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

dcc-ops README asks for AWS "keys", ambiguous #102

Open
brainstorm opened this issue Jul 27, 2017 · 2 comments
Open

dcc-ops README asks for AWS "keys", ambiguous #102

brainstorm opened this issue Jul 27, 2017 · 2 comments

Comments

@brainstorm
Copy link
Member

Some questions on the bootstrap installer are a bit ambiguous and/or not present on the README:

(...)
What is your AWS Key?

This could be the "AWS SSH key", the "AWS Encryption key" or the "AWS Access Key ID". On that question/step it happens to be the latter, but sticking to the precise terms mentioned above could help avoid some confusion.

@emikoifish
Copy link
Member

The README should have a standard format for the bootstrap installer questions.

I would prefer the following format:

  • First, each of the install bootstrap questions are prefixed with the same "On the question" or "For the question"
  • Next, the question, as presented on the install_bootstrap, in a code block format to make it easier for the reader to find the question
  • Then, instructions on how the answer the question

For example:
On the question What is the Consonance access token? enter your Consonance access token

@brainstorm
Copy link
Member Author

Good points @emikoifish

IMHO, the bootstrap and a huge part of the README should go away in favour of automated deployment via ansible and/or terraform which rely on already present ~/.aws/credentials from the user.

That would take a bit more effort/attempts than mine over here:

https://github.com/brainstorm/dcc-ops/blob/aws_cloudformation/common/terraform/main.tf

Great automation is orders of magnitude better than any documentation or interactive Q/A script.

A properly automated, idempotent deployment recipe should solve several issues with dcc-ops right away and allow third parties to deploy it easily, IMHO.

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

No branches or pull requests

2 participants