Docs: Adding Blazar installation guide using OpenStack Ansible
[promise.git] / docs / release / configguide / feature.configuration.rst
index 10696e0..422e822 100644 (file)
@@ -1,63 +1,57 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
 
-Manual testing
-==============
+Blazar installation with OpenStack Ansible
+==========================================
+.. note::
+   This guide provides steps for manual installation of Blazar using OpenStack
+   Ansible. These instructions are valid for Ubuntu 18.04 All-in-one (AIO).
 
-Promise installation
---------------------
+Install and bootstrap Ansible (master branch) as the root user:
 
-Install nodejs, npm and promise
+.. code:: bash
 
-.. code-block:: bash
+   # git clone https://git.openstack.org/openstack/openstack-ansible /opt/openstack-ansible
+   # cd /opt/openstack-ansible
 
-    curl -sL https://deb.nodesource.com/setup_4.x | sudo -E bash -
-    sudo apt-get install -y nodejs
-    sudo npm -g install npm@latest
-    git clone https://gerrit.opnfv.org/gerrit/promise
-    cd promise/source
-    npm install
+Get the Blazar extra code:
 
-Please note that the last command 'npm install' will install all needed dependencies
-for promise (including yangforge and mocha)
+.. code:: bash
 
-.. figure:: images/screenshot_promise_install.png
-   :name: figure1
-      :width: 90%
+  # git pull https://git.openstack.org/openstack/openstack-ansible refs/changes/56/549956/31
 
+.. note::
+   At the time of writing, work is still ongoing upstream in OpenStack.
+   Therefore, it is recommended to set ANSIBLE_ROLE_FETCH_MODE to git-clone.
 
-Validation
-----------
-Please perform the following preparation steps:
+.. code:: bash
 
-1. Set OpenStack environment parameters properly (e.g. source openrc admin demo
-   in DevStack)
-2. Create OpenStack tenant (e.g. promise) and tenant user (e.g. promiser)
-3. Create a flavor in Nova with 1 vCPU and 512 MB RAM
-4. Create a private network, subnet and router in Neutron
-5. Create an image in Glance
+   # export ANSIBLE_ROLE_FETCH_MODE=git-clone
+   # scripts/bootstrap-ansible.sh
+   # scripts/bootstrap-aio.sh
 
-Once done, the promise test script can be invoked as follows (as a single line
-command):
+Enable Blazar:
 
-.. code-block:: bash
+.. code:: bash
 
-   NODE_ENV=mytest \
-   OS_TENANT_NAME=promise \
-   OS_USERNAME=promiser \
-   OS_PASSWORD=<user password from Step 2> \
-   OS_TEST_FLAVOR=<flavor ID from Step 3> \
-   OS_TEST_NETWORK=<network ID from Step 4> \
-   OS_TEST_IMAGE=<image ID from Step 5> \
-   npm run -s test -- --reporter json > promise-results.json
+   # cp etc/openstack_deploy/conf.d/blazar.yml.aio /etc/openstack_deploy/conf.d/
+   # cd /etc/openstack_deploy/conf.d
+   # mv blazar.yml.aio blazar.yml
 
-The results of the tests will be stored in the promise-results.json file.
+Run Ansible playbooks:
 
-The results can also be seen in the console ("npm run -s test")
+.. code:: bash
 
-.. figure:: images/screenshot_promise.png
-   :name: figure2
-   :width: 90%
+   # cd /opt/openstack-ansible/playbooks
+   # openstack-ansible setup-hosts.yml
+   # openstack-ansible setup-infrastructure.yaml
+   # openstack-ansible setup-openstack.yml
 
-All 33 tests passing?!
-Congratulations, promise has been successfully installed and configured.
+Once the playbooks have successfully executed, it is possible to make some
+modifications to the Blazar Ansible role in /etc/ansible/roles/os_blazar
+and re-install the Blazar service by executing:
+
+.. code:: bash
+
+   # cd /opt/openstack-ansible/playbooks
+   # openstack-ansible os-blazar-install.yml