diff --git a/modules/k8s-nmstate-troubleshooting-dns-disconnected-bind9-dns.adoc b/modules/k8s-nmstate-troubleshooting-dns-disconnected-bind9-dns.adoc index 17fe955ecb..276c3eac15 100644 --- a/modules/k8s-nmstate-troubleshooting-dns-disconnected-bind9-dns.adoc +++ b/modules/k8s-nmstate-troubleshooting-dns-disconnected-bind9-dns.adoc @@ -52,7 +52,6 @@ $ host -t NS root-servers.net. 127.0.0.1 ---- + .Example output -+ [source,terminal] ---- Using domain server: diff --git a/modules/k8s-nmstate-troubleshooting-dns-disconnected-env-dnsmasq.adoc b/modules/k8s-nmstate-troubleshooting-dns-disconnected-env-dnsmasq.adoc index 459f2a8dce..786fd34843 100644 --- a/modules/k8s-nmstate-troubleshooting-dns-disconnected-env-dnsmasq.adoc +++ b/modules/k8s-nmstate-troubleshooting-dns-disconnected-env-dnsmasq.adoc @@ -33,7 +33,6 @@ $ journalctl -u dnsmasq|grep root-servers.net ---- + .Example output -+ [source,terminal] ---- Jul 03 15:31:25 rhel-8-10 dnsmasq[1342]: using nameserver 192.168.1.1#53 for domain root-servers.net @@ -47,7 +46,6 @@ $ host -t NS root-servers.net. 127.0.0.1 ---- + .Example output -+ [source,terminal] ---- Using domain server: diff --git a/modules/node-network-configuration-policy-file.adoc b/modules/node-network-configuration-policy-file.adoc index 02b8795bbb..b804100af5 100644 --- a/modules/node-network-configuration-policy-file.adoc +++ b/modules/node-network-configuration-policy-file.adoc @@ -4,9 +4,10 @@ :_mod-docs-content-type: CONCEPT [id="node-network-configuration-policy-file_{context}"] -= The NodeNetworkConfigurationPolicy manifest file += About the NodeNetworkConfigurationPolicy manifest file -A `NodeNetworkConfigurationPolicy` (NNCP) manifest file defines policies that the Kubernetes NMState Operator uses to configure networking for nodes that exist in an {product-title} cluster. +[role="_abstract"] +A `NodeNetworkConfigurationPolicy` manifest file defines policies that the Kubernetes NMState Operator uses to configure networking for nodes in your {product-title} cluster. You can create, edit, and delete these policies to manage node network configurations. [IMPORTANT] ==== diff --git a/modules/virt-example-dynamic-matching-templating.adoc b/modules/virt-example-dynamic-matching-templating.adoc new file mode 100644 index 0000000000..ff9d67ff2d --- /dev/null +++ b/modules/virt-example-dynamic-matching-templating.adoc @@ -0,0 +1,16 @@ +// Module included in the following assemblies: +// +// * networking/k8s_nmstate/k8s-observing-node-network-state.adoc + +:_mod-docs-content-type: CONCEPT +[id="virt-example-dynamic-matching-templating_{context}"] += Example policy configurations that use dynamic matching and templating + +[role="_abstract"] +The following example configuration snippets show node network policies that use dynamic matching and templating. + +ifdef::openshift-enterprise[] +:FeatureName: Applying node network configuration policies that use dynamic matching and templating +include::snippets/technology-preview.adoc[leveloffset=+2] + +endif::[] \ No newline at end of file diff --git a/modules/virt-manage-nncp-cli.adoc b/modules/virt-manage-nncp-cli.adoc new file mode 100644 index 0000000000..ab187bd8f9 --- /dev/null +++ b/modules/virt-manage-nncp-cli.adoc @@ -0,0 +1,10 @@ +// Module included in the following assemblies: +// +// * networking/k8s_nmstate/k8s-observing-node-network-state.adoc + +:_mod-docs-content-type: CONCEPT +[id="virt-manage-nncp-cli_{context}"] += Managing the NodeNetworkConfigurationPolicy manifest file + +[role="_abstract"] +To configure network interfaces on nodes in your {product-title} cluster, you can manage the `NodeNetworkConfigurationPolicy` manifest file by using the CLI. \ No newline at end of file diff --git a/modules/virt-updating-node-network-configuration-policy-file.adoc b/modules/virt-updating-node-network-configuration-policy-file.adoc new file mode 100644 index 0000000000..187d0d7fda --- /dev/null +++ b/modules/virt-updating-node-network-configuration-policy-file.adoc @@ -0,0 +1,10 @@ +// Module included in the following assemblies: +// +// * networking/k8s_nmstate/k8s-observing-node-network-state.adoc + +:_mod-docs-content-type: CONCEPT +[id="virt-updating-policy-k8s-nmstate_{context}"] += Updating the NodeNetworkConfigurationPolicy manifest file + +[role="_abstract"] +To modify the network configuration for nodes in your {product-title} cluster, you can update the `NodeNetworkConfigurationPolicy` manifest file. 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 01743e889a..dfa9c57c7e 100644 --- a/networking/k8s_nmstate/k8s-nmstate-updating-node-network-config.adoc +++ b/networking/k8s_nmstate/k8s-nmstate-updating-node-network-config.adoc @@ -7,7 +7,8 @@ include::_attributes/common-attributes.adoc[] toc::[] -After you install the Kubernetes NMState Operator, you can use the Operator to observe and update the node network state and network configuration of the cluster. +[role="_abstract"] +To observe and update the node network state and configuration in your cluster, you can use the Kubernetes NMState Operator. You can view network states, create and manage network configuration policies, and configure interfaces on cluster nodes. For more information about how to install the NMState Operator, see xref:../../networking/networking_operators/k8s-nmstate-about-the-k8s-nmstate-operator.adoc#k8s-nmstate-about-the-k8s-nmstate-operator[Kubernetes NMState Operator]. @@ -29,9 +30,8 @@ include::modules/virt-viewing-list-of-nodenetworkstate-resources-console.adoc[le // The `NodeNetworkConfigurationPolicy` manifest file include::modules/node-network-configuration-policy-file.adoc[leveloffset=+1] +.Additional resources -[role="_additional-resources"] -== Additional resources * xref:../../networking/k8s_nmstate/k8s-nmstate-updating-node-network-config.adoc#virt-nmstate-example-policy-configurations_{context}[Example policy configurations for different interfaces] * xref:../../networking/k8s_nmstate/k8s-nmstate-updating-node-network-config.adoc#virt-removing-interface-from-nodes_{context}[Removing an interface from nodes] @@ -45,7 +45,8 @@ include::modules/virt-monitor-node-network-config-console.adoc[leveloffset=+2] // Creating a policy include::modules/virt-create-node-network-config-console.adoc[leveloffset=+2] -== Updating the policy + +include::modules/virt-updating-node-network-configuration-policy-file.adoc[leveloffset=+1] // Updating the policy by using form include::modules/virt-update-node-network-config-form.adoc[leveloffset=+2] @@ -56,15 +57,13 @@ include::modules/virt-update-node-network-config-yaml.adoc[leveloffset=+2] // Deleting the policy include::modules/virt-delete-node-network-config.adoc[leveloffset=+2] -[id="virt-manage-nncp-cli"] -== Managing policy by using the CLI +include::modules/virt-manage-nncp-cli.adoc[leveloffset=+1] //Creating an interface on nodes include::modules/virt-creating-interface-on-nodes.adoc[leveloffset=+2] +.Additional resources -[role="_additional-resources"] -== Additional resources * 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] @@ -86,8 +85,8 @@ include::modules/virt-example-bridge-nncp.adoc[leveloffset=+2] // Example: VLAN interface node network configuration policy include::modules/virt-example-vlan-nncp.adoc[leveloffset=+2] -[role="_additional-resources"] .Additional resources + * xref:../../networking/hardware_networks/configuring-sriov-device.adoc#configuring-sriov-device[Configuring an SR-IOV network device] * xref:../../networking/hardware_networks/configuring-hardware-offloading.adoc#configuring-hardware-offloading[Configuring hardware offloading] @@ -104,7 +103,6 @@ include::modules/virt-example-vf-host-services.adoc[leveloffset=+2] // Example: Network interface with a VRF instance node network configuration policy include::modules/virt-example-host-vrf.adoc[leveloffset=+2] -[role="_additional-resources"] .Additional resources * xref:../../networking/multiple_networks/about-virtual-routing-and-forwarding.adoc#cnf-about-virtual-routing-and-forwarding_about-virtual-routing-and-forwarding[About virtual routing and forwarding] @@ -113,16 +111,7 @@ include::modules/virt-example-host-vrf.adoc[leveloffset=+2] // Creating an InfiniBand interface on nodes include::modules/virt-creating-infiniband-interface-on-nodes.adoc[leveloffset=+1] -[id="capturing-nic-static-ip_k8s-nmstate-updating-node-network-config"] -== Example policy configurations that use dynamic matching and templating - -The following example configuration snippets show node network policies that use dynamic matching and templating. - -ifdef::openshift-enterprise[] -:FeatureName: Applying node network configuration policies that use dynamic matching and templating -include::snippets/technology-preview.adoc[leveloffset=+2] - -endif::[] +include::modules/virt-example-dynamic-matching-templating.adoc[leveloffset=+1] // Example: Linux bridge interface node network configuration policy to inherit static IP address from the NIC attached to the bridge include::modules/virt-example-inherit-static-ip-from-nic.adoc[leveloffset=+2] @@ -130,8 +119,9 @@ include::modules/virt-example-inherit-static-ip-from-nic.adoc[leveloffset=+2] //Example: LLDP policy include::modules/virt-example-enabling-lldp-policy.adoc[leveloffset=+2] -[role="_additional-resources"] + .Additional resources + * link:https://nmstate.io/nmpolicy/user-guide/102-policy-syntax.html[The NMPolicy project - Policy syntax] // Examples: IP management @@ -140,7 +130,6 @@ include::modules/virt-example-nmstate-IP-management.adoc[leveloffset=+1] // Routes and route tables include::modules/virt-routes-route-rules.adoc[leveloffset=+1] -[role="_additional-resources"] .Additional resources * xref:../../installing/installing_bare_metal/ipi/ipi-install-installation-workflow.adoc#creating-manifest-file-customized-br-ex-bridge_ipi-install-installation-workflow[Creating a manifest object that includes a customized br-ex bridge (Installer-provisioned infrastructure)]