TELCODOCS-1348: Exposing disk cleaning option through SiteConfig

Author: amolnar-rh

snippets/ztp-example-siteconfig.adoc

@@ -37,15 +37,16 @@ spec:
         nodeLabels: <7>
           node-role.kubernetes.io/example-label:
           custom-label/parameter1: true
-        bmcAddress: idrac-virtualmedia://<out_of_band_ip>/<system_id>/ <8>
+      # automatedCleaningMode: "disabled" <8>
+        bmcAddress: idrac-virtualmedia://<out_of_band_ip>/<system_id>/ <9>
         bmcCredentialsName:
-          name: "bmh-secret" <9>
+          name: "bmh-secret" <10>
         bootMACAddress: "AA:BB:CC:DD:EE:11"
-        bootMode: "UEFI" <10>
-        rootDeviceHints: <11>
+        bootMode: "UEFI" <11>
+        rootDeviceHints: <12>
           wwn: "0x11111000000asd123"
-        cpuset: "0-1,52-53"  <12>
-        nodeNetwork: <13>
+        cpuset: "0-1,52-53"  <13>
+        nodeNetwork: <14>
           interfaces:
             - name: eno1
               macAddress: "AA:BB:CC:DD:EE:11"
@@ -56,7 +57,7 @@ spec:
                 state: up
                 ipv4:
                   enabled: false
-                ipv6: <14>
+                ipv6: <15>
                   enabled: true
                   address:
                   - ip: 1111:2222:3333:4444::aaaa:1
@@ -81,10 +82,11 @@ spec:
 <5> Optional. The CR specifed under `KlusterletAddonConfig` is used to override the default `KlusterletAddonConfig` that is created for the cluster.
 <6> For single-node deployments, define a single host. For three-node deployments, define three hosts. For standard deployments, define three hosts with `role: master` and two or more hosts defined with `role: worker`.
 <7> Specify custom roles to your nodes in your managed clusters. These are additional roles which are not used by any {product-title} components, only by the user. When you add a custom role, it can be associated with a custom machine config pool that references a specific configuration for that role. Adding your custom labels or roles during installation makes the deployment process more effective and prevents the need for additional reboots after the installation is complete.
-<8> BMC address that you use to access the host. Applies to all cluster types. {ztp} supports iPXE and virtual media booting by using Redfish or IPMI protocols. To use iPXE booting, you must use {rh-rhacm} 2.8 or later. For more information about BMC addressing, see the _Additional resources_ section.
-<9> Name of the `bmh-secret` CR that you separately create with the host BMC credentials. When creating the `bmh-secret` CR, use the same namespace as the `SiteConfig` CR that provisions the host.
-<10> Configures the boot mode for the host. The default value is `UEFI`. Use `UEFISecureBoot` to enable secure boot on the host.
-<11> Specifies the device for deployment. Identifiers that are stable across reboots are recommended, for example `wwn: <disk_wwn>` or `deviceName: /dev/disk/by-path/<device_path>`. For a detailed list of stable identifiers, see the _About root device hints_ section.
-<12> `cpuset` must match the value set in the cluster `PerformanceProfile` CR `spec.cpu.reserved` field for workload partitioning.
-<13> Specifies the network settings for the node.
-<14> Configures the IPv6 address for the host. For {sno} clusters with static IP addresses, the node-specific API and Ingress IP addresses must be the same.
+<8> Optional. If the value is set to `metadata`, the partitioning table of the disk is removed, but the disk is not fully wiped. By default, the `automatedCleaningMode` field is disabled. To enable removing the partitioning table, uncomment this line and set the value to `metadata`.
+<9> BMC address that you use to access the host. Applies to all cluster types. {ztp} supports iPXE and virtual media booting by using Redfish or IPMI protocols. To use iPXE booting, you must use {rh-rhacm} 2.8 or later. For more information about BMC addressing, see the _Additional resources_ section.
+<10> Name of the `bmh-secret` CR that you separately create with the host BMC credentials. When creating the `bmh-secret` CR, use the same namespace as the `SiteConfig` CR that provisions the host.
+<11> Configures the boot mode for the host. The default value is `UEFI`. Use `UEFISecureBoot` to enable secure boot on the host.
+<12> Specifies the device for deployment. Identifiers that are stable across reboots are recommended, for example `wwn: <disk_wwn>` or `deviceName: /dev/disk/by-path/<device_path>`. For a detailed list of stable identifiers, see the _About root device hints_ section.
+<13> `cpuset` must match the value set in the cluster `PerformanceProfile` CR `spec.cpu.reserved` field for workload partitioning.
+<14> Specifies the network settings for the node.
+<15> Configures the IPv6 address for the host. For {sno} clusters with static IP addresses, the node-specific API and Ingress IP addresses must be the same.