See below to back up the state of a PKI Hub installation comprising one or more nodes.

As explained in Installing PKI Hub, only prod-mode installations support state backup and restore.

Backing up the state of a single-node PKI Hub installation

When installed on a single node, follow the steps below to back up the PKI Hub installation state.

To back up the state of a single-node PKI Hub installation

  1. Run the clusterctl backup create command to generate a backup file – for example:
    $ sudo clusterctl backup create --file /home/sysadmin/202341014.bkp --password 7Txsxu
  2. If the deployed solutions use databases, back up the database contents according to the DBMS vendor's instructions.
  3. If the deployed solutions use an HSM (Hardware Security Module) to protect private keys, back up the device using the HSM vendor's tools. 

    If you previously ran the clusterctl backup create command, for example when Backing up the PKI Hub state, you do not need to back up HSM-protected keys. The backup file generated by the command includes these keys.

  4. Move all the backup data from the PKI Hub node to a secure location – for example, using an SFTP client.

Backing up the state of a multi-node PKI Hub installation

When installed in several nodes, perform the step below in any node to back up the state of the PKI Hub installation

To back up the state of a multi-node PKI Hub installation

  1. Run the clusterctl backup create command to generate a backup file – for example: 
    $ sudo clusterctl backup create --file /home/sysadmin/202341014.bkp --password 7Txsxu
  2. Manually back up the following data.
  3. Follow the steps described in Backing up the configuration of a solution to back up the CA Gateway, Certificate Enrollment Gateway, and Certificate Manager solutions.  

    The settings of the other solutions are automatically included in the backup file generated with the clusterctl backup create command.

  4. If the deployed solutions use databases, back up the database contents according to the DBMS vendor's instructions.
  5. If the deployed solutions use an HSM (Hardware Security Module) to protect private keys, back up the device using the HSM vendor's tools. 

    If you previously ran the clusterctl backup create command (for example, when Backing up the PKI Hub state), you do not need to back up HSM-protected keys. The backup file generated by the command includes these keys.

  6. Move all the backup data from the PKI Hub node to a secure location – for example, using an SFTP client.