Skip to content

Commit

Permalink
OSS-Docs-32: Removed instances of OCM
Browse files Browse the repository at this point in the history
  • Loading branch information
EricPonvelle committed Mar 3, 2022
1 parent db2a2d4 commit c3b9473
Show file tree
Hide file tree
Showing 163 changed files with 401 additions and 400 deletions.
6 changes: 4 additions & 2 deletions _attributes/attributes-openshift-dedicated.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,10 @@
:experimental:
:imagesdir: images
:OCP: OpenShift Container Platform
:OCM: OpenShift Cluster Manager (OCM)
:console-redhat-com: link:https://console.redhat.com/openshift[OpenShift Cluster Manager (OCM)]
:cluster-manager-first: Red Hat OpenShift Cluster Manager
:cluster-manager: OpenShift Cluster Manager
:cluster-manager-url: link:https://console.redhat.com/openshift[OpenShift Cluster Manager]
:cluster-manager-url-pull: link:https://console.redhat.com/openshift/install/pull-secret[pull secret from the Red Hat OpenShift Cluster Manager]
:AWS: Amazon Web Services (AWS)
:GCP: Google Cloud Platform (GCP)
:kebab: image:kebab.png[title="Options menu"]
5 changes: 4 additions & 1 deletion _attributes/common-attributes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,10 @@ endif::[]
:kebab: image:kebab.png[title="Options menu"]
:rh-openstack-first: Red Hat OpenStack Platform (RHOSP)
:rh-openstack: RHOSP
:console-redhat-com: Red Hat OpenShift Cluster Manager
:cluster-manager-first: Red Hat OpenShift Cluster Manager
:cluster-manager: OpenShift Cluster Manager
:cluster-manager-url: link:https://console.redhat.com/openshift[OpenShift Cluster Manager]
:cluster-manager-url-pull: link:https://console.redhat.com/openshift/install/pull-secret[pull secret from the 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)
Expand Down
4 changes: 2 additions & 2 deletions _attributes/distr-tracing-document-attributes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
//
:product-title: OpenShift Container Platform
:product-dedicated: Red Hat OpenShift Dedicated
:console-redhat-com: Red Hat OpenShift Cluster Manager
:cluster-manager-first: Red Hat OpenShift Cluster Manager

:ProductName: Red Hat OpenShift Service Mesh

Expand All @@ -28,7 +28,7 @@

:product-build:
:DownloadURL: registry.redhat.io
:cloud-redhat-com: Red Hat OpenShift Cluster Manager
:cluster-manager-first: Red Hat OpenShift Cluster Manager
:kebab: image:kebab.png[title="Options menu"]
//
// Documentation publishing attributes used in the master-docinfo.xml file
Expand Down
2 changes: 1 addition & 1 deletion _attributes/jaeger-document-attributes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
:ProductVersion: 1.24.0
:product-build:
:DownloadURL: registry.redhat.io
:console-redhat-com: Red Hat OpenShift Cluster Manager
:cluster-manager-first: Red Hat OpenShift Cluster Manager
:kebab: image:kebab.png[title="Options menu"]
//
// Documentation publishing attributes used in the master-docinfo.xml file
Expand Down
2 changes: 1 addition & 1 deletion _attributes/ossm-document-attributes-1x.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
:MaistraVersion: 1.1
:product-build:
:DownloadURL: registry.redhat.io
:console-redhat-com: Red Hat OpenShift Cluster Manager
:cluster-manager-first: Red Hat OpenShift Cluster Manager
:kebab: image:kebab.png[title="Options menu"]
//
// Documentation publishing attributes used in the master-docinfo.xml file
Expand Down
2 changes: 1 addition & 1 deletion _attributes/ossm-document-attributes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
:toc-title:
:experimental:
:DownloadURL: registry.redhat.io
:console-redhat-com: Red Hat OpenShift Cluster Manager
:cluster-manager-first: Red Hat OpenShift Cluster Manager
:kebab: image:kebab.png[title="Options menu"]

// Service Mesh product content attributes, that is, substitution variables in the files.
Expand Down
4 changes: 2 additions & 2 deletions _topic_maps/_topic_map_osd.yml
Original file line number Diff line number Diff line change
Expand Up @@ -54,11 +54,11 @@ Topics:
- Name: Getting started with OpenShift Dedicated
File: osd-quickstart
---
Name: Red Hat OpenShift Cluster Manager (OCM)
Name: Red Hat OpenShift Cluster Manager
Dir: ocm
Distros: openshift-dedicated
Topics:
- Name: Red Hat OpenShift Cluster Manager (OCM)
- Name: Red Hat OpenShift Cluster Manager
File: ocm-overview
---
Name: Creating a cluster
Expand Down
4 changes: 2 additions & 2 deletions _topic_maps/_topic_map_rosa.yml
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ Topics:
File: rosa-sts-interactive-mode-reference
- Name: Accessing a ROSA cluster
File: rosa-sts-accessing-cluster
- Name: Configuring identity providers using the OCM console
- Name: Configuring identity providers
File: rosa-sts-config-identity-providers
- Name: Revoking access to a ROSA cluster
File: rosa-sts-deleting-access-cluster
Expand All @@ -108,7 +108,7 @@ Topics:
File: rosa-aws-privatelink-creating-cluster
- Name: Accessing a ROSA cluster
File: rosa-accessing-cluster
- Name: Configuring identity providers using the OCM console
- Name: Configuring identity providers
File: rosa-config-identity-providers
- Name: Deleting access to a ROSA cluster
File: rosa-deleting-access-cluster
Expand Down
2 changes: 1 addition & 1 deletion adding_service_cluster/adding-service.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:_content-type: ASSEMBLY
include::_attributes/attributes-openshift-dedicated.adoc[]
[id="adding-service"]
= Adding services to a cluster using the OCM console
= Adding services to a cluster using {cluster-manager-first} console
:context: adding-service

toc::[]
Expand Down
2 changes: 1 addition & 1 deletion adding_service_cluster/available-services.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ include::_attributes/attributes-openshift-dedicated.adoc[]

toc::[]

You can add services to your existing {product-title} cluster using the xref:../adding_service_cluster/adding-service.adoc#adding-service[OpenShift Cluster Manager console].
You can add services to your existing {product-title} cluster using the xref:../adding_service_cluster/adding-service.adoc#adding-service[{cluster-manager-first} console].

include::modules/codeready-workspaces.adoc[leveloffset=+1]
include::modules/osd-rhoam.adoc[leveloffset=+1]
2 changes: 1 addition & 1 deletion adding_service_cluster/rosa-available-services.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ include::_attributes/attributes-openshift-dedicated.adoc[]
:context: rosa-available-services


You can add services to your existing {product-title} (ROSA) cluster using the xref:../adding_service_cluster/adding-service.adoc#adding-service[OpenShift Cluster Manager console].
You can add services to your existing {product-title} (ROSA) cluster using the xref:../adding_service_cluster/adding-service.adoc#adding-service[{cluster-manager-first} console].

These services can also be installed xref:../rosa_cli/rosa-manage-objects-cli.adoc#rosa-managing-objects-cli[using the `rosa` CLI].

Expand Down
2 changes: 1 addition & 1 deletion cicd/pipelines/installing-pipelines.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This guide walks cluster administrators through the process of installing the {p
* You have installed xref:../../cli_reference/tkn_cli/installing-tkn.adoc#installing-tkn[OpenShift Pipelines (`tkn`) CLI] on your local system.

ifdef::openshift-origin[]
* Ensure that you have downloaded the link:https://console.redhat.com/openshift/install/pull-secret[pull secret from the Red Hat OpenShift Cluster Manager site] as shown in the xref:../../installing/installing_gcp/installing-gcp-customizations.adoc#installation-obtaining-installer_installing-gcp-customizations[Obtaining the installation program] to install this Operator.
* Ensure that you have downloaded the {cluster-manager-url-pull} as shown in the xref:../../installing/installing_gcp/installing-gcp-customizations.adoc#installation-obtaining-installer_installing-gcp-customizations[Obtaining the installation program] to install this Operator.
+
If you have the pull secret, add the `redhat-operators` catalog to the OperatorHub custom resource (CR) as shown in xref:../../post_installation_configuration/preparing-for-users.adoc#olm-installing-operators-from-operatorhub-configure_post-install-preparing-for-users[Configuring {product-title} to use Red Hat Operators].
endif::[]
Expand Down
2 changes: 1 addition & 1 deletion cloud_infrastructure_access/dedicated-aws-access.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ It is not recommended to set a permissions boundary.
. Gather the IAM user's Amazon Resource Name (ARN). The ARN will have the following format: `arn:aws:iam::000111222333:user/username`.

[id=dedicated-aws-ocm-iam-role]
=== Granting the IAM role from the OpenShift Cluster Manager
=== Granting the IAM role from {cluster-manager-first}

.Procedure

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ toc::[]

An {product-title} cluster can be made private so that internal applications can be hosted inside a corporate network. In addition, private clusters can be configured to have only internal API endpoints for increased security.

{product-title} administrators can choose between public and private cluster configuration from within the *OpenShift Cluster Manager* (OCM). Privacy settings can be configured during cluster creation or after a cluster is established.
{product-title} administrators can choose between public and private cluster configuration from within *{cluster-manager}*. Privacy settings can be configured during cluster creation or after a cluster is established.

include::modules/dedicated-enable-private-cluster-new.adoc[leveloffset=+1]

Expand Down
2 changes: 1 addition & 1 deletion cloud_infrastructure_access/rosa-private-cluster.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ toc::[]

A {product-title} cluster can be made private so that internal applications can be hosted inside a corporate network. In addition, private clusters can be configured to have only internal API endpoints for increased security.

// {product-title} administrators can choose between public and private cluster configuration from within the *OpenShift Cluster Manager* (OCM).
// {product-title} administrators can choose between public and private cluster configuration from within *{cluster-manager}*.

Privacy settings can be configured during cluster creation or after a cluster is established.
////
Expand Down
3 changes: 2 additions & 1 deletion contributing_to_docs/doc_guidelines.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -482,9 +482,10 @@ If it makes more sense in context to refer to the major version of the product i

[NOTE]
====
Other common attribute values are defined in the `_attributes/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. If you need to add an attribute to the `_attributes/common-attributes.adoc` file, open a pull request to add it to the attribute list. Do not create a separate attributes file without first consulting the docs team.
Other common attribute values are defined in the `_attributes/common-attributes.adoc` file. Where possible, generalize references to those values by using the common attributes. For example, use `{cluster-manager-first}` to refer to Red Hat OpenShift Cluster Manager. If you need to add an attribute to the `_attributes/common-attributes.adoc` file, open a pull request to add it to the attribute list. Do not create a separate attributes file without first consulting the docs team.
====

//CANARY
[id="conditional-content"]
== Conditional content

Expand Down
2 changes: 1 addition & 1 deletion installing/validating-an-installation.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ include::modules/querying-the-status-of-cluster-nodes-using-the-cli.adoc[levelof
//Reviewing the cluster status from the OpenShift Container Platform web console
include::modules/reviewing-cluster-status-from-the-openshift-web-console.adoc[leveloffset=+1]

//Reviewing the cluster status from the OpenShift Cluster Manager
//Reviewing the cluster status from {cluster-manager}
include::modules/reviewing-cluster-status-from-the-openshift-cluster-manager.adoc[leveloffset=+1]

[role="_additional-resources"]
Expand Down
10 changes: 7 additions & 3 deletions modules/access-cluster.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,22 @@
[id="access-cluster_{context}"]
= Accessing your cluster

After you have added a user to your configured identity provider, you can log in to your {product-title} cluster through the web console.
After you have configured your identity providers, users can access the cluster from {cluster-manager-first}.

.Prerequisites

* You logged in to {OCM}.
* You logged in to {cluster-manager-url}.
* You created an {product-title} cluster.
* You configured an identity provider for your cluster.
* You added your user account to the configured identity provider.
.Procedure

. Navigate to {console-redhat-com} and select your cluster.
. From {cluster-manager-url}, click on the cluster you want to access.

. Click *Open Console*.

. Click on your identity provider and provide your credentials to log into the cluster.

. Click *Open console* to open the web console for your cluster.

Expand Down
5 changes: 1 addition & 4 deletions modules/access-service.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,15 @@

= Accessing installed services on your cluster

// Should this be the OCM instead of "OpenShift console"?
After you successfully install a service on your cluster, you can access the service through the OpenShift console.


.Prerequisites

* You have successfully installed a service on your {product-title} cluster.


.Procedure

. Navigate to the *Clusters* page in link:https://cloud.redhat.com/openshift/[OpenShift Cluster Manager (OCM)].
. Navigate to the *Clusters* page in {cluster-manager-url}.

. Select the cluster with an installed service you want to access.

Expand Down
26 changes: 26 additions & 0 deletions modules/add-user.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
// Module included in the following assemblies:
//
// * assemblies/quickstart-osd.adoc

:_content-type: PROCEDURE
[id="add-user_{context}"]
= Adding a user


Administrator roles are managed using a `dedicated-admins` group on the cluster. You can add and remove users from {cluster-manager-first}.

.Procedure

. Navigate to the *Clusters* page and select the cluster you want to add users to.

. Click the *Access control* tab.

. Under the *Cluster administrative users* heading, click *Add User*.

. Enter the user ID you want to add.

. Click *Add user*.

.Verification

* You now see the user listed under the *Cluster administrative users* heading.
8 changes: 4 additions & 4 deletions modules/adding-service-existing.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,17 @@
= Adding a service to a cluster


You can add a service to an existing {product-title} cluster through the OpenShift Cluster Manager (OCM).
You can add a service to an existing {product-title} cluster through {cluster-manager-first}.


.Prerequisites

* You have created and provisioned a cluster for {product-title}.
* Your cluster meets all of the prerequisites for the service that you want to add on to your cluster.
* For paid add-on services, note the following considerations:
** If the organization has sufficient quota, and if the service is compatible with the cluster, the service appears in OCM.
** If the organization has sufficient quota, and if the service is compatible with the cluster, the service appears in {cluster-manager}.
** If the organization has never had quota, or if the cluster is not compatible, then the service does not display.
** If the organization had quota in the past, but the quota is currently `0`, the service is still visible but disabled in OCM until you get more quota.
** If the organization had quota in the past, but the quota is currently `0`, the service is still visible but disabled in {cluster-manager} until you get more quota.

// TODO: Could this just be one of the above prereqs instead of its own NOTE?
[NOTE]
Expand All @@ -28,7 +28,7 @@ To add a service to a cluster, you must be the cluster owner.

.Procedure

. Navigate to the *Clusters* page in link:https://cloud.redhat.com/openshift/[OCM].
. Navigate to the *Clusters* page in {cluster-manager-url}.

. Select the cluster you want to add a service to.

Expand Down
2 changes: 1 addition & 1 deletion modules/aws-cloudwatch.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

= Amazon CloudWatch

Amazon CloudWatch forwards logs from {product-title} (ROSA) to the AWS console for viewing. You must first install the ROSA `cluster-logging-operator` using the `rosa` CLI before installing the Amazon CloudWatch service through the OpenShift Cluster Manager (OCM) console.
Amazon CloudWatch forwards logs from {product-title} (ROSA) to the AWS console for viewing. You must first install the ROSA `cluster-logging-operator` using the `rosa` CLI before installing the Amazon CloudWatch service through {cluster-manager-first} console.

[role="_additional-resources"]
.Additional resources
Expand Down
2 changes: 1 addition & 1 deletion modules/aws-vpc.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ A Virtual Private Cloud (VPC) peering connection is a networking connection betw

[WARNING]
====
Private clusters cannot be fully deleted by the {OCM} if the VPC the cluster is installed in is peered.
Private clusters cannot be fully deleted by {cluster-manager-first} if the VPC the cluster is installed in is peered.
AWS supports inter-region VPC peering between all commercial regions link:https://aws.amazon.com/vpc/faqs/#Peering_Connections[excluding China].
====
Expand Down
2 changes: 1 addition & 1 deletion modules/ccs-aws-customer-procedure.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,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 {console-redhat-com}.
** You must provide the *access key ID* and *secret access key* in {cluster-manager-url}.
2 changes: 1 addition & 1 deletion modules/ccs-aws-customer-requirements.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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 {console-redhat-com} must not be directly performed in the customer-provided AWS account.
* Actions available in {cluster-manager-url} must not be directly performed in the customer-provided AWS account.

[id="ccs-requirements-support_{context}"]
== Support requirements
Expand Down
2 changes: 1 addition & 1 deletion modules/ccs-gcp-customer-procedure.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -105,4 +105,4 @@ The following roles must be link:https://cloud.google.com/iam/docs/granting-role

|===

. link:https://cloud.google.com/iam/docs/creating-managing-service-account-keys#creating_service_account_keys[Create the service account key] for the `osd-ccs-admin` IAM service account. Export the key to a file named `osServiceAccount.json`; this JSON file will be uploaded in {OCM} when you create your cluster.
. link:https://cloud.google.com/iam/docs/creating-managing-service-account-keys#creating_service_account_keys[Create the service account key] for the `osd-ccs-admin` IAM service account. Export the key to a file named `osServiceAccount.json`; this JSON file will be uploaded in {cluster-manager-first} when you create your cluster.
2 changes: 1 addition & 1 deletion modules/ccs-gcp-customer-requirements.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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 {console-redhat-com} must not be directly performed in the customer-provided GCP account.
* Actions available in the {cluster-manager-url} must not be directly performed in the customer-provided GCP account.

[id="ccs-gcp-requirements-support_{context}"]
== Support requirements
Expand Down
2 changes: 1 addition & 1 deletion modules/cluster-entitlements.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ your cluster.

You must have internet access to:

* 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 {cluster-manager-url} 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[]
Expand Down
2 changes: 1 addition & 1 deletion modules/cluster-logging-deploy-cli.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ If you use a local volume for persistent storage, do not use a raw block volume,
Elasticsearch is a memory-intensive application. By default, {product-title} installs three Elasticsearch nodes with memory requests and limits of 16 GB. This initial set of three {product-title} nodes might not have enough memory to run Elasticsearch within your cluster. If you experience memory issues that are related to Elasticsearch, add more Elasticsearch nodes to your cluster rather than increasing the memory on existing nodes.
ifdef::openshift-origin[]
* Ensure that you have downloaded the link:https://console.redhat.com/openshift/install/pull-secret[pull secret from the Red Hat OpenShift Cluster Manager site] as shown in _Obtaining the installation program_ in the installation documentation for your platform.
* Ensure that you have downloaded the {cluster-manager-url-pull} as shown in _Obtaining the installation program_ in the installation documentation for your platform.
+
If you have the pull secret, add the `redhat-operators` catalog to the OperatorHub custom resource (CR) as shown in *Configuring {product-title} to use Red Hat Operators*.
endif::[]
Expand Down
Loading

0 comments on commit c3b9473

Please sign in to comment.