MariaDB Agent Manager Credentials File Reference

Encryption and Ingestion

The credentials file must be ingested using the mariadb_agent_manager encrypt-creds sub-command, which also encrypts the credentials:

$ mariadb_agent_manager encrypt-creds -p ~/credentials.json

The following files have been successfully created:
Encrypted credentials:    /home/USER/.config/mariadb-agent-manager/cred.json
Secret key:               /home/USER/.config/mariadb-agent-manager/.key.txt

• The -p option specifies the path to the credentials file. Alternatively, the REMOTE_AGENT_CREDENTIALS environment variable can be used.

MariaDB Agent Manager encrypts the credentials and saves the encrypted credentials to its configuration directory.

After the credentials have been encrypted, MariaDB Agent Manager deletes the credentials file. If you need to preserve the credentials file, ensure that you have a backup.

Path

When executing the mariadb_agent_manager encrypt-creds sub-command, the path to the credentials file can be specified using the -p flag or by setting the REMOTE_AGENT_CREDENTIALS environment variable.

Consistency

The MariaDB Agent Manager credential file is not required to be consistent on all hosts. Each host can have a separate credentials file, containing only the credentials required by that host's components.

Format

The MariaDB Agent Manager credentials file uses the JSON format.

Sections

The MariaDB Agent Manager credentials file contains two types of sections:

Example

Expand the sections below to see examples of credentials files.

{
  "cred_store": {
    "mariadb": {
      "user": "ros",
      "pwd": "USER_PASSWORD"
    }
  }
}

{
  "cred_store": {
    "mariadb": {
      "user": "ros",
      "pwd": "USER_PASSWORD"
    }
  }
}

{
  "cred_store": {
    "maxscale": {
      "user": "ros",
      "pwd": "USER_PASSWORD"
    }
  }
}