From 6fb970627653a5ae6293db6ef36b5a836e98769d Mon Sep 17 00:00:00 2001 From: Alexandru Avadanii Date: Sun, 10 Sep 2017 01:11:23 +0200 Subject: Add & fix licensing in README.rst files, align ext Rename all variations of README files to README.rst. Fix license headers according to OPNFV Contribution Guidelines [1]. Markdown syntax will be switched to rst in an ulterior change. [1] https://wiki.opnfv.org/display/DEV/Contribution+Guidelines Change-Id: I2c71fd62b38f218545507c79c39e07dbd35f7c88 Signed-off-by: Alexandru Avadanii --- prototypes/sfc_tacker/README | 54 ---------------------------------------- prototypes/sfc_tacker/README.rst | 49 ++++++++++++++++++++++++++++++++++++ 2 files changed, 49 insertions(+), 54 deletions(-) delete mode 100644 prototypes/sfc_tacker/README create mode 100644 prototypes/sfc_tacker/README.rst (limited to 'prototypes') diff --git a/prototypes/sfc_tacker/README b/prototypes/sfc_tacker/README deleted file mode 100644 index 0208b7850..000000000 --- a/prototypes/sfc_tacker/README +++ /dev/null @@ -1,54 +0,0 @@ -# author: Ferenc Cserepkei -# -# (c) 2016 Telefonaktiebolaget L. M. ERICSSON -# -# All rights reserved. This program and the accompanying materials -# are made available under the terms of the Apache License, Version 2.0 -# which accompanies this distribution, and is available at -# http://www.apache.org/licenses/LICENSE-2.0 - -README SFC + Tacker -------------------- - - The Enclosed shell script builds, deploys, orchestrates Tacker, -an Open NFV Orchestrator with in-built general purpose VNF Manager -to deploy and operate Virtual Network Functions (VNFs). - The provided deployment tool is experimental, not fault -tolerant but as idempotent as possible. To use the provided shell -script for provision/deployment, transfer the script to the Openstack -primary controller node, where Your deployed OpenDaylight SDN -controller runs. The deployment tool (poc.tacker-up.sh), expects that -Your primary controller reaches all your OPNFV/Fuel cluster nodes and -has internet connection either directly or via an http proxy, note -that a working and consistent DNS name resolution is a must. - Theory of operation: the deployment tool downloads the source -python packages from GitHub and a json rpc library developed by Josh -Marshall. Besides these sources, downloads software for python/debian -software release. When building succeeds the script deploys the software -components to the OPNFV Cluster nodes. Finally orchestrates the deployed -tacker binaries as an infrastucture/service. The Tacker has two -components: -o Tacker server - what interacts with Openstack and OpenDayLight. -o Tacker client - a command line software talks with the server, - available on all cluster nodes and the access point - to the Tacker service. Note that the tacker - distribution provides a a plugin to the Horizon - OpenStack Gui, but thus Horizon plugin is out of the - scope of this Proof of Concept setup/deployment. -As mentioned, this compilation contains an OpenDayLight SDN controller -with Service Function Chaining and Group based Policy features enabled. - -To acces for your cluster information ssh to the fuel master (10.20.0.2) -and issue command: fuel node. -Here is an output of an example deployment: - -id | status | name | cluster | ip | mac | roles | pending_roles | online | group_id ----|--------|------------------|---------|-----------|-------------------|----------------------------------|---------------|--------|--------- -3 | ready | Untitled (a2:4c) | 1 | 10.20.0.5 | 52:54:00:d3:a2:4c | compute | | True | 1 -4 | ready | Untitled (c7:d8) | 1 | 10.20.0.3 | 52:54:00:00:c7:d8 | cinder, controller, opendaylight | | True | 1 -1 | ready | Untitled (cc:51) | 1 | 10.20.0.6 | 52:54:00:1e:cc:51 | compute | | True | 1 -2 | ready | Untitled (e6:3e) | 1 | 10.20.0.4 | 52:54:00:0c:e6:3e | compute | | True | 1 -[root@fuel-sfc-virt ~]# - -As You can see in this case the poc.tacker-up.sh script should be -transferred and run on node having IP address 10.20.0.3 diff --git a/prototypes/sfc_tacker/README.rst b/prototypes/sfc_tacker/README.rst new file mode 100644 index 000000000..27574a66f --- /dev/null +++ b/prototypes/sfc_tacker/README.rst @@ -0,0 +1,49 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. (c) 2016 Telefonaktiebolaget L. M. ERICSSON + +README SFC + Tacker +=================== + + The Enclosed shell script builds, deploys, orchestrates Tacker, +an Open NFV Orchestrator with in-built general purpose VNF Manager +to deploy and operate Virtual Network Functions (VNFs). + The provided deployment tool is experimental, not fault +tolerant but as idempotent as possible. To use the provided shell +script for provision/deployment, transfer the script to the Openstack +primary controller node, where Your deployed OpenDaylight SDN +controller runs. The deployment tool (poc.tacker-up.sh), expects that +Your primary controller reaches all your OPNFV/Fuel cluster nodes and +has internet connection either directly or via an http proxy, note +that a working and consistent DNS name resolution is a must. + Theory of operation: the deployment tool downloads the source +python packages from GitHub and a json rpc library developed by Josh +Marshall. Besides these sources, downloads software for python/debian +software release. When building succeeds the script deploys the software +components to the OPNFV Cluster nodes. Finally orchestrates the deployed +tacker binaries as an infrastucture/service. The Tacker has two +components: +o Tacker server - what interacts with Openstack and OpenDayLight. +o Tacker client - a command line software talks with the server, + available on all cluster nodes and the access point + to the Tacker service. Note that the tacker + distribution provides a a plugin to the Horizon + OpenStack Gui, but thus Horizon plugin is out of the + scope of this Proof of Concept setup/deployment. +As mentioned, this compilation contains an OpenDayLight SDN controller +with Service Function Chaining and Group based Policy features enabled. + +To acces for your cluster information ssh to the fuel master (10.20.0.2) +and issue command: fuel node. +Here is an output of an example deployment: + +id | status | name | cluster | ip | mac | roles | pending_roles | online | group_id +---|--------|------------------|---------|-----------|-------------------|----------------------------------|---------------|--------|--------- +3 | ready | Untitled (a2:4c) | 1 | 10.20.0.5 | 52:54:00:d3:a2:4c | compute | | True | 1 +4 | ready | Untitled (c7:d8) | 1 | 10.20.0.3 | 52:54:00:00:c7:d8 | cinder, controller, opendaylight | | True | 1 +1 | ready | Untitled (cc:51) | 1 | 10.20.0.6 | 52:54:00:1e:cc:51 | compute | | True | 1 +2 | ready | Untitled (e6:3e) | 1 | 10.20.0.4 | 52:54:00:0c:e6:3e | compute | | True | 1 +[root@fuel-sfc-virt ~]# + +As You can see in this case the poc.tacker-up.sh script should be +transferred and run on node having IP address 10.20.0.3 -- cgit 1.2.3-korg