Skip to content
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

Jira DOC-703: Update Database backup to reflect start time and updated directions. #1548

Merged
merged 6 commits into from
Sep 30, 2021

Conversation

lanceleonard
Copy link
Contributor

  • Initial draft

@lanceleonard
Copy link
Contributor Author

A staged preview is available.

Copy link
Collaborator

@rrelledge rrelledge left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. I left some suggestions for possible typos.

Comment on lines 10 to 12
Periodic backups provide a way to restore data with minimal data loss. With Redis Enterprise Software, you can schedule periodic backups to occur every once a day (every 24 hours), twice a day (every twelve hours), every four hours, or every hour.

As of v6.2.8, you can specify the start time for twenty four or twelve hour backups.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Periodic backups provide a way to restore data with minimal data loss. With Redis Enterprise Software, you can schedule periodic backups to occur every once a day (every 24 hours), twice a day (every twelve hours), every four hours, or every hour.
As of v6.2.8, you can specify the start time for twenty four or twelve hour backups.
Periodic backups provide a way to restore data with minimal data loss. With Redis Enterprise Software, you can schedule periodic backups to occur once a day (every 24 hours), twice a day (every 12 hours), every four hours, or every hour.
As of v6.2.8, you can specify the start time for 24- or 12-hour backups.

Copy link
Contributor Author

@lanceleonard lanceleonard Sep 28, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed to match intention.

|--------------|-------------|
| **Interval** | Specifies the frequency of the backup; that is, the time between each backup snapshot.<br/><br/>Supported values include _Every 24 hours_, _Every 12 hours_, _Every 4 hours_, and _Every hour_. |
| **Set starting time** | _v6.2.8 or later:&nbsp;_ Specifies the start time for the backup; available when **Interval** is set to _Every 24 hours_ or _Every 12 hours_.<br/><br/>If not specified, defaults to a time selected by Redis Enterprise Software. |
| **Choose storage type** | Specifies the storage type for the backup. Supported options vary and might require additional details. To learn more, see [Supported storage types](#supported-storage-types).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mismatched anchor

Suggested change
| **Choose storage type** | Specifies the storage type for the backup. Supported options vary and might require additional details. To learn more, see [Supported storage types](#supported-storage-types).
| **Choose storage type** | Specifies the storage type for the backup. Supported options vary and might require additional details. To learn more, see [Supported storage locations](#supported-storage-locations).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed


## Default backup start time

If you do _not_ specify a start time for twenty four or twelve hour backups, Redis Enterprise Software chooses one for you, based on the time the backups are enabled.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If you do _not_ specify a start time for twenty four or twelve hour backups, Redis Enterprise Software chooses one for you, based on the time the backups are enabled.
If you do _not_ specify a start time for 24- or 12-hour backups, Redis Enterprise Software chooses one for you, based on the time the backups are enabled.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed to intention

- You choose to back up your database every 12 hours.
- Because you didn't set a start time, the cluster randomly chooses an offset of 4,320 seconds (or 72 minutes).

This means your first periodic backup will run roughly around 5:12 pm (72 minutes after the time you enabled backups) and repeats every twelve hours at about that same time.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This means your first periodic backup will run roughly around 5:12 pm (72 minutes after the time you enabled backups) and repeats every twelve hours at about that same time.
This means your first periodic backup will run roughly around 5:12 pm (72 minutes after the time you enabled backups) and repeats every 12 hours at about that same time.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reworked.

To backup to an SFTP server, enter the SFTP server location in the format:

```sh
sftp://user:password@host:<:custom_port>/path/
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
sftp://user:password@host:<:custom_port>/path/
sftp://user:password@host:<custom_port>/path/

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed-ish. (There should only be one colon).


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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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. When the **Edit access control list (ACL)** screen appears, locate the **Access for other AWS accounts** section and then select the **Add grantee** button.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.


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:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
1. In the **Grantee** field, enter:
1. In the **Grantee** field, enter the AWS account ID:

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.

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`.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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`.
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`.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reworked.


1. Sign in to Google Cloud Platform console.

1. In the admin console menu, locate the _Storage_ section than select **Cloud Storage&nbsp;>&nbsp;Browser**.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
1. In the admin console menu, locate the _Storage_ section than select **Cloud Storage&nbsp;>&nbsp;Browser**.
1. In the admin console menu, locate the _Storage_ section then select **Cloud Storage&nbsp;>&nbsp;Browser**.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.


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

`abs://:storage_account_access_key@storage_account_name/container_name/[path/]`
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`abs://:storage_account_access_key@storage_account_name/container_name/[path/]`
`abs://storage_account_access_key@storage_account_name/container_name/[path/]`

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.

@lanceleonard lanceleonard merged commit ca81cdc into release-rs-6-2-8 Sep 30, 2021
@lanceleonard lanceleonard deleted the jira-doc-703 branch September 30, 2021 22:10
lanceleonard added a commit that referenced this pull request Oct 31, 2021
* Added more detail to rladmin verify commands (#1550)

* Jira DOC-703: Update Database backup to reflect start time and updated directions. (#1548)

* First steps; not yet ready for review.

* Initial draft

* Adding default start time discussion.

* Minor tweaks and edits.

* Moar fixes

* Jira DOC-769: Update TLS support statement for TLS. (#1554)

* Initial draft

* Adding statement to Supported OS article.

* Tweaks and fixes

* Jira DOC-929: Add additional details about the upgrade policy to the upgrade doc. (#1599)

* Initial draft

* Promoting section.

* Incoporating editorial feedback.

* Jira DOC-939: RS - Align Export data article to Back up data article (#1598)

* Initial draft

* Editorial feedback.

* Jira DOC-857: RS - v6.2.8 Release notes (#1628)

* Added public read parameter to automated deployment of robots.txt (#1622)

* Initial draft

* Editorial fixes/tweaks

* More fixes/tweaks

* Jira DOC-564: RS - Clarify how to enable public/private IP support (#1611)

* Initial draft.

* Editorial feedback/tweaks.

* Fixing typo.

* More updates/tweaks.

* Allow HTML encoding in table-children column names (#1629)

* Jira DOC-196: Modules: document enterprise capability support (#1504)

* Initial draft

* Tweaks and fixes

* Editorial feedback.

* More editorial feedback.

* More editorial changes.

* More fixes/updates

* Updating limitations.

Co-authored-by: Rachel Elledge <86307637+rrelledge@users.noreply.github.com>

Co-authored-by: Rachel Elledge <86307637+rrelledge@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants