Skip to content

Commit 13b8c2d

Browse files
authored
Merge pull request #60222 from jeana-redhat/OSDOCS-6134-Reorg-AWS-GCP-short-term-creds
[OSDOCS-6134]: Moving AWS & GCP short term creds install procs
2 parents eaa5488 + b9a10c4 commit 13b8c2d

File tree

76 files changed

+1657
-448
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

76 files changed

+1657
-448
lines changed

_topic_maps/_topic_map.yml

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -159,8 +159,6 @@ Topics:
159159
File: preparing-to-install-on-aws
160160
- Name: Configuring an AWS account
161161
File: installing-aws-account
162-
- Name: Manually creating IAM
163-
File: manually-creating-iam
164162
- Name: Installing a cluster quickly on AWS
165163
File: installing-aws-default
166164
- Name: Installing a cluster on AWS with customizations
@@ -201,7 +199,7 @@ Topics:
201199
File: preparing-to-install-on-azure
202200
- Name: Configuring an Azure account
203201
File: installing-azure-account
204-
- Name: Manually creating IAM
202+
- Name: Manually creating long-term credentials for Azure
205203
File: manually-creating-iam-azure
206204
- Name: Enabling user-managed encryption on Azure
207205
File: enabling-user-managed-encryption-azure
@@ -249,8 +247,6 @@ Topics:
249247
File: preparing-to-install-on-gcp
250248
- Name: Configuring a GCP project
251249
File: installing-gcp-account
252-
- Name: Manually creating IAM
253-
File: manually-creating-iam-gcp
254250
- Name: Installing a cluster quickly on GCP
255251
File: installing-gcp-default
256252
- Name: Installing a cluster on GCP with customizations
@@ -1139,16 +1135,14 @@ Topics:
11391135
Topics:
11401136
- Name: About the Cloud Credential Operator
11411137
File: about-cloud-credential-operator
1142-
- Name: Using mint mode
1138+
- Name: Mint mode
11431139
File: cco-mode-mint
1144-
- Name: Using passthrough mode
1140+
- Name: Passthrough mode
11451141
File: cco-mode-passthrough
1146-
- Name: Using manual mode
1142+
- Name: Manual mode with long-term credentials for components
11471143
File: cco-mode-manual
1148-
- Name: Using manual mode with AWS Security Token Service
1149-
File: cco-mode-sts
1150-
- Name: Using manual mode with GCP Workload Identity
1151-
File: cco-mode-gcp-workload-identity
1144+
- Name: Manual mode with short-term credentials for components
1145+
File: cco-short-term-creds
11521146
---
11531147
Name: Networking
11541148
Dir: networking
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

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

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,9 @@ By setting different values for the `credentialsMode` parameter in the `install-
1919

2020
* **xref:../../authentication/managing_cloud_provider_credentials/cco-mode-passthrough.adoc#cco-mode-passthrough[Passthrough]**: In passthrough mode, the CCO passes the provided cloud credential to the components that request cloud credentials.
2121

22-
* **xref:../../authentication/managing_cloud_provider_credentials/cco-mode-manual.adoc#cco-mode-manual[Manual]**: In manual mode, a user manages cloud credentials instead of the CCO.
22+
* **xref:../../authentication/managing_cloud_provider_credentials/cco-mode-manual.adoc#cco-mode-manual[Manual mode with long-term credentials for components]**: In manual mode, you can manage long-term cloud credentials instead of the CCO.
2323

24-
** **xref:../../authentication/managing_cloud_provider_credentials/cco-mode-sts.adoc#cco-mode-sts[Manual with AWS Security Token Service]**: In manual mode, you can configure an AWS cluster to use Amazon Web Services Security Token Service (AWS STS). With this configuration, the CCO uses temporary credentials for different components.
25-
26-
** **xref:../../authentication/managing_cloud_provider_credentials/cco-mode-gcp-workload-identity.adoc#cco-mode-gcp-workload-identity[Manual with GCP Workload Identity]**: In manual mode, you can configure a GCP cluster to use GCP Workload Identity. With this configuration, the CCO uses temporary credentials for different components.
24+
* **xref:../../authentication/managing_cloud_provider_credentials/cco-short-term-creds.adoc#cco-short-term-creds[Manual mode with short-term credentials for components]**: For some providers, you can use the CCO utility (`ccoctl`) during installation to implement short-term credentials for individual components. These credentials are created and managed outside the {product-title} cluster.
2725

2826
.CCO mode support matrix
2927
[cols="<.^2,^.^1,^.^1,^.^1"]
@@ -38,18 +36,18 @@ By setting different values for the `credentialsMode` parameter in the `install-
3836
|Amazon Web Services (AWS)
3937
|X
4038
|X
41-
|X
39+
|X ^[1]^
4240

4341

4442
|Microsoft Azure
4543
|
46-
|X ^[1]^
44+
|X ^[2]^
4745
|X
4846

4947
|Google Cloud Platform (GCP)
5048
|X
5149
|X
52-
|X
50+
|X ^[3]^
5351

5452
|IBM Cloud
5553
|
@@ -74,7 +72,9 @@ By setting different values for the `credentialsMode` parameter in the `install-
7472
|====
7573
[.small]
7674
--
77-
1. Manual mode is the only supported CCO configuration for Microsoft Azure Stack Hub.
75+
1. Short-term credentials with AWS Security Token Service can be configured during installation.
76+
2. Manual mode with long-term credentials is the only supported CCO configuration for Microsoft Azure Stack Hub.
77+
3. Short-term credentials with GCP Workload Identity can be configured during installation.
7878
--
7979

8080
[id="cco-determine-mode_{context}"]
@@ -97,11 +97,11 @@ For platforms on which multiple modes are supported (AWS, Azure, and GCP), when
9797

9898
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.
9999

100-
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.
100+
If the provided credentials are determined to be insufficient during installation, the installation fails. For AWS, the installation program 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.
101101

102102
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.
103103

104-
To resolve insufficient credentials issues, provide a credential with sufficient permissions. If an error occurred during installation, try installing again. For issues with new `CredentialsRequest` CRs, wait for the CCO to try to process the CR again. As an alternative, you can manually create IAM for xref:../../installing/installing_aws/manually-creating-iam.adoc#manually-creating-iam-aws[AWS], xref:../../installing/installing_azure/manually-creating-iam-azure.adoc#manually-creating-iam-azure[Azure], and xref:../../installing/installing_gcp/manually-creating-iam-gcp.adoc#manually-creating-iam-gcp[GCP].
104+
To resolve insufficient credentials issues, provide a credential with sufficient permissions. If an error occurred during installation, try installing again. For issues with new `CredentialsRequest` CRs, wait for the CCO to try to process the CR again. As an alternative, you can configure your cluster to use a different CCO mode that is supported for your cloud provider.
105105

106106
[role="_additional-resources"]
107107
[id="additional-resources_about-cloud-credential-operator_{context}"]

0 commit comments

Comments
 (0)