Skip to content

Commit c501251

Browse files
authored
Merge pull request #41230 from jeana-redhat/OSDOCS-3132_Stop_mining_Azure_ServicePrincipals
OSDOCS-3132: Removing references to CCO mint mode on Azure for 4.10
2 parents 9e583a0 + bf297a8 commit c501251

File tree

6 files changed

+21
-40
lines changed

6 files changed

+21
-40
lines changed

authentication/managing_cloud_provider_credentials/about-cloud-credential-operator.adoc

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Mint mode is the default and recommended best practice setting for the CCO to us
4040

4141

4242
|Microsoft Azure
43-
|X ^[1]^
43+
|
4444
|X ^[1]^
4545
|X
4646

@@ -76,11 +76,6 @@ For platforms on which multiple modes are supported (AWS, Azure, and GCP), when
7676

7777
By default, the CCO determines whether the credentials are sufficient for mint mode, which is the preferred mode of operation, and uses those credentials to create appropriate credentials for components in the cluster. If the credentials are not sufficient for mint mode, it determines whether they are sufficient for passthrough mode. If the credentials are not sufficient for passthrough mode, the CCO cannot adequately process `CredentialsRequest` CRs.
7878

79-
[NOTE]
80-
====
81-
The CCO cannot verify whether Azure credentials are sufficient for passthrough mode. If Azure credentials are insufficient for mint mode, the CCO operates with the assumption that the credentials are sufficient for passthrough mode.
82-
====
83-
8479
If the provided credentials are determined to be insufficient during installation, the installation fails. For AWS, the installer fails early in the process and indicates which required permissions are missing. Other providers might not provide specific information about the cause of the error until errors are encountered.
8580

8681
If the credentials are changed after a successful installation and the CCO determines that the new credentials are insufficient, the CCO puts conditions on any new `CredentialsRequest` CRs to indicate that it cannot process them because of the insufficient credentials.

authentication/managing_cloud_provider_credentials/cco-mode-mint.adoc

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,13 @@ include::modules/common-attributes.adoc[]
66

77
toc::[]
88

9-
Mint mode is supported for Amazon Web Services (AWS), Microsoft Azure, and Google Cloud Platform (GCP).
9+
Mint mode is supported for Amazon Web Services (AWS) and Google Cloud Platform (GCP).
1010

11-
Mint mode is the default and recommended best practice setting for the Cloud Credential Operator (CCO) to use on the platforms for which it is supported. In this mode, the CCO uses the provided administrator-level cloud credential to create new credentials for components in the cluster with only the specific permissions that are required.
11+
Mint mode is the default mode on the platforms for which it is supported. In this mode, the Cloud Credential Operator (CCO) uses the provided administrator-level cloud credential to create new credentials for components in the cluster with only the specific permissions that are required.
1212

1313
If the credential is not removed after installation, it is stored and used by the CCO to process `CredentialsRequest` CRs for components in the cluster and create new credentials for each with only the specific permissions that are required. The continuous reconciliation of cloud credentials in mint mode allows actions that require additional credentials or permissions, such as upgrading, to proceed.
1414

15-
If the requirement that mint mode stores the administrator-level credential in the cluster `kube-system` namespace does not suit the security requirements of your organization, see _Alternatives to storing administrator-level secrets in the kube-system project_ for xref:../../installing/installing_aws/manually-creating-iam.adoc#alternatives-to-storing-admin-secrets-in-kube-system_manually-creating-iam-aws[AWS], xref:../../installing/installing_azure/manually-creating-iam-azure.adoc#alternatives-to-storing-admin-secrets-in-kube-system_manually-creating-iam-azure[Azure], or xref:../../installing/installing_gcp/manually-creating-iam-gcp.adoc#alternatives-to-storing-admin-secrets-in-kube-system_manually-creating-iam-gcp[GCP].
16-
17-
[NOTE]
18-
====
19-
xref:../../authentication/managing_cloud_provider_credentials/cco-mode-manual.adoc#cco-mode-manual[Manual mode] is the only supported CCO configuration for Microsoft Azure Stack Hub.
20-
====
15+
Mint mode stores the administrator-level credential in the cluster `kube-system` namespace. If this approach does not meet the security requirements of your organization, see _Alternatives to storing administrator-level secrets in the kube-system project_ for xref:../../installing/installing_aws/manually-creating-iam.adoc#alternatives-to-storing-admin-secrets-in-kube-system_manually-creating-iam-aws[AWS] or xref:../../installing/installing_gcp/manually-creating-iam-gcp.adoc#alternatives-to-storing-admin-secrets-in-kube-system_manually-creating-iam-gcp[GCP].
2116

2217
[id="mint-mode-permissions"]
2318
== Mint mode permissions requirements
@@ -39,10 +34,6 @@ The credential you provide for mint mode in AWS must have the following permissi
3934
* `iam:TagUser`
4035
* `iam:SimulatePrincipalPolicy`
4136

42-
[id="mint-mode-permissions-azure"]
43-
=== Microsoft Azure permissions
44-
The credential you provide for mint mode in Azure must have a service principal with the permissions specified in xref:../../installing/installing_azure/installing-azure-account.adoc#installation-azure-service-principal_installing-azure-account[Creating a service principal].
45-
4637
[id="mint-mode-permissions-gcp"]
4738
=== Google Cloud Platform (GCP) permissions
4839
The credential you provide for mint mode in GCP must have the following permissions:
@@ -71,6 +62,4 @@ include::modules/manually-removing-cloud-creds.adoc[leveloffset=+2]
7162
== Additional resources
7263

7364
* xref:../../installing/installing_aws/manually-creating-iam.adoc#alternatives-to-storing-admin-secrets-in-kube-system_manually-creating-iam-aws[Alternatives to storing administrator-level secrets in the kube-system project] for AWS
74-
* xref:../../installing/installing_azure/manually-creating-iam-azure.adoc#alternatives-to-storing-admin-secrets-in-kube-system_manually-creating-iam-azure[Alternatives to storing administrator-level secrets in the kube-system project] for Azure
7565
* xref:../../installing/installing_gcp/manually-creating-iam-gcp.adoc#alternatives-to-storing-admin-secrets-in-kube-system_manually-creating-iam-gcp[Alternatives to storing administrator-level secrets in the kube-system project] for GCP
76-
* xref:../../installing/installing_azure/installing-azure-account.adoc#installation-azure-service-principal_installing-azure-account[Creating a service principal] in Azure

installing/installing_azure/manually-creating-iam-azure.adoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,6 @@ include::modules/admin-credentials-root-secret-formats.adoc[leveloffset=+1]
2020

2121
include::modules/manually-maintained-credentials-upgrade.adoc[leveloffset=+1]
2222

23-
include::modules/mint-mode.adoc[leveloffset=+1]
24-
2523
[id="manually-creating-iam-azure-next-steps"]
2624
== Next steps
2725

modules/admin-credentials-root-secret-formats.adoc

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,19 @@ ifeval::["{context}" == "manually-creating-iam-gcp"]
1212
:google-cloud-platform:
1313
endif::[]
1414

15+
:_content-type: REFERENCE
1516
[id="admin-credentials-root-secret-formats_{context}"]
1617
= Admin credentials root secret format
1718

1819
Each cloud provider uses a credentials root secret in the `kube-system`
1920
namespace by convention, which is then used to satisfy all credentials requests
20-
and create their respective secrets. This is done either by minting new
21-
credentials, with _mint mode_, or by copying the credentials root secret, with
22-
_passthrough mode_.
21+
and create their respective secrets.
22+
ifndef::azure[]
23+
This is done either by minting new credentials with _mint mode_, or by copying the credentials root secret with _passthrough mode_.
24+
endif::azure[]
25+
ifdef::azure[]
26+
This is done by copying the credentials root secret with _passthrough mode_.
27+
endif::azure[]
2328

2429
The format for the secret varies by cloud, and is also used for each
2530
`CredentialsRequest` secret.
@@ -63,9 +68,7 @@ stringData:
6368
azure_region: <Region>
6469
----
6570

66-
On Microsoft Azure, the credentials secret format includes two properties that must
67-
contain the cluster's infrastructure ID, generated randomly for each cluster
68-
installation. This value can be found after running create manifests:
71+
On Microsoft Azure, the credentials secret format includes two properties that must contain the cluster's infrastructure ID, generated randomly for each cluster installation. This value can be found after running create manifests:
6972

7073
[source,terminal]
7174
----

modules/manually-rotating-cloud-creds.adoc

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,19 +22,14 @@ You can also use the command line interface to complete all parts of this proced
2222

2323
* Your cluster is installed on a platform that supports rotating cloud credentials manually with the CCO mode that you are using:
2424
25-
** For mint mode, AWS, Azure, and GCP are supported.
25+
** For mint mode, AWS and GCP are supported.
2626

2727
** For passthrough mode, AWS, Azure, GCP, {rh-openstack-first}, {rh-virtualization-first}, and VMware vSphere are supported.
2828

2929
* You have changed the credentials that are used to interface with your cloud provider.
3030
3131
* The new credentials have sufficient permissions for the mode CCO is configured to use in your cluster.
3232
33-
[NOTE]
34-
====
35-
When rotating the credentials for an Azure cluster that is using mint mode, do not delete or replace the service principal that was used during installation. Instead, generate new Azure service principal client secrets and update the {product-title} secrets accordingly.
36-
====
37-
3833
.Procedure
3934

4035
. In the *Administrator* perspective of the web console, navigate to *Workloads* -> *Secrets*.
@@ -88,7 +83,6 @@ Where `<provider_spec>` is the corresponding value for your cloud provider: `AWS
8883
"name": "cloud-credential-operator-iam-ro-creds",
8984
"namespace": "openshift-cloud-credential-operator"
9085
}
91-
...
9286
----
9387

9488
.. Delete each of the referenced component secrets:
@@ -109,11 +103,13 @@ $ oc delete secret ebs-cloud-credentials -n openshift-cluster-csi-drivers
109103
+
110104
You do not need to manually delete the credentials from your provider console. Deleting the referenced component secrets will cause the CCO to delete the existing credentials from the platform and create new ones.
111105

112-
. To verify that the credentials have changed:
106+
.Verification
107+
108+
To verify that the credentials have changed:
113109

114-
.. In the *Administrator* perspective of the web console, navigate to *Workloads* -> *Secrets*.
110+
. In the *Administrator* perspective of the web console, navigate to *Workloads* -> *Secrets*.
115111

116-
.. Verify that the contents of the *Value* field or fields are different than the previously recorded information.
112+
. Verify that the contents of the *Value* field or fields have changed.
117113

118114
////
119115
// Provider-side verification also possible, though cluster-side is cleaner process.

modules/mint-mode.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
// Module included in the following assemblies:
22
//
33
// * installing/installing_aws/manually-creating-iam.adoc
4-
// * installing/installing_azure/manually-creating-iam-azure.adoc
54
// * installing/installing_gcp/manually-creating-iam-gcp.adoc
65

6+
:_content-type: CONCEPT
77
[id="mint-mode_{context}"]
88
= Mint mode
99

10-
Mint mode is the default and recommended Cloud Credential Operator (CCO) credentials mode for {product-title}. In this mode, the CCO uses the provided administrator-level cloud credential to run the cluster. Mint mode is supported for AWS, GCP, and Azure.
10+
Mint mode is the default Cloud Credential Operator (CCO) credentials mode for {product-title} on platforms that support it. In this mode, the CCO uses the provided administrator-level cloud credential to run the cluster. Mint mode is supported for AWS and GCP.
1111

1212
In mint mode, the `admin` credential is stored in the `kube-system` namespace and then used by the CCO to process the `CredentialsRequest` objects in the cluster and create users for each with specific permissions.
1313

0 commit comments

Comments
 (0)