Skip to content

Commit 6129678

Browse files
authored
Merge pull request #64001 from jeana-redhat/OSDOCS-6135-installing-azure-short-term-creds
[OSDOCS-6135]: Configuring an Azure cluster with short-term creds
2 parents 7a3ccbe + ece4b6c commit 6129678

33 files changed

+312
-93
lines changed

_topic_maps/_topic_map.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -199,8 +199,6 @@ Topics:
199199
File: preparing-to-install-on-azure
200200
- Name: Configuring an Azure account
201201
File: installing-azure-account
202-
- Name: Manually creating long-term credentials for Azure
203-
File: manually-creating-iam-azure
204202
- Name: Enabling user-managed encryption on Azure
205203
File: enabling-user-managed-encryption-azure
206204
- Name: Installing a cluster quickly on Azure
File renamed without changes.

authentication/managing_cloud_provider_credentials/cco-mode-manual.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ An AWS, global Azure, or GCP cluster that uses manual mode might be configured t
2828

2929
* xref:../../installing/installing_alibaba/manually-creating-alibaba-ram.adoc#manually-creating-alibaba-ram[Manually creating RAM resources for Alibaba Cloud]
3030
* xref:../../installing/installing_aws/installing-aws-customizations.adoc#manually-create-iam_installing-aws-customizations[Manually creating long-term credentials for AWS]
31-
* xref:../../installing/installing_azure/manually-creating-iam-azure.adoc#manually-creating-iam-azure[Manually creating long-term credentials for Azure]
31+
* xref:../../installing/installing_azure/installing-azure-customizations.adoc#manually-create-iam_installing-azure-customizations[Manually creating long-term credentials for Azure]
3232
* xref:../../installing/installing_gcp/installing-gcp-customizations.adoc#manually-create-iam_installing-gcp-customizations[Manually creating long-term credentials for GCP]
3333
* xref:../../installing/installing_ibm_cloud_public/configuring-iam-ibm-cloud.adoc#configuring-iam-ibm-cloud[Configuring IAM for IBM Cloud]
3434
* xref:../../installing/installing_nutanix/installing-nutanix-installer-provisioned.adoc#manually-create-iam-nutanix_installing-nutanix-installer-provisioned[Configuring IAM for Nutanix]

authentication/managing_cloud_provider_credentials/cco-mode-passthrough.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ To locate the `CredentialsRequest` CRs that are required, see xref:../../install
2929
=== Microsoft Azure permissions
3030
The credential you provide for passthrough mode in Azure must have all the requested permissions for all `CredentialsRequest` CRs that are required by the version of {product-title} you are running or installing.
3131

32-
To locate the `CredentialsRequest` CRs that are required, see xref:../../installing/installing_azure/manually-creating-iam-azure.adoc#manually-creating-iam-azure[Manually creating long-term credentials for Azure].
32+
To locate the `CredentialsRequest` CRs that are required, see xref:../../installing/installing_azure/installing-azure-customizations.adoc#manually-create-iam_installing-azure-customizations[Manually creating long-term credentials for Azure].
3333

3434
[id="passthrough-mode-permissions-gcp"]
3535
=== Google Cloud Platform (GCP) permissions
@@ -81,7 +81,7 @@ include::modules/admin-credentials-root-secret-formats.adoc[leveloffset=+1]
8181

8282
[id="passthrough-mode-maintenance"]
8383
== Passthrough mode credential maintenance
84-
If `CredentialsRequest` CRs change over time as the cluster is upgraded, you must manually update the passthrough mode credential to meet the requirements. To avoid credentials issues during an upgrade, check the `CredentialsRequest` CRs in the release image for the new version of {product-title} before upgrading. To locate the `CredentialsRequest` CRs that are required for your cloud provider, see _Manually creating long-term credentials_ for xref:../../installing/installing_aws/installing-aws-customizations.adoc#manually-create-iam_installing-aws-customizations[AWS], xref:../../installing/installing_azure/manually-creating-iam-azure.adoc#manually-creating-iam-azure[Azure], or xref:../../installing/installing_gcp/installing-gcp-customizations.adoc#manually-create-iam_installing-gcp-customizations[GCP].
84+
If `CredentialsRequest` CRs change over time as the cluster is upgraded, you must manually update the passthrough mode credential to meet the requirements. To avoid credentials issues during an upgrade, check the `CredentialsRequest` CRs in the release image for the new version of {product-title} before upgrading. To locate the `CredentialsRequest` CRs that are required for your cloud provider, see _Manually creating long-term credentials_ for xref:../../installing/installing_aws/installing-aws-customizations.adoc#manually-create-iam_installing-aws-customizations[AWS], xref:../../installing/installing_azure/installing-azure-customizations.adoc#manually-create-iam_installing-azure-customizations[Azure], or xref:../../installing/installing_gcp/installing-gcp-customizations.adoc#manually-create-iam_installing-gcp-customizations[GCP].
8585

8686
//Rotating cloud provider credentials manually
8787
include::modules/manually-rotating-cloud-creds.adoc[leveloffset=+2]
@@ -96,11 +96,11 @@ When using passthrough mode, each component has the same permissions used by all
9696

9797
After installation, you can reduce the permissions on your credential to only those that are required to run the cluster, as defined by the `CredentialsRequest` CRs in the release image for the version of {product-title} that you are using.
9898

99-
To locate the `CredentialsRequest` CRs that are required for AWS, Azure, or GCP and learn how to change the permissions the CCO uses, see _Manually creating long-term credentials_ for xref:../../installing/installing_aws/installing-aws-customizations.adoc#manually-create-iam_installing-aws-customizations[AWS], xref:../../installing/installing_azure/manually-creating-iam-azure.adoc#manually-creating-iam-azure[Azure], or xref:../../installing/installing_gcp/installing-gcp-customizations.adoc#manually-create-iam_installing-gcp-customizations[GCP].
99+
To locate the `CredentialsRequest` CRs that are required for AWS, Azure, or GCP and learn how to change the permissions the CCO uses, see _Manually creating long-term credentials_ for xref:../../installing/installing_aws/installing-aws-customizations.adoc#manually-create-iam_installing-aws-customizations[AWS], xref:../../installing/installing_azure/installing-azure-customizations.adoc#manually-create-iam_installing-azure-customizations[Azure], or xref:../../installing/installing_gcp/installing-gcp-customizations.adoc#manually-create-iam_installing-gcp-customizations[GCP].
100100

101101
[role="_additional-resources"]
102102
== Additional resources
103103

104104
* xref:../../installing/installing_aws/installing-aws-customizations.adoc#manually-create-iam_installing-aws-customizations[Manually creating long-term credentials for AWS]
105-
* xref:../../installing/installing_azure/manually-creating-iam-azure.adoc#manually-creating-iam-azure[Manually creating long-term credentials for Azure]
105+
* xref:../../installing/installing_azure/installing-azure-customizations.adoc#manually-create-iam_installing-azure-customizations[Manually creating long-term credentials for Azure]
106106
* xref:../../installing/installing_gcp/installing-gcp-customizations.adoc#manually-create-iam_installing-gcp-customizations[Manually creating long-term credentials for GCP]

authentication/managing_cloud_provider_credentials/cco-short-term-creds.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ In manual mode with Azure AD Workload Identity, the individual {product-title} c
8484

8585
[role="_additional-resources"]
8686
.Additional resources
87-
//* xr\ef:../../installing/installing_azure/installing-azure-customizations.adoc#installing-azure-with-short-term-creds_installing-azure-customizations[Configuring a global Microsoft Azure cluster to use short-term credentials]
87+
* xref:../../installing/installing_azure/installing-azure-customizations.adoc#installing-azure-with-short-term-creds_installing-azure-customizations[Configuring a global Microsoft Azure cluster to use short-term credentials]
8888

8989
//Azure AD Workload Identity authentication process (placeholder)
9090
//include::modules/cco-short-term-creds-auth-flow-azure.adoc[leveloffset=+2]
@@ -101,5 +101,5 @@ include::modules/cco-short-term-creds-component-permissions-azure.adoc[leveloffs
101101

102102
* xref:../../installing/installing_aws/installing-aws-customizations.adoc#installing-aws-with-short-term-creds_installing-aws-customizations[Configuring an AWS cluster to use short-term credentials]
103103
* xref:../../installing/installing_gcp/installing-gcp-customizations.adoc#installing-gcp-with-short-term-creds_installing-gcp-customizations[Configuring a GCP cluster to use short-term credentials]
104-
//* xr\ef:../../installing/installing_azure/installing-azure-customizations.adoc#installing-azure-with-short-term-creds_installing-azure-customizations[Configuring a global Microsoft Azure cluster to use short-term credentials]
104+
* xref:../../installing/installing_azure/installing-azure-customizations.adoc#installing-azure-with-short-term-creds_installing-azure-customizations[Configuring a global Microsoft Azure cluster to use short-term credentials]
105105
* xref:../../updating/preparing_for_updates/preparing-manual-creds-update.adoc#preparing-manual-creds-update[Preparing to update a cluster with manually maintained credentials]

installing/installing_azure/installing-azure-account.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ include::modules/installation-creating-azure-service-principal.adoc[leveloffset=
3939
[role="_additional-resources"]
4040
.Additional resources
4141

42-
* 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].
42+
* xref:../../authentication/managing_cloud_provider_credentials/about-cloud-credential-operator.adoc#about-cloud-credential-operator-modes[About the Cloud Credential Operator]
4343
4444
include::modules/installation-azure-marketplace.adoc[leveloffset=+1]
4545

installing/installing_azure/installing-azure-customizations.adoc

Lines changed: 30 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ parameters in the `install-config.yaml` file before you install the cluster.
1818
* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users].
1919
* You xref:../../installing/installing_azure/installing-azure-account.adoc#installing-azure-account[configured an Azure account] to host the cluster and determined the tested and validated region to deploy the cluster to.
2020
* If you use a firewall, you xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured it to allow the sites] that your cluster requires access to.
21-
* If the cloud identity and access management (IAM) APIs are not accessible in your environment, or if you do not want to store an administrator-level credential secret in the `kube-system` namespace, you can xref:../../installing/installing_azure/manually-creating-iam-azure.adoc#manually-creating-iam-azure[manually create and maintain IAM credentials].
2221
* If you use customer-managed encryption keys, you xref:../../installing/installing_azure/enabling-user-managed-encryption-azure.adoc#enabling-user-managed-encryption-azure[prepared your Azure environment for encryption].
2322

2423
include::modules/cluster-entitlements.adoc[leveloffset=+1]
@@ -59,10 +58,38 @@ include::modules/installation-configure-proxy.adoc[leveloffset=+2]
5958

6059
* For more details about Accelerated Networking, see xref:../../machine_management/creating_machinesets/creating-machineset-azure.adoc#machineset-azure-accelerated-networking_creating-machineset-azure[Accelerated Networking for Microsoft Azure VMs].
6160

62-
include::modules/installation-launching-installer.adoc[leveloffset=+1]
63-
61+
//Installing the OpenShift CLI by downloading the binary: Moved up to precede manual cred (short and long) steps, which require the use of `oc`
6462
include::modules/cli-installing-cli.adoc[leveloffset=+1]
6563

64+
[id="installing-azure-manual-modes_{context}"]
65+
== Alternatives to storing administrator-level secrets in the kube-system project
66+
67+
By default, administrator secrets are stored in the `kube-system` project. If you configured the `credentialsMode` parameter in the `install-config.yaml` file to `Manual`, you must use one of the following alternatives:
68+
69+
* To manage long-term cloud credentials manually, follow the procedure in xref:../../installing/installing_azure/installing-azure-customizations.adoc#manually-create-iam_installing-azure-customizations[Manually creating long-term credentials].
70+
71+
* To implement short-term credentials that are managed outside the cluster for individual components, follow the procedures in xref:../../installing/installing_azure/installing-azure-customizations.adoc#installing-azure-with-short-term-creds_installing-azure-customizations[Configuring an Azure cluster to use short-term credentials].
72+
73+
//Manually creating long-term credentials
74+
include::modules/manually-create-identity-access-management.adoc[leveloffset=+2]
75+
76+
//Supertask: Configuring an Azure cluster to use short-term credentials
77+
[id="installing-azure-with-short-term-creds_{context}"]
78+
=== Configuring an Azure cluster to use short-term credentials
79+
80+
To install a cluster that uses Azure AD Workload Identity, you must configure the Cloud Credential Operator utility and create the required Azure resources for your cluster.
81+
82+
//Task part 1: Configuring the Cloud Credential Operator utility
83+
include::modules/cco-ccoctl-configuring.adoc[leveloffset=+3]
84+
85+
//Task part 2: Creating the required Azure resources
86+
include::modules/cco-ccoctl-creating-at-once.adoc[leveloffset=+3]
87+
88+
// Additional steps for the Cloud Credential Operator utility (`ccoctl`)
89+
include::modules/cco-ccoctl-install-creating-manifests.adoc[leveloffset=+3]
90+
91+
include::modules/installation-launching-installer.adoc[leveloffset=+1]
92+
6693
include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]
6794

6895
[role="_additional-resources"]

installing/installing_azure/installing-azure-government-region.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ cluster.
1717
* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users].
1818
* You xref:../../installing/installing_azure/installing-azure-account.adoc#installing-azure-account[configured an Azure account] to host the cluster and determined the tested and validated government region to deploy the cluster to.
1919
* If you use a firewall, you xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured it to allow the sites] that your cluster requires access to.
20-
* If the cloud identity and access management (IAM) APIs are not accessible in your environment, or if you do not want to store an administrator-level credential secret in the `kube-system` namespace, you can xref:../../installing/installing_azure/manually-creating-iam-azure.adoc#manually-creating-iam-azure[manually create and maintain IAM credentials].
20+
* If the cloud identity and access management (IAM) APIs are not accessible in your environment, or if you do not want to store an administrator-level credential secret in the `kube-system` namespace, you can xref:../../installing/installing_azure/installing-azure-customizations.adoc#manually-create-iam_installing-azure-customizations[manually create and maintain long-term credentials].
2121
* If you use customer-managed encryption keys, you xref:../../installing/installing_azure/enabling-user-managed-encryption-azure.adoc#enabling-user-managed-encryption-azure[prepared your Azure environment for encryption].
2222

2323
include::modules/installation-azure-about-government-region.adoc[leveloffset=+1]

installing/installing_azure/installing-azure-network-customizations.adoc

Lines changed: 30 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@ cluster.
2222
* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users].
2323
* You xref:../../installing/installing_azure/installing-azure-account.adoc#installing-azure-account[configured an Azure account] to host the cluster and determined the tested and validated region to deploy the cluster to.
2424
* If you use a firewall, you xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured it to allow the sites] that your cluster requires access to.
25-
* If the cloud identity and access management (IAM) APIs are not accessible in your environment, or if you do not want to store an administrator-level credential secret in the `kube-system` namespace, you can xref:../../installing/installing_azure/manually-creating-iam-azure.adoc#manually-creating-iam-azure[manually create and maintain IAM credentials]. Manual mode can also be used in environments where the cloud IAM APIs are not reachable.
2625
* If you use customer-managed encryption keys, you xref:../../installing/installing_azure/enabling-user-managed-encryption-azure.adoc#enabling-user-managed-encryption-azure[prepared your Azure environment for encryption].
2726

2827
include::modules/cluster-entitlements.adoc[leveloffset=+1]
@@ -69,10 +68,38 @@ For more information on using Linux and Windows nodes in the same cluster, see x
6968

7069
* For more details about Accelerated Networking, see xref:../../machine_management/creating_machinesets/creating-machineset-azure.adoc#machineset-azure-accelerated-networking_creating-machineset-azure[Accelerated Networking for Microsoft Azure VMs].
7170

72-
include::modules/installation-launching-installer.adoc[leveloffset=+1]
73-
71+
//Installing the OpenShift CLI by downloading the binary: Moved up to precede manual cred (short and long) steps, which require the use of `oc`
7472
include::modules/cli-installing-cli.adoc[leveloffset=+1]
7573

74+
[id="installing-azure-manual-modes_{context}"]
75+
== Alternatives to storing administrator-level secrets in the kube-system project
76+
77+
By default, administrator secrets are stored in the `kube-system` project. If you configured the `credentialsMode` parameter in the `install-config.yaml` file to `Manual`, you must use one of the following alternatives:
78+
79+
* To manage long-term cloud credentials manually, follow the procedure in xref:../../installing/installing_azure/installing-azure-network-customizations.adoc#manually-create-iam_installing-azure-network-customizations[Manually creating long-term credentials].
80+
81+
* To implement short-term credentials that are managed outside the cluster for individual components, follow the procedures in xref:../../installing/installing_azure/installing-azure-network-customizations.adoc#installing-azure-with-short-term-creds_installing-azure-network-customizations[Configuring an Azure cluster to use short-term credentials].
82+
83+
//Manually creating long-term credentials
84+
include::modules/manually-create-identity-access-management.adoc[leveloffset=+2]
85+
86+
//Supertask: Configuring an Azure cluster to use short-term credentials
87+
[id="installing-azure-with-short-term-creds_{context}"]
88+
=== Configuring an Azure cluster to use short-term credentials
89+
90+
To install a cluster that uses Azure AD Workload Identity, you must configure the Cloud Credential Operator utility and create the required Azure resources for your cluster.
91+
92+
//Task part 1: Configuring the Cloud Credential Operator utility
93+
include::modules/cco-ccoctl-configuring.adoc[leveloffset=+3]
94+
95+
//Task part 2: Creating the required Azure resources
96+
include::modules/cco-ccoctl-creating-at-once.adoc[leveloffset=+3]
97+
98+
// Additional steps for the Cloud Credential Operator utility (`ccoctl`)
99+
include::modules/cco-ccoctl-install-creating-manifests.adoc[leveloffset=+3]
100+
101+
include::modules/installation-launching-installer.adoc[leveloffset=+1]
102+
76103
include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]
77104

78105
[role="_additional-resources"]

0 commit comments

Comments
 (0)