Skip to content

TELCODOCS-2706 DITA rewrite for update-before-the-update.adoc #106567

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rohennes wants to merge 1 commit into
base: main
Choose a base branch
from
Open

TELCODOCS-2706 DITA rewrite for update-before-the-update.adoc #106567

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions modules/backup-etcd.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
45 changes: 33 additions & 12 deletions modules/creating-single-etcd-backup.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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:
+
Expand Down Expand Up @@ -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:
+
Expand Down Expand Up @@ -115,7 +124,7 @@ metadata:
name: etcd-backup-pv-fs
spec:
capacity:
storage: 100Gi <1>
storage: 100Gi
volumeMode: Filesystem
accessModes:
- ReadWriteOnce
Expand All @@ -130,10 +139,14 @@ spec:
- key: kubernetes.io/hostname
operator: In
values:
- <example_master_node> <2>
- <example_master_node>
----
<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 `<example_master_node>` with the node to attach this PV to.
====
+
.. Verify the creation of the PV by running the following command:
+
Expand Down Expand Up @@ -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:
+
Expand All @@ -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:
+
Expand Down
10 changes: 10 additions & 0 deletions modules/update-backup-etcd-database-before-update.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion modules/update-pause-worker-nodes-before-the-update.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
5 changes: 1 addition & 4 deletions ...on_configuration/day_2_core_cnf_clusters/updating/update-before-the-update.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]

Expand Down