diff --git a/images/fa-minus-circle.svg b/images/fa-minus-circle.svg new file mode 100644 index 0000000000..f976a98338 --- /dev/null +++ b/images/fa-minus-circle.svg @@ -0,0 +1,2 @@ + + \ No newline at end of file diff --git a/modules/virt-create-node-network-config-console.adoc b/modules/virt-create-node-network-config-console.adoc new file mode 100644 index 0000000000..57eb81c56c --- /dev/null +++ b/modules/virt-create-node-network-config-console.adoc @@ -0,0 +1,60 @@ +:_content-type: PROCEDURE +[id="virt-create-node-network-config-console_{context}"] += Creating a policy + +You can create a policy by using either a form or YAML in the web console. + +.Procedure +. Navigate to *Networking* → *NodeNetworkConfigurationPolicy*. + +. In the *NodeNetworkConfigurationPolicy* page, click *Create*, and select *From Form* option. ++ +In case there are no existing policies, you can alternatively click *Create NodeNetworkConfigurationPolicy* to createa policy using form. ++ +[NOTE] +==== +To create policy using YAML, click *Create*, and select *With YAML* option. The following steps are applicable to create a policy only by using form. +==== + +. Optional: Check the *Apply this NodeNetworkConfigurationPolicy only to specific subsets of nodes using the node selector* checkbox to specify the nodes where the policy must be applied. + +. Enter the policy name in the *Policy name* field. + +. Optional: Enter the description of the policy in the *Description* field. + +. Optional: In the *Policy Interface(s)* section, a bridge interface is added by default with preset values in editable fields. Edit the values by executing the following steps: + +.. Enter the name of the interface in *Interface name* field. + +.. Select the network state from *Network state* dropdown. The default selected value is *Up*. + +.. Select the type of interface from *Type* dropdown. The available values are *Bridge*, *Bonding*, and *Ethernet*. The default selected value is *Bridge*. ++ +[NOTE] +==== +Addition of a VLAN interface by using the form is not supported. To add a VLAN interface, you must use YAML to create the policy. Once added, you cannot edit the policy by using form. +==== + +.. Optional: In the IP configuration section, check *IPv4* checkbox to assign an IPv4 address to the interface, and configure the IP address assignment details: + +... Click *IP address* to configure the interface with a static IP address, or *DHCP* to auto-assign an IP address. + +... If you have selected *IP address* option, enter the IPv4 address in *IPV4 address* field, and enter the prefix length in *Prefix length* field. ++ +If you have selected *DHCP* option, uncheck the options that you want to disable. The available options are *Auto-DNS*, *Auto-routes*, and *Auto-gateway*. All the options are selected by default. + +.. Optional: Enter the port number in *Port* field. + +.. Optional: Check the checkbox *Enable STP* to enable STP. + +.. Optional: To add an interface to the policy, click *Add another interface to the policy*. + +.. Optional: To remove an interface from the policy, click image:fa-minus-circle.svg[minus] icon next to the interface. + ++ +[NOTE] +==== +Alternatively, you can click *Edit YAML* on the top of the page to continue editing the form using YAML. +==== + +. Click *Create* to complete policy creation. \ No newline at end of file diff --git a/modules/virt-delete-node-network-config.adoc b/modules/virt-delete-node-network-config.adoc new file mode 100644 index 0000000000..8ab8f4b608 --- /dev/null +++ b/modules/virt-delete-node-network-config.adoc @@ -0,0 +1,10 @@ +:_content-type: PROCEDURE +[id="virt-delete-node-network-config_{context}"] += Deleting the policy + +.Procedure +. Navigate to *Networking* → *NodeNetworkConfigurationPolicy*. + +. In the *NodeNetworkConfigurationPolicy* page, click the {kebab} icon placed next to the policy you want to delete, and click *Delete*. + +. In the pop-up window, enter the policy name to confirm deletion, and click *Delete*. diff --git a/modules/virt-monitor-node-network-config-console.adoc b/modules/virt-monitor-node-network-config-console.adoc new file mode 100644 index 0000000000..16b69b15da --- /dev/null +++ b/modules/virt-monitor-node-network-config-console.adoc @@ -0,0 +1,13 @@ +:_content-type: REFERENCE +[id="virt-monitor-node-network-config-console_{context}"] += Monitoring the policy status + +You can monitor the policy status from the *NodeNetworkConfigurationPolicy* page. This page displays all the policies created in the cluster in a tabular format, with the following columns: + +Name:: The name of the policy created. + +Matched nodes:: The count of nodes where the policies are applied. This could be either a subset of nodes based on the node selector or all the nodes on the cluster. + +Node network state:: The enactment state of the matched nodes. You can click on the enactment state and view detailed information on the status. + +To find the desired policy, you can filter the list either based on enactment state by using the *Filter* option, or by using the search option. \ No newline at end of file diff --git a/modules/virt-node-network-config-console.adoc b/modules/virt-node-network-config-console.adoc new file mode 100644 index 0000000000..87604e2ef7 --- /dev/null +++ b/modules/virt-node-network-config-console.adoc @@ -0,0 +1,5 @@ +:_content-type: CONCEPT +[id="virt-node-network-config-console_{context}"] += Managing policy from the web console +You can manage the policy from the web console by accessing the list of created policies in *NodeNetworkConfigurationPolicy* page under *Networking* menu. This page enables you to create, update, monitor, and delete the policies. + diff --git a/modules/virt-update-node-network-config-form.adoc b/modules/virt-update-node-network-config-form.adoc new file mode 100644 index 0000000000..fa066aec73 --- /dev/null +++ b/modules/virt-update-node-network-config-form.adoc @@ -0,0 +1,17 @@ +:_content-type: PROCEDURE +[id="virt-update-node-network-config-form_{context}"] += Updating the policy by using form + +.Procedure +. Navigate to *Networking* → *NodeNetworkConfigurationPolicy*. + +. In the *NodeNetworkConfigurationPolicy* page, click the {kebab} icon placed next to the policy you want to edit, and click *Edit*. + +. Edit the fields that you want to update. + +. Click *Save*. + +[NOTE] +==== +Addition of a VLAN interface using the form is not supported. To add a VLAN interface, you must use YAML to create the policy. Once added, you cannot edit the policy using form. +==== diff --git a/modules/virt-update-node-network-config-yaml.adoc b/modules/virt-update-node-network-config-yaml.adoc new file mode 100644 index 0000000000..f80c1b8961 --- /dev/null +++ b/modules/virt-update-node-network-config-yaml.adoc @@ -0,0 +1,12 @@ +:_content-type: PROCEDURE +[id="virt-update-node-network-config-yaml_{context}"] += Updating the policy by using YAML + +.Procedure +. Navigate to *Networking* → *NodeNetworkConfigurationPolicy*. + +. In the *NodeNetworkConfigurationPolicy* page, click the policy name under the *Name* column for the policy you want to edit. + +. Click the *YAML* tab, and edit the YAML. + +. Click *Save*. diff --git a/networking/k8s_nmstate/k8s-nmstate-updating-node-network-config.adoc b/networking/k8s_nmstate/k8s-nmstate-updating-node-network-config.adoc index fa8e4eff66..97aa08e334 100644 --- a/networking/k8s_nmstate/k8s-nmstate-updating-node-network-config.adoc +++ b/networking/k8s_nmstate/k8s-nmstate-updating-node-network-config.adoc @@ -11,7 +11,19 @@ You can update the node network configuration, such as adding or removing interf include::modules/virt-about-nmstate.adoc[leveloffset=+1] -include::modules/virt-creating-interface-on-nodes.adoc[leveloffset=+1] + +include::modules/virt-node-network-config-console.adoc[leveloffset=+1] +include::modules/virt-monitor-node-network-config-console.adoc[leveloffset=+2] +include::modules/virt-create-node-network-config-console.adoc[leveloffset=+2] + +=== Updating the policy +include::modules/virt-update-node-network-config-form.adoc[leveloffset=+3] +include::modules/virt-update-node-network-config-yaml.adoc[leveloffset=+3] +include::modules/virt-delete-node-network-config.adoc[leveloffset=+2] + +[id="virt-manage-nncp-cli"] +== Managing policy by using the CLI +include::modules/virt-creating-interface-on-nodes.adoc[leveloffset=+2] [discrete] [role="_additional-resources"] @@ -19,9 +31,9 @@ include::modules/virt-creating-interface-on-nodes.adoc[leveloffset=+1] * xref:../../networking/k8s_nmstate/k8s-nmstate-updating-node-network-config.adoc#virt-example-nmstate-multiple-interfaces_{context}[Example for creating multiple interfaces in the same policy] * xref:../../networking/k8s_nmstate/k8s-nmstate-updating-node-network-config.adoc#virt-example-nmstate-IP-management_{context}[Examples of different IP management methods in policies] -include::modules/virt-confirming-policy-updates-on-nodes.adoc[leveloffset=+1] +include::modules/virt-confirming-policy-updates-on-nodes.adoc[leveloffset=+2] -include::modules/virt-removing-interface-from-nodes.adoc[leveloffset=+1] +include::modules/virt-removing-interface-from-nodes.adoc[leveloffset=+2] [id="virt-nmstate-example-policy-configurations"] == Example policy configurations for different interfaces