Skip to content

Commit d7964c0

Browse files
authored
Merge pull request #100640 from openshift-cherrypick-robot/cherry-pick-99801-to-enterprise-4.20
[enterprise-4.20] OSDOCS-16109# Add docs for tech preview of azure dedicated disk for etcd
2 parents ee5011f + 2edf5f2 commit d7964c0

File tree

5 files changed

+190
-0
lines changed

5 files changed

+190
-0
lines changed

installing/installing_azure/ipi/installing-azure-customizations.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@ include::modules/installation-azure-trusted-launch.adoc[leveloffset=+2]
3838

3939
include::modules/installation-azure-confidential-vms.adoc[leveloffset=+2]
4040

41+
include::modules/installation-azure-dedicated-disks.adoc[leveloffset=+2]
42+
4143
include::modules/installation-azure-config-yaml.adoc[leveloffset=+2]
4244

4345
include::modules/installation-configure-proxy.adoc[leveloffset=+2]

installing/installing_azure/ipi/installing-azure-network-customizations.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@ include::modules/installation-azure-arm-tested-machine-types.adoc[leveloffset=+2
3636
include::modules/installation-azure-trusted-launch.adoc[leveloffset=+2]
3737
include::modules/installation-azure-confidential-vms.adoc[leveloffset=+2]
3838

39+
include::modules/installation-azure-dedicated-disks.adoc[leveloffset=+2]
40+
3941
include::modules/installation-azure-config-yaml.adoc[leveloffset=+2]
4042

4143
include::modules/installation-configure-proxy.adoc[leveloffset=+2]

installing/installing_azure/ipi/installing-restricted-networks-azure-installer-provisioned.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,8 @@ include::modules/installation-azure-arm-tested-machine-types.adoc[leveloffset=+2
5454
include::modules/installation-azure-trusted-launch.adoc[leveloffset=+2]
5555
include::modules/installation-azure-confidential-vms.adoc[leveloffset=+2]
5656

57+
include::modules/installation-azure-dedicated-disks.adoc[leveloffset=+2]
58+
5759
include::modules/installation-azure-config-yaml.adoc[leveloffset=+2]
5860

5961
include::modules/installation-configure-proxy.adoc[leveloffset=+2]
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * installing/installing_azure/ipi/installing-azure-customizations.adoc
4+
// * installing/installing_azure/ipi/installing-azure-network-customizations.adoc
5+
// * installing/installing_azure/ipi/installing-restricted-networks-azure-installer-provisioned.adoc
6+
7+
:_mod-docs-content-type: PROCEDURE
8+
[id="installation-azure-dedicated-disks_{context}"]
9+
= Configuring a dedicated disk for etcd
10+
11+
You can install your {product-title} cluster on {azure-first} with a dedicated data disk for `etcd`. This configuration attaches a separate managed disk to each control plane node and uses it only for `etcd` data, which can improve cluster performance and stability.
12+
13+
:FeatureName: Dedicated disk for etcd
14+
15+
include::snippets/technology-preview.adoc[]
16+
17+
.Prerequisites
18+
19+
* You have created an `install-config.yaml` file.
20+
21+
.Procedure
22+
23+
* To configure a dedicated `etcd` disk, edit the `install-config.yaml` file and add the `diskSetup` and `dataDisks` parameters to the `controlPlane` stanza:
24+
+
25+
[source,yaml]
26+
----
27+
# ...
28+
controlPlane:
29+
architecture: amd64
30+
hyperthreading: Enabled
31+
name: master
32+
platform:
33+
azure:
34+
type: Standard_D4s_v5
35+
dataDisks:
36+
- nameSuffix: etcddisk # <1>
37+
cachingType: None # <2>
38+
diskSizeGB: 20 # <3>
39+
lun: 0 # <4>
40+
diskSetup:
41+
- type: etcd # <5>
42+
etcd:
43+
platformDiskID: etcddisk # <6>
44+
replicas: 3
45+
# ...
46+
----
47+
48+
<1> Specify the same value you defined for `platformDiskID`.
49+
<2> Specify `None`. Other caching requirements are not currently supported.
50+
<3> Specify a disk size in GB. This value can be any integer greater than `0`.
51+
+
52+
[NOTE]
53+
====
54+
A minimum of 20 GB ensures enough space is available for defragmentation operations.
55+
====
56+
<4> Specify a logical unit number (LUN). This can be any integer from `0` through `63` that is not used by another disk.
57+
<5> Specify `etcd`. This identifies `etcd` as the node component type to receive a dedicated disk.
58+
<6> Specify a name to identify the disk. This value must not exceed 12 characters.

modules/installation-configuration-parameters.adoc

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1752,6 +1752,58 @@ Supplying more than one user-assigned identity is an experimental feature, which
17521752

17531753
*Value:* `VMGuestStateOnly` is the only supported value.
17541754

1755+
|controlPlane:
1756+
diskSetup:
1757+
|Specifies node component information for dedicated disk configuration.
1758+
1759+
*Value:* Array of objects. Each object includes the `type` and `etcd` parameters as described in the following rows of the table.
1760+
1761+
[IMPORTANT]
1762+
====
1763+
Dedicated disk for `etcd` on {azure-full} is a Technology Preview feature only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process.
1764+
For more information about the support scope of Red Hat Technology Preview features, see link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Support Scope].
1765+
====
1766+
1767+
|controlPlane:
1768+
diskSetup:
1769+
- type:
1770+
|Specifies which node component type to assign a dedicated disk.
1771+
1772+
*Value:* `etcd` is the only supported value.
1773+
1774+
[IMPORTANT]
1775+
====
1776+
Dedicated disk for `etcd` on {azure-full} is a Technology Preview feature only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process.
1777+
For more information about the support scope of Red Hat Technology Preview features, see link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Support Scope].
1778+
====
1779+
1780+
|controlPlane:
1781+
diskSetup:
1782+
- etcd:
1783+
|Specifies parameters for an `etcd` dedicated disk.
1784+
1785+
*Value*: The `platformDiskID` object is the only supported value.
1786+
1787+
[IMPORTANT]
1788+
====
1789+
Dedicated disk for `etcd` on {azure-full} is a Technology Preview feature only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process.
1790+
For more information about the support scope of Red Hat Technology Preview features, see link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Support Scope].
1791+
====
1792+
1793+
|controlPlane:
1794+
diskSetup:
1795+
- etcd:
1796+
platformDiskID:
1797+
|Specifies a name to identify the dedicated disk.
1798+
1799+
*Value:* String. Must not exceed 12 characters.
1800+
1801+
[IMPORTANT]
1802+
====
1803+
Dedicated disk for `etcd` on {azure-full} is a Technology Preview feature only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process.
1804+
For more information about the support scope of Red Hat Technology Preview features, see link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Support Scope].
1805+
====
1806+
17551807
|controlPlane:
17561808
platform:
17571809
azure:
@@ -1813,6 +1865,80 @@ Supplying more than one user-assigned identity is an experimental feature, which
18131865

18141866
*Value:* String.
18151867

1868+
|controlPlane:
1869+
platform:
1870+
azure:
1871+
dataDisks:
1872+
|Specifies dedicated disk parameters.
1873+
1874+
*Value:* Array of objects. Each object includes `nameSuffix`, `cachingType`, `diskSizeGB`, and `lun` as described in the following rows of the table.
1875+
1876+
[IMPORTANT]
1877+
====
1878+
Dedicated disk for `etcd` on {azure-full} is a Technology Preview feature only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process.
1879+
For more information about the support scope of Red Hat Technology Preview features, see link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Support Scope].
1880+
====
1881+
1882+
|controlPlane:
1883+
platform:
1884+
azure:
1885+
dataDisks:
1886+
- nameSuffix:
1887+
|Specifies the same value you defined for `platformDiskID`.
1888+
1889+
*Value:* String.
1890+
1891+
[IMPORTANT]
1892+
====
1893+
Dedicated disk for `etcd` on {azure-full} is a Technology Preview feature only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process.
1894+
For more information about the support scope of Red Hat Technology Preview features, see link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Support Scope].
1895+
====
1896+
1897+
|controlPlane:
1898+
platform:
1899+
azure:
1900+
dataDisks:
1901+
- cachingType:
1902+
|Specifies the caching requirements for the disk.
1903+
1904+
*Value:* `None` is the only value currently supported.
1905+
1906+
[IMPORTANT]
1907+
====
1908+
Dedicated disk for `etcd` on {azure-full} is a Technology Preview feature only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process.
1909+
For more information about the support scope of Red Hat Technology Preview features, see link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Support Scope].
1910+
====
1911+
1912+
|controlPlane:
1913+
platform:
1914+
azure:
1915+
dataDisks:
1916+
- diskSizeGB:
1917+
|Specifies a dedicated disk size in GB.
1918+
1919+
*Value:* Integer greater than `0`.
1920+
1921+
[IMPORTANT]
1922+
====
1923+
Dedicated disk for `etcd` on {azure-full} is a Technology Preview feature only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process.
1924+
For more information about the support scope of Red Hat Technology Preview features, see link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Support Scope].
1925+
====
1926+
1927+
|controlPlane:
1928+
platform:
1929+
azure:
1930+
dataDisks:
1931+
- lun:
1932+
|Specifies a logical unit number (LUN) for the dedicated disk.
1933+
1934+
*Value:* Integer from `0` through `63` that is not used by another disk.
1935+
1936+
[IMPORTANT]
1937+
====
1938+
Dedicated disk for `etcd` on {azure-full} is a Technology Preview feature only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process.
1939+
For more information about the support scope of Red Hat Technology Preview features, see link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Support Scope].
1940+
====
1941+
18161942
|controlPlane:
18171943
platform:
18181944
azure:

0 commit comments

Comments
 (0)