Skip to content

Commit d5ea579

Browse files
fmcdonalEricPonvelle
authored andcommitted
classic to hcp migration topic maps update
commented in the end of section in topic map applied QE suggestions from gdoc applied more QE suggestions from gdoc applied conditions for new hcp distro to assemblies and modules fixed typo on line 13 of configuring registry operator replaced namespace as suggested by QE removed operator pod list removed space in rosa topic maps removed spacing in line 39 of checking status of pods
1 parent e071753 commit d5ea579

9 files changed

+58
-38
lines changed

_topic_maps/_topic_map_rosa.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -903,8 +903,6 @@ Topics:
903903
File: configuring-registry-operator
904904
- Name: Accessing the registry
905905
File: accessing-the-registry
906-
# - Name: Exposing the registry
907-
# File: securing-exposing-registry
908906
---
909907
Name: Operators
910908
Dir: operators

_topic_maps/_topic_map_rosa_hcp.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1145,6 +1145,17 @@ Topics:
11451145
- Name: Installing OADP on ROSA with STS
11461146
File: backing-up-applications
11471147
---
1148+
Name: Registry
1149+
Dir: registry
1150+
Distros: openshift-rosa-hcp
1151+
Topics:
1152+
- Name: Registry overview
1153+
File: index
1154+
- Name: Image Registry Operator in Red Hat OpenShift Service on AWS
1155+
File: configuring-registry-operator
1156+
- Name: Accessing the registry
1157+
File: accessing-the-registry
1158+
---
11481159
Name: Nodes
11491160
Dir: nodes
11501161
Distros: openshift-rosa-hcp

modules/registry-authentication-enabled-registry-overview.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,12 @@ to stand-alone projects outside {product-title}.
3636
You can use `podman login` with your credentials, either username and password
3737
or authentication token, to access content on the new registry.
3838

39-
All imagestreams point to the new registry, which uses the installation pull secret to authenticate.
39+
All image streams point to the new registry, which uses the installation pull secret to authenticate.
4040

4141
You must place your credentials in either of the following places:
4242

4343
* *`openshift` namespace*. Your credentials must exist in the `openshift`
44-
namespace so that the imagestreams in the `openshift` namespace can import.
44+
namespace so that the image streams in the `openshift` namespace can import.
4545
* *Your host*. Your credentials must exist on your host because Kubernetes
4646
uses the credentials from your host when it goes to pull images.
4747

modules/registry-checking-the-status-of-registry-pods.adoc

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,22 @@
66
[id="checking-the-status-of-registry-pods_{context}"]
77
= Checking the status of the registry pods
88

9-
ifndef::openshift-dedicated,openshift-rosa[]
9+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
1010
As a cluster administrator,
11-
endif::openshift-dedicated,openshift-rosa[]
12-
ifdef::openshift-dedicated,openshift-rosa[]
11+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
12+
ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
1313
As an administrator with the `dedicated-admin` role,
14-
endif::openshift-dedicated,openshift-rosa[]
14+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
1515
you can list the image registry pods running in the `openshift-image-registry` project and check their status.
1616

1717
.Prerequisites
1818

19-
ifndef::openshift-dedicated,openshift-rosa[]
19+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
2020
* You have access to the cluster as a user with the `cluster-admin` role.
21-
endif::openshift-dedicated,openshift-rosa[]
22-
ifdef::openshift-dedicated,openshift-rosa[]
21+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
22+
ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
2323
* You have access to the cluster as a user with the `dedicated-admin` role.
24-
endif::openshift-dedicated,openshift-rosa[]
24+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
2525

2626
.Procedure
2727

@@ -36,7 +36,6 @@ $ oc get pods -n openshift-image-registry
3636
[source,terminal]
3737
----
3838
NAME READY STATUS RESTARTS AGE
39-
cluster-image-registry-operator-764bd7f846-qqtpb 1/1 Running 0 78m
4039
image-registry-79fb4469f6-llrln 1/1 Running 0 77m
4140
node-ca-hjksc 1/1 Running 0 73m
4241
node-ca-tftj6 1/1 Running 0 77m

modules/registry-common-terms.adoc

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,17 @@
99
This glossary defines the common terms that are used in the registry content.
1010

1111
container::
12-
Lightweight and executable images that consist software and all its dependencies. Because containers virtualize the operating system, you can run containers in data center, a public or private cloud, or your local host.
12+
Lightweight and executable images that consist of software and all its dependencies. Because containers virtualize the operating system, you can run containers in a data center, a public or private cloud, or your local host.
1313

14+
ifdef::openshift-rosa,openshift-rosa-hcp[]
1415
Image Registry Operator::
16+
ifdef::openshift-rosa-hcp[]
17+
The Image Registry Operator runs in the `CONTROL_PLANE_NAMESPACE` of the management cluster, and manages the registry instance in openshift-image-registry of the cluster.
18+
endif::openshift-rosa-hcp[]
19+
ifdef::openshift-rosa[]
1520
The Image Registry Operator runs in the `openshift-image-registry` namespace, and manages the registry instance in that location.
21+
endif::openshift-rosa[]
22+
endif::openshift-rosa,openshift-rosa-hcp[]
1623

1724
image repository::
1825
An image repository is a collection of related container images and tags identifying images.
@@ -33,7 +40,7 @@ public registry::
3340
A registry is a server that implements the container image registry API. A public registry is a registry that serves its contently publicly.
3441

3542
Quay.io::
36-
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.
43+
A public Red Hat Quay Container Registry instance provided and maintained by Red Hat, which serves most of the container images and Operators to {product-title} clusters.
3744

3845
{product-registry}::
3946
{product-registry} is the registry provided by {product-title} to manage images.

modules/registry-integrated-openshift-registry.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,4 @@ Image data is stored in two locations. The actual image data is stored in a
2525
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
28-
and imagestreams.
28+
and image streams.

modules/registry-third-party-registries.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[id="registry-third-party-registries_{context}"]
77
= Third-party registries
88

9-
{product-title} can create containers using images from third-party registries, but it is unlikely that these registries offer the same image notification support as the integrated {product-registry}. In this situation, {product-title} will fetch tags from the remote registry upon imagestream creation. To refresh the fetched tags, run `oc import-image <stream>`. When new images are detected, the previously described build and deployment reactions occur.
9+
{product-title} can create containers using images from third-party registries, but it is unlikely that these registries offer the same image notification support as the integrated {product-registry}. In this situation, {product-title} will fetch tags from the remote registry upon image stream creation. To refresh the fetched tags, run `oc import-image <stream>`. When new images are detected, the previously described build and deployment reactions occur.
1010

1111
[id="authentication_{context}"]
1212
== Authentication

registry/accessing-the-registry.adoc

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
ifndef::openshift-dedicated,openshift-rosa[]
9+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
1010
Use the following sections for instructions on accessing the registry, including
1111
viewing logs and metrics, as well as securing and exposing the registry.
1212

@@ -15,13 +15,13 @@ you to push images to or pull them from the integrated registry directly using
1515
operations like `podman push` or `podman pull`. To do so, you must be logged in
1616
to the registry using the `podman login` command. The operations you can perform
1717
depend on your user permissions, as described in the following sections.
18-
endif::openshift-dedicated,openshift-rosa[]
18+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
1919

20-
ifdef::openshift-dedicated,openshift-rosa[]
20+
ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
2121
In {product-title}, Red Hat Site Reliability Engineering (SRE) manages the registry for you. However, you can check the status of the registry pods and view the registry logs.
22-
endif::openshift-dedicated,openshift-rosa[]
22+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
2323

24-
ifndef::openshift-dedicated,openshift-rosa[]
24+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
2525
== Prerequisites
2626

2727
* You have access to the cluster as a user with the `cluster-admin` role.
@@ -43,17 +43,17 @@ $ oc policy add-role-to-user registry-editor <user_name>
4343
----
4444
+
4545
** Your cluster must have an existing project where the images can be pushed to.
46-
endif::openshift-dedicated,openshift-rosa[]
46+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
4747
48-
ifndef::openshift-dedicated,openshift-rosa[]
48+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
4949
include::modules/registry-accessing-directly.adoc[leveloffset=+1]
50-
endif::openshift-dedicated,openshift-rosa[]
50+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
5151

5252
include::modules/registry-checking-the-status-of-registry-pods.adoc[leveloffset=+1]
5353

5454
include::modules/registry-viewing-logs.adoc[leveloffset=+1]
5555

56-
ifndef::openshift-dedicated,openshift-rosa[]
56+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
5757
include::modules/registry-accessing-metrics.adoc[leveloffset=+1]
5858

5959
[id="accessing-the-registry-additional-resources"]
@@ -66,4 +66,4 @@ xref:../authentication/remove-kubeadmin.adoc[Removing the kubeadmin user] for
6666
more information.
6767
* For more information on configuring an identity provider, see
6868
xref:../authentication/understanding-identity-provider.adoc[Understanding identity provider configuration].
69-
endif::openshift-dedicated,openshift-rosa[]
69+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]

registry/configuring-registry-operator.adoc

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,31 +7,36 @@ include::_attributes/common-attributes.adoc[]
77
toc::[]
88

99
[id="image-registry-on-cloud"]
10-
ifndef::openshift-dedicated,openshift-rosa[]
10+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
1111
== Image Registry on cloud platforms and OpenStack
12-
endif::openshift-dedicated,openshift-rosa[]
13-
ifdef::openshift-dedicated,openshift-rosa[]
12+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
13+
ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
1414
== Image Registry on {product-title}
15-
endif::openshift-dedicated,openshift-rosa[]
15+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
1616

1717
The Image Registry Operator installs a single instance of the {product-registry}, and manages all registry configuration, including setting up registry storage.
1818

19-
ifndef::openshift-dedicated,openshift-rosa[]
19+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
2020
[NOTE]
2121
====
2222
Storage is only automatically configured when you install an installer-provisioned infrastructure cluster on AWS, Azure, GCP, {ibm-name}, or OpenStack.
2323

2424
When you install or upgrade an installer-provisioned infrastructure cluster on AWS, Azure, GCP, {ibm-name}, or OpenStack, the Image Registry Operator sets the `spec.storage.managementState` parameter to `Managed`. If the `spec.storage.managementState` parameter is set to `Unmanaged`, the Image Registry Operator takes no action related to storage.
2525
====
26-
endif::openshift-dedicated,openshift-rosa[]
26+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
2727

28-
After the control plane deploys, the Operator creates a default `configs.imageregistry.operator.openshift.io` resource instance based on configuration detected in the cluster.
28+
After the control plane deploys in the management cluster, the Operator creates a default `configs.imageregistry.operator.openshift.io` resource instance based on configuration detected in the cluster.
2929

3030
If insufficient information is available to define a complete `configs.imageregistry.operator.openshift.io` resource, the incomplete resource is defined and the Operator updates the resource status with information about what is missing.
3131

32+
ifdef::openshift-rosa-hcp[]
33+
The Image Registry Operator runs in the `CONTROL_PLANE_NAMESPACE` of the management cluster, and manages the registry instance in openshift-image-registry namespace of the cluster. All configuration and workload resources for the registry reside in that namespace.
34+
endif::openshift-rosa-hcp[]
35+
ifdef::openshift-rosa[]
3236
The Image Registry Operator runs in the `openshift-image-registry` namespace, and manages the registry instance in that location as well. All configuration and workload resources for the registry reside in that namespace.
37+
endif::openshift-rosa[]
3338

34-
ifndef::openshift-dedicated,openshift-rosa[]
39+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
3540
[IMPORTANT]
3641
====
3742
The Image Registry Operator's behavior for managing the pruner is orthogonal to the `managementState` specified on the `ClusterOperator` object for the Image Registry Operator. If the Image Registry Operator is not in the `Managed` state, the image pruner can still be configured and managed by the `Pruning` custom resource.
@@ -41,9 +46,9 @@ However, the `managementState` of the Image Registry Operator alters the behavio
4146
* `Managed`: the `--prune-registry` flag for the image pruner is set to `true`.
4247
* `Removed`: the `--prune-registry` flag for the image pruner is set to `false`, meaning it only prunes image metadata in etcd.
4348
====
44-
endif::openshift-dedicated,openshift-rosa[]
49+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
4550
46-
ifndef::openshift-dedicated,openshift-rosa[]
51+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
4752
[id="image-registry-on-bare-metal-vsphere"]
4853
== Image Registry on bare metal, Nutanix, and vSphere
4954

@@ -77,4 +82,4 @@ include::modules/registry-operator-config-resources-storage-credentials.adoc[lev
7782
* xref:../registry/configuring_registry_storage/configuring-registry-storage-osp.adoc#configuring-registry-storage-openstack[Configuring the registry for {rh-openstack}]
7883
* xref:../registry/configuring_registry_storage/configuring-registry-storage-rhodf.adoc#configuring-registry-storage-rhodf[Configuring the registry for Red Hat OpenShift Data Foundation]
7984
* xref:../registry/configuring_registry_storage/configuring-registry-storage-nutanix.adoc#configuring-registry-storage-nutanix[Configuring the registry for Nutanix]
80-
endif::openshift-dedicated,openshift-rosa[]
85+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]

0 commit comments

Comments
 (0)