Usage¶

How to consume this configuration¶

This configuration is not a complete Kayobe configuration, rather it should be treated as a base, in place of the upstream kayobe-config. Indeed, this repository is based on the upstream kayobe-config, with some opinionated configuration changes applied.

Since this repository makes changes to the base configuration, it works best when used with Kayobe’s multiple environments feature.

This configuration should be consumed using the StackHPC Kayobe fork, which includes backported support for Ansible collections.

New deployments¶

If starting a new deployment, clone this repository as the starting point for your configuration:

git clone https://github.com/stackhpc/stackhpc-kayobe-config -b stackhpc/2024.1

Existing deployments¶

If migrating an existing deployment to StackHPC Kayobe configuration, you will need to merge the changes in this repository into your repository:

git remote add stackhpc https://github.com/stackhpc/stackhpc-kayobe-config
git fetch stackhpc
git merge stackhpc/stackhpc/2024.1

Updating¶

This base configuration will be updated over time, to update repository versions, container image tags, and other configuration. Deployments may consume these updates by merging in the changes with their local configuration:

git fetch stackhpc
git merge stackhpc/stackhpc/2024.1

The intention is to avoid merge conflicts where possible, but there may be cases where this is difficult. We are open to discussion on how best to approach this on both sides.

Beokay¶

Beokay <https://github.com/stackhpc/beokay> is a tool to manage Kayobe environments. This can create new StackHPC Kayobe environments and ensure StackHPC Kayobe Configuration dependencies are from the correct repositories and are up-to-date:

To create a Beokay environment using the base configuration, for the latest release:

beokay.py create \
--base-path skc-environment \
--kayobe-config-repo https://github.com/stackhpc/stackhpc-kayobe-config.git \
--kayobe-config-branch |current_release_git_branch_name| \
--kayobe-in-requirements

Kayobe environments can also be specified, for example, to create an AIO environment:

beokay.py create \
--base-path skc-aio-environment \
--kayobe-config-repo https://github.com/stackhpc/stackhpc-kayobe-config.git \
--kayobe-config-branch |current_release_git_branch_name| \
--kayobe-config-env-name ci-aio \
--vault-password-file ~/vault-pw \
--kayobe-in-requirements

When Beokay environments are no longer required, they can be deleted by running:

beokay.py destroy \
--base-path skc-environment

Specific Kayobe commands can also be run via Beokay, for example, to run a Kolla service deployment on overcloud hosts:

beokay.py run \
'kayobe overcloud service deploy' \
--base-path skc-aio-environment \
--kayobe-config-env-name ci-aio \
--vault-password-file ~/vault-pw