diff --git a/.vale.ini b/.vale.ini index fea3b0635ed2..669dee073244 100644 --- a/.vale.ini +++ b/.vale.ini @@ -1,48 +1,6 @@ StylesPath = .vale/styles +MinAlertLevel = warning +Packages = https://github.com/jhradilek/asciidoctor-dita-vale/releases/latest/download/AsciiDocDITA.zip -MinAlertLevel = suggestion - -Packages = RedHat, AsciiDoc, OpenShiftAsciiDoc, https://github.com/jhradilek/asciidoctor-dita-vale/releases/latest/download/AsciiDocDITA.zip - -Vocab = OpenShiftDocs - -# Ignore files in dirs starting with `.` to avoid raising errors for `.vale/fixtures/*/testinvalid.adoc` files -[[!.]*.adoc] -BasedOnStyles = RedHat, AsciiDoc, OpenShiftAsciiDoc - -# Disabling rules (NO) -RedHat.ReleaseNotes = NO - -# Use local OpenShiftDocs Vocab terms -Vale.Terms = YES -Vale.Avoid = YES - -# Enable specifc DITA rules on assemblies -AsciiDocDITA.AdmonitionTitle = error -AsciiDocDITA.ThematicBreak = error -AsciiDocDITA.TableFooter = error -AsciiDocDITA.PageBreak = error -AsciiDocDITA.DiscreteHeading = error -AsciiDocDITA.SidebarBlock = error -AsciiDocDITA.LineBreak = error -AsciiDocDITA.EquationFormula = error -AsciiDocDITA.TaskExample = error -AsciiDocDITA.EntityReference = error -AsciiDocDITA.ExampleBlock = error -AsciiDocDITA.ContentType = error -AsciiDocDITA.ShortDescription = error -AsciiDocDITA.NestedSection = error - -# Disable module specific rules -OpenShiftAsciiDoc.ModuleContainsParentAssemblyComment = NO -OpenShiftAsciiDoc.NoNestingInModules = NO -OpenShiftAsciiDoc.NoXrefInModules = NO -OpenShiftAsciiDoc.IdHasContextVariable = NO -OpenShiftAsciiDoc.NoTocInModules = NO - -# Optional: pass doc attributes to asciidoctor before linting -# Temp values are used for Prow CI comment linting only -[asciidoctor] -temp-ifdef = YES -temp-ifndef = NO -temp-ifeval = temp +[*.adoc] +BasedOnStyles = AsciiDocDITA diff --git a/modules/wif-overview.adoc b/modules/wif-overview.adoc index a26b1edfb0b2..69c43d5a53cb 100644 --- a/modules/wif-overview.adoc +++ b/modules/wif-overview.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * osd_install_access_delete_cluster/creating-a-gcp-cluster-with-workload-identity-federation.adoc +// *osd_gcp_clusters/osd-creating-a-cluster-on-gcp-with-workload-identity-federation.adoc :_mod-docs-content-type: CONCEPT diff --git a/modules/wif-requirements.adoc b/modules/wif-requirements.adoc new file mode 100644 index 000000000000..5f1a13e039f9 --- /dev/null +++ b/modules/wif-requirements.adoc @@ -0,0 +1,29 @@ +// Module included in the following assemblies: +// +// * osd_gcp_clusters/osd-creating-a-cluster-on-gcp-with-workload-identity-federation.adoc + + +:_mod-docs-content-type: CONCEPT +[id="workload-identity-federation-requirements_{context}"] += Workload Identity Federation requirements + +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]. + +* 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. ++ +[NOTE] +==== +For more information regarding resource quotas and limits, see _Resource quotas per project_ in the _Additional resources_ section. +==== ++ +* 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]. +* 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]. +* You have read and completed the xref:../osd_planning/gcp-ccs.adoc#ccs-gcp-customer-procedure_gcp-ccs[Required customer procedure]. + +[NOTE] +==== +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. +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]. +==== + + diff --git a/osd_gcp_clusters/creating-a-gcp-cluster-with-workload-identity-federation.adoc b/osd_gcp_clusters/creating-a-gcp-cluster-with-workload-identity-federation.adoc index 249e007e7226..467a210e3024 100644 --- a/osd_gcp_clusters/creating-a-gcp-cluster-with-workload-identity-federation.adoc +++ b/osd_gcp_clusters/creating-a-gcp-cluster-with-workload-identity-federation.adoc @@ -4,45 +4,23 @@ include::_attributes/attributes-openshift-dedicated.adoc[] = Creating a cluster on {gcp-short} with Workload Identity Federation authentication :context: osd-creating-a-cluster-on-gcp-with-workload-identity-federation +[role="_abstract"] +Learn how to create an {product-title} cluster on {gcp-full} using Workload Identity Federation (WIF) for authentication. toc::[] include::modules/wif-overview.adoc[leveloffset=+1] - -[id="osd-creating-a-cluster-on-gcp-prerequisites1_{context}"] -== Prerequisites -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]. - - -* 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. -+ -[NOTE] -==== -For more information regarding resource quotas and limits, see _Additional resources_. -==== - -* 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]. -* 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]. - -* You have read and completed the xref:../osd_planning/gcp-ccs.adoc#ccs-gcp-customer-procedure_gcp-ccs[Required customer procedure]. - -[NOTE] -==== -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. -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]. -==== - +include::modules/wif-requirements.adoc[leveloffset=+1] include::modules/create-wif-cluster-ocm.adoc[leveloffset=+1] include::modules/create-wif-cluster-cli.adoc[leveloffset=+1] - -== Additional resources - -* 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]. -* For information about resource quotas, xref:../applications/quotas/quotas-setting-per-project.adoc[Resource quotas per project]. -* For information about limits, xref:../osd_planning/gcp-ccs.adoc#gcp-limits_gcp-ccs[{gcp-short} account limits]. -* For information about required APIs, see xref:../osd_planning/gcp-ccs.adoc#ccs-gcp-customer-procedure_gcp-ccs[Required customer procedure]. -* 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]. -* 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]. -* For a list of the supported maximums, see xref:../osd_planning/osd-limits-scalability.adoc#tested-cluster-maximums-sd_osd-limits-scalability[Cluster maximums]. -* For information about configuring identity providers, see xref:../authentication/sd-configuring-identity-providers.adoc#sd-configuring-identity-providers[Configuring identity providers]. -* 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]. \ No newline at end of file +.Additional resources + +* 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] +* For information about resource quotas, see xref:../applications/quotas/quotas-setting-per-project.adoc[Resource quotas per project] +* For information about limits, see xref:../osd_planning/gcp-ccs.adoc#gcp-limits_gcp-ccs[{gcp-short} account limits] +* For information about required APIs, see xref:../osd_planning/gcp-ccs.adoc#ccs-gcp-customer-procedure_gcp-ccs[Required customer procedure] +* 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] +* 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] +* For a list of the supported maximums, see xref:../osd_planning/osd-limits-scalability.adoc#tested-cluster-maximums-sd_osd-limits-scalability[Cluster maximums] +* For information about configuring identity providers, see xref:../authentication/sd-configuring-identity-providers.adoc#sd-configuring-identity-providers[Configuring identity providers] +* 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] \ No newline at end of file