From 681dd54cd02cc9e89f26f2799680bfe6eac5ef51 Mon Sep 17 00:00:00 2001 From: goldammx Date: Wed, 15 Feb 2017 10:15:11 -0500 Subject: license: Add license info to all project files All files were updated with license header. In case of binary files is license stored in LICENSE file stored in the same directory. Packages.txt was removed, because file has not been used.List of packages differs according OS distribution, all of neccesary packages are include in instalation scripts JIRA: VSPERF-489 Change-Id: I6ecae21b8db2a0f22fa5a66f9525352080f1fcc0 Signed-off-by: Martin Goldammer Reviewed-by: Martin Klozik Reviewed-by: Al Morton Reviewed-by: Christian Trautman Reviewed-by: Bill Michalowski Reviewed-by: Antonio Fischetti Reviewed-by: Sridhar Rao --- CONTRIBUTING.md | 5 ++++ LICENSE | 26 ++++++++--------- README.md | 5 ++++ docs/configguide/LICENSE | 2 ++ docs/design/LICENSE | 2 ++ docs/requirements/LICENSE | 2 ++ docs/requirements/ietf_draft/LICENSE | 12 ++++++++ fuel-plugin-vsperf/README.md | 5 ++++ fuel-plugin-vsperf/deployment_scripts/deploy.sh | 7 +++++ .../puppet/manifests/vsperf-install.pp | 7 +++++ fuel-plugin-vsperf/deployment_tasks.yaml | 7 +++++ fuel-plugin-vsperf/environment_config.yaml | 6 ++++ fuel-plugin-vsperf/node_roles.yaml | 7 +++++ fuel-plugin-vsperf/pre_build_hook | 7 +++++ fuel-plugin-vsperf/tasks.yaml | 7 +++++ fuel-plugin-vsperf/vagrant/README.md | 5 ++++ fuel-plugin-vsperf/vagrant/Vagrantfile | 9 +++++- fuel-plugin-vsperf/vagrant/build_fuel_plugin.sh | 8 +++++ jobs/README | 1 - jobs/README.md | 6 ++++ onboarding.txt | 3 ++ packages.txt | 9 ------ requirements.txt | 8 +++++ src/README | 29 ------------------ src/README.md | 34 ++++++++++++++++++++++ src/mk/README | 3 -- src/mk/README.md | 7 +++++ src/package-list.mk | 7 +++++ systems/README | 9 ------ systems/README.md | 14 +++++++++ testcases/README | 8 ----- testcases/README.md | 13 +++++++++ tools/README | 1 - tools/README.md | 6 ++++ tools/report/report.jinja | 5 ++++ tools/report/report_foot.rst | 3 ++ tools/report/report_rst.jinja | 9 ++++++ vswitches/README | 6 ---- vswitches/README.md | 11 +++++++ 39 files changed, 241 insertions(+), 80 deletions(-) create mode 100644 docs/configguide/LICENSE create mode 100644 docs/design/LICENSE create mode 100644 docs/requirements/LICENSE create mode 100644 docs/requirements/ietf_draft/LICENSE delete mode 100644 jobs/README create mode 100644 jobs/README.md delete mode 100644 packages.txt delete mode 100644 src/README create mode 100644 src/README.md delete mode 100644 src/mk/README create mode 100644 src/mk/README.md delete mode 100644 systems/README create mode 100644 systems/README.md delete mode 100644 testcases/README create mode 100644 testcases/README.md delete mode 100644 tools/README create mode 100644 tools/README.md delete mode 100644 vswitches/README create mode 100644 vswitches/README.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 91dc6d25..1aa61085 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,3 +1,8 @@ + + # General Coding Style ## Code diff --git a/LICENSE b/LICENSE index eab09245..8523e6a1 100644 --- a/LICENSE +++ b/LICENSE @@ -1,13 +1,13 @@ -Copyright 2015 Open Platform for NFV Project, Inc. and its contributors - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - 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. +Copyright 2015-2017 Open Platform for NFV Project, Inc. and its contributors + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +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/README.md b/README.md index 82c334d3..9edb340d 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,8 @@ + + # VSPERF - vSwitch Performance Tests Documentation for this project including the [installation userguide] is contained diff --git a/docs/configguide/LICENSE b/docs/configguide/LICENSE new file mode 100644 index 00000000..7bc572ce --- /dev/null +++ b/docs/configguide/LICENSE @@ -0,0 +1,2 @@ +This work is licensed under a Creative Commons Attribution 4.0 International License. +http://creativecommons.org/licenses/by/4.0 diff --git a/docs/design/LICENSE b/docs/design/LICENSE new file mode 100644 index 00000000..7bc572ce --- /dev/null +++ b/docs/design/LICENSE @@ -0,0 +1,2 @@ +This work is licensed under a Creative Commons Attribution 4.0 International License. +http://creativecommons.org/licenses/by/4.0 diff --git a/docs/requirements/LICENSE b/docs/requirements/LICENSE new file mode 100644 index 00000000..7bc572ce --- /dev/null +++ b/docs/requirements/LICENSE @@ -0,0 +1,2 @@ +This work is licensed under a Creative Commons Attribution 4.0 International License. +http://creativecommons.org/licenses/by/4.0 diff --git a/docs/requirements/ietf_draft/LICENSE b/docs/requirements/ietf_draft/LICENSE new file mode 100644 index 00000000..7fc9ae14 --- /dev/null +++ b/docs/requirements/ietf_draft/LICENSE @@ -0,0 +1,12 @@ +Copyright (c) 2016 IETF Trust and the persons identified as the +document authors. All rights reserved. + +This document is subject to BCP 78 and the IETF Trust's Legal +Provisions Relating to IETF Documents +(http://trustee.ietf.org/license-info) in effect on the date of +publication of this document. Please review these documents +carefully, as they describe your rights and restrictions with respect +to this document. Code Components extracted from this document must +include Simplified BSD License text as described in Section 4.e of +the Trust Legal Provisions and are provided without warranty as +described in the Simplified BSD License. diff --git a/fuel-plugin-vsperf/README.md b/fuel-plugin-vsperf/README.md index a7dca2c1..5e7e9346 100644 --- a/fuel-plugin-vsperf/README.md +++ b/fuel-plugin-vsperf/README.md @@ -1,3 +1,8 @@ + + fuel-plugin-vsperf ================== diff --git a/fuel-plugin-vsperf/deployment_scripts/deploy.sh b/fuel-plugin-vsperf/deployment_scripts/deploy.sh index 6c82e46d..084d1e3e 100755 --- a/fuel-plugin-vsperf/deployment_scripts/deploy.sh +++ b/fuel-plugin-vsperf/deployment_scripts/deploy.sh @@ -1,4 +1,11 @@ #!/bin/bash +# Copyright (c) 2016-2017 Intel corporation. +# +# 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 + # It's a script which deploys your plugin diff --git a/fuel-plugin-vsperf/deployment_scripts/puppet/manifests/vsperf-install.pp b/fuel-plugin-vsperf/deployment_scripts/puppet/manifests/vsperf-install.pp index 7d075add..d5c9cc9c 100644 --- a/fuel-plugin-vsperf/deployment_scripts/puppet/manifests/vsperf-install.pp +++ b/fuel-plugin-vsperf/deployment_scripts/puppet/manifests/vsperf-install.pp @@ -1,3 +1,10 @@ +# Copyright (c) 2016-2017 Intel corporation. +# +# 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 + $fuel_settings = parseyaml(file('/etc/astute.yaml')) $master_ip = $::fuel_settings['master_ip'] diff --git a/fuel-plugin-vsperf/deployment_tasks.yaml b/fuel-plugin-vsperf/deployment_tasks.yaml index 02a7c56b..d37f1545 100644 --- a/fuel-plugin-vsperf/deployment_tasks.yaml +++ b/fuel-plugin-vsperf/deployment_tasks.yaml @@ -1,3 +1,10 @@ +# Copyright 2016-2017 Intel Corporation. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# http://www.apache.org/licenses/LICENSE-2.0 + - id: vsperf type: group role: [vsperf] diff --git a/fuel-plugin-vsperf/environment_config.yaml b/fuel-plugin-vsperf/environment_config.yaml index e69de29b..5962e8cf 100644 --- a/fuel-plugin-vsperf/environment_config.yaml +++ b/fuel-plugin-vsperf/environment_config.yaml @@ -0,0 +1,6 @@ +# Copyright (c) 2016-2017 Intel corporation. +# +# 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 diff --git a/fuel-plugin-vsperf/node_roles.yaml b/fuel-plugin-vsperf/node_roles.yaml index 0f4f8350..c2370fc7 100644 --- a/fuel-plugin-vsperf/node_roles.yaml +++ b/fuel-plugin-vsperf/node_roles.yaml @@ -1,3 +1,10 @@ +# Copyright (c) 2016-2017 Intel corporation. +# +# 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 + vsperf: name: "VSPERF" description: "Install VSPERF on nodes with this role" diff --git a/fuel-plugin-vsperf/pre_build_hook b/fuel-plugin-vsperf/pre_build_hook index b4da204f..ea7bc206 100755 --- a/fuel-plugin-vsperf/pre_build_hook +++ b/fuel-plugin-vsperf/pre_build_hook @@ -1,5 +1,12 @@ #!/bin/bash +# Copyright (c) 2016-2017 Intel corporation. +# +# 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 + # Add here any the actions which are required before plugin build # like packages building, packages downloading from mirrors and so on. # The script should return 0 if there were no errors. diff --git a/fuel-plugin-vsperf/tasks.yaml b/fuel-plugin-vsperf/tasks.yaml index fe51488c..c7f81214 100644 --- a/fuel-plugin-vsperf/tasks.yaml +++ b/fuel-plugin-vsperf/tasks.yaml @@ -1 +1,8 @@ +# Copyright (c) 2016-2017 Intel corporation. +# +# 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 + [] diff --git a/fuel-plugin-vsperf/vagrant/README.md b/fuel-plugin-vsperf/vagrant/README.md index fa0fd823..c979e783 100644 --- a/fuel-plugin-vsperf/vagrant/README.md +++ b/fuel-plugin-vsperf/vagrant/README.md @@ -1,3 +1,8 @@ + + Build fuel plugin ================== diff --git a/fuel-plugin-vsperf/vagrant/Vagrantfile b/fuel-plugin-vsperf/vagrant/Vagrantfile index d83ac4cc..78128e8b 100644 --- a/fuel-plugin-vsperf/vagrant/Vagrantfile +++ b/fuel-plugin-vsperf/vagrant/Vagrantfile @@ -1,4 +1,11 @@ -# -*- mode: ruby -*- +# Copyright (c) 2016-2017 Intel corporation. +# +# 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 + +# # -*- mode: ruby -*- # vi: set ft=ruby : # Vagrantfile API/syntax version. Don't touch unless you know what you're doing! diff --git a/fuel-plugin-vsperf/vagrant/build_fuel_plugin.sh b/fuel-plugin-vsperf/vagrant/build_fuel_plugin.sh index 80fc3353..cd3e6226 100755 --- a/fuel-plugin-vsperf/vagrant/build_fuel_plugin.sh +++ b/fuel-plugin-vsperf/vagrant/build_fuel_plugin.sh @@ -1,4 +1,12 @@ #!/bin/bash + +# Copyright (c) 2016-2017 Intel corporation. +# +# 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 + sudo apt-get update -y sudo apt-get install -y ruby-dev rubygems-integration python-pip rpm createrepo dpkg-dev sudo gem install fpm diff --git a/jobs/README b/jobs/README deleted file mode 100644 index 9620ca97..00000000 --- a/jobs/README +++ /dev/null @@ -1 +0,0 @@ -This folder contains frequently used test configurations diff --git a/jobs/README.md b/jobs/README.md new file mode 100644 index 00000000..affed7cd --- /dev/null +++ b/jobs/README.md @@ -0,0 +1,6 @@ + + +This folder contains frequently used test configurations diff --git a/onboarding.txt b/onboarding.txt index a6a7fcc1..9fa742b2 100644 --- a/onboarding.txt +++ b/onboarding.txt @@ -1,3 +1,6 @@ +# This work is licensed under a Creative Commons Attribution 4.0 International License. +# http://creativecommons.org/licenses/by/4.0 + Get on board by filling this out and submitting it for review. This is all optional, it's just to give you a taste of the workflow. diff --git a/packages.txt b/packages.txt deleted file mode 100644 index 7d68021d..00000000 --- a/packages.txt +++ /dev/null @@ -1,9 +0,0 @@ -python33-* -pciutils -gcc -zlib -zlib-devel -glib2-devel -pixman-devel -socat -sysstat diff --git a/requirements.txt b/requirements.txt index fb8f1b02..80d72a96 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,10 @@ +# Copyright (c) 2015-2017 Intel corporation. +# +# 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 + pexpect==3.3 tox==1.8.1 jinja2==2.7.3 @@ -6,3 +13,4 @@ requests==2.8.1 netaddr==0.7.18 scapy-python3==0.18 distro +======= diff --git a/src/README b/src/README deleted file mode 100644 index 0492fa1d..00000000 --- a/src/README +++ /dev/null @@ -1,29 +0,0 @@ -### Purpose of this folder - Quickview - -1. contains place holders for upstream source code package. -2. manages the package dependency -3. provides simple one-button build for test developers - -### Motivation Explained - -There are multiple goals for the project vswitch performance characterization. -First, it is a generic test framework that can be used to characterize any vswitch solution. -Second, it is to be as CI tool to validate any change during development. - -For the first goal, it would be nice to get all the relevant upstream source package and -to provide a easy build environment for a given test developer. Obviously we don't want to -rewrite the makefile system from upstream project. However we need to add a wrapper to the -individual packages to manage package dependecy. For example, to test ovs-dpdk vswitch solution, -the build of ovs would depend on the build result of dpdk. -This dependency is never explicitly specified in the individual package. - -For the second goal as a CI tool, it may not be needed to pull the upstream package. -So this whole folder can be ignored. - -### Files and subfolders - -* package-list: contains list of packages and their associated tags -* mk: contains top level makefiles -* dpdk: place holder for dpdk package -* ovs: place holder for ovs package. -* l2fwd: simple l2 forwarding kernel module diff --git a/src/README.md b/src/README.md new file mode 100644 index 00000000..0aeea04f --- /dev/null +++ b/src/README.md @@ -0,0 +1,34 @@ + + +### Purpose of this folder - Quickview + +1. contains place holders for upstream source code package. +2. manages the package dependency +3. provides simple one-button build for test developers + +### Motivation Explained + +There are multiple goals for the project vswitch performance characterization. +First, it is a generic test framework that can be used to characterize any vswitch solution. +Second, it is to be as CI tool to validate any change during development. + +For the first goal, it would be nice to get all the relevant upstream source package and +to provide a easy build environment for a given test developer. Obviously we don't want to +rewrite the makefile system from upstream project. However we need to add a wrapper to the +individual packages to manage package dependecy. For example, to test ovs-dpdk vswitch solution, +the build of ovs would depend on the build result of dpdk. +This dependency is never explicitly specified in the individual package. + +For the second goal as a CI tool, it may not be needed to pull the upstream package. +So this whole folder can be ignored. + +### Files and subfolders + +* package-list: contains list of packages and their associated tags +* mk: contains top level makefiles +* dpdk: place holder for dpdk package +* ovs: place holder for ovs package. +* l2fwd: simple l2 forwarding kernel module diff --git a/src/mk/README b/src/mk/README deleted file mode 100644 index 52f83600..00000000 --- a/src/mk/README +++ /dev/null @@ -1,3 +0,0 @@ - -This folder contains top level makefile defintions - diff --git a/src/mk/README.md b/src/mk/README.md new file mode 100644 index 00000000..6d39f2b2 --- /dev/null +++ b/src/mk/README.md @@ -0,0 +1,7 @@ + + +This folder contains top level makefile defintions + diff --git a/src/package-list.mk b/src/package-list.mk index 6eb43b8b..9334cd8e 100644 --- a/src/package-list.mk +++ b/src/package-list.mk @@ -1,3 +1,10 @@ +# Copyright (c) 2016-2017 Intel corporation. +# +# 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 +# # Upstream Package List # # Everything here is defined as its suggested default diff --git a/systems/README b/systems/README deleted file mode 100644 index 14967107..00000000 --- a/systems/README +++ /dev/null @@ -1,9 +0,0 @@ -This folder abstract out details among linux distros. - -One time setup: ---------------- - -On a freshly built system, run the following with a super user privilege -or with password less sudo access. - -./build_base_machine.sh diff --git a/systems/README.md b/systems/README.md new file mode 100644 index 00000000..d72aae65 --- /dev/null +++ b/systems/README.md @@ -0,0 +1,14 @@ + + +This folder abstract out details among linux distros. + +One time setup: +--------------- + +On a freshly built system, run the following with a super user privilege +or with password less sudo access. + +./build_base_machine.sh diff --git a/testcases/README b/testcases/README deleted file mode 100644 index be6ffae2..00000000 --- a/testcases/README +++ /dev/null @@ -1,8 +0,0 @@ -### This folder contains various test cases for performance test. - -* P2P: packets flow from PHY -> vSwitch -> PHY -* P2V: packets flow from PHY -> vSwitch -> VNF -* V2V: packets flow from VNF -> vSwitch -> VNF -* V2P: packets flow from VNF -> vSwitch -> PHY -* PVP: pakcets flow from PHY -> vSwitch -> VNF -> vSwitch -> PHY -* PVVP: packets flow from PHY -> vSwitch -> VNF -> vswitch -> VNF -> vSwitch -> PHY diff --git a/testcases/README.md b/testcases/README.md new file mode 100644 index 00000000..9a1eec49 --- /dev/null +++ b/testcases/README.md @@ -0,0 +1,13 @@ + + +### This folder contains various test cases for performance test. + +* P2P: packets flow from PHY -> vSwitch -> PHY +* P2V: packets flow from PHY -> vSwitch -> VNF +* V2V: packets flow from VNF -> vSwitch -> VNF +* V2P: packets flow from VNF -> vSwitch -> PHY +* PVP: pakcets flow from PHY -> vSwitch -> VNF -> vSwitch -> PHY +* PVVP: packets flow from PHY -> vSwitch -> VNF -> vswitch -> VNF -> vSwitch -> PHY diff --git a/tools/README b/tools/README deleted file mode 100644 index a10c2bb3..00000000 --- a/tools/README +++ /dev/null @@ -1 +0,0 @@ -This folder contains various tool sets for vswitch performance diff --git a/tools/README.md b/tools/README.md new file mode 100644 index 00000000..dc00eac8 --- /dev/null +++ b/tools/README.md @@ -0,0 +1,6 @@ + + +This folder contains various tool sets for vswitch performance diff --git a/tools/report/report.jinja b/tools/report/report.jinja index c9588565..90cd43d7 100644 --- a/tools/report/report.jinja +++ b/tools/report/report.jinja @@ -1,3 +1,8 @@ +{# +This work is licensed under a Creative Commons Attribution 4.0 International License. +http://creativecommons.org/licenses/by/4.0 +#} + # CHARACTERIZE VSWITCH PERFORMANCE FOR TELCO NFV USE CASES LEVEL TEST REPORT ## Table of Contents diff --git a/tools/report/report_foot.rst b/tools/report/report_foot.rst index f0e51876..5045e186 100644 --- a/tools/report/report_foot.rst +++ b/tools/report/report_foot.rst @@ -1,3 +1,6 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + http://creativecommons.org/licenses/by/4.0 + .. _rationale: Rationale for decisions diff --git a/tools/report/report_rst.jinja b/tools/report/report_rst.jinja index 545dd493..e2cb4c83 100644 --- a/tools/report/report_rst.jinja +++ b/tools/report/report_rst.jinja @@ -1,3 +1,12 @@ +{# + Copyright (c) 2016-2017 Intel corporation. + + 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 +#} + Test ID: {{ tests[0].ID }} -------------------------- diff --git a/vswitches/README b/vswitches/README deleted file mode 100644 index 5af284ec..00000000 --- a/vswitches/README +++ /dev/null @@ -1,6 +0,0 @@ -This folder contains various vswitches to be tested - -Required API for each vswitch: - add_switch - add_port - add_flow diff --git a/vswitches/README.md b/vswitches/README.md new file mode 100644 index 00000000..ea1e11fb --- /dev/null +++ b/vswitches/README.md @@ -0,0 +1,11 @@ + + +This folder contains various vswitches to be tested + +Required API for each vswitch: + add_switch + add_port + add_flow -- cgit 1.2.3-korg