Skip to content

Standardize configuration #9

@mwarman

Description

@mwarman

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 and CDK_LOGGING_ in the infrastructure.
    • Change ENABLE_LOGGING to LOGGING_ENABLED
    • Change LOG_LEVEL to LOGGING_LEVEL
    • Change LOG_FORMAT to LOGGING_FORMAT
    • Update the corresponding infrastructure variables in the infrastructure to match but using the CDK_APP_ prefix.
  • Apply the CORS configuration in the infrastructure.
    • Create infrastructure variable CDK_CORS_ALLOW_ORIGIN and use it to configure the API Gateway.
  • 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_ORIGIN variable to configure the API Gateway and to pass to the Lambda functions as CORS_ALLOW_ORIGIN

Additional context

Add any other context about the story here.

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions