Skip to content

Jira DOC-715: RC: Update Backup database article to reflect new UX #1419

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jul 29, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
136 changes: 95 additions & 41 deletions content/rc/databases/back-up-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,50 +13,103 @@ aliases: [ "/rv/administration/configure/backups/",
"/rc/databases/backups/" ]
---

The backup process for Redis Enterprise Cloud databases depends on your plan:
The backup options for Redis Enterprise Cloud databases depend on your plan:

- Flexible and Annual can use the **Backup** icon on the **View Database** screen or schedule regular backups.
- Flexible and Annual subscriptions can perform backups on-demand and schedule daily backups that occur during a set hour.

- Paid Fixed plans run scheduled backups every 24 hours.
- Paid Fixed plans can perform backups on-demand and schedule backups that occur every 24 hours.

- Free plans do not back up automatically.

Backups are saved to pre-defined storage locations available to your subscription.

Backup locations need to be available before you enable database backups. To learn more, see [Set up backup storage locations](#set-up-backup-storage-locations)

Here, you'll learn how to store backups using different cloud providers.

## Back up to Amazon Simple Storage Service (AWS S3)
## Enable backups

To enable backups for a database:

1. Sign in to the Redis Cloud [admin portal](https://app.redislabs.com/new/). (Create an account if you don't already have one.)

2. If you have more than one subscription, select the target subscription from the list. This displays the **Databases** tab for the selected subscription.

{{<image filename="images/rc/subscription-flexible-databases-tab-pending.png" alt="The Databases tab summarizes databases created for a given subscription." >}}{{< /image >}}

3. Select the database to open the **Database** page and then select **Edit database**.

{{<image filename="images/rc/database-details-configuration-tab-general-flexible.png" width="75%" alt="The Configuration tab of the Database details screen." >}}{{< /image >}}

4. In the **Durability** section of the **Configuration** tab, locate the **Remote backup** setting:

{{<image filename="images/rc/database-details-configuration-tab-durability-flexible.png" alt="The Remote backup setting is located in the Durability section of the Configuration tab of the database details screen." >}}{{< /image >}}

When you enable **Remote backup**, additional options appear. The options vary according to your subscription.

{{<image filename="images/rc/database-details-configuration-durability-backup.png" alt="Backup settings appear when you enable the Remote backup settings." >}}{{< /image >}}

|Setting name|Description|
|:-----------|:----------|
| **Interval** | Defines the frequency of automatic backups. Paid fixed accounts are backed up every 24 hours. Flexible and Annual subscriptions can be set to 24, 12, 6, 4, 2, or 1 hour backup intervals. |
| **Set backup time** | When checked, this lets you set the hour of the **Backup time**. (_Flexible and Annual subscriptions only_) |
| **Backup time** | Defines the hour automatic backups are made. Note that actual backup times will vary up in order to minimize customer access disruptions. (_Flexible and Annual subscriptions only_)<br/> Times are expressed in [Coordinated Universal Time](https://en.wikipedia.org/wiki/Coordinated_Universal_Time) (UTC).|
| **Storage type** | Defines the provider of the storage location, which can be: `AWS S3`, `Google Cloud Storage`, `Azure Blob Storage`, or `FTP` (SFTP). |
| **Backup destination** | Defines a URI representing the backup storage location. |

## Back up data on demand

Once backups are enabled, you can back up your data at any time. Use the **Backup Now** button in the **Durability** section.

{{<image filename="images/rc/button-database-backup-now.png" alt="Use the Backup Now button to make backups on demand." >}}{{< /image >}}

Backups need to be enabled before the button appears.

## Set up backup storage locations

To use an S3 bucket for storing backups, sign in to your [AWS
Management Console](https://console.aws.amazon.com/) and follow these
steps:
Database backups can be stored to a cloud provider service or saved to a URI using FTP/SFTP.

1. Go to the AWS S3 Management Console in: **Services > Storage > S3**
When stored to a cloud provider, backup locations need to be available on the same provider in the same region as your subscription.

1. Configure the permissions for your S3 bucket:
Your subscription needs the ability to view permissions and update objects in the storage location. Specific details vary according to the provider. To learn more, consult the provider's documentation.

- For a new bucket:
1. Click **Create Bucket**.
1. Enter a name and region for the bucket and click **Next**.
1. Set the bucket properties that are required by your company standards, and click **Next**.
1. Set Public access properties according to your company standards, and click **Next**.
1. Review the properties, and click **Create bucket**.
1. Find your bucket in the bucket list, and click on the bucket name.
1. In **Permissions > Access Control**, click **Add account**:
1. In the Account field enter:
`fd1b05415aa5ea3a310265ddb13b156c7c76260dbc87e037a8fc290c3c86b614`
1. Select the **Write objects**, **Read bucket permissions**, and **Write bucket permissions**, and click **Save**.
The following sections help set things up; however, provider features change frequently. For best results, use your provider's documentation for the latest info.

- For an existing bucket, click on the S3 bucket and go to the **Permissions** tab.
1. Click **Add account**.
1. In the **Access for other AWS accounts** section, enter:
1. In the Account field enter:
`fd1b05415aa5ea3a310265ddb13b156c7c76260dbc87e037a8fc290c3c86b614`
1. Select the **permissions** that you need.
1. Click **Save**.
### AWS Simple Storage Service

After the permissions are set for your bucket, set the **Backup Path** to the path of your S3 bucket
and click **Apply**. For example, if the name of your bucket is *backups-bucket*, use the path: `s3://backups-bucket`
To store backups in an Amazon Web Services (AWS) Simple Storage Service (S3) [bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html):

## Back up to Google Cloud Storage (GCS)
1. Sign in to the [AWS Management Console](https://console.aws.amazon.com/).

1. Use the **Services** menu to locate and select **Storage** > **S3**. This takes you to the Amazon S3 admin panel.

1. If you do not already have a bucket for backups, select the **Create Bucket** button in the upper, right corner of the **Buckets** panel.

1. When the **Create bucket** screen appears, enter a name for your bucket.

1. Set **AWS Region** to an appropriate region.

1. Set other properties according to your company standards.

1. When finished, select the **Create bucket** button near the bottom of the screen.

1. Use the Buckets list to locate and select your bucket. When the settings appear, select the **Permissions** tab, locate the **Access control list (ACL)** section, and then select the **Edit** button.

1. When the **Edit access control list (ACL)** screen appears, locate the Access for other AWS accounts section and then select the **Add grantee** button.

1. In the **Grantee** field, enter:

```
fd1b05415aa5ea3a310265ddb13b156c7c76260dbc87e037a8fc290c3c86b614
```

1. In the **Objects** list, enable **Write**.
1. In the **Bucket ACL** list, enable **Read** and **Write**.
1. When finished, select the **Save changes** button.

Once the bucket is available and the permissions are set, use the name of your bucket as the **Backup destination** for your database's Remote backup settings. For example, suppose your bucket is named *backups-bucket*. In that case, set **Backup destination** to `s3://backups-bucket`.

### GCP Storage

For [Google Cloud Platform (GCP)
console](https://developers.google.com/console/) subscriptions, store your backups in a Google Cloud Storage bucket:
Expand Down Expand Up @@ -91,19 +144,17 @@ console](https://developers.google.com/console/) subscriptions, store your backu

Use the bucket details **Configuration** tab to locate the **gsutil URI**. This is the value you'll assign to your resource's backup path.


## Back up to Azure Blob Storage
### Azure Blob Storage

To store your backup in Microsoft Azure Blob Storage, sign in to the Azure portal and then:

1. [Create an Azure Storage account](https://docs.microsoft.com/en-us/azure/storage/common/storage-account-create)
1. [Create an Azure Storage account](https://docs.microsoft.com/en-us/azure/storage/common/storage-account-create) if you do not already have one

1. [Create a container](https://docs.microsoft.com/en-us/azure/storage/blobs/storage-quickstart-blobs-portal#create-a-container)
1. [Create a container](https://docs.microsoft.com/en-us/azure/storage/blobs/storage-quickstart-blobs-portal#create-a-container) if you do not already have one

1. [Manage storage account access keys](https://docs.microsoft.com/en-us/azure/storage/common/storage-account-keys-manage)

Set your resource's **Backup Path** to the path of your storage
account.
Set your resource's **Backup Path** to the path of your storage account.

The syntax for creating the backup varies according to your authorization mechanism. For example:

Expand All @@ -119,18 +170,21 @@ Where:

To learn more, see [Authorizing access to data in Azure Storage](https://docs.microsoft.com/en-us/azure/storage/common/storage-auth)

## Back up to an FTP Server
### FTP Server

To store your resource backups on an FTP server, set its **Backup Path**
using the following syntax:
To store your backups on an FTP server, set its **Backup Path** using the following syntax:

`<protocol>://[username]:[password]@[hostname]:[port]/[path]/`

Where:

- *protocol*: the server's protocol, can be either ftp or ftps.
- *protocol*: the server's protocol, can be either `ftp` or `ftps`.
- *username*: your username, if needed.
- *password*: your password, if needed.
- *hostname*: the hostname or IP address of the server.
- *port*: the port number of the server, if needed.
- *path*: the backups path, if needed.
- *path*: the backup path, if needed.

The user account needs permission to write files to the server.


41 changes: 27 additions & 14 deletions content/rc/databases/delete-database.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,42 @@
---
Title: Delete a database
Title: Delete database
linkTitle: Delete database
description:
weight: 30
alwaysopen: false
categories: ["RC"]
aliases: /rc/administration/setup-and-editing/delete-databases/
/rv/administration/setup_and_editing/deleting-database/
---
Deleting a database is just as easy as creating one.
Make sure that you are truly done with the database,
because after you delete the database it cannot be recovered (except from your backups).

{{< note >}}
- Only users that are defined as Owners on the Redis Cloud account can delete a database.
- We recommend that you create a backup of your database before deleting it.
{{< /note >}}
To delete a database, use the **Delete** button. It's located in the **Danger zone** section of the database's **Configuration** tab.

## Deleting a database
Databases must be empty before they can be deleted. Deleted databases cannot be recovered. (We recommend [making a backup]({{< relref "rc/databases/back-up-data.md" >}}), just in case.)

1. Use the admin console menu to select the **Databases** command.
This command requires the account owner role.

1. From the databases list, select the database you want to delete.
## Step-by-step

1. When the database details appear, select the Delete icon.
1. Sign in to the Redis Cloud [admin portal](https://app.redislabs.com/new/).

1. Confirm your choice.
1. If you have more than one subscription, select the target subscription from the list. This displays the **Databases** tab for the selected subscription.

The database and all of its data and configurations is now deleted.
{{<image filename="images/rc/subscription-flexible-databases-tab-pending.png" alt="The Databases tab summarizes databases created for a given subscription." >}}{{< /image >}}

1. Select the database from the list. The **Configuration** tab is selected by default.

{{<image filename="images/rc/database-details-configuration-tab-general-flexible.png" width="75%" alt="The Configuration tab of the Database details screen." >}}{{< /image >}}

1. Scroll to the **Danger zone**.

{{<image filename="images/rc/database-details-configuration-tab-danger-flexible.png" width="75%" alt="The Configuration tab of the Database details screen." >}}{{< /image >}}

1. Select the **Delete** button.

{{<image filename="images/rc/button-danger-zone-delete.png" alt="The Delete button is located in the Danger zone section of the database Configuration tab." >}}{{< /image >}}

1. When the **Delete database** dialog appears, use the **Delete database** button to confirm your choice.

{{<image filename="images/rc/button-database-delete.png" alt="The Delete button is located in the Danger zone section of the database Configuration tab." >}}{{< /image >}}

When the operation completes, the database and its data are deleted.
Binary file added static/images/rc/button-danger-zone-delete.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/images/rc/button-database-backup-now.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/images/rc/button-database-delete.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/images/rc/button-database-keep.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.