atlanticwave-sdx / kytos-sdx

MIT License
0 stars 3 forks source link

Refactor environment variables to be more concise #37

Closed italovalcy closed 7 months ago

italovalcy commented 7 months ago

Fix #36

Heads-up: this PR depends on PR https://github.com/atlanticwave-sdx/sdx-continuous-development/pull/109

Description of the change

lmarinve commented 7 months ago

The initial setup scattered environment variables across various files, including the Docker Compose files, making the system configuration complex and more challenging to maintain. To enhance our configuration management and improve codebase clarity, we proposed consolidating all environment variable values into a single.env file and reorganizing hardcoded values within the Docker Compose files. Goals:

Centralize Configuration: Aggregate all environment variables into one.env file to streamline configuration changes and improve visibility.

Clarify Docker Compose Files: To maintain clarity and organization, move hardcoded values from Docker Compose files to the.env file or appropriately document them.

Tasks:

Documentation Update: Update all relevant documentation to reflect the new configuration strategy and provide guidelines on managing and updating the.env file. Testing: Thoroughly test the updated configurations in various environments to ensure no functional compromises.

Expected Outcome: This reorganization will lead to a more maintainable and organized codebase, making it easier for developers to update and manage environment settings without navigating multiple files.

Additional Notes: This task requires careful coordination with the development team to ensure that changes do not disrupt existing functionalities. All team members must update their local development setups after implementation according to the new guidelines.

italovalcy commented 7 months ago

The initial setup scattered environment variables across various files, including the Docker Compose files, making the system configuration complex and more challenging to maintain. To enhance our configuration management and improve codebase clarity, we proposed consolidating all environment variable values into a single.env file and reorganizing hardcoded values within the Docker Compose files. Goals:

Centralize Configuration: Aggregate all environment variables into one.env file to streamline configuration changes and improve visibility.

Clarify Docker Compose Files: To maintain clarity and organization, move hardcoded values from Docker Compose files to the.env file or appropriately document them.

Tasks:

  • Audit all existing configuration files to identify and list all current environment variables.
  • Create a.env file: Develop a comprehensive.env file that includes all necessary environment variables, appropriate default values, and comments for clarification.
  • Modify Docker Compose Files: Refactor Docker Compose files to reference the.env file instead of containing hardcoded values. Ensure all references are correctly linked and functional.

Documentation Update: Update all relevant documentation to reflect the new configuration strategy and provide guidelines on managing and updating the.env file. Testing: Thoroughly test the updated configurations in various environments to ensure no functional compromises.

Expected Outcome: This reorganization will lead to a more maintainable and organized codebase, making it easier for developers to update and manage environment settings without navigating multiple files.

Additional Notes: This task requires careful coordination with the development team to ensure that changes do not disrupt existing functionalities. All team members must update their local development setups after implementation according to the new guidelines.

Hi @lmarinve thanks for you comment! Is there any specific adjustment you need me to apply? This PR is not related to the actual docker compose or .env files. I'm a bit confused with your comment.