ditkrg/dit-digital-service-manual
4
0
Fork 0
Code Issues Pull Requests Packages Projects 1 Releases Wiki Activity

Update environment variables page

Browse Source 
Signed-off-by: Shakar <5h4k4r.b4kr@gmail.com>
This commit is contained in:
Shakar 2023-04-04 16:34:26 +03:00
parent 1796c41532
commit d2aadc4c40
No known key found for this signature in database
GPG Key ID: DA55A26823AE3C28
1 changed files with 51 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
docs/Software Development/06-Environment Variables.md
View File

@ -1,11 +1,15 @@
# Environment Variables for Micro-Service Applications
This document provides a brief description of the environment variables that are used by the micro-service applications developed by the Department of Information & Technology (DIT). These variables are used to configure various aspects of the applications, such as database connections, cloud storage access, message queue settings, etc. The environment variables follow a standard naming convention that consists of two parts: the prefix and the suffix. The prefix indicates the component or service that the variable belongs to, and the suffix indicates the specific parameter or attribute that the variable represents. For example, `DATABASE__HOST` is an environment variable that specifies the host name of the database server for the application.
This document provides a brief description of the environment variables that are used by the micro-service applications developed and maintained by the Department of Information & Technology (DIT). These variables are used to configure various aspects of the applications, such as database connections, cloud storage access, message queue settings, etc. The environment variables follow a standard naming convention that consists of two parts: the prefix and the suffix. The prefix indicates the component or service that the variable belongs to, and the suffix indicates the specific parameter or attribute that the variable represents. For example, `DATABASE__HOST` is an environment variable that specifies the host name of the database server for the application.
The following table lists the environment variables that are common to all DIT micro-service applications, along with their descriptions.
| Environment Variable | Description |
| :--------------------------------- | :----------------------------------------------------------------------------- |
| :------------------------- | :------------------------------------------------------------------------ |
| CAS\_\_URL | The URI format for the connection string of database server |
| CAS\_\_M2M_CLIENT_ID | The URI format for the connection string of database server |
| CAS\_\_M2M_CLIENT_SECRET | The URI format for the connection string of database server |
| DATABASE\_\_URL | The URI format for the connection string of database server |
| DATABASE\_\_HOST | The host name or IP address of the database server |
| DATABASE\_\_USERNAME | The username for accessing the database |
| DATABASE\_\_PASSWORD | The password for accessing the database |
@ -13,9 +17,10 @@ The following table lists the environment variables that are common to all DIT m
| DATABASE\_\_PORT | The port number of the database server |
| S3\_\_REGION | The AWS region of the S3 bucket |
| S3\_\_ENDPOINT | The endpoint URL of the S3 bucket |
| S3\_\_ACCESS_KEY | The access key ID for accessing the S3 bucket |
| S3\_\_SECRET_KEY | The secret access key for accessing the S3 bucket |
| S3\_\_BUCKET | The name of the S3 bucket |
| S3\_\_ACCESS_KEY_ID | The access key ID for accessing the S3 bucket |
| S3\_\_SECRET_ACCESS_KEY | The secret access key for accessing the S3 bucket |
| S3\_\_SELF_BUCKET | The name of the S3 bucket used for storing self-related files |
| S3\_\_UPLOADS_API_BUCKET | The name of the S3 bucket used for storing uploaded files via Uploads API |
| SIDEKIQ\_\_USERNAME | The username for accessing the Sidekiq web interface |
| SIDEKIQ\_\_PASSWORD | The password for accessing the Sidekiq web interface |
| REDIS_SENTINEL\_\_HOST | The host name or IP address of the Redis Sentinel server |
@ -35,11 +40,19 @@ The following table lists the environment variables that are common to all DIT m
| RABBITMQ\_\_VHOST | The virtual host name of the RabbitMQ server |
| RABBITMQ\_\_USERNAME | The username for accessing the RabbitMQ server |
| RABBITMQ\_\_PASSWORD | The password for accessing the RabbitMQ server |
| RABBITMQ\_\_MAX_ATTEMPTS | The maximum number of attempts for retrying failed messages in RabbitMQ queues |
| RABBITMQ\_\_RETRY_DELAY_IN_SECONDS | The delay in seconds between each retry attempt in RabbitMQ queues |
| MONGO\_\URL | The MongoDB Connection string |
| SERIVCE\_\_[Name of service]\_URL | The URL of other services |
| EVENTBUS\_\_EXCHANGE_NAME | The name of the exchange for event bus |
| EMAIL_TEMPLATE_ID\_\_[action] | The database ID of the email template |
| RABBITMQ\_\_EXCHANGE_NAME | The name of the exchange for RabbitMQ server |
In addition to these common environment variables, some applications may have specific environment variables that are related to their functionality or dependencies. These variables are prefixed with the name of the application or service that they belong to, such as `TAX_CORPORATE_REGISTRATION_PORTAL_URL`. These variables are documented in their respective application repositories or README files.
## Environment Variables for Micro-Service Applications
1. Use double underscores (\_\_) to separate words in the variable name.
2. Use all uppercase letters for the variable name.
3. Use descriptive names for the variable that indicate their purpose or usage.
4. Use consistent naming across all microservice applications developed by DIT.
5. Store environment variables securely, using an encrypted secrets store, such as HashiCorp Vault or Amazon Secrets Manager.
6. Avoid hard-coding sensitive information, such as passwords or API keys, in the code.
## Conclusion
The standard naming convention for environment variables used by microservice applications developed and maintained by the Department of Information & Technology (DIT) has been outlined in this document. Following these guidelines will ensure consistency and clarity across all microservice applications developed by DIT.