src.constants¶

Configuration values for the RCTab deployment.

This module contains the configuration values for the RCTab deployment. REQUIRED values must be set using pulumi config set …. Optional values can be set using pulumi config set … or can be ignored, in which case they will be given a default value.

src.constants.SESSION_TIMEOUT_MINUTES¶

The number of minutes before a user session times out. Defaults to 90.

Type:: str

src.constants.DATABASE_NAME¶

The name of the database to create. Defaults to RCTab.

Type:: str

src.constants.APP_MODULE¶

The name of the module to run. Defaults to rctab:app.

Type:: str

src.constants.STACK_NAME¶

The name of the pulumi stack.

Type:: str

src.constants.RCTAB_APP_USER¶

The name of the user to create for the RCTab app. Defaults to rctab-api-user.

Type:: str

src.constants.ORGANISATION¶

The name of the organisation. REQUIRED.

Type:: str

src.constants.TICKER¶

The ticker of the organisation. REQUIRED.

Type:: str

src.constants.IDENTIFIER¶

The identifier of the organisation. This is the combination of the ticker and stack name.

Type:: str

src.constants.RCTAB_TAG¶

The tag of the RCTab docker image to use. Defaults to 1.latest.

Type:: str

src.constants.AUTO_DEPLOY¶

Whether to automatically deploy the app. Defaults to true.

Type:: str

src.constants.DOCKER_REGISTRY_SERVER_URL¶

The URL of the docker registry server. Defaults to https://index.docker.io/v1.

Type:: str

src.constants.DOCKER_REGISTRY_SERVER_USERNAME¶

The username for docker. Defaults to an empty string.

Type:: str

src.constants.DOCKER_REGISTRY_SERVER_PASSWORD¶

The password for docker. Defaults to an empty string.

Type:: str

src.constants.DOCKER_API_IMAGE¶

The name of the docker image for the API. Defaults to turingrc/rctab-api:1.latest.

Type:: str

src.constants.DOCKER_USAGE_IMAGE¶

The name of the docker image for the usage app. Defaults to turingrc/rctab-usage:1.latest.

Type:: str

src.constants.DOCKER_STATUS_IMAGE¶

The name of the docker image for the status app. Defaults to turingrc/rctab-status:1.latest.

Type:: str

src.constants.DOCKER_CONTROLLER_IMAGE¶

The name of the docker image for the controller app. Defaults to turingrc/rctab-controller:1.latest.

Type:: str

src.constants.PRIMARY_IP¶

The primary IP address of the organisation. REQUIRED.

Type:: str

src.constants.DB_ROOT_CERT_PATH¶

The path to the root certificate for the database. REQUIRED.

Type:: str

src.constants.AD_SERVER_ADMIN¶

The name of the admin user for the AD server. REQUIRED.

Type:: str

src.constants.AD_TENANT_ID¶

The tenant ID for the AD server. REQUIRED.

Type:: str

src.constants.AD_API_CLIENT_ID¶

The client ID for the API app in the AD server. REQUIRED.

Type:: str

src.constants.AD_API_CLIENT_SECRET¶

The client secret for the API app in the AD server. REQUIRED.

Type:: str

src.constants.AD_STATUS_CLIENT_ID¶

The client ID for the status app in the AD server. REQUIRED.

Type:: str

src.constants.AD_STATUS_CLIENT_SECRET¶

The client secret for the status app in the AD server. REQUIRED.

Type:: str

src.constants.SENDGRID_API_KEY¶

The API key for SendGrid. REQUIRED.

Type:: str

src.constants.SENDGRID_SENDER_EMAIL¶

The sender email for SendGrid. REQUIRED.

Type:: str

src.constants.NOTIFIABLE_ROLES¶

The roles to notify. Defaults to an empty string.

Type:: str

src.constants.ROLES_FILTER¶

The roles to filter. Defaults to an empty string.

Type:: str

src.constants.ADMIN_EMAIL_RECIPIENTS¶

The email recipients for admin emails. Defaults to an empty string.

Type:: str

src.constants.IGNORE_WHITELIST¶

Whether to ignore the whitelist. Defaults to an empty string.

Type:: str

src.constants.WHITELIST¶

The whitelist. Defaults to an empty string.

Type:: str

src.constants.LOG_LEVEL¶

The log level. Defaults to an empty string.

Type:: str

src.constants.BILLING_ACCOUNT_ID¶

The billing account ID. REQUIRED.

Type:: str

src.constants.MGMT_GROUP¶

The management group. REQUIRED.

Type:: str

Functions

assert_is_file

Mock version of assert_is_file.