Skip to content

Commit 3d4fe9f

Browse files
bscott-rhbscott-rh
committed
Formatting Nutanix and Alibaba install config parameters
1 parent 77277e9 commit 3d4fe9f

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
@@ -2188,91 +2188,148 @@ If defined, the parameters `compute.platform.alibabacloud` and `controlPlane.pla
21882188
====
21892189

21902190
.Optional {alibaba} parameters
2191-
[cols=".^2,.^3,.^5a",options="header"]
2191+
[cols=".^2l,.^3,.^5a",options="header"]
21922192
|====
21932193
|Parameter|Description|Values
21942194

2195-
|`compute.platform.alibabacloud.imageID`
2195+
|compute:
2196+
platform:
2197+
alibabacloud:
2198+
imageID:
21962199
|The imageID used to create the ECS instance. ImageID must belong to the same region as the cluster.
21972200
|String.
21982201

2199-
|`compute.platform.alibabacloud.instanceType`
2202+
|compute:
2203+
platform:
2204+
alibabacloud:
2205+
instanceType:
22002206
|InstanceType defines the ECS instance type. Example: `ecs.g6.large`
22012207
|String.
22022208

2203-
|`compute.platform.alibabacloud.systemDiskCategory`
2209+
|compute:
2210+
platform:
2211+
alibabacloud:
2212+
systemDiskCategory:
22042213
|Defines the category of the system disk. Examples: `cloud_efficiency`,`cloud_essd`
22052214
|String.
22062215

2207-
|`compute.platform.alibabacloud.systemDisksize`
2216+
|compute:
2217+
platform:
2218+
alibabacloud:
2219+
systemDisksize:
22082220
|Defines the size of the system disk in gibibytes (GiB).
22092221
|Integer.
22102222

2211-
|`compute.platform.alibabacloud.zones`
2223+
|compute:
2224+
platform:
2225+
alibabacloud:
2226+
zones:
22122227
|The list of availability zones that can be used. Examples: `cn-hangzhou-h`, `cn-hangzhou-j`
22132228
|String list.
22142229

2215-
|`controlPlane.platform.alibabacloud.imageID`
2230+
|controlPlane:
2231+
platform:
2232+
alibabacloud:
2233+
imageID:
22162234
|The imageID used to create the ECS instance. ImageID must belong to the same region as the cluster.
22172235
|String.
22182236

2219-
|`controlPlane.platform.alibabacloud.instanceType`
2237+
|controlPlane:
2238+
platform:
2239+
alibabacloud:
2240+
instanceType:
22202241
|InstanceType defines the ECS instance type. Example: `ecs.g6.xlarge`
22212242
|String.
22222243

2223-
|`controlPlane.platform.alibabacloud.systemDiskCategory`
2244+
|controlPlane:
2245+
platform:
2246+
alibabacloud:
2247+
systemDiskCategory:
22242248
|Defines the category of the system disk. Examples: `cloud_efficiency`,`cloud_essd`
22252249
|String.
22262250

2227-
|`controlPlane.platform.alibabacloud.systemDisksize`
2251+
|controlPlane:
2252+
platform:
2253+
alibabacloud:
2254+
systemDisksize:
22282255
|Defines the size of the system disk in gibibytes (GiB).
22292256
|Integer.
22302257

2231-
|`controlPlane.platform.alibabacloud.zones`
2258+
|controlPlane:
2259+
platform:
2260+
alibabacloud:
2261+
zones:
22322262
|The list of availability zones that can be used. Examples: `cn-hangzhou-h`, `cn-hangzhou-j`
22332263
|String list.
22342264

2235-
|`platform.alibabacloud.region`
2265+
|platform:
2266+
alibabacloud:
2267+
region:
22362268
|Required. The Alibaba Cloud region where the cluster will be created.
22372269
|String.
22382270

2239-
|`platform.alibabacloud.resourceGroupID`
2271+
|platform:
2272+
alibabacloud:
2273+
resourceGroupID:
22402274
|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.
22412275
|String.
22422276

2243-
|`platform.alibabacloud.tags`
2277+
|platform:
2278+
alibabacloud:
2279+
tags:
22442280
|Additional keys and values to apply to all Alibaba Cloud resources created for the cluster.
22452281
|Object.
22462282

2247-
|`platform.alibabacloud.vpcID`
2283+
|platform:
2284+
alibabacloud:
2285+
vpcID:
22482286
|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.
22492287
|String.
22502288

2251-
|`platform.alibabacloud.vswitchIDs`
2289+
|platform:
2290+
alibabacloud:
2291+
vswitchIDs:
22522292
|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.
22532293
|String list.
22542294

2255-
|`platform.alibabacloud.defaultMachinePlatform.imageID`
2295+
|platform:
2296+
alibabacloud:
2297+
defaultMachinePlatform:
2298+
imageID:
22562299
|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.
22572300
|String.
22582301

2259-
|`platform.alibabacloud.defaultMachinePlatform.instanceType`
2302+
|platform:
2303+
alibabacloud:
2304+
defaultMachinePlatform:
2305+
instanceType:
22602306
|For both compute machines and control plane machines, the ECS instance type used to create the ECS instance. Example: `ecs.g6.xlarge`
22612307
|String.
22622308

2263-
|`platform.alibabacloud.defaultMachinePlatform.systemDiskCategory`
2309+
|platform:
2310+
alibabacloud:
2311+
defaultMachinePlatform:
2312+
systemDiskCategory:
22642313
|For both compute machines and control plane machines, the category of the system disk. Examples: `cloud_efficiency`, `cloud_essd`.
22652314
|String, for example "", `cloud_efficiency`, `cloud_essd`.
22662315

2267-
|`platform.alibabacloud.defaultMachinePlatform.systemDiskSize`
2316+
|platform:
2317+
alibabacloud:
2318+
defaultMachinePlatform:
2319+
systemDiskSize:
22682320
|For both compute machines and control plane machines, the size of the system disk in gibibytes (GiB). The minimum is `120`.
22692321
|Integer.
22702322

2271-
|`platform.alibabacloud.defaultMachinePlatform.zones`
2323+
|platform:
2324+
alibabacloud:
2325+
defaultMachinePlatform:
2326+
zones:
22722327
|For both compute machines and control plane machines, the list of availability zones that can be used. Examples: `cn-hangzhou-h`, `cn-hangzhou-j`
22732328
|String list.
22742329

2275-
|`platform.alibabacloud.privateZoneID`
2330+
|platform:
2331+
alibabacloud:
2332+
privateZoneID:
22762333
|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.
22772334
|String.
22782335

@@ -2287,107 +2344,194 @@ ifdef::nutanix[]
22872344
Additional Nutanix configuration parameters are described in the following table:
22882345

22892346
.Additional Nutanix cluster parameters
2290-
[cols=".^2,.^3a,.^3a",options="header"]
2347+
[cols=".^2l,.^3a,.^3a",options="header"]
22912348
|====
22922349
|Parameter|Description|Values
22932350

2294-
|`compute.platform.nutanix.categories.key`
2351+
|compute:
2352+
platform:
2353+
nutanix:
2354+
categories:
2355+
key:
22952356
|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].
22962357
|String
22972358

2298-
|`compute.platform.nutanix.categories.value`
2359+
|compute:
2360+
platform:
2361+
nutanix:
2362+
categories:
2363+
value:
22992364
|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.
23002365
|String
23012366

2302-
|`compute.platform.nutanix.project.type`
2367+
|compute:
2368+
platform:
2369+
nutanix:
2370+
project:
2371+
type:
23032372
|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].
23042373
|`name` or `uuid`
23052374

2306-
|`compute.platform.nutanix.project.name` or `compute.platform.nutanix.project.uuid`
2375+
|compute:
2376+
platform:
2377+
nutanix:
2378+
project:
2379+
name: or uuid:
23072380
|The name or UUID of a project with which compute VMs are associated. This parameter must be accompanied by the `type` parameter.
23082381
|String
23092382

2310-
|`compute.platform.nutanix.bootType`
2383+
|compute:
2384+
platform:
2385+
nutanix:
2386+
bootType:
23112387
|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].
23122388
|`Legacy`, `SecureBoot` or `UEFI`. The default is `Legacy`.
23132389

2314-
|`controlPlane.platform.nutanix.categories.key`
2390+
|controlPlane:
2391+
platform:
2392+
nutanix:
2393+
categories:
2394+
key:
23152395
|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].
23162396
|String
23172397

2318-
|`controlPlane.platform.nutanix.categories.value`
2398+
|controlPlane:
2399+
platform:
2400+
nutanix:
2401+
categories:
2402+
value:
23192403
|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.
23202404
|String
23212405

2322-
|`controlPlane.platform.nutanix.project.type`
2406+
|controlPlane:
2407+
platform:
2408+
nutanix:
2409+
project:
2410+
type:
23232411
|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].
23242412
|`name` or `uuid`
23252413

2326-
|`controlPlane.platform.nutanix.project.name` or `controlPlane.platform.nutanix.project.uuid`
2414+
|controlPlane:
2415+
platform:
2416+
nutanix:
2417+
project:
2418+
name: or uuid:
23272419
|The name or UUID of a project with which control plane VMs are associated. This parameter must be accompanied by the `type` parameter.
23282420
|String
23292421

2330-
|`platform.nutanix.defaultMachinePlatform.categories.key`
2422+
|platform:
2423+
nutanix:
2424+
defaultMachinePlatform:
2425+
categories:
2426+
key:
23312427
|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].
23322428
|String
23332429

2334-
|`platform.nutanix.defaultMachinePlatform.categories.value`
2430+
|platform:
2431+
nutanix:
2432+
defaultMachinePlatform:
2433+
categories:
2434+
value:
23352435
|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.
23362436
|String
23372437

2338-
|`platform.nutanix.defaultMachinePlatform.project.type`
2438+
|platform:
2439+
nutanix:
2440+
defaultMachinePlatform:
2441+
project:
2442+
type:
23392443
|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].
23402444
|`name` or `uuid`.
23412445

2342-
|`platform.nutanix.defaultMachinePlatform.project.name` or `platform.nutanix.defaultMachinePlatform.project.uuid`
2446+
|platform:
2447+
nutanix:
2448+
defaultMachinePlatform:
2449+
project:
2450+
name: or uuid:
23432451
|The name or UUID of a project with which all VMs are associated. This parameter must be accompanied by the `type` parameter.
23442452
|String
23452453

2346-
|`platform.nutanix.defaultMachinePlatform.bootType`
2454+
|platform:
2455+
nutanix:
2456+
defaultMachinePlatform:
2457+
bootType:
23472458
|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].
23482459
|`Legacy`, `SecureBoot` or `UEFI`. The default is `Legacy`.
23492460

2350-
|`platform.nutanix.apiVIP`
2461+
|platform:
2462+
nutanix:
2463+
apiVIP:
23512464
|The virtual IP (VIP) address that you configured for control plane API access.
23522465
|IP address
23532466

2354-
|`platform.nutanix.ingressVIP`
2467+
|platform:
2468+
nutanix:
2469+
ingressVIP:
23552470
|The virtual IP (VIP) address that you configured for cluster ingress.
23562471
|IP address
23572472

2358-
|`platform.nutanix.prismCentral.endpoint.address`
2473+
|platform:
2474+
nutanix:
2475+
prismCentral:
2476+
endpoint:
2477+
address:
23592478
|The Prism Central domain name or IP address.
23602479
|String
23612480

2362-
|`platform.nutanix.prismCentral.endpoint.port`
2481+
|platform:
2482+
nutanix:
2483+
prismCentral:
2484+
endpoint:
2485+
port:
23632486
|The port that is used to log into Prism Central.
23642487
|String
23652488

2366-
|`platform.nutanix.prismCentral.password`
2489+
|platform:
2490+
nutanix:
2491+
prismCentral:
2492+
password:
23672493
|The password for the Prism Central user name.
23682494
|String
23692495

2370-
|`platform.nutanix.prismCentral.username`
2496+
|platform:
2497+
nutanix:
2498+
prismCentral:
2499+
username:
23712500
|The user name that is used to log into Prism Central.
23722501
|String
23732502

2374-
|`platform.nutanix.prismElments.endpoint.address`
2503+
|platform:
2504+
nutanix:
2505+
prismElements:
2506+
endpoint:
2507+
address:
23752508
|The Prism Element domain name or IP address. [^1^]
23762509
|String
23772510

2378-
|`platform.nutanix.prismElments.endpoint.port`
2511+
|platform:
2512+
nutanix:
2513+
prismElements:
2514+
endpoint:
2515+
port:
23792516
|The port that is used to log into Prism Element.
23802517
|String
23812518

2382-
|`platform.nutanix.prismElements.uuid`
2519+
|platform:
2520+
nutanix:
2521+
prismElements:
2522+
uuid:
23832523
|The universally unique identifier (UUID) for Prism Element.
23842524
|String
23852525

2386-
|`platform.nutanix.subnetUUIDs`
2526+
|platform:
2527+
nutanix:
2528+
subnetUUIDs:
23872529
|The UUID of the Prism Element network that contains the virtual IP addresses and DNS records that you configured. [^2^]
23882530
|String
23892531

2390-
|`platform.nutanix.clusterOSImage`
2532+
|platform:
2533+
nutanix:
2534+
clusterOSImage:
23912535
|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.
23922536
|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
23932537
|====

0 commit comments

Comments
 (0)