-
Notifications
You must be signed in to change notification settings - Fork 0
Closed
Description
Describe the story
Provide a clear description of the new feature or improvement to existing functionality.
Standardize the configuration naming standards in the application and infrastructure. Create configuration documentation for both application engineers and DevOps engineers.
Requirements
- Standardize logging configuration keys to use prefix
LOGGING_in the application andCDK_LOGGING_in the infrastructure.- Change
ENABLE_LOGGINGtoLOGGING_ENABLED - Change
LOG_LEVELtoLOGGING_LEVEL - Change
LOG_FORMATtoLOGGING_FORMAT - Update the corresponding infrastructure variables in the infrastructure to match but using the
CDK_APP_prefix.
- Change
- Apply the CORS configuration in the infrastructure.
- Create infrastructure variable
CDK_CORS_ALLOW_ORIGINand use it to configure the API Gateway.
- Create infrastructure variable
- Create a "Configuration Guide" in the project documentation.
- Should have sections that document the application and infrastructure configuration in a tabular format including the key, description, and default value.
- Add to the documentation table of contents README
Acceptance criteria
- Application logging configuration variables begin with prefix
LOGGING_ - Infrastructure logging configuration variables begin with prefix
CDK_APP_LOGGING_ - Infrastructure uses
CDK_CORS_ALLOW_ORIGINvariable to configure the API Gateway and to pass to the Lambda functions asCORS_ALLOW_ORIGIN
Additional context
Add any other context about the story here.
Metadata
Metadata
Assignees
Labels
enhancementNew feature or requestNew feature or request