From ac94b255e95dd498fa8c72430e6aecbedb6e9d34 Mon Sep 17 00:00:00 2001 From: OpenShift Cherrypick Robot Date: Wed, 22 Jan 2025 08:58:00 +0100 Subject: [PATCH] Replace links to docs.openshift.com (#867) Co-authored-by: GitHub Actions --- modules/installation/proc-install-operator.adoc | 8 ++++---- ...oc-install-rhdh-airgapped-environment-ocp-helm.adoc | 2 +- ...nstall-rhdh-airgapped-environment-ocp-operator.adoc | 10 +++++----- .../installation/proc-install-rhdh-ocp-helm-cli.adoc | 6 +++--- .../installation/proc-install-rhdh-ocp-helm-gui.adoc | 4 ++-- .../installation/proc-install-rhdh-ocp-operator.adoc | 2 +- modules/observe/con-audit-log-config.adoc | 6 +++--- .../observe/proc-admin-enabling-metrics-ocp-helm.adoc | 2 +- .../proc-admin-enabling-metrics-ocp-operator.adoc | 2 +- modules/upgrade/proc-upgrade-rhdh-operator.adoc | 4 ++-- 10 files changed, 23 insertions(+), 23 deletions(-) diff --git a/modules/installation/proc-install-operator.adoc b/modules/installation/proc-install-operator.adoc index f2b929514e..884b2000fa 100644 --- a/modules/installation/proc-install-operator.adoc +++ b/modules/installation/proc-install-operator.adoc @@ -20,15 +20,15 @@ Containers are available for the following CPU architectures: .Prerequisites * You are logged in as an administrator on the {ocp-short} web console. -* You have configured the appropriate roles and permissions within your project to create or access an application. For more information, see the link:https://docs.openshift.com/container-platform/{ocp-version}/applications/index.html[{ocp-brand-name} documentation on Building applications]. +* You have configured the appropriate roles and permissions within your project to create or access an application. For more information, see the link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/building_applications/index#building-applications-overview[{ocp-brand-name} documentation on Building applications]. [IMPORTANT] ==== For enhanced security, better control over the Operator lifecycle, and preventing potential privilege escalation, install the {product} Operator in a dedicated default `rhdh-operator` namespace. You can restrict other users' access to the Operator resources through role bindings or cluster role bindings. -You can also install the Operator in another namespace by creating the necessary resources, such as an Operator group. For more information, see link:https://docs.openshift.com/container-platform/latest/operators/admin/olm-adding-operators-to-cluster.html#olm-installing-global-namespaces_olm-adding-operators-to-a-cluster[Installing global Operators in custom namespaces]. +You can also install the Operator in another namespace by creating the necessary resources, such as an Operator group. For more information, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/operators/index#olm-installing-global-namespaces_olm-adding-operators-to-a-cluster[Installing global Operators in custom namespaces]. -However, if the {product} Operator shares a namespace with other Operators, then it shares the same update policy as well, preventing the customization of the update policy. For example, if one Operator is set to manual updates, the {product} Operator update policy is also set to manual. For more information, see link:https://docs.openshift.com/container-platform/latest/operators/understanding/olm/olm-colocation.html#olm-colocation-namespaces_olm-colocation[Colocation of Operators in a namespace]. +However, if the {product} Operator shares a namespace with other Operators, then it shares the same update policy as well, preventing the customization of the update policy. For example, if one Operator is set to manual updates, the {product} Operator update policy is also set to manual. For more information, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/operators/index#olm-colocation-namespaces_olm-colocation[Colocation of Operators in a namespace]. ==== @@ -62,4 +62,4 @@ The `fast` channel includes all of the updates available for a particular versio .Additional resources * xref:proc-install-rhdh-ocp-operator_{context}[Deploying {product} on {ocp-short} with the Operator] -* link:https://docs.openshift.com/container-platform/{ocp-version}/operators/admin/olm-adding-operators-to-cluster.html#olm-installing-from-operatorhub-using-web-console_olm-adding-operators-to-a-cluster[Installing from OperatorHub using the web console] +* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/operators/index#olm-installing-from-operatorhub-using-web-console_olm-adding-operators-to-a-cluster[Installing from OperatorHub by using the web console] diff --git a/modules/installation/proc-install-rhdh-airgapped-environment-ocp-helm.adoc b/modules/installation/proc-install-rhdh-airgapped-environment-ocp-helm.adoc index 0f95924184..798dbb243e 100644 --- a/modules/installation/proc-install-rhdh-airgapped-environment-ocp-helm.adoc +++ b/modules/installation/proc-install-rhdh-airgapped-environment-ocp-helm.adoc @@ -14,7 +14,7 @@ To install {product-short} in an air-gapped environment, you must have access to * You have installed an {ocp-brand-name} {ocp-version-min} or later. * You have access to the `registry.redhat.io`. -* You have access to the {ocp-brand-name} image registry of your cluster. For more information about exposing the image registry, see the {ocp-brand-name} documentation about https://docs.openshift.com/container-platform/{ocp-version}/registry/securing-exposing-registry.html[Exposing the registry]. +* You have access to the {ocp-brand-name} image registry of your cluster. For more information about exposing the image registry, see the {ocp-brand-name} documentation about https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/registry/index#securing-exposing-registry[Exposing the registry]. * You have installed the {openshift-cli} on your workstation. * You have installed the `podman` command line tools on your workstation. * You you have an account in https://developers.redhat.com/[{rhdeveloper-name}] portal. diff --git a/modules/installation/proc-install-rhdh-airgapped-environment-ocp-operator.adoc b/modules/installation/proc-install-rhdh-airgapped-environment-ocp-operator.adoc index 87ed7a17df..815c61bd3a 100644 --- a/modules/installation/proc-install-rhdh-airgapped-environment-ocp-operator.adoc +++ b/modules/installation/proc-install-rhdh-airgapped-environment-ocp-operator.adoc @@ -20,20 +20,20 @@ This script requires a target mirror registry which you should already have inst ==== .Prerequisites -* You have an active {openshift-cli} session with administrative permissions to the {ocp-short} cluster. See link:https://docs.openshift.com/container-platform/{ocp-version}/cli_reference/openshift_cli/getting-started-cli.html[Getting started with the OpenShift CLI]. +* You have an active {openshift-cli} session with administrative permissions to the {ocp-short} cluster. See link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/cli_tools/index#cli-getting-started[Getting started with the OpenShift CLI]. * You have an active `oc registry` session to the `registry.redhat.io` {company-name} Ecosystem Catalog. See link:https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication]. -* The `opm` CLI tool is installed. See link:https://docs.openshift.com/container-platform/{ocp-version}/cli_reference/opm/cli-opm-install.html[Installing the opm CLI]. +* The `opm` CLI tool is installed. See link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/cli_tools/index#olm-about-opm_cli-opm-install[Installing the opm CLI]. * The jq package is installed. See link:https://jqlang.github.io/jq/download/[Download jq]. * Podman is installed. See link:https://podman.io/docs/installation[Podman Installation Instructions]. * Skopeo version 1.14 or higher is installed. link:https://github.com/containers/skopeo/blob/main/install.md[See Installing Skopeo]. -* If you already have a mirror registry for your cluster, an active Skopeo session with administrative access to this registry is required. See link:https://github.com/containers/skopeo#authenticating-to-a-registry[Authenticating to a registry] and link:https://docs.openshift.com/container-platform/{ocp-version}/installing/disconnected_install/installing-mirroring-installation-images.html[Mirroring images for a disconnected installation]. +* If you already have a mirror registry for your cluster, an active Skopeo session with administrative access to this registry is required. See link:https://github.com/containers/skopeo#authenticating-to-a-registry[Authenticating to a registry] and link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/disconnected_installation_mirroring/index#prerequisites_installing-mirroring-installation-images[Mirroring images for a disconnected installation]. [NOTE] ==== -The internal {ocp-short} cluster image registry cannot be used as a target mirror registry. See link:https://docs.openshift.com/container-platform/{ocp-version}/installing/disconnected_install/installing-mirroring-installation-images.html#installation-about-mirror-registry_installing-mirroring-installation-images[About the mirror registry]. +The internal {ocp-short} cluster image registry cannot be used as a target mirror registry. See link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/disconnected_installation_mirroring/index#installation-about-mirror-registry_installing-mirroring-installation-images[About the mirror registry]. ==== -* If you prefer to create your own mirror registry, see link:https://docs.openshift.com/container-platform/{ocp-version}/installing/disconnected_install/installing-mirroring-creating-registry.html[Creating a mirror registry with mirror registry for Red Hat OpenShift]. +* If you prefer to create your own mirror registry, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/disconnected_installation_mirroring/index#installing-mirroring-creating-registry[Creating a mirror registry with mirror registry for Red Hat OpenShift]. * If you do not already have a mirror registry, you can use the helper script to create one for you and you need the following additional prerequisites: + diff --git a/modules/installation/proc-install-rhdh-ocp-helm-cli.adoc b/modules/installation/proc-install-rhdh-ocp-helm-cli.adoc index 20b4a6f5bb..2801291fcc 100644 --- a/modules/installation/proc-install-rhdh-ocp-helm-cli.adoc +++ b/modules/installation/proc-install-rhdh-ocp-helm-cli.adoc @@ -9,8 +9,8 @@ You can use the Helm CLI to install {product} on {ocp-brand-name}. .Prerequisites * You have installed the {openshift-cli} on your workstation. * You are logged in to your {ocp-short} account. -* A user with the {ocp-short} admin role has configured the appropriate roles and permissions within your project to create an application. For more information about {ocp-short} roles, see link:https://docs.openshift.com/container-platform/4.15/authentication/using-rbac.html[Using RBAC to define and apply permissions]. -* You have created a project in {ocp-short}. For more information about creating a project in {ocp-short}, see link:https://docs.openshift.com/container-platform/4.15/applications/projects/working-with-projects.html#odc-creating-projects-using-developer-perspective_projects[{ocp-brand-name} documentation]. +* A user with the {ocp-short} admin role has configured the appropriate roles and permissions within your project to create an application. For more information about {ocp-short} roles, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/authentication_and_authorization/index#authorization-overview_using-rbac[Using RBAC to define and apply permissions]. +* You have created a project in {ocp-short}. For more information about creating a project in {ocp-short}, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/building_applications/index#working-with-projects[{ocp-brand-name} documentation]. * You have installed the Helm CLI tool. .Procedure @@ -50,4 +50,4 @@ echo "https://redhat-developer-hub-$NAMESPACE.$CLUSTER_ROUTER_BASE" * Open the running {product-short} instance URL in your browser to use {product-short}. .Additional resources -* link:https://docs.openshift.com/container-platform/4.16/applications/working_with_helm_charts/installing-helm.html[Installing Helm] \ No newline at end of file +* link:https://docs.redhat.com/en/documentation/openshift_dedicated/4/html-single/building_applications/index#installing-helm[Installing Helm] \ No newline at end of file diff --git a/modules/installation/proc-install-rhdh-ocp-helm-gui.adoc b/modules/installation/proc-install-rhdh-ocp-helm-gui.adoc index ea28ba1377..5bf3c684dc 100644 --- a/modules/installation/proc-install-rhdh-ocp-helm-gui.adoc +++ b/modules/installation/proc-install-rhdh-ocp-helm-gui.adoc @@ -18,8 +18,8 @@ The {product} Helm chart is available in the Helm catalog on {osd-short} and {oc .Prerequisites * You are logged in to your {ocp-short} account. -* A user with the {ocp-short} `admin` role has configured the appropriate roles and permissions within your project to create an application. For more information about {ocp-short} roles, see link:https://docs.openshift.com/container-platform/{ocp-version}/authentication/using-rbac.html[Using RBAC to define and apply permissions]. -* You have created a project in {ocp-short}. For more information about creating a project in {ocp-short}, see link:https://docs.openshift.com/container-platform/{ocp-version}/applications/projects/working-with-projects.html#odc-creating-projects-using-developer-perspective_projects[{ocp-brand-name} documentation]. +* A user with the {ocp-short} `admin` role has configured the appropriate roles and permissions within your project to create an application. For more information about {ocp-short} roles, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/authentication_and_authorization/index#authorization-overview_using-rbac[Using RBAC to define and apply permissions]. +* You have created a project in {ocp-short}. For more information about creating a project in {ocp-short}, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/building_applications/index#working-with-projects[{ocp-brand-name} documentation]. .Procedure diff --git a/modules/installation/proc-install-rhdh-ocp-operator.adoc b/modules/installation/proc-install-rhdh-ocp-operator.adoc index 293a7d1b07..54f6bd196e 100644 --- a/modules/installation/proc-install-rhdh-ocp-operator.adoc +++ b/modules/installation/proc-install-rhdh-ocp-operator.adoc @@ -36,4 +36,4 @@ image::rhdh/operator-install-1.png[] [role="_additional-resources"] [id="additional-resources_proc-install-rhdh-ocp-operator"] .Additional resources -* link:https://docs.openshift.com/container-platform/{ocp-version}/applications/index.html[{ocp-short} - Building applications overview] +* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/building_applications/index#building-applications-overview[{ocp-short} - Building applications overview] diff --git a/modules/observe/con-audit-log-config.adoc b/modules/observe/con-audit-log-config.adoc index 9b72c4a915..2cc11ea2d3 100644 --- a/modules/observe/con-audit-log-config.adoc +++ b/modules/observe/con-audit-log-config.adoc @@ -6,10 +6,10 @@ Use the {ocp-short} web console to configure the following {ocp-short} logging components to use audit logging for {product-short}: Logging deployment:: -Configure the logging environment, including both the CPU and memory limits for each logging component. For more information, see link:https://docs.openshift.com/container-platform/4.15/observability/logging/config/cluster-logging-memory.html[{ocp-brand-name} - Configuring your Logging deployment]. +Configure the logging environment, including both the CPU and memory limits for each logging component. For more information, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.16/html-single/logging/index#cluster-logging-memory[{ocp-brand-name} - Configuring your Logging deployment]. Logging collector:: -Configure the `spec.collection` stanza in the `ClusterLogging` custom resource (CR) to use a supported modification to the log collector and collect logs from `STDOUT`. For more information, see link:https://docs.openshift.com/container-platform/4.15/observability/logging/log_collection_forwarding/cluster-logging-collector.html[{ocp-brand-name} - Configuring the logging collector]. +Configure the `spec.collection` stanza in the `ClusterLogging` custom resource (CR) to use a supported modification to the log collector and collect logs from `STDOUT`. For more information, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.16/html-single/logging/index#cluster-logging-collector[{ocp-brand-name} - Configuring the logging collector]. Log forwarding:: -Send logs to specific endpoints inside and outside your {ocp-short} cluster by specifying a combination of outputs and pipelines in a `ClusterLogForwarder` CR. For more information, see link:https://docs.openshift.com/container-platform/4.15/observability/logging/log_collection_forwarding/cluster-logging-enabling-json-logging.html[{ocp-brand-name} - Enabling JSON log forwarding] and link:https://docs.openshift.com/container-platform/4.15/observability/logging/log_collection_forwarding/configuring-log-forwarding.html[{ocp-brand-name} - Configuring log forwarding]. +Send logs to specific endpoints inside and outside your {ocp-short} cluster by specifying a combination of outputs and pipelines in a `ClusterLogForwarder` CR. For more information, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.16/html-single/logging/index#cluster-logging-json-log-forwarding_cluster-logging-enabling-json-logging[{ocp-brand-name} - Enabling JSON log forwarding] and link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.16/html-single/logging/index#configuring-log-forwarding[{ocp-brand-name} - Configuring log forwarding]. diff --git a/modules/observe/proc-admin-enabling-metrics-ocp-helm.adoc b/modules/observe/proc-admin-enabling-metrics-ocp-helm.adoc index eccc3f6f1f..9222762631 100644 --- a/modules/observe/proc-admin-enabling-metrics-ocp-helm.adoc +++ b/modules/observe/proc-admin-enabling-metrics-ocp-helm.adoc @@ -10,7 +10,7 @@ You can enable and view metrics for a {product} Helm deployment from the *Develo .Prerequisites -* Your {ocp-short} cluster has link:https://docs.openshift.com/container-platform/latest/observability/monitoring/enabling-monitoring-for-user-defined-projects.html[monitoring for user-defined projects] enabled. +* Your {ocp-short} cluster has link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/monitoring/index#enabling-monitoring-for-user-defined-projects[monitoring for user-defined projects] enabled. * You have installed {product} on {ocp-short} using the Helm chart. .Procedure diff --git a/modules/observe/proc-admin-enabling-metrics-ocp-operator.adoc b/modules/observe/proc-admin-enabling-metrics-ocp-operator.adoc index 66c4960062..66fc01c579 100644 --- a/modules/observe/proc-admin-enabling-metrics-ocp-operator.adoc +++ b/modules/observe/proc-admin-enabling-metrics-ocp-operator.adoc @@ -10,7 +10,7 @@ You can enable and view metrics for an Operator-installed {product} instance fro .Prerequisites -* Your {ocp-short} cluster has link:https://docs.openshift.com/container-platform/latest/observability/monitoring/enabling-monitoring-for-user-defined-projects.html[monitoring for user-defined projects] enabled. +* Your {ocp-short} cluster has link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/monitoring/index#enabling-monitoring-for-user-defined-projects[monitoring for user-defined projects] enabled. * You have installed {product} on {ocp-short} using the {product} Operator. * You have installed the {openshift-cli}. diff --git a/modules/upgrade/proc-upgrade-rhdh-operator.adoc b/modules/upgrade/proc-upgrade-rhdh-operator.adoc index bfc3fca75e..f2d43a2272 100644 --- a/modules/upgrade/proc-upgrade-rhdh-operator.adoc +++ b/modules/upgrade/proc-upgrade-rhdh-operator.adoc @@ -14,7 +14,7 @@ If you use the Operator to deploy your {product} instance, then an administrator * You are logged in as an administrator on the {ocp-short} web console. * You have installed the {product} Operator. -* You have configured the appropriate roles and permissions within your project to create or access an application. For more information, see the link:https://docs.openshift.com/container-platform/{ocp-version}/applications/index.html[{ocp-brand-name} documentation on Building applications]. +* You have configured the appropriate roles and permissions within your project to create or access an application. For more information, see the link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/building_applications/index#building-applications-overview[{ocp-brand-name} documentation on Building applications]. .Procedure @@ -38,4 +38,4 @@ If there is no upgrade available, the *Upgrade status* field value is *Up to dat .Additional resources * link:{installing-on-ocp-book-url}#proc-install-operator_assembly-install-rhdh-ocp-operator[{installing-on-ocp-book-title} with the Operator]. -* link:https://docs.openshift.com/container-platform/{ocp-version}/operators/admin/olm-adding-operators-to-cluster.html#olm-installing-from-operatorhub-using-web-console_olm-adding-operators-to-a-cluster[Installing from OperatorHub using the web console] +* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/operators/index#olm-installing-from-operatorhub-using-web-console_olm-adding-operators-to-a-cluster[Installing from OperatorHub by using the web console]