From 3404bdb5568f4913d7d0ca8e070922c081d821fb Mon Sep 17 00:00:00 2001 From: Jeana Routh <61474374+jeana-redhat@users.noreply.github.com> Date: Wed, 15 Jan 2025 13:47:51 -0500 Subject: [PATCH] Revert "Revert "OCPBUGS-48192: clarifying the role of the root cred in CCO mint mode"" --- .../cco-mode-mint.adoc | 9 +++++++-- modules/manually-removing-cloud-creds.adoc | 14 ++++++++++---- .../changing-cloud-credentials-configuration.adoc | 5 +++-- 3 files changed, 20 insertions(+), 8 deletions(-) diff --git a/authentication/managing_cloud_provider_credentials/cco-mode-mint.adoc b/authentication/managing_cloud_provider_credentials/cco-mode-mint.adoc index 5a6c8d2a5580..db3c5ecae040 100644 --- a/authentication/managing_cloud_provider_credentials/cco-mode-mint.adoc +++ b/authentication/managing_cloud_provider_credentials/cco-mode-mint.adoc @@ -11,9 +11,14 @@ Mint mode is the default Cloud Credential Operator (CCO) credentials mode for {p [id="mint-mode-about"] == Mint mode credentials management -For clusters that use the CCO in mint mode, the administrator-level credential is stored in the `kube-system` namespace. The CCO uses the `admin` credential to process the `CredentialsRequest` objects in the cluster and create users for components with limited permissions. +For clusters that use the CCO in mint mode, the administrator-level credential is stored in the `kube-system` namespace. +The CCO uses the `admin` credential to process the `CredentialsRequest` objects in the cluster and create users for components with limited permissions. -With mint mode, each cluster component has only the specific permissions it requires. The automatic, continuous reconciliation of cloud credentials in mint mode allows actions that require additional credentials or permissions, such as upgrading, to proceed. +With mint mode, each cluster component has only the specific permissions it requires. +Cloud credential reconciliation is automatic and continuous so that components can perform actions that require additional credentials or permissions. + +For example, a minor version cluster update (such as updating from {product-title} 4.16 to 4.17) might include an updated `CredentialsRequest` resource for a cluster component. +The CCO, operating in mint mode, uses the `admin` credential to process the `CredentialsRequest` resource and create users with limited permissions to satisfy the updated authentication requirements. [NOTE] ==== diff --git a/modules/manually-removing-cloud-creds.adoc b/modules/manually-removing-cloud-creds.adoc index b5793afe65dd..5d4b5c6e1ea2 100644 --- a/modules/manually-removing-cloud-creds.adoc +++ b/modules/manually-removing-cloud-creds.adoc @@ -1,21 +1,27 @@ // Module included in the following assemblies: // -// * post_installation_configuration/cluster-tasks.adoc +// * post_installation_configuration/changing-cloud-credentials-configuration.adoc :_mod-docs-content-type: PROCEDURE [id="manually-removing-cloud-creds_{context}"] = Removing cloud provider credentials -After installing an {product-title} cluster with the Cloud Credential Operator (CCO) in mint mode, you can remove the administrator-level credential secret from the `kube-system` namespace in the cluster. The administrator-level credential is required only during changes that require its elevated permissions, such as upgrades. +For clusters that use the Cloud Credential Operator (CCO) in mint mode, the administrator-level credential is stored in the `kube-system` namespace. +The CCO uses the `admin` credential to process the `CredentialsRequest` objects in the cluster and create users for components with limited permissions. + +After installing an {product-title} cluster with the CCO in mint mode, you can remove the administrator-level credential secret from the `kube-system` namespace in the cluster. +The CCO only requires the administrator-level credential during changes that require reconciling new or modified `CredentialsRequest` custom resources, such as minor cluster version updates. [NOTE] ==== -Prior to a non z-stream upgrade, you must reinstate the credential secret with the administrator-level credential. If the credential is not present, the upgrade might be blocked. +Before performing a minor version cluster update (for example, updating from {product-title} 4.16 to 4.17), you must reinstate the credential secret with the administrator-level credential. +If the credential is not present, the update might be blocked. ==== .Prerequisites -* Your cluster is installed on a platform that supports removing cloud credentials from the CCO. Supported platforms are AWS and GCP. +* Your cluster is installed on a platform that supports removing cloud credentials from the CCO. +Supported platforms are AWS and GCP. .Procedure diff --git a/post_installation_configuration/changing-cloud-credentials-configuration.adoc b/post_installation_configuration/changing-cloud-credentials-configuration.adoc index 7211dd01dbab..7e1b0f47e08a 100644 --- a/post_installation_configuration/changing-cloud-credentials-configuration.adoc +++ b/post_installation_configuration/changing-cloud-credentials-configuration.adoc @@ -31,15 +31,16 @@ include::modules/manually-rotating-cloud-creds.adoc[leveloffset=+2] [role="_additional-resources"] .Additional resources +* xref:../authentication/managing_cloud_provider_credentials/cco-mode-mint.adoc#cco-mode-mint[The Cloud Credential Operator in mint mode] +* xref:../authentication/managing_cloud_provider_credentials/cco-mode-passthrough.html#cco-mode-passthrough[The Cloud Credential Operator in passthrough mode] * xref:../storage/container_storage_interface/persistent-storage-csi-vsphere.adoc#persistent-storage-csi-vsphere[vSphere CSI Driver Operator] //Removing cloud provider credentials manually include::modules/manually-removing-cloud-creds.adoc[leveloffset=+2] -//These additional resources are for the "Rotating or removing cloud provider credentials" section, do not separate them from that content. [role="_additional-resources"] .Additional resources -* xref:../authentication/managing_cloud_provider_credentials/cco-mode-passthrough.adoc#admin-credentials-root-secret-formats_cco-mode-passthrough[Admin credentials root secret format] +* xref:../authentication/managing_cloud_provider_credentials/cco-mode-mint.adoc#cco-mode-mint[The Cloud Credential Operator in mint mode] [id="post-install-enable-token-auth_{context}"] == Enabling token-based authentication