Skip to content

Commit 5aa67a0

Browse files
authored
Merge pull request #54761 from bhardesty/OSDOCS-3993-port-registry-book-osd-rosa
2 parents a37602c + 6b176c5 commit 5aa67a0

12 files changed

+65
-25
lines changed

_topic_maps/_topic_map_osd.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -213,6 +213,19 @@ Topics:
213213
- Name: Dynamic provisioning
214214
File: dynamic-provisioning
215215
---
216+
Name: Registry
217+
Dir: registry
218+
Distros: openshift-dedicated
219+
Topics:
220+
- Name: Registry overview
221+
File: index
222+
- Name: Image Registry Operator in OpenShift Dedicated
223+
File: configuring-registry-operator
224+
- Name: Accessing the registry
225+
File: accessing-the-registry
226+
- Name: Exposing the registry
227+
File: securing-exposing-registry
228+
---
216229
Name: Networking
217230
Dir: networking
218231
Distros: openshift-dedicated

_topic_maps/_topic_map_rosa.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -302,6 +302,19 @@ Topics:
302302
- Name: Dynamic provisioning
303303
File: dynamic-provisioning
304304
---
305+
Name: Registry
306+
Dir: registry
307+
Distros: openshift-rosa
308+
Topics:
309+
- Name: Registry overview
310+
File: index
311+
- Name: Image Registry Operator in Red Hat OpenShift Service on AWS
312+
File: configuring-registry-operator
313+
- Name: Accessing the registry
314+
File: accessing-the-registry
315+
- Name: Exposing the registry
316+
File: securing-exposing-registry
317+
---
305318
Name: Networking
306319
Dir: networking
307320
Distros: openshift-rosa

modules/registry-accessing-directly.adoc

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,14 @@
44

55
:_content-type: PROCEDURE
66
[id="registry-accessing-directly_{context}"]
7-
= Accessing registry directly from the cluster
7+
= Accessing the registry directly from the cluster
88

99
You can access the registry from inside the cluster.
1010

1111
.Procedure
1212

1313
Access the registry from the cluster by using internal routes:
1414

15-
ifdef::openshift-enterprise,openshift-webscale,openshift-origin[]
1615
. Access the node by getting the node's name:
1716
+
1817
[source,terminal]
@@ -32,11 +31,8 @@ $ oc debug nodes/<node_name>
3231
sh-4.2# chroot /host
3332
----
3433
+
35-
endif::[]
36-
3734
. Log in to the container image registry by using your access token:
3835
+
39-
ifdef::openshift-enterprise,openshift-webscale,openshift-origin[]
4036
[source,terminal]
4137
----
4238
sh-4.2# oc login -u kubeadmin -p <password_from_install_log> https://api-int.<cluster_name>.<base_domain>:6443
@@ -46,8 +42,6 @@ sh-4.2# oc login -u kubeadmin -p <password_from_install_log> https://api-int.<cl
4642
----
4743
sh-4.2# podman login -u kubeadmin -p $(oc whoami -t) image-registry.openshift-image-registry.svc:5000
4844
----
49-
endif::[]
50-
5145
+
5246
You should see a message confirming login, such as:
5347
+
@@ -79,13 +73,11 @@ In the following examples, use:
7973
|====
8074
|Component |Value
8175

82-
ifdef::openshift-enterprise,openshift-webscale,openshift-origin[]
8376
|*<registry_ip>*
8477
|`172.30.124.220`
8578

8679
|*<port>*
8780
|`5000`
88-
endif::[]
8981

9082
|*<project>*
9183
|`openshift`
@@ -104,7 +96,6 @@ endif::[]
10496
sh-4.2# podman pull <name.io>/<image>
10597
----
10698

107-
ifdef::openshift-enterprise,openshift-webscale,openshift-origin[]
10899
.. Tag the new image with the form `<registry_ip>:<port>/<project>/<image>`.
109100
The project name must appear in this pull specification for {product-title} to
110101
correctly place and later access the image in the registry:
@@ -113,7 +104,6 @@ correctly place and later access the image in the registry:
113104
----
114105
sh-4.2# podman tag <name.io>/<image> image-registry.openshift-image-registry.svc:5000/openshift/<image>
115106
----
116-
endif::[]
117107
+
118108
[NOTE]
119109
====
@@ -125,9 +115,7 @@ to push the image.
125115

126116
.. Push the newly tagged image to your registry:
127117
+
128-
ifdef::openshift-enterprise,openshift-webscale,openshift-origin[]
129118
[source,terminal]
130119
----
131120
sh-4.2# podman push image-registry.openshift-image-registry.svc:5000/openshift/<image>
132121
----
133-
endif::[]

modules/registry-common-terms.adoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,10 @@ The mirror registry is a registry that holds the mirror of {product-title} image
2323
namespace::
2424
A namespace isolates groups of resources within a single cluster.
2525

26+
ifndef::openshift-rosa[]
2627
{product-title} registry::
2728
{product-title} registry is the registry provided by {product-title} to manage images.
29+
endif::openshift-rosa[]
2830

2931
pod::
3032
The pod is the smallest logical unit in Kubernetes. A pod is comprised of one or more containers to run in a worker node.
@@ -38,6 +40,11 @@ A registry is a server that implements the container image registry API. A publi
3840
Quay.io::
3941
A public Red Hat Quay Container Registry instance provided and maintained by Red Hat, that serves most of the container images and Operators to {product-title} clusters.
4042

43+
ifdef::openshift-rosa[]
44+
{product-title} registry::
45+
{product-title} registry is the registry provided by {product-title} to manage images.
46+
endif::openshift-rosa[]
47+
4148
registry authentication::
4249
To push and pull images to and from private image repositories, the registry needs to authenticate its users with credentials.
4350

modules/registry-exposing-default-registry-manually.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Instead of logging in to the default {product-title} registry from within the cl
99
* The following prerequisites are automatically performed:
1010
** Deploy the Registry Operator.
1111
** Deploy the Ingress Operator.
12+
* You have access to the cluster as a user with the `cluster-admin` role.
1213
1314
.Procedure
1415

modules/registry-exposing-secure-registry-manually.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ to tag and push images to an existing project by using the route host.
1616
* The following prerequisites are automatically performed:
1717
** Deploy the Registry Operator.
1818
** Deploy the Ingress Operator.
19+
* You have access to the cluster as a user with the `cluster-admin` role.
1920
2021
.Procedure
2122

modules/registry-integrated-openshift-registry.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
[id="registry-integrated-openshift-registry_{context}"]
77
= Integrated {product-title} registry
8-
ifdef::openshift-enterprise,openshift-webscale,openshift-origin[]
8+
99
{product-title} provides a built-in container image registry that runs as a
1010
standard workload on the cluster. The registry is configured and managed by an
1111
infrastructure Operator. It provides an out-of-the-box solution for users to
@@ -26,4 +26,3 @@ configurable storage location, such as cloud storage or a filesystem volume. The
2626
image metadata, which is exposed by the standard cluster APIs and is used to
2727
perform access control, is stored as standard API resources, specifically images
2828
and imagestreams.
29-
endif::[]

modules/registry-operator-configuration-resource-overview.adoc

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -69,12 +69,17 @@ for the route.
6969

7070
|`spec.storage.managementState`
7171

72-
|The Image Registry Operator sets the `spec.storage.managementState` parameter to `Managed` on new installations or upgrades of clusters using installer-provisioned infrastructure on AWS or Azure.
72+
a|
73+
ifndef::openshift-dedicated,openshift-rosa[]
74+
The Image Registry Operator sets the `spec.storage.managementState` parameter to `Managed` on new installations or upgrades of clusters using installer-provisioned infrastructure on AWS or Azure.
75+
endif::openshift-dedicated,openshift-rosa[]
76+
77+
ifdef::openshift-dedicated,openshift-rosa[]
78+
The Image Registry Operator sets the `spec.storage.managementState` parameter to `Managed` on new installations or upgrades of clusters on AWS.
79+
endif::openshift-dedicated,openshift-rosa[]
7380

7481
* `Managed`: Determines that the Image Registry Operator manages underlying storage. If the Image Registry Operator's `managementState` is set to `Removed`, then the storage is deleted.
7582
** If the `managementState` is set to `Managed`, the Image Registry Operator attempts to apply some default configuration on the underlying storage unit. For example, if set to `Managed`, the Operator tries to enable encryption on the S3 bucket before making it available to the registry. If you do not want the default settings to be applied on the storage you are providing, make sure the `managementState` is set to `Unmanaged`.
7683
* `Unmanaged`: Determines that the Image Registry Operator ignores the storage settings. If the Image Registry Operator's `managementState` is set to `Removed`, then the storage is not deleted. If you provided an underlying storage unit configuration, such as a bucket or container name, and the `spec.storage.managementState` is not yet set to any value, then the Image Registry Operator configures it to `Unmanaged`.
7784

78-
79-
8085
|===

modules/registry-operator-distribution-across-availability-zones.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ The Image Registry Operator defaults to the following when deployed with a zone-
3434
whenUnsatisfiable: DoNotSchedule
3535
----
3636

37+
ifndef::openshift-dedicated,openshift-rosa[]
3738
The Image Registry Operator defaults to the following when deployed without a zone-related topology constraint, which applies to bare metal and vSphere instances:
3839

3940
.Image Registry Operator deployed without a zone related topology constraint
@@ -53,5 +54,6 @@ The Image Registry Operator defaults to the following when deployed without a zo
5354
topologyKey: node-role.kubernetes.io/worker
5455
whenUnsatisfiable: DoNotSchedule
5556
----
57+
endif::openshift-dedicated,openshift-rosa[]
5658

5759
A cluster administrator can override the default `topologySpreadConstraints` by configuring the `configs.imageregistry.operator.openshift.io/cluster` spec file. In that case, only the constraints you provide apply.

modules/registry-third-party-registries.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Some container image registries require access authorization. Podman is an open
2222

2323
. Click *Get this image* to find the command for your container image.
2424

25-
. Login by running the following command and entering your username and password to authenticate:
25+
. Log in by running the following command and entering your username and password to authenticate:
2626
+
2727
[source,terminal]
2828
----

0 commit comments

Comments
 (0)