prototypes/sfc_tacker/README.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. SPDX-License-Identifier: CC-BY-4.0
   3 .. (c) 2016 Telefonaktiebolaget L. M. ERICSSON
   4
   5 README SFC + Tacker
   6 ===================
   7
   8 The Enclosed shell script builds, deploys, orchestrates Tacker,
   9 an Open NFV Orchestrator with in-built general purpose VNF Manager
  10 to deploy and operate Virtual Network Functions (VNFs).
  11
  12 The provided deployment tool is experimental, not fault
  13 tolerant but as idempotent as possible. To use the provided shell
  14 script for provision/deployment, transfer the script to the Openstack
  15 primary controller node,  where Your deployed OpenDaylight SDN
  16 controller runs. The deployment tool (poc.tacker-up.sh), expects that
  17 Your primary controller reaches all your OPNFV/Fuel cluster nodes and
  18 has internet connection either directly or via an http proxy, note
  19 that a working and consistent DNS name resolution is a must.
  20
  21 Theory of operation: the deployment tool downloads the source
  22 python packages from GitHub and a json rpc library developed by Josh
  23 Marshall. Besides these sources, downloads software for python/debian
  24 software release. When building succeeds the script deploys the software
  25 components to the OPNFV Cluster nodes. Finally orchestrates the deployed
  26 tacker binaries as an infrastucture/service. The Tacker has two
  27 components:
  28
  29 #. Tacker server
  30
  31    - what interacts with Openstack and OpenDayLight.
  32
  33 #. Tacker client
  34
  35    - a command line software talks with the server,
  36      available on all cluster nodes and the access point
  37      to the Tacker service. Note that the tacker
  38      distribution provides a a plugin to the Horizon
  39      OpenStack Gui, but thus Horizon plugin is out of the
  40      scope of this Proof of Concept setup/deployment.
  41
  42 As mentioned, this compilation contains an OpenDayLight SDN controller
  43 with Service Function Chaining and Group based Policy features enabled.
  44
  45 To acces for your cluster information ssh to the fuel master (10.20.0.2)
  46 and issue command: fuel node.
  47 Here is an output of an example deployment:
  48
  49 +--------+------------+------------------+-------------+-----------+-------------------+----------------------------------+-------------------+------------+--------------+
  50 | **id** | **status** | **name**         | **cluster** | **ip**    | **mac**           | **roles**                        | **pending_roles** | **online** | **group_id** |
  51 +--------+------------+------------------+-------------+-----------+-------------------+----------------------------------+-------------------+------------+--------------+
  52 |   1    |   ready    | Untitled (cc:51) | 1           | 10.20.0.6 | 52:54:00:1e:cc:51 | compute                          |                   | True       | 1            |
  53 +--------+------------+------------------+-------------+-----------+-------------------+----------------------------------+-------------------+------------+--------------+
  54 |   2    |   ready    | Untitled (e6:3e) | 1           | 10.20.0.4 | 52:54:00:0c:e6:3e | compute                          |                   | True       | 1            |
  55 +--------+------------+------------------+-------------+-----------+-------------------+----------------------------------+-------------------+------------+--------------+
  56 |   3    |   ready    | Untitled (a2:4c) | 1           | 10.20.0.5 | 52:54:00:d3:a2:4c | compute                          |                   | True       | 1            |
  57 +--------+------------+------------------+-------------+-----------+-------------------+----------------------------------+-------------------+------------+--------------+
  58 |   4    |   ready    | Untitled (c7:d8) | 1           | 10.20.0.3 | 52:54:00:00:c7:d8 | cinder, controller, opendaylight |                   | True       | 1            |
  59 +--------+------------+------------------+-------------+-----------+-------------------+----------------------------------+-------------------+------------+--------------+
  60
  61 As You can see in this case the poc.tacker-up.sh script should be
  62 transferred and run on node having IP address 10.20.0.3