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