alibaba vpc new assembly

[GroceryBoyJr]

Problem: This PR adds a new section that works correctly for Alibaba VPC installation

Version(s): 4.8+

Issue: https://bugzilla.redhat.com/show_bug.cgi?id=

Link to docs preview: http://file.rdu.redhat.com/jbrigman/alibaba-vpc/installing/installing_alibaba/installing-alibaba-vpc.html

Additional information: Initial review needed by product owner Gaurav Singh

[netlify[bot]]

✅ Deploy Preview for osdocs ready!

Name	Link
🔨 Latest commit	431e799109cea2b3f728874179354015bd367c91
🔍 Latest deploy log	https://app.netlify.com/sites/osdocs/deploys/627036573ec415000828010e
😎 Deploy Preview	https://deploy-preview-44593--osdocs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site settings.

[jianli-wei]

Problem: This PR adds a new section that works correctly for Alibaba VPC installation

Version(s): 4.8+

Issue: https://bugzilla.redhat.com/show_bug.cgi?id=

Link to docs preview: http://file.rdu.redhat.com/jbrigman/alibaba-vpc/installing/installing_alibaba/installing-alibaba-vpc.html

Additional information: Initial review needed by product owner Gaurav Singh

The Version(s) should be 4.10+, thanks!

[ocpdocs-previewbot]

🤖 Updated build preview is available at: https://44593--docspreview.netlify.app

Build log: https://circleci.com/gh/ocpdocs-previewbot/openshift-docs/1651

[jianli-wei]

@GroceryBoyJr Another 2 suggestions, thanks!

Replace "alibaba" with "alibabacloud" in below parameters' description. Table 3. Optional parameters compute.platform controlPlane.platform

Remove the parameter from the optional params list. Table 4. Optional Alibaba Cloud parameters platform.alibabacloud.region

[GroceryBoyJr]

Problem: This PR adds a new section that works correctly for Alibaba VPC installation Version(s): 4.8+ Issue: https://bugzilla.redhat.com/show_bug.cgi?id= Link to docs preview: http://file.rdu.redhat.com/jbrigman/alibaba-vpc/installing/installing_alibaba/installing-alibaba-vpc.html Additional information: Initial review needed by product owner Gaurav Singh

The Version(s) should be 4.10+, thanks!

Changed, thank you!

[GroceryBoyJr]

@GroceryBoyJr Another 2 suggestions, thanks!

Replace "alibaba" with "alibabacloud" in below parameters' description. Table 3. Optional parameters compute.platform controlPlane.platform

Remove the parameter from the optional params list. Table 4. Optional Alibaba Cloud parameters platform.alibabacloud.region

This is done, thank you so much @jianli-wei

[jianli-wei]

Hi @GroceryBoyJr, some other final suggestions, if possible, please address, thanks in advance!

1. Below parameters are for both compute machines and control plane machines, if not otherwise specified. Table 4. Optional Alibaba Cloud parameters

• platform.alibabacloud.defaultMachinePlatform.imageID (btw, it's description statement missing the ending dot)
• platform.alibabacloud.defaultMachinePlatform.instanceType
• platform.alibabacloud.defaultMachinePlatform.systemDiskCategory
• platform.alibabacloud.defaultMachinePlatform.systemDiskSize
• platform.alibabacloud.defaultMachinePlatform.zones

2. Table 4 doesn't list parameters under compute.platform.alibabacloud and controlPlane.platform.alibabacloud, which would overwrite platform.alibabacloud.defaultMachinePlatform for compute machines and control plane machines respectively. Suggest to add a statement telling it before the table.

3. Suggest to move Sample customized install-config.yaml file for Alibaba Cloud to before Generating the required installation manifests.

[GroceryBoyJr]

Problem: This PR adds a new section that works correctly for Alibaba VPC installation Version(s): 4.8+ Issue: https://bugzilla.redhat.com/show_bug.cgi?id= Link to docs preview: http://file.rdu.redhat.com/jbrigman/alibaba-vpc/installing/installing_alibaba/installing-alibaba-vpc.html Additional information: Initial review needed by product owner Gaurav Singh

The Version(s) should be 4.10+, thanks!

Done, thank you!

[GroceryBoyJr]

Hi @GroceryBoyJr, some other final suggestions, if possible, please address, thanks in advance!

1. Below parameters are for both compute machines and control plane machines, if not otherwise specified. Table 4. Optional Alibaba Cloud parameters

• platform.alibabacloud.defaultMachinePlatform.imageID (btw, it's description statement missing the ending dot)
• platform.alibabacloud.defaultMachinePlatform.instanceType
• platform.alibabacloud.defaultMachinePlatform.systemDiskCategory
• platform.alibabacloud.defaultMachinePlatform.systemDiskSize
• platform.alibabacloud.defaultMachinePlatform.zones

Added the note to the text just above the table (and fixed the missing dot, thank you!)

2. Table 4 doesn't list parameters under compute.platform.alibabacloud and controlPlane.platform.alibabacloud, which would overwrite platform.alibabacloud.defaultMachinePlatform for compute machines and control plane machines respectively. Suggest to add a statement telling it before the table.

Added a NOTE saying this, just above the table.

3. Suggest to move Sample customized install-config.yaml file for Alibaba Cloud to before Generating the required installation manifests.

Moved example YAML section to where you requested.

These requests are complete. Thank you gents!

[GroceryBoyJr]

@jianli-wei @twiest All requested changes are complete - PTAL. If you believe we're good to go, please let me have an "LGTM", I need that from both of you before I'll be able to go to peer review. (peer review looks at style, content, punctuation, syntax review)

[jianli-wei]

@GroceryBoyJr Sorry, it seems I didn't put it very clear on the table 4 suggestions, let me clarify. Very sorry to bother you again.

1. Now in table 4, e.g. the Description field of platform.alibabacloud.defaultMachinePlatform.imageID still tells "For compute machines, the image ID that...", while in fact the parameter is for both compute machines and control plane machines, if not otherwise specified.
2. I also checked aws doc (table 4) and azure doc (table 5) on the similar table content, although neither is perfect, both firstly list compute parameters (e.g. compute.platform.aws.amiID in aws doc), then controlPlane parameters (e.g. controlPlane.platform.aws.amiID in aws doc), and then defaultMachinePlatform parameters (e.g. platform.aws.defaultMachinePlatform.amiID in aws doc).
3. In order to be consistent with other provider doc, suggest to also firstly list compute.platform.alibabacloud parameters, then controlPlane.platform.alibabacloud parameters, and then platform.alibabacloud.defaultMachinePlatform parameters (along with other platform.alibabacloud parameters) in table 4, and explicitly tell in each parameter's Description field that the parameter is for compute machines, or control plane machines, or both. I think this way would be much clear, HDYT?
4. If you agree, please remove the statements/notes added last time.

[GroceryBoyJr]

@GroceryBoyJr Sorry, it seems I didn't put it very clear on the table 4 suggestions, let me clarify. Very sorry to bother you again.

Thank you so much, appreciate the clarification, no bother at all @jianli-wei and @twiest .

1. Now in table 4, e.g. the Description field of platform.alibabacloud.defaultMachinePlatform.imageID still tells "For compute machines, the image ID that...", while in fact the parameter is for both compute machines and control plane machines, if not otherwise specified.

I have added this individually for each option.

2. I also checked aws doc (table 4) and azure doc (table 5) on the similar table content, although neither is perfect, both firstly list compute parameters (e.g. compute.platform.aws.amiID in aws doc), then controlPlane parameters (e.g. controlPlane.platform.aws.amiID in aws doc), and then defaultMachinePlatform parameters (e.g. platform.aws.defaultMachinePlatform.amiID in aws doc).

OK, I see that also.

3. In order to be consistent with other provider doc, suggest to also firstly list compute.platform.alibabacloud parameters, then controlPlane.platform.alibabacloud parameters, and then platform.alibabacloud.defaultMachinePlatform parameters (along with other platform.alibabacloud parameters) in table 4, and explicitly tell in each parameter's Description field that the parameter is for compute machines, or control plane machines, or both. I think this way would be much clear, HDYT?

I do not have any compute.platform.alibabacloud or controlPlane.platform.alibabacloud optional parameters in Table 4. All I have are platform.alibabacloud and platform.alibabacloud.defaultMachinePlatform. I don't understand?

If there are missing values, is it possible, please, for me to move ahead with this PR then open a new one to correct the table only? I am worried, because there's nothing there yet for Alibaba VPC, would like to get the documentation in and improve it with another much smaller PR. (This one is an XL or XXL.)

4. If you agree, please remove the statements/notes added last time. I have removed or edited the statements. I kept the form of the text before the table because it is clear, but I didn't completely delete, wanted to emphasize to the customer some parameters apply to both compute and control plane.

[GroceryBoyJr]

@twiest @jianli-wei have made changes to Table 4 and pushed them to the preview.

[jianli-wei]

I do not have any compute.platform.alibabacloud or controlPlane.platform.alibabacloud optional parameters in Table 4. All I have are platform.alibabacloud and platform.alibabacloud.defaultMachinePlatform. I don't understand?

@GroceryBoyJr My bad again, I'd thought you know the installer's explain command. For example, start with openshift-install explain installconfig and then dig into each interested field of "object" (or list of "object") type.

$ openshift-install version
openshift-install 4.12.0-0.nightly-2022-09-28-204419
built from commit 9eb0224926982cdd6cae53b872326292133e532d
release image registry.ci.openshift.org/ocp/release@sha256:2c8e617830f84ac1ee1bfcc3581010dec4ae5d9cad7a54271574e8d91ef5ecbc
release architecture amd64
$ 
$ openshift-install explain installconfig.platform.alibabacloud.defaultMachinePlatform
KIND:     InstallConfig
VERSION:  v1

RESOURCE: <object>
  DefaultMachinePlatform is the default configuration used when installing on Alibaba Cloud for machine pools which do not define their own platform configuration.

FIELDS:
    imageID <string>
      ImageID is the Image ID that should be used to create ECS instance. If set, the ImageID should belong to the same region as the cluster.

    instanceType <string>
      InstanceType defines the ECS instance type. eg. ecs.g6.large

    systemDiskCategory <string>
      Valid Values: "","cloud_efficiency","cloud_essd"
      SystemDiskCategory defines the category of the system disk.

    systemDiskSize <integer>
      SystemDiskSize defines the size of the system disk in gibibytes (GiB).

    zones <[]string>
      Zones is list of availability zones that can be used. eg. ["cn-hangzhou-i", "cn-hangzhou-h", "cn-hangzhou-j"]

$ 
$ openshift-install explain installconfig.compute.platform.alibabacloud
KIND:     InstallConfig
VERSION:  v1

RESOURCE: <object>
  AlibabaCloud is the configuration used when installing on Alibaba Cloud.

FIELDS:
    imageID <string>
      ImageID is the Image ID that should be used to create ECS instance. If set, the ImageID should belong to the same region as the cluster.

    instanceType <string>
      InstanceType defines the ECS instance type. eg. ecs.g6.large

    systemDiskCategory <string>
      Valid Values: "","cloud_efficiency","cloud_essd"
      SystemDiskCategory defines the category of the system disk.

    systemDiskSize <integer>
      SystemDiskSize defines the size of the system disk in gibibytes (GiB).

    zones <[]string>
      Zones is list of availability zones that can be used. eg. ["cn-hangzhou-i", "cn-hangzhou-h", "cn-hangzhou-j"]

$ 
$ openshift-install explain installconfig.controlPlane.platform.alibabacloud
KIND:     InstallConfig
VERSION:  v1

RESOURCE: <object>
  AlibabaCloud is the configuration used when installing on Alibaba Cloud.

FIELDS:
    imageID <string>
      ImageID is the Image ID that should be used to create ECS instance. If set, the ImageID should belong to the same region as the cluster.

    instanceType <string>
      InstanceType defines the ECS instance type. eg. ecs.g6.large

    systemDiskCategory <string>
      Valid Values: "","cloud_efficiency","cloud_essd"
      SystemDiskCategory defines the category of the system disk.

    systemDiskSize <integer>
      SystemDiskSize defines the size of the system disk in gibibytes (GiB).

    zones <[]string>
      Zones is list of availability zones that can be used. eg. ["cn-hangzhou-i", "cn-hangzhou-h", "cn-hangzhou-j"]

$ 

[GroceryBoyJr]

@jianli-wei I do understand the installer's "explain" feature and use it often, but transcribing the installer text to the documentation is not requested of us by the developers. However, if other documentation sections are more complete, you have a good point and I will work to solve that problem as quickly as I can. Please stand by. (note we have a hurricane bearing down here right now which may delay my completing this work.)

[GroceryBoyJr]

@jianli-wei thank you for your feedback about "Table 4. Optional Alibaba Cloud Parameters". I am listing the fields in this order: platform.alibabacloud, compute.platform.alibabacloud, controlplane.platform.alibabacloud, platform.alibabacloud.defaultMachinePlatform. This is the same as what you asked for, except I have kept "platform.alibabacloud" first.

[GroceryBoyJr]

@jianli-wei @twiest Do you know if there is a 120 GiB minimum for controlPlane.platform.alibabacloud.systemDisksize ?

[GroceryBoyJr]

@jianli-wei @twiest all requested updates have been made - please review at the preview link at this time. I welcome any additions or changes you request for the document.

[GroceryBoyJr]

@twiest Tom - you still have a "Changes Requested" showing on this PR 44593. Check me please sir, is there anything you asked for that I have missed?

[twiest]

@jianli-wei @twiest Do you know if there is a 120 GiB minimum for controlPlane.platform.alibabacloud.systemDisksize ?

I'm not aware of this requirement. Where are you seeing it?

[jianli-wei]

@jianli-wei @twiest Do you know if there is a 120 GiB minimum for controlPlane.platform.alibabacloud.systemDisksize ?

I'm not aware of this requirement. Where are you seeing it?

@GroceryBoyJr FYI https://docs.openshift.com/container-platform/4.11/installing/installing_gcp/installing-gcp-customizations.html#installation-minimum-resource-requirements_installing-gcp-customizations

[openshift-merge-robot]

@GroceryBoyJr: 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/test-infra repository.