Skip to content

Commit 0ec737c

Browse files
author
Steven Smith
committed
Adds documentation for configuring registry for Nutanix
1 parent 0777e45 commit 0ec737c

8 files changed

+196
-9
lines changed

‎_topic_maps/_topic_map.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1613,6 +1613,9 @@ Topics:
16131613
- Name: Configuring the registry for OpenShift Data Foundation
16141614
File: configuring-registry-storage-rhodf
16151615
Distros: openshift-enterprise,openshift-origin
1616+
- Name: Configuring the registry for Nutanix
1617+
File: configuring-registry-storage-nutanix
1618+
Distros: openshift-enterprise,openshift-origin
16161619
- Name: Accessing the registry
16171620
File: accessing-the-registry
16181621
- Name: Exposing the registry

‎modules/configuring-registry-storage-nutanix.adoc

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
// Module included in the following assemblies:
2+
// * registry/configuring_registry_storage/configuring-registry-storage-nutanix.adoc
3+
4+
:_content-type: PROCEDURE
5+
[id="configuring-registry-storage-nutanix_{context}"]
6+
= Configuring registry storage for Nutanix
7+
8+
As a cluster administrator, following installation you must configure your registry to use storage.
9+
10+
.Prerequisites
11+
12+
* You have access to the cluster as a user with the `cluster-admin` role.
13+
* You have a cluster on Nutanix.
14+
* You have provisioned persistent storage for your cluster, such as {rh-storage-first}.
15+
+
16+
[IMPORTANT]
17+
====
18+
{product-title} supports `ReadWriteOnce` access for image registry storage when you have only one replica. `ReadWriteOnce` access also requires that the registry uses the `Recreate` rollout strategy. To deploy an image registry that supports high availability with two or more replicas, `ReadWriteMany` access is required.
19+
====
20+
+
21+
* You must have 100 Gi capacity.
22+
23+
.Procedure
24+
25+
. To configure your registry to use storage, change the `spec.storage.pvc` in the `configs.imageregistry/cluster` resource.
26+
+
27+
[NOTE]
28+
====
29+
When you use shared storage, review your security settings to prevent outside access.
30+
====
31+
32+
. Verify that you do not have a registry pod:
33+
+
34+
[source,terminal]
35+
----
36+
$ oc get pod -n openshift-image-registry -l docker-registry=default
37+
----
38+
+
39+
.Example output
40+
[source,terminal]
41+
----
42+
No resourses found in openshift-image-registry namespace
43+
----
44+
+
45+
[NOTE]
46+
=====
47+
If you do have a registry pod in your output, you do not need to continue with this procedure.
48+
=====
49+
50+
. Check the registry configuration:
51+
+
52+
[source,terminal]
53+
----
54+
$ oc edit configs.imageregistry.operator.openshift.io
55+
----
56+
+
57+
.Example output
58+
[source,yaml]
59+
----
60+
storage:
61+
pvc:
62+
claim: <1>
63+
----
64+
<1> Leave the `claim` field blank to allow the automatic creation of an `image-registry-storage` persistent volume claim (PVC). The PVC is generated based on the default storage class. However, be aware that the default storage class might provide ReadWriteOnce (RWO) volumes, such as a RADOS Block Device (RBD), which can cause issues when you replicate to more than one replica.
65+
66+
67+
. Check the `clusteroperator` status:
68+
+
69+
[source,terminal]
70+
----
71+
$ oc get clusteroperator image-registry
72+
----
73+
+
74+
.Example output
75+
[source,terminal]
76+
----
77+
NAME VERSION AVAILABLE PROGRESSING DEGRADED SINCE MESSAGE
78+
image-registry 4.13 True False False 6h50m
79+
----

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

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,9 @@ To allow the image registry to use block storage types during upgrades as a clus
1414

1515
[IMPORTANT]
1616
====
17-
Block storage volumes, or block persistent volumes, are supported but not recommended for use with the image
18-
registry on production clusters. An installation where the registry is
19-
configured on block storage is not highly available because the registry cannot
20-
have more than one replica.
17+
Block storage volumes, or block persistent volumes, are supported but not recommended for use with the image registry on production clusters. An installation where the registry is configured on block storage is not highly available because the registry cannot have more than one replica.
2118
22-
If you choose to use a block storage volume with the image registry, you must use a filesystem Persistent Volume Claim (PVC).
19+
If you choose to use a block storage volume with the image registry, you must use a filesystem persistent volume claim (PVC).
2320
====
2421

2522
.Procedure

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

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * installing/installing_bare_metal/installing-bare-metal.adoc
4+
// * installing/installing_baremetal/installing-bare-metal-network-customizations.adoc
5+
// * installing/installing_baremetal/installing-restricted-networks-bare-metal.adoc
6+
// * installing/installing_platform_agnostic/installing-platform-agnostic.adoc
7+
// * registry/configuring_registry_storage/configuring-registry-storage-baremetal.adoc
8+
9+
:_content-type: PROCEDURE
10+
[id="installation-registry-storage-block-recreate-rollout-nutanix_{context}"]
11+
= Configuring block registry storage for Nutanix volumes
12+
13+
To allow the image registry to use block storage types such as Nutanix volumes during upgrades as a cluster administrator, you can use the `Recreate` rollout strategy.
14+
15+
[IMPORTANT]
16+
====
17+
Block storage volumes, or block persistent volumes, are supported but not recommended for use with the image registry on production clusters. An installation where the registry is configured on block storage is not highly available because the registry cannot have more than one replica.
18+
19+
If you choose to use a block storage volume with the image registry, you must use a filesystem persistent volume claim (PVC).
20+
====
21+
22+
.Procedure
23+
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:
25+
+
26+
[source,terminal]
27+
----
28+
$ oc patch config.imageregistry.operator.openshift.io/cluster --type=merge -p '{"spec":{"rolloutStrategy":"Recreate","replicas":1}}'
29+
----
30+
31+
. 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+
33+
.. Create a `pvc.yaml` file with the following contents to define a Nutanix `PersistentVolumeClaim` object:
34+
+
35+
[source,yaml]
36+
----
37+
kind: PersistentVolumeClaim
38+
apiVersion: v1
39+
metadata:
40+
name: image-registry-storage <1>
41+
namespace: openshift-image-registry <2>
42+
spec:
43+
accessModes:
44+
- ReadWriteOnce <3>
45+
resources:
46+
requests:
47+
storage: 100Gi <4>
48+
----
49+
<1> A unique name that represents the `PersistentVolumeClaim` object.
50+
<2> The namespace for the `PersistentVolumeClaim` object, which is `openshift-image-registry`.
51+
<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.
52+
<4> The size of the persistent volume claim.
53+
54+
.. Create the `PersistentVolumeClaim` object from the file:
55+
+
56+
[source,terminal]
57+
----
58+
$ oc create -f pvc.yaml -n openshift-image-registry
59+
----
60+
61+
. Edit the registry configuration so that it references the correct PVC:
62+
+
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.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,4 +75,4 @@ storage:
7575
pvc:
7676
claim: <1>
7777
----
78-
<1> Creating a custom PVC allows you to leave the `claim` field blank for the default automatic creation of an `image-registry-storage` PVC.
78+
<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/registry-configuring-storage-baremetal.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ the `configs.imageregistry/cluster` resource.
6767
+
6868
[NOTE]
6969
====
70-
When using shared storage, review your security settings to prevent outside access.
70+
When you use shared storage, review your security settings to prevent outside access.
7171
====
7272

7373
. Verify that you do not have a registry pod:

‎modules/registry-configuring-storage-vsphere.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ components.
4646
+
4747
[NOTE]
4848
====
49-
When using shared storage, review your security settings to prevent outside access.
49+
When you use shared storage, review your security settings to prevent outside access.
5050
====
5151

5252
. Verify that you do not have a registry pod:
@@ -81,7 +81,7 @@ storage:
8181
claim: <1>
8282
----
8383
+
84-
<1> Leave the `claim` field blank to allow the automatic creation of an `image-registry-storage` persistent volume claim (PVC). The PVC is generated based on the default storage class. However, be aware that the default storage class might provide ReadWriteOnce (RWO) volumes, such as a RADOS Block Device (RBD), which can cause issues when replicating to more than one replica.
84+
<1> Leave the `claim` field blank to allow the automatic creation of an `image-registry-storage` persistent volume claim (PVC). The PVC is generated based on the default storage class. However, be aware that the default storage class might provide ReadWriteOnce (RWO) volumes, such as a RADOS Block Device (RBD), which can cause issues when you replicate to more than one replica.
8585

8686
. Check the `clusteroperator` status:
8787
+

‎registry/configuring_registry_storage/configuring-registry-storage-nutanix.adoc

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
:_content-type: ASSEMBLY
2+
[id="configuring-registry-storage-nutanix"]
3+
= Configuring the registry for Nutanix
4+
include::_attributes/common-attributes.adoc[]
5+
:context: configuring-registry-storage-nutanix
6+
toc::[]
7+
8+
By following the steps outlined in this documentation, users can optimize container image distribution, security, and access controls, enabling a robust foundation for Nutanix applications on {product-title}
9+
10+
include::modules/registry-removed.adoc[leveloffset=+1]
11+
12+
include::modules/registry-change-management-state.adoc[leveloffset=+1]
13+
14+
include::modules/installation-registry-storage-config.adoc[leveloffset=+1]
15+
16+
include::modules/configuring-registry-storage-nutanix.adoc[leveloffset=+2]
17+
18+
include::modules/installation-registry-storage-non-production.adoc[leveloffset=+2]
19+
20+
include::modules/installation-registry-storage-block-recreate-rollout-nutanix.adoc[leveloffset=+2]
21+
22+
include::modules/registry-configuring-registry-storage-rhodf-cephrgw.adoc[leveloffset=+2]
23+
24+
include::modules/registry-configuring-registry-storage-rhodf-nooba.adoc[leveloffset=+2]
25+
26+
include::modules/registry-configuring-registry-storage-rhodf-cephfs.adoc[leveloffset=+1]
27+
28+
[id="configuring-registry-storage-nutanix-addtl-resources"]
29+
[role="_additional-resources"]
30+
== Additional resources
31+
32+
* xref:../../scalability_and_performance/optimization/optimizing-storage.adoc#optimizing-storage[Recommended configurable storage technology]
33+
* link:https://access.redhat.com/documentation/en-us/red_hat_openshift_data_foundation/4.10/html-single/managing_and_allocating_storage_resources/index#configuring-image-registry-to-use-openshift-data-foundation_rhodf[Configuring Image Registry to use OpenShift Data Foundation]

0 commit comments

Comments
 (0)