openstack/barbican
Code Issues Proposed changes

docs: Minor tweaks to DevStack guide

Browse Source 
Fix indentation so code blocks don't appear as quotes, properly title
case case project names and format literals as such.

Change-Id: I3db0e83e30469d7217126f18dce813bf00abc0ae
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
This commit is contained in:
Stephen Finucane 2020-05-27 15:41:13 +01:00
parent 1ad4359735
commit 146b6e6b9e
1 changed files with 32 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

65
doc/source/contributor/devstack.rst
View File

@ -1,7 +1,7 @@
Running Barbican on DevStack
============================
Barbican is currently available via the plugin interface within devstack
Barbican is currently available via the plugin interface within DevStack
We provide two ways of deploying a DevStack environment with a running
Barbican. The easy mode uses vagrant and automatically creates the VM
@ -22,8 +22,8 @@ Easy Mode
---------
To simplify the setup process of running Barbican on DevStack, there is a
Vagrantfile that will automatically setup up a VM containing Barbican
running on Devstack.
``Vagrantfile`` that will automatically setup up a VM containing Barbican
running on DevStack.
.. warning::
@ -36,48 +36,47 @@ running on Devstack.
1. Obtain Barbican vagrant file
If you don't already have the file then clone the repo below
.. code-block:: bash
.. code-block:: bash
git clone https://opendev.org/openstack/barbican.git
git clone https://opendev.org/openstack/barbican.git
2. Move the ``barbican-vagrant`` directory outside of the Barbican directory
and into your current directory for vagrant files. If you do not have one,
then just copy it into your home directory.
.. code-block:: bash
.. code-block:: bash
cp -r barbican/devstack/barbican-vagrant <directory>
cp -r barbican/devstack/barbican-vagrant <directory>
3. Get into the ``barbican-vagrant`` directory
.. code-block:: bash
.. code-block:: bash
cd barbican-vagrant
cd barbican-vagrant
4. Start create a new VM based on the cloned configuration
.. code-block:: bash
.. code-block:: bash
vagrant up
vagrant up
5. Once the VM has been successfully started and provisioned, ssh into the VM.
.. code-block:: bash
.. code-block:: bash
vagrant ssh
vagrant ssh
6. Once inside the VM, change your directory to the ``devstack`` folder.
.. code-block:: bash
.. code-block:: bash
cd /opt/stack/devstack/
cd /opt/stack/devstack/
7. Start DevStack
.. code-block:: bash
.. code-block:: bash
./stack.sh
./stack.sh
Manual Setup
@ -92,40 +91,40 @@ to expose the following ports
#. Keystone Admin API - ``5000``
Installation
^^^^^^^^^^^^
~~~~~~~~~~~~
1. Make sure you are logged in as a non-root user with sudo privileges
2. Install git
.. code-block:: bash
.. code-block:: bash
sudo apt-get install git
sudo apt-get install git
3. Clone DevStack
.. code-block:: bash
.. code-block:: bash
git clone https://opendev.org/openstack/devstack.git
git clone https://opendev.org/openstack/devstack.git
4. Add the Barbican plugin to the local.conf file and verify the minimum
4. Add the Barbican plugin to the ``local.conf`` file and verify the minimum
services required are included. You can pull down a specific branch by
appending the name to the end of the git URL. If you leave the space empty
like below, then origin/master will be pulled.
.. code-block:: ini
.. code-block:: ini
enable_plugin barbican https://opendev.org/openstack/barbican
enable_service rabbit mysql key
enable_plugin barbican https://opendev.org/openstack/barbican
enable_service rabbit mysql key
If this is your first time and you do not have a local.conf file, there is
an example in the `Barbican github
If this is your first time and you do not have a ``local.conf`` file, there
is an example in the `Barbican GitHub
<https://github.com/openstack/barbican/tree/master/devstack>`_.
Copy the file and place it in the devstack/ directory.
Copy the file and place it in the ``devstack/`` directory.
5. Start DevStack
.. code-block:: bash
.. code-block:: bash
cd devstack/
./stack.sh
cd devstack/
./stack.sh