Skip to content

Latest commit

 

History

History
104 lines (91 loc) · 7.1 KB

configuration.md

File metadata and controls

104 lines (91 loc) · 7.1 KB
Raw

Configuration

Most configuration is done through environment variables. In the development environment, these are stored in files for ease of editing and loading. In production, they are set as part of the runtime environment.

Environment Configuration

  • CTMS_DB_URL - The database connection parameters, formatted as a URL. In the development environment, this defaults to talk to the postgres container. In production, it is set to talk to the provisioned database.

  • CTMS_DB_POOL_SIZE - The database connection parameter pool_size (default: 10). ...view more on sqlalchemy.

  • CTMS_DB_MAX_OVERFLOW - The database connection parameter max_overflow (default: 20). ...view more on sqlalchemy.

  • CTMS_DB_POOL_TIMEOUT_IN_SECONDS - The database connection parameter pool_timeout(default: 45s). ...view more on sqlalchemy.

  • CTMS_SECRET_KEY - An encryption key, used for OAuth2 and other hashes. Set to a long but non-secret value for development, and set to a randomized string for each production deployment.

  • CTMS_TOKEN_EXPIRATION - How long an OAuth2 access token is valid, in seconds. If unset, defaults to one hour.

  • CTMS_SERVER_PREFIX - The protocol and domain part of the server name, used to construct full URLS. Set to http://localhost:8000 in development, and the user-facing prefix in production.

  • CTMS_USE_MOZLOG - Use the JSON MozLog format for logs. Defaults to True as used in production, and is set to False for development. See the deployment guide for more information on the MozLog format.

  • CTMS_LOGGING_LEVEL - The minimum level for logs. Defaults to INFO if unset. Unset in production, and set to INFO in development.

  • CTMS_LOG_SQLALCHEMY - Determines whether SQLAlchemy logs should be emmited. Defaults to False if unset. Unset in production, and set to False in development.

  • CTMS_SENTRY_DEBUG - If set to True, then sentry initialization and capture is logged as well. This may be useful for development, but is not recommended for production.

  • CTMS_FASTAPI_ENV - To determine which environment is being run; defaults to None.

  • CTMS_PUBSUB_AUDIENCE - Audience (or Server) shared between FxA and CTMS; part of claims analysis to ensure request payload is trustworthy.

  • CTMS_PUBSUB_EMAIL - Email (or Service Account) shared between FxA and CTMS; part of claims analysis to ensure request payload is trustworthy.

  • CTMS_PUBSUB_CLIENT - Client (or Token) shared between FxA and CTMS; part of claims analysis to ensure request payload is trustworthy.

  • CTMS_ACOUSTIC_SYNC_FEATURE_FLAG - To enable background process to poll for PendingAcousticRecords; defaults to False or disabled state.

  • CTMS_ACOUSTIC_INTEGRATION_FEATURE_FLAG - To enable background process to sync to Acoustic; defaults to False or disabled state.

  • CTMS_ACOUSTIC_RETRY_LIMIT - Number of retries before a record is no longer attempted to be synchronized to Acoustic; defaults to 6.

  • CTMS_ACOUSTIC_BATCH_LIMIT - Number of records to be polled from DB Table during a single sync iteration; defaults to 20.

  • CTMS_ACOUSTIC_SERVER_NUMBER - Required to interact with Acoustic API

  • CTMS_ACOUSTIC_LOOP_MIN_SECS - Amount of time to sleep between sync cycles

  • CTMS_ACOUSTIC_MAX_BACKLOG - Used with __heartbeat__ as limit of records in DB Table pending sync before service is considered in unhealthy state

  • CTMS_ACOUSTIC_MAX_RETRY_BACKLOG -Used with __heartbeat__ as limit of retried records in DB Table pending sync before service is considered in unhealthy state

  • CTMS_ACOUSTIC_CLIENT_ID - Required to interact with Acoustic API

  • CTMS_ACOUSTIC_CLIENT_SECRET - Required to interact with Acoustic API

  • CTMS_ACOUSTIC_REFRESH_TOKEN - Required to interact with Acoustic API

  • CTMS_ACOUSTIC_MAIN_TABLE_ID - Identifier to main_table for Acoustic API interactions

  • CTMS_ACOUSTIC_NEWSLETTER_TABLE_ID - Identifier to newsletter_table for Acoustic API interactions

  • CTMS_ACOUSTIC_PRODUCT_SUBSCRIPTIONS_ID - Identifier to product_subscriptions_table for Acoustic API interactions

  • CTMS_PROMETHEUS_PUSHGATEWAY_URL - URL for Prometheus pushgateway, enabling an outlet for metrics to be received from the background job

  • CTMS_BACKGROUND_HEALTHCHECK_PATH - Path of file used for healthcheck from background sync process

  • CTMS_BACKGROUND_HEALTHCHECK_AGE_S - Age (in seconds) as upper bound to determine if the background job is in an unhealthy state.

  • CTMS_ACOUSTIC_TIMEOUT_S - The amount of time (in seconds) before an Acoustic API call will timeout; defaults to 5.0s;

  • CTMS_UID - The user ID of the app account, used to run the CTMS application. If unset, defaults to 10001. On Linux development systems, set along with CTMS_GID to match the development user, for consistent permissions.

  • CTMS_GID - The group ID of the app account, used to run the CTMS application. If unset, defaults to 10001. On Linux development systems, set along with CTMS_UID to match the development user, for consistent permissions.

  • MK_WITH_SERVICE_PORTS - If set to --service-ports, passes that option to docker run commands, allowing access to host-based commands.

  • MK_KEEP_DOCKER_UP - If unset, then make test runs docker-compose down after tests run, shutting down the PostgreSQL container. If set to 1, make test keeps containers running.

  • PORT - The port for the web service. Defaults to 8000 if unset.

  • SENTRY_DSN - The Sentry connection string. The sentry-sdk reads this in production. It should be unset in development, except for Sentry testing, and after informing operations engineers.

Environment Configuration Files

The file ctms/config.py defines the environment settings for the CTMS API.

In the production environment, environment variables are set in the deployment instances and read by the CTMS API application for configuration. When possible, the default values of environment variables are appropriate for production.

In the local development environment, the default configuration is in .env. The file .env.example is the .env template for new developer environments.

.env is loaded in the Makefile, making those configuration items available in Makefile targets and commands. .env is also loaded by docker-compose and passed to Docker. Some adjust the build process by setting ARG variables in the Dockerfile. Others are passed to the runtime environment. The CTMS API application then loads these from the environment.

Linux users should set CTMS_UID and CTMS_GID to match their user account, so that files created inside the docker container have the same permissions as their user account.

View All Docs