From fe404cb938ec9ca11f609fc6581de5a73deb0d5c Mon Sep 17 00:00:00 2001 From: Servesha Dudhgaonkar Date: Thu, 25 Nov 2021 13:58:54 +0530 Subject: [PATCH] Registry Overview --- _topic_maps/_topic_map.yml | 6 ++-- architecture/architecture.adoc | 2 +- ...hentication-enabled-registry-overview.adoc | 2 +- modules/registry-authentication.adoc | 2 +- ...egistry-integrated-openshift-registry.adoc | 2 +- modules/registry-quay-overview.adoc | 4 +-- modules/registry-third-party-registries.adoc | 2 +- .../architecture-component-imageregistry.adoc | 17 ----------- registry/index.adoc | 28 +++++++++++++++++++ registry/registry-options.adoc | 21 -------------- .../security-registries.adoc | 2 +- welcome/index.adoc | 2 +- 12 files changed, 39 insertions(+), 51 deletions(-) delete mode 100644 registry/architecture-component-imageregistry.adoc create mode 100644 registry/index.adoc delete mode 100644 registry/registry-options.adoc diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml index c351d0fd0b..c4e70f5da9 100644 --- a/_topic_maps/_topic_map.yml +++ b/_topic_maps/_topic_map.yml @@ -1187,8 +1187,8 @@ Name: Registry Dir: registry Distros: openshift-enterprise,openshift-origin Topics: -- Name: Overview - File: architecture-component-imageregistry +- Name: Registry overview + File: index - Name: Image Registry Operator in OpenShift Container Platform File: configuring-registry-operator Distros: openshift-enterprise @@ -1213,8 +1213,6 @@ Topics: File: configuring-registry-storage-baremetal - Name: Configuring the registry for vSphere File: configuring-registry-storage-vsphere -- Name: Registry options - File: registry-options Distros: openshift-enterprise,openshift-origin - Name: Accessing the registry File: accessing-the-registry diff --git a/architecture/architecture.adoc b/architecture/architecture.adoc index 92ac6d933a..cbde2d6eca 100644 --- a/architecture/architecture.adoc +++ b/architecture/architecture.adoc @@ -22,7 +22,7 @@ variety of techniques including industry standard Dockerfiles and publishing them to either the cluster image registry, or an external registry. It also provides integration with Jenkins based pipeline continuous integration workflows. -* xref:../registry/architecture-component-imageregistry.adoc[Image Registry] - +* xref:../registry/index.adoc[Image Registry] - The image registry provides a scalable repository for storing and retrieving container images that are produced by and run on the cluster. Image access is integrated with the cluster's role-based access controls and user authentication diff --git a/modules/registry-authentication-enabled-registry-overview.adoc b/modules/registry-authentication-enabled-registry-overview.adoc index 4f965da99f..22e2b06f48 100644 --- a/modules/registry-authentication-enabled-registry-overview.adoc +++ b/modules/registry-authentication-enabled-registry-overview.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * registry/registry-options.adoc +// * registry/index.adoc [id="registry-authentication-enabled-registry-overview_{context}"] = Authentication enabled Red Hat registry diff --git a/modules/registry-authentication.adoc b/modules/registry-authentication.adoc index 552be9744b..f906c12ca3 100644 --- a/modules/registry-authentication.adoc +++ b/modules/registry-authentication.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * registry/registry-options.adoc +// * registry/index.adoc [id="authentication_{context}"] = Authentication diff --git a/modules/registry-integrated-openshift-registry.adoc b/modules/registry-integrated-openshift-registry.adoc index 2115ceded5..25d0d6658c 100644 --- a/modules/registry-integrated-openshift-registry.adoc +++ b/modules/registry-integrated-openshift-registry.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // //* registry/registry-options -//* registry/architecture-component-imageregistry +//* registry/index.adoc [id="registry-integrated-openshift-registry_{context}"] = Integrated {product-title} registry diff --git a/modules/registry-quay-overview.adoc b/modules/registry-quay-overview.adoc index 133346d04e..372afef11a 100644 --- a/modules/registry-quay-overview.adoc +++ b/modules/registry-quay-overview.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * registry/registry-options.adoc +// * registry/index.adoc [id="registry-quay-overview_{context}"] = Red Hat Quay registries @@ -10,7 +10,7 @@ available both as a hosted service and as software you can install in your own data center or cloud environment. Advanced registry features in Red Hat Quay include geo-replication, image scanning, and the ability to roll back images. -Visit the Quay.io site to set up your own hosted Quay registry account. After +Visit the link:https://quay.io[Quay.io] site to set up your own hosted Quay registry account. After that, follow the Quay Tutorial to log in to the Quay registry and start managing your images. diff --git a/modules/registry-third-party-registries.adoc b/modules/registry-third-party-registries.adoc index aadeb3838b..4e1f27a4aa 100644 --- a/modules/registry-third-party-registries.adoc +++ b/modules/registry-third-party-registries.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * registry/registry-options.adoc +// * registry/index.adoc [id="registry-third-party-registries_{context}"] = Third-party registries diff --git a/registry/architecture-component-imageregistry.adoc b/registry/architecture-component-imageregistry.adoc deleted file mode 100644 index 44aa90543a..0000000000 --- a/registry/architecture-component-imageregistry.adoc +++ /dev/null @@ -1,17 +0,0 @@ -[id="architecture-component-imageregistry"] -= Image Registry -include::modules/common-attributes.adoc[] -:context: architecture-component-imageregistry - -toc::[] - -include::modules/registry-integrated-openshift-registry.adoc[leveloffset=+1] - -ifdef::openshift-enterprise,openshift-webscale,openshift-origin[] -.Additional resources - -* xref:../registry/configuring-registry-operator.adoc#configuring-registry-operator[Image Registry Operator in {product-title}] -endif::[] - -//* Link: Triggering updates on imagestream changes -//* LINK TO API DOCS diff --git a/registry/index.adoc b/registry/index.adoc new file mode 100644 index 0000000000..1931662648 --- /dev/null +++ b/registry/index.adoc @@ -0,0 +1,28 @@ +[id="registry-overview"] += {product-title} registry overview +include::modules/common-attributes.adoc[] +:context: registry-overview + +toc::[] + +{product-title} can build images from your source code, deploy them, and manage their lifecycle. It provides an internal, integrated container image registry that can be deployed in your {product-title} environment to locally manage images. This overview contains reference information and links for registries commonly used with {product-title}, with a focus on the internal image registry. + +include::modules/registry-integrated-openshift-registry.adoc[leveloffset=+1] + +.Additional resources + +* xref:../registry/configuring-registry-operator.adoc#configuring-registry-operator[Image Registry Operator in {product-title}] + +include::modules/registry-third-party-registries.adoc[leveloffset=+1] + +include::modules/registry-quay-overview.adoc[leveloffset=+1] + +.Additional resources + +* link:https://access.redhat.com/documentation/en-us/red_hat_quay/[Red Hat Quay product documentation] + +include::modules/registry-authentication-enabled-registry-overview.adoc[leveloffset=+1] + +.Additional resources + +* link:https://access.redhat.com/terms-based-registry/[Registry service accounts] diff --git a/registry/registry-options.adoc b/registry/registry-options.adoc deleted file mode 100644 index 4e99a8cead..0000000000 --- a/registry/registry-options.adoc +++ /dev/null @@ -1,21 +0,0 @@ -[id="registry-options"] -= Registry options -include::modules/common-attributes.adoc[] -:context: registry-options - -toc::[] - -{product-title} can build images from your source code, deploy them, and manage -their lifecycle. To enable this, {product-title} provides an internal, -integrated container image registry that can be deployed in your {product-title} -environment to locally manage images. - -include::modules/registry-integrated-openshift-registry.adoc[leveloffset=+1] - -include::modules/registry-third-party-registries.adoc[leveloffset=+1] - -include::modules/registry-authentication.adoc[leveloffset=+2] - -include::modules/registry-quay-overview.adoc[leveloffset=+1] - -include::modules/registry-authentication-enabled-registry-overview.adoc[leveloffset=+1] diff --git a/security/container_security/security-registries.adoc b/security/container_security/security-registries.adoc index a175a7446f..7ccff74f89 100644 --- a/security/container_security/security-registries.adoc +++ b/security/container_security/security-registries.adoc @@ -41,7 +41,7 @@ include::modules/security-registries-ecosystem.adoc[leveloffset=+1] // OpenShift Container Registry include::modules/security-registries-openshift.adoc[leveloffset=+1] .Additional resources -* xref:../../registry/architecture-component-imageregistry.adoc#architecture-component-imageregistry[Integrated {product-title} registry] +* xref:../../registry/index.adoc#registry-overview[Integrated {product-title} registry] // Quay Container Registry include::modules/security-registries-quay.adoc[leveloffset=+1] diff --git a/welcome/index.adoc b/welcome/index.adoc index 5db84118c2..b9f72e11bb 100644 --- a/welcome/index.adoc +++ b/welcome/index.adoc @@ -218,7 +218,7 @@ or xref:../machine_management/creating_machinesets/creating-machineset-gcp.adoc#creating-machineset-gcp[GCP] by xref:../machine_management/deploying-machine-health-checks.adoc#deploying-machine-health-checks[deploying health checks] and xref:../machine_management/applying-autoscaling.adoc#applying-autoscaling[applying autoscaling to machines]. -- **xref:../registry/registry-options.adoc#registry-options[Manage container registries]**: Each {product-title} cluster includes a built-in container registry for storing its images. You can also configure a separate link:https://access.redhat.com/documentation/en-us/red_hat_quay/[Red Hat Quay] registry to use with {product-title}. The link:https://quay.io[Quay.io] web site provides a public container registry that stores {product-title} containers and Operators. +- **xref:../registry/index.adoc#registry-overview[Manage container registries]**: Each {product-title} cluster includes a built-in container registry for storing its images. You can also configure a separate link:https://access.redhat.com/documentation/en-us/red_hat_quay/[Red Hat Quay] registry to use with {product-title}. The link:https://quay.io[Quay.io] web site provides a public container registry that stores {product-title} containers and Operators. - **xref:../authentication/understanding-authentication.adoc#understanding-authentication[Manage users and groups]**: Add users and groups with different levels of permissions to use or modify clusters.