Merge pull request #903 from slagle/docs-updates

Document minor updates

docs/assemblies/creating-the-data-plane.adoc

@@ -64,3 +64,5 @@ include::hashes.adoc[leveloffset=+1]
 include::ipam.adoc[leveloffset=+1]
 
 include::hotfixing-the-data-plane.adoc[leveloffset=+1]
+
+include::updating-the-data-plane.adoc[leveloffset=+1]

docs/assemblies/proc_updating-the-data-plane-ovn.adoc

@@ -0,0 +1,68 @@
+[id="proc_updating-the-data-plane-ovn-{context}"]
+= Updating OVN on the data plane
+
+[role="_abstract"]
+
+You update OVN content (containers) on the data plane once OVN on the control
+plane has been updated.
+
+.Procedure
+
+. Validate that OVN has been updated on the control plane.
++
+----
+$ oc wait openstackversion <openstack_ctlplane_name> --for=condition=OpenStackVersionMinorUpdateOVNControlplane
+----
++
+* Replace `<openstack_ctlplane_name>` with the name of the OpenStack control plane resource.
++
+The following example output shows the condition has been met:
++
+----
+openstackversion.core.openstack.org/openstack-galera-network-isolation condition met
+----
+
+. Create an `OpenStackDataPlaneDeployment` CR and save it to a file named `openstack-edpm-update.yaml` on your workstation.
++
+----
+apiVersion: dataplane.openstack.org/v1beta1
+kind: OpenStackDataPlaneDeployment
+metadata:
+  name: edpm-deployment-ipam-update
+spec:
+  nodeSets:
+    - openstack-edpm-ipam
+    - <nodeSet_name>
+    - ...
+    - <nodeSet_name>
+  servicesOverride:
+    - ovn
+----
++
+* Replace `<nodeSet_name>` with the names of the `OpenStackDataPlaneNodeSet` CRs that you want to include in your data plane minor update.
++
+[NOTE]
+The `servicesOverride` field is set to include only `ovn` as the `ovn` service must be updated first in isolation. If using a custom service to manage `ovn`, then use that custom service name instead of `ovn` in `servicesOverride`. Additionally if other custom services must be updated at the same time as `ovn`, then they can be included in `servicesOverride` as well.
+
+. Save the `openstack-edpm-update.yaml` deployment file.
+
+. Update the data plane:
++
+----
+$ oc create -f openstack-edpm-update.yaml
+----
+
+. Verify that the data plane update deployment succeeded:
++
+----
+$ oc get openstackdataplanedeployment
+NAME             			STATUS   MESSAGE
+edpm-deployment-ipam   		True     Setup Complete
+edpm-deployment-ipam-update True     Setup Complete
+----
+
+Once OVN has been updated on the data plane, the rest of the control plane minor update will automatically proceed. Once the control plane minor update is finished, the rest of the data plane can be updated.
+
+.Troubleshooting
+
+See <<proc_troubleshooting-data-plane-creation-and-deployment_{context}>> for troubleshooting any deployment failures.

docs/assemblies/proc_updating-the-data-plane.adoc

@@ -0,0 +1,66 @@
+[id="proc_updating-the-data-plane-{context}"]
+= Updating other services on the data plane
+
+[role="_abstract"]
+
+Once OVN has been updated on the control plane and data plane, and the rest of the control plane has completed updating, you update the rest of the services on the data plane.
+
+.Procedure
+
+. Validate that the rest of the minor update has completed on the control plane.
++
+----
+$ oc wait openstackversion <openstack_ctlplane_name> --for=condition=OpenStackVersionMinorUpdateControlplane
+----
++
+* Replace `<openstack_ctlplane_name>` with the name of the OpenStack control plane resource.
++
+The following example output shows the condition has been met:
++
+----
+openstackversion.core.openstack.org/openstack-galera-network-isolation condition met
+----
+
+. Create an `OpenStackDataPlaneDeployment` CR and save it to a file named `openstack-edpm-update-services.yaml` on your workstation.
++
+----
+apiVersion: dataplane.openstack.org/v1beta1
+kind: OpenStackDataPlaneDeployment
+metadata:
+  name: edpm-deployment-ipam-update-services
+spec:
+  nodeSets:
+    - openstack-edpm-ipam
+    - <nodeSet_name>
+    - ...
+    - <nodeSet_name>
+  servicesOverride:
+    - update
+----
++
+* Replace `<nodeSet_name>` with the names of the `OpenStackDataPlaneNodeSet` CRs that you want to include in your data plane minor update.
++
+[NOTE]
+The `servicesOverride` field is set to include only `update`. The `update` service applies only the tasks needed to update the packages and containers on the EDPM nodes. When using custom services, include those here as well, or their equivalent custom services that apply the needed update tasks.
+
+. Save the `openstack-edpm-update-services.yaml` deployment file.
+
+. Update the data plane:
++
+----
+$ oc create -f openstack-edpm-update-services.yaml
+----
+
+. Verify that the data plane update deployment succeeded:
++
+----
+$ oc get openstackdataplanedeployment
+NAME             						STATUS   MESSAGE
+edpm-deployment-ipam   					True     Setup Complete
+edpm-deployment-ipam-update 			True     Setup Complete
+edpm-deployment-ipam-update-services 	True     Setup Complete
+----
+
+.Troubleshooting
+
+See <<proc_troubleshooting-data-plane-creation-and-deployment_{context}>> for troubleshooting any deployment failures.

docs/assemblies/updating-the-data-plane.adoc

@@ -0,0 +1,23 @@
+[id="assembly_updating-the-data-plane"]
+= Updating the data plane
+
+:context: dataplane
+
+[role="_abstract"]
+You can perform a minor update of your OpenStack data plane environment to keep
+it updated with the latest packages and containers.
+
+You must coordinate the minor update of the OpenStack data plane environment
+with a minor update of the control plane. OVN containers on the data plane
+nodes should not be updated until OVN containers on the control plane have been
+updated.
+
+See
+https://github.com/openstack-k8s-operators/dev-docs/blob/main/version_updates.md[OpenStackVersion]
+and
+https://github.com/openstack-k8s-operators/dev-docs/blob/main/ovs-update.md[Open
+vSwitch update] for more information.
+
+include::proc_updating-the-data-plane-ovn.adoc[leveloffset=+1]
+
+include::proc_updating-the-data-plane.adoc[leveloffset=+1]