[OSDOCS-11124]: Add automated backup/restore with OADP docs #94958
Conversation
openshift-ci
bot
added
the
size/L
lahinson
force-pushed
the
osdocs-11124-hcp-automate-capture
branch
7 times, most recently
from
aad960c to
b430ae0
Compare
modules/hcp-dr-oadp-dpa.adoc
Outdated
| .Procedure | ||
|
|
||
| * If you use a bare metal platform, you can create a DPA by creating a manifest file similar to the following example: | ||
|
|
There was a problem hiding this comment.
@jparrill If we need to call out anything specific about the parameters in the manifest, let me know.
There was a problem hiding this comment.
Yes, It's perfect. This is suitable once the storage provider it's compatible with S3 API like MinIO. That could differ if the storage provider is not compatible with S3 API, then the DPA manifest would be different. Maybe we can remark this.
modules/hcp-dr-oadp-dpa.adoc
Outdated
| .Procedure | ||
|
|
||
| * If you use a bare metal platform, you can create a DPA by creating a manifest file similar to the following example: | ||
|
|
There was a problem hiding this comment.
Yes, It's perfect. This is suitable once the storage provider it's compatible with S3 API like MinIO. That could differ if the storage provider is not compatible with S3 API, then the DPA manifest would be different. Maybe we can remark this.
lahinson
force-pushed
the
osdocs-11124-hcp-automate-capture
branch
from
b430ae0 to
30fccd3
Compare
|
New changes are detected. LGTM label has been removed. |
lahinson
force-pushed
the
osdocs-11124-hcp-automate-capture
branch
from
30fccd3 to
c50093e
Compare
|
@LiangquanLi930 When you're available, please provide QE review. Thanks! |
lahinson
added
the
peer-review-needed
mburke5678
added
the
peer-review-in-progress
hosted_control_planes/hcp_high_availability/hcp-disaster-recovery-oadp-auto.adoc
Outdated
Show resolved
Hide resolved
hosted_control_planes/hcp_high_availability/hcp-disaster-recovery-oadp-auto.adoc
Outdated
Show resolved
Hide resolved
hosted_control_planes/hcp_high_availability/hcp-disaster-recovery-oadp-auto.adoc
Outdated
Show resolved
Hide resolved
hosted_control_planes/hcp_high_availability/hcp-disaster-recovery-oadp-auto.adoc
Outdated
Show resolved
Hide resolved
| [id="prepare-aws-oadp-auto_{context}"] | ||
| == Preparing {aws-short} to use {oadp-short} | ||
|
|
||
| To perform disaster recovery for a hosted cluster, you can use {oadp-first} on {aws-first} S3 compatible storage. |
There was a problem hiding this comment.
How do I use {oadp-first} on {aws-first} S3 compatible storage? Will a typical user know how do do this? Is there somewhere you can link to?
There was a problem hiding this comment.
Good question. The intended audience for this content will know how to use AWS S3 compatible storage. Actually, now that I look at this text again, I don't think the sentence on line 34 is necessary. The info that users need is on line 35. I'll remove line 34.
| * Backing up the data plane workload | ||
| * Backing up the control plane workload |
| [id="prepare-bm-dr-oadp-auto_{context}"] | ||
| == Preparing bare metal to use {oadp-short} | ||
|
|
||
| To perform disaster recovery for a hosted cluster, you can use {oadp-first} on bare metal. |
There was a problem hiding this comment.
Is this correct?
| To perform disaster recovery for a hosted cluster, you can use {oadp-first} on bare metal. | |
| To perform disaster recovery for a bare-metal hosted cluster, you can use {oadp-first} on bare metal. |
or,
| To perform disaster recovery for a hosted cluster, you can use {oadp-first} on bare metal. | |
| To perform disaster recovery for a bare-metal cluster, you can use {oadp-first} on bare metal. |
There was a problem hiding this comment.
I think this line can go away completely.
hosted_control_planes/hcp_high_availability/hcp-disaster-recovery-oadp-auto.adoc
Outdated
Show resolved
Hide resolved
hosted_control_planes/hcp_high_availability/hcp-disaster-recovery-oadp-auto.adoc
Outdated
Show resolved
Hide resolved
|
|
||
| .Next steps | ||
|
|
||
| * Restoring a hosted cluster by using {oadp-short} |
lahinson
force-pushed
the
osdocs-11124-hcp-automate-capture
branch
from
c50093e to
f96f100
Compare
| defaultVolumesToFsBackup: true <7> | ||
| ---- | ||
| ==== | ||
| <1> Replace `backup_resource_name` with the name of your `Backup` resource. |
There was a problem hiding this comment.
with the name of makes it sound like the Backup resource already exists, to me. Is this accurate:
| <1> Replace `backup_resource_name` with the name of your `Backup` resource. | |
| <1> Replace `backup_resource_name` with a name for your `Backup` resource. |
|
|
||
| .Verification | ||
|
|
||
| * Verify if the value of the `status.phase` is `Completed` by running the following command: |
There was a problem hiding this comment.
I think verify that is used when confirming something. Verify if is for checking possibility (verify if I can go to Raleigh)
| * Verify if the value of the `status.phase` is `Completed` by running the following command: | |
| * Verify that the value of the `status.phase` is `Completed` by running the following command: |
|
|
||
| .Procedure | ||
|
|
||
| * If you use a bare metal platform, you can create a DPA by creating a manifest file similar to the following example: |
There was a problem hiding this comment.
| * If you use a bare metal platform, you can create a DPA by creating a manifest file similar to the following example: | |
| * If you use a bare-metal platform, you can create a DPA by creating a manifest file similar to the following example: |
| <1> Specify the provider for Velero. If you are using bare metal and MinIO, you can use `aws` as the provider. | ||
| <2> Specify the bucket name; for example, `oadp-backup`. | ||
| <3> Specify the bucket prefix; for example, `hcp`. | ||
| <4> The bucket region in this example is `minio`, which is a storage provider that is compatilble with the S3 API. |
There was a problem hiding this comment.
How do I know if my storage provider is compatible.
| ---- | ||
| <1> Specify the bucket name; for example, `oadp-backup`. | ||
| <2> Specify the bucket prefix; for example, `hcp`. | ||
| <3> The bucket region in this example is `minio`, which is a storage provider that is compatilble with the S3 API. |
There was a problem hiding this comment.
How do I know if my storage provider is compatible?
| * Backing up the data plane workload | ||
| * Backing up the control plane workload |
There was a problem hiding this comment.
Do we want links here, where the second item is not contiguous?
| * If you are using an _in-place_ update, InfraEnv does not need spare nodes. You need to re-provision the worker nodes from the new management cluster. | ||
| * If you are using a _replace_ update, you need some spare nodes for InfraEnv to deploy the worker nodes. |
There was a problem hiding this comment.
Not sure you need the italics here. You are not defining the term, and in other places where there were different paths for different objects, you didn't italicize. Will typical users know which update they are doing?
Also, do we need to state what InfraEnv is?
| * If you are using an _in-place_ update, InfraEnv does not need spare nodes. You need to re-provision the worker nodes from the new management cluster. | |
| * If you are using a _replace_ update, you need some spare nodes for InfraEnv to deploy the worker nodes. | |
| * If you are using an in-place update, InfraEnv does not need spare nodes. You need to re-provision the worker nodes from the new management cluster. | |
| * If you are using a replace update, you need some spare nodes for InfraEnv to deploy the worker nodes. |
| * You completed the steps in link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.13/html/clusters/cluster_mce_overview#remove-a-cluster-by-using-the-console[Removing a cluster by using the console] to delete your hosted cluster. | ||
| * You completed the steps in link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.13/html/clusters/cluster_mce_overview#removing-a-cluster-from-management-in-special-cases[Removing remaining resources after removing a cluster]. |
There was a problem hiding this comment.
Per doc style guide, use the <document_heading_name> (<document_source>) format for external links.
| * You completed the steps in link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.13/html/clusters/cluster_mce_overview#remove-a-cluster-by-using-the-console[Removing a cluster by using the console] to delete your hosted cluster. | |
| * You completed the steps in link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.13/html/clusters/cluster_mce_overview#removing-a-cluster-from-management-in-special-cases[Removing remaining resources after removing a cluster]. | |
| * You completed the steps in link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.13/html/clusters/cluster_mce_overview#remove-a-cluster-by-using-the-console[Removing a cluster by using the console] [({rh-rhacm} documentation) to delete your hosted cluster. | |
| * You completed the steps in link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.13/html/clusters/cluster_mce_overview#removing-a-cluster-from-management-in-special-cases[Removing remaining resources after removing a cluster [({rh-rhacm} documentation). |
| <1> Replace `<restore_resource_name>` with the name of your `Restore` resource. | ||
| <2> Replace `<backup_resource_name>` with the name of your `Backup` resource. |
There was a problem hiding this comment.
| <1> Replace `<restore_resource_name>` with the name of your `Restore` resource. | |
| <2> Replace `<backup_resource_name>` with the name of your `Backup` resource. | |
| <1> Replace `<restore_resource_name>` with a name for your `Restore` resource. | |
| <2> Replace `<backup_resource_name>` with a name for your `Backup` resource. |
| [id="prepare-bm-dr-oadp-auto_{context}"] | ||
| == Preparing bare metal to use {oadp-short} |
There was a problem hiding this comment.
This an preparing AWS to use OADP should probably be individual modules, as they are distinct use cases. In theory, it would be nice to have a unified heading for both, and the modules would be sub-modules.
Preparing your cluster to use OADP
Preparing AWS to use OADP
Preparing bare metal to use OADP
There was a problem hiding this comment.
Good suggestion. I based the structure here on the existing structure in the other disaster recovery docs for HCP. For this PR, I'll leave the structure as-is, but I will take note of this suggestion to apply it to this content and the other, non-automated, DR docs in the future.
| [id="hcp-dr-oadp-dpa_{context}"] | ||
| = Automating the backup and restore process by using a DPA | ||
|
|
||
| You can automate parts of the backup and restore process by using a Data Protection Application (DPA). The DPA defines information including backup locations and Velero pod configurations. |
There was a problem hiding this comment.
automate parts of the backup and restore process
Which parts can be automated? And, what do I do after creating the DPA object?
| .Next steps | ||
|
|
||
| * Restoring a hosted cluster by using OADP |
There was a problem hiding this comment.
Need a link here?
| * Restoring a hosted cluster by using OADP | |
| * Restoring a hosted cluster by using {oadp-short} |
|
@lahinson I added some comments. Let me know if you need explanation or further info. Otherwise LGTM. Sorry it took so long! |
mburke5678
added
peer-review-done
lahinson
force-pushed
the
osdocs-11124-hcp-automate-capture
branch
from
f96f100 to
f2f368e
Compare
|
@lahinson: all tests passed! Full PR test history. Your PR dashboard. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
Version(s): 4.19+
Issue: https://issues.redhat.com/browse/OSDOCS-11124
Link to docs preview: https://94958--ocpdocs-pr.netlify.app/openshift-enterprise/latest/hosted_control_planes/hcp_high_availability/hcp-disaster-recovery-oadp-auto.html
QE review:
Additional information: