Secrets Management

Secrets management #

This page guides you through the general steps to access and retrieve secrets from AWS Secrets Manager or Azure Key Vault using Arcion Replicant.

Overview #

Secrets management allows you to protect sensitive information like passwords, keys, tokens, and so on. To ensure effective and secure secrets management for enterprises, Arcion supports the following secrets management services:

Replicant works seamlessly with both AWS Secrets Manager and Azure Key Vault. When you start a replication job, specify the necessary options for using a secrets management service. This means you don’t need to separately run Replicant to fetch secrets. Replicant automatically fetches the necessary credentials for a replication job according to your specifications.

Use a secrets management service #

Follow these steps to use a secrets management service with Arcion Replicant in a replication job:

Configure secrets management details #

Replicant requires an optional configuration file containing all the details about secrets management. The configuration file specifies the following details:

  • The secrets management service: AWS Secrets Manager or Azure Key Vault
  • Password rotation and the number of secrets cache retries
  • Authentication credentials and secret details

For more information about the secrets management configuration file, see Configure Secrets Manager details and Configure Key Vault details.

If you don’t specify the secrets management configuration file, Arcion looks for authentication credentials in the following locatons:

  • The AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables. We recommend setting these variables.
  • The aws.accessKeyId and aws.secretKey Java system properties.
  • Web identity token from the environment or container.
  • The shared credentials file in the default location.
  • The Amazon ECS container credentials. You must set the AWS_CONTAINER_CREDENTIALS_RELATIVE_URI system environment variable and Secrets Manager must have the permission to access the variable.
  • Amazon EC2 instance IAM role-provided credentials through the Amazon EC2 metadata service.

Environment variables holding service principal authentication credentials. For example, you can use the following commands in a bash shell to set the environment variables:


Replace TENANT_ID, CLIENT_ID, and CLIENT_SECRET with the actual authentication credentials values.

Arcion then uses the values of these environment variables to authenticate with Azure Active Directory (Azure AD). These variables represent the same set of credentials you specify under namespaces when you use the secrets management configuration file.

Specify secrets URI in the connection configuration file #

To locate and access a secret in AWS Secrets Manager or Azure Key Vault, Arcion uses the following URI format for each secret:


The preceding URI structure contains the following elements:

  • NAMESPACE represents the secret name in AWS Secrets Manager, or the key vault name in Azure Key Vault. Replace NAMESPACE with the namespace name you specify under the namespaces field of the secrets management configuration file. For more information, see the description of namespaces for AWS Secrets Manager and Azure Key Vault.
  • KEY, for AWS Secrets Manager, represents the key of the secret whose value Arcion must retrieve. For Azure Key Vault, KEY represents the secret name whose value which Arcion must retrieve.

The following sample connection configuration file for a source MySQL specifies the host, port, username, and password credentials using secrets URI:

type: MYSQL

host: arcion-sm://mysql_src/host
port: arcion-sm://mysql_src/port
username: arcion-sm://mysql_src/username
password: arcion-sm://mysql_src/password

slaveServerIds: [1]
maxConnections: 20

maxRetries: 10
retryWaitDurationMs: 1000

Run Replicant #

Run Replicant with the following options:


Specifies the secrets management service you want to use:


Use AWS Secrets Manager as the secrets management service.


Use Azure Key Vault as the secrets management service.


Replicant expects credentials to be in plain text in the configuration file. Therefore, Replicant doesn't look for credentials in any secrets management service.


Location to the secrets management YAML configuration file. For more information, see Use AWS Secrets Manager and Use Azure Key Vault.

For example, the following command tests the connection to a MySQL server using secrets from AWS Secrets Manager:

./bin/replicant test-connection conf/conn/mysql.yaml \
--validate conf/validate/validate.yaml \
--use-sm-provider AWS \
--secret-manager conf/secretmanager/aws_example.yaml