diff --git a/modules/backup-etcd.adoc b/modules/backup-etcd.adoc index 9deecda30203..7f0250b9b355 100644 --- a/modules/backup-etcd.adoc +++ b/modules/backup-etcd.adoc @@ -7,6 +7,7 @@ [id="backing-up-etcd-data_{context}"] = Backing up etcd data +[role="_abstract"] Follow these steps to back up etcd data by creating an etcd snapshot and backing up the resources for the static pods. This backup can be saved and used at a later time if you need to restore etcd. [IMPORTANT] diff --git a/modules/creating-single-etcd-backup.adoc b/modules/creating-single-etcd-backup.adoc index 09ba879620e1..adabcd4776bd 100644 --- a/modules/creating-single-etcd-backup.adoc +++ b/modules/creating-single-etcd-backup.adoc @@ -7,6 +7,7 @@ [id="creating-single-etcd-backup_{context}"] = Creating a single automated etcd backup +[role="_abstract"] Follow these steps to create a single etcd backup by creating and applying a custom resource (CR). .Prerequisites @@ -32,10 +33,14 @@ spec: - ReadWriteOnce resources: requests: - storage: 200Gi <1> + storage: 200Gi volumeMode: Filesystem ---- -<1> The amount of storage available to the PVC. Adjust this value for your requirements. ++ +[NOTE] +==== +The amount of storage available to the PVC. Adjust this value for your requirements. +==== + .. Apply the PVC by running the following command: + @@ -73,9 +78,13 @@ metadata: name: etcd-single-backup namespace: openshift-etcd spec: - pvcName: etcd-backup-pvc <1> + pvcName: etcd-backup-pvc ---- -<1> The name of the PVC to save the backup to. Adjust this value according to your environment. ++ +[NOTE] +==== +The name of the PVC to save the backup to. Adjust this value according to your environment. +==== + .. Apply the CR to start a single backup: + @@ -115,7 +124,7 @@ metadata: name: etcd-backup-pv-fs spec: capacity: - storage: 100Gi <1> + storage: 100Gi volumeMode: Filesystem accessModes: - ReadWriteOnce @@ -130,10 +139,14 @@ spec: - key: kubernetes.io/hostname operator: In values: - - <2> + - ---- -<1> The amount of storage available to the PV. Adjust this value for your requirements. -<2> Replace this value with the node to attach this PV to. ++ +[NOTE] +==== +- The amount of storage available to the PV. Adjust this value for your requirements. +- Replace `` with the node to attach this PV to. +==== + .. Verify the creation of the PV by running the following command: + @@ -164,9 +177,13 @@ spec: volumeMode: Filesystem resources: requests: - storage: 10Gi <1> + storage: 10Gi ---- -<1> The amount of storage available to the PVC. Adjust this value for your requirements. ++ +[NOTE] +==== +The amount of storage available to the PVC. Adjust this value for your requirements. +==== + .. Apply the PVC by running the following command: + @@ -185,9 +202,13 @@ metadata: name: etcd-single-backup namespace: openshift-etcd spec: - pvcName: etcd-backup-pvc <1> + pvcName: etcd-backup-pvc ---- -<1> The name of the persistent volume claim (PVC) to save the backup to. Adjust this value according to your environment. ++ +[NOTE] +==== +The name of the persistent volume claim (PVC) to save the backup to. Adjust this value according to your environment. +==== + .. Apply the CR to start a single backup: + diff --git a/modules/update-backup-etcd-database-before-update.adoc b/modules/update-backup-etcd-database-before-update.adoc new file mode 100644 index 000000000000..6e431d5e64f7 --- /dev/null +++ b/modules/update-backup-etcd-database-before-update.adoc @@ -0,0 +1,10 @@ +// Module included in the following assemblies: +// +// * edge_computing/day_2_core_cnf_clusters/updating/update-before-the-update.adoc + +:_mod-docs-content-type: CONCEPT +[id="update-backup-etcd-database-before-update_{context}"] += Backup the etcd database before you proceed with the update + +[role="_abstract"] +You must backup the etcd database before you proceed with the update. diff --git a/modules/update-pause-worker-nodes-before-the-update.adoc b/modules/update-pause-worker-nodes-before-the-update.adoc index 260c431d0dcb..d1ab9cb4dcb7 100644 --- a/modules/update-pause-worker-nodes-before-the-update.adoc +++ b/modules/update-pause-worker-nodes-before-the-update.adoc @@ -41,7 +41,7 @@ master false mcp-1 true mcp-2 true ---- - ++ [NOTE] ==== The default control plane and worker `mcp` groups are not changed during an update. diff --git a/post_installation_configuration/day_2_core_cnf_clusters/updating/update-before-the-update.adoc b/post_installation_configuration/day_2_core_cnf_clusters/updating/update-before-the-update.adoc index 7d7ff1d7a8af..c66e63216a36 100644 --- a/post_installation_configuration/day_2_core_cnf_clusters/updating/update-before-the-update.adoc +++ b/post_installation_configuration/day_2_core_cnf_clusters/updating/update-before-the-update.adoc @@ -11,10 +11,7 @@ Before you start the cluster update, you must pause worker nodes, back up the et include::modules/update-pause-worker-nodes-before-the-update.adoc[leveloffset=+1] -[id="update-backup-etcd-database-before-update_{context}"] -== Backup the etcd database before you proceed with the update - -You must backup the etcd database before you proceed with the update. +include::modules/update-backup-etcd-database-before-update.adoc[leveloffset=+1] include::modules/backup-etcd.adoc[leveloffset=+2]