From d32e6b2b0e91eec7f4c19255e6fbb02edbd693cf Mon Sep 17 00:00:00 2001 From: AedinC Date: Wed, 3 Sep 2025 10:31:45 +0100 Subject: [PATCH] OSDOCS-14493:Pruning Images book. --- _topic_maps/_topic_map_rosa.yml | 5 +- _topic_maps/_topic_map_rosa_hcp.yml | 2 +- .../openshift_cli/getting-started-cli.adoc | 1 + modules/cli-about-cli.adoc | 21 ++---- modules/cli-installing-cli.adoc | 69 ++++++++----------- ...iguration-image-registry-settings-hcp.adoc | 4 +- .../images-configuration-parameters-hcp.adoc | 4 +- ...s-editing-image-registry-settings-hcp.adoc | 2 +- ...mages-updating-platform-allowlist-hcp.adoc | 4 +- modules/installation-mirror-repository.adoc | 3 +- ...l-mirroring-for-disconnected-registry.adoc | 3 +- openshift_images/image-configuration-hcp.adoc | 10 +-- openshift_images/image-configuration.adoc | 4 +- openshift_images/index.adoc | 15 +++- .../samples-operator-alt-registry.adoc | 2 + 15 files changed, 63 insertions(+), 86 deletions(-) diff --git a/_topic_maps/_topic_map_rosa.yml b/_topic_maps/_topic_map_rosa.yml index 18143031e8..a928afad55 100644 --- a/_topic_maps/_topic_map_rosa.yml +++ b/_topic_maps/_topic_map_rosa.yml @@ -792,12 +792,9 @@ Topics: - Name: Triggering updates on image stream changes File: triggering-updates-on-imagestream-changes Distros: openshift-rosa -- Name: Image configuration resources (Classic) +- Name: Image configuration resources File: image-configuration Distros: openshift-rosa -- Name: Image configuration resources (HCP) - File: image-configuration-hcp - Distros: openshift-rosa - Name: Using images Dir: using_images Distros: openshift-rosa diff --git a/_topic_maps/_topic_map_rosa_hcp.yml b/_topic_maps/_topic_map_rosa_hcp.yml index 4cd25daeff..20578db167 100644 --- a/_topic_maps/_topic_map_rosa_hcp.yml +++ b/_topic_maps/_topic_map_rosa_hcp.yml @@ -663,7 +663,7 @@ Topics: - Name: Triggering updates on image stream changes File: triggering-updates-on-imagestream-changes Distros: openshift-rosa-hcp -- Name: Image configuration resources (HCP) +- Name: Image configuration resources File: image-configuration-hcp Distros: openshift-rosa-hcp - Name: Using images diff --git a/cli_reference/openshift_cli/getting-started-cli.adoc b/cli_reference/openshift_cli/getting-started-cli.adoc index 1faa3b9da9..df45ceb9b5 100644 --- a/cli_reference/openshift_cli/getting-started-cli.adoc +++ b/cli_reference/openshift_cli/getting-started-cli.adoc @@ -2,6 +2,7 @@ [id="cli-getting-started"] = Getting started with the OpenShift CLI include::_attributes/common-attributes.adoc[] +include::_attributes/attributes-openshift-dedicated.adoc[] :context: cli-developer-commands toc::[] diff --git a/modules/cli-about-cli.adoc b/modules/cli-about-cli.adoc index a640d0d6d4..c291fedaab 100644 --- a/modules/cli-about-cli.adoc +++ b/modules/cli-about-cli.adoc @@ -6,24 +6,13 @@ [id="cli-about-cli_{context}"] = About the OpenShift CLI -With the {oc-first}, you can create applications and manage {product-title} -ifdef::openshift-rosa[] -(ROSA) -endif::openshift-rosa[] -projects from a terminal. The OpenShift CLI is ideal in the following situations: +With the {oc-first}, you can create applications and manage {product-title} projects from a terminal. The OpenShift CLI is ideal in the following situations: -* Working directly with project source code -* Scripting -ifndef::openshift-rosa[] -{product-title} -endif::openshift-rosa[] -ifdef::openshift-rosa[] -ROSA -endif::openshift-rosa[] -operations +* Working directly with project source code. +* Scripting {product-title} operations ifndef::microshift[] -* Managing projects while restricted by bandwidth resources and the web console is unavailable +* Managing projects while restricted by bandwidth resources and the web console is unavailable. endif::microshift[] ifdef::microshift[] -* Managing projects while restricted by bandwidth resources +* Managing projects while restricted by bandwidth resources. endif::microshift[] diff --git a/modules/cli-installing-cli.adoc b/modules/cli-installing-cli.adoc index 37900f2bb3..1fdf74adf4 100644 --- a/modules/cli-installing-cli.adoc +++ b/modules/cli-installing-cli.adoc @@ -56,27 +56,12 @@ endif::[] [id="cli-installing-cli_{context}"] = Installing the OpenShift CLI -You can install the {oc-first} to interact with -ifndef::openshift-rosa[] -{product-title} -endif::openshift-rosa[] -ifdef::openshift-dedicated[] -clusters -endif::openshift-dedicated[] -ifdef::openshift-rosa[] -ROSA -endif::openshift-rosa[] -from a command-line interface. You can install `oc` on Linux, Windows, or macOS. +You can install the {oc-first} to interact with {product-title} from a command-line interface. You can install `oc` on Linux, Windows, or macOS. [IMPORTANT] ==== -If you installed an earlier version of `oc`, you cannot use it to complete all of the commands in -ifndef::openshift-rosa[] -{product-title} {product-version}. -endif::openshift-rosa[] -ifdef::openshift-rosa[] -ROSA. -endif::openshift-rosa[] +If you installed an earlier version of `oc`, you cannot use it to complete all of the commands in {product-title}. + Download and install the new version of `oc`. ifdef::restricted[] If you are updating a cluster in a disconnected environment, install the `oc` version that you plan to update to. @@ -101,18 +86,18 @@ ifdef::openshift-origin[] . Navigate to link:https://mirror.openshift.com/pub/openshift-v4/clients/oc/latest/[https://mirror.openshift.com/pub/openshift-v4/clients/oc/latest/] and choose the folder for your operating system and architecture. . Download `oc.tar.gz`. endif::[] -ifndef::openshift-origin,microshift[] -. Navigate to the link:https://access.redhat.com/downloads/content/290[{product-title} downloads page] on the Red Hat Customer Portal. -. Select the architecture from the *Product Variant* drop-down list. -. Select the appropriate version from the *Version* drop-down list. +ifndef::openshift-origin,microshift,openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] +. Navigate to the link:https://access.redhat.com/downloads/content/290[Download {product-title}] page on the Red{nbsp}Hat Customer Portal. +. Select the architecture from the *Product Variant* list. +. Select the appropriate version from the *Version* list. . Click *Download Now* next to the *OpenShift v{product-version} Linux Clients* entry and save the file. -endif::[] -ifdef::microshift[] -. Navigate to the link:https://access.redhat.com/downloads/content/290[{ocp} downloads page] on the Red Hat Customer Portal. -. Select the architecture from the *Product Variant* drop-down list. -. Select the appropriate version from the *Version* drop-down list. +endif::openshift-origin,microshift,openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] +ifdef::microshift,openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] +. Navigate to the link:https://access.redhat.com/downloads/content/290[Download {OCP}] page on the Red{nbsp}Hat Customer Portal. +. Select the architecture from the *Product Variant* list. +. Select the appropriate version from the *Version* list. . Click *Download Now* next to the *OpenShift v{product-version} Linux Clients* entry and save the file. -endif::[] +endif::microshift,openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] . Unpack the archive: + [source,terminal] @@ -154,16 +139,16 @@ ifdef::openshift-origin[] . Navigate to link:https://mirror.openshift.com/pub/openshift-v4/clients/oc/latest/[https://mirror.openshift.com/pub/openshift-v4/clients/oc/latest/] and choose the folder for your operating system and architecture. . Download `oc.zip`. endif::[] -ifndef::openshift-origin,microshift[] -. Navigate to the link:https://access.redhat.com/downloads/content/290[{product-title} downloads page] on the Red Hat Customer Portal. -. Select the appropriate version from the *Version* drop-down list. +ifndef::openshift-origin,microshift,openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] +. Navigate to the link:https://access.redhat.com/downloads/content/290[Download {product-title}] page on the Red{nbsp}Hat Customer Portal. +. Select the appropriate version from the *Version* list. . Click *Download Now* next to the *OpenShift v{product-version} Windows Client* entry and save the file. -endif::[] -ifdef::microshift[] -. Navigate to the link:https://access.redhat.com/downloads/content/290[{ocp} downloads page] on the Red Hat Customer Portal. -. Select the appropriate version from the *Version* drop-down list. +endif::openshift-origin,microshift,openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] +ifdef::microshift,openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] +. Navigate to the link:https://access.redhat.com/downloads/content/290[Download {OCP}] page on the Red Hat Customer Portal. +. Select the appropriate version from the *Version* list. . Click *Download Now* next to the *OpenShift v{product-version} Windows Client* entry and save the file. -endif::[] +endif::microshift,openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] . Unzip the archive with a ZIP program. . Move the `oc` binary to a directory that is on your `PATH`. + @@ -200,8 +185,8 @@ ifdef::openshift-origin[] . Navigate to link:https://mirror.openshift.com/pub/openshift-v4/clients/oc/latest/[https://mirror.openshift.com/pub/openshift-v4/clients/oc/latest/] and choose the folder for your operating system and architecture. . Download `oc.tar.gz`. endif::[] -ifndef::openshift-origin,microshift[] -. Navigate to the link:https://access.redhat.com/downloads/content/290[{product-title} downloads page] on the Red Hat Customer Portal. +ifndef::openshift-origin,microshift,openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] +. Navigate to the link:https://access.redhat.com/downloads/content/290[Download {product-title}] page on the Red{nbsp}Hat Customer Portal. . Select the appropriate version from the *Version* drop-down list. . Click *Download Now* next to the *OpenShift v{product-version} macOS Clients* entry and save the file. + @@ -209,12 +194,12 @@ ifndef::openshift-origin,microshift[] ==== For macOS arm64, choose the *OpenShift v{product-version} macOS arm64 Client* entry. ==== -endif::[] -ifdef::microshift[] -. Navigate to the link:https://access.redhat.com/downloads/content/290[{ocp} downloads page] on the Red Hat Customer Portal. +endif::openshift-origin,microshift,openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] +ifdef::microshift,openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] +. Navigate to the link:https://access.redhat.com/downloads/content/290[Download {OCP}] on the Red{nbsp}Hat Customer Portal. . Select the appropriate version from the *Version* drop-down list. . Click *Download Now* next to the *OpenShift v{product-version} macOS Clients* entry and save the file. -endif::[] +endif::microshift,openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] . Unpack and unzip the archive. . Move the `oc` binary to a directory on your PATH. + diff --git a/modules/images-configuration-image-registry-settings-hcp.adoc b/modules/images-configuration-image-registry-settings-hcp.adoc index 14282d2aa1..974ab3b57a 100644 --- a/modules/images-configuration-image-registry-settings-hcp.adoc +++ b/modules/images-configuration-image-registry-settings-hcp.adoc @@ -4,13 +4,13 @@ :_mod-docs-content-type: PROCEDURE [id="images-configuring-image-registry-settings-hcp_{context}"] -= Configuring image registry settings for {hcp-title} += Configuring image registry settings for {product-title} You can configure image registry settings at cluster creation. The cluster's nodes will use the required configuration after creation. .Procedure -* Create {hcp-title} clusters with image registry by running the following command: +* Create {product-title} clusters with image registry by running the following command: + [source,terminal] diff --git a/modules/images-configuration-parameters-hcp.adoc b/modules/images-configuration-parameters-hcp.adoc index 8b8fd111ac..14c74925eb 100644 --- a/modules/images-configuration-parameters-hcp.adoc +++ b/modules/images-configuration-parameters-hcp.adoc @@ -3,9 +3,9 @@ // * openshift_images/image-configuration-hcp.adoc [id="images-configuration-parameters-hcp_{context}"] -= Image controller configuration parameters for {hcp-title} += Image controller configuration parameters for {product-title} -The `image.config.openshift.io/cluster` resource holds cluster-wide information about how to handle images. The resource exists, but it is read only and can only be changed through supported tools like ROSA CLI (`rosa`). The canonical and only valid name is `cluster`. It can be configured in {product-rosa} {hcp} through ROSA CLI (`rosa`) commands. +The `image.config.openshift.io/cluster` resource holds cluster-wide information about how to handle images. The resource exists, but it is read only and can only be changed through supported tools like the ROSA CLI (`rosa`). The canonical and only valid name is `cluster`. It can be configured in {product-title} through `rosa` commands. [NOTE] diff --git a/modules/images-editing-image-registry-settings-hcp.adoc b/modules/images-editing-image-registry-settings-hcp.adoc index 9a37c40e74..c7541acc79 100644 --- a/modules/images-editing-image-registry-settings-hcp.adoc +++ b/modules/images-editing-image-registry-settings-hcp.adoc @@ -5,7 +5,7 @@ :_mod-docs-content-type: PROCEDURE [id="images-editing-image-registry-settings-hcp_{context}"] -= Editing image registry settings for {hcp-title} += Editing image registry settings for {product-title} You can change the image registry config with the `rosa edit` command. diff --git a/modules/images-updating-platform-allowlist-hcp.adoc b/modules/images-updating-platform-allowlist-hcp.adoc index 5c046e81fe..88c9c7668f 100644 --- a/modules/images-updating-platform-allowlist-hcp.adoc +++ b/modules/images-updating-platform-allowlist-hcp.adoc @@ -5,9 +5,9 @@ :_mod-docs-content-type: PROCEDURE [id="images-updating-platform-allowlist-hcp_{context}"] -= Updating platform allowlist for {hcp-title} += Updating platform allowlist for {product-title} -A list of Red Hat registries is automatically allowed and it is visible when running rosa describe cluster. This list can be periodically updated to ensure platform can be operated correctly. Impacted clusters will receive a notification with the new allowlist ID. In such cases, the user must use this parameter to update from the previous expected ID to the newly expected ID. Update or edit the image registry for the cluster by running the following command: +A list of Red{nbsp}Hat registries is automatically allowed and it is visible when running rosa describe cluster. This list can be periodically updated to ensure platform can be operated correctly. Impacted clusters will receive a notification with the new allowlist ID. In such cases, the user must use this parameter to update from the previous expected ID to the newly expected ID. Update or edit the image registry for the cluster by running the following command: [source,terminal] ---- diff --git a/modules/installation-mirror-repository.adoc b/modules/installation-mirror-repository.adoc index f69bfbb354..4f15312205 100644 --- a/modules/installation-mirror-repository.adoc +++ b/modules/installation-mirror-repository.adoc @@ -34,8 +34,7 @@ Complete the following steps on the mirror host: . Review the ifndef::openshift-origin[] -link:https://access.redhat.com/downloads/content/290/[{product-title} downloads page] -to determine the version of {product-title} that you want to install and determine the corresponding tag on the link:https://quay.io/repository/openshift-release-dev/ocp-release?tab=tags[Repository Tags] page. +link:https://access.redhat.com/downloads/content/290/[Download {product-title}] page to determine the version of {product-title} that you want to install and determine the corresponding tag on the link:https://quay.io/repository/openshift-release-dev/ocp-release?tab=tags[Repository Tags] page. endif::[] ifdef::openshift-origin[] link:https://github.com/okd-project/okd/releases/[{product-title} releases page] diff --git a/modules/ipi-install-mirroring-for-disconnected-registry.adoc b/modules/ipi-install-mirroring-for-disconnected-registry.adoc index fadc9cf479..8fad820081 100644 --- a/modules/ipi-install-mirroring-for-disconnected-registry.adoc +++ b/modules/ipi-install-mirroring-for-disconnected-registry.adoc @@ -25,8 +25,7 @@ endif::[] . Review the ifndef::openshift-origin[] -link:https://access.redhat.com/downloads/content/290/[{product-title} downloads page] -to determine the version of {product-title} that you want to install and determine the corresponding tag on the link:https://quay.io/repository/openshift-release-dev/ocp-release?tab=tags[Repository Tags] page. +link:https://access.redhat.com/downloads/content/290/[Download {product-title}] page to determine the version of {product-title} that you want to install and determine the corresponding tag on the link:https://quay.io/repository/openshift-release-dev/ocp-release?tab=tags[Repository Tags] page. endif::[] ifdef::openshift-origin[] link:https://github.com/okd-project/okd/releases/[{product-title} releases page] diff --git a/openshift_images/image-configuration-hcp.adoc b/openshift_images/image-configuration-hcp.adoc index 2f40c123d8..81c566feb4 100644 --- a/openshift_images/image-configuration-hcp.adoc +++ b/openshift_images/image-configuration-hcp.adoc @@ -1,11 +1,10 @@ :_mod-docs-content-type: ASSEMBLY include::_attributes/common-attributes.adoc[] -ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::_attributes/attributes-openshift-dedicated.adoc[] -endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] + :context: image-configuration-hcp [id="image-configuration-hcp"] -= Image configuration resources for {hcp-title} += Image configuration resources toc::[] @@ -19,9 +18,4 @@ include::modules/images-editing-image-registry-settings-hcp.adoc[leveloffset=+1] include::modules/images-updating-platform-allowlist-hcp.adoc[leveloffset=+2] -ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] -[role="_additional-resources"] -.Additional resources -* xref:../openshift_images/managing_images/using-image-pull-secrets.adoc#images-update-global-pull-secret_using-image-pull-secrets[Updating the global cluster pull secret] -endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] diff --git a/openshift_images/image-configuration.adoc b/openshift_images/image-configuration.adoc index 49666969cd..84862e32e7 100644 --- a/openshift_images/image-configuration.adoc +++ b/openshift_images/image-configuration.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: ASSEMBLY -[id="image-configuration"] -= Image configuration resources (Classic) +[id="image-configuration-classic"] += Image configuration resources include::_attributes/common-attributes.adoc[] :context: image-configuration diff --git a/openshift_images/index.adoc b/openshift_images/index.adoc index 9330cc90d7..a9c52a9376 100644 --- a/openshift_images/index.adoc +++ b/openshift_images/index.adoc @@ -58,12 +58,12 @@ endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] == About templates A template is a definition of an object to be replicated. -You can use link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html-single/building_applications/index[templates] to build and deploy configurations. +You can use templates to build and deploy configurations. [id="how-you-can-use-ruby-on-rails"] == How you can use Ruby on Rails -As a developer, you can use link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html-single/building_applications/index#templates-using-ruby-on-rails[Ruby on Rails] to: +As a developer, you can use Ruby on Rails to: ** Write your application: *** Set up a database. @@ -74,3 +74,14 @@ As a developer, you can use link:https://docs.redhat.com/en/documentation/red_ha *** Create the database service. *** Create the frontend service. *** Create a route for your application. + +ifdef::openshift-rosa[] +[role="_additional-resources"] +== Additional resources + +* To learn more about templates, see +xref:../applications/creating_applications/using-templates.adoc#templates-overview[Understanding templates]. +* To learn more about Ruby on Rails, see +xref:../applications/creating_applications/templates-using-ruby-on-rails.adoc#templates-using-ruby-on-rails[Creating applications using Ruby on Rails]. +endif::openshift-rosa[] + diff --git a/openshift_images/samples-operator-alt-registry.adoc b/openshift_images/samples-operator-alt-registry.adoc index bc3c7982ba..8f8b4c5c76 100644 --- a/openshift_images/samples-operator-alt-registry.adoc +++ b/openshift_images/samples-operator-alt-registry.adoc @@ -2,6 +2,7 @@ [id="samples-operator-alt-registry"] = Using the Cluster Samples Operator with an alternate registry include::_attributes/common-attributes.adoc[] +include::_attributes/attributes-openshift-dedicated.adoc[] :context: samples-operator-alt-registry toc::[] @@ -21,6 +22,7 @@ ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] For information on viewing the CRI-O logs to view the image source, see xref:../installing/validation_and_troubleshooting/validating-an-installation.adoc#viewing-the-image-pull-source_validating-an-installation[Viewing the image pull source]. endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] +//Incorrect rendering of ROSA attributes discovered during Pruning HCP task. I believe some of the following content is not correct for managed OpenShift. I have created JIRA issue to investigate further. [id="samples-preparing-bastion"] === Preparing the mirror host