The Backup and Restore Operator provides the ability to back up and restore the Rancher application running on any Kubernetes cluster.
What the Backup Restore Operator is not:
This is the current branch strategy for rancher/backup-restore-operator
, it may change in the future.
Branch | Tag | Rancher |
---|---|---|
main |
head |
main branch (head ) |
release/v5.0 |
v5.x.x |
v2.9.x |
release/v4.0 |
v4.x.x |
v2.8.x |
release/v3.0 |
v3.x.x |
v2.7.x |
You will need to install the backup-restore-operator
, from the Cluster Explorer UI.
Within the App catalog look for the Rancher Backups
application chart.
However, when performing a Rancher migration you will not have the UI installed.
So, you will need to install the charts via helm repo
by executing the commands below.
First, add the rancher-charts
charts repository.
helm repo add rancher-charts https://charts.rancher.io
helm repo update
Then, install both charts. Ensure that the CRD chart is installed first.
helm install --wait \
--create-namespace -n cattle-resources-system \
rancher-backup-crd rancher-charts/rancher-backup-crd
helm install --wait \
-n cattle-resources-system \
rancher-backup rancher-charts/rancher-backup
If you are using S3, you can configure the s3.credentialSecretNamespace
to determine where the Backup and Restore Operator will look for the S3 backup secret. For more information on configuring backups, see the backup documentation.
If you are uninstalling and want to keep backup(s), ensure that you have created Backup CR(s) and that your backups are stored in a safe location. Execute the following commands to uninstall:
helm uninstall -n cattle-resources-system rancher-backup
helm uninstall -n cattle-resources-system rancher-backup-crd
kubectl delete namespace cattle-resources-system
The default chart is built for the use case of backing up and restoring the Rancher application. However, under the hood the Backup Restore Operator is a rather flexible extension for backup and restore of Kubernetes resources.
ownerReferences
on all resources, hence maintaining dependencies between objects.It installs the following cluster-scoped CRDs:
A backup can be performed by creating an instance of the Backup CRD. It can be configured to perform a one-time backup, or to schedule recurring backups. For help configuring backups, see this documentation.
Creating an instance of the Restore CRD lets you restore from a backup file. For help configuring restores, see this documentation.
ResourceSet specifies the Kubernetes core resources and CRDs that need to be backed up. This chart comes with a predetermined ResourceSet to be used for backing up Rancher application
For help configuring the storage location, see this documentation.
If you are using S3 to store your backups, the Backup
custom resource can reference an S3 credential secret in any namespace. The credentialSecretNamespace
directive tells the backup application where to look for the secret:
s3:
bucketName: ''
credentialSecretName: ''
credentialSecretNamespace: ''
enabled: false
endpoint: ''
endpointCA: ''
folder: ''
insecureTLSSkipVerify: false
region: ''
Refer to DEVELOPING.md for developer tips, tricks, and workflows when working with the backup-restore-operator
.
Refer to troubleshooting.md for troubleshooting commands.