trailofbits
Better Documentation For Other Cloud Providers
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
- View that section of the read-me either directly or via its mirror on Alog's main GitHub project page.
- Look for bullet items that are children of the one on 'Cloud setup.'
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.
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.
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 ./algo)
- Create a service account and grant it owner permission for your GCE engine.
- Download and save the json credentials and take note of the location
- Enable the GCE API
(Then run ./algo)
