openstack/barbican
Code Issues Proposed changes

Update devstack plugin installation doc

Browse Source 
This patch updates the installation doc for the devstack plugin.  It
also removes the Vagrant option as it has not been maintained in quite
some time.

Change-Id: I97fc2fac0cb29b1059b668bbe817a2778a8a4a70
This commit is contained in:
Douglas Mendizábal 2022-09-12 16:37:54 -04:00
parent d8ffdf91e5
commit 33d42acb04
5 changed files with 21 additions and 145 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
devstack/README.md
View File

@ -15,7 +15,7 @@ where
For example
enable_plugin barbican https://opendev.org/openstack/barbican stable/liberty
enable_plugin barbican https://opendev.org/openstack/barbican stable/zed
For more information, see the "Externally Hosted Plugins" section of
https://docs.openstack.org/devstack/latest/plugins.html

26
devstack/barbican-vagrant/Vagrantfile vendored
View File

@ -1,26 +0,0 @@
# -*- mode: ruby -*-
# vi: set ft=ruby :
VAGRANTFILE_API_VERSION = "2"
Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
config.vm.box = "ubuntu/xenial64"
# Barbican Ports
config.vm.network "forwarded_port", guest: 9311, host: 9311
# Keystone Ports
config.vm.network "forwarded_port", guest: 35357, host: 35357
config.vm.network "forwarded_port", guest: 5000, host: 5000
config.vm.provision "shell", path: "install_devstack.sh"
# Create Synced Folder
config.vm.synced_folder "./devstack", "/opt/stack", create: true
config.vm.provider "virtualbox" do |v|
v.name = "Devstack"
v.memory = 2048
v.cpus = 2
end
end

15
devstack/barbican-vagrant/install_devstack.sh
View File

@ -1,15 +0,0 @@
#!/bin/bash
export DEBIAN_FRONTEND=noninteractive
sudo apt-get update
sudo apt-get install -y python-pip python-dev libffi-dev libssl-dev git
git clone https://opendev.org/openstack/devstack.git
git clone https://opendev.org/openstack/barbican.git
cp barbican/devstack/local.conf.example devstack/local.conf
sudo cp -R devstack/ /opt/stack/
sudo chown -R vagrant:vagrant /opt/stack/
echo "export SERVICE_HOST=\"localhost\"" >> .bashrc

6
devstack/local.conf.example
View File

@ -1,18 +1,14 @@
[[local|localrc]]
disable_all_services
enable_plugin barbican https://opendev.org/openstack/barbican
# To use a specific branch:
# enable_plugin barbican https://opendev.org/openstack/barbican stable/<release-name>
enable_plugin barbican https://opendev.org/openstack/barbican
enable_service rabbit mysql key
# This is to keep the token small for testing
KEYSTONE_TOKEN_FORMAT=UUID
# Modify passwords as needed
DATABASE_PASSWORD=secretdatabase
RABBIT_PASSWORD=secretrabbit
ADMIN_PASSWORD=secretadmin
SERVICE_PASSWORD=secretservice
SERVICE_TOKEN=111222333444

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

@ -1,116 +1,37 @@
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
with all necessary dependencies to run DevStack. It is recommended to use
this process if it is your first time.
This installation guide assumes you are running devstack within a clean virtual
machine (local or cloud instance) using one of the `supported Linux
distributions`_ with all available system package updates.
If you are familiar with DevStack you can use the steps in the manual
setup section to install Barbican onto your already running DevStack
installation.
.. _`supported Linux distributions`: https://governance.openstack.org/tc/reference/project-testing-interface.html#linux-distributions
.. warning::
#. Make sure you are logged in as the "stack" user with sudo privileges
This process takes anywhere from 10-30 minutes depending on your internet
connection.
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.
.. warning::
Upon following these steps, you will not be able to use tox tools
if you setup a shared folder. This is because making hard-links is
required, but not permitted if the project is in a shared folder.
If you wish to use tox, comment out the `Create Synced Folder`
section in `barbican/devstack/barbican-vagrant/Vagrantfile`.
1. Obtain Barbican vagrant file
If you don't already have the file then clone the repo below
.. code-block:: bash
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
cp -r barbican/devstack/barbican-vagrant <directory>
3. Get into the ``barbican-vagrant`` directory
.. code-block:: bash
cd barbican-vagrant
4. Start create a new VM based on the cloned configuration
.. code-block:: bash
vagrant up
5. Once the VM has been successfully started and provisioned, ssh into the VM.
.. code-block:: bash
vagrant ssh
6. Once inside the VM, change your directory to the ``devstack`` folder.
.. code-block:: bash
cd /opt/stack/devstack/
7. Start DevStack
.. code-block:: bash
./stack.sh
Manual Setup
------------
These steps assume you are running within a clean Ubuntu 14.04 virtual
machine (local or cloud instance). If you are running locally, do not forget
to expose the following ports
#. Barbican - ``9311``
#. Keystone API - ``5000``
#. Keystone Admin API - ``5000``
Installation
~~~~~~~~~~~~
1. Make sure you are logged in as a non-root user with sudo privileges
2. Install git
#. Install git
.. code-block:: bash
# Debian/Ubuntu
sudo apt-get install git
# CentOS
sudo dnf install git
3. Clone DevStack
.. code-block:: bash
git clone https://opendev.org/openstack/devstack.git
cd devstack/
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.
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
@ -118,13 +39,13 @@ Installation
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
<https://github.com/openstack/barbican/tree/master/devstack>`_.
is a working sample file in the `Barbican repository`_.
Copy the file and place it in the ``devstack/`` directory.
.. _`Barbican repository`: https://opendev.org/openstack/barbican/src/branch/master/devstack/local.conf.example
5. Start DevStack
.. code-block:: bash
cd devstack/
./stack.sh