Skip to content

Commit c98bd48

Browse files
committed
OSDOCS-13183: update CSI snapshot docs to remove webhook
1 parent 6c7d922 commit c98bd48

13 files changed

+37
-36
lines changed

microshift_networking/microshift_network_policy/microshift-network-policy-index.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
= About network policies
44
include::_attributes/attributes-microshift.adoc[]
55
:context: microshift-network-policies
6+
67
toc::[]
78

89
Learn how network policies work for {microshift-short} to restrict or allow network traffic to pods in your cluster.

microshift_storage/volume-snapshots-microshift.adoc

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -28,23 +28,21 @@ Only the logical volume manager storage (LVMS) plugin CSI driver is supported by
2828

2929
* xref:../microshift_storage/understanding-persistent-storage-microshift.adoc#persistent-volumes_understanding-persistent-storage-microshift[Understanding persistent volumes]
3030
31-
* link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/{op-system-version-major}/html/configuring_and_managing_logical_volumes/creating-and-managing-thin-provisioned-volumes_configuring-and-managing-logical-volumes[Configuring and managing logical volumes]
31+
* link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/configuring_and_managing_logical_volumes/managing-lvm-volume-groups_configuring-and-managing-logical-volumes[Managing LVM volume groups] ({op-system-base} documentation)
3232
33-
* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{ocp-version}/html/storage/using-container-storage-interface-csi#persistent-storage-csi-snapshots[CSI snapshots: `VolumeSnapshot` APIs]
33+
* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{ocp-version}/html/storage/using-container-storage-interface-csi#persistent-storage-csi-snapshots[CSI snapshots: `VolumeSnapshot` APIs] ({OCP} documentation)
3434
35-
* link:https://docs.openshift.com/container-platform/{ocp-version}/rest_api/storage_apis/volumesnapshot-snapshot-storage-k8s-io-v1.html[VolumeSnapshot API specification]
35+
* link:https://docs.openshift.com/container-platform/{ocp-version}/rest_api/storage_apis/volumesnapshot-snapshot-storage-k8s-io-v1.html[VolumeSnapshot API specification] ({OCP} documentation)
3636
3737
include::modules/microshift-lvm-thin-volumes.adoc[leveloffset=+1]
3838

3939
//additional resources for thin volumes module
4040
[role="_additional-resources"]
4141
.Additional resources
4242

43-
* To create a thin pool on the host, see link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/{op-system-version-major}/html/configuring_and_managing_logical_volumes/creating-and-managing-thin-provisioned-volumes_configuring-and-managing-logical-volumes[Creating and managing thin provisioned volumes]
43+
* To create a thin pool on the host, see link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/configuring_and_managing_logical_volumes/basic-logical-volume-management_configuring-and-managing-logical-volumes#creating-thin-logical-volume_creating-logical-volumes[Creating a thin logical volume] ({op-system-base} documentation)
4444
45-
* link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/{op-system-version-major}/html/configuring_and_managing_logical_volumes/creating-and-managing-thin-provisioned-volumes_configuring-and-managing-logical-volumes#creating-thinly-provisioned-logical-volumes_creating-and-managing-thin-provisioned-volumes[Creating thinly provisioned logical volumes]
46-
47-
* link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/{op-system-version-major}/html/configuring_and_managing_logical_volumes/creating-and-managing-thin-provisioned-volumes_configuring-and-managing-logical-volumes[Configuring and managing thin provisioned volumes]
45+
* link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html/configuring_and_managing_logical_volumes/creating-and-managing-thin-provisioned-volumes_configuring-and-managing-logical-volumes[Configuring and managing thin provisioned volumes]
4846
4947
* xref:../microshift_storage/volume-snapshots-microshift.adoc#microshift-storage-classes_volume-snapshots-microshift[Storage classes]
5048
@@ -56,7 +54,7 @@ include::modules/microshift-storage-classes.adoc[leveloffset=+2]
5654
[role="_additional-resources"]
5755
.Additional resources
5856

59-
* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{ocp-version}/html/storage/dynamic-provisioning#defining-storage-classes_dynamic-provisioning[Defining storage classes]
57+
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html/storage/dynamic-provisioning#defining-storage-classes_dynamic-provisioning[Defining storage classes]
6058
6159
* xref:../microshift_storage/microshift-storage-plugin-overview.adoc#microshift-storage-device-classes_microshift-storage-plugin-overview[Storage device classes]
6260
@@ -66,7 +64,7 @@ include::modules/microshift-storage-vol-snapshot-class.adoc[leveloffset=+1]
6664
[role="_additional-resources"]
6765
.Additional resources
6866

69-
* link:https://docs.openshift.com/container-platform/{ocp-version}/storage/container_storage_interface/persistent-storage-csi-snapshots.html#volume-snapshot-crds[OpenShift CSI volume snapshots]
67+
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html/storage/using-container-storage-interface-csi#persistent-storage-csi-snapshots-overview_persistent-storage-csi-snapshots[OpenShift CSI volume snapshots]
7068
7169
include::modules/microshift-storage-about-vol-snapshots.adoc[leveloffset=+1]
7270

@@ -80,7 +78,7 @@ include::modules/microshift-storage-vol-snapshot-restore.adoc[leveloffset=+2]
8078
[role="_additional-resources"]
8179
.Additional resources
8280

83-
* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{ocp-version}/html/storage/using-container-storage-interface-csi#persistent-storage-csi-snapshots-provision_persistent-storage-csi-snapshots[Restoring a volume snapshot]
81+
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html/storage/using-container-storage-interface-csi#persistent-storage-csi-snapshots-restore_persistent-storage-csi-snapshots[Restoring a volume snapshot]
8482
8583
//this module is reused from OCP; take care in editing for MicroShift
8684
include::modules/persistent-storage-csi-snapshots-delete.adoc[leveloffset=+2]
@@ -91,8 +89,9 @@ include::modules/microshift-storage-volume-cloning.adoc[leveloffset=+1]
9189
[role="_additional-resources"]
9290
.Additional resources
9391

94-
* link:https://docs.openshift.com/container-platform/{ocp-version}/storage/container_storage_interface/persistent-storage-csi-cloning.html[CSI volume cloning]
92+
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html/storage/using-container-storage-interface-csi#persistent-storage-csi-cloning[CSI volume cloning]
9593
96-
* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{ocp-version}/html/storage/configuring-persistent-storage#lvms-creating-volume-clones-in-single-node-openshift_logical-volume-manager-storage[LVMS volume cloning for Single-Node OpenShift]
94+
//* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{ocp-version}/html/storage/configuring-persistent-storage#lvms-creating-volume-clones-in-single-node-openshift_logical-volume-manager-storage[LVMS volume cloning for Single-Node OpenShift]
95+
//cannot find new link
9796

9897
* To configure the host to enable cloning, see xref:../microshift_storage/volume-snapshots-microshift.adoc#microshift-lvm-thin-volumes_volume-snapshots-microshift[About LVM thin volumes]

modules/microshift-config-parameters-table.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -259,5 +259,5 @@ container_memory_working_set_bytes{container=`router`,namespace=`openshift-ingre
259259

260260
|`storage.optionalCsiComponents`
261261
|`array`
262-
|Default value is null or an empty array. A null or empty array defaults to deploying `snapshot-controller` and `snapshot-webhook`. Expected values are `csi-snapshot-controller`, `csi-snapshot-webhook`, or `none`. An entry of `none` is mutually exclusive with all other values.
262+
|Default value is null or an empty array. A null or empty array defaults to deploying `snapshot-controller`. Expected values are `csi-snapshot-controller` or `none`. A value of `none` is mutually exclusive with all other values.
263263
|===

modules/microshift-default-settings.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,4 +90,4 @@ storage:
9090
<1> Calculated based on the address of the service network.
9191
<2> The IP address of the default route.
9292
<3> Default null value deploys Logical Volume Managed Storage (LVMS).
93-
<4> Default null value deploys `snapshot-controller` and `snapshot-webhook`.
93+
<4> Default null value deploys `snapshot-controller`.

modules/microshift-deploying-a-load-balancer.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,6 @@ $ oc get pods -A
2929
NAMESPACE NAME READY STATUS RESTARTS AGE
3030
default i-06166fbb376f14a8bus-west-2computeinternal-debug-qtwcr 1/1 Running 0 46m
3131
kube-system csi-snapshot-controller-5c6586d546-lprv4 1/1 Running 0 51m
32-
kube-system csi-snapshot-webhook-6bf8ddc7f5-kz6k9 1/1 Running 0 51m
3332
openshift-dns dns-default-45jl7 2/2 Running 0 50m
3433
openshift-dns node-resolver-7wmzf 1/1 Running 0 51m
3534
openshift-ingress router-default-78b86fbf9d-qvj9s 1/1 Running 0 51m

modules/microshift-disabling-lvms-csi-snapshot.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,11 @@ This procedure is for users who are defining the configuration file before insta
3232
<1> Accepted values are:
3333
* Not defining `optionalCsiComponents`.
3434
* Specifying `optionalCsiComponents` field with an empty value (`[]`) or a single empty string element (`[""]`).
35-
* Specifying `optionalCsiComponents` with one of the accepted values which are `snapshot-controller`, `snapshot-webhook`, or `none`. `none` is mutually exclusive with all other values.
35+
* Specifying `optionalCsiComponents` with one of the accepted values which are `snapshot-controller`, or `none`. A value of `none` is mutually exclusive with all other values.
3636
+
3737
[NOTE]
3838
====
39-
If the `optionalCsiComponents` value is empty or null, {microshift-short} defaults to deploying snapshot-controller and snapshot-webhook.
39+
If the `optionalCsiComponents` value is empty or null, {microshift-short} defaults to deploying snapshot-controller.
4040
====
4141

4242
. After the `optionalCsiComponents` field is specified with a supported value in the `config.yaml`, start {microshift-short} by running the following command:

modules/microshift-disconnected-host-procedure.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ $ sudo systemctl reboot <1>
9595

9696
At this point, network access to the {microshift-short} host has been severed. If you have access to the host terminal, you can use the host CLI to verify that the cluster has started in a stable state.
9797

98-
. Verify that the {microshift-short} cluster is running by entering the following command:
98+
. Verify that the {microshift-short} cluster is running by entering the following commands:
9999
+
100100
[source,terminal]
101101
----
@@ -108,7 +108,6 @@ $ sudo -E oc get pods -A
108108
----
109109
NAMESPACE NAME READY STATUS RESTARTS AGE
110110
kube-system csi-snapshot-controller-74d566564f-66n2f 1/1 Running 0 1m
111-
kube-system csi-snapshot-webhook-69bdff8879-xs6mb 1/1 Running 0 1m
112111
openshift-dns dns-default-dxglm 2/2 Running 0 1m
113112
openshift-dns node-resolver-dbf5v 1/1 Running 0 1m
114113
openshift-ingress router-default-8575d888d8-xmq9p 1/1 Running 0 1m

modules/microshift-nw-ipv6-dual-stack-migrating-config.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,6 @@ $ oc get pod -A -o wide
106106
----
107107
NAMESPACE NAME READY STATUS RESTARTS AGE IP NODE NOMINATED NODE READINESS GATES
108108
kube-system csi-snapshot-controller-bb7cb654b-7s5ql 1/1 Running 0 46m 10.42.0.6 microshift-9 <none> <none>
109-
kube-system csi-snapshot-webhook-95f475949-jrqv8 1/1 Running 0 46m 10.42.0.4 microshift-9 <none> <none>
110109
openshift-dns dns-default-zxkqn 2/2 Running 0 46m 10.42.0.5 microshift-9 <none> <none>
111110
openshift-dns node-resolver-r2h5z 1/1 Running 0 46m 192.168.113.117 microshift-9 <none> <none>
112111
openshift-ingress router-default-5b75594b4-228z7 1/1 Running 0 2m5s 10.42.0.3 microshift-9 <none> <none>

modules/microshift-nw-ipv6-single-stack-config.adoc

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,6 @@ $ oc get pod -A -o wide
8181
----
8282
NAMESPACE NAME READY STATUS RESTARTS AGE IP NODE NOMINATED NODE READINESS GATES
8383
kube-system csi-snapshot-controller-bb7cb654b-rqrt6 1/1 Running 0 65s fd01:0:0:1::5 microshift-9 <none> <none>
84-
kube-system csi-snapshot-webhook-95f475949-nbz8x 1/1 Running 0 61s fd01:0:0:1::6 microshift-9 <none> <none>
8584
openshift-dns dns-default-cjn66 2/2 Running 0 62s fd01:0:0:1::9 microshift-9 <none> <none>
8685
openshift-dns node-resolver-ppnjb 1/1 Running 0 63s 2001:db9:ca7:ff::1db8 microshift-9 <none> <none>
8786
openshift-ingress router-default-6d97d7b8b6-wdtmg 1/1 Running 0 61s fd01:0:0:1::8 microshift-9 <none> <none>
@@ -100,11 +99,10 @@ $ oc get svc -A
10099
----
101100
+
102101
.Example output
103-
[source,terminal]
102+
[source,text]
104103
----
105104
NAMESPACE NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
106105
default kubernetes ClusterIP fd02::1 <none> 443/TCP 3m42s
107-
kube-system csi-snapshot-webhook ClusterIP fd02::4c4f <none> 443/TCP 3m20s
108106
openshift-dns dns-default ClusterIP fd02::a <none> 53/UDP,53/TCP,9154/TCP 2m58s
109107
openshift-ingress router-default LoadBalancer fd02::f2e6 2001:db9:ca7:ff::1db8,fd01:0:0:1::2,fd02::1:0,fd69::2 80:31133/TCP,443:31996/TCP 2m58s
110108
openshift-ingress router-internal-default ClusterIP fd02::c55e <none> 80/TCP,443/TCP,1936/TCP 2m58s

modules/microshift-storage-backup-volume-snapshots.adoc

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,22 +21,26 @@ To find specific snapshots and copy them, use the following procedure.
2121
+
2222
[source,terminal]
2323
----
24-
$ oc get volumesnapshot -n <namespace> <snapshot_name> -o 'jsonpath={.status.volumeSnapshotContentName}'
24+
$ oc get volumesnapshot -n <namespace> <snapshot_name> -o 'jsonpath={.status.volumeSnapshotContentName}' # <1>
2525
----
26+
<1> Replace _<namespace>_ and _<snapshot_name>_ with the namespace and snapshot name you used.
2627

2728
. Get the unique identity of the volume created on the storage backend by using the following command and inserting the name retrieved in the previous step:
2829
+
2930
[source,terminal]
3031
----
31-
$ oc get volumesnapshotcontent snapcontent-<retrieved_volume_identity> -o 'jsonpath={.status.snapshotHandle}'
32+
$ oc get volumesnapshotcontent snapcontent-<retrieved_volume_identity> -o 'jsonpath={.status.snapshotHandle}' # <1>
3233
----
34+
<1> Replace _<retrieved_volume_identity>_ with the volume identity.
3335

3436
. Display the snapshots by using the unique identity of the volume you retrieved in the previous step to determine which one you want to backup by running the following command:
3537
+
3638
[source,terminal]
3739
----
38-
$ sudo lvdisplay <retrieved_snapshot_handle>
40+
$ sudo lvdisplay <retrieved_volume_identity> # <1>
3941
----
42+
<1> Replace _<retrieved_volume_identity>_ with the volume identity.
43+
4044
+
4145
.Example output
4246
[source,terminal]
@@ -73,12 +77,14 @@ $ sudo mkdir /mnt/snapshot
7377
+
7478
[source,terminal]
7579
----
76-
$ sudo mount /dev/<retrieved_snapshot_handle> /mnt/snapshot
80+
$ sudo mount /dev/<retrieved_snapshot_handle> /mnt/snapshot # <1>
7781
----
82+
<1> Replace _<retrieved_snapshot_handle>_ with the device name.
7883

7984
. Copy the files from the mounted location and store them in a secure location by running the following command:
8085
+
8186
[source,terminal]
8287
----
83-
$ sudo cp -r /mnt/snapshot <destination>
84-
----
88+
$ sudo cp -r /mnt/snapshot <destination> # <1>
89+
----
90+
<1> Replace _<destination>_ with the path to the secure location.

0 commit comments

Comments
 (0)