Skip to content

Commit afbfdb0

Browse files
committed
Add beokay kayobe env support and simplfy vault secret section
1 parent 5aeb29f commit afbfdb0

File tree

1 file changed

+11
-21
lines changed

1 file changed

+11
-21
lines changed

source/working_with_kayobe.rst

Lines changed: 11 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ and control plane hosts through the provisioning network
3131

3232
|control_host_access|
3333

34+
.. _Making a Kayobe Checkout:
35+
3436
Making a Kayobe Checkout
3537
------------------------
3638

@@ -50,26 +52,21 @@ A Kayobe development environment can easily be set up using a script called
5052
--kayobe-branch |kayobe_source_version| \
5153
--kayobe-config-repo |kayobe_config_source_url| \
5254
--kayobe-config-branch |kayobe_config_source_version| \
55+
--kayobe-config-env-name <kayobe-environment-name> \
5356
--vault-password-file |vault_password_file_path|
5457
55-
After making the checkout, source the virtualenv and Kayobe config environment variables:
56-
57-
.. code-block:: console
58-
:substitutions:
59-
60-
kayobe# cd |base_path|
61-
kayobe# source venvs/kayobe/bin/activate
62-
kayobe# source src/kayobe-config/kayobe-env
58+
If the system does not use Kayobe environment, you can omit ``--kayobe-config-env-name``.
59+
See the section :ref:`Kayobe Environments` for more details.
6360

64-
If you are using a Kayobe environment, you will instead need to specify which
65-
environment to source. See the section :ref:`Kayobe Environments` for more details.
61+
After making the checkout, source ``env-vars.sh``.
6662

6763
.. code-block:: console
6864
:substitutions:
6965
70-
kayobe# source src/kayobe-config/kayobe-env --environment <env-name>
66+
cd |base_path|
67+
source env-vars.sh
7168
72-
Set up any dependencies needed on the control host:
69+
Then, set up any dependencies needed on the control host:
7370

7471
.. code-block:: console
7572
@@ -84,15 +81,8 @@ such as IPMI credentials, Ceph account keys and OpenStack service credentials.
8481
The vault of deployment secrets is protected by a password, which
8582
conventionally is stored in a (mode 0400) file in the user home directory.
8683

87-
An easy way to manage the vault password is to update ``.bash_profile`` to add
88-
a command such as:
89-
90-
.. code-block:: console
91-
:substitutions:
92-
93-
kayobe# export KAYOBE_VAULT_PASSWORD=$(cat |vault_password_file_path|)
94-
95-
Or using ``env-vars.sh`` created from ``beokay`` if you used it.
84+
An easy way to manage the vault password is using ``env-vars.sh`` created from ``beokay``.
85+
See the section :ref:`Making a Kayobe Checkout` for details.
9686

9787
.. code-block:: console
9888
:substitutions:

0 commit comments

Comments
 (0)