Skip to content

[OSDOCS-19679]: Tech Preview docs about etcd snapshot backup method for HCP#111843

Open
lahinson wants to merge 1 commit into
openshift:mainfrom
lahinson:osdocs-19679-hcp-oadp-tp-concept
Open

[OSDOCS-19679]: Tech Preview docs about etcd snapshot backup method for HCP#111843
lahinson wants to merge 1 commit into
openshift:mainfrom
lahinson:osdocs-19679-hcp-oadp-tp-concept

Conversation

@lahinson
Copy link
Copy Markdown
Contributor

@lahinson lahinson commented May 18, 2026 •
edited
Loading

@lahinson lahinson added this to the Planned for 4.22 GA milestone May 18, 2026
@openshift-ci openshift-ci Bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label May 18, 2026
@ocpdocs-previewbot
Copy link
Copy Markdown

ocpdocs-previewbot commented May 18, 2026 •
edited
Loading

🤖 Wed May 20 15:22:03 - Prow CI generated the docs preview:

https://111843--ocpdocs-pr.netlify.app/openshift-enterprise/latest/hosted_control_planes/hcp_high_availability/hcp-backup-etcd-snapshot.html

@lahinson lahinson force-pushed the osdocs-19679-hcp-oadp-tp-concept branch from a382209 to 8b89cb4 Compare May 18, 2026 16:32
lahinson
lahinson commented May 18, 2026
View reviewed changes
Comment thread modules/hcp-backup-etcd-snapshot-about.adoc
|The `etcdutl snapshot save` mechanism produces a single snapshot file and uploads it to object storage.

|Portability
|Tied to the storage provider and the CSI driver.
Copy link
Copy Markdown
Contributor Author

@lahinson lahinson May 18, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

Note for technical reviewers: The docs for self-managed HCP on Azure are not published yet. I plan to revise this file to mention Azure after the tech preview for Azure is live.

@lahinson lahinson changed the title [OSDOCS-19679]: Concept about TP etcd snapshot backups [OSDOCS-19679]: TP docs about etcd snapshot backup method for HCP May 18, 2026
@lahinson lahinson force-pushed the osdocs-19679-hcp-oadp-tp-concept branch from 8b89cb4 to 8a0e04b Compare May 18, 2026 17:23
@openshift-ci openshift-ci Bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels May 18, 2026
@lahinson lahinson force-pushed the osdocs-19679-hcp-oadp-tp-concept branch from 8a0e04b to 2384697 Compare May 18, 2026 18:40
lahinson
lahinson commented May 18, 2026
View reviewed changes
Comment thread modules/hcp-backup-etcd-snapshot-backup.adoc Outdated
lahinson
lahinson commented May 18, 2026
View reviewed changes
Comment thread modules/hcp-backup-etcd-snapshot-backup.adoc
----
$ hypershift create oadp-backup \
--hc-name <my_hosted_cluster> \
--hc-namespace <my_hosted_cluster_namespace> \
Copy link
Copy Markdown
Contributor Author

@lahinson lahinson May 18, 2026

Choose a reason for hiding this comment

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

@jparrill I saw that clusters was used for the namespace in the upstream docs, but we've had a lot of customer confusion about that. I replaced clusters with my_hosted_cluster_namespace. Is that correct, or should it be my_hosted_control_plane_namespace?

lahinson
lahinson commented May 18, 2026
View reviewed changes
Comment thread modules/hcp-backup-etcd-snapshot-backup.adoc
+
The generated backup custom resource (CR) includes the namespaces of the hosted cluster and the hosted control plane, a platform-aware resource list that excludes etcd-related resources, and snapshot settings.
+
Next, the {oadp-short} HyperShift plugin and the `HCPEtcdBackup` CR work to complete the backup process.
Copy link
Copy Markdown
Contributor Author

@lahinson lahinson May 18, 2026

Choose a reason for hiding this comment

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

@jparrill Are there any verification steps that users need to run to ensure that the backup succeeded?

lahinson
lahinson commented May 18, 2026
View reviewed changes
Comment thread modules/hcp-backup-etcd-snapshot-restore.adoc Outdated
lahinson
lahinson commented May 18, 2026
View reviewed changes
Comment thread modules/hcp-backup-etcd-snapshot-restore.adoc
----
$ hypershift create oadp-restore \
--hc-name <my_hosted_cluster> \
--hc-namespace <my_hosted_cluster_namespace> \
Copy link
Copy Markdown
Contributor Author

@lahinson lahinson May 18, 2026

Choose a reason for hiding this comment

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

@jparrill Similar question here as I had in the backup procedure about clusters. For clarity, I replaced clusters with my_hosted_cluster_namespace. Is that correct, or should it be my_hosted_control_plane_namespace?

@lahinson lahinson force-pushed the osdocs-19679-hcp-oadp-tp-concept branch 2 times, most recently from 31cf951 to 44c7b38 Compare May 18, 2026 19:16
@lahinson
Copy link
Copy Markdown
Contributor Author

lahinson commented May 18, 2026

/retest

@lahinson lahinson force-pushed the osdocs-19679-hcp-oadp-tp-concept branch from 44c7b38 to b6b373a Compare May 18, 2026 20:01
lahinson
lahinson commented May 18, 2026
View reviewed changes
Comment thread modules/hcp-backup-etcd-snapshot-config.adoc

* The `HCPEtcdBackup` feature gate is enabled in the HyperShift Operator.
* The {oadp-first} Operator version 1.6 or later with the HyperShift plugin is deployed. For more information, see "Configuring {oadp-short}" and "Automating the backup and restore process by using a DPA".
* Object storage is configured. Use a Velero backup storage location that points to {aws-short} S3.
Copy link
Copy Markdown
Contributor Author

@lahinson lahinson May 18, 2026

Choose a reason for hiding this comment

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

@jparrill A question about this sentence: "Use a Velero backup storage location that points to AWS S3."
Does that statement apply only to deployments on AWS?

jparrill
jparrill reviewed May 19, 2026
View reviewed changes
Copy link
Copy Markdown

@jparrill jparrill left a comment

Choose a reason for hiding this comment

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

Dropped some comments. Thanks!

Comment thread modules/hcp-backup-etcd-snapshot-backup.adoc Outdated
Comment thread modules/hcp-backup-etcd-snapshot-about.adoc Outdated
Comment thread modules/hcp-backup-etcd-snapshot-backup.adoc Outdated
Comment thread modules/hcp-backup-etcd-snapshot-restore.adoc
Comment thread modules/hcp-backup-etcd-snapshot-reference.adoc
@lahinson lahinson force-pushed the osdocs-19679-hcp-oadp-tp-concept branch 3 times, most recently from bd602b6 to b644c2f Compare May 19, 2026 20:12
@lahinson lahinson force-pushed the osdocs-19679-hcp-oadp-tp-concept branch from b644c2f to 7602a30 Compare May 20, 2026 15:13
@openshift-ci
Copy link
Copy Markdown

openshift-ci Bot commented May 20, 2026

@lahinson: all tests passed!

Full PR test history. Your PR dashboard.

Details

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.

@lahinson lahinson changed the title [OSDOCS-19679]: TP docs about etcd snapshot backup method for HCP [OSDOCS-19679]: Tech Preview docs about etcd snapshot backup method for HCP May 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@jparrill jparrill jparrill left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

branch/enterprise-4.22 size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Milestone

Planned for 4.22 GA

Development

Successfully merging this pull request may close these issues.

3 participants

@lahinson @ocpdocs-previewbot @jparrill