Skip to content

Commit ea27eae

Browse files
AedinCAedinC
committed
OSDOCS-14662:Updated Creating a cluster on GC with WIF auth for DITA compliance.
1 parent 99878ec commit ea27eae

File tree

4 files changed

+48
-90
lines changed

4 files changed

+48
-90
lines changed

‎.vale.ini‎

Lines changed: 4 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,6 @@
11
StylesPath = .vale/styles
2+
MinAlertLevel = warning
3+
Packages = https://github.com/jhradilek/asciidoctor-dita-vale/releases/latest/download/AsciiDocDITA.zip
24

3-
MinAlertLevel = suggestion
4-
5-
Packages = RedHat, AsciiDoc, OpenShiftAsciiDoc, https://github.com/jhradilek/asciidoctor-dita-vale/releases/latest/download/AsciiDocDITA.zip
6-
7-
Vocab = OpenShiftDocs
8-
9-
# Ignore files in dirs starting with `.` to avoid raising errors for `.vale/fixtures/*/testinvalid.adoc` files
10-
[[!.]*.adoc]
11-
BasedOnStyles = RedHat, AsciiDoc, OpenShiftAsciiDoc
12-
13-
# Disabling rules (NO)
14-
RedHat.ReleaseNotes = NO
15-
16-
# Use local OpenShiftDocs Vocab terms
17-
Vale.Terms = YES
18-
Vale.Avoid = YES
19-
20-
# Enable specifc DITA rules on assemblies
21-
AsciiDocDITA.AdmonitionTitle = error
22-
AsciiDocDITA.AuthorLine = error
23-
AsciiDocDITA.BlockTitle = error
24-
AsciiDocDITA.CalloutList = error
25-
AsciiDocDITA.ContentType = error
26-
AsciiDocDITA.DiscreteHeading = error
27-
AsciiDocDITA.EntityReference = error
28-
AsciiDocDITA.EquationFormula = error
29-
AsciiDocDITA.ExampleBlock = error
30-
AsciiDocDITA.LineBreak = error
31-
AsciiDocDITA.NestedSection = error
32-
AsciiDocDITA.PageBreak = error
33-
AsciiDocDITA.RelatedLinks = error
34-
AsciiDocDITA.ShortDescription = error
35-
AsciiDocDITA.SidebarBlock = error
36-
AsciiDocDITA.TableFooter = error
37-
AsciiDocDITA.TaskDuplicate = error
38-
AsciiDocDITA.TaskExample = error
39-
AsciiDocDITA.TaskSection = error
40-
AsciiDocDITA.TaskStep = error
41-
AsciiDocDITA.ThematicBreak = error
42-
43-
# Disable module specific rules
44-
OpenShiftAsciiDoc.ModuleContainsParentAssemblyComment = NO
45-
OpenShiftAsciiDoc.NoNestingInModules = NO
46-
OpenShiftAsciiDoc.NoXrefInModules = NO
47-
OpenShiftAsciiDoc.IdHasContextVariable = NO
48-
OpenShiftAsciiDoc.NoTocInModules = NO
49-
50-
# Optional: pass doc attributes to asciidoctor before linting
51-
# Temp values are used for Prow CI comment linting only
52-
[asciidoctor]
53-
temp-ifdef = YES
54-
temp-ifndef = NO
55-
temp-ifeval = temp
5+
[*.adoc]
6+
BasedOnStyles = AsciiDocDITA

‎modules/wif-overview.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
// * osd_install_access_delete_cluster/creating-a-gcp-cluster-with-workload-identity-federation.adoc
3+
// *osd_gcp_clusters/osd-creating-a-cluster-on-gcp-with-workload-identity-federation.adoc
44

55

66
:_mod-docs-content-type: CONCEPT

‎modules/wif-requirements.adoc‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * osd_gcp_clusters/osd-creating-a-cluster-on-gcp-with-workload-identity-federation.adoc
4+
5+
6+
:_mod-docs-content-type: CONCEPT
7+
[id="workload-identity-federation-requirements_{context}"]
8+
= Workload Identity Federation requirements
9+
10+
You must complete the following prerequisites before xref:../osd_gcp_clusters/creating-a-gcp-cluster-with-workload-identity-federation.adoc#create-wif-cluster-ocm_osd-creating-a-cluster-on-gcp-with-workload-identity-federation[Creating a Workload Identity Federation cluster using OpenShift Cluster Manager] and xref:../osd_gcp_clusters/creating-a-gcp-cluster-with-workload-identity-federation.adoc#create-wif-cluster-cli_osd-creating-a-cluster-on-gcp-with-workload-identity-federation[Creating a Workload Identity Federation cluster using the OCM CLI].
11+
12+
* You have confirmed your {gcp-full} account has the necessary resource quotas and limits to support your desired cluster size according to the cluster resource requirements.
13+
+
14+
[NOTE]
15+
====
16+
For more information regarding resource quotas and limits, see _Resource quotas per project_ in the _Additional resources_ section.
17+
====
18+
+
19+
* You have reviewed the xref:../osd_architecture/osd-understanding.adoc#osd-understanding[introduction to {product-title}] and the documentation on xref:../architecture/index.adoc#architecture-overview[architecture concepts].
20+
* You have reviewed the xref:../osd_getting_started/osd-understanding-your-cloud-deployment-options.adoc#osd-understanding-your-cloud-deployment-options[{product-title} cloud deployment options].
21+
* You have read and completed the xref:../osd_planning/gcp-ccs.adoc#ccs-gcp-customer-procedure_gcp-ccs[Required customer procedure].
22+
23+
[NOTE]
24+
====
25+
WIF supports the deployment of a private {product-title} on {GCP} cluster with Private Service Connect (PSC). Red Hat recommends using PSC when deploying private clusters.
26+
For more information about the prerequisites for PSC, see xref:../osd_gcp_clusters/creating-a-gcp-psc-enabled-private-cluster.adoc#private-service-connect-prereqs[Prerequisites for Private Service Connect].
27+
====
28+
29+

‎osd_gcp_clusters/creating-a-gcp-cluster-with-workload-identity-federation.adoc‎

Lines changed: 14 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -4,45 +4,23 @@ include::_attributes/attributes-openshift-dedicated.adoc[]
44
= Creating a cluster on {gcp-short} with Workload Identity Federation authentication
55
:context: osd-creating-a-cluster-on-gcp-with-workload-identity-federation
66

7+
[role="_abstract"]
8+
Learn how to create an {product-title} cluster on {gcp-full} using Workload Identity Federation (WIF) for authentication.
79
toc::[]
810

911
include::modules/wif-overview.adoc[leveloffset=+1]
10-
11-
[id="osd-creating-a-cluster-on-gcp-prerequisites1_{context}"]
12-
== Prerequisites
13-
You must complete the following prerequisites before xref:../osd_gcp_clusters/creating-a-gcp-cluster-with-workload-identity-federation.adoc#create-wif-cluster-ocm_osd-creating-a-cluster-on-gcp-with-workload-identity-federation[Creating a Workload Identity Federation cluster using OpenShift Cluster Manager] and xref:../osd_gcp_clusters/creating-a-gcp-cluster-with-workload-identity-federation.adoc#create-wif-cluster-cli_osd-creating-a-cluster-on-gcp-with-workload-identity-federation[Creating a Workload Identity Federation cluster using the OCM CLI].
14-
15-
16-
* You have confirmed your {gcp-full} account has the necessary resource quotas and limits to support your desired cluster size according to the cluster resource requirements.
17-
+
18-
[NOTE]
19-
====
20-
For more information regarding resource quotas and limits, see _Additional resources_.
21-
====
22-
23-
* You have reviewed the xref:../osd_architecture/osd-understanding.adoc#osd-understanding[introduction to {product-title}] and the documentation on xref:../architecture/index.adoc#architecture-overview[architecture concepts].
24-
* You have reviewed the xref:../osd_getting_started/osd-understanding-your-cloud-deployment-options.adoc#osd-understanding-your-cloud-deployment-options[{product-title} cloud deployment options].
25-
26-
* You have read and completed the xref:../osd_planning/gcp-ccs.adoc#ccs-gcp-customer-procedure_gcp-ccs[Required customer procedure].
27-
28-
[NOTE]
29-
====
30-
WIF supports the deployment of a private {product-title} on {GCP} cluster with Private Service Connect (PSC). Red Hat recommends using PSC when deploying private clusters.
31-
For more information about the prerequisites for PSC, see xref:../osd_gcp_clusters/creating-a-gcp-psc-enabled-private-cluster.adoc#private-service-connect-prereqs[Prerequisites for Private Service Connect].
32-
====
33-
12+
include::modules/wif-requirements.adoc[leveloffset=+1]
3413
include::modules/create-wif-cluster-ocm.adoc[leveloffset=+1]
3514
include::modules/create-wif-cluster-cli.adoc[leveloffset=+1]
3615

37-
38-
== Additional resources
39-
40-
* For information about {product-title} clusters using a Customer Cloud Subscription (CCS) model on {GCP}, see xref:../osd_planning/gcp-ccs.adoc#ccs-gcp-customer-requirements_gcp-ccs[Customer requirements].
41-
* For information about resource quotas, xref:../applications/quotas/quotas-setting-per-project.adoc[Resource quotas per project].
42-
* For information about limits, xref:../osd_planning/gcp-ccs.adoc#gcp-limits_gcp-ccs[{gcp-short} account limits].
43-
* For information about required APIs, see xref:../osd_planning/gcp-ccs.adoc#ccs-gcp-customer-procedure_gcp-ccs[Required customer procedure].
44-
* For information about managing workload identity pools, see link:https://cloud.google.com/iam/docs/manage-workload-identity-pools-providers[Manage workload identity pools and providers].
45-
* For information about managing roles and permissions in your {gcp-full} account, see link:https://cloud.google.com/iam/docs/roles-overview[Roles and permissions].
46-
* For a list of the supported maximums, see xref:../osd_planning/osd-limits-scalability.adoc#tested-cluster-maximums-sd_osd-limits-scalability[Cluster maximums].
47-
* For information about configuring identity providers, see xref:../authentication/sd-configuring-identity-providers.adoc#sd-configuring-identity-providers[Configuring identity providers].
48-
* For information about revoking cluster privileges, see xref:../authentication/osd-revoking-cluster-privileges.adoc#osd-revoking-cluster-privileges[Revoking privileges and access to an {product-title} cluster].
16+
.Additional resources
17+
18+
* For information about {product-title} clusters using a Customer Cloud Subscription (CCS) model on {GCP}, see xref:../osd_planning/gcp-ccs.adoc#ccs-gcp-customer-requirements_gcp-ccs[Customer requirements]
19+
* For information about resource quotas, see xref:../applications/quotas/quotas-setting-per-project.adoc[Resource quotas per project]
20+
* For information about limits, see xref:../osd_planning/gcp-ccs.adoc#gcp-limits_gcp-ccs[{gcp-short} account limits]
21+
* For information about required APIs, see xref:../osd_planning/gcp-ccs.adoc#ccs-gcp-customer-procedure_gcp-ccs[Required customer procedure]
22+
* For information about managing workload identity pools, see link:https://cloud.google.com/iam/docs/manage-workload-identity-pools-providers[Manage workload identity pools and providers]
23+
* For information about managing roles and permissions in your {gcp-full} account, see link:https://cloud.google.com/iam/docs/roles-overview[Roles and permissions]
24+
* For a list of the supported maximums, see xref:../osd_planning/osd-limits-scalability.adoc#tested-cluster-maximums-sd_osd-limits-scalability[Cluster maximums]
25+
* For information about configuring identity providers, see xref:../authentication/sd-configuring-identity-providers.adoc#sd-configuring-identity-providers[Configuring identity providers]
26+
* For information about revoking cluster privileges, see xref:../authentication/osd-revoking-cluster-privileges.adoc#osd-revoking-cluster-privileges[Revoking privileges and access to an {product-title} cluster]

0 commit comments

Comments
 (0)