From 081f5f3ff3fd09c534ddbfcf60bd0222ded257a3 Mon Sep 17 00:00:00 2001 From: Eric Ponvelle Date: Wed, 24 Nov 2021 11:50:28 -0600 Subject: [PATCH] OSDOCS-2849: Updated the OCM links from cloud to console. This change prompted me to also change and update the variables for OCM. --- contributing_to_docs/doc_guidelines.adoc | 17 ++++++++++++++++- modules/access-cluster.adoc | 2 +- modules/attributes-openshift-dedicated.adoc | 2 +- modules/ccs-aws-customer-procedure.adoc | 2 +- modules/ccs-aws-customer-requirements.adoc | 2 +- modules/ccs-gcp-customer-requirements.adoc | 2 +- modules/cluster-entitlements.adoc | 2 +- modules/cluster-telemetry.adoc | 4 ++-- modules/common-attributes.adoc | 2 +- modules/config-aws-access.adoc | 2 +- modules/config-github-idp.adoc | 2 +- modules/config-gitlab-idp.adoc | 2 +- modules/config-google-idp.adoc | 2 +- modules/config-htpasswd-idp.adoc | 2 +- modules/config-ldap-idp.adoc | 2 +- modules/config-openid-idp.adoc | 2 +- modules/create-aws-cluster.adoc | 2 +- modules/create-cluster.adoc | 2 +- modules/create-gcp-cluster.adoc | 2 +- ...cated-managing-dedicated-administrators.adoc | 2 +- modules/deleting-cluster.adoc | 2 +- modules/deleting-service.adoc | 3 +-- ...ying-potential-issues-with-your-cluster.adoc | 6 +++--- ...-the-insights-status-in-the-web-console.adoc | 5 ++--- modules/distr-tracing-document-attributes.adoc | 2 +- modules/enable-private-cluster-existing.adoc | 2 +- modules/enable-private-cluster-new.adoc | 2 +- modules/enable-public-cluster.adoc | 2 +- ...rating-icsp-object-scoped-to-a-registry.adoc | 2 +- modules/insights-operator-about.adoc | 4 ++-- ...nstallation-adding-registry-pull-secret.adoc | 2 +- .../installation-bare-metal-config-yaml.adoc | 4 ++-- ...-generate-aws-user-infra-install-config.adoc | 2 +- modules/installation-initializing.adoc | 6 +++--- modules/installation-launching-installer.adoc | 8 ++++---- modules/installation-mirror-repository.adoc | 2 +- modules/installation-obtaining-installer.adoc | 8 ++++---- modules/installation-process.adoc | 2 +- modules/installation-vsphere-config-yaml.adoc | 4 ++-- modules/jaeger-document-attributes.adoc | 2 +- modules/managing-dedicated-administrators.adoc | 2 +- .../nodes-cluster-enabling-features-about.adoc | 10 +++++----- modules/osd-intro.adoc | 4 ++-- modules/ossm-document-attributes-1x.adoc | 2 +- modules/ossm-document-attributes.adoc | 2 +- modules/psap-driver-toolkit-pulling.adoc | 2 +- ...atus-from-the-openshift-cluster-manager.adoc | 8 ++++---- modules/rosa-upgrading-automatic-ocm.adoc | 2 +- modules/rosa-upgrading-manual-ocm.adoc | 4 ++-- modules/support.adoc | 2 +- ...try-consequences-of-disabling-telemetry.adoc | 4 ++-- modules/understanding-admin-roles.adoc | 2 +- modules/update-service-mirror-release.adoc | 2 +- .../using-image-pull-secrets.adoc | 2 +- .../insights-operator-simple-access.adoc | 6 +++--- ...ts-to-identify-issues-with-your-cluster.adoc | 2 +- upgrading/rosa-upgrading-sts.adoc | 2 +- upgrading/rosa-upgrading.adoc | 4 ++-- 58 files changed, 101 insertions(+), 88 deletions(-) diff --git a/contributing_to_docs/doc_guidelines.adoc b/contributing_to_docs/doc_guidelines.adoc index 091219ccb2..ea77932709 100644 --- a/contributing_to_docs/doc_guidelines.adoc +++ b/contributing_to_docs/doc_guidelines.adoc @@ -236,7 +236,22 @@ would render as: And for the `openshift-origin` distro: -"You can deploy applications on OKD." +> You can deploy applications on OKD. + +Considering that we use distinct branches to keep content for product versions separated, global use of `{product-version}` across all branches is probably less useful, but it is available if you come across a requirement for it. Just consider how it will render across any branches that the content appears in. + +If it makes more sense in context to refer to the major version of the product instead of a specific minor version (for example, if comparing how something in OpenShift Container Platform 4 differs from OpenShift Container Platform 3), just use the major version number. Do not prepend with a `v`, as in `v3` or `v4`. + +[NOTE] +==== +Other common attribute values are defined in the `modules/common-attributes.adoc` file. Where possible, generalize references to those values by using the common attributes. For example, use `{console-redhat-com}` to refer to Red Hat OpenShift Cluster Manager. +==== + +== Node names + +Do not use internal company server names in commands or example output. Provide generic OpenShift Container Platform node name examples that are not provider-specific, unless required. Where possible, use the example.com domain name when providing fully qualified domain names (FQDNs). + +The following table includes example OpenShift Container Platform 4 node names and their corresponding role types: Considering that we use distinct branches to keep content for product versions separated, global use of `{product-version}` across all branches is probably diff --git a/modules/access-cluster.adoc b/modules/access-cluster.adoc index 16cce695dc..4fc2209ca0 100644 --- a/modules/access-cluster.adoc +++ b/modules/access-cluster.adoc @@ -16,7 +16,7 @@ After you have configured your identity providers, users can access the cluster .Procedure -. From {cloud-redhat-com}, click on the cluster you want to access. +. From {console-redhat-com}, click on the cluster you want to access. . Click *Open Console*. diff --git a/modules/attributes-openshift-dedicated.adoc b/modules/attributes-openshift-dedicated.adoc index 5f45e798a4..df14c64e94 100644 --- a/modules/attributes-openshift-dedicated.adoc +++ b/modules/attributes-openshift-dedicated.adoc @@ -6,7 +6,7 @@ :imagesdir: images :OCP: OpenShift Container Platform :OCM: OpenShift Cluster Manager (OCM) -:cloud-redhat-com: link:https://cloud.redhat.com/openshift[OpenShift Cluster Manager (OCM)] +:console-redhat-com: link:https://console.redhat.com/openshift[OpenShift Cluster Manager (OCM)] :AWS: Amazon Web Services (AWS) :GCP: Google Cloud Platform (GCP) :kebab: image:kebab.png[title="Options menu"] diff --git a/modules/ccs-aws-customer-procedure.adoc b/modules/ccs-aws-customer-procedure.adoc index 16784e0028..236d6fec38 100644 --- a/modules/ccs-aws-customer-procedure.adoc +++ b/modules/ccs-aws-customer-procedure.adoc @@ -21,4 +21,4 @@ The Customer Cloud Subscription (CCS) model allows Red Hat to deploy and manage ** This user must have the `AdministratorAccess` policy attached to it. . Provide the IAM user credentials to Red Hat. -** You must provide the *access key ID* and *secret access key* in the {cloud-redhat-com}. +** You must provide the *access key ID* and *secret access key* in the {console-redhat-com}. diff --git a/modules/ccs-aws-customer-requirements.adoc b/modules/ccs-aws-customer-requirements.adoc index 3fe3e4fc2c..0f3b83a1ff 100644 --- a/modules/ccs-aws-customer-requirements.adoc +++ b/modules/ccs-aws-customer-requirements.adoc @@ -47,7 +47,7 @@ This policy only provides Red Hat with permissions and capabilities to change re * The customer must not utilize the AWS account to elevate their permissions within the {product-title} cluster. -* Actions available in the {cloud-redhat-com} must not be directly performed in the customer-provided AWS account. +* Actions available in the {console-redhat-com} must not be directly performed in the customer-provided AWS account. [id="ccs-requirements-support_{context}"] == Support requirements diff --git a/modules/ccs-gcp-customer-requirements.adoc b/modules/ccs-gcp-customer-requirements.adoc index 16769506ff..0e85dbe3a9 100644 --- a/modules/ccs-gcp-customer-requirements.adoc +++ b/modules/ccs-gcp-customer-requirements.adoc @@ -42,7 +42,7 @@ This policy only provides Red Hat with permissions and capabilities to change re * The customer must not utilize the GCP account to elevate their permissions within the {product-title} cluster. -* Actions available in the {cloud-redhat-com} must not be directly performed in the customer-provided GCP account. +* Actions available in the {console-redhat-com} must not be directly performed in the customer-provided GCP account. [id="ccs-gcp-requirements-support_{context}"] == Support requirements diff --git a/modules/cluster-entitlements.adoc b/modules/cluster-entitlements.adoc index 807a868a06..facdcbbfb3 100644 --- a/modules/cluster-entitlements.adoc +++ b/modules/cluster-entitlements.adoc @@ -125,7 +125,7 @@ your cluster. You must have internet access to: -* Access the link:https://console.redhat.com/openshift[{cloud-redhat-com}] page to download the installation program and perform subscription management. If the cluster has internet access and you do not disable Telemetry, that service automatically entitles your cluster. +* Access the link:https://console.redhat.com/openshift[{console-redhat-com}] page to download the installation program and perform subscription management. If the cluster has internet access and you do not disable Telemetry, that service automatically entitles your cluster. * Access link:http://quay.io[Quay.io] to obtain the packages that are required to install your cluster. * Obtain the packages that are required to perform cluster updates. ifdef::openshift-enterprise,openshift-webscale[] diff --git a/modules/cluster-telemetry.adoc b/modules/cluster-telemetry.adoc index ae2eeeddd4..31438d9ee9 100644 --- a/modules/cluster-telemetry.adoc +++ b/modules/cluster-telemetry.adoc @@ -69,8 +69,8 @@ ifndef::openshift-origin[] = Telemetry access for {product-title} -In {product-title} {product-version}, the Telemetry service, which runs by default to provide metrics about cluster health and the success of updates, requires internet access. If your cluster is connected to the internet, Telemetry runs automatically, and your cluster is registered to the link:https://console.redhat.com/openshift[{cloud-redhat-com} (OCM)]. +In {product-title} {product-version}, the Telemetry service, which runs by default to provide metrics about cluster health and the success of updates, requires internet access. If your cluster is connected to the internet, Telemetry runs automatically, and your cluster is registered to the link:https://console.redhat.com/openshift[{console-redhat-com} (OCM)]. -After you confirm that your {cloud-redhat-com} inventory is correct, either maintained automatically by Telemetry or manually by using OCM, link:https://access.redhat.com/documentation/en-us/subscription_central/2020-04/html/getting_started_with_subscription_watch/con-how-to-select-datacollection-tool_assembly-requirements-and-your-responsibilities-ctxt#red_hat_openshift[use subscription watch] to track your {product-title} subscriptions at the account or multi-cluster level. +After you confirm that your {console-redhat-com} inventory is correct, either maintained automatically by Telemetry or manually by using OCM, link:https://access.redhat.com/documentation/en-us/subscription_central/2020-04/html/getting_started_with_subscription_watch/con-how-to-select-datacollection-tool_assembly-requirements-and-your-responsibilities-ctxt#red_hat_openshift[use subscription watch] to track your {product-title} subscriptions at the account or multi-cluster level. endif::openshift-origin[] diff --git a/modules/common-attributes.adoc b/modules/common-attributes.adoc index be7f71d150..5dee615b55 100644 --- a/modules/common-attributes.adoc +++ b/modules/common-attributes.adoc @@ -23,7 +23,7 @@ endif::[] :kebab: image:kebab.png[title="Options menu"] :rh-openstack-first: Red Hat OpenStack Platform (RHOSP) :rh-openstack: RHOSP -:cloud-redhat-com: Red Hat OpenShift Cluster Manager +:console-redhat-com: Red Hat OpenShift Cluster Manager :rh-storage-first: Red Hat OpenShift Container Storage :rh-storage: OpenShift Container Storage :rh-rhacm-first: Red Hat Advanced Cluster Management (RHACM) diff --git a/modules/config-aws-access.adoc b/modules/config-aws-access.adoc index c9fd1f7e69..06d28e4d01 100644 --- a/modules/config-aws-access.adoc +++ b/modules/config-aws-access.adoc @@ -55,7 +55,7 @@ It is not recommended to set a permissions boundary. .. Click *Create user*, a success page appears. .. Gather the IAM user’s Amazon Resource Name (ARN). The ARN will have the following format: `arn:aws:iam::000111222333:user/username`. Click *Close*. -. Open the {cloud-redhat-com} in your browser and select the cluster you want to allow AWS infrastructure access. +. Open the {console-redhat-com} in your browser and select the cluster you want to allow AWS infrastructure access. . Select the *Access control* tab, and scroll to the *AWS Infrastructure Access* section. diff --git a/modules/config-github-idp.adoc b/modules/config-github-idp.adoc index 1db58721d5..dac5207bac 100644 --- a/modules/config-github-idp.adoc +++ b/modules/config-github-idp.adoc @@ -21,7 +21,7 @@ Configuring GitHub authentication allows users to log in to {product-title} with .Procedure -. From {cloud-redhat-com}, navigate to the *Clusters* page and select the cluster that you need to configure identity providers for. +. From {console-redhat-com}, navigate to the *Clusters* page and select the cluster that you need to configure identity providers for. . Click the *Access control* tab. diff --git a/modules/config-gitlab-idp.adoc b/modules/config-gitlab-idp.adoc index b72b72b7ff..31ecbf3000 100644 --- a/modules/config-gitlab-idp.adoc +++ b/modules/config-gitlab-idp.adoc @@ -14,7 +14,7 @@ Configure a GitLab identity provider to use link:https://gitlab.com/[GitLab.com] .Procedure -. From {cloud-redhat-com}, navigate to the *Clusters* page and select the cluster that you need to configure identity providers for. +. From {console-redhat-com}, navigate to the *Clusters* page and select the cluster that you need to configure identity providers for. . Click the *Access control* tab. diff --git a/modules/config-google-idp.adoc b/modules/config-google-idp.adoc index a2224efff5..3f3e562dd6 100644 --- a/modules/config-google-idp.adoc +++ b/modules/config-google-idp.adoc @@ -17,7 +17,7 @@ You can limit authentication to members of a specific hosted domain with the .Procedure -. From {cloud-redhat-com}, navigate to the *Clusters* page and select the cluster that you need to configure identity providers for. +. From {console-redhat-com}, navigate to the *Clusters* page and select the cluster that you need to configure identity providers for. . Click the *Access control* tab. diff --git a/modules/config-htpasswd-idp.adoc b/modules/config-htpasswd-idp.adoc index 17ea7636cc..33263d5b6a 100644 --- a/modules/config-htpasswd-idp.adoc +++ b/modules/config-htpasswd-idp.adoc @@ -9,7 +9,7 @@ Configure an HTPasswd identity provider to create a single, static user with clu .Procedure -. From {cloud-redhat-com}, navigate to the *Clusters* page and select the cluster that you need to configure identity providers for. +. From {console-redhat-com}, navigate to the *Clusters* page and select the cluster that you need to configure identity providers for. . Click the *Access control* tab. diff --git a/modules/config-ldap-idp.adoc b/modules/config-ldap-idp.adoc index 6f514dd559..6878cd7ff0 100644 --- a/modules/config-ldap-idp.adoc +++ b/modules/config-ldap-idp.adoc @@ -52,7 +52,7 @@ If the LDAP directory requires authentication to search, specify a `bindDN` and .Procedure -. From {cloud-redhat-com}, navigate to the *Clusters* page and select the cluster that you need to configure identity providers for. +. From {console-redhat-com}, navigate to the *Clusters* page and select the cluster that you need to configure identity providers for. . Click the *Access control* tab. diff --git a/modules/config-openid-idp.adoc b/modules/config-openid-idp.adoc index ffb5267080..462967b98b 100644 --- a/modules/config-openid-idp.adoc +++ b/modules/config-openid-idp.adoc @@ -54,7 +54,7 @@ for more information. .Procedure -. From {cloud-redhat-com}, navigate to the *Clusters* page and select the cluster that you need to configure identity providers for. +. From {console-redhat-com}, navigate to the *Clusters* page and select the cluster that you need to configure identity providers for. . Click the *Access control* tab. diff --git a/modules/create-aws-cluster.adoc b/modules/create-aws-cluster.adoc index 379ed7902b..d1fec9accb 100644 --- a/modules/create-aws-cluster.adoc +++ b/modules/create-aws-cluster.adoc @@ -21,7 +21,7 @@ Using the CCS model to deploy and manage {product-title} into your AWS account r .Procedure -. Log in to {cloud-redhat-com}. +. Log in to {console-redhat-com}. . Click *Create Cluster* -> *Red Hat OpenShift Dedicated* -> *Create Cluster*. diff --git a/modules/create-cluster.adoc b/modules/create-cluster.adoc index 594fcece0f..acc5895b43 100644 --- a/modules/create-cluster.adoc +++ b/modules/create-cluster.adoc @@ -11,7 +11,7 @@ You can quickly create a standard {product-title} cluster, which deploys in clou .Procedure -. Log in to {cloud-redhat-com}. +. Log in to {console-redhat-com}. . Click *Create Cluster* -> *Red Hat OpenShift Dedicated* -> *Create Clusters*. diff --git a/modules/create-gcp-cluster.adoc b/modules/create-gcp-cluster.adoc index fe84b7a9a2..07a53fb0ae 100644 --- a/modules/create-gcp-cluster.adoc +++ b/modules/create-gcp-cluster.adoc @@ -35,7 +35,7 @@ The project name must be 10 characters or less. .Procedure -. Log in to {cloud-redhat-com}. +. Log in to {console-redhat-com}. . Click *Create Cluster* -> *Red Hat OpenShift Dedicated* -> *Create cluster*. diff --git a/modules/dedicated-managing-dedicated-administrators.adoc b/modules/dedicated-managing-dedicated-administrators.adoc index 85308bf348..a0609dbc26 100644 --- a/modules/dedicated-managing-dedicated-administrators.adoc +++ b/modules/dedicated-managing-dedicated-administrators.adoc @@ -7,7 +7,7 @@ Administrator roles are managed using a `dedicated-admins` group on the cluster. Existing members of this group can edit membership via the -link:https://console.redhat.com/openshift[{cloud-redhat-com}] site. +link:https://console.redhat.com/openshift[{console-redhat-com}] site. [id="dedicated-administrators-adding-user_{context}"] == Adding a user diff --git a/modules/deleting-cluster.adoc b/modules/deleting-cluster.adoc index 8121dc5124..f28f873a27 100644 --- a/modules/deleting-cluster.adoc +++ b/modules/deleting-cluster.adoc @@ -12,7 +12,7 @@ You can delete your {product-title} cluster in the {OCM}. .Procedure -. From {cloud-redhat-com}, click on the cluster you want to delete. +. From {console-redhat-com}, click on the cluster you want to delete. . Click *Actions* -> *Delete Cluster*. diff --git a/modules/deleting-service.adoc b/modules/deleting-service.adoc index 1a358dc2e3..01b2c783dd 100644 --- a/modules/deleting-service.adoc +++ b/modules/deleting-service.adoc @@ -1,4 +1,3 @@ - // Module included in the following assemblies: // // * assemblies/adding-service.adoc @@ -10,7 +9,7 @@ You can delete the add-on services from your {product-title} cluster through the .Procedure -. Navigate to the *Clusters* page in {cloud-redhat-com}. +. Navigate to the *Clusters* page in {console-redhat-com}. . Click the cluster with the installed service that you want to delete. diff --git a/modules/displaying-potential-issues-with-your-cluster.adoc b/modules/displaying-potential-issues-with-your-cluster.adoc index 2a9816365e..b37fce65c6 100644 --- a/modules/displaying-potential-issues-with-your-cluster.adoc +++ b/modules/displaying-potential-issues-with-your-cluster.adoc @@ -5,15 +5,15 @@ [id="displaying-potential-issues-with-your-cluster_{context}"] = Displaying potential issues with your cluster -This section describes how to display the Insights report in the {cloud-redhat-com}. +This section describes how to display the Insights report in the {console-redhat-com}. Note that Insights repeatedly analyzes your cluster and shows the latest results. These results can change, for example, if you fix an issue or a new issue has been detected. .Prerequisites -* Your cluster is registered in the {cloud-redhat-com}. +* Your cluster is registered in the {console-redhat-com}. * Remote health reporting is enabled, which is the default. -* You are logged in to the link:https://console.redhat.com/openshift[{cloud-redhat-com}]. +* You are logged in to the link:https://console.redhat.com/openshift[{console-redhat-com}]. .Procedure diff --git a/modules/displaying-the-insights-status-in-the-web-console.adoc b/modules/displaying-the-insights-status-in-the-web-console.adoc index 1a6b385986..27882a4c55 100644 --- a/modules/displaying-the-insights-status-in-the-web-console.adoc +++ b/modules/displaying-the-insights-status-in-the-web-console.adoc @@ -5,11 +5,11 @@ [id="displaying-the-insights-status-in-the-web-console_{context}"] = Displaying the Insights status in the web console -Insights repeatedly analyzes your cluster and you can display the status of identified potential issues of your cluster in the {product-title} web console. This status shows the number of issues in the different categories and, for further details, links to the reports in the {cloud-redhat-com}. +Insights repeatedly analyzes your cluster and you can display the status of identified potential issues of your cluster in the {product-title} web console. This status shows the number of issues in the different categories and, for further details, links to the reports in the {console-redhat-com}. .Prerequisites -* Your cluster is registered in the {cloud-redhat-com}. +* Your cluster is registered in the {console-redhat-com}. * Remote health reporting is enabled, which is the default. * You are logged in to the {product-title} web console. @@ -20,4 +20,3 @@ Insights repeatedly analyzes your cluster and you can display the status of iden . Click *Insights* on the *Status* card. + The pop-up window lists potential issues grouped by priority. Click the individual categories or *View all in {product-title}* to display further details. - diff --git a/modules/distr-tracing-document-attributes.adoc b/modules/distr-tracing-document-attributes.adoc index 08b681e7f9..aa92eaaf1c 100644 --- a/modules/distr-tracing-document-attributes.adoc +++ b/modules/distr-tracing-document-attributes.adoc @@ -15,7 +15,7 @@ :ProductVersion: 2.0 :product-build: :DownloadURL: registry.redhat.io -:cloud-redhat-com: Red Hat OpenShift Cluster Manager +:console-redhat-com: Red Hat OpenShift Cluster Manager :kebab: image:kebab.png[title="Options menu"] // // Documentation publishing attributes used in the master-docinfo.xml file diff --git a/modules/enable-private-cluster-existing.adoc b/modules/enable-private-cluster-existing.adoc index 80afda0a5e..395b35f3b1 100644 --- a/modules/enable-private-cluster-existing.adoc +++ b/modules/enable-private-cluster-existing.adoc @@ -20,7 +20,7 @@ After a cluster has been created, you can later enable the cluster to be private .Procedure -. Log in to {cloud-redhat-com}. +. Log in to {console-redhat-com}. . Select the public cluster you would like to make private. diff --git a/modules/enable-private-cluster-new.adoc b/modules/enable-private-cluster-new.adoc index a6c78d480a..0b9a32895a 100644 --- a/modules/enable-private-cluster-new.adoc +++ b/modules/enable-private-cluster-new.adoc @@ -21,7 +21,7 @@ You can enable private cluster settings when creating a new cluster. .Procedure -. Log in to {cloud-redhat-com}. +. Log in to {console-redhat-com}. . Click *Create cluster* -> *{product-title}* -> *Create cluster*. . Configure your cluster details. . When selecting your preferred network configuration, select *Advanced*. diff --git a/modules/enable-public-cluster.adoc b/modules/enable-public-cluster.adoc index ab713d24f4..210c1b56c2 100644 --- a/modules/enable-public-cluster.adoc +++ b/modules/enable-public-cluster.adoc @@ -11,7 +11,7 @@ After a private cluster has been created, you can later enable the cluster to be .Procedure -. Log in to {cloud-redhat-com}. +. Log in to {console-redhat-com}. . Select the private cluster you would like to make public. diff --git a/modules/generating-icsp-object-scoped-to-a-registry.adoc b/modules/generating-icsp-object-scoped-to-a-registry.adoc index 2a3366d161..751206f7a7 100644 --- a/modules/generating-icsp-object-scoped-to-a-registry.adoc +++ b/modules/generating-icsp-object-scoped-to-a-registry.adoc @@ -29,7 +29,7 @@ where: -- :: is the local registry you have configured for your disconnected cluster, for example, `local.registry:5000`. :: is the pull specification as configured in your disconnected registry, for example, `redhat/redhat-operator-index:v{product-version}` -:: is the `registry.redhat.io` pull secret in `.json` file format downloaded from the link:https://cloud.redhat.com/openshift/install/pull-secret[Pull Secret] page on the {cloud-redhat-com} site. +:: is the `registry.redhat.io` pull secret in `.json` file format downloaded from the link:https://cloud.redhat.com/openshift/install/pull-secret[Pull Secret] page on the {console-redhat-com} site. -- + The `oc adm catalog mirror` command creates a `/redhat-operator-index-manifests` directory and generates `imageContentSourcePolicy.yaml`, `catalogSource.yaml`, and `mapping.txt` files. diff --git a/modules/insights-operator-about.adoc b/modules/insights-operator-about.adoc index 7a62fc91c3..db39492575 100644 --- a/modules/insights-operator-about.adoc +++ b/modules/insights-operator-about.adoc @@ -7,12 +7,12 @@ The Insights Operator periodically gathers configuration and component failure status and, by default, reports that data every two hours to Red Hat. This information enables Red Hat to assess configuration and deeper failure data than is reported through Telemetry. -Users of {product-title} can display the report of each cluster in {cloud-redhat-com}. If any issues have been identified, Insights provides further details and, if available, steps on how to solve a problem. +Users of {product-title} can display the report of each cluster in {console-redhat-com}. If any issues have been identified, Insights provides further details and, if available, steps on how to solve a problem. The Insights Operator does not collect identifying information, such as user names, passwords, or certificates. See link:https://console.redhat.com/security/insights[Red Hat Insights Data & Application Security] for information about Red Hat Insights data collection and controls. Red Hat uses all connected cluster information to: -* Proactively identify potential cluster issues and provide a solution and preventive actions in {cloud-redhat-com} +* Proactively identify potential cluster issues and provide a solution and preventive actions in {console-redhat-com} * Improve {product-title} by providing aggregated and critical information to product and support teams * Make {product-title} more intuitive diff --git a/modules/installation-adding-registry-pull-secret.adoc b/modules/installation-adding-registry-pull-secret.adoc index 8befc4c83c..d79b4a0943 100644 --- a/modules/installation-adding-registry-pull-secret.adoc +++ b/modules/installation-adding-registry-pull-secret.adoc @@ -47,7 +47,7 @@ Complete the following steps on the installation host: ifndef::openshift-origin[] . Download your `registry.redhat.io` pull secret from the -link:https://console.redhat.com/openshift/install/pull-secret[Pull Secret] page on the {cloud-redhat-com} site and save it to a `.json` file. +link:https://console.redhat.com/openshift/install/pull-secret[Pull Secret] page on the {console-redhat-com} site and save it to a `.json` file. endif::[] . Generate the base64-encoded user name and password or token for your mirror diff --git a/modules/installation-bare-metal-config-yaml.adoc b/modules/installation-bare-metal-config-yaml.adoc index 516a3105ab..00eb51b1c1 100644 --- a/modules/installation-bare-metal-config-yaml.adoc +++ b/modules/installation-bare-metal-config-yaml.adoc @@ -283,13 +283,13 @@ The use of FIPS Validated / Modules in Process cryptographic libraries is only s endif::openshift-origin[] ifndef::restricted[] ifndef::openshift-origin[] -<12> The pull secret that you obtained from the link:https://console.redhat.com/openshift[{cloud-redhat-com}] site. +<12> The pull secret that you obtained from the link:https://console.redhat.com/openshift[{console-redhat-com}] site. This pull secret allows you to authenticate with the services that are provided by the included authorities, including Quay.io, which serves the container images for {product-title} components. endif::openshift-origin[] ifdef::openshift-origin[] -<11> The pull secret that you obtained from the link:https://console.redhat.com/openshift[{cloud-redhat-com}] site. +<11> The pull secret that you obtained from the link:https://console.redhat.com/openshift[{console-redhat-com}] site. This pull secret allows you to authenticate with the services that are provided by the included authorities, including Quay.io, which serves the container images for {product-title} components. diff --git a/modules/installation-generate-aws-user-infra-install-config.adoc b/modules/installation-generate-aws-user-infra-install-config.adoc index 682fd22c15..3364af6075 100644 --- a/modules/installation-generate-aws-user-infra-install-config.adoc +++ b/modules/installation-generate-aws-user-infra-install-config.adoc @@ -62,7 +62,7 @@ The AWS access key ID and secret access key are stored in `~/.aws/credentials` i ... Select the base domain for the Route 53 service that you configured for your cluster. ... Enter a descriptive name for your cluster. ... Paste the pull secret that you obtained from the -link:https://console.redhat.com/openshift/install/pull-secret[Pull Secret] page on the {cloud-redhat-com} site. +link:https://console.redhat.com/openshift/install/pull-secret[Pull Secret] page on the {console-redhat-com} site. ifdef::openshift-origin[] This field is optional. endif::[] diff --git a/modules/installation-initializing.adoc b/modules/installation-initializing.adoc index c35726151a..6fe5a7dd96 100644 --- a/modules/installation-initializing.adoc +++ b/modules/installation-initializing.adoc @@ -168,7 +168,7 @@ ifndef::aws,gcp[] * Retrieve a {op-system-first} image and upload it to an accessible location. endif::aws,gcp[] endif::restricted[] -* Obtain service principal permissions at the subscription level. +* Obtain service principal permissions at the subscription level. .Procedure @@ -339,11 +339,11 @@ ocpadmin@internal ... For `Ingress virtual IP`, enter the static IP address you reserved for the wildcard apps domain. ... For `Base Domain`, enter the base domain of the {product-title} cluster. If this cluster is exposed to the outside world, this must be a valid domain recognized by DNS infrastructure. For example, enter: `virtlab.example.com` ... For `Cluster Name`, enter the name of the cluster. For example, `my-cluster`. Use cluster name from the externally registered/resolvable DNS entries you created for the {product-title} REST API and apps domain names. The installation program also gives this name to the cluster in the {rh-virtualization} environment. -... For `Pull Secret`, copy the pull secret from the `pull-secret.txt` file you downloaded earlier and paste it here. You can also get a copy of the same pull secret from the link:https://console.redhat.com/openshift/install/pull-secret[Pull Secret] page on the {cloud-redhat-com} site. +... For `Pull Secret`, copy the pull secret from the `pull-secret.txt` file you downloaded earlier and paste it here. You can also get a copy of the same pull secret from the link:https://console.redhat.com/openshift/install/pull-secret[Pull Secret] page on the {console-redhat-com} site. endif::rhv[] ifndef::rhv[] ... Paste the pull secret that you obtained from the -link:https://console.redhat.com/openshift/install/pull-secret[Pull Secret] page on the {cloud-redhat-com} site. +link:https://console.redhat.com/openshift/install/pull-secret[Pull Secret] page on the {console-redhat-com} site. ifdef::openshift-origin[] This field is optional. endif::[] diff --git a/modules/installation-launching-installer.adoc b/modules/installation-launching-installer.adoc index ecf1c0964c..b49ee628af 100644 --- a/modules/installation-launching-installer.adoc +++ b/modules/installation-launching-installer.adoc @@ -303,12 +303,12 @@ ID that is generated from the cluster name. endif::gcp[] ifndef::openshift-origin[] .. Paste the pull secret that you obtained from the -link:https://console.redhat.com/openshift/install/pull-secret[Pull Secret] page on the {cloud-redhat-com} site. +link:https://console.redhat.com/openshift/install/pull-secret[Pull Secret] page on the {console-redhat-com} site. endif::openshift-origin[] ifdef::openshift-origin[] .. Paste the pull secret that you obtained from the -link:https://console.redhat.com/openshift/install/pull-secret[Pull Secret] page on the {cloud-redhat-com} site. -* If you do not have a pull secret from the {cloud-redhat-com} site, you can paste the pull secret another private registry. +link:https://console.redhat.com/openshift/install/pull-secret[Pull Secret] page on the {console-redhat-com} site. +* If you do not have a pull secret from the {console-redhat-com} site, you can paste the pull secret another private registry. * If you do not need the cluster to pull images from a private registry, you can paste `{"auths":{"fake":{"auth":"aWQ6cGFzcwo="}}}` as the pull secret. endif::openshift-origin[] endif::rhv[] @@ -359,7 +359,7 @@ endif::openshift-origin[] .. For `Ingress virtual IP`, enter the static IP address you reserved for the wildcard apps domain. .. For `Base Domain`, enter the base domain of the {product-title} cluster. If this cluster is exposed to the outside world, this must be a valid domain recognized by DNS infrastructure. For example, enter: `virtlab.example.com` .. For `Cluster Name`, enter the name of the cluster. For example, `my-cluster`. Use cluster name from the externally registered/resolvable DNS entries you created for the {product-title} REST API and apps domain names. The installation program also gives this name to the cluster in the {rh-virtualization} environment. -.. For `Pull Secret`, copy the pull secret from the `pull-secret.txt` file you downloaded earlier and paste it here. You can also get a copy of the same pull secret from the link:https://console.redhat.com/openshift/install/pull-secret[Pull Secret] page on the {cloud-redhat-com} site. +.. For `Pull Secret`, copy the pull secret from the `pull-secret.txt` file you downloaded earlier and paste it here. You can also get a copy of the same pull secret from the link:https://console.redhat.com/openshift/install/pull-secret[Pull Secret] page on the {console-redhat-com} site. endif::rhv[] -- endif::no-config[] diff --git a/modules/installation-mirror-repository.adoc b/modules/installation-mirror-repository.adoc index 8ef7c8b9ad..663683461e 100644 --- a/modules/installation-mirror-repository.adoc +++ b/modules/installation-mirror-repository.adoc @@ -16,7 +16,7 @@ Mirror the {product-title} image repository to your registry to use during clust can access the certificate and credentials that you configured. ifndef::openshift-origin[] * You downloaded the pull secret from the -link:https://console.redhat.com/openshift/install/pull-secret[Pull Secret] page on the {cloud-redhat-com} site and modified it to include authentication to your mirror repository. +link:https://console.redhat.com/openshift/install/pull-secret[Pull Secret] page on the {console-redhat-com} site and modified it to include authentication to your mirror repository. endif::[] ifdef::openshift-origin[] * You have created a pull secret for your mirror repository. diff --git a/modules/installation-obtaining-installer.adoc b/modules/installation-obtaining-installer.adoc index 64ce823cb3..44a33c6331 100644 --- a/modules/installation-obtaining-installer.adoc +++ b/modules/installation-obtaining-installer.adoc @@ -71,7 +71,7 @@ ifndef::ibm-z,ibm-z-kvm[* You have a computer that runs Linux or macOS, with 500 ifndef::openshift-origin[] . Access the link:https://console.redhat.com/openshift/install[Infrastructure Provider] -page on the {cloud-redhat-com} site. If you have a Red Hat account, log in with your credentials. If you do not, create an account. +page on the {console-redhat-com} site. If you have a Red Hat account, log in with your credentials. If you do not, create an account. . Select your infrastructure provider. ifdef::ash[] Select *Azure* as the cloud provider if you are installing your cluster on Azure Stack Hub. @@ -105,14 +105,14 @@ $ tar -xvf openshift-install-linux.tar.gz ---- . From the -link:https://console.redhat.com/openshift/install/pull-secret[Pull Secret] page on the {cloud-redhat-com} site, download your installation pull secret. This pull secret allows you to authenticate with the services that +link:https://console.redhat.com/openshift/install/pull-secret[Pull Secret] page on the {console-redhat-com} site, download your installation pull secret. This pull secret allows you to authenticate with the services that are provided by the included authorities, including Quay.io, which serves the container images for {product-title} components. ifdef::openshift-origin[] + -Using a pull secret from the {cloud-redhat-com} site is not required. You can use a pull secret for another private registry. Or, if you do not need the cluster to pull images from a private registry, you can use `{"auths":{"fake":{"auth":"aWQ6cGFzcwo="}}}` as the pull secret when prompted during the installation. +Using a pull secret from the {console-redhat-com} site is not required. You can use a pull secret for another private registry. Or, if you do not need the cluster to pull images from a private registry, you can use `{"auths":{"fake":{"auth":"aWQ6cGFzcwo="}}}` as the pull secret when prompted during the installation. + -If you do not use the pull secret from the {cloud-redhat-com} site: +If you do not use the pull secret from the {console-redhat-com} site: + * Red Hat Operators are not available. * The Telemetry and Insights operators do not send data to Red Hat. diff --git a/modules/installation-process.adoc b/modules/installation-process.adoc index 0b4096b1d1..9ef89c0de2 100644 --- a/modules/installation-process.adoc +++ b/modules/installation-process.adoc @@ -8,7 +8,7 @@ When you install an {product-title} cluster, you download the installation program from ifndef::openshift-origin[] -the appropriate link:https://console.redhat.com/openshift/install[Infrastructure Provider] page on the {cloud-redhat-com} site. This site manages: +the appropriate link:https://console.redhat.com/openshift/install[Infrastructure Provider] page on the {console-redhat-com} site. This site manages: * REST API for accounts * Registry tokens, which are the pull secrets that you use to obtain the required components diff --git a/modules/installation-vsphere-config-yaml.adoc b/modules/installation-vsphere-config-yaml.adoc index 496608d7b0..a5aa2555a7 100644 --- a/modules/installation-vsphere-config-yaml.adoc +++ b/modules/installation-vsphere-config-yaml.adoc @@ -150,7 +150,7 @@ endif::openshift-origin[] ifndef::restricted[] ifndef::openshift-origin[] <14> The pull secret that you obtained from the -link:https://console.redhat.com/openshift/install/pull-secret[Pull Secret] page on the {cloud-redhat-com} site. This pull secret allows you to authenticate with the services that are +link:https://console.redhat.com/openshift/install/pull-secret[Pull Secret] page on the {console-redhat-com} site. This pull secret allows you to authenticate with the services that are provided by the included authorities, including Quay.io, which serves the container images for {product-title} components. <15> The public portion of the default SSH key for the `core` user in @@ -158,7 +158,7 @@ container images for {product-title} components. endif::openshift-origin[] ifdef::openshift-origin[] <13> The pull secret that you obtained from the -link:https://console.redhat.com/openshift/install/pull-secret[Pull Secret] page on the {cloud-redhat-com} site. This pull secret allows you to authenticate with the services that are +link:https://console.redhat.com/openshift/install/pull-secret[Pull Secret] page on the {console-redhat-com} site. This pull secret allows you to authenticate with the services that are provided by the included authorities, including Quay.io, which serves the container images for {product-title} components. <14> The public portion of the default SSH key for the `core` user in diff --git a/modules/jaeger-document-attributes.adoc b/modules/jaeger-document-attributes.adoc index 968254aafc..6f73276122 100644 --- a/modules/jaeger-document-attributes.adoc +++ b/modules/jaeger-document-attributes.adoc @@ -15,7 +15,7 @@ :ProductVersion: 1.24.0 :product-build: :DownloadURL: registry.redhat.io -:cloud-redhat-com: Red Hat OpenShift Cluster Manager +:console-redhat-com: Red Hat OpenShift Cluster Manager :kebab: image:kebab.png[title="Options menu"] // // Documentation publishing attributes used in the master-docinfo.xml file diff --git a/modules/managing-dedicated-administrators.adoc b/modules/managing-dedicated-administrators.adoc index 1a661f951c..5fadbacca2 100644 --- a/modules/managing-dedicated-administrators.adoc +++ b/modules/managing-dedicated-administrators.adoc @@ -5,7 +5,7 @@ [id="managing-dedicated-administrators_{context}"] = Managing {product-title} administrators -Administrator roles are managed using a `cluster-admin` or `dedicated-admin` group on the cluster. Existing members of this group can edit membership through {cloud-redhat-com}. +Administrator roles are managed using a `cluster-admin` or `dedicated-admin` group on the cluster. Existing members of this group can edit membership through {console-redhat-com}. // TODO: These two procedures should be separated and created as proper procedure modules. diff --git a/modules/nodes-cluster-enabling-features-about.adoc b/modules/nodes-cluster-enabling-features-about.adoc index e11cc7974e..a2e3c24bef 100644 --- a/modules/nodes-cluster-enabling-features-about.adoc +++ b/modules/nodes-cluster-enabling-features-about.adoc @@ -16,24 +16,24 @@ You can activate any of the following feature sets by using the `FeatureGate` CR | Feature Set| Description |`TechPreviewNoUpgrade` -a|Enables Technology Preview features that are not part of the default features. Enabling this feature set cannot be undone and prevents upgrades. This feature set is not recommended on production clusters. +a|Enables Technology Preview features that are not part of the default features. Enabling this feature set cannot be undone and prevents upgrades. This feature set is not recommended on production clusters. The following Technology Preview features are enabled by this feature set: * link:https://kubernetes.io/docs/reference/command-line-tools-reference/kubelet-tls-bootstrapping/#certificate-rotation[RotateKubeletServerCertificate]. Enables the rotation of the server TLS certificate on the kubelet. * link:https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits[Pod PID limits (SupportPodPidsLimit)]. Enables limiting process IDs (PIDs) in pods. -* `InsightsOperatorPullingSCA`. Enables importing of RHEL Simple Content Access (SCA) certificates from {cloud-redhat-com}. +* `InsightsOperatorPullingSCA`. Enables importing of RHEL Simple Content Access (SCA) certificates from {console-redhat-com}. |=== -//// +//// Do not document per Derek Carr: https://github.com/openshift/api/pull/370#issuecomment-510632939 |`CustomNoUpgrade` ^[2]^ -|Allows the enabling or disabling of any feature. Turning on this feature set on is not supported, cannot be undone, and prevents upgrades. +|Allows the enabling or disabling of any feature. Turning on this feature set on is not supported, cannot be undone, and prevents upgrades. [.small] -- -1. +1. 2. If you use the `CustomNoUpgrade` feature set to disable a feature that appears in the web console, you might see that feature, but no objects are listed. For example, if you disable builds, you can see the *Builds* tab in the web console, but there are no builds present. If you attempt to use commands associated with a disabled feature, such as `oc start-build`, {product-title} displays an error. diff --git a/modules/osd-intro.adoc b/modules/osd-intro.adoc index 530d52b9b0..5c31097acc 100644 --- a/modules/osd-intro.adoc +++ b/modules/osd-intro.adoc @@ -42,13 +42,13 @@ Other enhancements to Kubernetes in {product-title} include improvements in soft [id="telemetry_{context}"] == Internet and Telemetry access for {product-title} -In {product-title}, you require access to the Internet to install your cluster. The Telemetry service, which runs by default to provide metrics about cluster health and the success of updates, also requires Internet access. If your cluster is connected to the Internet, Telemetry runs automatically, and your cluster is registered to the {cloud-redhat-com}. +In {product-title}, you require access to the Internet to install your cluster. The Telemetry service, which runs by default to provide metrics about cluster health and the success of updates, also requires Internet access. If your cluster is connected to the Internet, Telemetry runs automatically, and your cluster is registered to the {console-redhat-com}. Once you confirm that your Red Hat OpenShift Cluster Manager inventory is correct, either maintained automatically by Telemetry or manually using OCM, use link:https://access.redhat.com/documentation/en-us/subscription_central/2020-04/html/getting_started_with_subscription_watch/con-how-to-select-datacollection-tool_assembly-requirements-and-your-responsibilities-ctxt#red_hat_openshift[subscription watch] to track your {product-title} subscriptions at the account or multi-cluster level. You must have Internet access to: -* Access the {cloud-redhat-com} page to download the installation program and perform subscription management. If the cluster has Internet access and you do not disable Telemetry, that service automatically entitles your cluster. +* Access the {console-redhat-com} page to download the installation program and perform subscription management. If the cluster has Internet access and you do not disable Telemetry, that service automatically entitles your cluster. * Obtain the packages that are required to perform cluster updates. diff --git a/modules/ossm-document-attributes-1x.adoc b/modules/ossm-document-attributes-1x.adoc index fffea10353..e999c3f26a 100644 --- a/modules/ossm-document-attributes-1x.adoc +++ b/modules/ossm-document-attributes-1x.adoc @@ -16,7 +16,7 @@ :MaistraVersion: 1.1 :product-build: :DownloadURL: registry.redhat.io -:cloud-redhat-com: Red Hat OpenShift Cluster Manager +:console-redhat-com: Red Hat OpenShift Cluster Manager :kebab: image:kebab.png[title="Options menu"] // // Documentation publishing attributes used in the master-docinfo.xml file diff --git a/modules/ossm-document-attributes.adoc b/modules/ossm-document-attributes.adoc index 714f912ec6..dce258a71c 100644 --- a/modules/ossm-document-attributes.adoc +++ b/modules/ossm-document-attributes.adoc @@ -17,7 +17,7 @@ :MaistraVersion: 2.0 :product-build: :DownloadURL: registry.redhat.io -:cloud-redhat-com: Red Hat OpenShift Cluster Manager +:console-redhat-com: Red Hat OpenShift Cluster Manager :kebab: image:kebab.png[title="Options menu"] // // Documentation publishing attributes used in the master-docinfo.xml file diff --git a/modules/psap-driver-toolkit-pulling.adoc b/modules/psap-driver-toolkit-pulling.adoc index d133232500..f933fc2ccf 100644 --- a/modules/psap-driver-toolkit-pulling.adoc +++ b/modules/psap-driver-toolkit-pulling.adoc @@ -18,7 +18,7 @@ The driver-toolkit image for the latest minor release will be tagged with the mi .Prerequisites -* You obtained the image pull secret needed to perform an installation of {product-title}, from the link:https://cloud.redhat.com/openshift/install/pull-secret[Pull Secret] page on the {cloud-redhat-com} site. +* You obtained the image pull secret needed to perform an installation of {product-title}, from the link:https://cloud.redhat.com/openshift/install/pull-secret[Pull Secret] page on the {console-redhat-com} site. * You installed the OpenShift CLI (`oc`). .Procedure diff --git a/modules/reviewing-cluster-status-from-the-openshift-cluster-manager.adoc b/modules/reviewing-cluster-status-from-the-openshift-cluster-manager.adoc index 8b3a583845..d49f6af2c5 100644 --- a/modules/reviewing-cluster-status-from-the-openshift-cluster-manager.adoc +++ b/modules/reviewing-cluster-status-from-the-openshift-cluster-manager.adoc @@ -3,9 +3,9 @@ // *installing/validating-an-installation.adoc [id="reviewing-cluster-status-from-the-openshift-cluster-manager_{context}"] -= Reviewing the cluster status from the {cloud-redhat-com} += Reviewing the cluster status from the {console-redhat-com} -You can review detailed information about the status of your cluster in the {cloud-redhat-com}. +You can review detailed information about the status of your cluster in the {console-redhat-com}. .Prerequisites @@ -13,11 +13,11 @@ You can review detailed information about the status of your cluster in the {clo .Procedure -. In the *Administrator* perspective, navigate to *Home* -> *Overview* -> *Details* -> *OpenShift Cluster Manager* to open the *Overview* page for the cluster in the {cloud-redhat-com}. +. In the *Administrator* perspective, navigate to *Home* -> *Overview* -> *Details* -> *OpenShift Cluster Manager* to open the *Overview* page for the cluster in the {console-redhat-com}. + [NOTE] ==== -Alternatively, you can navigate to the link:https://console.redhat.com/openshift/[{cloud-redhat-com}] directly and select your cluster ID from the list of available clusters. +Alternatively, you can navigate to the link:https://console.redhat.com/openshift/[{console-redhat-com}] directly and select your cluster ID from the list of available clusters. ==== . In the *Overview* page, review the following information about your cluster: diff --git a/modules/rosa-upgrading-automatic-ocm.adoc b/modules/rosa-upgrading-automatic-ocm.adoc index ff7b098b47..940971619e 100644 --- a/modules/rosa-upgrading-automatic-ocm.adoc +++ b/modules/rosa-upgrading-automatic-ocm.adoc @@ -10,7 +10,7 @@ You can schedule automatic upgrades for a {product-title} cluster through the Op .Procedure -. Log in to the {cloud-redhat-com}. +. Log in to the {console-redhat-com}. . Select a cluster to upgrade. . Click the *Settings* tab. . In the *Update strategy* pane, click *Automatic* and select a preferred day of the week and start time for the automatic upgrades. diff --git a/modules/rosa-upgrading-manual-ocm.adoc b/modules/rosa-upgrading-manual-ocm.adoc index 0cf86170e7..c5495974b1 100644 --- a/modules/rosa-upgrading-manual-ocm.adoc +++ b/modules/rosa-upgrading-manual-ocm.adoc @@ -10,7 +10,7 @@ endif::[] [id="rosa-upgrade-ocm_{context}"] = Upgrading manually using the console -You can upgrade a {product-title} cluster +You can upgrade a {product-title} cluster ifdef::sts[] that uses the AWS Security Token Service (STS) endif::sts[] @@ -24,7 +24,7 @@ endif::sts[] .Procedure -. Log in to the {cloud-redhat-com}. +. Log in to the {console-redhat-com}. . Select a cluster to upgrade. . Click the *Settings* tab. . In the *Update strategy* pane, click *Manual*. diff --git a/modules/support.adoc b/modules/support.adoc index 50b67c6f3c..5ef2d19c35 100644 --- a/modules/support.adoc +++ b/modules/support.adoc @@ -18,7 +18,7 @@ If you experience difficulty with a procedure described in this documentation, o // TODO: xref * Access other product documentation. -To identify issues with your cluster, you can use Insights in {cloud-redhat-com}. Insights provides details about issues and, if available, information on how to solve a problem. +To identify issues with your cluster, you can use Insights in {console-redhat-com}. Insights provides details about issues and, if available, information on how to solve a problem. // TODO: verify that these settings apply for Service Mesh and OpenShift virtualization, etc. If you have a suggestion for improving this documentation or have found an diff --git a/modules/telemetry-consequences-of-disabling-telemetry.adoc b/modules/telemetry-consequences-of-disabling-telemetry.adoc index 47148ce2ed..1b53b83216 100644 --- a/modules/telemetry-consequences-of-disabling-telemetry.adoc +++ b/modules/telemetry-consequences-of-disabling-telemetry.adoc @@ -5,7 +5,7 @@ [id="telemetry-consequences-of-disabling-telemetry_{context}"] = Consequences of disabling remote health reporting -In {product-title}, customers can opt out of reporting usage information. However, connected clusters allow Red Hat to react more quickly to problems and better support our customers, as well as better understand how product upgrades impact clusters. Connected clusters also help to simplify the subscription and entitlement process and enable the {cloud-redhat-com} service to provide an overview of your clusters and their subscription status. +In {product-title}, customers can opt out of reporting usage information. However, connected clusters allow Red Hat to react more quickly to problems and better support our customers, as well as better understand how product upgrades impact clusters. Connected clusters also help to simplify the subscription and entitlement process and enable the {console-redhat-com} service to provide an overview of your clusters and their subscription status. Red Hat strongly recommends leaving health and usage reporting enabled for pre-production and test clusters even if it is necessary to opt out for production clusters. This allows Red Hat to be a participant in qualifying {product-title} in your environments and react more rapidly to product issues. @@ -13,7 +13,7 @@ Some of the consequences of opting out of having a connected cluster are: * Red Hat will not be able to monitor the success of product upgrades or the health of your clusters without a support case being opened. * Red Hat will not be able to use configuration data to better triage customer support cases and identify which configurations our customers find important. -* The {cloud-redhat-com} will not show data about your clusters including health and usage information. +* The {console-redhat-com} will not show data about your clusters including health and usage information. ifndef::openshift-origin[] * Your subscription entitlement information must be manually entered via console.redhat.com without the benefit of automatic usage reporting. endif::[] diff --git a/modules/understanding-admin-roles.adoc b/modules/understanding-admin-roles.adoc index 12aa1445f9..3a932863fc 100644 --- a/modules/understanding-admin-roles.adoc +++ b/modules/understanding-admin-roles.adoc @@ -7,7 +7,7 @@ = Understanding administration roles == The cluster-admin role -As an administrator of an {product-title} cluster with Customer Cloud Subscriptions (CCS), you have access to the `cluster-admin` role. The user who created the cluster can add the `cluster-admin` user role to an account to have the maximum administrator privileges. These privileges are not automatically assigned to your user account when you create the cluster. While logged in to an account with the cluster-admin role, users have mostly unrestricted access to control and configure the cluster. There are some configurations that are blocked with webhooks to prevent destabilizing the cluster, or because they are managed in {cloud-redhat-com} and any in-cluster changes would be overwritten. Usage of the cluster-admin role is subject to the restrictions listed in your Appendix 4 agreement with Red Hat. As a best practice, limit the number of `cluster-admin` users to as few as possible. +As an administrator of an {product-title} cluster with Customer Cloud Subscriptions (CCS), you have access to the `cluster-admin` role. The user who created the cluster can add the `cluster-admin` user role to an account to have the maximum administrator privileges. These privileges are not automatically assigned to your user account when you create the cluster. While logged in to an account with the cluster-admin role, users have mostly unrestricted access to control and configure the cluster. There are some configurations that are blocked with webhooks to prevent destabilizing the cluster, or because they are managed in {console-redhat-com} and any in-cluster changes would be overwritten. Usage of the cluster-admin role is subject to the restrictions listed in your Appendix 4 agreement with Red Hat. As a best practice, limit the number of `cluster-admin` users to as few as possible. == The dedicated-admin role diff --git a/modules/update-service-mirror-release.adoc b/modules/update-service-mirror-release.adoc index dae4cae04c..1a2aa34b0f 100644 --- a/modules/update-service-mirror-release.adoc +++ b/modules/update-service-mirror-release.adoc @@ -15,7 +15,7 @@ To avoid excessive memory usage by the OpenShift Update Service application, it * You configured a mirror registry to use in your restricted network and can access the certificate and credentials that you configured. ifndef::openshift-origin[] * You downloaded the pull secret from the -link:https://console.redhat.com/openshift/install/pull-secret[Pull Secret] page on the {cloud-redhat-com} site and modified it to include authentication to your mirror repository. +link:https://console.redhat.com/openshift/install/pull-secret[Pull Secret] page on the {console-redhat-com} site and modified it to include authentication to your mirror repository. endif::[] ifdef::openshift-origin[] * You have created a pull secret for your mirror repository. diff --git a/openshift_images/managing_images/using-image-pull-secrets.adoc b/openshift_images/managing_images/using-image-pull-secrets.adoc index cd3cbe26b5..dfd9ce016a 100644 --- a/openshift_images/managing_images/using-image-pull-secrets.adoc +++ b/openshift_images/managing_images/using-image-pull-secrets.adoc @@ -9,7 +9,7 @@ If you are using the {product-title} internal registry and are pulling from imag However, for other scenarios, such as referencing images across {product-title} projects or from secured registries, then additional configuration steps are required. -You can obtain the image pull secret, `pullSecret`, from the link:https://console.redhat.com/openshift/install/pull-secret[Pull Secret] page on the {cloud-redhat-com} site. +You can obtain the image pull secret, `pullSecret`, from the link:https://console.redhat.com/openshift/install/pull-secret[Pull Secret] page on the {console-redhat-com} site. You use this pull secret to authenticate with the services that are provided by the included authorities, including link:quay.io[Quay.io] and link:registry.redhat.io[registry.redhat.io], which serve the container images for {product-title} components. diff --git a/support/remote_health_monitoring/insights-operator-simple-access.adoc b/support/remote_health_monitoring/insights-operator-simple-access.adoc index 603e7882d9..fa43c63df5 100644 --- a/support/remote_health_monitoring/insights-operator-simple-access.adoc +++ b/support/remote_health_monitoring/insights-operator-simple-access.adoc @@ -6,11 +6,11 @@ include::modules/common-attributes.adoc[] toc::[] -Insights Operator can import your RHEL Simple Content Access (SCA) certificates from {cloud-redhat-com}. SCA is a capability in Red Hat’s subscription tools which simplifies the behavior of the entitlement tooling. It is easier to consume the content provided by your Red Hat subscriptions without the complexity of configuring subscription tooling. After importing the certificates, they are stored in the `etc-pki-entitlement` secret in the `openshift-config-managed` namespace. +Insights Operator can import your RHEL Simple Content Access (SCA) certificates from {console-redhat-com}. SCA is a capability in Red Hat’s subscription tools which simplifies the behavior of the entitlement tooling. It is easier to consume the content provided by your Red Hat subscriptions without the complexity of configuring subscription tooling. After importing the certificates, they are stored in the `etc-pki-entitlement` secret in the `openshift-config-managed` namespace. -Insights Operator imports SCA certificates every 8 hours by default, but can be configured or disabled using the `support` secret in the `openshift-config` namespace. +Insights Operator imports SCA certificates every 8 hours by default, but can be configured or disabled using the `support` secret in the `openshift-config` namespace. -In {product-title} 4.9, this feature is in Technology Preview and must be enabled using the `TechPreviewNoUpgrade` Feature Set. See xref:../../nodes/clusters/nodes-cluster-enabling-features.adoc[_Enabling OpenShift Container Platform features using FeatureGates_] for more information. +In {product-title} 4.9, this feature is in Technology Preview and must be enabled using the `TechPreviewNoUpgrade` Feature Set. See xref:../../nodes/clusters/nodes-cluster-enabling-features.adoc[_Enabling OpenShift Container Platform features using FeatureGates_] for more information. For more information about Simple Content Access certificates see the link:https://access.redhat.com/articles/simple-content-access[_Simple Content Access_] article in the Red Hat Knowledgebase. diff --git a/support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc b/support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc index 72a379c27c..fef8583297 100644 --- a/support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc +++ b/support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc @@ -8,7 +8,7 @@ endif::[] toc::[] -Insights repeatedly analyzes the data Insights Operator sends. Users of {product-title} can display the report on the *Insights* tab of each cluster in {cloud-redhat-com}. +Insights repeatedly analyzes the data Insights Operator sends. Users of {product-title} can display the report on the *Insights* tab of each cluster in {console-redhat-com}. include::modules/displaying-potential-issues-with-your-cluster.adoc[leveloffset=+1] include::modules/displaying-the-insights-status-in-the-web-console.adoc[leveloffset=+1] diff --git a/upgrading/rosa-upgrading-sts.adoc b/upgrading/rosa-upgrading-sts.adoc index 609ba276ba..71058cf2e1 100644 --- a/upgrading/rosa-upgrading-sts.adoc +++ b/upgrading/rosa-upgrading-sts.adoc @@ -18,7 +18,7 @@ include::modules/rosa-upgrading-preparing-4-7-to-4-8.adoc[leveloffset=+1] There are two methods to upgrade {product-title} (ROSA) clusters that uses the AWS Security Token Service (STS): * Manual upgrades through the `rosa` CLI -* Manual upgrades through the {cloud-redhat-com} console +* Manual upgrades through the {console-redhat-com} console [NOTE] ==== diff --git a/upgrading/rosa-upgrading.adoc b/upgrading/rosa-upgrading.adoc index bbabdde5cd..a3addc305d 100644 --- a/upgrading/rosa-upgrading.adoc +++ b/upgrading/rosa-upgrading.adoc @@ -15,8 +15,8 @@ To plan an upgrade, review the xref:../rosa_policy/rosa-life-cycle.adoc#rosa-lif There are three methods to upgrade {product-title} (ROSA) clusters: * Manual upgrades through the `rosa` CLI -* Manual upgrades through the {cloud-redhat-com} console -* Automatic upgrades through the {cloud-redhat-com} console +* Manual upgrades through the {console-redhat-com} console +* Automatic upgrades through the {console-redhat-com} console [NOTE] ====