Skip to content

Commit b8b5a6e

Browse files
committed
OSDOCS-11734: GCP Workload ID OLM stub and related updates
1 parent 4241b05 commit b8b5a6e

File tree

5 files changed

+45
-19
lines changed

5 files changed

+45
-19
lines changed

_attributes/common-attributes.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -309,6 +309,9 @@ endif::openshift-origin[]
309309
//Microsoft Entra Workload ID (FKA Azure Active Directory Workload Identities)
310310
:entra-first: Microsoft Entra Workload ID
311311
:entra-short: Workload ID
312+
//Google Cloud Platform Workload Identity
313+
:gcp-wid-first: Google Cloud Platform Workload Identity
314+
:gcp-wid-short: GCP Workload Identity
312315

313316

314317
// Cluster API terminology

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

Lines changed: 24 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ During installation, you can configure the Cloud Credential Operator (CCO) to op
1010

1111
[NOTE]
1212
====
13-
This credentials strategy is supported for Amazon Web Services (AWS), Google Cloud Platform (GCP), and global Microsoft Azure only. The strategy must be configured during installation of a new {product-title} cluster. You cannot configure an existing cluster that uses a different credentials strategy to use this feature.
13+
This credentials strategy is supported for {aws-first}, {gcp-first}, and global {azure-full} only. The strategy must be configured during installation of a new {product-title} cluster. You cannot configure an existing cluster that uses a different credentials strategy to use this feature.
1414
====
1515

1616
//todo: Should provide some more info about the benefits of this here as well. Note: Azure is not yet limited-priv, but still gets the benefit of not storing root creds on the cluster and some sort of time-based rotation
@@ -21,25 +21,25 @@ Cloud providers use different terms for their implementation of this authenticat
2121
|====
2222
|Cloud provider |Provider nomenclature
2323

24-
|Amazon Web Services (AWS)
25-
|AWS Security Token Service (STS)
24+
|{aws-first}
25+
|{aws-short} {sts-first}
2626

27-
|Google Cloud Platform (GCP)
28-
|GCP Workload Identity
27+
|{gcp-first}
28+
|{gcp-wid-short}
2929

3030
|Global Microsoft Azure
3131
|{entra-first}
3232

3333
|====
3434

3535
[id="cco-short-term-creds-aws_{context}"]
36-
== AWS Security Token Service
36+
== {aws-short} {sts-full}
3737

38-
In manual mode with STS, the individual {product-title} cluster components use the AWS Security Token Service (STS) to assign components IAM roles that provide short-term, limited-privilege security credentials. These credentials are associated with IAM roles that are specific to each component that makes AWS API calls.
38+
In manual mode with {sts-first}, the individual {product-title} cluster components use the {aws-short} {sts-short} to assign components IAM roles that provide short-term, limited-privilege security credentials. These credentials are associated with IAM roles that are specific to each component that makes {aws-short} API calls.
3939

4040
[role="_additional-resources"]
4141
.Additional resources
42-
* xref:../../installing/installing_aws/ipi/installing-aws-customizations.adoc#installing-aws-with-short-term-creds_installing-aws-customizations[Configuring an AWS cluster to use short-term credentials]
42+
* xref:../../installing/installing_aws/ipi/installing-aws-customizations.adoc#installing-aws-with-short-term-creds_installing-aws-customizations[Configuring an {aws-short} cluster to use short-term credentials]
4343

4444
//AWS Security Token Service authentication process
4545
include::modules/cco-short-term-creds-auth-flow-aws.adoc[leveloffset=+2]
@@ -55,16 +55,16 @@ include::modules/cco-short-term-creds-aws-olm.adoc[leveloffset=+2]
5555

5656
[role="_additional-resources"]
5757
.Additional resources
58-
* xref:../../operators/operator_sdk/token_auth/osdk-cco-aws-sts.adoc#osdk-cco-aws-sts[CCO-based workflow for OLM-managed Operators with AWS STS]
58+
* xref:../../operators/operator_sdk/token_auth/osdk-cco-aws-sts.adoc#osdk-cco-aws-sts[CCO-based workflow for OLM-managed Operators with {aws-short} {sts-short}]
5959

6060
[id="cco-short-term-creds-gcp_{context}"]
61-
== GCP Workload Identity
61+
== {gcp-wid-short}
6262

63-
In manual mode with GCP Workload Identity, the individual {product-title} cluster components use the GCP workload identity provider to allow components to impersonate GCP service accounts using short-term, limited-privilege credentials.
63+
In manual mode with {gcp-wid-short}, the individual {product-title} cluster components use the {gcp-short} workload identity provider to allow components to impersonate {gcp-short} service accounts using short-term, limited-privilege credentials.
6464

6565
[role="_additional-resources"]
6666
.Additional resources
67-
* 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]
67+
* xref:../../installing/installing_gcp/installing-gcp-customizations.adoc#installing-gcp-with-short-term-creds_installing-gcp-customizations[Configuring a {gcp-short} cluster to use short-term credentials]
6868

6969
//GCP Workload Identity authentication process
7070
include::modules/cco-short-term-creds-auth-flow-gcp.adoc[leveloffset=+2]
@@ -75,14 +75,22 @@ include::modules/cco-short-term-creds-format-gcp.adoc[leveloffset=+2]
7575
//GCP component secret permissions requirements (placeholder)
7676
//include::modules/cco-short-term-creds-component-permissions-gcp.adoc[leveloffset=+2]
7777

78+
//OLM-managed Operator support for authentication with GCP Workload Identity
79+
include::modules/cco-short-term-creds-gcp-olm.adoc[leveloffset=+2]
80+
81+
// Placeholder/guess for OLM link
82+
// [role="_additional-resources"]
83+
// .Additional resources
84+
// * xr3f:../../operators/operator_sdk/token_auth/osdk-cco-gcp.adoc#osdk-cco-gcp[CCO-based workflow for OLM-managed Operators with {gcp-wid-first}]
85+
7886
[id="cco-short-term-creds-azure_{context}"]
7987
== {entra-first}
8088

8189
In manual mode with {entra-first}, the individual {product-title} cluster components use the {entra-short} provider to assign components short-term security credentials.
8290

8391
[role="_additional-resources"]
8492
.Additional resources
85-
* xref:../../installing/installing_azure/ipi/installing-azure-customizations.adoc#installing-azure-with-short-term-creds_installing-azure-customizations[Configuring a global Microsoft Azure cluster to use short-term credentials]
93+
* xref:../../installing/installing_azure/ipi/installing-azure-customizations.adoc#installing-azure-with-short-term-creds_installing-azure-customizations[Configuring a global {azure-first} cluster to use short-term credentials]
8694

8795
//Microsoft Entra Workload ID authentication process
8896
include::modules/cco-short-term-creds-auth-flow-azure.adoc[leveloffset=+2]
@@ -104,7 +112,7 @@ include::modules/cco-short-term-creds-azure-olm.adoc[leveloffset=+2]
104112
[id="additional-resources_{context}"]
105113
== Additional resources
106114

107-
* xref:../../installing/installing_aws/ipi/installing-aws-customizations.adoc#installing-aws-with-short-term-creds_installing-aws-customizations[Configuring an AWS cluster to use short-term credentials]
108-
* 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]
109-
* xref:../../installing/installing_azure/ipi/installing-azure-customizations.adoc#installing-azure-with-short-term-creds_installing-azure-customizations[Configuring a global Microsoft Azure cluster to use short-term credentials]
115+
* xref:../../installing/installing_aws/ipi/installing-aws-customizations.adoc#installing-aws-with-short-term-creds_installing-aws-customizations[Configuring an {aws-short} cluster to use short-term credentials]
116+
* xref:../../installing/installing_gcp/installing-gcp-customizations.adoc#installing-gcp-with-short-term-creds_installing-gcp-customizations[Configuring a {gcp-short} cluster to use short-term credentials]
117+
* xref:../../installing/installing_azure/ipi/installing-azure-customizations.adoc#installing-azure-with-short-term-creds_installing-azure-customizations[Configuring a global {azure-first} cluster to use short-term credentials]
110118
* xref:../../updating/preparing_for_updates/preparing-manual-creds-update.adoc#preparing-manual-creds-update[Preparing to update a cluster with manually maintained credentials]

modules/cco-short-term-creds-aws-olm.adoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
:_mod-docs-content-type: CONCEPT
66
[id="cco-short-term-creds-aws-olm_{context}"]
7-
= OLM-managed Operator support for authentication with AWS STS
7+
= OLM-managed Operator support for authentication with {aws-short} {sts-short}
88

9-
In addition to {product-title} cluster components, some Operators managed by the Operator Lifecycle Manager (OLM) on AWS clusters can use manual mode with STS. These Operators authenticate with limited-privilege, short-term credentials that are managed outside the cluster. To determine if an Operator supports authentication with AWS STS, see the Operator description in OperatorHub.
9+
Certain Operators managed by the Operator Lifecycle Manager (OLM) on {aws-short} clusters can use manual mode with {sts-short}.
10+
These Operators authenticate with limited-privilege, short-term credentials that are managed outside the cluster.
11+
To determine if an Operator supports authentication with {aws-short} {sts-short}, see the Operator description in OperatorHub.

modules/cco-short-term-creds-azure-olm.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,6 @@
66
[id="cco-short-term-creds-azure-olm_{context}"]
77
= OLM-managed Operator support for authentication with {entra-first}
88

9-
In addition to {product-title} cluster components, some Operators managed by the Operator Lifecycle Manager (OLM) on Azure clusters can use manual mode with {entra-first}. These Operators authenticate with short-term credentials that are managed outside the cluster. To determine if an Operator supports authentication with {entra-short}, see the Operator description in OperatorHub.
9+
Certain Operators managed by the Operator Lifecycle Manager (OLM) on {azure-short} clusters can use manual mode with {entra-first}.
10+
These Operators authenticate with short-term credentials that are managed outside the cluster.
11+
To determine if an Operator supports authentication with {entra-short}, see the Operator description in OperatorHub.
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * authentication/managing_cloud_provider_credentials/cco-short-term-creds.adoc
4+
5+
:_mod-docs-content-type: CONCEPT
6+
[id="cco-short-term-creds-gcp-olm_{context}"]
7+
= OLM-managed Operator support for authentication with {gcp-wid-short}
8+
9+
Certain Operators managed by the Operator Lifecycle Manager (OLM) on {gcp-short} clusters can use manual mode with {gcp-wid-short}.
10+
These Operators authenticate with limited-privilege, short-term credentials that are managed outside the cluster.
11+
To determine if an Operator supports authentication with {gcp-wid-short}, see the Operator description in OperatorHub.

0 commit comments

Comments
 (0)