|
| 1 | +--- |
| 2 | +title: Back up and restore YugabyteDB Anywhere |
| 3 | +headerTitle: Back up and restore YugabyteDB Anywhere |
| 4 | +description: Use a script to back up and restore YugabyteDB Anywhere. |
| 5 | +headcontent: Back up your YugabyteDB Anywhere installation |
| 6 | +linkTitle: Back up YugabyteDB Anywhere |
| 7 | +menu: |
| 8 | + stable_yugabyte-platform: |
| 9 | + identifier: back-up-restore-1-yba |
| 10 | + parent: administer-yugabyte-platform |
| 11 | + weight: 30 |
| 12 | +aliases: |
| 13 | + - /stable/yugabyte-platform/administer-yugabyte-platform/back-up-restore-yp/ |
| 14 | +type: docs |
| 15 | +--- |
| 16 | + |
| 17 | +YugabyteDB Anywhere installations include configuration settings, certificates and keys, and other components required for creating and managing YugabyteDB universes. |
| 18 | + |
| 19 | +<ul class="nav nav-tabs-alt nav-tabs-yb"> |
| 20 | + <li > |
| 21 | + <a href="../back-up-restore-yba/" class="nav-link active"> |
| 22 | + <i class="fa-solid fa-cloud"></i> |
| 23 | + YugabyteDB Anywhere |
| 24 | + </a> |
| 25 | + </li> |
| 26 | + <li> |
| 27 | + <a href="../back-up-restore-installer/" class="nav-link"> |
| 28 | + <i class="fa-solid fa-building"></i> |
| 29 | + YBA Installer</a> |
| 30 | + </li> |
| 31 | + <li> |
| 32 | + <a href="../back-up-restore-k8s/" class="nav-link"> |
| 33 | + <i class="fa-regular fa-dharmachakra" aria-hidden="true"></i> |
| 34 | + Kubernetes |
| 35 | + </a> |
| 36 | + </li> |
| 37 | + |
| 38 | +</ul> |
| 39 | + |
| 40 | +If you aren't running [high availability](../high-availability/), use automated backups to take regularly scheduled backups of your YugabyteDB Anywhere installation for recovery in case of the loss of the node running your YugabyteDB Anywhere instance. |
| 41 | + |
| 42 | +You can also perform ad hoc manual backups. |
| 43 | + |
| 44 | +## Set up automatic backups |
| 45 | + |
| 46 | +Before you can set up automatic backups of YugabyteDB Anywhere, you need to [configure a storage location](../../back-up-restore-universes/configure-backup-storage/) for the backups. |
| 47 | + |
| 48 | +Automatic backups do not include universe Prometheus data, but they do include locally stored YugabyteDB releases. |
| 49 | + |
| 50 | +To configure automatic backups of your YugabyteDB Anywhere installation, do the following: |
| 51 | + |
| 52 | +1. Navigate to **Admin>Platform HA and Backups** and select **Automated Platform Backups**. |
| 53 | +1. Click **Set up automated platform backups** (or **Edit** if already configured). |
| 54 | +1. Select the storage configuration you want to use for the backup. For more information, see [Configure backup storage](../../back-up-restore-universes/configure-backup-storage/). |
| 55 | +1. Enter a name for the folder where you want to store the backups. |
| 56 | + |
| 57 | + If you are backing up more than one YugabyteDB Anywhere instance to the same storage, provide a name that uniquely identifies the instance you are backing up. For example, `yba_104.72.167.2_backups`. |
| 58 | + |
| 59 | +1. Enter the backup frequency in minutes. 5 minutes works well for most purposes. More frequent backups provide more recovery points but may impact performance. |
| 60 | +1. Click **Apply Changes**. |
| 61 | + |
| 62 | +Click **Remove** to disable periodic backups (this stops automatic backups but does not delete existing backup files). |
| 63 | + |
| 64 | +## Back up manually |
| 65 | + |
| 66 | +You can manually back up your YugabyteDB Anywhere installation. Manual backups can include Prometheus data and YugabyteDB releases, in addition to your YugabyteDB Anywhere settings and metadata. |
| 67 | + |
| 68 | +Manual backups are stored locally on the node that hosts your installation. |
| 69 | + |
| 70 | +Perform a manual backup: |
| 71 | + |
| 72 | +- Before upgrading YugabyteDB Anywhere. |
| 73 | +- When migrating YugabyteDB Anywhere to a different host. |
| 74 | +- When you need to include Prometheus metrics data. |
| 75 | +- For ad-hoc backups outside your periodic backup schedule. |
| 76 | + |
| 77 | +To create a one-time backup: |
| 78 | + |
| 79 | +1. Navigate to **Admin>Platform HA and Backups** and select **Automated Platform Backups**. |
| 80 | +1. Click **One-Time Platform Export**. |
| 81 | +1. Select the data you want to back up. |
| 82 | + |
| 83 | + - **Platform Metadata**: YugabyteDB Anywhere instance settings and metadata. |
| 84 | + - **Local YugabyteDB Releases**: [YugabyteDB releases](../../manage-deployments/ybdb-releases/) stored on universe nodes. |
| 85 | + - **Universe Metrics (Prometheus Data)**: Prometheus metrics data for your universes. |
| 86 | + |
| 87 | +1. Specify the destination for the backup, as a full path. For example, `/opt/yugabyte/yba_backups` or `/tmp/yba_export`. |
| 88 | + |
| 89 | + Ensure the directory exists and the `yugabyte` user has write permissions for the location. |
| 90 | + |
| 91 | + The backup is saved as a `.tar.gz` file with a timestamped name. |
| 92 | + |
| 93 | +1. Click **Export**. |
| 94 | + |
| 95 | + You can monitor progress of the backup on the **Tasks** page. |
| 96 | + |
| 97 | +## Restore YugabyteDB Anywhere |
| 98 | + |
| 99 | +When restoring YugabyteDB Anywhere (for example, after the loss of the node running YugabyteDB Anywhere): |
| 100 | + |
| 101 | +1. Create an fresh YugabyteDB Anywhere installation, either on the existing node after it is recovered, or on a new node. |
| 102 | +1. Using the new YugabyteDB Anywhere instance, restore from the most recent backup. |
| 103 | + |
| 104 | +When doing a restore, YugabyteDB Anywhere performs the following checks: |
| 105 | + |
| 106 | +- Existing universes. By default, due to the possibility of data loss, you can only do a restore if your instance is not managing any universes. You can override this by setting the **Allow YBA Restore With Universes** Global Runtime Configuration option (config key `yb.yba_backup.allow_restore_with_universes`) to true. |
| 107 | + |
| 108 | +- The selected backup is not older than one day. By default you cannot restore from backups older than one day, as the backup may be inconsistent if you performed management operations after the backup was taken. You can override this by setting the **Allow YBA Restore With Old Backup** Global Runtime Configuration option (config key `yb.yba_backup.allow_restore_with_old_backup`) to true. |
| 109 | + |
| 110 | +Refer to [Manage runtime configuration settings](../../administer-yugabyte-platform/manage-runtime-config/). Note that only a Super Admin user can modify Global configuration settings. |
| 111 | + |
| 112 | +### Restore from automated backups |
| 113 | + |
| 114 | +To restore a YugabyteDB Anywhere backup from external storage: |
| 115 | + |
| 116 | +1. If YugabyteDB Anywhere is not installed, [install it](../../install-yugabyte-platform/install-software/installer/). |
| 117 | +1. Navigate to **Admin>Platform HA and Backups** and select **Automated Platform Backups**. |
| 118 | +1. Click **Advanced Restore**. |
| 119 | + |
| 120 | + If YugabyteDB Anywhere detects existing universes, a warning is shown about potential data loss. |
| 121 | + |
| 122 | +1. Select **Cloud Backup**. |
| 123 | +1. Select the storage configuration for the backup you want to restore. |
| 124 | +1. Enter the name of the folder that you specified for the periodic backup you are restoring (for example, `yba_104.72.167.2_backups`). |
| 125 | +1. Click **Restore**. |
| 126 | + |
| 127 | +YugabyteDB Anywhere restores the most recent backup and restarts automatically after the restore finishes. |
| 128 | + |
| 129 | +### Restore from a manual backup |
| 130 | + |
| 131 | +To restore a YugabyteDB Anywhere backup from a manual backup: |
| 132 | + |
| 133 | +1. If YugabyteDB Anywhere is not installed, [install it](../../install-yugabyte-platform/install-software/installer/). |
| 134 | +1. Navigate to **Admin>Platform HA and Backups** and select **Automated Platform Backups**. |
| 135 | +1. Click **Advanced Restore**. |
| 136 | + |
| 137 | + If YugabyteDB Anywhere detects existing universes, a warning is shown about potential data loss. |
| 138 | + |
| 139 | +1. Select **Local Backup**. |
| 140 | +1. Enter the full file path to the backup file. |
| 141 | + |
| 142 | + For example, `/opt/yba_backups/yba_backup_20240115_120000.tar.gz`. |
| 143 | + |
| 144 | +1. Click **Restore**. |
| 145 | + |
| 146 | +YugabyteDB Anywhere restores from the backup and restarts automatically after the restore finishes. |
0 commit comments