Backup and Restore CE

The purpose of this page is to document the backup & restore process for Private Cloud Director Community Edition (CE).

Community Edition backup & restore process

The backup process for Community Edition is:

• Create a backup using airctl backup. The resulting backup file will be saved in the /tmp directory on the CE host.
• Save backup copies of the k3s.yaml and airctl-config.yaml configuration files as well.
• Move the backup file, and copy the other files to another directory to prevent unintentional overwrite.

The restore process for Community Edition is:

• airctl unconfigure-du will stop the Community Edition management plane, including all of its Kubernetes pods, but will leave the Kubernetes install in place.
• airctl restore uses the backup file to rebuild & restore your Community Edition installation.

The full command list is outlined below:

# Creating a backup, which saves to /tmp

/opt/pf9/airctl/airctl backup --config /opt/pf9/airctl/conf/airctl-config.yaml

​

# Creating a backup directory, and moving the backup file there

mkdir backups

mv /tmp/backup_* backups

​

# Saving a copy of k3s and airctl configuration files

cp /opt/pf9/airctl/conf/airctl-config.yaml backups/

cp /etc/rancher/k3s/k3s.yaml backups/

​

# Unconfiguring the CE deployment unit

/opt/pf9/airctl/airctl unconfigure-du --config /opt/pf9/airctl/conf/airctl-config.yaml

​

# Restoring the deployment unit from the backup

/opt/pf9/airctl/airctl restore --config /opt/pf9/airctl/conf/airctl-config.yaml --backupdir backups