Skip to content

OSDOCS-14757 greatly reducing GCP sample install config files #93709

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

bscott-rh
Copy link
Contributor

@bscott-rh bscott-rh commented May 22, 2025

Version(s):
4.19

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

Link to docs preview:
Customizations
Network customizations
Private cluster
Shared VPC
Existing VPC
Disconnected env

QE review:

  • QE has approved this change.

Additional information:
I added a module to the shared VPC installation assembly to give extra attention to the necessary shared VPC parameters while still using the new sample yaml:
shared VPC parameters

@bscott-rh bscott-rh added this to the Planned for 4.19 GA milestone May 22, 2025
@openshift-ci openshift-ci bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label May 22, 2025
@bscott-rh bscott-rh changed the title OSDOCS-14757 simplified GCP install config yaml file, replaced shared vpc config yaml OSDOCS-14757 greatly reducing GCP sample install config files May 22, 2025
Copy link

openshift-ci bot commented May 22, 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.

name: master
replicas: 3
platform:
gcp:
Copy link
Contributor

Choose a reason for hiding this comment

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

Not sure how minimal you want to go but this type may not be required, but if you do want to show the structure there are certainly other fields that could be mentioned here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yeah, I am open to suggestions. At a minimum I'd like to put 1 parameter in each section. is there another you would recommend?

type: n2-standard-4
metadata:
name: test-cluster
networking: <4>
Copy link
Contributor

Choose a reason for hiding this comment

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

As a default, you may be able to drop the networking section. I am sure that this is present in the base install config.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I want to include the networking stanza because this sample is also included in the "...with network customizations" installation procedure so I want to show what that portion of the file looks like.

<1> The name of the subnet in the shared VPC for compute machines to use.
Copy link
Contributor

Choose a reason for hiding this comment

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

The credentialsMode still applies I believe. Should be leave that or mention it somewhere else ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I was going off of what we have the parameters table, which is "If no mode is specified, the CCO dynamically tries to determine the capabilities of the provided credentials, with a preference for mint mode on the platforms where multiple modes are supported. "

would you recommend we still specify credentials mode? if so, which mode should we put in the sample?

@barbacbd
Copy link
Contributor

barbacbd commented Jun 3, 2025

/cc @patrickdillon

@openshift-ci openshift-ci bot requested a review from patrickdillon June 3, 2025 14:47
hostPrefix: 23
platform: <5>
gcp:
projectID: sample-project

Choose a reason for hiding this comment

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

platform.gcp.region is also a required field.

Choose a reason for hiding this comment

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

@bscott-rh Besides, I'm trying to understand the updates, for example, in the 4.18 doc chapter "Chapter 6. Installing a cluster on GCP in a disconnected environment", the section "6.5. Creating the installation configuration file" explains how to edit "install-config.yaml" to give the additional information that is required for an installation in a restricted network. But in your changes, it seems no such info, how do you expect the end-users know generally what's required?

@bergerhoffer
Copy link
Contributor

The branch/enterprise-4.20 label has been added to this PR.

This is because your PR targets the main branch and is labeled for enterprise-4.19. And any PR going into main must also target the latest version branch (enterprise-4.20).

If the update in your PR does NOT apply to version 4.20 onward, please re-target this PR to go directly into the appropriate version branch or branches (enterprise-4.x) instead of main.

@openshift-merge-robot openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jun 16, 2025
@openshift-merge-robot
Copy link

PR needs rebase.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
branch/enterprise-4.19 branch/enterprise-4.20 needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants