Install the ALTR Sidecar
Installing the ALTR sidecar deploys the sidecar container on your infrastructure and configures it to communicate with ALTR’s SaaS control plane for policy information, telemetry, and database activity monitoring. How you run that container — as a Docker container, in Kubernetes, or through another method — depends on your own infrastructure and environment; this section doesn’t prescribe one.
In this section
Section titled “In this section”- Sidecar Authentication — Generate the RSA key pair the sidecar uses to authenticate to ALTR.
- Sidecar Environment Variables — Configure the environment variables the sidecar container reads on startup.
- Sidecar Networking — Configure inbound access from data consumers and outbound access to the database and to ALTR.
Prerequisites
Section titled “Prerequisites”- A validated database is deployed for the sidecar to connect to.
- A host able to run the sidecar’s Docker image, or, as an alternative installation method, its RPM package. The sidecar image is published on ALTR’s Amazon Elastic Container Registry listing.
- A credential provider configured to supply the database’s credentials to the sidecar: AWS Secrets Manager, Azure Key Vault, Environment Variable, or a Local File. See Sidecar Environment Variables.
- A sidecar has been registered in ALTR, to obtain the Sidecar ID, ALTR Organization ID, and Data Plane URL the container needs at startup.
- Single sign-on (SSO) and System for Cross-domain Identity Management (SCIM) enabled in ALTR — see Identity Providers for Okta and Microsoft Entra ID setup — and at least one user assigned the Data Consumer role — needed only to test an impersonation connection after the sidecar is installed, not to deploy the sidecar itself.
Required Information
Section titled “Required Information”Installing the sidecar itself requires only the sidecar’s (or load balancer’s) hostname and the listener port it will present to data consumers.
Two related steps need additional information, covered on their own pages:
- Creating a repository user or repository service user requires the database credential’s username and password. See Register Repository Users.
- Registering the repository and binding a listener port to it requires the database’s hostname and port. See Register Repositories and Bind a Sidecar Listener Port to a Repository.