Environment variables
Properties that can be passed to the CDC agent during deployment are listed below. Many of these properties are mandatory for the agent to verify your identity and perform CDC operations.
Read the individual installation articles for more information about acquiring these details as you set up resources for the CDC agent.
Universal variables
| Environment Variable |
Required |
Default |
Description |
| ID_AGENT |
Yes |
None |
Generated through the Data Loader UI when creating a new agent—this property is required for identity verification. |
| ID_ORGANIZATION |
Yes |
None |
Provided to you by Matillion. Please reach out to Matillion if you do not have this to hand. |
| PLATFORM_WEBSOCKET_ENDPOINT |
Yes |
None |
This value must be set to wss://ws-<region>.matillion-cdc-prod.matillion.com:443/ws where <region> is either eu or us depending on the Data Loader region you are building the pipeline in. Template users should ensure this value is correct in their templates before attempting the install. |
AWS
| Environment Variable |
Required |
Default |
Description |
| PLATFORM_KEY_NAME |
Yes |
None |
The name of the AWS Secrets Manager secret in which your generated private key is stored. Consult the AWS Secrets Manager documentation for more information about creating a secrets manager in AWS. |
Azure
| Environment Variable |
Required |
Default |
Description |
| AZURE_STORAGE_KEY |
Yes |
None |
The Storage Access Key for your Blob Storage container. |
| AZURE_SECRET_KEY_VAULT_URL |
Yes |
None |
The URL of your Azure key vault. This is typically in the following format: https://<vault-name>.vault.azure.net. This must be provided if you have selected azure-key-vault as your PLATFORM_KEY_PROVIDER. |
| AZURE_TENANT_ID |
Yes |
None |
The Tenant ID of your Azure Active Directory. |
| PLATFORM_KEY_PROVIDER |
Yes |
None |
Should be set to azure-key-vault. |
| SECRET_PROVIDERS |
Yes |
None |
Should be set to azure-key-vault:1. |
GCP
| Environment Variable |
Required |
Default |
Description |
| GCP_PROJECTID |
Yes |
None |
This is your Google Cloud Project ID. |
| INSTANCE_NAME |
Yes |
None |
Name of the Compute Engine instance. For example, matillion-cdc-agent. |
| STORAGE_BUCKET_NAME |
Yes |
None |
Name of the Google Cloud Storage bucket where the agent will land the data. |
| PLATFORM_KEY_NAME |
Yes |
None |
The name of the key storing your platform secret that is generated the first time you attempt to create an agent. |
| PLATFORM_KEY_PROVIDER |
Yes |
None |
The service that supplies your platform key. This must be google-secret-manager for the GKE Template. |
| SECRET_PROVIDERS |
Yes |
None |
The service that holds your database passwords. This must be google-secret-manager:1 for the GKE Template. |
| DATABASE_PASSWORD_SECRET_NAME |
Yes |
None |
Name of the source databases password secret stored in Google Secret Manager. |