docs: add required env vars to readme

[fernandoataoldotcom]

PR Type

Documentation

---

Description

• Added a new section in the README for configuring environment variables.
• Included a command example for building and running the Docker container with an .env file.
• Listed necessary environment variables for AWS and vault configurations, both for nonproduction and production environments.

---

Changes walkthrough 📝

	Relevant files
Documentation	README.md Add environment variable configuration to README                  README.md Added a new section for environment variable file configuration. Provided a command example for building and running the Docker container. Listed required environment variables for AWS and vault configurations. +26/-1

---

💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

[codiumai-pr-agent-free]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪

🧪 No relevant tests

🔒 Security concerns Sensitive information exposure: The README file includes placeholder lines for sensitive information such as AWS credentials (AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_SESSION_TOKEN) and vault tokens (NONPROD_VAULT_TOKEN, PROD_VAULT_TOKEN). While these are currently empty placeholders, there's a risk that developers might accidentally commit this file with real values filled in, potentially exposing sensitive credentials. It's recommended to use a .env.example file for showcasing required environment variables instead of including them directly in the README, and to add .env to .gitignore to prevent accidental commits of real credentials.

⚡ Recommended focus areas for review Security Concern The README includes placeholder lines for sensitive information like AWS credentials and vault tokens, which could potentially be misused if accidentally committed with real values.

[codiumai-pr-agent-free]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Score
Security	Add a security note about handling sensitive environment variables Consider adding a note about the importance of keeping these environment variables secure and not committing the .env file to version control. README.md [9-26] ```.env #AWS AWS_ACCESS_KEY_ID= AWS_SECRET_ACCESS_KEY= AWS_SESSION_TOKEN= # nonproduction vault NONPROD_VAULT_URL= KUBERNETES_ROLE= NONPROD_VAULT_TOKEN= NONPROD_POMERIUM_COOKIE= # production vault PROD_VAULT_URL= KUBERNETES_ROLE= PROD_VAULT_TOKEN= PROD_POMERIUM_COOKIE= +> Important: Keep these environment variables secure. Do not commit the .env file to version control. + - [ ] **Apply this suggestion** <!-- /improve --apply_suggestion=0 --> <details><summary>Suggestion importance[1-10]: 8</summary> Why: Including a security note about not committing sensitive environment variables to version control is crucial for maintaining security best practices and protecting sensitive information. </details></details></td><td align=center>8 </td></tr><tr><td rowspan=2><strong>Enhancement</strong></td> <td> <details><summary>Add descriptions for environment variables to improve clarity and ease of setup<!-- not_implemented --></summary> ___ **Consider adding a brief description of each environment variable to provide context <br>and guidance for users setting up the project.** [README.md [10-25]](https://github.com/GlueOps/migrate-ecs-apps/pull/30/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R10-R25) ```diff #AWS -AWS_ACCESS_KEY_ID= -AWS_SECRET_ACCESS_KEY= -AWS_SESSION_TOKEN= +AWS_ACCESS_KEY_ID= # Your AWS access key ID +AWS_SECRET_ACCESS_KEY= # Your AWS secret access key +AWS_SESSION_TOKEN= # Your AWS session token (if using temporary credentials) # nonproduction vault -NONPROD_VAULT_URL= -KUBERNETES_ROLE= -NONPROD_VAULT_TOKEN= -NONPROD_POMERIUM_COOKIE= +NONPROD_VAULT_URL= # URL of the nonproduction Vault server +KUBERNETES_ROLE= # Kubernetes role for Vault authentication +NONPROD_VAULT_TOKEN= # Vault token for nonproduction environment +NONPROD_POMERIUM_COOKIE= # Pomerium cookie for nonproduction environment # production vault -PROD_VAULT_URL= -KUBERNETES_ROLE= -PROD_VAULT_TOKEN= -PROD_POMERIUM_COOKIE= +PROD_VAULT_URL= # URL of the production Vault server +KUBERNETES_ROLE= # Kubernetes role for Vault authentication +PROD_VAULT_TOKEN= # Vault token for production environment +PROD_POMERIUM_COOKIE= # Pomerium cookie for production environment Apply this suggestion Suggestion importance[1-10]: 7 Why: Adding descriptions for environment variables enhances clarity and assists users in correctly setting up the project, improving usability and reducing potential setup errors.	7
Provide guidance on obtaining necessary environment variable values Consider adding instructions on how to obtain or generate the required environment variable values, especially for sensitive information like AWS credentials and Vault tokens. README.md [3-26] ## Environment Variable File Configuration + +1. Create a `.env` file in the project root directory. +2. Fill in the required environment variables: ```sh docker build . -t migrate-ecs && docker run --env-file .env -t migrate-ecs #AWS AWS_ACCESS_KEY_ID= AWS_SECRET_ACCESS_KEY= AWS_SESSION_TOKEN= # nonproduction vault NONPROD_VAULT_URL= KUBERNETES_ROLE= NONPROD_VAULT_TOKEN= NONPROD_POMERIUM_COOKIE= # production vault PROD_VAULT_URL= KUBERNETES_ROLE= PROD_VAULT_TOKEN= PROD_POMERIUM_COOKIE= +3. Obtain the required values: For AWS credentials, refer to the AWS documentation. For Vault tokens and URLs, consult your organization's Vault administrator. For Kubernetes roles and Pomerium cookies, refer to your organization's authentication documentation. - [ ] **Apply this suggestion** <!-- /improve --apply_suggestion=2 --> <details><summary>Suggestion importance[1-10]: 6</summary> Why: Offering instructions on how to obtain or generate environment variable values aids users in correctly configuring the application, though it is less critical than security-related suggestions. </details></details></td><td align=center>6 </td></tr></tr></tbody></table> >💡 Need additional feedback ? start a [PR chat](https://chromewebstore.google.com/detail/ephlnjeghhogofkifjloamocljapahnl)

[venkatamutyala]

I don't think this is needed.

[venkatamutyala]

I don't think this is needed.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud