spcl / faaskeeper

A fully serverless implementation of the ZooKeeper coordination protocol.
BSD 3-Clause "New" or "Revised" License
17 stars 13 forks source link

Additional steps required while deploying FaasKeeper #44

Open mujtaba1747 opened 6 months ago

mujtaba1747 commented 6 months ago

These are the commands I ran to deploy FaaSKeeper to AWS: Note: nvm is node version manager

pip3 install requirements.txt
pip3 install git+https://github.com/spcl/faaskeeper-python
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash
source ~/.bashrc # or whatever is your shell. Eg: zshrc for macOS
nvm install 14.15.0
nvm use 14.15.0
npm install -g serverless
serverless plugin install -n serverless-export-env --config /workspaces/faaskeeper/aws.yml
serverless plugin install -n serverless-python-requirements  --config /workspaces/faaskeeper/aws.yml
serverless plugin install -n serverless-iam-roles-per-function --config /workspaces/faaskeeper/aws.yml
./fk.py deploy service config/user_config_final.json --provider aws --config config/user_config.json

3 Additional commands had to be run, ie the serverless plugin install commands

How to fix this: These commands should be added to the documentation. Because perhaps the latest version of serverless does not come with these plugins installed by default

EricPyZhou commented 6 months ago

Hello, thanks for creating the issue. From the reference on the serverless doc: https://www.serverless.com/framework/docs-guides-plugins

you can find the plugins installation code in install.py and aws.yml

if specifying '--config' is a new practice, can you provide a reference to a related doc?