Refactor to use Beokay

Beokay is a tool for creating production kayobe environments. It
provides a clear source tree with a simple python script.

This change primarily moves the source code and python virtual
environments into a new ~/deployment directory, and separates each
source code directory (Kayobe, Kayobe-Config, Kolla-Ansible, Tenks).

Author: Alex-Welsh

README.rst

@@ -105,24 +105,19 @@ already logged in (e.g. ``ssh rocky@<ip>``, or ``ssh ubuntu@<ip>``).
    # Start at home.
    cd
 
-   # Clone Kayobe.
-   git clone https://opendev.org/openstack/kayobe.git -b stable/2023.1
-   cd kayobe
+   # Clone Beokay.
+   git clone https://github.com/stackhpc/beokay.git -b master
 
-   # Clone the Tenks repository.
-   git clone https://opendev.org/openstack/tenks.git
+   # Use Beokay to bootstrap your control host.
+   [[ -d deployment ]] || beokay/beokay.py create --base-path ~/deployment --kayobe-repo https://opendev.org/openstack/kayobe.git --kayobe-branch stable/2023.1 --kayobe-config-repo https://github.com/stackhpc/a-universe-from-nothing.git --kayobe-config-branch stable/2023.1
 
-   # Clone this Kayobe configuration.
-   mkdir -p config/src
-   cd config/src/
-   git clone https://github.com/stackhpc/a-universe-from-nothing.git kayobe-config -b stable/2023.1
+   # Clone the Tenks repository.
+   cd ~/deployment/src
+   [[ -d tenks ]] || git clone https://opendev.org/openstack/tenks.git
+   cd
 
    # Configure host networking (bridge, routes & firewall)
-   ./kayobe-config/configure-local-networking.sh
-
-   # Install kayobe.
-   cd ~/kayobe
-   ./dev/install-dev.sh
+   ~/deployment/src/kayobe-config/configure-local-networking.sh
 
 Deploying a Seed
 ----------------
@@ -134,14 +129,9 @@ performed the necessary `Preparation`_.
 
 .. code-block:: console
 
-   cd ~/kayobe
-
-   # Activate the Kayobe environment, to allow running commands directly.
-   source ~/kayobe-venv/bin/activate
-   source config/src/kayobe-config/kayobe-env
-
-   # Bootstrap the Ansible control host.
-   kayobe control host bootstrap
+   # If you have not done so already, activate the Kayobe environment, to allow
+   # running commands directly.
+   source ~/deployment/env-vars.sh
 
    # Configure the seed hypervisor host.
    kayobe seed hypervisor host configure
@@ -153,14 +143,14 @@ performed the necessary `Preparation`_.
    kayobe seed host configure
 
    # Pull, retag images, then push to our local registry.
-   ./config/src/kayobe-config/pull-retag-push-images.sh
+   ~/deployment/src/kayobe-config/pull-retag-push-images.sh
 
    # Deploy the seed services.
    kayobe seed service deploy
 
    # Deploying the seed restarts networking interface,
    # run configure-local-networking.sh again to re-add routes.
-   ./config/src/kayobe-config/configure-local-networking.sh
+   ~/deployment/src/kayobe-config/configure-local-networking.sh
 
    # Optional: Shutdown the seed VM if creating a seed snapshot.
    sudo virsh shutdown seed
@@ -192,11 +182,8 @@ Otherwise, continue working with the instance from `Deploying a Seed`_.
    # Optional: start a new tmux session in case we lose our connection.
    tmux
 
-   # Set working directory
-   cd ~/kayobe
-
    # Configure non-persistent networking, if the node has rebooted.
-   ./config/src/kayobe-config/configure-local-networking.sh
+   ~/deployment/src/kayobe-config/configure-local-networking.sh
 
 Make sure that the seed VM (running Bifrost and supporting services)
 is present and running.
@@ -215,12 +202,16 @@ our model development environment, alongside the seed VM.
 
 .. code-block:: console
 
-   # NOTE: Make sure to use ./tenks, since just ‘tenks’ will install via PyPI.
-   export TENKS_CONFIG_PATH=config/src/kayobe-config/tenks.yml
-   ./dev/tenks-deploy-overcloud.sh ./tenks
+   # Set Environment variables for Kayobe dev scripts
+   export KAYOBE_CONFIG_SOURCE_PATH=~/deployment/src/kayobe-config
+   export KAYOBE_VENV_PATH=~/deployment/venvs/kayobe
+   export TENKS_CONFIG_PATH=~/deployment/src/kayobe-config/tenks.yml
+
+   # Use tenks to deploy the overcloud machines
+   ~/deployment/src/kayobe/dev/tenks-deploy-overcloud.sh ~/deployment/src/tenks
 
    # Activate the Kayobe environment, to allow running commands directly.
-   source dev/environment-setup.sh
+   source ~/deployment/env-vars.sh
 
    # Inspect and provision the overcloud hardware:
    kayobe overcloud inventory discover
@@ -236,7 +227,7 @@ Configure and deploy OpenStack to the control plane
    kayobe overcloud host configure
    kayobe overcloud container image pull
    kayobe overcloud service deploy
-   source config/src/kayobe-config/etc/kolla/public-openrc.sh
+   source ~/deployment/src/kayobe-config/etc/kolla/public-openrc.sh
    kayobe overcloud post configure
 
 At this point it should be possible to access the Horizon GUI via the
@@ -250,15 +241,15 @@ VM:
 
 .. code-block:: console
 
-   source config/src/kayobe-config/etc/kolla/public-openrc.sh
-   ./config/src/kayobe-config/init-runonce.sh
+   source ~/deployment/src/kayobe-config/etc/kolla/public-openrc.sh
+   ~/deployment/src/kayobe-config/init-runonce.sh
 
 Following the instructions displayed by the above script, boot a VM.
-You'll need to have activated the `~/os-venv` virtual environment.
+You'll need to have activated the `~/deployment/venvs/os-venv` virtual environment.
 
 .. code-block:: console
 
-   source ~/os-venv/bin/activate
+   source ~/deployment/venvs/os-venv/bin/activate
    openstack server create --image cirros \
              --flavor m1.tiny \
              --key-name mykey \
@@ -274,7 +265,7 @@ You'll need to have activated the `~/os-venv` virtual environment.
 
    # If the ssh command above fails you may need to reconfigure the local
    networking setup again:
-   ~/kayobe/config/src/kayobe-config/configure-local-networking.sh
+   ~/deployment/src/kayobe-config/configure-local-networking.sh
 
 *Note*: when accessing the VNC console of an instance via Horizon,
 you will be sent to the internal IP address of the controller,
@@ -386,7 +377,7 @@ all OpenStack service logging. **Be cautious as OpenSearch will consume a
 significant portion of available resources on a standard deployment.**
 
 To enable the service, one flag must be changed in
-``~/kayobe/config/src/kayobe-config/etc/kayobe/kolla.yml``:
+``~/deployment/src/kayobe-config/etc/kayobe/kolla.yml``:
 
 .. code-block:: diff
 
@@ -402,7 +393,7 @@ the seed VM. Pull, retag and push the centralised logging images:
 
 .. code-block:: console
 
-   ~/kayobe/config/src/kayobe-config/pull-retag-push-images.sh ^opensearch
+   ~/deployment/src/kayobe-config/pull-retag-push-images.sh ^opensearch
 
 To deploy the logging stack:
 
@@ -434,7 +425,7 @@ public interface to the OpenSearch Dashboards service running on our
 ``controller0`` VM.
 
 The easiest way to do this is to add OpenSearch Dashboards's default port (5601) to our
-``configure-local-networking.sh`` script in ``~/kayobe/config/src/kayobe-config/``:
+``configure-local-networking.sh`` script in ``~/deployment/src/kayobe-config/``:
 
 .. code-block:: diff
 
@@ -451,7 +442,7 @@ Then rerun the script to apply the change:
 
 .. code-block:: console
 
-    config/src/kayobe-config/configure-local-networking.sh
+    ~/deployment/src/kayobe-config/configure-local-networking.sh
 
 We can now connect to OpenSearch Dashboards using our hypervisor host public IP and port 5601.
 
@@ -461,7 +452,7 @@ but they are not here).
 
 .. code-block:: console
 
-   grep opensearch_dashboards config/src/kayobe-config/etc/kolla/passwords.yml
+   grep opensearch_dashboards ~/deployment/src/kayobe-config/etc/kolla/passwords.yml
 
 Once you're in, OpenSearch Dashboards needs some further setup which is not automated.
 Set the log index to ``flog-*`` and you should be ready to go.
@@ -474,7 +465,7 @@ secret management service. It is an example of a simple service we
 can use to illustrate the process of adding new services to our deployment.
 
 As with the Logging service above, enable Barbican by modifying the flag in
-``~/kayobe/config/src/kayobe-config/etc/kayobe/kolla.yml`` as follows:
+``~/deployment/src/kayobe-config/etc/kayobe/kolla.yml`` as follows:
 
 .. code-block:: diff
 
@@ -486,15 +477,14 @@ containers. Pull down barbican images:
 
 .. code-block:: console
 
-   ~/kayobe/config/src/kayobe-config/pull-retag-push-images.sh barbican
+   ~/deployment/src/kayobe-config/pull-retag-push-images.sh barbican
 
 To deploy the Barbican service:
 
 .. code-block:: console
 
     # Activate the venv if not already active
-    cd ~/kayobe
-    source dev/environment-setup.sh
+    source ~/deployment/env-vars.sh
 
     kayobe overcloud container image pull
     kayobe overcloud service deploy
@@ -509,13 +499,13 @@ OpenStack venv:
     deactivate
 
     # Activate the OpenStack venv
-    . ~/os-venv/bin/activate
+    ~/deployment/venvs/os-venv/bin/activate
 
     # Install barbicanclient
     pip install python-barbicanclient -c https://releases.openstack.org/constraints/upper/2023.1
 
     # Source the OpenStack environment variables
-    source ~/kayobe/config/src/kayobe-config/etc/kolla/public-openrc.sh
+    source ~/deployment/src/kayobe-config/etc/kolla/public-openrc.sh
 
     # Store a test secret
     openstack secret store --name mysecret --payload foo=bar

a-universe-from-nothing.sh

@@ -28,34 +28,21 @@ echo 'Defaults	!fqdn' | sudo tee /etc/sudoers.d/no-fqdn
 # Start at home.
 cd
 
-# Clone Kayobe.
-[[ -d kayobe ]] || git clone https://opendev.org/openstack/kayobe.git -b master
-cd kayobe
+# Clone Beokay.
+[[ -d beokay ]] || git clone https://github.com/stackhpc/beokay.git -b master
+
+# Use Beokay to bootstrap your control host.
+[[ -d deployment ]] || beokay/beokay.py create --base-path ~/deployment --kayobe-repo https://opendev.org/openstack/kayobe.git --kayobe-branch stable/2023.1 --kayobe-config-repo https://github.com/stackhpc/a-universe-from-nothing.git --kayobe-config-branch stable/2023.1
 
 # Clone the Tenks repository.
+cd ~/deployment/src
 [[ -d tenks ]] || git clone https://opendev.org/openstack/tenks.git
 
-# Clone this Kayobe configuration.
-mkdir -p config/src
-cd config/src/
-[[ -d kayobe-config ]] || git clone https://github.com/stackhpc/a-universe-from-nothing.git -b master kayobe-config
-
 # Configure host networking (bridge, routes & firewall)
 ./kayobe-config/configure-local-networking.sh
 
-# Install kayobe.
-cd ~/kayobe
-./dev/install-dev.sh
-
-# Activate the Kayobe environment, to allow running commands directly.
-# NOTE: Virtualenv's activate script references an unbound variable.
-set +u
-source ~/kayobe-venv/bin/activate
-set -u
-source config/src/kayobe-config/kayobe-env
-
-# Bootstrap the Ansible control host.
-kayobe control host bootstrap
+# Use the kayobe virtual environment, and export kayobe environment variables
+source ~/deployment/env-vars.sh
 
 # Configure the seed hypervisor host.
 kayobe seed hypervisor host configure
@@ -67,18 +54,22 @@ kayobe seed vm provision
 kayobe seed host configure
 
 # Pull, retag images, then push to our local registry.
-./config/src/kayobe-config/pull-retag-push-images.sh
+~/deployment/src/kayobe-config/pull-retag-push-images.sh
 
 # Deploy the seed services.
 kayobe seed service deploy
 
 # Deploying the seed restarts networking interface,
 # run configure-local-networking.sh again to re-add routes.
-./config/src/kayobe-config/configure-local-networking.sh
+~/deployment/src/kayobe-config/configure-local-networking.sh
+
+# Set Environment variables for Kayobe dev scripts
+export KAYOBE_CONFIG_SOURCE_PATH=~/deployment/src/kayobe-config
+export KAYOBE_VENV_PATH=~/deployment/venvs/kayobe
+export TENKS_CONFIG_PATH=~/deployment/src/kayobe-config/tenks.yml
 
-# NOTE: Make sure to use ./tenks, since just ‘tenks’ will install via PyPI.
-export TENKS_CONFIG_PATH=config/src/kayobe-config/tenks.yml
-./dev/tenks-deploy-overcloud.sh ./tenks
+# Deploy overcloud using Tenks
+~/deployment/src/kayobe/dev/tenks-deploy-overcloud.sh ~/deployment/src/tenks
 
 # Inspect and provision the overcloud hardware:
 kayobe overcloud inventory discover
@@ -88,7 +79,7 @@ kayobe overcloud provision
 kayobe overcloud host configure
 kayobe overcloud container image pull
 kayobe overcloud service deploy
-source config/src/kayobe-config/etc/kolla/public-openrc.sh
+source ~/deployment/src/kayobe-config/etc/kolla/public-openrc.sh
 kayobe overcloud post configure
-source config/src/kayobe-config/etc/kolla/public-openrc.sh
-./config/src/kayobe-config/init-runonce.sh
+source ~/deployment/src/kayobe-config/etc/kolla/public-openrc.sh
+~/deployment/src/kayobe-config/init-runonce.sh

etc/kayobe/ansible/pull-retag-push.yml

@@ -1,5 +1,6 @@
 ---
-- import_playbook: ../../../../../../ansible/kolla-build.yml
+- name: Run the Kayobe kolla-build.yml playbook
+  import_playbook: "{{ lookup('ansible.builtin.env', 'VIRTUAL_ENV') }}/share/kayobe/ansible/kolla-build.yml"
 
 - name: Pull, retag, and push images
   hosts: container-image-builders

init-runonce.sh

@@ -2,11 +2,11 @@
 
 set -e
 
-if [[ ! -d ~/os-venv ]]; then
-  /usr/bin/python3 -m venv ~/os-venv
+if [[ ! -d ~/deployment/venvs/os-venv ]]; then
+  /usr/bin/python3 -m venv ~/deployment/venvs/os-venv
 fi
-~/os-venv/bin/pip install -U pip
-~/os-venv/bin/pip install python-openstackclient -c https://releases.openstack.org/constraints/upper/master
+~/deployment/venvs/os-venv/bin/pip install -U pip
+~/deployment/venvs/os-venv/bin/pip install python-openstackclient -c https://releases.openstack.org/constraints/upper/2023.1
 
 parent="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
 init_runonce=$parent/../kolla-ansible/tools/init-runonce
@@ -15,5 +15,5 @@ if [[ ! -f $init_runonce ]]; then
   exit 1
 fi
 
-source ~/os-venv/bin/activate
+source ~/deployment/venvs/os-venv/bin/activate
 $init_runonce

pull-retag-push-images.sh

@@ -15,5 +15,5 @@ fi
 shift $#
 
 cd ${KAYOBE_PATH}
-source dev/environment-setup.sh
+source ~/deployment/env-vars.sh
 kayobe playbook run ${KAYOBE_CONFIG_PATH}/ansible/pull-retag-push.yml ${KAYOBE_EXTRA_ARGS:+"$KAYOBE_EXTRA_ARGS"}