Skip to content

Commit b81478c

Browse files
jeana-redhatjeana-redhat
authored
Merge pull request #48399 from emarcusRH/2086986a
BZ#2086986 remove references to deprecated instance_type_id
2 parents 3454165 + 4b63d16 commit b81478c

File tree

2 files changed

+37
-53
lines changed

2 files changed

+37
-53
lines changed

‎modules/installation-configuration-parameters.adoc

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1275,14 +1275,6 @@ Additional {rh-virtualization} configuration parameters for machine pools are de
12751275
|Optional. Memory of the VM in MiB.
12761276
|Integer
12771277

1278-
|`<machine-pool>.platform.ovirt.instanceTypeID`
1279-
|Optional. An instance type UUID, such as `00000009-0009-0009-0009-0000000000f1`, which you can get from the `https://<engine-fqdn>/ovirt-engine/api/instancetypes` endpoint.
1280-
[WARNING]
1281-
====
1282-
The `instance_type_id` field is deprecated and will be removed in a future release.
1283-
====
1284-
|String of UUID
1285-
12861278
|`<machine-pool>.platform.ovirt.osDisk`
12871279
|Optional. Defines the first and bootable disk of the VM.
12881280
|String

‎modules/machineset-yaml-rhv.adoc

Lines changed: 37 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -43,28 +43,27 @@ spec:
4343
apiVersion: ovirtproviderconfig.machine.openshift.io/v1beta1
4444
cluster_id: <ovirt_cluster_id> <6>
4545
template_name: <ovirt_template_name> <7>
46-
instance_type_id: <instance_type_id> <8>
47-
sparse: <boolean_value> <9>
48-
format: <raw_or_cow> <10>
49-
cpu: <11>
50-
sockets: <number_of_sockets> <12>
51-
cores: <number_of_cores> <13>
52-
threads: <number_of_threads> <14>
53-
memory_mb: <memory_size> <15>
54-
guaranteed_memory_mb: <memory_size> <16>
55-
os_disk: <17>
56-
size_gb: <disk_size> <18>
57-
storage_domain_id: <storage_domain_UUID> <19>
58-
network_interfaces: <20>
59-
vnic_profile_id: <vnic_profile_id> <21>
46+
sparse: <boolean_value> <8>
47+
format: <raw_or_cow> <9>
48+
cpu: <10>
49+
sockets: <number_of_sockets> <11>
50+
cores: <number_of_cores> <12>
51+
threads: <number_of_threads> <13>
52+
memory_mb: <memory_size> <14>
53+
guaranteed_memory_mb: <memory_size> <15>
54+
os_disk: <16>
55+
size_gb: <disk_size> <17>
56+
storage_domain_id: <storage_domain_UUID> <18>
57+
network_interfaces: <19>
58+
vnic_profile_id: <vnic_profile_id> <20>
6059
credentialsSecret:
61-
name: ovirt-credentials <22>
60+
name: ovirt-credentials <21>
6261
kind: OvirtMachineProviderSpec
63-
type: <workload_type> <23>
64-
auto_pinning_policy: <auto_pinning_policy> <24>
65-
hugepages: <hugepages> <25>
62+
type: <workload_type> <22>
63+
auto_pinning_policy: <auto_pinning_policy> <23>
64+
hugepages: <hugepages> <24>
6665
affinityGroupsNames:
67-
- compute <26>
66+
- compute <25>
6867
userDataSecret:
6968
name: worker-user-data
7069
----
@@ -87,53 +86,46 @@ $ oc get -o jsonpath='{.status.infrastructureName}{"\n"}' infrastructure cluster
8786

8887
<7> Specify the {rh-virtualization} VM template to use to create the machine.
8988

90-
<8> Optional: Specify the VM instance type.
91-
+
92-
[WARNING]
93-
====
94-
The `instance_type_id` field is deprecated and will be removed in a future release.
95-
====
96-
+
97-
If you include this parameter, you do not need to specify the hardware parameters of the VM including CPU and memory because this parameter overrides all hardware parameters.
98-
<9> Setting this option to `false` enables preallocation of disks. The default is `true`. Setting `sparse` to `true` with `format` set to `raw` is not available for block storage domains. The `raw` format writes the entire virtual disk to the underlying physical disk.
99-
<10> Can be set to `cow` or `raw`. The default is `cow`. The `cow` format is optimized for virtual machines.
89+
<8> Setting this option to `false` enables preallocation of disks. The default is `true`. Setting `sparse` to `true` with `format` set to `raw` is not available for block storage domains. The `raw` format writes the entire virtual disk to the underlying physical disk.
90+
91+
<9> Can be set to `cow` or `raw`. The default is `cow`. The `cow` format is optimized for virtual machines.
10092
+
10193
[NOTE]
10294
====
10395
Preallocating disks on file storage domains writes zeroes to the file. This might not actually preallocate disks depending on the underlying storage.
10496
====
105-
<11> Optional: The CPU field contains the CPU configuration, including sockets, cores, and threads.
97+
<10> Optional: The CPU field contains the CPU configuration, including sockets, cores, and threads.
10698

107-
<12> Optional: Specify the number of sockets for a VM.
99+
<11> Optional: Specify the number of sockets for a VM.
108100

109-
<13> Optional: Specify the number of cores per socket.
101+
<12> Optional: Specify the number of cores per socket.
110102

111-
<14> Optional: Specify the number of threads per core.
103+
<13> Optional: Specify the number of threads per core.
112104

113-
<15> Optional: Specify the size of a VM's memory in MiB.
105+
<14> Optional: Specify the size of a VM's memory in MiB.
114106

115-
<16> Optional: Specify the size of a virtual machine's guaranteed memory in MiB. This is the amount of memory that is guaranteed not to be drained by the ballooning mechanism. For more information, see link:https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.4/html-single/administration_guide#memory_ballooning[Memory Ballooning] and link:https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.4/html-single/administration_guide#Cluster_Optimization_Settings_Explained[Optimization Settings Explained].
107+
<15> Optional: Specify the size of a virtual machine's guaranteed memory in MiB. This is the amount of memory that is guaranteed not to be drained by the ballooning mechanism. For more information, see link:https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.4/html-single/administration_guide#memory_ballooning[Memory Ballooning] and link:https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.4/html-single/administration_guide#Cluster_Optimization_Settings_Explained[Optimization Settings Explained].
116108
+
117109
[NOTE]
118110
====
119111
If you are using a version earlier than {rh-virtualization} 4.4.8, see link:https://access.redhat.com/articles/6454811[Guaranteed memory requirements for OpenShift on Red Hat Virtualization clusters].
120112
====
121-
<17> Optional: Root disk of the node.
113+
<16> Optional: Root disk of the node.
122114

123-
<18> Optional: Specify the size of the bootable disk in GiB.
115+
<17> Optional: Specify the size of the bootable disk in GiB.
124116

125-
<19> Optional: Specify the UUID of the storage domain for the compute node's disks. If none is provided, the compute node is created on the same storage domain as the control nodes. (default)
117+
<18> Optional: Specify the UUID of the storage domain for the compute node's disks. If none is provided, the compute node is created on the same storage domain as the control nodes. (default)
126118

127-
<20> Optional: List of the network interfaces of the VM. If you include this parameter, {product-title} discards all network interfaces from the template and creates new ones.
119+
<19> Optional: List of the network interfaces of the VM. If you include this parameter, {product-title} discards all network interfaces from the template and creates new ones.
128120

129-
<21> Optional: Specify the vNIC profile ID.
121+
<20> Optional: Specify the vNIC profile ID.
130122

131-
<22> Specify the name of the secret object that holds the {rh-virtualization} credentials.
123+
<21> Specify the name of the secret object that holds the {rh-virtualization} credentials.
132124

133-
<23> Optional: Specify the workload type for which the instance is optimized. This value affects the `{rh-virtualization} VM` parameter. Supported values: `desktop`, `server` (default), `high_performance`. `high_performance` improves performance on the VM. Limitations exist, for example, you cannot access the VM with a graphical console. For more information, see link:https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.4/html-single/virtual_machine_management_guide/index#Configuring_High_Performance_Virtual_Machines_Templates_and_Pools[Configuring High Performance Virtual Machines, Templates, and Pools] in the _Virtual Machine Management Guide_.
134-
<24> Optional: AutoPinningPolicy defines the policy that automatically sets CPU and NUMA settings, including pinning to the host for this instance. Supported values: `none`, `resize_and_pin`. For more information, see link:https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.4/html-single/virtual_machine_management_guide/index#Setting_NUMA_Nodes[Setting NUMA Nodes] in the _Virtual Machine Management Guide_.
135-
<25> Optional: Hugepages is the size in KiB for defining hugepages in a VM. Supported values: `2048` or `1048576`. For more information, see link:https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.4/html-single/virtual_machine_management_guide/index#Configuring_Huge_Pages[Configuring Huge Pages] in the _Virtual Machine Management Guide_.
136-
<26> Optional: A list of affinity group names to be applied to the VMs. The affinity groups must exist in oVirt.
125+
<22> Optional: Specify the workload type for which the instance is optimized. This value affects the `{rh-virtualization} VM` parameter. Supported values: `desktop`, `server` (default), `high_performance`. `high_performance` improves performance on the VM. Limitations exist, for example, you cannot access the VM with a graphical console. For more information, see link:https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.4/html-single/virtual_machine_management_guide/index#Configuring_High_Performance_Virtual_Machines_Templates_and_Pools[Configuring High Performance Virtual Machines, Templates, and Pools] in the _Virtual Machine Management Guide_.
126+
<23> Optional: AutoPinningPolicy defines the policy that automatically sets CPU and NUMA settings, including pinning to the host for this instance. Supported values: `none`, `resize_and_pin`. For more information, see link:https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.4/html-single/virtual_machine_management_guide/index#Setting_NUMA_Nodes[Setting NUMA Nodes] in the _Virtual Machine Management Guide_.
127+
<24> Optional: Hugepages is the size in KiB for defining hugepages in a VM. Supported values: `2048` or `1048576`. For more information, see link:https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.4/html-single/virtual_machine_management_guide/index#Configuring_Huge_Pages[Configuring Huge Pages] in the _Virtual Machine Management Guide_.
128+
<25> Optional: A list of affinity group names to be applied to the VMs. The affinity groups must exist in oVirt.
137129

138130
[NOTE]
139131
====

0 commit comments

Comments
 (0)