Soon, all Red Hat OpenShift documentation will only be available on docs.redhat.com, the official location of all Red Hat product documentation. Get familiar with the updated experience today!
  1. Documentation
    2. history
×

Backing up Central database by using the roxctl CLI

Central stores information about the following:

  • Activity observed in your clusters

  • Information retrieved from integrated image registries or Scanners

  • Red Hat Advanced Cluster Security for Kubernetes (RHACS) configuration

Backing up the Central database is critical to ensure data integrity and system reliability. Regular backups of the database, which contain the necessary configurations, resources, events, and certificates, protect against database failures, corruption, and accidental data loss.

You can use the roxctl CLI to back up and restore the Central database by using the backup command. This command requires an API token or your administrator password.

On-demand backups by using an API token

You can back up the entire database of RHACS by using an API token.

Prerequisites

  • You have an API token with the Admin role.

  • You have installed the roxctl CLI.

Procedure

  1. Set the ROX_API_TOKEN and the ROX_ENDPOINT environment variables by running the following commands:

    $ export ROX_API_TOKEN=<api_token>
    $ export ROX_ENDPOINT=<address>:<port_number>

  2. Initiate a backup for Central by running the following command:

    $ roxctl central backup (1)
    1 You can use the --output option to specify the backup file location.

    By default, the roxctl CLI saves the backup file in the directory where you run the command.

Additional resources

On-demand backups by using the administrator password

You can back up the entire database of RHACS by using your administrator password.

Prerequisites

  • You have the administrator password.

  • You have installed the roxctl CLI.

Procedure

  1. Set the ROX_ENDPOINT environment variable by running the following command:

    $ export ROX_ENDPOINT=<address>:<port_number>

  2. Initiate a backup for Central by running the following command:

    $ roxctl -p <admin_password> central backup (1)
    1 For <admin_password>, specify the administrator password.

    By default, the roxctl CLI saves the backup file in the directory in which you run the command. You can use the --output option to specify the backup file location.