Skip to content

Commit ae616f8

Browse files
bscott-rhbscott-rh
authored
Merge pull request #68695 from bscott-rh/nutanix-config-params-reformat
Reformatting Nutanix and Alibaba install config parameters
2 parents d0317df + 3d4fe9f commit ae616f8

File tree

1 file changed

+192
-48
lines changed

1 file changed

+192
-48
lines changed

‎modules/installation-configuration-parameters.adoc

Lines changed: 192 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -2469,91 +2469,148 @@ If defined, the parameters `compute.platform.alibabacloud` and `controlPlane.pla
24692469
====
24702470

24712471
.Optional {alibaba} parameters
2472-
[cols=".^2,.^3,.^5a",options="header"]
2472+
[cols=".^2l,.^3,.^5a",options="header"]
24732473
|====
24742474
|Parameter|Description|Values
24752475

2476-
|`compute.platform.alibabacloud.imageID`
2476+
|compute:
2477+
platform:
2478+
alibabacloud:
2479+
imageID:
24772480
|The imageID used to create the ECS instance. ImageID must belong to the same region as the cluster.
24782481
|String.
24792482

2480-
|`compute.platform.alibabacloud.instanceType`
2483+
|compute:
2484+
platform:
2485+
alibabacloud:
2486+
instanceType:
24812487
|InstanceType defines the ECS instance type. Example: `ecs.g6.large`
24822488
|String.
24832489

2484-
|`compute.platform.alibabacloud.systemDiskCategory`
2490+
|compute:
2491+
platform:
2492+
alibabacloud:
2493+
systemDiskCategory:
24852494
|Defines the category of the system disk. Examples: `cloud_efficiency`,`cloud_essd`
24862495
|String.
24872496

2488-
|`compute.platform.alibabacloud.systemDisksize`
2497+
|compute:
2498+
platform:
2499+
alibabacloud:
2500+
systemDisksize:
24892501
|Defines the size of the system disk in gibibytes (GiB).
24902502
|Integer.
24912503

2492-
|`compute.platform.alibabacloud.zones`
2504+
|compute:
2505+
platform:
2506+
alibabacloud:
2507+
zones:
24932508
|The list of availability zones that can be used. Examples: `cn-hangzhou-h`, `cn-hangzhou-j`
24942509
|String list.
24952510

2496-
|`controlPlane.platform.alibabacloud.imageID`
2511+
|controlPlane:
2512+
platform:
2513+
alibabacloud:
2514+
imageID:
24972515
|The imageID used to create the ECS instance. ImageID must belong to the same region as the cluster.
24982516
|String.
24992517

2500-
|`controlPlane.platform.alibabacloud.instanceType`
2518+
|controlPlane:
2519+
platform:
2520+
alibabacloud:
2521+
instanceType:
25012522
|InstanceType defines the ECS instance type. Example: `ecs.g6.xlarge`
25022523
|String.
25032524

2504-
|`controlPlane.platform.alibabacloud.systemDiskCategory`
2525+
|controlPlane:
2526+
platform:
2527+
alibabacloud:
2528+
systemDiskCategory:
25052529
|Defines the category of the system disk. Examples: `cloud_efficiency`,`cloud_essd`
25062530
|String.
25072531

2508-
|`controlPlane.platform.alibabacloud.systemDisksize`
2532+
|controlPlane:
2533+
platform:
2534+
alibabacloud:
2535+
systemDisksize:
25092536
|Defines the size of the system disk in gibibytes (GiB).
25102537
|Integer.
25112538

2512-
|`controlPlane.platform.alibabacloud.zones`
2539+
|controlPlane:
2540+
platform:
2541+
alibabacloud:
2542+
zones:
25132543
|The list of availability zones that can be used. Examples: `cn-hangzhou-h`, `cn-hangzhou-j`
25142544
|String list.
25152545

2516-
|`platform.alibabacloud.region`
2546+
|platform:
2547+
alibabacloud:
2548+
region:
25172549
|Required. The Alibaba Cloud region where the cluster will be created.
25182550
|String.
25192551

2520-
|`platform.alibabacloud.resourceGroupID`
2552+
|platform:
2553+
alibabacloud:
2554+
resourceGroupID:
25212555
|The ID of an already existing resource group where the cluster will be installed. If empty, the installation program will create a new resource group for the cluster.
25222556
|String.
25232557

2524-
|`platform.alibabacloud.tags`
2558+
|platform:
2559+
alibabacloud:
2560+
tags:
25252561
|Additional keys and values to apply to all Alibaba Cloud resources created for the cluster.
25262562
|Object.
25272563

2528-
|`platform.alibabacloud.vpcID`
2564+
|platform:
2565+
alibabacloud:
2566+
vpcID:
25292567
|The ID of an already existing VPC where the cluster should be installed. If empty, the installation program will create a new VPC for the cluster.
25302568
|String.
25312569

2532-
|`platform.alibabacloud.vswitchIDs`
2570+
|platform:
2571+
alibabacloud:
2572+
vswitchIDs:
25332573
|The ID list of already existing VSwitches where cluster resources will be created. The existing VSwitches can only be used when also using existing VPC. If empty, the installation program will create new VSwitches for the cluster.
25342574
|String list.
25352575

2536-
|`platform.alibabacloud.defaultMachinePlatform.imageID`
2576+
|platform:
2577+
alibabacloud:
2578+
defaultMachinePlatform:
2579+
imageID:
25372580
|For both compute machines and control plane machines, the image ID that should be used to create ECS instance. If set, the image ID should belong to the same region as the cluster.
25382581
|String.
25392582

2540-
|`platform.alibabacloud.defaultMachinePlatform.instanceType`
2583+
|platform:
2584+
alibabacloud:
2585+
defaultMachinePlatform:
2586+
instanceType:
25412587
|For both compute machines and control plane machines, the ECS instance type used to create the ECS instance. Example: `ecs.g6.xlarge`
25422588
|String.
25432589

2544-
|`platform.alibabacloud.defaultMachinePlatform.systemDiskCategory`
2590+
|platform:
2591+
alibabacloud:
2592+
defaultMachinePlatform:
2593+
systemDiskCategory:
25452594
|For both compute machines and control plane machines, the category of the system disk. Examples: `cloud_efficiency`, `cloud_essd`.
25462595
|String, for example "", `cloud_efficiency`, `cloud_essd`.
25472596

2548-
|`platform.alibabacloud.defaultMachinePlatform.systemDiskSize`
2597+
|platform:
2598+
alibabacloud:
2599+
defaultMachinePlatform:
2600+
systemDiskSize:
25492601
|For both compute machines and control plane machines, the size of the system disk in gibibytes (GiB). The minimum is `120`.
25502602
|Integer.
25512603

2552-
|`platform.alibabacloud.defaultMachinePlatform.zones`
2604+
|platform:
2605+
alibabacloud:
2606+
defaultMachinePlatform:
2607+
zones:
25532608
|For both compute machines and control plane machines, the list of availability zones that can be used. Examples: `cn-hangzhou-h`, `cn-hangzhou-j`
25542609
|String list.
25552610

2556-
|`platform.alibabacloud.privateZoneID`
2611+
|platform:
2612+
alibabacloud:
2613+
privateZoneID:
25572614
|The ID of an existing private zone into which to add DNS records for the cluster's internal API. An existing private zone can only be used when also using existing VPC. The private zone must be associated with the VPC containing the subnets. Leave the private zone unset to have the installation program create the private zone on your behalf.
25582615
|String.
25592616

@@ -2568,107 +2625,194 @@ ifdef::nutanix[]
25682625
Additional Nutanix configuration parameters are described in the following table:
25692626

25702627
.Additional Nutanix cluster parameters
2571-
[cols=".^2,.^3a,.^3a",options="header"]
2628+
[cols=".^2l,.^3a,.^3a",options="header"]
25722629
|====
25732630
|Parameter|Description|Values
25742631

2575-
|`compute.platform.nutanix.categories.key`
2632+
|compute:
2633+
platform:
2634+
nutanix:
2635+
categories:
2636+
key:
25762637
|The name of a prism category key to apply to compute VMs. This parameter must be accompanied by the `value` parameter, and both `key` and `value` parameters must exist in Prism Central. For more information on categories, see link:https://portal.nutanix.com/page/documents/details?targetId=Prism-Central-Guide-vpc_2022_6:ssp-ssp-categories-manage-pc-c.html[Category management].
25772638
|String
25782639

2579-
|`compute.platform.nutanix.categories.value`
2640+
|compute:
2641+
platform:
2642+
nutanix:
2643+
categories:
2644+
value:
25802645
|The value of a prism category key-value pair to apply to compute VMs. This parameter must be accompanied by the `key` parameter, and both `key` and `value` parameters must exist in Prism Central.
25812646
|String
25822647

2583-
|`compute.platform.nutanix.project.type`
2648+
|compute:
2649+
platform:
2650+
nutanix:
2651+
project:
2652+
type:
25842653
|The type of identifier you use to select a project for compute VMs. Projects define logical groups of user roles for managing permissions, networks, and other parameters. For more information on projects, see link:https://portal.nutanix.com/page/documents/details?targetId=Prism-Central-Guide-vpc_2022_9:ssp-app-mgmt-project-env-c.html[Projects Overview].
25852654
|`name` or `uuid`
25862655

2587-
|`compute.platform.nutanix.project.name` or `compute.platform.nutanix.project.uuid`
2656+
|compute:
2657+
platform:
2658+
nutanix:
2659+
project:
2660+
name: or uuid:
25882661
|The name or UUID of a project with which compute VMs are associated. This parameter must be accompanied by the `type` parameter.
25892662
|String
25902663

2591-
|`compute.platform.nutanix.bootType`
2664+
|compute:
2665+
platform:
2666+
nutanix:
2667+
bootType:
25922668
|The boot type that the compute machines use. You must use the `Legacy` boot type in {product-title} {product-version}. For more information on boot types, see link:https://portal.nutanix.com/page/documents/kbs/details?targetId=kA07V000000H3K9SAK[Understanding UEFI, Secure Boot, and TPM in the Virtualized Environment].
25932669
|`Legacy`, `SecureBoot` or `UEFI`. The default is `Legacy`.
25942670

2595-
|`controlPlane.platform.nutanix.categories.key`
2671+
|controlPlane:
2672+
platform:
2673+
nutanix:
2674+
categories:
2675+
key:
25962676
|The name of a prism category key to apply to control plane VMs. This parameter must be accompanied by the `value` parameter, and both `key` and `value` parameters must exist in Prism Central. For more information on categories, see link:https://portal.nutanix.com/page/documents/details?targetId=Prism-Central-Guide-vpc_2022_6:ssp-ssp-categories-manage-pc-c.html[Category management].
25972677
|String
25982678

2599-
|`controlPlane.platform.nutanix.categories.value`
2679+
|controlPlane:
2680+
platform:
2681+
nutanix:
2682+
categories:
2683+
value:
26002684
|The value of a prism category key-value pair to apply to control plane VMs. This parameter must be accompanied by the `key` parameter, and both `key` and `value` parameters must exist in Prism Central.
26012685
|String
26022686

2603-
|`controlPlane.platform.nutanix.project.type`
2687+
|controlPlane:
2688+
platform:
2689+
nutanix:
2690+
project:
2691+
type:
26042692
|The type of identifier you use to select a project for control plane VMs. Projects define logical groups of user roles for managing permissions, networks, and other parameters. For more information on projects, see link:https://portal.nutanix.com/page/documents/details?targetId=Prism-Central-Guide-vpc_2022_9:ssp-app-mgmt-project-env-c.html[Projects Overview].
26052693
|`name` or `uuid`
26062694

2607-
|`controlPlane.platform.nutanix.project.name` or `controlPlane.platform.nutanix.project.uuid`
2695+
|controlPlane:
2696+
platform:
2697+
nutanix:
2698+
project:
2699+
name: or uuid:
26082700
|The name or UUID of a project with which control plane VMs are associated. This parameter must be accompanied by the `type` parameter.
26092701
|String
26102702

2611-
|`platform.nutanix.defaultMachinePlatform.categories.key`
2703+
|platform:
2704+
nutanix:
2705+
defaultMachinePlatform:
2706+
categories:
2707+
key:
26122708
|The name of a prism category key to apply to all VMs. This parameter must be accompanied by the `value` parameter, and both `key` and `value` parameters must exist in Prism Central. For more information on categories, see link:https://portal.nutanix.com/page/documents/details?targetId=Prism-Central-Guide-vpc_2022_6:ssp-ssp-categories-manage-pc-c.html[Category management].
26132709
|String
26142710

2615-
|`platform.nutanix.defaultMachinePlatform.categories.value`
2711+
|platform:
2712+
nutanix:
2713+
defaultMachinePlatform:
2714+
categories:
2715+
value:
26162716
|The value of a prism category key-value pair to apply to all VMs. This parameter must be accompanied by the `key` parameter, and both `key` and `value` parameters must exist in Prism Central.
26172717
|String
26182718

2619-
|`platform.nutanix.defaultMachinePlatform.project.type`
2719+
|platform:
2720+
nutanix:
2721+
defaultMachinePlatform:
2722+
project:
2723+
type:
26202724
|The type of identifier you use to select a project for all VMs. Projects define logical groups of user roles for managing permissions, networks, and other parameters. For more information on projects, see link:https://portal.nutanix.com/page/documents/details?targetId=Prism-Central-Guide-vpc_2022_9:ssp-app-mgmt-project-env-c.html[Projects Overview].
26212725
|`name` or `uuid`.
26222726

2623-
|`platform.nutanix.defaultMachinePlatform.project.name` or `platform.nutanix.defaultMachinePlatform.project.uuid`
2727+
|platform:
2728+
nutanix:
2729+
defaultMachinePlatform:
2730+
project:
2731+
name: or uuid:
26242732
|The name or UUID of a project with which all VMs are associated. This parameter must be accompanied by the `type` parameter.
26252733
|String
26262734

2627-
|`platform.nutanix.defaultMachinePlatform.bootType`
2735+
|platform:
2736+
nutanix:
2737+
defaultMachinePlatform:
2738+
bootType:
26282739
|The boot type for all machines. You must use the `Legacy` boot type in {product-title} {product-version}. For more information on boot types, see link:https://portal.nutanix.com/page/documents/kbs/details?targetId=kA07V000000H3K9SAK[Understanding UEFI, Secure Boot, and TPM in the Virtualized Environment].
26292740
|`Legacy`, `SecureBoot` or `UEFI`. The default is `Legacy`.
26302741

2631-
|`platform.nutanix.apiVIP`
2742+
|platform:
2743+
nutanix:
2744+
apiVIP:
26322745
|The virtual IP (VIP) address that you configured for control plane API access.
26332746
|IP address
26342747

2635-
|`platform.nutanix.ingressVIP`
2748+
|platform:
2749+
nutanix:
2750+
ingressVIP:
26362751
|The virtual IP (VIP) address that you configured for cluster ingress.
26372752
|IP address
26382753

2639-
|`platform.nutanix.prismCentral.endpoint.address`
2754+
|platform:
2755+
nutanix:
2756+
prismCentral:
2757+
endpoint:
2758+
address:
26402759
|The Prism Central domain name or IP address.
26412760
|String
26422761

2643-
|`platform.nutanix.prismCentral.endpoint.port`
2762+
|platform:
2763+
nutanix:
2764+
prismCentral:
2765+
endpoint:
2766+
port:
26442767
|The port that is used to log into Prism Central.
26452768
|String
26462769

2647-
|`platform.nutanix.prismCentral.password`
2770+
|platform:
2771+
nutanix:
2772+
prismCentral:
2773+
password:
26482774
|The password for the Prism Central user name.
26492775
|String
26502776

2651-
|`platform.nutanix.prismCentral.username`
2777+
|platform:
2778+
nutanix:
2779+
prismCentral:
2780+
username:
26522781
|The user name that is used to log into Prism Central.
26532782
|String
26542783

2655-
|`platform.nutanix.prismElments.endpoint.address`
2784+
|platform:
2785+
nutanix:
2786+
prismElements:
2787+
endpoint:
2788+
address:
26562789
|The Prism Element domain name or IP address. [^1^]
26572790
|String
26582791

2659-
|`platform.nutanix.prismElments.endpoint.port`
2792+
|platform:
2793+
nutanix:
2794+
prismElements:
2795+
endpoint:
2796+
port:
26602797
|The port that is used to log into Prism Element.
26612798
|String
26622799

2663-
|`platform.nutanix.prismElements.uuid`
2800+
|platform:
2801+
nutanix:
2802+
prismElements:
2803+
uuid:
26642804
|The universally unique identifier (UUID) for Prism Element.
26652805
|String
26662806

2667-
|`platform.nutanix.subnetUUIDs`
2807+
|platform:
2808+
nutanix:
2809+
subnetUUIDs:
26682810
|The UUID of the Prism Element network that contains the virtual IP addresses and DNS records that you configured. [^2^]
26692811
|String
26702812

2671-
|`platform.nutanix.clusterOSImage`
2813+
|platform:
2814+
nutanix:
2815+
clusterOSImage:
26722816
|Optional: By default, the installation program downloads and installs the {op-system-first} image. If Prism Central does not have internet access, you can override the default behavior by hosting the {op-system} image on any HTTP server and pointing the installation program to the image.
26732817
|An HTTP or HTTPS URL, optionally with a SHA-256 checksum. For example, \http://example.com/images/rhcos-47.83.202103221318-0-nutanix.x86_64.qcow2
26742818
|====

0 commit comments

Comments
 (0)