Enhancement | Update the leverage documentation to cover common use cases

fgauchat-binbash commented 1 year ago

Describe the Feature

An enhancement of the Leverage documentation focusing on daily operations, from the point of view of someone that has to use leverage to interact with AWS, terraform and kubectl on a daily basis. This could include:

Clear and concise instructions for setting up and configuring the tool, with screenshots or diagrams to help visually guide users through the process.
Detailed explanations of any error messages or troubleshooting steps.
A section dedicated to frequently asked questions (FAQs)
Expand the AWS section, explaining how it works for daily operations, how the credentials are stored and how to use those credentials to interact with other services (kubectl, SOPS, etc)

Expected Behavior

A new section dedicated to documenting a few use cases, with a step by step guide or some sort of "Runbook" covering the most common scenarios.

Use Case

Noticed that some customers were having troubles understanding the tool, configuring credentials, troubleshooting errors and how to use it for daily operations. We found ourselves having to explain what to do several times.

exequielrafaela commented 1 year ago

As agreed with @diego-ojeda-binbash, @rodriguez-matias and the @binbashar/leverage-ref-architecture-aws-dev team we'll define the basic cases:

kubectl
SOPs

NOTE: Emphasize .tfvars setup => credentials files

CONSIDERATION (we have some related issues):

diego-ojeda-binbash commented 9 months ago

FYI @juanmatias suggested we could use the playbooks entry he added not so long ago here for this: https://leverage.binbash.co/user-guide/playbooks/ Let's see if that could be enough for this iteration, otherwise let's define what would be missing.

exequielrafaela commented 9 months ago

binbashar / le-ref-architecture-doc