prototypes/sfc_tacker/README

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