From 71f8d469871e7902f5a7669acb9631cfa085be6b Mon Sep 17 00:00:00 2001 From: Shafer Slockett Date: Tue, 9 Sep 2025 19:17:46 -0400 Subject: [PATCH] OSDOCS-16109: Add docs for tech preview of azure dedicated disk for etcd --- .../ipi/installing-azure-customizations.adoc | 2 + ...stalling-azure-network-customizations.adoc | 2 + ...-networks-azure-installer-provisioned.adoc | 2 + .../installation-azure-dedicated-disks.adoc | 53 ++++++++ ...installation-configuration-parameters.adoc | 115 ++++++++++++++++++ 5 files changed, 174 insertions(+) create mode 100644 modules/installation-azure-dedicated-disks.adoc diff --git a/installing/installing_azure/ipi/installing-azure-customizations.adoc b/installing/installing_azure/ipi/installing-azure-customizations.adoc index 3f64d4797188..ecb8b63a4c17 100644 --- a/installing/installing_azure/ipi/installing-azure-customizations.adoc +++ b/installing/installing_azure/ipi/installing-azure-customizations.adoc @@ -38,6 +38,8 @@ include::modules/installation-azure-trusted-launch.adoc[leveloffset=+2] include::modules/installation-azure-confidential-vms.adoc[leveloffset=+2] +include::modules/installation-azure-dedicated-disks.adoc[leveloffset=+2] + include::modules/installation-azure-config-yaml.adoc[leveloffset=+2] include::modules/installation-configure-proxy.adoc[leveloffset=+2] diff --git a/installing/installing_azure/ipi/installing-azure-network-customizations.adoc b/installing/installing_azure/ipi/installing-azure-network-customizations.adoc index 7bcd7db2e537..eb3c27fa2c55 100644 --- a/installing/installing_azure/ipi/installing-azure-network-customizations.adoc +++ b/installing/installing_azure/ipi/installing-azure-network-customizations.adoc @@ -36,6 +36,8 @@ include::modules/installation-azure-arm-tested-machine-types.adoc[leveloffset=+2 include::modules/installation-azure-trusted-launch.adoc[leveloffset=+2] include::modules/installation-azure-confidential-vms.adoc[leveloffset=+2] +include::modules/installation-azure-dedicated-disks.adoc[leveloffset=+2] + include::modules/installation-azure-config-yaml.adoc[leveloffset=+2] include::modules/installation-configure-proxy.adoc[leveloffset=+2] diff --git a/installing/installing_azure/ipi/installing-restricted-networks-azure-installer-provisioned.adoc b/installing/installing_azure/ipi/installing-restricted-networks-azure-installer-provisioned.adoc index 604dc5e27479..933e6fe25992 100644 --- a/installing/installing_azure/ipi/installing-restricted-networks-azure-installer-provisioned.adoc +++ b/installing/installing_azure/ipi/installing-restricted-networks-azure-installer-provisioned.adoc @@ -54,6 +54,8 @@ include::modules/installation-azure-arm-tested-machine-types.adoc[leveloffset=+2 include::modules/installation-azure-trusted-launch.adoc[leveloffset=+2] include::modules/installation-azure-confidential-vms.adoc[leveloffset=+2] +include::modules/installation-azure-dedicated-disks.adoc[leveloffset=+2] + include::modules/installation-azure-config-yaml.adoc[leveloffset=+2] include::modules/installation-configure-proxy.adoc[leveloffset=+2] diff --git a/modules/installation-azure-dedicated-disks.adoc b/modules/installation-azure-dedicated-disks.adoc new file mode 100644 index 000000000000..501ce0359fdb --- /dev/null +++ b/modules/installation-azure-dedicated-disks.adoc @@ -0,0 +1,53 @@ +// Module included in the following assemblies: +// +// * installing/installing_azure/ipi/installing-azure-customizations.adoc +// * installing/installing_azure/ipi/installing-azure-network-customizations.adoc +// * installing/installing_azure/ipi/installing-restricted-networks-azure-installer-provisioned.adoc + +:_mod-docs-content-type: PROCEDURE +[id="installation-azure-dedicated-disks_{context}"] += Configuring a dedicated disk for etcd + +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 I/O performance and stability. + +:FeatureName: Dedicated disk for etcd + +include::snippets/technology-preview.adoc[] + +.Prerequisites +* You have created an `install-config.yaml` file. + +.Procedure + +* To configure a dedicated `etcd` disk, edit the `install-config.yaml` file and add the `diskSetup` and `dataDisks` parameters to the `controlPlane` stanza: ++ +[source,yaml] +---- +controlPlane: + architecture: amd64 + hyperthreading: Enabled + name: master + diskSetup: + - type: etcd <1> + etcd: + platformDiskID: "etcddisk" <2> + platform: + azure: + type: Standard_D4s_v5 + dataDisks: + - nameSuffix: etcddisk <3> + diskSizeGB: 20 <4> + lun: 0 <5> + replicas: 3 +---- + +<1> Specify `etcd`. +<2> Specify a name to identify the disk. +<3> Specify the same value given for `platformDiskID`. +<4> Specify a disk size in GB. This can be any integer from `8` through `32`. ++ +[NOTE] +==== +A minimum of 20 GB ensures enough space is available for defragmentation operations. +==== +<5> Specify a logical unit number (LUN). This can be any integer from `0` through `63` that is not used by another disk. \ No newline at end of file diff --git a/modules/installation-configuration-parameters.adoc b/modules/installation-configuration-parameters.adoc index 132283828ccc..4239c536805d 100644 --- a/modules/installation-configuration-parameters.adoc +++ b/modules/installation-configuration-parameters.adoc @@ -1596,6 +1596,60 @@ Supplying more than one user-assigned identity is an experimental feature, which |Enables the encryption of the virtual machine guest state for compute nodes. This parameter can only be used if you use Confidential VMs. |`VMGuestStateOnly` is the only supported value. +|controlPlane: + diskSetup: +|Specifies node component information for dedicated disk configuration. + +[IMPORTANT] +==== +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. +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]. +==== + +|Array of objects. Includes a `type`, which contains `etcd` and `platformDiskID` as described in the following rows of this table. + +|controlPlane: + diskSetup: + - type: +|Specifies which node component type to assign a dedicated disk. + +[IMPORTANT] +==== +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. +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]. +==== + +|`etcd` is the only supported value. + +|controlPlane: + diskSetup: + - type: etcd + etcd: +|Specifies parameters for an `etcd` dedicated disk. + +[IMPORTANT] +==== +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. +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]. +==== + +|The `platformDiskID` object is the only supported value. + +|controlPlane: + diskSetup: + - type: etcd + etcd: + platformDiskID: +|Specifies a name to identify the dedicated disk. + +[IMPORTANT] +==== +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. +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]. +==== + +|String. + |controlPlane: platform: azure: @@ -1653,6 +1707,67 @@ Supplying more than one user-assigned identity is an experimental feature, which |Specifies the {azure-short} storage account to store the diagnostic logs for control plane machines. Use `storageAccountName` only when you set `type` to `UserManaged`. |String. +|controlPlane: + platform: + azure: + dataDisks: +|Specifies dedicated disk parameters. + +[IMPORTANT] +==== +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. +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]. +==== + +|Array of objects. Includes a `NameSuffix`, which contains `diskSizeGB` and `lun` as described in the following rows of this table. + +|controlPlane: + platform: + azure: + dataDisks: + - NameSuffix: +|Specifies the same value given for `platformDiskID`. + +[IMPORTANT] +==== +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. +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]. +==== + +|String. + +|controlPlane: + platform: + azure: + dataDisks: + - nameSuffix: + diskSizeGB: +|Specifies a dedicated disk size in GB. + +[IMPORTANT] +==== +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. +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]. +==== + +|Integer from `8` through `32`. + +|controlPlane: + platform: + azure: + dataDisks: + - nameSuffix: + lun: +|Specifies a logical unit number (LUN) for the dedicated disk. + +[IMPORTANT] +==== +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. +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]. +==== + +|Integer from `0` through `63` that is not used by another disk. + |controlPlane: platform: azure: