Fixed xrefs that weren't using _{context} and removed xref to removed module

johnwilkins · johnwilkins · commit 7496ae224ec0 · 2021-02-10T13:46:28.000-08:00
diff --git a/_topic_map.yml b/_topic_map.yml
@@ -933,6 +933,18 @@ Topics:
   - Name: Configuring ingress cluster traffic using a NodePort
     File: configuring-ingress-cluster-traffic-nodeport
     Distros: openshift-enterprise,openshift-webscale,openshift-origin
+  # Kubernetes NMState (TECHNOLOGY PREVIEW)
+- Name: Kubernetes NMState
+  Dir: k8s_nmstate
+  Topics:
+  - Name: About the Kubernetes NMState Operator
+    File: k8s-nmstate-about-the-k8s-nmstate-operator
+  - Name: Observing node network state
+    File: k8s-nmstate-observing-node-network-state
+  - Name: Updating node network configuration
+    File: k8s-nmstate-updating-node-network-config
+  - Name: Troubleshooting node network configuration
+    File: k8s-nmstate-troubleshooting-node-network
 - Name: Configuring the cluster-wide proxy
   File: enable-cluster-wide-proxy
   Distros: openshift-enterprise,openshift-webscale,openshift-origin
diff --git a/modules/k8s-nmstate-installing-the-kubernetes-nmstate-operator.adoc b/modules/k8s-nmstate-installing-the-kubernetes-nmstate-operator.adoc
@@ -0,0 +1,40 @@
+// This is included in the following assemblies:
+//
+// networking/k8s_nmstate/k8s-nmstate-about-the-kubernetes-nmstate-operator.adoc
+
+[id="installing-the-kubernetes-nmstate-operator_{context}"]
+
+= Installing the Kubernetes NMState Operator
+
+You must install the Kubernetes NMState Operator from the OpenShift web console while logged in with administrator privileges. Once installed, the Operator can deploy the NMState State Controller as a daemon set across all of the cluster nodes.
+
+.Procedure
+
+. Select *Operators* -> *OperatorHub*.
+
+. In the search field below *All Items*, enter `nmstate` and click *Enter*  to search for the Kubernetes NMState Operator.
+
+. Click on the Kubernetes NMState Operator search result.
+
+. Click on *Install* to open the *Install Operator* window.
+
+. Under *Installed Namespace*, ensure the namespace is `openshift-nmstate`. If `openshift-nmstate` does not exist in the combo box, click on *Create Namespace* and enter `openshift-nmstate` in the *Name* field of the dialog box and press *Create*.
+
+. Click *Install* to install the Operator.
+
+. Once the Operator finishes installing, click *View Operator*.
+
+. Under *Provided APIs*, click *Create Instance* to open the dialog box for creating an instance of `kubernetes-nmstate`.
+
+. In the *Name* field of the dialog box, ensure the name of the instance is `nmstate.`
++
+[NOTE]
+====
+The name restriction is a known issue. The instance is a singleton for the entire cluster.
+====
+
+. Accept the default settings and click *Create* to create the instance.
+
+.Summary
+
+Once complete, the Operator has deployed the NMState State Controller as a daemon set across all of the cluster nodes.
diff --git a/modules/virt-about-nmstate.adoc b/modules/virt-about-nmstate.adoc
@@ -2,6 +2,8 @@
 //
 // * virt/node_network/virt-observing-node-network-state.adoc
 // * virt/node_network/virt-updating-node-network-config.adoc
+// * networking/k8s_nmstate/k8s-nmstate-observing-node-network-state.adoc
+// * networking/k8s_nmstate/k8s-nmstate-updating-node-network-config.adoc 
 
 [id="virt-about-nmstate_{context}"]
 = About nmstate
@@ -11,7 +13,7 @@
 Node networking is monitored and updated by the following objects:
 
 `NodeNetworkState`:: Reports the state of the network on that node.
-`NodeNetworkConfigurationPolicy`:: Describes the requested network configuration on nodes. You update the node network configuration, including adding and removing interfaces, by applying a `NodeNetworkConfigurationPolicy` manifest to the cluster. 
+`NodeNetworkConfigurationPolicy`:: Describes the requested network configuration on nodes. You update the node network configuration, including adding and removing interfaces, by applying a `NodeNetworkConfigurationPolicy` manifest to the cluster.
 `NodeNetworkConfigurationEnactment`:: Reports the network policies enacted upon each node.
 
 {VirtProductName} supports the use of the following nmstate interface types:
diff --git a/modules/virt-confirming-policy-updates-on-nodes.adoc b/modules/virt-confirming-policy-updates-on-nodes.adoc
@@ -1,6 +1,7 @@
 // Module included in the following assemblies:
 //
 // * virt/node_network/virt-configuring-node-network-policy
+// * networking/k8s_nmstate/k8s-nmstate-updating-node-network-config.adoc
 
 [id="virt-confirming-policy-updates-on-nodes_{context}"]
 = Confirming node network policy updates on nodes
diff --git a/modules/virt-creating-interface-on-nodes.adoc b/modules/virt-creating-interface-on-nodes.adoc
@@ -1,6 +1,7 @@
 // Module included in the following assemblies:
 //
 // * virt/node_network/virt-updating-node-network-config.adoc
+// * networking/k8s_nmstate/k8s-nmstate-updating-node-network-config.adoc
 
 [id="virt-creating-interface-on-nodes_{context}"]
 = Creating an interface on nodes
diff --git a/modules/virt-example-bond-nncp.adoc b/modules/virt-example-bond-nncp.adoc
@@ -1,6 +1,7 @@
 // Module included in the following assemblies:
 //
 // * virt/node_network/virt-updating-node-network-config.adoc
+// * networking/k8s_nmstate/k8s-nmstate-updating-node-network-config.adoc
 
 [id="virt-example-bond-nncp_{context}"]
 = Example: Bond interface node network configuration policy
diff --git a/modules/virt-example-bridge-nncp.adoc b/modules/virt-example-bridge-nncp.adoc
@@ -1,6 +1,7 @@
 // Module included in the following assemblies:
 //
 // * virt/node_network/virt-updating-node-network-config.adoc
+// * networking/k8s_nmstate/k8s-nmstate-updating-node-network-config.adoc
 
 [id="virt-example-bridge-nncp_{context}"]
 = Example: Linux bridge interface node network configuration policy
diff --git a/modules/virt-example-ethernet-nncp.adoc b/modules/virt-example-ethernet-nncp.adoc
@@ -1,6 +1,7 @@
 // Module included in the following assemblies:
 //
 // * virt/node_network/virt-updating-node-network-config.adoc
+// * networking/k8s_nmstate/k8s-nmstate-updating-node-network-config.adoc
 
 [id="virt-example-ethernet-nncp_{context}"]
 = Example: Ethernet interface node network configuration policy
diff --git a/modules/virt-example-nmstate-IP-management.adoc b/modules/virt-example-nmstate-IP-management.adoc
@@ -1,13 +1,14 @@
 // Module included in the following assemblies:
 //
 // * virt/node_network/virt-updating-node-network-config.adoc
+// * networking/k8s_nmstate/k8s-nmstate-updating-node-network-config.adoc
 
 [id="virt-example-nmstate-IP-management_{context}"]
 = Examples: IP management
 
-The following example configuration snippets demonstrate different methods of IP management. 
+The following example configuration snippets demonstrate different methods of IP management.
 
-These examples use the `ethernet` interface type to simplify the example while showing the related context in the policy configuration. These IP management examples can be used with the other interface types. 
+These examples use the `ethernet` interface type to simplify the example while showing the related context in the policy configuration. These IP management examples can be used with the other interface types.
 
 [id="virt-example-nmstate-IP-management-static_{context}"]
 == Static
@@ -109,7 +110,7 @@ The following snippet sets DNS configuration on the host.
 [id="virt-example-nmstate-IP-management-static-routing_{context}"]
 == Static routing
 
-The following snippet configures a static route and a static IP on interface `eth1`. 
+The following snippet configures a static route and a static IP on interface `eth1`.
 
 [source,yaml]
 ----
diff --git a/modules/virt-example-nmstate-multiple-interfaces.adoc b/modules/virt-example-nmstate-multiple-interfaces.adoc
@@ -1,6 +1,7 @@
 // Module included in the following assemblies:
 //
 // * virt/node_network/virt-updating-node-network-config.adoc
+// * networking/k8s_nmstate/k8s-nmstate-updating-node-network-config.adoc
 
 [id="virt-example-nmstate-multiple-interfaces_{context}"]
 = Example: Multiple interfaces in the same node network configuration policy
diff --git a/modules/virt-example-vlan-nncp.adoc b/modules/virt-example-vlan-nncp.adoc
@@ -1,12 +1,13 @@
 // Module included in the following assemblies:
 //
 // * virt/node_network/virt-updating-node-network-config.adoc
+// * networking/k8s_nmstate/k8s-nmstate-updating-node-network-config.adoc
 
 [id="virt-example-vlan-nncp_{context}"]
 = Example: VLAN interface node network configuration policy
 
 Create a VLAN interface on nodes in the cluster by applying a `NodeNetworkConfigurationPolicy` manifest
-to the cluster. 
+to the cluster.
 
 The following YAML file is an example of a manifest for a VLAN interface.
 It includes samples values that you must replace with your own information.
@@ -30,12 +31,12 @@ spec:
         base-iface: eth1 <8>
         id: 102 <9>
 ----
-<1> Name of the policy. 
+<1> Name of the policy.
 <2> Optional: If you do not include the `nodeSelector` parameter, the policy applies to all nodes in the cluster.
 <3> This example uses a `hostname` node selector.
 <4> Name of the interface.
 <5> Optional: Human-readable description of the interface.
 <6> The type of interface. This example creates a VLAN.
 <7> The requested state for the interface after creation.
-<8> The node NIC to which the VLAN is attached. 
-<9> The VLAN tag. 
+<8> The node NIC to which the VLAN is attached.
+<9> The VLAN tag.
diff --git a/modules/virt-removing-interface-from-nodes.adoc b/modules/virt-removing-interface-from-nodes.adoc
@@ -1,6 +1,7 @@
 // Module included in the following assemblies:
 //
 // * virt/node_network/virt-updating-node-network-config.adoc
+// * networking/k8s_nmstate/k8s-nmstate-updating-node-network-config.adoc
 
 [id="virt-removing-interface-from-nodes_{context}"]
 = Removing an interface from nodes
diff --git a/modules/virt-troubleshooting-incorrect-policy-config.adoc b/modules/virt-troubleshooting-incorrect-policy-config.adoc
@@ -1,16 +1,17 @@
 // Module included in the following assemblies:
 //
 // * virt/node_network/virt-troubleshooting-node-network.adoc
+// * networking/k8s_nmstate/k8s-nmstate-troubleshooting-node-network.adoc
 
 [id="virt-troubleshooting-incorrect-policy-config_{context}"]
 = Troubleshooting an incorrect node network configuration policy configuration
 
 You can apply changes to the node network configuration across your entire cluster by applying a node network configuration policy.
 If you apply an incorrect configuration, you can use the following example to troubleshoot and correct the failed node network policy.
 
-In this example, a Linux bridge policy is applied to an example cluster that has 3 master nodes and 3 worker nodes.
+In this example, a Linux bridge policy is applied to an example cluster that has three master nodes and three worker nodes.
 The policy fails to be applied because it references an incorrect interface.
-To find the error, investigate the available nmstate resources. You can then update the policy with the correct configuration.
+To find the error, investigate the available NMState resources. You can then update the policy with the correct configuration.
 
 .Procedure
 
diff --git a/modules/virt-viewing-network-state-of-node.adoc b/modules/virt-viewing-network-state-of-node.adoc
@@ -1,11 +1,12 @@
 // Module included in the following assemblies:
 //
 // * virt/node_network/virt-observing-node-network-state.adoc
+// * networking/k8s_nmstate/k8s-observing-node-network-state.adoc
 
 [id="virt-viewing-network-state-of-node_{context}"]
 = Viewing the network state of a node
 
-A `NodeNetworkState` object exists on every node in the cluster. This object is periodically updated and captures the state of the network for that node. 
+A `NodeNetworkState` object exists on every node in the cluster. This object is periodically updated and captures the state of the network for that node.
 
 .Procedure
 
@@ -44,5 +45,4 @@ status:
 ----
 <1> The name of the `NodeNetworkState` object is taken from the node.
 <2> The `currentState` contains the complete network configuration for the node, including DNS, interfaces, and routes.
-<3> Timestamp of the last successful update. This is updated periodically as long as the node is reachable and can be used to evalute the freshness of the report. 
-
+<3> Timestamp of the last successful update. This is updated periodically as long as the node is reachable and can be used to evalute the freshness of the report.
diff --git a/networking/k8s_nmstate/k8s-nmstate-about-the-k8s-nmstate-operator.adoc b/networking/k8s_nmstate/k8s-nmstate-about-the-k8s-nmstate-operator.adoc
@@ -0,0 +1,13 @@
+[id="k8s-nmstate-about-the-k8s-nmstate-operator"]
+= About the Kubernetes NMState Operator
+:FeatureName: Kubernetes NMState Operator
+:context: k8s-nmstate-operator
+toc::[]
+
+The Kubernetes NMState Operator provides a Kubernetes API for performing state-driven network configuration across the {product-title} cluster's nodes with NMState. The Kubernetes NMState Operator provides users with functionality to configure various network interface types, DNS, and routing on cluster nodes. Additionally, the daemons on the cluster nodes periodically report on the state of each node's network interfaces to the API server.
+
+include::modules/technology-preview.adoc[]
+
+Before you can use NMState with {product-title}, you must install the Kubernetes NMState Operator.
+
+include::modules/k8s-nmstate-installing-the-kubernetes-nmstate-operator.adoc[leveloffset=+1]
diff --git a/networking/k8s_nmstate/k8s-nmstate-observing-node-network-state.adoc b/networking/k8s_nmstate/k8s-nmstate-observing-node-network-state.adoc
@@ -0,0 +1,12 @@
+[id="k8s-nmstate-observing-node-network-state"]
+= Observing node network state
+include::modules/virt-document-attributes.adoc[]
+:VirtProductName: OpenShift Container Platform
+:context: k8s-nmstate-observing-node-network-state
+toc::[]
+
+Node network state is the network configuration for all nodes in the cluster.
+
+include::modules/virt-about-nmstate.adoc[leveloffset=+1]
+
+include::modules/virt-viewing-network-state-of-node.adoc[leveloffset=+1]
diff --git a/networking/k8s_nmstate/k8s-nmstate-troubleshooting-node-network.adoc b/networking/k8s_nmstate/k8s-nmstate-troubleshooting-node-network.adoc
@@ -0,0 +1,15 @@
+[id="k8s-nmstate-troubleshooting-node-network"]
+= Troubleshooting node network configuration
+include::modules/virt-document-attributes.adoc[]
+:VirtProductName: OpenShift Container Platform
+:context: k8s-nmstate-troubleshooting-node-network
+toc::[]
+
+If the node network configuration encounters an issue, the policy is automatically rolled back and the enactments report failure.
+This includes issues such as:
+
+* The configuration fails to be applied on the host.
+* The host loses connection to the default gateway.
+* The host loses connection to the API server.
+
+include::modules/virt-troubleshooting-incorrect-policy-config.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
@@ -0,0 +1,37 @@
+[id="k8s-nmstate-updating-node-network-config"]
+= Updating node network configuration
+include::modules/virt-document-attributes.adoc[]
+:VirtProductName: OpenShift Container Platform
+:context: k8s_nmstate-updating-node-network-config
+toc::[]
+
+You can update the node network configuration, such as adding or removing interfaces from nodes, by applying `NodeNetworkConfigurationPolicy` manifests to the cluster.
+
+include::modules/virt-about-nmstate.adoc[leveloffset=+1]
+
+include::modules/virt-creating-interface-on-nodes.adoc[leveloffset=+1]
+
+[discrete]
+== Additional resources
+* xref:virt-example-nmstate-multiple-interfaces_{context}[Example for creating multiple interfaces in the same policy]
+* xref: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-removing-interface-from-nodes.adoc[leveloffset=+1]
+
+[id="virt-nmstate-example-policy-configurations"]
+== Example policy configurations for different interfaces
+
+include::modules/virt-example-bridge-nncp.adoc[leveloffset=+2]
+
+include::modules/virt-example-vlan-nncp.adoc[leveloffset=+2]
+
+include::modules/virt-example-bond-nncp.adoc[leveloffset=+2]
+
+include::modules/virt-example-ethernet-nncp.adoc[leveloffset=+2]
+
+include::modules/virt-example-nmstate-multiple-interfaces.adoc[leveloffset=+2]
+
+// Dropping offset by one again
+include::modules/virt-example-nmstate-IP-management.adoc[leveloffset=+1]
diff --git a/networking/k8s_nmstate/modules b/networking/k8s_nmstate/modules
@@ -0,0 +1 @@
+../../modules/
