OSDOCS-14757 greatly reducing GCP sample install config files #93709
Conversation
openshift-ci
bot
added
the
size/L
bscott-rh
changed the title
| name: master | ||
| replicas: 3 | ||
| platform: | ||
| gcp: |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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> |
There was a problem hiding this comment.
As a default, you may be able to drop the networking section. I am sure that this is present in the base install config.
There was a problem hiding this comment.
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.
| <6> The name of the GCP project where you want to install the cluster. | ||
| <7> Optional. One or more network tags to apply to compute machines, control plane machines, or all machines. | ||
| <8> You can optionally provide the `sshKey` value that you use to access the machines in your cluster. | ||
| <1> The name of the subnet in the shared VPC for compute machines to use. |
There was a problem hiding this comment.
The credentialsMode still applies I believe. Should be leave that or mention it somewhere else ?
There was a problem hiding this comment.
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?
|
/cc @patrickdillon |
| hostPrefix: 23 | ||
| platform: <5> | ||
| gcp: | ||
| projectID: sample-project |
There was a problem hiding this comment.
platform.gcp.region is also a required field.
There was a problem hiding this comment.
@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?
There was a problem hiding this comment.
Hi @jianli-wei , I am resuming work on this ticket finally :) I will add the region parameter.
Regarding the updates, if the correct information is in the "Creating the installation configuration file" procedure, then it is okay for it to be removed from the sample install-config.yaml file, because the sample file is only meant to be a reference for the syntax of the file, not a complete config file. Does that make sense?
|
The This is because your PR targets the 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
added
the
needs-rebase
|
Issues go stale after 90d of inactivity. Mark the issue as fresh by commenting If this issue is safe to close now please do so with /lifecycle stale |
openshift-ci
bot
added
the
lifecycle/stale
|
Stale issues rot after 30d of inactivity. Mark the issue as fresh by commenting If this issue is safe to close now please do so with /lifecycle rotten |
openshift-ci
bot
added
lifecycle/rotten
|
The This is because your PR targets the If the update in your PR does NOT apply to version 4.21 onward, please re-target this PR to go directly into the appropriate version branch or branches (enterprise-4.x) instead of main. |
bscott-rh
force-pushed
the
OSDOCS-14757
branch
from
edc59a4 to
b61706c
Compare
openshift-merge-robot
removed
the
needs-rebase
|
/remove-lifecycle rotten |
openshift-ci
bot
removed
the
lifecycle/rotten
|
@bscott-rh: all tests passed! Full PR test history. Your PR dashboard. DetailsInstructions 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. |
9 participants
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:
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