Merge pull request #88115 from sjhala-ccs/cnv-54739

CNV-54739: UI procedure to create UDN

Author: sjhala-ccs

modules/virt-attaching-vm-to-primary-udn.adoc

@@ -4,7 +4,7 @@
 
 :_mod-docs-content-type: PROCEDURE                                
 [id="virt-attaching-vm-to-primary-udn_{context}"]                                  
-= Attaching a virtual machine to the primary user-defined network
+= Attaching a virtual machine to the primary user-defined network by using the CLI
 
 You can connect a virtual machine (VM) to the primary user-defined network (UDN) by requesting the pod network attachment, and configuring the interface binding.
 

modules/virt-creating-a-primary-cluster-udn.adoc

@@ -4,14 +4,13 @@
 
 :_mod-docs-content-type: PROCEDURE                                
 [id="virt-creating-a-primary-cluster-udn_{context}"]                                  
-= Creating a primary cluster-scoped user-defined network
+= Creating a primary cluster-scoped user-defined network by using the CLI
 
-You can connect multiple namespaces to the same primary user-defined network (UDN) to achieve native tenant isolation.
+You can connect multiple namespaces to the same primary user-defined network (UDN) to achieve native tenant isolation by using the CLI.
 
 .Prerequisites
 . You have access to the cluster as a user with `cluster-admin` privileges.
 . You have installed the OpenShift CLI (`oc`).
-. You have created multiple namespaces with the `k8s.ovn.org/primary-user-defined-network` label.
 
 .Procedure
 . Create a `ClusterUserDefinedNetwork` object to specify the custom network configuration:

modules/virt-creating-a-primary-udn.adoc

@@ -4,9 +4,9 @@
 
 :_mod-docs-content-type: PROCEDURE                                
 [id="virt-creating-a-primary-udn_{context}"]                                  
-= Creating a primary namespace-scoped user-defined network
+= Creating a primary namespace-scoped user-defined network by using the CLI
 
-You can create an isolated primary network in your project namespace. You must use the OVN-Kubernetes layer 2 topology and enable persistent IP address allocation in the user-defined network (UDN) configuration to ensure VM live migration support.
+You can create an isolated primary network in your project namespace by using the CLI. You must use the OVN-Kubernetes layer 2 topology and enable persistent IP address allocation in the user-defined network (UDN) configuration to ensure VM live migration support.
 
 .Prerequisites
 . You have installed the OpenShift CLI (`oc`).

modules/virt-creating-primary-cluster-udn-web.adoc

@@ -0,0 +1,25 @@
+// Module included in the following assemblies:
+//
+// * virt/vm_networking/virt-connecting-vm-to-primary-udn.adoc              
+
+:_mod-docs-content-type: PROCEDURE                                    
+[id="virt-creating-primary-cluster-udn-web_{context}"]                                   
+= Creating a primary cluster-scoped user-defined network by using the web console
+
+You can connect multiple namespaces to the same primary user-defined network (UDN) by creating a `ClusterUserDefinedNetwork` custom resource in the {product-title} web console.
+
+.Prerequisites
+* You have access to the {product-title} web console as a user with `cluster-admin` permissions.
+
+.Procedure
+. From the *Administrator* perspective, click *Networking* -> *UserDefinedNetworks*.
+
+. From the *Create* list, select *ClusterUserDefinedNetwork*.
+
+. In the *Name* field, specify a name for the cluster-scoped UDN.
+
+. Specify a value in the *Subnet* field.
+
+. In the *Project(s) Match Labels* field, add the appropriate labels to select namespaces that the cluster UDN applies to.
+
+. Click *Create*. The cluster-scoped UDN serves as the default primary network for pods and virtual machines located in namespaces that contain the labels that you specified in step 5.

modules/virt-creating-primary-udn-web.adoc

@@ -0,0 +1,24 @@
+// Module included in the following assemblies:
+//
+// * virt/vm_networking/virt-connecting-vm-to-primary-udn.adoc              
+
+:_mod-docs-content-type: PROCEDURE                                    
+[id="virt-creating-primary-udn-web_{context}"]                                   
+= Creating a primary namespace-scoped user-defined network by using the web console
+
+You can create an isolated primary network in your project namespace by creating a `UserDefinedNetwork` custom resource in the {product-title} web console.
+
+.Prerequisites
+* You have access to the {product-title} web console as a user with `cluster-admin` permissions.
+* You have created a namespace and applied the `k8s.ovn.org/primary-user-defined-network` label. For more information, see "Creating a namespace for user-defined networks by using the web console".
+
+.Procedure
+. From the *Administrator* perspective, click *Networking* -> *UserDefinedNetworks*.
+
+. Click *Create UserDefinedNetwork*.
+
+. From the *Project name* list, select the namespace that you previously created.
+
+. Specify a value in the *Subnet* field.
+
+. Click *Create*. The user-defined network serves as the default primary network for pods and virtual machines that you create in this namespace.

modules/virt-creating-udn-namespace-cli.adoc

@@ -0,0 +1,36 @@
+// Module included in the following assemblies:
+//
+// * virt/vm_networking/virt-connecting-vm-to-primary-udn.adoc              
+
+:_mod-docs-content-type: PROCEDURE                                    
+[id="virt-creating-udn-namespace-cli_{context}"]                                   
+= Creating a namespace for user-defined networks by using the CLI
+
+You can create a namespace to be used with primary user-defined networks (UDNs) by using the CLI.
+
+.Prerequisites
+* You have access to the cluster as a user with `cluster-admin` permissions.
+* You have installed the OpenShift CLI (`oc`).
+
+
+.Procedure
+. Create a `Namespace` object as a YAML file similar to the following example:
++
+[source,yaml]
+----
+apiVersion: v1
+kind: Namespace
+metadata:
+  name: udn_namespace
+  labels:
+    k8s.ovn.org/primary-user-defined-network: "" # <1>
+# ...
+----
+<1> This label is required for the namespace to be associated with a UDN. If the namespace is to be used with an existing cluster UDN, you must also add the appropriate labels that are defined in the `spec.namespaceSelector` field of the `ClusterUserDefinedNetwork` custom resource.
+
+. Apply the `Namespace` manifest by running the following command:
++
+[source, terminal]
+----
+oc apply -f <filename>.yaml
+----

modules/virt-creating-udn-namespace-web.adoc

@@ -0,0 +1,28 @@
+// Module included in the following assemblies:
+//
+// * virt/vm_networking/virt-connecting-vm-to-primary-udn.adoc              
+
+:_mod-docs-content-type: PROCEDURE                                    
+[id="virt-creating-udn-namespace-web_{context}"]                                   
+= Creating a namespace for user-defined networks by using the web console
+
+You can create a namespace to be used with primary user-defined networks (UDNs) by using the {product-title} web console.
+
+.Prerequisites
+* Log in to the {product-title} web console as a user with `cluster-admin` permissions.
+
+
+.Procedure
+. From the *Administrator* perspective, click *Administration* -> *Namespaces*.
+
+. Click *Create Namespace*.
+
+. In the *Name* field, specify a name for the namespace. The name must consist of lower case alphanumeric characters or '-', and must start and end with an alphanumeric character.
+
+. In the *Labels* field, add the `k8s.ovn.org/primary-user-defined-network` label.
+
+. Optional: If the namespace is to be used with an existing cluster-scoped UDN, add the appropriate labels as defined in the `spec.namespaceSelector` field in the `ClusterUserDefinedNetwork` custom resource.
+
+. Optional: Specify a default network policy.
+
+. Click *Create* to create the namespace.

virt/vm_networking/virt-connecting-vm-to-primary-udn.adoc

@@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[]
 
 toc::[]                
 
-You can connect a virtual machine (VM) to a user-defined network (UDN) on the VM's primary interface. The primary user-defined network replaces the default pod network in your specified namespace. Unlike the pod network, you can define the primary UDN per project, where each project can use its specific subnet and topology.
+You can connect a virtual machine (VM) to a user-defined network (UDN) on the VM's primary interface by using the {product-title} web console or the CLI. The primary user-defined network replaces the default pod network in your specified namespace. Unlike the pod network, you can define the primary UDN per project, where each project can use its specific subnet and topology.
 
 {VirtProductName} supports the namespace-scoped `UserDefinedNetwork` and the cluster-scoped `ClusterUserDefinedNetwork` custom resource definitions (CRD). 
 
@@ -33,9 +33,35 @@ You must consider the following limitations before implementing a primary UDN:
 {VirtProductName} currently does not support secondary user-defined networks.
 ====
 
-include::modules/virt-creating-a-primary-udn.adoc[leveloffset=+1]
+[id="creating-primary-udn-web_{context}"]
+== Creating a primary user-defined network by using the web console
 
-include::modules/virt-creating-a-primary-cluster-udn.adoc[leveloffset=+1]
+You can use the {product-title} web console to create a primary namespace-scoped `UserDefinedNetwork` or a cluster-scoped `ClusterUserDefinedNetwork` CRD. The UDN serves as the default primary network for pods and VMs that you create in namespaces associated with the network.
+
+include::modules/virt-creating-udn-namespace-web.adoc[leveloffset=+2]
+
+include::modules/virt-creating-primary-udn-web.adoc[leveloffset=+2]
+
+include::modules/virt-creating-primary-cluster-udn-web.adoc[leveloffset=+2]
+
+[id="next-steps-web_{context}"]
+.Next steps
+* xref:../../virt/vm_networking/virt-connecting-vm-to-primary-udn.adoc#virt-creating-udn-namespace-web_virt-connecting-vm-to-primary-udn[Create namespaces that are associated with the cluster-scoped UDN]
+
+[id="creating-primary-udn-cli_{context}"]
+== Creating a primary user-defined network by using the CLI
+
+You can create a primary `UserDefinedNetwork` or `ClusterUserDefinedNetwork` CRD by using the CLI.
+
+include::modules/virt-creating-udn-namespace-cli.adoc[leveloffset=+2]
+
+include::modules/virt-creating-a-primary-udn.adoc[leveloffset=+2]
+
+include::modules/virt-creating-a-primary-cluster-udn.adoc[leveloffset=+2]
+
+[id="next-steps-cli_{context}"]
+.Next steps
+* xref:../../virt/vm_networking/virt-connecting-vm-to-primary-udn.adoc#virt-creating-udn-namespace-cli_virt-connecting-vm-to-primary-udn[Create namespaces that are associated with the cluster-scoped UDN]
 
 include::modules/virt-attaching-vm-to-primary-udn.adoc[leveloffset=+1]