Skip to main content

Environment Variables

Environment variables defined within the container enable dynamic configuration of all Request Manager Agent properties and operations.

Request Manager Agent Configuration

The Request Manager Agent's runtime behavior is controlled by the DATAGRAIL_AGENT_CONFIG environment variable. This configuration defines the target systems for integration, the locations of associated credentials, and metadata used to parameterize privacy request execution logic. A properly formatted configuration variable is required for successful Agent startup.

NameValue
DATAGRAIL_AGENT_CONFIGobject(AgentConfig)
JSON object that defines connectors, credential locations, cloud storage, etc.

AgentConfig Schema

Fields
connections[]object(Connection) (required)
Defines the target systems, their capabilities and privacy request logic.
customer_domainstring (required)
Your DataGrail domain.
datagrail_agent_credentials_locationstring (required)
Location of the OAuth Client Credentials.
datagrail_credentials_locationstring (required)
Location of the Callback Token.
platformobject(Platform) (required)
Credentials and cloud storage providers to use.
redis_urlstring (optional)
Used for multi-node deployments that need to share an external Redis instance.
job_timeout_secondsinteger (optional)
Duration in seconds before a job times out. The default is 180 (3 minutes).
JSON Representation
{
"connections": [
object(Connection)
],
"customer_domain": string,
"datagrail_agent_credentials_location": string,
"datagrail_credentials_location": string,
"platform": object(Platform),
"redis_url": string,
"job_timeout_seconds": integer
}

Cloud Provider Credentials

Enables cloud provider credentials to be set when role-based access controls are unavailable (e.g., local development environment).

Best Practice

When deploying the agent, the use of role-based access controls is recommended so long-lived credentials are not stored in plain text in the container's environment.

Amazon Web Services

NameValue
AWS_ACCESS_KEY_IDAWS access key associated with an IAM account.
AWS_SECRET_ACCESS_KEYSecret key associated with the access key. This is essentially the "password" for the access key.
AWS_REGIONThe AWS Region to send the request to.

Google Cloud Platform

NameValue
GOOGLE_APPLICATION_CREDENTIALS_JSONExtracted Google credentials file JSON.

Microsoft Azure

NameValue
AZURE_TENANT_IDThe Azure Active Directory tenant (directory) ID.
AZURE_CLIENT_IDThe client (application) ID of an App Registration in the tenant.
AZURE_CLIENT_SECRETA client secret that was generated for the App Registration.

 

Need help?
If you have any questions, please reach out to your dedicated Account Manager or contact us at support@datagrail.io.

Disclaimer: The information contained in this message does not constitute as legal advice. We would advise seeking professional counsel before acting on or interpreting any material.