Skip to content

Commit

Permalink
Add beokay kayobe env support and simplfy vault secret section
Browse files Browse the repository at this point in the history
  • Loading branch information
seunghun1ee committed Nov 4, 2024
1 parent 5aeb29f commit afbfdb0
Showing 1 changed file with 11 additions and 21 deletions.
32 changes: 11 additions & 21 deletions source/working_with_kayobe.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ and control plane hosts through the provisioning network

|control_host_access|

.. _Making a Kayobe Checkout:

Making a Kayobe Checkout
------------------------

Expand All @@ -50,26 +52,21 @@ A Kayobe development environment can easily be set up using a script called
--kayobe-branch |kayobe_source_version| \
--kayobe-config-repo |kayobe_config_source_url| \
--kayobe-config-branch |kayobe_config_source_version| \
--kayobe-config-env-name <kayobe-environment-name> \
--vault-password-file |vault_password_file_path|
After making the checkout, source the virtualenv and Kayobe config environment variables:

.. code-block:: console
:substitutions:
kayobe# cd |base_path|
kayobe# source venvs/kayobe/bin/activate
kayobe# source src/kayobe-config/kayobe-env
If the system does not use Kayobe environment, you can omit ``--kayobe-config-env-name``.
See the section :ref:`Kayobe Environments` for more details.

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

.. code-block:: console
:substitutions:
kayobe# source src/kayobe-config/kayobe-env --environment <env-name>
cd |base_path|
source env-vars.sh
Set up any dependencies needed on the control host:
Then, set up any dependencies needed on the control host:

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

An easy way to manage the vault password is to update ``.bash_profile`` to add
a command such as:

.. code-block:: console
:substitutions:
kayobe# export KAYOBE_VAULT_PASSWORD=$(cat |vault_password_file_path|)
Or using ``env-vars.sh`` created from ``beokay`` if you used it.
An easy way to manage the vault password is using ``env-vars.sh`` created from ``beokay``.
See the section :ref:`Making a Kayobe Checkout` for details.

.. code-block:: console
:substitutions:
Expand Down

0 comments on commit afbfdb0

Please sign in to comment.