Merge pull request #31204 from aburdenthehand/cnv-9053-kubemacpool-by-default

CNV-9053 KubeMacPool enabled by default

Author: aburdenthehand

modules/virt-about-kubemacpool.adoc

@@ -5,7 +5,7 @@
 [id="virt-about-kubemacpool_{context}"]
 = About KubeMacPool
 
-If you enable the KubeMacPool component for a namespace, virtual machine NICs in that namespace are allocated MAC addresses from a MAC address pool.
+KubeMacPool provides a MAC address pool per namespace and allocates MAC addresses for virtual machine NICs from the pool.
 This ensures that the NIC is assigned a unique MAC address that does not conflict with the MAC address of another virtual machine.
 
 Virtual machine instances created from that virtual machine retain the assigned MAC address across reboots.
@@ -15,6 +15,5 @@ Virtual machine instances created from that virtual machine retain the assigned
 KubeMacPool does not handle virtual machine instances created independently from a virtual machine.
 ====
 
-KubeMacPool is disabled by default.
-Enable a MAC address pool for a namespace by applying the KubeMacPool label to the namespace.
-
+KubeMacPool is enabled by default when you install {VirtProductName}.
+You can disable a MAC address pool for a namespace by adding the `mutatevirtualmachines.kubemacpool.io=ignore` label to the namespace. Re-enable KubeMacPool for the namespace by removing the label.

modules/virt-disabling-mac-address-pool-for-namespace-cli.adoc

@@ -5,15 +5,15 @@
 [id="virt-disabling-mac-address-pool-for-namespace-cli_{context}"]
 = Disabling a MAC address pool for a namespace in the CLI
 
-Disable a MAC address pool for virtual machines in a namespace by removing the `mutatevirtualmachines.kubemacpool.io` label.
+Disable a MAC address pool for virtual machines in a namespace by adding the `mutatevirtualmachines.kubemacpool.io=ignore` label to the namespace.
 
 .Procedure
 
-* Remove the KubeMacPool label from the namespace.
-The following example removes the KubeMacPool label from two namespaces, `<namespace1>` and `<namespace2>`:
+* Add the `mutatevirtualmachines.kubemacpool.io=ignore` label to the namespace.
+The following example disables KubeMacPool for two namespaces, `<namespace1>` and `<namespace2>`:
 +
 [source,terminal]
 ----
-$ oc label namespace <namespace1> <namespace2> mutatevirtualmachines.kubemacpool.io-
+$ oc label namespace <namespace1> <namespace2> mutatevirtualmachines.kubemacpool.io=ignore
 ----
 

modules/virt-enabling-mac-address-pool-for-namespace-cli.adoc

@@ -25,5 +25,5 @@
 |List of available binding methods. For the default pod network, `masquerade` is the only recommended binding method. For secondary networks, use the `bridge` binding method. The `masquerade` method is not supported for non-default networks. Select `SR-IOV` if you configured an SR-IOV network device and defined that network in the namespace.
 
 |MAC Address
-|MAC address for the network interface card. If a MAC address is not specified, an ephemeral address is generated for the session.
+|MAC address for the network interface card. If a MAC address is not specified, one is assigned automatically.
 |===

modules/virt-networking-wizard-fields-web.adoc

@@ -61,7 +61,6 @@ $ oc create -f pxe-net-conf.yaml
 
 .. Specify the network and MAC address, if required by the PXE server.
 If the MAC address is not specified, a value is assigned automatically.
-However, note that at this time, MAC addresses assigned automatically are not persistent.
 +
 Ensure that `bootOrder` is set to `1` so that the interface boots first.
 In this example, the interface is connected to a network called

modules/virt-pxe-booting-with-mac-address.adoc

@@ -0,0 +1,24 @@
+// Module included in the following assemblies:
+//
+// * virt/virtual_machines/vm_networking/virt-using-mac-address-pool-for-vms.adoc
+
+[id="virt-reenabling-mac-address-pool-for-namespace-cli_{context}"]
+= Re-enabling a MAC address pool for a namespace in the CLI
+
+If you disabled KubeMacPool for a namespace and want to re-enable it, remove the `mutatevirtualmachines.kubemacpool.io=ignore` label from the namespace.
+
+[NOTE]
+====
+Earlier versions of {VirtProductName} used the label `mutatevirtualmachines.kubemacpool.io=allocate` to enable KubeMacPool for a namespace. This is still supported but redundant as KubeMacPool is now enabled by default.
+====
+
+.Procedure
+
+* Remove the KubeMacPool label from the namespace.
+The following example re-enables KubeMacPool for two namespaces, `<namespace1>` and `<namespace2>`:
++
+[source,terminal]
+----
+$ oc label namespace <namespace1> <namespace2> mutatevirtualmachines.kubemacpool.io-
+----
+

modules/virt-reenabling-mac-address-pool-for-namespace-cli.adoc

@@ -28,7 +28,5 @@ include::modules/virt-deploying-operator-cli.adoc[leveloffset=+1]
 
 You might want to additionally configure the following components:
 
-* The _KubeMacPool_ component provides a MAC address pool service for virtual machine NICs in designated namespaces. xref:../../virt/virtual_machines/vm_networking/virt-using-mac-address-pool-for-vms.adoc#virt-about-kubemacpool_virt-using-mac-address-pool-for-vms[Enable a MAC address pool in a namespace] by applying the KubeMacPool label to that namespace.
-
 * The xref:../../virt/virtual_machines/virtual_disks/virt-configuring-local-storage-for-vms.adoc#virt-about-hostpath-provisioner_virt-configuring-local-storage-for-vms[hostpath provisioner] is a local storage provisioner designed for {VirtProductName}. If you want to configure local storage for virtual machines, you must enable the hostpath provisioner first.
 

virt/install/installing-virt-cli.adoc

@@ -17,6 +17,4 @@ include::modules/virt-installing-virt-operator.adoc[leveloffset=+1]
 
 You might want to additionally configure the following components:
 
-* The _KubeMacPool_ component provides a MAC address pool service for virtual machine NICs in designated namespaces. xref:../../virt/virtual_machines/vm_networking/virt-using-mac-address-pool-for-vms.adoc#virt-about-kubemacpool_virt-using-mac-address-pool-for-vms[Enable a MAC address pool in a namespace] by applying the KubeMacPool label to that namespace.
-
 * The xref:../../virt/virtual_machines/virtual_disks/virt-configuring-local-storage-for-vms.adoc#virt-about-hostpath-provisioner_virt-configuring-local-storage-for-vms[hostpath provisioner] is a local storage provisioner designed for {VirtProductName}. If you want to configure local storage for virtual machines, you must enable the hostpath provisioner first.

virt/install/installing-virt-web.adoc

@@ -15,11 +15,6 @@ To attach a virtual machine to an additional network:
 ** In the web console, create a NIC for a new or existing virtual machine.
 ** In the CLI, include the network information in the virtual machine configuration.
 
-[NOTE]
-====
-The _KubeMacPool_ component provides a MAC address pool service for virtual machine NICs in designated namespaces. It is not enabled by default. xref:../../../virt/virtual_machines/vm_networking/virt-using-mac-address-pool-for-vms.adoc#virt-about-kubemacpool_virt-using-mac-address-pool-for-vms[Enable a MAC address pool in a namespace] by applying the KubeMacPool label to that namespace.
-====
-
 include::modules/virt-networking-glossary.adoc[leveloffset=+1]
 
 [id="virt-creating-network-attachment-definition"]

virt/virtual_machines/vm_networking/virt-attaching-vm-multiple-networks.adoc

@@ -5,10 +5,11 @@ include::modules/virt-document-attributes.adoc[]
 
 toc::[]
 
-The _KubeMacPool_ component provides a MAC address pool service for virtual machine NICs in designated namespaces. Enable a MAC address pool in a namespace by applying the KubeMacPool label to that namespace.
+The _KubeMacPool_ component provides a MAC address pool service for virtual machine NICs in a namespace.
 
 include::modules/virt-about-kubemacpool.adoc[leveloffset=+1]
 
-include::modules/virt-enabling-mac-address-pool-for-namespace-cli.adoc[leveloffset=+1]
-
 include::modules/virt-disabling-mac-address-pool-for-namespace-cli.adoc[leveloffset=+1]
+
+include::modules/virt-reenabling-mac-address-pool-for-namespace-cli.adoc[leveloffset=+1]
+