Skip to content

Conversation

@bscott-rh
Copy link
Contributor

@bscott-rh bscott-rh commented Oct 15, 2025

Versions: 4.12+

Issue: https://issues.redhat.com/browse/OSDOCS-16547

No QE required as this is just a text substitution. Previews are not listed as there are too many, but the preview is here:
https://100535--ocpdocs-pr.netlify.app/

Partner PR to #100525

@openshift-ci openshift-ci bot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Oct 15, 2025
@ocpdocs-previewbot
Copy link

ocpdocs-previewbot commented Oct 15, 2025

🤖 Thu Oct 23 19:25:48 - Prow CI generated the docs preview:
https://100535--ocpdocs-pr.netlify.app
Complete list of updated preview URLs: artifacts/updated_preview_urls.txt

@bscott-rh bscott-rh force-pushed the replace-google-cloud-attr branch from 876e605 to fd8ed84 Compare October 23, 2025 15:14
Copy link
Contributor

@snarayan-redhat snarayan-redhat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Left couple of FYI comments.

Comment on lines +23 to +26
// on {gcp-full}
include::modules/cert-manager-configure-cloud-credentials-gcp-non-sts.adoc[leveloffset=+1]

// with GCP Workload Identity
// with {gcp-full} Workload Identity
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since attributes are not parsed in comments, this might not be the best fix. Not a blocker. I can handle this one separately. This PR can move on as-is.

Comment on lines -51 to +54
// Configuring an ACME issuer to solve DNS01 challenges by using explicit credentials on GCP
// Configuring an ACME issuer to solve DNS01 challenges by using explicit credentials on {gcp-full}
include::modules/cert-manager-acme-dns01-explicit-gcp.adoc[leveloffset=+1]

// Configuring an ACME issuer to solve DNS01 challenges by using ambient credentials on GCP
// Configuring an ACME issuer to solve DNS01 challenges by using ambient credentials on {gcp-full}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since attributes are not parsed in comments, this might not be the best fix. Not a blocker. I can handle this one separately. This PR can move on as-is.

@lahinson
Copy link
Contributor

LGTM for etcd and HCP content

Copy link
Contributor

@bergerhoffer bergerhoffer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One comment about backing out changes to the API doc file, but otherwise LGTM!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

API docs shouldn't be manually changed.

ifeval::["{context}" == "installing-gcp-user-infra"]
:cp-first: Google Cloud Platform
:cp-first: Google Cloud
:cp: GCP
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this {cp} attribute renders to GCP

* Red{nbsp}Hat must have {gcp-short} console access to the customer-provided {gcp-short} account. This access is protected and managed by Red{nbsp}Hat.

* The customer must not utilize the GCP account to elevate their permissions within the {product-title} cluster.
* The customer must not utilize the {gcp-short} account to elevate their permissions within the {product-title} cluster.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 [error] RedHat.TermsErrors: Use 'use' rather than 'utilize'. For more information, see RedHat.TermsErrors.


* If your cluster is configured to use GCP Workload Identity, you followed the instructions from the _Configuring cloud credentials for the cert-manager Operator for Red Hat OpenShift with GCP Workload Identity_ section.
* If your cluster does not use GCP Workload Identity, you followed the instructions from the _Configuring cloud credentials for the cert-manager Operator for Red Hat OpenShift on GCP_ section.
* If your cluster is configured to use {gcp-short} Workload Identity, you followed the instructions from the _Configuring cloud credentials for the cert-manager Operator for Red Hat OpenShift with {gcp-short} Workload Identity_ section.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 [error] OpenShiftAsciiDoc.SuggestAttribute: Use the AsciiDoc attribute '{cert-manager-operator}' rather than the plain text product term 'cert-manager Operator for Red Hat OpenShift', unless your use case is an exception.



The {product-title} cluster uses a number of Google Cloud Platform (GCP) components, but the default link:https://cloud.google.com/docs/quota[quotas] do not affect your ability to install an {product-title} cluster.
The {product-title} cluster uses a number of {gcp-first} components, but the default link:https://cloud.google.com/docs/quota[quotas] do not affect your ability to install an {product-title} cluster.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 [error] RedHat.TermsErrors: Use 'several' rather than 'a number of'. For more information, see RedHat.TermsErrors.

= {gcp-short} account limits

The {product-title} cluster uses a number of Google Cloud Platform (GCP)
The {product-title} cluster uses a number of {gcp-first}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 [error] RedHat.TermsErrors: Use 'several' rather than 'a number of'. For more information, see RedHat.TermsErrors.

ifdef::aws[You can launch a Spot Instance on AWS by adding `spotMarketOptions` to your compute machine set YAML file.]
ifdef::azure[You can launch a Spot VM on Azure by adding `spotVMOptions` to your compute machine set YAML file.]
ifdef::gcp[You can launch a preemptible VM instance on GCP by adding `preemptible` to your compute machine set YAML file.]
ifdef::gcp[You can launch a preemptible VM instance on {gcp-short} by adding `preemptible` to your compute machine set YAML file.]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 [error] AsciiDoc.ValidConditions: File contains unbalanced if statements. Review the file to ensure it contains matching opening and closing if statements.

endif::azure[]
ifdef::gcp[]
You can save on costs by creating a compute machine set running on GCP that deploys machines as non-guaranteed preemptible VM instances. Preemptible VM instances utilize excess Compute Engine capacity and are less expensive than normal instances. You can use preemptible VM instances for workloads that can tolerate interruptions, such as batch or stateless, horizontally scalable workloads.
You can save on costs by creating a compute machine set running on {gcp-short} that deploys machines as non-guaranteed preemptible VM instances. Preemptible VM instances utilize excess Compute Engine capacity and are less expensive than normal instances. You can use preemptible VM instances for workloads that can tolerate interruptions, such as batch or stateless, horizontally scalable workloads.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 [error] RedHat.TermsErrors: Use 'use' rather than 'utilize'. For more information, see RedHat.TermsErrors.

----

. View the machines and machine sets that exist in the `openshift-machine-api` namespace by running the following command. Each compute machine set is associated with a different availability zone within the GCP region. The installer automatically load balances compute machines across availability zones.
. View the machines and machine sets that exist in the `openshift-machine-api` namespace by running the following command. Each compute machine set is associated with a different availability zone within the {gcp-short} region. The installer automatically load balances compute machines across availability zones.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 [error] RedHat.TermsErrors: Use 'installation program' rather than 'The installer'. For more information, see RedHat.TermsErrors.

[NOTE]
====
Red Hat recommends using Workload Identity Federation as the Authentication type. For more information, see xref:../osd_gcp_clusters/creating-a-gcp-cluster-with-workload-identity-federation.adoc#osd-creating-a-cluster-on-gcp-with-workload-identity-federation[Creating a cluster on GCP with Workload Identity Federation authentication].
Red Hat recommends using Workload Identity Federation as the Authentication type. For more information, see xref:../osd_gcp_clusters/creating-a-gcp-cluster-with-workload-identity-federation.adoc#osd-creating-a-cluster-on-gcp-with-workload-identity-federation[Creating a cluster on {gcp-short} with Workload Identity Federation authentication].
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 [error] OpenShiftAsciiDoc.NoXrefInModules: Do not include xrefs in modules, only assemblies.

@openshift-ci
Copy link

openshift-ci bot commented Oct 23, 2025

@bscott-rh: all tests passed!

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

@brendan-daly-red-hat
Copy link
Contributor

LGTM

@bscott-rh
Copy link
Contributor Author

Closed in favor of #101036

@bscott-rh bscott-rh closed this Oct 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

9 participants