Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign upGitHub is where the world builds software
Millions of developers and companies build, ship, and maintain their software on GitHub — the largest and most advanced development platform in the world.
Better Documentation For Other Cloud Providers #682
Comments
Feel free to split the various aspects of this issue's resolution into multiple issues, leaving this one as a tracking issue or abandoning it altogether. |
For Amazon Web Services, this Lifehacker article could be adapted if it isn't too out of date. |
Now that I look for it, there does seem to be some documentation of the sort I was looking for, just not all together by cloud provider. It'd still be useful to have information, newly duplicated or just reformatted, organized that way, though… |
For Google Cloud Compute, here's the steps I needed to get it working. (Before running
(Then run |
These steps should be documented as well (#658) |
This commit adds the steps needed to create a credential with the needed access on Google Cloud Platform to be able to successfully create a new algo VPN. Related to: - trailofbits#682 - trailofbits#658
* Add documentation on how to setup GCE accounts This commit adds the steps needed to create a credential with the needed access on Google Cloud Platform to be able to successfully create a new algo VPN. Related to: - #682 - #658 * Adds links on main README to GCP * Adds link to Ansible documentation * Update cloud-gce.md
* Add documentation on how to setup GCE accounts This commit adds the steps needed to create a credential with the needed access on Google Cloud Platform to be able to successfully create a new algo VPN. Related to: - trailofbits#682 - trailofbits#658 * Adds links on main README to GCP * Adds link to Ansible documentation * Update cloud-gce.md
I think the only Lightsail and OpenStack are missing now |
Can I still work on this issue for Hacktoberfest? |
@GearGit Yes! PRs welcome. |
OS/Environment
None yet, but I'm working on OS X v10.11.6 'El Capitan' client-side. (See 'The way of deployment (cloud or local)' below for details on considered server infrastructure.)
Ansible version
None yet, as I haven't yet gotten that far into setting up Algo.
Version of components from
requirements.txt
Not applicable (see above.)
Summary of the problem
In the 'Additional Documentation' section of Algo's
README.md
, the bullet point on 'Cloud setup' of Algo on various cloud hosting services has only one child bullet item, namely one linking to instructions for cloud setup of Algo specific to Microsoft Azure.Steps to reproduce the behavior
The way of deployment (cloud or local)
None yet, but I'm working on hosting on Google Cloud Platform.
Expected behavior
Finding links to documentation on how to set up a cloud deployment of Algo on multiple different hosting providers' infrastructure offerings in this project's read-me under the section cited was the sort of outcome I expected from the route of investigation described in this issue.
Actual behavior
A single link pointing to instructions specific to Microsoft Azure was all that I found in that section of the read-me.
Full logs
Not applicable; no logs (see 'OS/Environment' and 'The way of deployment (cloud or local)' above.)
Suggested resolution
Improve Algo's documentation to include instructions on how to set a cloud deployment of Algo up on all of the cloud platforms that it supports.