ae5-conda
environment contains all the tools you need to backup and restore Workbench; for more information, see Administration server.
ae5-conda
environment, it is a good idea to update the ae5_backup_restore
package to the latest version before continuing. You can update the package by running the command:ae_backup.sh
script to create backup files of your cluster in the current directory:
YYYYMMDDHHMM
is the format for the timestamp of your backup data.ae5_config_db
file stores your Kubernetes resources and Postgres data.ae5_data
file stores your /opt/anaconda/storage
data.Option | Description |
---|---|
| Prints help and exits. |
| Changes the location of the Workbench storage. The default location is /opt/anaconda/storage . Do not update the location of Workbench storage on Gravity clusters! |
| Changes the location where the backup files are saved. The default location is the current directory. Use this option when the space in the current directory is insufficient to hold the backup. |
| Prevents the removal of intermediate files generated during the backup process. This is useful for informational or debugging purposes. |
| The script will only create the config/postgres tarball without a data tarball. This is useful if combined with an alternate mechanism for taking snapshots or backups of the data. |
| Includes the full package repository in the data tarball. By default, this is not included because the repository is typically large and incompressible. |
Option | Description |
---|---|
| Prints help and exits. |
| Changes the location of the Workbench storage. Default: /opt/anaconda/storage. Should not be changed when used on a Gravity cluster. |
| Changes the location where backup files are found. Default: current directory. Use when space in the current directory is insufficient. |
| Prevents the removal of intermediate files generated during the backup process. Useful for debugging or informational purposes. |
| Allows the hostname to be modified. Automatically triggers --restore-certs and --restore-configmap when supplied. If this option is not supplied, the existing SSL certificates and configmap are used. |
| Restores SSL certificates from a backup, even if the hostname does not change. |
| Restores the system’s configmap from a backup, even if the hostname does not change. |
| Only restores configuration data (SSL, secrets, configmaps, and so on) without modifying the Postgres database and data. |
| Specifies the PostgreSQL version to use when patching the database StatefulSet during a restore. The version must already exist in the same registry as the current PostgreSQL image. If not, the restore process will fail until the image is available. |
| Waits for system pods to stabilize before exiting the script. |
| Leaves the cluster in a paused state upon completion of the restore process. |
| Skips confirmation prompts during restore. Use with caution. |
-c
, --config-db
command line argument, as the backup script will only be able to capture your Workbench configuration data. This will not capture user/project data, and you will need to ensure you are taking regular backups of your provided storage solution. This includes the Persistent Volume used for both anaconda-storage and anaconda-persistence that were configured at time of install.
When restoring from a backup, you will need to supply the -c
, --config-only
command line option, as the restore script will only be able to restore your Workbench configuration data. This will not restore user/project data, and you will need to ensure you have also restored a backup of your provided storage solution.