Skip to content

Commit edf6078

Browse files
JoeAldingerJoeAldinger
committed
OSDOCS-16866:CQA-2.0-reg-1
1 parent 7cbeae2 commit edf6078

20 files changed

+103
-64
lines changed

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

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
[id="installation-registry-storage-block-recreate-rollout-bare-metal_{context}"]
1111
= Configuring block registry storage for bare metal
1212

13+
[role="_abstract"]
1314
To allow the image registry to use block storage types during upgrades as a cluster administrator, you can use the `Recreate` rollout strategy.
1415

1516
[IMPORTANT]
@@ -36,19 +37,21 @@ $ oc patch config.imageregistry.operator.openshift.io/cluster --type=merge -p '{
3637
kind: PersistentVolumeClaim
3738
apiVersion: v1
3839
metadata:
39-
name: image-registry-storage <1>
40-
namespace: openshift-image-registry <2>
40+
name: image-registry-storage
41+
namespace: openshift-image-registry
4142
spec:
4243
accessModes:
43-
- ReadWriteOnce <3>
44+
- ReadWriteOnce
4445
resources:
4546
requests:
46-
storage: 100Gi <4>
47+
storage: 100Gi
4748
----
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.
49+
where:
50+
51+
`name`:: Specifies a unique name that represents the `PersistentVolumeClaim` object.
52+
`namespace`:: Specifies the `namespace` for the `PersistentVolumeClaim` object, which is `openshift-image-registry`.
53+
`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.
54+
`storage`:: The size of the persistent volume claim.
5255

5356
.. Enter the following command to create the `PersistentVolumeClaim` object from the file:
5457
+
@@ -70,6 +73,7 @@ $ oc edit config.imageregistry.operator.openshift.io -o yaml
7073
----
7174
storage:
7275
pvc:
73-
claim: <1>
76+
claim:
7477
----
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.
78+
+
79+
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-registry-storage-rhodf-cephrgw.adoc‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
[id="registry-configuring-registry-storage-rhodf-cephrgw_{context}"]
1111
= Configuring the Image Registry Operator to use Ceph RGW storage with Red Hat OpenShift Data Foundation
1212

13+
[role="_abstract"]
1314
{rh-storage-first} integrates multiple storage types that you can use with the {product-registry}:
1415

1516
* Ceph, a shared and distributed file system and on-premise object storage
@@ -36,13 +37,14 @@ apiVersion: objectbucket.io/v1alpha1
3637
kind: ObjectBucketClaim
3738
metadata:
3839
name: rgwbucket
39-
namespace: openshift-storage <1>
40+
namespace: openshift-storage
4041
spec:
4142
storageClassName: ocs-storagecluster-ceph-rgw
4243
generateBucketName: rgwbucket
4344
EOF
4445
----
45-
<1> Alternatively, you can use the `openshift-image-registry` namespace.
46+
+
47+
Alternatively, you can use the `openshift-image-registry` for the `namespace` value.
4648

4749
. Get the bucket name by entering the following command:
4850
+

‎modules/registry-configuring-registry-storage-rhodf-nooba.adoc‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
[id="registry-configuring-registry-storage-rhodf-nooba_{context}"]
1111
= Configuring the Image Registry Operator to use Noobaa storage with Red Hat OpenShift Data Foundation
1212

13+
[role="_abstract"]
1314
{rh-storage-first} integrates multiple storage types that you can use with the {product-registry}:
1415

1516
* Ceph, a shared and distributed file system and on-premise object storage
@@ -35,13 +36,14 @@ apiVersion: objectbucket.io/v1alpha1
3536
kind: ObjectBucketClaim
3637
metadata:
3738
name: noobaatest
38-
namespace: openshift-storage <1>
39+
namespace: openshift-storage
3940
spec:
4041
storageClassName: openshift-storage.noobaa.io
4142
generateBucketName: noobaatest
4243
EOF
4344
----
44-
<1> Alternatively, you can use the `openshift-image-registry` namespace.
45+
+
46+
Alternatively, you can use the `openshift-image-registry` for the `namespace` value.
4547

4648
. Get the bucket name by entering the following command:
4749
+

‎modules/registry-configuring-registry-storage-swift-trust.adoc‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,14 @@
77
[id="registry-configuring-registry-storage-swift-trust_{context}"]
88
= Configuring Image Registry Operator redirects
99

10+
[role="_abstract"]
1011
By disabling redirects, you can configure the Image Registry Operator to control whether clients such as {product-title} cluster builds or external systems like developer machines are redirected to pull images directly from {rh-openstack-first} Swift storage. This configuration is optional and depends on whether the clients trust the storage's SSL/TLS certificates.
1112

1213
[NOTE]
1314
====
14-
In situations where clients to not trust the storage certificate, setting the `disableRedirect` option can be set to `true` proxies traffic through the image registry. Consequently, however, the image registry might require more resources, especially network bandwidth, to handle the increased load.
15+
In situations where clients to not trust the storage certificate, setting the `disableRedirect` option can be set to `true` proxies traffic through the image registry. Consequently, however, the image registry might require more resources, especially network bandwidth, to handle the increased load.
1516
16-
Alternatively, if clients trust the storage certificate, the registry can allow redirects. This reduces resource demand on the registry itself.
17+
Alternatively, if clients trust the storage certificate, the registry can allow redirects. This reduces resource demand on the registry itself.
1718
1819
Some users might prefer to configure their clients to trust their self-signed certificate authorities (CAs) instead of disabling redirects. If you are using a self-signed CA, you must decide between trusting the custom CAs or disabling redirects.
1920
====

‎modules/registry-configuring-storage-aws-user-infra.adoc‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,16 @@
88
[id="registry-configuring-storage-aws-user-infra_{context}"]
99
= Configuring registry storage for AWS with user-provisioned infrastructure
1010

11-
During installation, your cloud credentials are sufficient to create an Amazon S3 bucket
12-
and the Registry Operator will automatically configure storage.
11+
[role="_abstract"]
12+
During installation, your cloud credentials are sufficient to create an Amazon S3 bucket and the Registry Operator will automatically configure storage.
1313

14-
If the Registry Operator cannot create an S3 bucket and automatically configure
15-
storage, you can create an S3 bucket and configure storage with the following
16-
procedure.
14+
If the Registry Operator cannot create an S3 bucket and automatically configure storage, you can create an S3 bucket and configure storage with the following procedure.
15+
16+
[WARNING]
17+
====
18+
To secure your registry images in AWS, link:https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-publicaccessblockconfiguration.html[block public access]
19+
to the S3 bucket.
20+
====
1721

1822
.Prerequisites
1923

@@ -24,9 +28,6 @@ procedure.
2428
2529
.Procedure
2630

27-
Use the following procedure if the Registry Operator cannot create an S3 bucket
28-
and automatically configure storage.
29-
3031
. Set up a link:https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config[Bucket Lifecycle Policy]
3132
to abort incomplete multipart uploads that are one day old.
3233

@@ -41,14 +42,13 @@ $ oc edit configs.imageregistry.operator.openshift.io/cluster
4142
.Example configuration
4243
[source,yaml]
4344
----
44-
storage:
45-
s3:
46-
bucket: <bucket-name>
47-
region: <region-name>
45+
apiVersion: imageregistry.operator.openshift.io/v1
46+
kind: Config
47+
metadata:
48+
name: cluster
49+
spec:
50+
storage:
51+
s3:
52+
bucket: <bucket_name>
53+
region: <region_name>
4854
----
49-
50-
[WARNING]
51-
====
52-
To secure your registry images in AWS, link:https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-publicaccessblockconfiguration.html[block public access]
53-
to the S3 bucket.
54-
====

‎modules/registry-configuring-storage-azure-gov-cloud.adoc‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
[id="registry-configuring-storage-azure-gov-cloud_{context}"]
77
= Configuring registry storage for Azure Government
88

9+
[role="_abstract"]
910
During installation, your cloud credentials are sufficient to create Azure Blob
1011
Storage, and the Registry Operator automatically configures storage.
1112

@@ -35,6 +36,7 @@ storage:
3536
azure:
3637
accountName: <storage-account-name>
3738
container: <container-name>
38-
cloudName: AzureUSGovernmentCloud <1>
39+
cloudName: AzureUSGovernmentCloud
3940
----
40-
<1> `cloudName` is the name of the Azure cloud environment, which can be used to configure the Azure SDK with the appropriate Azure API endpoints. Defaults to `AzurePublicCloud`. You can also set `cloudName` to `AzureUSGovernmentCloud`, `AzureChinaCloud`, or `AzureGermanCloud` with sufficient credentials.
41+
+
42+
`cloudName` is the name of the Azure cloud environment, which can be used to configure the Azure SDK with the appropriate Azure API endpoints. Defaults to `AzurePublicCloud`. You can also set `cloudName` to `AzureUSGovernmentCloud`, `AzureChinaCloud`, or `AzureGermanCloud` with sufficient credentials.

‎modules/registry-configuring-storage-azure-user-infra.adoc‎

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
[id="registry-configuring-storage-azure-user-infra_{context}"]
77
= Configuring registry storage for Azure
88

9+
[role="_abstract"]
910
During installation, your cloud credentials are sufficient to create Azure Blob
1011
Storage, and the Registry Operator automatically configures storage.
1112

@@ -31,8 +32,13 @@ $ oc edit configs.imageregistry.operator.openshift.io/cluster
3132
.Example configuration
3233
[source,yaml]
3334
----
34-
storage:
35-
azure:
36-
accountName: <storage-account-name>
37-
container: <container-name>
35+
apiVersion: imageregistry.operator.openshift.io/v1
36+
kind: Config
37+
metadata:
38+
name: cluster
39+
spec:
40+
storage:
41+
azure:
42+
accountName: <storage_account_name>
43+
container: <container_name>
3844
----

‎modules/registry-configuring-storage-gcp-user-infra.adoc‎

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
[id="registry-configuring-storage-gcp-user-infra_{context}"]
77
= Configuring the registry storage for {gcp-short} with user-provisioned infrastructure
88

9+
[role="_abstract"]
910
If the Registry Operator cannot create a {gcp-first} bucket, you must set up the storage medium manually and configure the settings in the registry custom resource (CR).
1011

1112
.Prerequisites
@@ -17,6 +18,11 @@ cloud credentials.
1718
contents of a credentials file provided by {gcp-short}:
1819
** `REGISTRY_STORAGE_GCS_KEYFILE`
1920
21+
[WARNING]
22+
====
23+
You can secure your registry images that use a {gcp-full} Storage bucket by setting link:https://cloud.google.com/storage/docs/using-public-access-prevention[public access prevention].
24+
====
25+
2026
.Procedure
2127

2228
. Set up an link:https://cloud.google.com/storage/docs/lifecycle[Object Lifecycle Management policy] to abort incomplete multipart uploads that are one day old.
@@ -31,16 +37,14 @@ $ oc edit configs.imageregistry.operator.openshift.io/cluster
3137
.Example configuration
3238
[source,yaml]
3339
----
34-
# ...
35-
storage:
36-
gcs:
37-
bucket: <bucket-name>
38-
projectID: <project-id>
39-
region: <region-name>
40-
# ...
40+
apiVersion: imageregistry.operator.openshift.io/v1
41+
kind: Config
42+
metadata:
43+
name: cluster
44+
spec:
45+
storage:
46+
gcs:
47+
bucket: <bucket_name>
48+
projectID: <project_id>
49+
region: <region_name>
4150
----
42-
43-
[WARNING]
44-
====
45-
You can secure your registry images that use a {gcp-full} Storage bucket by setting link:https://cloud.google.com/storage/docs/using-public-access-prevention[public access prevention].
46-
====

‎modules/registry-configuring-storage-openstack-user-infra.adoc‎

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
[id="registry-configuring-storage-openstack-user-infra_{context}"]
77
= Registry storage for {rh-openstack} with user-provisioned infrastructure
88

9+
[role="_abstract"]
910
If the Registry Operator cannot create a Swift bucket, you must set up the storage medium manually and configure the settings in the registry custom resource (CR).
1011

1112
.Prerequisites
@@ -30,9 +31,12 @@ $ oc edit configs.imageregistry.operator.openshift.io/cluster
3031
.Example configuration
3132
[source,yaml]
3233
----
33-
# ...
34-
storage:
35-
swift:
36-
container: <container-id>
37-
# ...
34+
apiVersion: imageregistry.operator.openshift.io/v1
35+
kind: Config
36+
metadata:
37+
name: cluster
38+
spec:
39+
storage:
40+
swift:
41+
container: <container_id>
3842
----

‎modules/registry-operator-config-resources-secret-aws.adoc‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
[id="registry-operator-config-resources-secret-aws_{context}"]
77
= Configuring a secret for the Image Registry Operator
88

9+
10+
[role="_abstract"]
911
In addition to the `configs.imageregistry.operator.openshift.io` and ConfigMap
1012
resources, configuration is provided to the Operator by a separate secret
1113
resource located within the `openshift-image-registry` namespace.

0 commit comments

Comments
 (0)