Bug 1846118 - [DOCS] Include steps on validating/verifying an etcd backup
Summary: [DOCS] Include steps on validating/verifying an etcd backup
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Documentation
Version: 4.4
Hardware: Unspecified
OS: Unspecified
low
low
Target Milestone: ---
: 4.6.z
Assignee: Kathryn Alexander
QA Contact: ge liu
Vikram Goyal
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2020-06-10 19:58 UTC by Robert Bost
Modified: 2023-06-28 03:56 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2021-08-06 18:46:18 UTC
Target Upstream Version:
Embargoed:
rbost: needinfo-


Attachments (Terms of Use)

Description Robert Bost 2020-06-10 19:58:39 UTC
Document URL: https://docs.openshift.com/container-platform/4.4/backup_and_restore/backing-up-etcd.html

Describe the issue: Need steps on verifying an etcd backup file.

Suggestions for improvement: These commands should work for verifying the db file:
  https://kubernetes.io/docs/tasks/administer-cluster/configure-upgrade-etcd/

Comment 1 Kathryn Alexander 2021-06-25 19:17:24 UTC
This is fixed in the operator in 4.8: https://github.com/openshift/cluster-etcd-operator/blob/master/bindata/etcd/cluster-backup.sh#L119

The backport for 4.6 is forthcoming, and the backport for 4.7 is here: https://github.com/openshift/cluster-etcd-operator/pull/617

I'm opening a PR to update the command output and state that the script verifies the snapshot: https://github.com/openshift/openshift-docs/pull/33997

Robert, does this look ok to you?

Ge Liu, will you PTAL?

Comment 2 ge liu 2021-06-30 03:51:26 UTC
Verified.

Comment 3 Kathryn Alexander 2021-06-30 19:08:26 UTC
I've merged the change into 4.8 and am holding the changes to other branches until the etcd operator is updated.

Comment 4 Kathryn Alexander 2021-07-06 12:50:25 UTC
The 4.7 PR for the etcd operator has merged. I don't see a PR for the 4.6 backport, so I've filed an issue: https://github.com/openshift/cluster-etcd-operator/issues/623

Comment 5 Kathryn Alexander 2021-08-06 18:46:18 UTC
The change has been backported to 4.6 and the docs change is live, eg: https://docs.openshift.com/container-platform/4.8/backup_and_restore/backing-up-etcd.html


Note You need to log in before you can comment on or make changes to this bug.