Skip to main content

Register Sidecar

Notice

Prerequisites:

  • Hostname is established that can be used to access a sidecar instance

  • RSA key pair has been generated for sidecar authentication

  • ALTR sidecar is installed. Contact ALTR Support to get started

Registering a sidecar in ALTR provides the necessary information for the sidecar to securely connect with ALTR and retrieve policy and configuration information. Communication is always initiated by the sidecar; ALTR never reaches into your environment.

To register a sidecar and sidecar port to ALTR:

  1. Log into ALTR via Okta.

  2. Select Settings → Sidecars in the Navigation menu.

  3. Click Register Sidecar.

  4. Enter a Display Name. This is a user-friendly name to identify your sidecar.

  5. Enter Hostname of the sidecar in RFC 1123 specification, which is a URL without http://. This is the DSN name of the network load balancer.

  6. Enter Public Key of the sidecar. This is the public key from your RSA private-public key pair.

    Note

    The Public Key must begin with -----BEGIN RSA PUBLIC KEY----- and end with -----END PUBLIC KEY-----. For example:

    -----BEGIN PUBLIC KEY-----
ab59a....sja8
-----END PUBLIC KEY-----

  7. (Optional) Expand Advanced Settings and enable Allow unsupported queries if you want queries that can't be parsed to run instead of fail, which may result in unauthorized data access. This setting applies only to access management policies, not impersonation policies.

  8. Click Register.

    Note

    In addition to the public key registered, a second public key field displays. This is used to rotate keys. Learn more.

After registering a sidecar in ALTR, use the returned Sidecar ID, Data Plane URL and ALTR Organization ID to install the sidecar in your environment.

Once a sidecar is registered, ALTR displays information for all instances of that sidecar that have connected to ALTR. A single configured sidecar can have multiple installed instances.

Remove Sidecar

Removing a sidecar from ALTR prevents repository users from accessing data repositories using this sidecar. You must remove relevant sidecar listener ports before removing a sidecar.

To remove a sidecar from ALTR:

  1. Log into ALTR via Okta.

  2. Select Settings → Sidecars in the Navigation menu.

  3. Click the sidecar to view details.

  4. Click Remove Sidecar; a modal displays to confirm.

  5. Click Remove Sidecar.

In this section: