Skip to content
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

Better Documentation For Other Cloud Providers #682

Open
RandomDSdevel opened this issue Sep 23, 2017 · 9 comments
Open

Better Documentation For Other Cloud Providers #682

RandomDSdevel opened this issue Sep 23, 2017 · 9 comments

Comments

@RandomDSdevel
Copy link

RandomDSdevel commented Sep 23, 2017

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

  1. View that section of the read-me either directly or via its mirror on Alog's main GitHub project page.
  2. 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.

@RandomDSdevel
Copy link
Author

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.

@RandomDSdevel
Copy link
Author

For Amazon Web Services, this Lifehacker article could be adapted if it isn't too out of date.

@RandomDSdevel
Copy link
Author

RandomDSdevel commented Sep 23, 2017

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…

@chrisjensen
Copy link

For Google Cloud Compute, here's the steps I needed to get it working.

(Before running ./algo)

  1. Create a service account and grant it owner permission for your GCE engine.
  2. Download and save the json credentials and take note of the location
  3. Enable the GCE API

(Then run ./algo)

@jackivanov
Copy link
Collaborator

jackivanov commented Feb 10, 2018

These steps should be documented as well (#658)

bltavares added a commit to bltavares/algo that referenced this issue Oct 24, 2018
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
jackivanov pushed a commit that referenced this issue Oct 28, 2018
* 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
faf0 pushed a commit to faf0/algo that referenced this issue Dec 13, 2018
* 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
@TC1977 TC1977 mentioned this issue Apr 26, 2019
1 task
@jackivanov
Copy link
Collaborator

I think the only Lightsail and OpenStack are missing now

@GearGit
Copy link

GearGit commented Oct 25, 2019

Can I still work on this issue for Hacktoberfest?

@jackivanov
Copy link
Collaborator

@GearGit Yes! PRs welcome.

@oliver44k
Copy link

how can i use this vpn i subscribed already

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

7 participants