From d2e3f6f1aec2c1ed301144ed26872394799346fb Mon Sep 17 00:00:00 2001
From: Mark Goddard <mark@stackhpc.com>
Date: Tue, 25 May 2021 17:14:06 +0100
Subject: [PATCH] docs: improve automated seed development info
* add 'bridge_type: linuxbridge' to tenks configuration to avoid
dependency on OVS
* extend seed development environment testing to include overcloud
provisioning and deployment
* remove seed hypervisor and seed VM environments. These are very
stale, and largely replaced by a-universe-from-nothing. Add a link to
that workshop on the same page
Change-Id: I9928e5912e6770bdcc1d5d0884d2f101c16ee6a9
---
dev/tenks-deploy-config-overcloud.yml | 2 +
doc/source/contributor/automated.rst | 138 ++++----------------------
2 files changed, 24 insertions(+), 116 deletions(-)
diff --git a/dev/tenks-deploy-config-overcloud.yml b/dev/tenks-deploy-config-overcloud.yml
index 8896483c..7d54961d 100644
--- a/dev/tenks-deploy-config-overcloud.yml
+++ b/dev/tenks-deploy-config-overcloud.yml
@@ -32,6 +32,8 @@ nova_flavors: []
physnet_mappings:
physnet1: breth1
+bridge_type: linuxbridge
+
# No placement service.
wait_for_placement: false
diff --git a/doc/source/contributor/automated.rst b/doc/source/contributor/automated.rst
index e26d3adc..5e245581 100644
--- a/doc/source/contributor/automated.rst
+++ b/doc/source/contributor/automated.rst
@@ -28,11 +28,13 @@ The following development environments are supported:
* Overcloud (single OpenStack controller)
* Seed
-* Seed hypervisor
-* Seed VM
-The seed VM environment may be used in an environment already deployed as a
-seed hypervisor.
+The `Universe from Nothing
+<https://github.com/stackhpc/a-universe-from-nothing/>`_ workshop may be of use
+for more advanced testing scenarios involving a seed hypervisor, seed VM, and
+separate control and compute nodes.
+
+.. _contributor-automated-overcloud:
Overcloud
=========
@@ -184,8 +186,7 @@ Seed
====
These instructions cover deploying the seed services directly rather than in a
-VM. See :ref:`contributor-automated-seed-vm` for instructions covering
-deployment of the seed services in a VM.
+VM.
Preparation
-----------
@@ -246,6 +247,9 @@ The seed services may be tested using the `Tenks
<https://tenks.readthedocs.io/en/latest/>`__ project to create fake bare metal
nodes.
+If your seed has a non-standard MTU, you should set it via ``aio_mtu`` in
+``etc/kayobe/networks.yml``.
+
Clone the tenks repository::
git clone https://opendev.org/openstack/tenks.git
@@ -265,121 +269,23 @@ Verify that VirtualBMC is running::
~/tenks-venv/bin/vbmc list
-The machines and networking created by Tenks can be cleaned up via
-``dev/tenks-teardown-overcloud.sh``::
-
- ./dev/tenks-teardown-overcloud.sh ./tenks
-
-.. _contributor-automated-seed-hypervisor:
-
-Seed Hypervisor
-===============
-
-The seed hypervisor development environment is supported for CentOS 8. The
-system must be either bare metal, or a VM on a system with nested
-virtualisation enabled.
-
-Preparation
------------
-
-The following commands should be executed on the seed hypervisor.
-
-Clone the Kayobe repository::
-
- git clone https://opendev.org/openstack/kayobe.git
-
-Change the current directory to the Kayobe repository::
-
- cd kayobe
-
-Clone the ``add-seed-and-hv`` branch of the ``kayobe-config-dev`` repository to
-``config/src/kayobe-config``::
-
- mkdir -p config/src
- git clone https://github.com/markgoddard/dev-kayobe-config -b add-seed-and-hv config/src/kayobe-config
-
-Inspect the Kayobe configuration and make any changes necessary for your
-environment.
-
-Usage
------
-
-Run the ``dev/install-dev.sh`` script to install Kayobe and its dependencies in a
-Python virtual environment::
-
- ./dev/install-dev.sh
-
-.. note::
-
- This will create an :ref:`editable install <installation-editable>`.
- It is also possible to install Kayobe in a non-editable way, such that
- changes will not been seen until you reinstall the package. To do this you
- can run ``./dev/install.sh``.
-
-Run the ``dev/seed-hypervisor-deploy.sh`` script to deploy the seed
-hypervisor::
-
- ./dev/seed-hypervisor-deploy.sh
-
-Upon successful completion of this script, the seed hypervisor will be active.
+It is now possible to discover, inspect and provision the controller VM::
-.. _contributor-automated-seed-vm:
+ source dev/environment-setup.sh
+ kayobe overcloud inventory discover
+ kayobe overcloud hardware inspect
+ kayobe overcloud provision
-Seed VM
-=======
+The controller VM is now accessible via SSH as the bootstrap user (``centos``
+or ``ubuntu``) at ``192.168.33.3``.
-The seed VM should be deployed on a system configured as a libvirt/KVM
-hypervisor, using :ref:`contributor-automated-seed-hypervisor` or otherwise.
-
-Preparation
------------
-
-The following commands should be executed on the seed hypervisor.
-
-Clone the Kayobe repository::
-
- git clone https://opendev.org/openstack/kayobe.git
-
-Change to the ``kayobe`` directory::
-
- cd kayobe
-
-Clone the ``add-seed-and-hv`` branch of the ``kayobe-config-dev`` repository to
-``config/src/kayobe-config``::
-
- mkdir -p config/src
- git clone https://github.com/markgoddard/dev-kayobe-config -b add-seed-and-hv config/src/kayobe-config
-
-Inspect the Kayobe configuration and make any changes necessary for your
-environment.
-
-If using Ubuntu, configure the OS distribution::
-
- sed -i -e 's/#os_distribution:/os_distribution: ubuntu/' config/src/kayobe-config/etc/kayobe/globals.yml
-
-Usage
------
-
-Run the ``dev/install-dev.sh`` script to install Kayobe and its dependencies in a
-Python virtual environment::
-
- ./dev/install-dev.sh
-
-.. note::
-
- This will create an :ref:`editable install <installation-editable>`.
- It is also possible to install Kayobe in a non-editable way, such that
- changes will not been seen until you reinstall the package. To do this you
- can run ``./dev/install.sh``.
-
-Run the ``dev/seed-deploy.sh`` script to deploy the seed VM::
-
- ./dev/seed-deploy.sh
+The machines and networking created by Tenks can be cleaned up via
+``dev/tenks-teardown-overcloud.sh``::
-Upon successful completion of this script, the seed VM will be active. The
-seed VM may be accessed via SSH as the ``stack`` user::
+ ./dev/tenks-teardown-overcloud.sh ./tenks
- ssh stack@192.168.33.5
+Upgrading
+---------
It is possible to test an upgrade by running the ``dev/seed-upgrade.sh``
script::
--
GitLab