From bf54e8afe30a0b61170308f158ece761630b4bb3 Mon Sep 17 00:00:00 2001 From: Jake Hutchinson Date: Wed, 9 Apr 2025 16:24:03 +0100 Subject: [PATCH 1/4] Beokay usage documentation --- doc/source/usage.rst | 48 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) diff --git a/doc/source/usage.rst b/doc/source/usage.rst index fe83d9157..d830d97ff 100644 --- a/doc/source/usage.rst +++ b/doc/source/usage.rst @@ -57,3 +57,51 @@ configuration: 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 ` is a tool to help assist managing Kayobe +environments. This can be utilised to help 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: + +.. code-block:: console + + beokay.py create \ + --base-path skc-environment \ + --kayobe-config-repo https://github.com/stackhpc/stackhpc-kayobe-config.git \ + --kayobe-config-branch stackhpc/2024.1 \ + --kayobe-in-requirements + +Kayobe environments can also be specified, for example, to create an AIO environment: + +.. code-block:: console + + beokay.py create \ + --base-path skc-aio-environment \ + --kayobe-config-repo https://github.com/stackhpc/stackhpc-kayobe-config.git \ + --kayobe-config-branch stackhpc/2024.1 \ + --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: + +.. code-block:: console + + 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: + +.. code-block:: console + + beokay.py run \ + 'kayobe overcloud service deploy' \ + --base-path skc-aio-environment \ + --kayobe-config-env-name ci-aio \ + --vault-password-file ~/vault-pw From 386e77c023b65b6933f74b4becc3041e0ddfef27 Mon Sep 17 00:00:00 2001 From: Jake Hutchinson <39007539+assumptionsandg@users.noreply.github.com> Date: Thu, 10 Apr 2025 12:52:19 +0100 Subject: [PATCH 2/4] Update doc/source/usage.rst Co-authored-by: Alex-Welsh <112560678+Alex-Welsh@users.noreply.github.com> --- doc/source/usage.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/source/usage.rst b/doc/source/usage.rst index d830d97ff..b354a010f 100644 --- a/doc/source/usage.rst +++ b/doc/source/usage.rst @@ -61,8 +61,8 @@ approach this on both sides. Beokay ------ -`Beokay ` is a tool to help assist managing Kayobe -environments. This can be utilised to help create new StackHPC Kayobe environments and +`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: From de3ce09598c0bb8a7e6dc9134b1ddc5c707a710c Mon Sep 17 00:00:00 2001 From: Jake Hutchinson <39007539+assumptionsandg@users.noreply.github.com> Date: Thu, 10 Apr 2025 12:52:28 +0100 Subject: [PATCH 3/4] Update doc/source/usage.rst Co-authored-by: Alex-Welsh <112560678+Alex-Welsh@users.noreply.github.com> --- doc/source/usage.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/usage.rst b/doc/source/usage.rst index b354a010f..fda81c486 100644 --- a/doc/source/usage.rst +++ b/doc/source/usage.rst @@ -73,7 +73,7 @@ To create a Beokay environment using the base configuration, for the latest rele beokay.py create \ --base-path skc-environment \ --kayobe-config-repo https://github.com/stackhpc/stackhpc-kayobe-config.git \ - --kayobe-config-branch stackhpc/2024.1 \ + --kayobe-config-branch |current_release_git_branch_name| \ --kayobe-in-requirements Kayobe environments can also be specified, for example, to create an AIO environment: From 4774fbd2467e179f9d4a0f38c9a679128067f8ad Mon Sep 17 00:00:00 2001 From: Jake Hutchinson <39007539+assumptionsandg@users.noreply.github.com> Date: Thu, 10 Apr 2025 12:52:34 +0100 Subject: [PATCH 4/4] Update doc/source/usage.rst Co-authored-by: Alex-Welsh <112560678+Alex-Welsh@users.noreply.github.com> --- doc/source/usage.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/usage.rst b/doc/source/usage.rst index fda81c486..06e54ba0f 100644 --- a/doc/source/usage.rst +++ b/doc/source/usage.rst @@ -83,7 +83,7 @@ Kayobe environments can also be specified, for example, to create an AIO environ beokay.py create \ --base-path skc-aio-environment \ --kayobe-config-repo https://github.com/stackhpc/stackhpc-kayobe-config.git \ - --kayobe-config-branch stackhpc/2024.1 \ + --kayobe-config-branch |current_release_git_branch_name| \ --kayobe-config-env-name ci-aio \ --vault-password-file ~/vault-pw \ --kayobe-in-requirements