diff --git a/modules/virt-create-node-network-config-console.adoc b/modules/virt-create-node-network-config-console.adoc index 081a3478eb1d..55cf6d73954d 100644 --- a/modules/virt-create-node-network-config-console.adoc +++ b/modules/virt-create-node-network-config-console.adoc @@ -2,33 +2,30 @@ [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. +You can create a policy by using either a form or YAML in the web console. When creating a policy using a form, you can see how the new policy changes the topology of the nodes in your cluster in real time. .Procedure -. Navigate to *Networking* → *NodeNetworkConfigurationPolicy*. +. Navigate to *Networking* → *Node Network Configuration*. -. 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. +. On the *Node Network Configuration* page, click *Create* and select the *From Form* option. + [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. +To create a policy using YAML, click *Create* -> *With YAML* option. However, the following steps apply only to the form method. ==== - . 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. +. Click *Next* to move to the *Policy Interfaces* section. -. 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: +. In the *Bridging* part of the *Policy Interfaces* section, a bridge interface named `br0` is added by default with preset values in editable fields. If required, edit the values by performing 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 required network state. The default selected state is *Up*. -.. Select the type of interface from *Type* dropdown. The available values are *Bridge*, *Bonding*, and *Ethernet*. The default selected value is *Bridge*. +.. Select the type of interface. The available types are *Bridge*, *Bonding*, and *Ethernet*. The default selected value is *Bridge*. + [NOTE] ==== @@ -56,5 +53,5 @@ If you have selected *DHCP* option, uncheck the options that you want to disable ==== 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 +. Click *Next* to go to the *Review* section of the form. +. Verify the settings and click *Create* to create the policy. \ No newline at end of file diff --git a/modules/virt-viewing-graphical-representation-of-network-state-of-node-console.adoc b/modules/virt-viewing-graphical-representation-of-network-state-of-node-console.adoc new file mode 100644 index 000000000000..0020fcdf602e --- /dev/null +++ b/modules/virt-viewing-graphical-representation-of-network-state-of-node-console.adoc @@ -0,0 +1,20 @@ +// Module included in the following assemblies: +// +// * networking/k8s_nmstate/k8s-observing-node-network-state.adoc +// * networking/k8s_nmstate/k8s-nmstate-updating-node-network-config.adoc + +:_mod-docs-content-type: PROCEDURE +[id="virt-viewing-graphical-representation-of-network-state-of-node-console_{context}"] += Viewing a graphical representation of the network state of a node (NNS) topology from the web console + +To make the configuration of the node network in the cluster easier to understand, you can view it in the form of a diagram. The NNS topology diagram displays all node components (network interface controllers, bridges, bonds, and VLANs), their properties and configurations, and connections between the nodes. + +To open the topology view of the cluster, use the following steps: + +* In the *Administrator* view of the {product-title} web console, navigate to *Networking* -> *Node Network Configuration*. ++ +The NNS topology diagram opens. Each group of components represents a single node. ++ +** To display the configuration and properties of a node, click inside the border of the node. +** To display the features or the YAML file of a specific component (for example, an interface or a bridge), click the icon of the component. +** The icons of active components have green borders; the icons of disconnected components have red borders. diff --git a/modules/virt-viewing-list-of-nodenetworkstate-resources-console.adoc b/modules/virt-viewing-list-of-nodenetworkstate-resources-console.adoc new file mode 100644 index 000000000000..684fbb374124 --- /dev/null +++ b/modules/virt-viewing-list-of-nodenetworkstate-resources-console.adoc @@ -0,0 +1,23 @@ +// Module included in the following assemblies: +// +// * networking/k8s_nmstate/k8s-observing-node-network-state.adoc +// * networking/k8s_nmstate/k8s-nmstate-updating-node-network-config.adoc + +:_mod-docs-content-type: PROCEDURE +[id="virt-viewing-list-of-nodenetworkstate-resources-console_{context}"] += Viewing the list of NodeNetworkState resources + +As an administrator, you can use the {product-title} web console to view the list of `NodeNetworkState` resources and network interfaces, and access network details. + +.Procedure +. Navigate to *Networking* → *Node Network Configuration*. +. Click the *List* icon. ++ +You can now view the list of `NodeNetworkState` resources and the corresponding interfaces that are created on the nodes. + +* You can use *Filter* based on *Interface state*, *Interface type*, and *IP*, or the search bar based on criteria *Name* or *Label*, to narrow down the displayed `NodeNetworkState` resources. + +* To access the detailed information about a `NodeNetworkState` resource, click the `NodeNetworkState` resource name listed in the *Name* column . + +* To expand and view the *Network Details* section for the `NodeNetworkState` resource, click the greater than (*>*) symbol . Alternatively, you can click on each interface type under the *Network interface* column to view the network details. + diff --git a/modules/virt-viewing-network-state-of-node-console.adoc b/modules/virt-viewing-network-state-of-node-console.adoc deleted file mode 100644 index 6c005d7e24a4..000000000000 --- a/modules/virt-viewing-network-state-of-node-console.adoc +++ /dev/null @@ -1,35 +0,0 @@ -// Module included in the following assemblies: -// -// * networking/k8s_nmstate/k8s-observing-node-network-state.adoc - -:_mod-docs-content-type: PROCEDURE -[id="virt-viewing-network-state-of-node-console_{context}"] -= Viewing the network state of a node (NNS) from the web console - -As an administrator, you can use the {product-title} web console to observe `NodeNetworkState` resources and network interfaces, and access network details. - -.Procedure -. Navigate to *Networking* → *NodeNetworkState*. -+ -In the *NodeNetworkState* page, you can view the list of `NodeNetworkState` resources and the corresponding interfaces that are created on the nodes. You can use *Filter* based on *Interface state*, *Interface type*, and *IP*, or the search bar based on criteria *Name* or *Label*, to narrow down the displayed `NodeNetworkState` resources. - -. To access the detailed information about `NodeNetworkState` resource, click the `NodeNetworkState` resource name listed in the *Name* column . - -. To expand and view the *Network Details* section for the `NodeNetworkState` resource, click the greater than (*>*) symbol . Alternatively, you can click on each interface type under the *Network interface* column to view the network details. - -[id="virt-viewing-graphical-representation-of-nns-topology_{context}"] -== Viewing a graphical representation of the NNS topology - -To make the configuration of the node network in the cluster easier to understand, you can view it in the form of a diagram. The NNS topology diagram displays all node components (network interface controllers, bridges, bonds, and VLANs), their properties and configurations, and connections between the nodes. - -To open the topology view of the cluster, do the following: - -. In the *Administrator* view of the web console, navigate to *Networking* -> *NodeNetworkState*. -. In the upper-right corner of the page, click the *Topology* icon. -+ -The NNS topology diagram opens. Each group of components represents a single node. -+ -* To display the configuration and propertires of a node, click inside the border of the node. -* To display the features or the YAML file of a specific component (for example, an interface or a bridge), click the icon of the component. -* The icons of active components have green borders; the icons of disconnected components have red borders. - diff --git a/networking/k8s_nmstate/k8s-nmstate-observing-node-network-state.adoc b/networking/k8s_nmstate/k8s-nmstate-observing-node-network-state.adoc index 1469c8f74728..5439ca98eea4 100644 --- a/networking/k8s_nmstate/k8s-nmstate-observing-node-network-state.adoc +++ b/networking/k8s_nmstate/k8s-nmstate-observing-node-network-state.adoc @@ -11,4 +11,6 @@ Node network state is the network configuration for all nodes in the cluster. include::modules/virt-viewing-network-state-of-node.adoc[leveloffset=+1] -include::modules/virt-viewing-network-state-of-node-console.adoc[leveloffset=+1] +include::modules/virt-viewing-graphical-representation-of-network-state-of-node-console.adoc[leveloffset=+1] + +include::modules/virt-viewing-list-of-nodenetworkstate-resources-console.adoc[leveloffset=+1] 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 4becfc95000d..3a6a0be3762b 100644 --- a/networking/k8s_nmstate/k8s-nmstate-updating-node-network-config.adoc +++ b/networking/k8s_nmstate/k8s-nmstate-updating-node-network-config.adoc @@ -22,7 +22,9 @@ For more information, see "Creating a manifest object that includes a customized include::modules/virt-viewing-network-state-of-node.adoc[leveloffset=+1] // Viewing the network state of a node from the web console -include::modules/virt-viewing-network-state-of-node-console.adoc[leveloffset=+1] +include::modules/virt-viewing-graphical-representation-of-network-state-of-node-console.adoc[leveloffset=+1] + +include::modules/virt-viewing-list-of-nodenetworkstate-resources-console.adoc[leveloffset=+1] // The `NodeNetworkConfigurationPolicy` manifest file include::modules/node-network-configuration-policy-file.adoc[leveloffset=+1]