Bug 1380614 - [DOCS] "Cluster Restore" article is not complete
Summary: [DOCS] "Cluster Restore" article is not complete
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Documentation
Version: 3.2.0
Hardware: Unspecified
OS: Unspecified
medium
medium
Target Milestone: ---
: ---
Assignee: Ashley Hardin
QA Contact: Anping Li
Vikram Goyal
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2016-09-30 07:19 UTC by Alexander Koksharov
Modified: 2019-12-16 06:57 UTC (History)
7 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2016-11-01 15:17:36 UTC
Target Upstream Version:


Attachments (Terms of Use)

Description Alexander Koksharov 2016-09-30 07:19:16 UTC
Document URL: 
https://docs.openshift.org/latest/admin_guide/backup_restore.html#cluster-restore

Section Number and Name: 
Cluster Restore-> 4. Restore from the etcd backup:

Describe the issue: 
Procedure is not complete. Described way will only work for single-member etcd cluster. 

Suggestions for improvement: 
Please make a note that in case it is necessary to restore multi-member etcd cluster customer have to follow different procedure. Please add a link to complete etcd restoration procedure. 

Additional information:

Comment 3 Timothy 2016-10-07 04:36:33 UTC
Started working on this.

I'm assuming that "Please add a link to complete etcd restoration procedure" is referring to: https://docs.openshift.com/container-platform/3.3/install_config/downgrade.html#downgrading-restoring-etcd

Please correct me if I'm wrong.

Comment 4 Timothy 2016-10-07 05:54:36 UTC
Alexander Koksharov on NEEDINFO to read over these changes:

https://github.com/openshift/openshift-docs/pull/3011

Docs PR submitted.

Nicely rendered docs for easy reading here: 
http://file.bne.redhat.com/~tpoitras/2016/clusterrestore/openshift-enterprise/cluster-restore-BZ1380614/admin_guide/backup_restore.html#cluster-restore

Not sure if I interpreted this BZ correctly, I simply added the note warning against using this procedure for multi-member etcd clusters. I suppose you could also mean that the complete etcd restoration procedure is not yet properly documented. In that case, is there any information on this already typed up somewhere that I can read? Kbase or something?

Also, would this stuff apply to OpenShift Dedicated, or not?

Comment 8 Anping Li 2016-10-21 10:30:46 UTC
I'd like to add contents in http://file.bne.redhat.com/~tpoitras/2016/clusterrestore/openshift-enterprise/cluster-restore-BZ1380614/admin_guide/backup_restore.html#cluster-restore and link them in https://docs.openshift.com/container-platform/3.3/install_config/downgrade.html#downgrading-restoring-etcd.

I know that is a historical reason downgrading-restoring-etcd was kicked off before this article.  But it had made me confused from the last time I reviewed this article.


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