rctab_infrastructure.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. Note that the pulumi config values are lowercase versions of the Python variable names.

rctab_infrastructure.constants.SESSION_TIMEOUT_MINUTES

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

Type:

str

rctab_infrastructure.constants.DATABASE_NAME

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

Type:

str

rctab_infrastructure.constants.APP_MODULE

The name of the FastAPI app. Defaults to “rctab:app”.

Type:

str

rctab_infrastructure.constants.STACK_NAME

The name of the pulumi stack. Set automatically.

Type:

str

rctab_infrastructure.constants.RCTAB_APP_USER

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

Type:

str

rctab_infrastructure.constants.ORGANISATION

Your organisation’s name. REQUIRED.

Type:

str

rctab_infrastructure.constants.TICKER

A short form of your organisation’s name. REQUIRED.

Type:

str

rctab_infrastructure.constants.IDENTIFIER

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

Type:

str

rctab_infrastructure.constants.RCTAB_TAG

The tag of the RCTab Docker image to use. Defaults to “1.latest”.

Type:

str

rctab_infrastructure.constants.AUTO_DEPLOY

Whether to automatically pull new images. Defaults to “true”.

Type:

str

rctab_infrastructure.constants.DOCKER_REGISTRY_SERVER_URL

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

Type:

str

rctab_infrastructure.constants.DOCKER_REGISTRY_SERVER_USERNAME

The username for the Docker registry. Defaults to an empty string.

Type:

str

rctab_infrastructure.constants.DOCKER_REGISTRY_SERVER_PASSWORD

The password for Docker registry. Defaults to an empty string.

Type:

str

rctab_infrastructure.constants.DOCKER_API_IMAGE

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

Type:

str

rctab_infrastructure.constants.DOCKER_USAGE_IMAGE

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

Type:

str

rctab_infrastructure.constants.DOCKER_STATUS_IMAGE

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

Type:

str

rctab_infrastructure.constants.DOCKER_CONTROLLER_IMAGE

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

Type:

str

rctab_infrastructure.constants.PRIMARY_IP

Your organisation’s static IP address. REQUIRED.

Type:

str

rctab_infrastructure.constants.DB_ROOT_CERT_PATH

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

Type:

str

rctab_infrastructure.constants.AD_SERVER_ADMIN

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

Type:

str

rctab_infrastructure.constants.AD_TENANT_ID

The ID of your Azure AD tenant. REQUIRED.

Type:

str

rctab_infrastructure.constants.AD_API_CLIENT_ID

The Azure AD ID of the API app. REQUIRED.

Type:

str

rctab_infrastructure.constants.AD_API_CLIENT_SECRET

The Azure AD client secret for the API app. REQUIRED.

Type:

str

rctab_infrastructure.constants.AD_STATUS_CLIENT_ID

The Azure AD ID of the status app service principal. REQUIRED.

Type:

str

rctab_infrastructure.constants.AD_STATUS_CLIENT_SECRET

The Azure AD secret for the status app service principal. REQUIRED.

Type:

str

rctab_infrastructure.constants.SENDGRID_API_KEY

The API key for SendGrid. REQUIRED.

Type:

str

rctab_infrastructure.constants.SENDGRID_SENDER_EMAIL

The sender email address for SendGrid. REQUIRED.

Type:

str

rctab_infrastructure.constants.EXPIRY_EMAIL_FREQ

The list of days to send expiry email notification. REQUIRED.

Type:

str

rctab_infrastructure.constants.NOTIFIABLE_ROLES

The roles to notify. Defaults to an empty string.

Type:

str

rctab_infrastructure.constants.ROLES_FILTER

The roles to filter. Defaults to an empty string.

Type:

str

rctab_infrastructure.constants.ADMIN_EMAIL_RECIPIENTS

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

Type:

str

rctab_infrastructure.constants.IGNORE_WHITELIST

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

Type:

str

rctab_infrastructure.constants.WHITELIST

The subscription UUID whitelist. Defaults to an empty string.

Type:

str

rctab_infrastructure.constants.LOG_LEVEL

The log level. Defaults to an empty string.

Type:

str

rctab_infrastructure.constants.DB_SKU_TYPE

A dict containing the database SKU name and type.

Type:

dict

rctab_infrastructure.constants.BILLING_ACCOUNT_ID

The billing account ID. REQUIRED.

Type:

str

rctab_infrastructure.constants.BILLING_PROFILE_ID

The billing profile ID.

Type:

str