Merge pull request #37882 from jeana-redhat/OSDOCS-CI-CCO-updates

jeana-redhat · web-flow · commit dea6bf688161 · 2021-10-27T14:40:43.000-04:00
OSDOCS cont improvement CCO updates: multiple tickets and a BZ for STS content
diff --git a/installing/installing_azure/installing-azure-account.adoc b/installing/installing_azure/installing-azure-account.adoc
@@ -27,6 +27,10 @@ include::modules/installation-azure-permissions.adoc[leveloffset=+1]
 
 include::modules/installation-azure-service-principal.adoc[leveloffset=+1]
 
+.Additional resources
+
+* For more information about CCO modes, see xref:../../authentication/managing_cloud_provider_credentials/about-cloud-credential-operator.adoc#about-cloud-credential-operator-modes[About the Cloud Credential Operator].
+
 include::modules/installation-azure-regions.adoc[leveloffset=+1]
 
 == Next steps
diff --git a/installing/installing_azure/installing-azure-user-infra.adoc b/installing/installing_azure/installing-azure-user-infra.adoc
@@ -54,6 +54,11 @@ Because your cluster has limited access to automatic machine management when you
 
 include::modules/installation-azure-permissions.adoc[leveloffset=+2]
 include::modules/installation-azure-service-principal.adoc[leveloffset=+2]
+
+.Additional resources
+
+* For more information about CCO modes, see xref:../../authentication/managing_cloud_provider_credentials/about-cloud-credential-operator.adoc#about-cloud-credential-operator-modes[About the Cloud Credential Operator].
+
 include::modules/installation-azure-regions.adoc[leveloffset=+2]
 
 include::modules/installation-obtaining-installer.adoc[leveloffset=+1]
diff --git a/installing/installing_azure_stack_hub/installing-azure-stack-hub-account.adoc b/installing/installing_azure_stack_hub/installing-azure-stack-hub-account.adoc
@@ -20,6 +20,10 @@ include::modules/installation-azure-stack-hub-permissions.adoc[leveloffset=+1]
 
 include::modules/installation-azure-service-principal.adoc[leveloffset=+1]
 
+.Additional resources
+
+* For more information about CCO modes, see xref:../../authentication/managing_cloud_provider_credentials/about-cloud-credential-operator.adoc#about-cloud-credential-operator-modes[About the Cloud Credential Operator].
+
 [id="next-steps_installing-azure-stack-hub-account"]
 == Next steps
 
diff --git a/installing/installing_azure_stack_hub/installing-azure-stack-hub-user-infra.adoc b/installing/installing_azure_stack_hub/installing-azure-stack-hub-user-infra.adoc
@@ -58,6 +58,10 @@ Because your cluster has limited access to automatic machine management when you
 include::modules/installation-azure-stack-hub-permissions.adoc[leveloffset=+2]
 include::modules/installation-azure-service-principal.adoc[leveloffset=+2]
 
+.Additional resources
+
+* For more information about CCO modes, see xref:../../authentication/managing_cloud_provider_credentials/about-cloud-credential-operator.adoc#about-cloud-credential-operator-modes[About the Cloud Credential Operator].
+
 include::modules/installation-obtaining-installer.adoc[leveloffset=+1]
 
 include::modules/ssh-agent-using.adoc[leveloffset=+1]
diff --git a/modules/cco-ccoctl-configuring.adoc b/modules/cco-ccoctl-configuring.adoc
@@ -24,6 +24,11 @@ The `ccoctl` is a Linux binary that must run in a Linux environment.
 ----
 $ CCO_IMAGE=$(oc adm release info --image-for='cloud-credential-operator' $RELEASE_IMAGE)
 ----
++
+[NOTE]
+====
+Ensure that the architecture of the `$RELEASE_IMAGE` matches the architecture of the environment in which you will use the `ccoctl` tool.
+====
 
 . Extract the `ccoctl` binary from the CCO container image within the {product-title} release image:
 +
diff --git a/modules/installation-azure-service-principal.adoc b/modules/installation-azure-service-principal.adoc
@@ -209,7 +209,7 @@ ifndef::ash[]
 ** To operate the CCO in _passthrough mode_, the app registration service principal does not require additional API permissions.
 --
 +
-For more information about CCO modes, see the *Cloud Credential Operator* entry in the *Red Hat Operators reference* content.
+For more information about CCO modes, see "About the Cloud Credential Operator" in the "Managing cloud provider credentials" section of the _Authentication and authorization_ guide.
 +
 [NOTE]
 ====
diff --git a/modules/manually-create-identity-access-management.adoc b/modules/manually-create-identity-access-management.adoc
@@ -30,6 +30,8 @@ administrator-level credential secret in the cluster `kube-system` namespace.
 ----
 $ openshift-install create install-config --dir=<installation_directory>
 ----
++
+where `<installation_directory>` is the directory in which the installation program creates files.
 
 . Edit the `install-config.yaml` configuration file so that it contains the `credentialsMode` parameter set to `Manual`.
 +
@@ -50,10 +52,8 @@ compute:
 +
 [source,terminal]
 ----
-$ openshift-install create manifests --dir=<installation_directory> <1>
+$ openshift-install create manifests --dir=<installation_directory>
 ----
-<1> For `<installation_directory>`, specify the directory name to store the
-files that the installation program creates.
 
 . From the directory that contains the installation program, obtain details of the {product-title} release image that your `openshift-install` binary is built to use:
 +
@@ -172,5 +172,5 @@ $ openshift-install create cluster --dir=<installation_directory>
 +
 [IMPORTANT]
 ====
-Before upgrading a cluster that uses manually maintained credentials, you must ensure that the CCO is in an upgradeable state. For details, see the _Upgrading clusters with manually maintained credentials_ section of the installation content for your cloud provider.
+Before upgrading a cluster that uses manually maintained credentials, you must ensure that the CCO is in an upgradeable state. For details, see the "Upgrading clusters with manually maintained credentials" section of the installation content for your cloud provider.
 ====
diff --git a/modules/manually-maintained-credentials-upgrade.adoc b/modules/manually-maintained-credentials-upgrade.adoc
@@ -21,7 +21,7 @@ Before upgrading a cluster with manually maintained credentials, you must create
 
 . Extract and examine the `CredentialsRequest` custom resource for the new release.
 +
-The _Manually creating IAM_ section of the installation content for your cloud provider explains how to obtain and use the credentials required for your cloud.
+The "Manually creating IAM" section of the installation content for your cloud provider explains how to obtain and use the credentials required for your cloud.
 
 . Update the manually maintained credentials on your cluster:
 
diff --git a/modules/sts-mode-installing-manual-run-installer.adoc b/modules/sts-mode-installing-manual-run-installer.adoc
@@ -7,16 +7,33 @@
 
 .Prerequisites
 
-* Create the `install-config.yaml` file for your installation.
+* Obtain the {product-title} release image.
 
 .Procedure
 
-. From the installation directory that contains your `install-config.yaml` file, configure the  Cloud Credential Operator (CCO) to run in manual mode:
+. Change to the directory that contains the installation program and create the `install-config.yaml` file:
 +
 [source,terminal]
 ----
-$ echo “credentialsMode: Manual” >> install-config.yaml
+$ openshift-install create install-config --dir=<installation_directory>
 ----
++
+where `<installation_directory>` is the directory in which the installation program creates files.
+
+. Edit the `install-config.yaml` configuration file so that it contains the `credentialsMode` parameter set to `Manual`.
++
+.Example `install-config.yaml` configuration file
+[source,yaml]
+----
+apiVersion: v1
+baseDomain: cluster1.example.com
+credentialsMode: Manual <1>
+compute:
+- architecture: amd64
+  hyperthreading: Enabled
+...
+----
+<1> This line is added to set the `credentialsMode` parameter to `Manual`.
 
 . Create the required {product-title} installation manifests:
 +

Original file line number	Diff line number	Diff line change
`@@ -209,7 +209,7 @@ ifndef::ash[]`
`209`	`209`	`** To operate the CCO in _passthrough mode_, the app registration service principal does not require additional API permissions.`
`210`	`210`	`--`
`211`	`211`	`+`
`212`		`-For more information about CCO modes, see the Cloud Credential Operator entry in the Red Hat Operators reference content.`
	`212`	`+For more information about CCO modes, see "About the Cloud Credential Operator" in the "Managing cloud provider credentials" section of the _Authentication and authorization_ guide.`
`213`	`213`	`+`
`214`	`214`	`[NOTE]`
`215`	`215`	`====`
Original file line number	Diff line number	Diff line change
@@ -30,6 +30,8 @@ administrator-level credential secret in the cluster `kube-system` namespace.
`30`	`30`	`----`
`31`	`31`	`$ openshift-install create install-config --dir=<installation_directory>`
`32`	`32`	`----`
	`33`	`++`
	`34`	+where `<installation_directory>` is the directory in which the installation program creates files.
`33`	`35`
`34`	`36`	. Edit the `install-config.yaml` configuration file so that it contains the `credentialsMode` parameter set to `Manual`.
`35`	`37`	`+`
`@@ -50,10 +52,8 @@ compute:`
`50`	`52`	`+`
`51`	`53`	`[source,terminal]`
`52`	`54`	`----`
`53`		`-$ openshift-install create manifests --dir=<installation_directory> <1>`
	`55`	`+$ openshift-install create manifests --dir=<installation_directory>`
`54`	`56`	`----`
`55`		-<1> For `<installation_directory>`, specify the directory name to store the
`56`		`-files that the installation program creates.`
`57`	`57`
`58`	`58`	. From the directory that contains the installation program, obtain details of the {product-title} release image that your `openshift-install` binary is built to use:
`59`	`59`	`+`
`@@ -172,5 +172,5 @@ $ openshift-install create cluster --dir=<installation_directory>`
`172`	`172`	`+`
`173`	`173`	`[IMPORTANT]`
`174`	`174`	`====`
`175`		`-Before upgrading a cluster that uses manually maintained credentials, you must ensure that the CCO is in an upgradeable state. For details, see the _Upgrading clusters with manually maintained credentials_ section of the installation content for your cloud provider.`
	`175`	`+Before upgrading a cluster that uses manually maintained credentials, you must ensure that the CCO is in an upgradeable state. For details, see the "Upgrading clusters with manually maintained credentials" section of the installation content for your cloud provider.`
`176`	`176`	`====`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ Before upgrading a cluster with manually maintained credentials, you must create`
`21`	`21`
`22`	`22`	. Extract and examine the `CredentialsRequest` custom resource for the new release.
`23`	`23`	`+`
`24`		`-The _Manually creating IAM_ section of the installation content for your cloud provider explains how to obtain and use the credentials required for your cloud.`
	`24`	`+The "Manually creating IAM" section of the installation content for your cloud provider explains how to obtain and use the credentials required for your cloud.`
`25`	`25`
`26`	`26`	`. Update the manually maintained credentials on your cluster:`
`27`	`27`