@@ -57,3 +57,51 @@ configuration:
57
57
The intention is to avoid merge conflicts where possible, but there may be
58
58
cases where this is difficult. We are open to discussion on how best to
59
59
approach this on both sides.
60
+
61
+ Beokay
62
+ ------
63
+
64
+ `Beokay <https://github.com/stackhpc/beokay> ` is a tool to manage Kayobe
65
+ environments. This can create new StackHPC Kayobe environments and
66
+ ensure StackHPC Kayobe Configuration dependencies are from the correct repositories and
67
+ are up-to-date:
68
+
69
+ To create a Beokay environment using the base configuration, for the latest release:
70
+
71
+ .. code-block :: console
72
+
73
+ beokay.py create \
74
+ --base-path skc-environment \
75
+ --kayobe-config-repo https://github.com/stackhpc/stackhpc-kayobe-config.git \
76
+ --kayobe-config-branch |current_release_git_branch_name| \
77
+ --kayobe-in-requirements
78
+
79
+ Kayobe environments can also be specified, for example, to create an AIO environment:
80
+
81
+ .. code-block :: console
82
+
83
+ beokay.py create \
84
+ --base-path skc-aio-environment \
85
+ --kayobe-config-repo https://github.com/stackhpc/stackhpc-kayobe-config.git \
86
+ --kayobe-config-branch |current_release_git_branch_name| \
87
+ --kayobe-config-env-name ci-aio \
88
+ --vault-password-file ~/vault-pw \
89
+ --kayobe-in-requirements
90
+
91
+ When Beokay environments are no longer required, they can be deleted by running:
92
+
93
+ .. code-block :: console
94
+
95
+ beokay.py destroy \
96
+ --base-path skc-environment
97
+
98
+ Specific Kayobe commands can also be run via Beokay, for example, to run a Kolla
99
+ service deployment on overcloud hosts:
100
+
101
+ .. code-block :: console
102
+
103
+ beokay.py run \
104
+ 'kayobe overcloud service deploy' \
105
+ --base-path skc-aio-environment \
106
+ --kayobe-config-env-name ci-aio \
107
+ --vault-password-file ~/vault-pw
0 commit comments