Skip to content

Commit 26d7319

Browse files
authored
Merge pull request #70110 from stevsmit/OCPBUGS-9446
Updates bare metal configuration docs
2 parents 46516c3 + e231ead commit 26d7319

4 files changed

+53
-11
lines changed

modules/installation-registry-storage-block-recreate-rollout-bare-metal.adoc

Lines changed: 46 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
:_mod-docs-content-type: PROCEDURE
1010
[id="installation-registry-storage-block-recreate-rollout-bare-metal_{context}"]
11-
= Configuring block registry storage
11+
= Configuring block registry storage for bare metal
1212

1313
To allow the image registry to use block storage types during upgrades as a cluster administrator, you can use the `Recreate` rollout strategy.
1414

@@ -21,13 +21,55 @@ If you choose to use a block storage volume with the image registry, you must us
2121

2222
.Procedure
2323

24-
. To set the image registry storage as a block storage type, patch the registry so that it uses the `Recreate` rollout strategy and runs with only one (`1`) replica:
24+
. Enter the following command to set the image registry storage as a block storage type, patch the registry so that it uses the `Recreate` rollout strategy, and runs with only one (`1`) replica:
2525
+
2626
[source,terminal]
2727
----
2828
$ oc patch config.imageregistry.operator.openshift.io/cluster --type=merge -p '{"spec":{"rolloutStrategy":"Recreate","replicas":1}}'
2929
----
30-
+
30+
3131
. Provision the PV for the block storage device, and create a PVC for that volume. The requested block volume uses the ReadWriteOnce (RWO) access mode.
32+
.. Create a `pvc.yaml` file with the following contents to define a VMware vSphere `PersistentVolumeClaim` object:
33+
+
34+
[source,yaml]
35+
----
36+
kind: PersistentVolumeClaim
37+
apiVersion: v1
38+
metadata:
39+
name: image-registry-storage <1>
40+
namespace: openshift-image-registry <2>
41+
spec:
42+
accessModes:
43+
- ReadWriteOnce <3>
44+
resources:
45+
requests:
46+
storage: 100Gi <4>
47+
----
48+
<1> A unique name that represents the `PersistentVolumeClaim` object.
49+
<2> The namespace for the `PersistentVolumeClaim` object, which is `openshift-image-registry`.
50+
<3> The access mode of the persistent volume claim. With `ReadWriteOnce`, the volume can be mounted with read and write permissions by a single node.
51+
<4> The size of the persistent volume claim.
52+
53+
.. Enter the following command to create the `PersistentVolumeClaim` object from the file:
54+
+
55+
[source,terminal]
56+
----
57+
$ oc create -f pvc.yaml -n openshift-image-registry
58+
----
59+
60+
+
61+
. Enter the following command to edit the registry configuration so that it references the correct PVC:
3262
+
33-
. Edit the registry configuration so that it references the correct PVC.
63+
[source,terminal]
64+
----
65+
$ oc edit config.imageregistry.operator.openshift.io -o yaml
66+
----
67+
+
68+
.Example output
69+
[source,yaml]
70+
----
71+
storage:
72+
pvc:
73+
claim: <1>
74+
----
75+
<1> By creating a custom PVC, you can leave the `claim` field blank for the default automatic creation of an `image-registry-storage` PVC.

modules/installation-registry-storage-block-recreate-rollout-nutanix.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ If you choose to use a block storage volume with the image registry, you must us
2121

2222
.Procedure
2323

24-
. To set the image registry storage as a block storage type, patch the registry so that it uses the `Recreate` rollout strategy and runs with only one (`1`) replica:
24+
. Enter the following command to set the image registry storage as a block storage type, patch the registry so that it uses the `Recreate` rollout strategy, and runs with only one (`1`) replica:
2525
+
2626
[source,terminal]
2727
----
@@ -51,14 +51,14 @@ spec:
5151
<3> The access mode of the persistent volume claim. With `ReadWriteOnce`, the volume can be mounted with read and write permissions by a single node.
5252
<4> The size of the persistent volume claim.
5353

54-
.. Create the `PersistentVolumeClaim` object from the file:
54+
.. Enter the following command to create the `PersistentVolumeClaim` object from the file:
5555
+
5656
[source,terminal]
5757
----
5858
$ oc create -f pvc.yaml -n openshift-image-registry
5959
----
6060

61-
. Edit the registry configuration so that it references the correct PVC:
61+
. Enter the following command to edit the registry configuration so that it references the correct PVC:
6262
+
6363
[source,terminal]
6464
----

modules/installation-registry-storage-block-recreate-rollout.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ have more than one replica.
2424

2525
.Procedure
2626

27-
. To set the image registry storage as a block storage type, patch the registry so that it uses the `Recreate` rollout strategy and runs with only `1` replica:
27+
. Enter the following command to set the image registry storage as a block storage type, patch the registry so that it uses the `Recreate` rollout strategy, and runs with only `1` replica:
2828
+
2929
[source,terminal]
3030
----
@@ -53,15 +53,15 @@ spec:
5353
<3> The access mode of the persistent volume claim. With `ReadWriteOnce`, the volume can be mounted with read and write permissions by a single node.
5454
<4> The size of the persistent volume claim.
5555

56-
.. Create the `PersistentVolumeClaim` object from the file:
56+
.. Enter the following command to create the `PersistentVolumeClaim` object from the file:
5757
+
5858
[source,terminal]
5959
----
6060
$ oc create -f pvc.yaml -n openshift-image-registry
6161
----
6262

6363
+
64-
. Edit the registry configuration so that it references the correct PVC:
64+
. Enter the following command to edit the registry configuration so that it references the correct PVC:
6565
+
6666
[source,terminal]
6767
----

modules/persistent-storage-vsphere-dynamic-provisioning-cli.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ spec:
3333
<2> The access mode of the persistent volume claim. With `ReadWriteOnce`, the volume can be mounted with read and write permissions by a single node.
3434
<3> The size of the persistent volume claim.
3535

36-
. Create the `PersistentVolumeClaim` object from the file:
36+
. Enter the following command to create the `PersistentVolumeClaim` object from the file:
3737
+
3838
[source,terminal]
3939
----

0 commit comments

Comments
 (0)