Skip to main content

Sidecar Environment Variables

Key

Required/Optional

Description

Example

AWS_DEFAULT_REGION

Required

AWS region for Secrets Manager and other AWS services. These are required for database credential retrieval

us-east-2

AWS_REGION

Required

SIDECAR_DATAPLANE_BASE_URL

Required

The base URL for the control plane API that manages configuration and policies. This is the Data Plan URL that you copy from ALTR once you register the sidecar to ALTR.

https://sc-data-trunnion1.568950776381.sandbox.ct.dev.altr.com

SIDECAR_ID

Required

Unique identifier for this specific sidecar instance. It is used to identify this sidecar in the control plane. This is the Sidecar ID that you copy from ALTR once you register the sidecar to ALTR.

1db4ee3c-0e1d-43cc-a5ef-ee8cb209a2ea

SIDECAR_ORG_ID

Required

Your organization’s identifier in ALTR. This ID is used for auditing, telemetry and configuration retrieval. This is the Client ID visible once you register the sidecar to ALTR.

8cd73ffc-2826-4b87-a10b-f9b04afeb6c0

SIDECAR_POLICY_REFRESH_INTERVAL

Optional

Defines how often (in minutes) to refresh policies from the control plane.

1

ALTR_PRIVATE_KEY_PATH

Optional

Defines the location of a mounted private key. If not provided, the sidecar assumes a mounted key exists as /app/private.pem

--

ALTR_PRIVATE_KEY_CONTENT

Optional

The private key in the key-pair used to authenticate the sidecar in ALTR’s control plane. The public key is registered in ALTR.. Do not provide this variable if you have mounted your private key to the sidecar.

-----BEGIN PRIVATE KEY----- ABC ....DEF-----END PRIVATE KEY-----