-
Notifications
You must be signed in to change notification settings - Fork 1.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
update installation.rst #670
Conversation
this change offers info on the minimum system requirements for a redhat like system to get sam-cli up and running this would be very similar for debian based system, but I haven't tested. If you feel it will be valuable I can do so. the dockerfile is because "lets put everything in docker" I havent tried the lambda-local option in it. I know people run docker in docker but I would expect memory or file space issues however if you want to have docker environment for plenty of other sam-cli related tasks this can be useful and it runs on alpine so its small and fast. I would probably guess not having this info on the main install page is good, I would think linking to it might be better, but you can tell me what is best.
docs/installation.rst
Outdated
pip install --upgrade aws-sam-cli | ||
*** if you want to use the lambda-local option(without running it as root) you will need to add your user to the docker group *** | ||
usermod -a -G Docker yourUserName | ||
***Docker if you would like to run SAM-CLI in a docker container (lambda-local will probably act weird)*** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you remove the Dockerfile related docs here? While you can use parts of SAM CLI in docker, all features and commands will not work. Before we add running SAM CLI in docker, we need to ensure all commands work as expected.
removed docker in docker steps
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Awesome! Thanks for the addition!
* develop: chore: Version bump aws-sam-translator to 1.8.0 (aws#732) docs: add instructions for using local version of SAM Transformer (aws#688) docs: Update Docker command to docker (aws#725) fix: Iterate over query param list chore: Enable Travis to run integ tests chore(0.6.1): SAM CLI Version bump (aws#717) fix(init/readme): Correct permissions for AWS CLI under requirements (aws#713) add pytest-mock for testing (aws#703) fix: allow for stdout and stderr streams to be unbufferred directly. (aws#708) docs: Add installation instructions for linux (Centos) (aws#670) fix: Updated isBase64Encoded value to bool (aws#699) fix: correct launch.json for nodejs debugging through VSCode (aws#704) docs(usage): Update how to debug Python functions using VS Code (aws#694) docs(Cloud9): Reset bash cache on Cloud9 (aws#693) docs: Updated virtualenv alias name for 3.7 in guide. (aws#706) chore: update aws-sam-translator to 1.7.0 (aws#682) feat: travis CI support for Python 3.7 (aws#679) docs: Update generate-sample-event-payloads link (aws#702) Fix: Raise error for invalid environment variables file (aws#675)
this change offers info on the minimum system requirements for a redhat like system to get sam-cli up and running
this would be very similar for debian based system, but I haven't tested. If you feel it will be valuable I can do so.
the dockerfile is because "lets put everything in docker" I havent tried the lambda-local option in it. I know people run docker in docker but I would expect memory or file space issues
however if you want to have docker environment for plenty of other sam-cli related tasks this can be useful and it runs on alpine so its small and fast.
I would probably guess not having this info on the main install page is good, I would think linking to it might be better, but you can tell me what is best.
Issue #, if available:
Description of changes:
added info for installation requirements for linux, specifically centos 7.5, and added alpine linux dockerfile
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.