1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00

OSDOCS-16867:CQA-2.0-Reg-2

This commit is contained in:
JoeAldinger
2025-11-13 10:23:06 -05:00
committed by openshift-cherrypick-robot
parent 5c9b62397e
commit e90303b2ae
18 changed files with 73 additions and 48 deletions

View File

@@ -5,6 +5,7 @@
[id="configuring-registry-storage-nutanix_{context}"]
= Configuring registry storage for Nutanix
[role="_abstract"]
As a cluster administrator, following installation you must configure your registry to use storage.
.Prerequisites
@@ -59,9 +60,10 @@ $ oc edit configs.imageregistry.operator.openshift.io
----
storage:
pvc:
claim: <1>
claim:
----
<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.
+
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.
. Check the `clusteroperator` status:

View File

@@ -6,6 +6,7 @@
[id="installation-registry-osp-creating-custom-pvc_{context}"]
= Configuring an image registry with custom storage on clusters that run on {rh-openstack}
[role="_abstract"]
After you install a cluster on {rh-openstack-first}, you can use a Cinder volume that is in a specific availability zone for registry storage.
.Procedure
@@ -51,7 +52,7 @@ apiVersion: v1
kind: PersistentVolumeClaim
metadata:
name: csi-pvc-imageregistry
namespace: openshift-image-registry <1>
namespace: openshift-image-registry
annotations:
imageregistry.openshift.io: "true"
spec:
@@ -60,12 +61,15 @@ spec:
volumeMode: Filesystem
resources:
requests:
storage: 100Gi <2>
storageClassName: <your_custom_storage_class> <3>
storage: 100Gi
storageClassName: <your_custom_storage_class>
----
<1> Enter the namespace `openshift-image-registry`. This namespace allows the Cluster Image Registry Operator to consume the PVC.
<2> Optional: Adjust the volume size.
<3> Enter the name of the storage class that you created.
+
where:
`openshift-image-registry`:: Specifying this namespace allows the Cluster Image Registry Operator to consume the PVC.
`storage`:: This optional field adjusts the volume size.
`storageClassName`:: Specifies the name of the storage class that you created.
. From a command line, apply the configuration:
+

View File

@@ -76,4 +76,4 @@ storage:
claim:
----
+
By creating a custom PVC, you can leave the `claim` field blank for the default automatic creation of an `image-registry-storage` PVC.
By creating a custom PVC, you can leave the `claim` field blank for the default automatic creation of an `image-registry-storage` PVC.

View File

@@ -10,6 +10,7 @@
[id="installation-registry-storage-block-recreate-rollout-nutanix_{context}"]
= Configuring block registry storage for Nutanix volumes
[role="_abstract"]
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.
[IMPORTANT]
@@ -37,19 +38,21 @@ $ oc patch config.imageregistry.operator.openshift.io/cluster --type=merge -p '{
kind: PersistentVolumeClaim
apiVersion: v1
metadata:
name: image-registry-storage <1>
namespace: openshift-image-registry <2>
name: image-registry-storage
namespace: openshift-image-registry
spec:
accessModes:
- ReadWriteOnce <3>
- ReadWriteOnce
resources:
requests:
storage: 100Gi <4>
storage: 100Gi
----
<1> A unique name that represents the `PersistentVolumeClaim` object.
<2> The namespace for the `PersistentVolumeClaim` object, which is `openshift-image-registry`.
<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.
<4> The size of the persistent volume claim.
where:
`name`:: Specifies a unique name that represents the `PersistentVolumeClaim` object.
`namespace`:: Specifies the namespace for the `PersistentVolumeClaim` object, which is `openshift-image-registry`.
`ReadWriteOnce`:: Specifies the access mode of the persistent volume claim. With `ReadWriteOnce`, the volume can be mounted with read and write permissions by a single node.
`storage`:: Specifies the size of the persistent volume claim.
.. Enter the following command to create the `PersistentVolumeClaim` object from the file:
+
@@ -72,4 +75,5 @@ storage:
pvc:
claim: <1>
----
<1> By creating a custom PVC, you can leave the `claim` field blank for the default automatic creation of an `image-registry-storage` PVC.
+
By creating a custom PVC, you can leave the `claim` field blank for the default automatic creation of an `image-registry-storage` PVC.

View File

@@ -12,6 +12,7 @@
[id="installation-registry-storage-block-recreate-rollout_{context}"]
= Configuring block registry storage for VMware vSphere
[role="_abstract"]
To allow the image registry to use block storage types such as vSphere Virtual Machine Disk (VMDK) during upgrades as a cluster administrator, you can use the `Recreate` rollout strategy.
[IMPORTANT]
@@ -39,19 +40,22 @@ $ oc patch config.imageregistry.operator.openshift.io/cluster --type=merge -p '{
kind: PersistentVolumeClaim
apiVersion: v1
metadata:
name: image-registry-storage <1>
namespace: openshift-image-registry <2>
name: image-registry-storage
namespace: openshift-image-registry
spec:
accessModes:
- ReadWriteOnce <3>
- ReadWriteOnce
resources:
requests:
storage: 100Gi <4>
storage: 100Gi
----
<1> A unique name that represents the `PersistentVolumeClaim` object.
<2> The namespace for the `PersistentVolumeClaim` object, which is `openshift-image-registry`.
<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.
<4> The size of the persistent volume claim.
+
where:
`name`:: Specifies a unique name that represents the `PersistentVolumeClaim` object.
`namespace`:: Specifies the `namespace` for the `PersistentVolumeClaim` object, which is `openshift-image-registry`.
`accessModes`:: Specifies the access mode of the persistent volume claim. With `ReadWriteOnce`, the volume can be mounted with read and write permissions by a single node.
`storage`:: The size of the persistent volume claim.
.. Enter the following command to create the `PersistentVolumeClaim` object from the file:
+
@@ -73,6 +77,7 @@ $ oc edit config.imageregistry.operator.openshift.io -o yaml
----
storage:
pvc:
claim: <1>
claim:
----
<1> By creating a custom PVC, you can leave the `claim` field blank for the default automatic creation of an `image-registry-storage` PVC.
+
By creating a custom PVC, you can leave the `claim` field blank for the default automatic creation of an `image-registry-storage` PVC.

View File

@@ -34,15 +34,12 @@ endif::[]
= Image registry storage configuration
ifdef::aws[]
Amazon Web Services provides default storage, which means the Image Registry
Operator is available after installation. However, if the Registry Operator
cannot create an S3 bucket and automatically configure storage, you must
manually configure registry storage.
[role="_abstract"]
Amazon Web Services provides default storage, which means the Image Registry Operator is available after installation. However, if the Registry Operator cannot create an S3 bucket and automatically configure storage, you must manually configure registry storage.
endif::aws[]
ifndef::aws[]
The Image Registry Operator is not initially available for platforms that do
not provide default storage. After installation, you must configure your
registry to use storage so that the Registry Operator is made available.
[role="_abstract"]
The Image Registry Operator is not initially available for platforms that do not provide default storage. After installation, you must configure your registry to use storage so that the Registry Operator is made available.
endif::aws[]
Instructions are shown for configuring a persistent volume, which is required for production clusters. Where applicable, instructions are shown for configuring an empty directory as the storage location, which is available for only non-production clusters.

View File

@@ -18,9 +18,8 @@
[id="installation-registry-storage-non-production_{context}"]
= Configuring storage for the image registry in non-production clusters
You must configure storage for the Image Registry Operator. For non-production
clusters, you can set the image registry to an empty directory. If you do so,
all images are lost if you restart the registry.
[role="_abstract"]
You must configure storage for the Image Registry Operator. For non-production clusters, you can set the image registry to an empty directory. If you do so, all images are lost if you restart the registry.
.Procedure

View File

@@ -12,6 +12,7 @@
[id="registry-change-management-state_{context}"]
= Changing the image registry's management state
[role="_abstract"]
To start the image registry, you must change the Image Registry Operator configuration's `managementState` from `Removed` to `Managed`.
.Procedure

View File

@@ -10,12 +10,13 @@
[id="registry-configuring-registry-storage-rhodf-cephfs_{context}"]
= Configuring the Image Registry Operator to use CephFS storage with Red Hat OpenShift Data Foundation
[role="_abstract"]
{rh-storage-first} integrates multiple storage types that you can use with the {product-registry}:
* Ceph, a shared and distributed file system and on-premise object storage
* NooBaa, providing a Multicloud Object Gateway
This document outlines the procedure to configure the image registry to use CephFS storage.
Use the following procedure to configure the image registry to use CephFS storage.
[NOTE]
====

View File

@@ -16,7 +16,7 @@
* Ceph, a shared and distributed file system and on-premise object storage
* NooBaa, providing a Multicloud Object Gateway
This document outlines the procedure to configure the image registry to use Ceph RGW storage.
Use the following, procedure to configure the image registry to use Ceph RGW storage.
.Prerequisites

View File

@@ -16,7 +16,7 @@
* Ceph, a shared and distributed file system and on-premise object storage
* NooBaa, providing a Multicloud Object Gateway
This document outlines the procedure to configure the image registry to use Noobaa storage.
Use the following the procedure to configure the image registry to use Noobaa storage.
.Prerequisites

View File

@@ -52,8 +52,8 @@ ifdef::ibm-power[]
endif::ibm-power[]
As a cluster administrator, following installation you must configure your
registry to use storage.
[role="_abstract"]
As a cluster administrator, following installation you must configure your registry to use storage.
.Prerequisites

View File

@@ -11,6 +11,7 @@
[id="registry-configuring-storage-vsphere_{context}"]
= Configuring registry storage for VMware vSphere
[role="_abstract"]
As a cluster administrator, following installation you must configure your registry to use storage.
.Prerequisites
@@ -77,10 +78,10 @@ $ oc edit configs.imageregistry.operator.openshift.io
----
storage:
pvc:
claim: <1>
claim:
----
+
<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.
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.
. Check the `clusteroperator` status by running the following command:
+

View File

@@ -17,5 +17,7 @@
[id="registry-removed_{context}"]
= Image registry removed during installation
[role="_abstract"]
On platforms that do not provide shareable object storage, the OpenShift Image Registry Operator bootstraps itself as `Removed`. This allows `openshift-installer` to complete installations on these platform types. After installation, you must edit the Image Registry Operator configuration to switch the `managementState` from `Removed` to `Managed`. After this task has completed, you must configure storage.
[role="_abstract"]
On platforms that do not provide shareable object storage, the OpenShift Image Registry Operator bootstraps itself as `Removed`. This allows `openshift-installer` to complete installations on these platform types.
After installation, you must edit the Image Registry Operator configuration to switch the `managementState` from `Removed` to `Managed`. When this has completed, you must configure storage.

View File

@@ -6,6 +6,9 @@ include::_attributes/common-attributes.adoc[]
toc::[]
[role="_abstract"]
Configure image registry storage for bare-metal clusters after installation. Because bare-metal installations do not automatically provision storage, you must change the registry management state from `Removed` to `Managed` and configure persistent storage or use {rh-storage-first} before the registry can store container images.
include::modules/registry-removed.adoc[leveloffset=+1]
include::modules/registry-change-management-state.adoc[leveloffset=+1]

View File

@@ -3,9 +3,11 @@
= Configuring the registry for Nutanix
include::_attributes/common-attributes.adoc[]
:context: configuring-registry-storage-nutanix
toc::[]
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}
[role="_abstract"]
Users can optimize container image distribution, security, and access controls, enabling a robust foundation for Nutanix applications on {product-title}
include::modules/registry-removed.adoc[leveloffset=+1]

View File

@@ -6,6 +6,7 @@ include::_attributes/common-attributes.adoc[]
toc::[]
[role="_abstract"]
To configure the {product-registry} on bare metal and vSphere to use {rh-storage-first} storage, you must install {rh-storage} and then configure image registry using Ceph or Noobaa.
include::modules/registry-configuring-registry-storage-rhodf-cephrgw.adoc[leveloffset=+1]

View File

@@ -6,6 +6,9 @@ include::_attributes/common-attributes.adoc[]
toc::[]
[role="_abstract"]
Configure image registry storage for vSphere clusters after installation. Because vSphere installations do not automatically provision storage, you must change the registry management state from `Removed` to `Managed` and configure persistent storage or use {rh-storage-first} before the registry can store container images.
include::modules/registry-removed.adoc[leveloffset=+1]
include::modules/registry-change-management-state.adoc[leveloffset=+1]