Add documentation for virtualised compute hosts

README.rst

@@ -32,6 +32,8 @@ Features
 * Discovery, introspection and provisioning of bare metal compute hosts
   using `OpenStack ironic <https://docs.openstack.org/developer/ironic/>`_ and
   `ironic inspector <https://docs.openstack.org/developer/ironic-inspector/>`_
+* Virtualised compute using `OpenStack nova
+  <https://docs.openstack.org/developer/nova/>`_
 * Containerised workloads on bare metal using `OpenStack magnum
   <https://docs.openstack.org/developer/magnum/>`_
 * Big data on bare metal using `OpenStack sahara
@@ -41,5 +43,3 @@ In the near future we aim to add support for the following:
 
 * Control plane and workload monitoring and log aggregation using `OpenStack
   monasca <https://wiki.openstack.org/wiki/Monasca>`_
-* Virtualised compute using `OpenStack nova
-  <https://docs.openstack.org/developer/nova/>`_

doc/source/architecture.rst

@@ -41,6 +41,9 @@ Network
 Monitoring
     Monitoring host run the control plane and workload monitoring services.
     Currently, kayobe does not deploy any services onto monitoring hosts.
+Virtualised compute hypervisors
+    Virtualised compute hypervisors run the tenant Virtual Machines (VMs) and
+    associated OpenStack services for compute, networking and storage.
 
 Networks
 ========

doc/source/configuration/network.rst

@@ -594,6 +594,20 @@ a list of names of additional networks to attach.  Alternatively, the list may
 be completely overridden by setting ``monitoring_network_interfaces``.  These
 variables are found in ``${KAYOBE_CONFIG_PATH}/monitoring.yml``.
 
+Virtualised Compute Hosts
+-------------------------
+
+By default, virtualised compute hosts are attached to the following networks:
+
+* overcloud provisioning network
+* internal network
+* storage network
+
+This list may be extended by setting ``compute_extra_network_interfaces`` to a
+list of names of additional networks to attach.  Alternatively, the list may be
+completely overridden by setting ``compute_network_interfaces``.  These
+variables are found in ``${KAYOBE_CONFIG_PATH}/compute.yml``.
+
 Other Hosts
 -----------
 

doc/source/release-notes.rst

@@ -24,6 +24,8 @@ Features
   which hosts run the nova compute service for ironic. This may be used to
   avoid the experimental HA nova compute service for ironic, by specifying a
   single host.
+* Adds support for deployment of virtualised compute hosts.  These hosts should
+  be added to the ``[compute]`` group.
 
 Upgrade Notes
 -------------