From d51fa5519b4e3b1caceef7e6a562b6e683a2a543 Mon Sep 17 00:00:00 2001 From: Bertrand Souville Date: Thu, 25 Oct 2018 12:43:43 +0200 Subject: Docs: Adding Blazar installation guide using OpenStack Ansible Change-Id: I22f986d15a9663d9d6c16b66f7a2aca8c5088e99 Signed-off-by: Bertrand Souville --- docs/release/configguide/feature.configuration.rst | 84 ++++++++++----------- docs/release/configguide/images/LICENSE | 14 ---- .../configguide/images/screenshot_promise.png | Bin 101419 -> 0 bytes .../images/screenshot_promise_install.png | Bin 216440 -> 0 bytes 4 files changed, 39 insertions(+), 59 deletions(-) delete mode 100644 docs/release/configguide/images/LICENSE delete mode 100755 docs/release/configguide/images/screenshot_promise.png delete mode 100644 docs/release/configguide/images/screenshot_promise_install.png (limited to 'docs') diff --git a/docs/release/configguide/feature.configuration.rst b/docs/release/configguide/feature.configuration.rst index 3e66020..422e822 100644 --- a/docs/release/configguide/feature.configuration.rst +++ b/docs/release/configguide/feature.configuration.rst @@ -1,63 +1,57 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -Promise installation -==================== +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). -Install nodejs, npm and promise +Install and bootstrap Ansible (master branch) as the root user: -.. code-block:: bash +.. code:: bash - 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 - npm ls + # git clone https://git.openstack.org/openstack/openstack-ansible /opt/openstack-ansible + # cd /opt/openstack-ansible -Please note that the last command 'npm ls' will list all needed dependencies -for promise (including yangforge and mocha) +Get the Blazar extra code: -.. figure:: images/screenshot_promise_install.png - :name: figure1 - :width: 90% +.. code:: bash + # git pull https://git.openstack.org/openstack/openstack-ansible refs/changes/56/549956/31 -Validation -========== -Please perform the following preparation steps: +.. 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. -1. Set OpenStack environment parameters properly (e.g. source openrc admin demo - in DevStack) -2. Create OpenStack project (e.g. promise) and user (e.g. myuser) in e.g. the - default domain -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 +.. code:: bash -Once done, the promise test script can be invoked as follows: + # export ANSIBLE_ROLE_FETCH_MODE=git-clone + # scripts/bootstrap-ansible.sh + # scripts/bootstrap-aio.sh -.. code-block:: bash +Enable Blazar: - export OS_PROJECT_NAME=promise - export OS_TENANT_NAME=promise - export OS_PROJECT_DOMAIN_NAME=Default - export OS_USERNAME=myuser - export OS_USER_DOMAIN_NAME=Default - export OS_PASSWORD= - export OS_TEST_FLAVOR= - export OS_TEST_NETWORK= - export OS_TEST_IMAGE= - npm run -s test -- --reporter json > promise-results.json +.. code:: bash -The results of the tests will be stored in the promise-results.json file. + # 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 can also be seen in the console ("npm run -s test") +Run Ansible playbooks: -.. figure:: images/screenshot_promise.png - :name: figure2 - :width: 90% +.. code:: bash -All 33 tests passing?! -Congratulations, Promise has been successfully installed and configured. + # cd /opt/openstack-ansible/playbooks + # openstack-ansible setup-hosts.yml + # openstack-ansible setup-infrastructure.yaml + # openstack-ansible setup-openstack.yml + +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 diff --git a/docs/release/configguide/images/LICENSE b/docs/release/configguide/images/LICENSE deleted file mode 100644 index 6a84dd4..0000000 --- a/docs/release/configguide/images/LICENSE +++ /dev/null @@ -1,14 +0,0 @@ -Copyright 2016 Open Platform for NFV Project, Inc. and its contributors - -Open Platform for NFV Project Documentation Licence -=================================================== -Any documentation developed by the "Open Platform for NFV Project" -is licensed under a Creative Commons Attribution 4.0 International License. -You should have received a copy of the license along with this. If not, -see . - -Unless required by applicable law or agreed to in writing, documentation -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. diff --git a/docs/release/configguide/images/screenshot_promise.png b/docs/release/configguide/images/screenshot_promise.png deleted file mode 100755 index 4a0cbe3..0000000 Binary files a/docs/release/configguide/images/screenshot_promise.png and /dev/null differ diff --git a/docs/release/configguide/images/screenshot_promise_install.png b/docs/release/configguide/images/screenshot_promise_install.png deleted file mode 100644 index ab78994..0000000 Binary files a/docs/release/configguide/images/screenshot_promise_install.png and /dev/null differ -- cgit 1.2.3-korg