confidant icon indicating copy to clipboard operation
confidant copied to clipboard

[Documentation] Configuration section

Open mickelsonm opened this issue 9 years ago • 4 comments

It would be nice if the Configuration section could be broken up into smaller readable sections. The way it stands now I am personally finding it hard to get the information I am looking for quickly.

Perhaps if it were something like :

Basics Basics -> Configuration Basics -> Configuration -> Environments Basics -> Configuration -> Environments -> Development Basics -> Configuration -> Environments -> Production

Maybe more granular would help the end user find/read about how to configure something more easily?

Also, when configuring for production...I am finding this process to be rather difficult. I have minimal AWS experience, so I am not sure exactly what needs to be done when setting up the IAM policies and the DynamoDB table that Confidant uses. Could you create a video showing how to setup Confidant in a production environment or at the very least provide a list of detailed steps to do so?

Thanks!

mickelsonm avatar Nov 30 '15 17:11 mickelsonm

Hey @mickelsonm, thanks for the feedback! I'll try to make the config docs more approachable. The screencasts are a good idea as well.

ryan-lane avatar Dec 01 '15 01:12 ryan-lane

As for the configuration of IAM policies and dynamo tables and such, the policies shown in the config should be almost exactly what you need. You'll need to generate two KMS keys, with the specified policies attached (you'll need to manually edit the key policy - there's a button for this in the console somewhere in the key's configuration). For the IAM policy for confidant itself, you'll need to create a role, then a couple inline policies for it. The docs show the IAM policy required. For the dynamodb table you'll create one table with two global secondary indexes. The keys for the table and indexes is here.

ryan-lane avatar Dec 01 '15 02:12 ryan-lane

@ryan-lane Thanks for understanding and I look forward to whatever you come up with.

As for the added AWS information, thanks for summing it up. Between learning Confidant itself and struggling to make sense of why AWS makes things more complex than what it should be...it has been a fun learning experience/work task. Hopefully, i'll get this up-and-running soon.

Thanks again!

mickelsonm avatar Dec 01 '15 05:12 mickelsonm

You're welcome. Feel free to hop into the confidant channel on freenode if you want to talk about any troubles you're having!

ryan-lane avatar Dec 01 '15 18:12 ryan-lane