Skip to content

Commit a5dd9b3

Browse files
committed
Add notes to provide more clarity for bifrost installation
Included activation block so that new users will not skip activating their virtual environment. To prevent bridge interface error during installation via playbooks, a note is included to notify users using virtual environment not to change the ``network_interface``. The commands in the playbook execution section under advanced installation is placed in a code block for better readability. Added more context to virtual env network interface DocImpact Change-Id: I6079591f264fb2822b7afb6afeebd1555da8e226
1 parent 7798b49 commit a5dd9b3

File tree

2 files changed

+19
-5
lines changed

2 files changed

+19
-5
lines changed

doc/source/install/index.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -327,6 +327,13 @@ After installation is done, export the following environment variable to
327327
configure the bare metal client to use the ``bifrost`` cloud configuration from
328328
the generated ``clouds.yaml`` (see :ref:`baremetal-cli` for details):
329329

330+
.. note::
331+
When using bifrost in a virtual environment, ensure to activate it.
332+
333+
.. code-block:: shell
334+
335+
source ~/bifrost/env/bin/activate
336+
330337
.. code-block:: shell
331338
332339
export OS_CLOUD=bifrost

doc/source/install/playbooks.rst

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@ upon.
7676
your local installation.
7777
- Change ``network_interface`` to match the interface that will need
7878
to service DHCP requests.
79+
7980
- Set ``service_password`` which is used for communication between services.
8081
If unset, a random password is generated during the initial installation and
8182
stored on the controller in ``~/.config/bifrost/service_password``.
@@ -184,19 +185,25 @@ First, make sure that the virtual environment is active (the example below
184185
assumes that bifrost venv is installed into the default path
185186
/opt/stack/bifrost).
186187

188+
.. code-block:: bash
189+
187190
$ . /opt/stack/bifrost/bin/activate
188-
(bifrost) $
191+
(bifrost)$
189192
190193
Verify if the ansible-playbook executable points to the one installed in
191194
the virtual environment:
192195

193-
(bifrost) $ which ansible-playbook
194-
/opt/stack/bifrost/bin/ansible-playbook
195-
(bifrost) $
196+
.. code-block:: bash
197+
198+
(bifrost)$ which ansible-playbook
199+
/opt/stack/bifrost/bin/ansible-playbook
200+
(bifrost)$
196201
197202
change to the ``playbooks`` subdirectory of the cloned bifrost repository:
198203

199-
$ cd playbooks
204+
.. code-block:: bash
205+
206+
$ cd playbooks
200207
201208
If you have passwordless sudo enabled, run::
202209

0 commit comments

Comments
 (0)