Skip to content

Commit 5d320e2

Browse files
stevsmitstevsmit
authored
Merge pull request #47247 from mjpytlak/bz2100612
BZ-2100612: Updated ASH install doc in support of premium_LRS and standardSSD_LRS disk types
2 parents 6d341a9 + 0aa1773 commit 5d320e2

File tree

2 files changed

+86
-50
lines changed

2 files changed

+86
-50
lines changed

‎modules/installation-azure-stack-hub-config-yaml.adoc

Lines changed: 70 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,22 @@ apiVersion: v1
3030
baseDomain: example.com
3131
controlPlane: <1>
3232
name: master
33+
platform:
34+
azure:
35+
osDisk:
36+
diskSizeGB: 1024 <2>
37+
diskType: premium_LRS
3338
replicas: 3
3439
compute: <1>
3540
- name: worker
36-
platform: {}
41+
platform:
42+
azure:
43+
osDisk:
44+
diskSizeGB: 512 <2>
45+
diskType: premium_LRS
3746
replicas: 0
3847
metadata:
39-
name: test-cluster <2>
48+
name: test-cluster <3>
4049
networking:
4150
clusterNetwork:
4251
- cidr: 10.128.0.0/14
@@ -53,50 +62,51 @@ endif::openshift-origin[]
5362
- 172.30.0.0/16
5463
platform:
5564
azure:
56-
armEndpoint: azurestack_arm_endpoint <3>
57-
baseDomainResourceGroupName: resource_group <4>
58-
region: azure_stack_local_region <5>
59-
resourceGroupName: existing_resource_group <6>
65+
armEndpoint: azurestack_arm_endpoint <4>
66+
baseDomainResourceGroupName: resource_group <5>
67+
region: azure_stack_local_region <6>
68+
resourceGroupName: existing_resource_group <7>
6069
outboundType: Loadbalancer
61-
cloudName: AzureStackCloud <7>
62-
pullSecret: '{"auths": ...}' <8>
70+
cloudName: AzureStackCloud <8>
71+
pullSecret: '{"auths": ...}' <9>
6372
ifndef::openshift-origin[]
64-
fips: false <9>
65-
additionalTrustBundle: | <10>
73+
fips: false <10>
74+
additionalTrustBundle: | <11>
6675
-----BEGIN CERTIFICATE-----
6776
<MY_TRUSTED_CA_CERT>
6877
-----END CERTIFICATE-----
69-
sshKey: ssh-ed25519 AAAA... <11>
78+
sshKey: ssh-ed25519 AAAA... <12>
7079
endif::openshift-origin[]
7180
ifdef::openshift-origin[]
72-
additionalTrustBundle: | <9>
81+
additionalTrustBundle: | <10>
7382
-----BEGIN CERTIFICATE-----
7483
<MY_TRUSTED_CA_CERT>
7584
-----END CERTIFICATE-----
76-
sshKey: ssh-ed25519 AAAA... <10>
85+
sshKey: ssh-ed25519 AAAA... <11>
7786
endif::openshift-origin[]
7887
----
7988
<1> The `controlPlane` section is a single mapping, but the compute section is a sequence of mappings. To meet the requirements of the different data structures, the first line of the `compute` section must begin with a hyphen, `-`, and the first line of the `controlPlane` section must not. Although both sections currently define a single machine pool, it is possible that future versions of {product-title} will support defining multiple compute pools during installation. Only one control plane pool is used.
80-
<2> Specify the name of the cluster.
81-
<3> Specify the Azure Resource Manager endpoint that your Azure Stack Hub operator provides.
82-
<4> Specify the name of the resource group that contains the DNS zone for your base domain.
83-
<5> Specify the name of your Azure Stack Hub local region.
84-
<6> Specify the name of an already existing resource group to install your cluster to. If undefined, a new resource group is created for the cluster.
85-
<7> Specify the Azure Stack Hub environment as your target platform.
86-
<8> Specify the pull secret required to authenticate your cluster.
89+
<2> You can specify the size of the disk to use in GB. Minimum recommendation for control plane nodes is 1024 GB.
90+
<3> Specify the name of the cluster.
91+
<4> Specify the Azure Resource Manager endpoint that your Azure Stack Hub operator provides.
92+
<5> Specify the name of the resource group that contains the DNS zone for your base domain.
93+
<6> Specify the name of your Azure Stack Hub local region.
94+
<7> Specify the name of an already existing resource group to install your cluster to. If undefined, a new resource group is created for the cluster.
95+
<8> Specify the Azure Stack Hub environment as your target platform.
96+
<9> Specify the pull secret required to authenticate your cluster.
8797
ifndef::openshift-origin[]
88-
<9> Whether to enable or disable FIPS mode. By default, FIPS mode is not enabled. If FIPS mode is enabled, the {op-system-first} machines that {product-title} runs on bypass the default Kubernetes cryptography suite and use the cryptography modules that are provided with {op-system} instead.
98+
<10> Whether to enable or disable FIPS mode. By default, FIPS mode is not enabled. If FIPS mode is enabled, the {op-system-first} machines that {product-title} runs on bypass the default Kubernetes cryptography suite and use the cryptography modules that are provided with {op-system} instead.
8999
+
90100
[IMPORTANT]
91101
====
92102
The use of FIPS Validated / Modules in Process cryptographic libraries is only supported on {product-title} deployments on the `x86_64` architecture.
93103
====
94-
<10> If your Azure Stack Hub environment uses an internal certificate authority (CA), add the necessary certificate bundle in `.pem` format.
95-
<11> You can optionally provide the `sshKey` value that you use to access the machines in your cluster.
104+
<11> If your Azure Stack Hub environment uses an internal certificate authority (CA), add the necessary certificate bundle in `.pem` format.
105+
<12> You can optionally provide the `sshKey` value that you use to access the machines in your cluster.
96106
endif::openshift-origin[]
97107
ifdef::openshift-origin[]
98-
<9> If your Azure Stack Hub environment uses an internal certificate authority (CA), add the necessary certificate bundle in `.pem` format.
99-
<10> You can optionally provide the `sshKey` value that you use to access the machines in your cluster.
108+
<10> If your Azure Stack Hub environment uses an internal certificate authority (CA), add the necessary certificate bundle in `.pem` format.
109+
<11> You can optionally provide the `sshKey` value that you use to access the machines in your cluster.
100110
endif::openshift-origin[]
101111
+
102112
[NOTE]
@@ -113,13 +123,22 @@ baseDomain: example.com <1>
113123
credentialsMode: Manual
114124
controlPlane: <2> <3>
115125
name: master
126+
platform:
127+
azure:
128+
osDisk:
129+
diskSizeGB: 1024 <4>
130+
diskType: premium_LRS
116131
replicas: 3
117132
compute: <2>
118133
- name: worker
119-
platform: {}
134+
platform:
135+
azure:
136+
osDisk:
137+
diskSizeGB: 512 <4>
138+
diskType: premium_LRS
120139
replicas: 3
121140
metadata:
122-
name: test-cluster <1> <4>
141+
name: test-cluster <1> <5>
123142
networking:
124143
clusterNetwork:
125144
- cidr: 10.128.0.0/14
@@ -136,26 +155,26 @@ endif::openshift-origin[]
136155
- 172.30.0.0/16
137156
platform:
138157
azure:
139-
armEndpoint: azurestack_arm_endpoint <1> <5>
140-
baseDomainResourceGroupName: resource_group <1> <6>
141-
region: azure_stack_local_region <1> <7>
142-
resourceGroupName: existing_resource_group <8>
158+
armEndpoint: azurestack_arm_endpoint <1> <6>
159+
baseDomainResourceGroupName: resource_group <1> <7>
160+
region: azure_stack_local_region <1> <8>
161+
resourceGroupName: existing_resource_group <9>
143162
outboundType: Loadbalancer
144163
cloudName: AzureStackCloud <1>
145-
clusterOSimage: https://vhdsa.blob.example.example.com/vhd/rhcos-410.84.202112040202-0-azurestack.x86_64.vhd <1> <9>
146-
pullSecret: '{"auths": ...}' <1> <10>
164+
clusterOSimage: https://vhdsa.blob.example.example.com/vhd/rhcos-410.84.202112040202-0-azurestack.x86_64.vhd <1> <10>
165+
pullSecret: '{"auths": ...}' <1> <11>
147166
ifndef::openshift-origin[]
148-
fips: false <11>
149-
sshKey: ssh-ed25519 AAAA... <12>
167+
fips: false <12>
168+
sshKey: ssh-ed25519 AAAA... <13>
150169
endif::openshift-origin[]
151170
ifdef::openshift-origin[]
152-
sshKey: ssh-ed25519 AAAA...<11>
171+
sshKey: ssh-ed25519 AAAA...<12>
153172
endif::openshift-origin[]
154173
ifndef::openshift-origin[]
155-
additionalTrustBundle: | <13>
174+
additionalTrustBundle: | <14>
156175
endif::openshift-origin[]
157176
ifdef::openshift-origin[]
158-
additionalTrustBundle: | <12>
177+
additionalTrustBundle: | <13>
159178
endif::openshift-origin[]
160179
-----BEGIN CERTIFICATE-----
161180
<MY_TRUSTED_CA_CERT>
@@ -164,35 +183,36 @@ endif::openshift-origin[]
164183
<1> Required.
165184
<2> If you do not provide these parameters and values, the installation program provides the default value.
166185
<3> The `controlPlane` section is a single mapping, but the `compute` section is a sequence of mappings. To meet the requirements of the different data structures, the first line of the `compute` section must begin with a hyphen, `-`, and the first line of the `controlPlane` section must not. Although both sections currently define a single machine pool, it is possible that future versions of {product-title} will support defining multiple compute pools during installation. Only one control plane pool is used.
167-
<4> The name of the cluster.
168-
<5> The Azure Resource Manager endpoint that your Azure Stack Hub operator provides.
169-
<6> The name of the resource group that contains the DNS zone for your base domain.
170-
<7> The name of your Azure Stack Hub local region.
171-
<8> The name of an existing resource group to install your cluster to. If undefined, a new resource group is created for the cluster.
172-
<9> The URL of a storage blob in the Azure Stack environment that contains an {op-system} VHD.
173-
<10> The pull secret required to authenticate your cluster.
186+
<4> You can specify the size of the disk to use in GB. Minimum recommendation for control plane nodes is 1024 GB.
187+
<5> The name of the cluster.
188+
<6> The Azure Resource Manager endpoint that your Azure Stack Hub operator provides.
189+
<7> The name of the resource group that contains the DNS zone for your base domain.
190+
<8> The name of your Azure Stack Hub local region.
191+
<9> The name of an existing resource group to install your cluster to. If undefined, a new resource group is created for the cluster.
192+
<10> The URL of a storage blob in the Azure Stack environment that contains an {op-system} VHD.
193+
<11> The pull secret required to authenticate your cluster.
174194
ifndef::openshift-origin[]
175-
<11> Whether to enable or disable FIPS mode. By default, FIPS mode is not enabled. If FIPS mode is enabled, the {op-system-first} machines that {product-title} runs on bypass the default Kubernetes cryptography suite and use the cryptography modules that are provided with {op-system} instead.
195+
<12> Whether to enable or disable FIPS mode. By default, FIPS mode is not enabled. If FIPS mode is enabled, the {op-system-first} machines that {product-title} runs on bypass the default Kubernetes cryptography suite and use the cryptography modules that are provided with {op-system} instead.
176196
+
177197
[IMPORTANT]
178198
====
179199
The use of FIPS Validated / Modules in Process cryptographic libraries is only supported on {product-title} deployments on the `x86_64` architecture.
180200
====
181-
<12> You can optionally provide the `sshKey` value that you use to access the machines in your cluster.
201+
<13> You can optionally provide the `sshKey` value that you use to access the machines in your cluster.
182202
endif::openshift-origin[]
183203
ifdef::openshift-origin[]
184-
<11> You can optionally provide the `sshKey` value that you use to access the machines in your cluster.
204+
<12> You can optionally provide the `sshKey` value that you use to access the machines in your cluster.
185205
endif::openshift-origin[]
186206
+
187207
[NOTE]
188208
====
189209
For production {product-title} clusters on which you want to perform installation debugging or disaster recovery, specify an SSH key that your `ssh-agent` process uses.
190210
====
191211
ifndef::openshift-origin[]
192-
<13> If the Azure Stack Hub environment is using an internal Certificate Authority (CA), adding the CA certificate is required.
212+
<14> If the Azure Stack Hub environment is using an internal Certificate Authority (CA), adding the CA certificate is required.
193213
endif::openshift-origin[]
194214
ifdef::openshift-origin[]
195-
<12> If the Azure Stack Hub environment is using an internal Certificate Authority (CA), adding the CA certificate is required.
215+
<13> If the Azure Stack Hub environment is using an internal Certificate Authority (CA), adding the CA certificate is required.
196216
endif::openshift-origin[]
197217

198218
endif::ash-default,ash-network[]

‎modules/installation-configuration-parameters.adoc

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1428,6 +1428,22 @@ Additional Azure configuration parameters are described in the following table:
14281428
|====
14291429
|Parameter|Description|Values
14301430

1431+
|`compute.platform.azure.osDisk.diskSizeGB`
1432+
|The Azure disk size for the VM.
1433+
|Integer that represents the size of the disk in GB. The default is `128`.
1434+
1435+
|`compute.platform.azure.osDisk.diskType`
1436+
|Defines the type of disk.
1437+
|`standard_LRS`, `premium_LRS`, or `standardSSD_LRS`. The default is `premium_LRS`.
1438+
1439+
|`controlPlane.platform.azure.osDisk.diskSizeGB`
1440+
|The Azure disk size for the VM.
1441+
|Integer that represents the size of the disk in GB. The default is `1024`.
1442+
1443+
|`controlPlane.platform.azure.osDisk.diskType`
1444+
|Defines the type of disk.
1445+
|`premium_LRS` or `standardSSD_LRS`. The default is `premium_LRS`.
1446+
14311447
|`platform.azure.armEndpoint`
14321448
|The URL of the Azure Resource Manager endpoint that your Azure Stack Hub operator provides.
14331449
|String

0 commit comments

Comments
 (0)