summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--.gitignore4
-rw-r--r--.gitlab-ci.yml12
-rw-r--r--.gitmodules252
-rw-r--r--.readthedocs.yml15
-rw-r--r--CODEOWNERS3
-rw-r--r--INFO1
-rw-r--r--INFO.yaml48
-rw-r--r--docs/_static/android-chrome-192x192.pngbin0 -> 12272 bytes
-rw-r--r--docs/_static/android-chrome-512x512.pngbin0 -> 54593 bytes
-rw-r--r--docs/_static/anuket-logo.pngbin0 -> 8612 bytes
-rw-r--r--docs/_static/apple-touch-icon.pngbin0 -> 10775 bytes
-rw-r--r--docs/_static/custom.css66
-rw-r--r--docs/_static/favicon-16x16.pngbin0 -> 425 bytes
-rw-r--r--docs/_static/favicon-32x32.pngbin0 -> 1003 bytes
-rw-r--r--[-rwxr-xr-x]docs/_static/favicon.icobin15086 -> 15406 bytes
-rw-r--r--docs/_static/images/OPNFV_testing_group.pngbin87295 -> 0 bytes
-rw-r--r--docs/_static/images/opnfvplatformgraphic.pngbin136767 -> 0 bytes
-rw-r--r--docs/_static/site.webmanifest1
-rw-r--r--docs/_templates/layout.html9
-rw-r--r--docs/_templates/my_custom_sidebar.html2
-rw-r--r--docs/conf.py354
-rw-r--r--docs/development/opnfvsecguide/audit.rst2
-rw-r--r--docs/development/opnfvsecguide/audit/audit_reqs.rst1
-rw-r--r--docs/development/opnfvsecguide/compute/trust.rst2
-rw-r--r--docs/development/scenario/featurematrix.rst39
-rw-r--r--docs/development/scenario/scenariointro.rst13
-rw-r--r--docs/development/scenario/scenariomatrix.rst100
-rw-r--r--docs/development/scenario/scenariovalidation.rst0
-rw-r--r--docs/featureprojects.rst255
-rw-r--r--docs/glossary/index.rst173
-rw-r--r--docs/how-to-use-docs/documentation-guide.rst88
-rw-r--r--docs/how-to-use-docs/files/build.yaml12
-rw-r--r--docs/how-to-use-docs/files/conf.py1
-rw-r--r--docs/how-to-use-docs/files/conf.yaml3
-rw-r--r--docs/how-to-use-docs/files/index (renamed from docs/infrastructure/hardware-infrastructure.rst)18
-rw-r--r--docs/how-to-use-docs/files/index.rst18
-rw-r--r--docs/how-to-use-docs/files/requirements.txt5
-rw-r--r--docs/how-to-use-docs/files/tox.ini17
-rw-r--r--docs/how-to-use-docs/include-documentation.rst38
-rw-r--r--docs/images/Anuket-structure.pngbin0 -> 70241 bytes
-rw-r--r--docs/images/Anuket-structure.pptxbin0 -> 56916 bytes
-rw-r--r--docs/images/diagram_euphrates.pngbin234411 -> 0 bytes
-rw-r--r--docs/images/diagram_fraser.pngbin0 -> 159200 bytes
-rw-r--r--docs/images/gambia.pngbin0 -> 156776 bytes
-rw-r--r--docs/images/hunter.pngbin0 -> 100573 bytes
-rw-r--r--docs/index.rst128
-rw-r--r--docs/infrastructure/ci.rst4
-rw-r--r--docs/infrastructure/gce-machines.rst131
-rw-r--r--docs/infrastructure/overview.rst60
-rw-r--r--docs/infrastructure/software-infrastructure.rst11
-rw-r--r--docs/infrastructure/xci.rst16
-rw-r--r--docs/release/installation.introduction.rst107
-rw-r--r--docs/release/overview.rst74
-rw-r--r--docs/release/release-notes.rst49
-rw-r--r--docs/release/subrelease.rst40
-rw-r--r--docs/release/userguide.introduction.rst110
-rw-r--r--docs/requirements.txt6
m---------docs/submodules/apex0
m---------docs/submodules/armband0
m---------docs/submodules/auto0
m---------docs/submodules/availability0
m---------docs/submodules/barometer0
m---------docs/submodules/bottlenecks0
m---------docs/submodules/calipso0
m---------docs/submodules/clover0
m---------docs/submodules/compass4nfv0
m---------docs/submodules/container4nfv0
m---------docs/submodules/copper0
m---------docs/submodules/daisy0
m---------docs/submodules/doctor0
m---------docs/submodules/domino0
m---------docs/submodules/dovetail0
m---------docs/submodules/escalator0
m---------docs/submodules/fastpathmetrics0
m---------docs/submodules/fds0
m---------docs/submodules/fuel0
m---------docs/submodules/functest0
m---------docs/submodules/ipv60
m---------docs/submodules/joid0
m---------docs/submodules/kvmfornfv0
m---------docs/submodules/moon0
m---------docs/submodules/multisite0
m---------docs/submodules/netready0
m---------docs/submodules/nfvbench0
m---------docs/submodules/octopus0
m---------docs/submodules/onosfw0
m---------docs/submodules/opera0
m---------docs/submodules/orchestra0
m---------docs/submodules/ovn4nfv0
m---------docs/submodules/ovno0
m---------docs/submodules/ovsnfv0
m---------docs/submodules/parser0
m---------docs/submodules/pharos0
m---------docs/submodules/promise0
m---------docs/submodules/qtip0
m---------docs/submodules/releng0
m---------docs/submodules/releng-xci0
m---------docs/submodules/samplevnf0
m---------docs/submodules/sdnvpn0
m---------docs/submodules/sfc0
m---------docs/submodules/snaps0
m---------docs/submodules/stor4nfv0
m---------docs/submodules/storperf0
m---------docs/submodules/ves0
m---------docs/submodules/vnf_forwarding_graph0
m---------docs/submodules/vswitchperf0
m---------docs/submodules/yardstick0
-rw-r--r--docs/testing/developer/devguide/dev-guide.rst144
-rw-r--r--docs/testing/developer/devguide/index.rst3
-rw-r--r--docs/testing/ecosystem/energy-monitoring.rst260
-rw-r--r--docs/testing/ecosystem/index.rst1
-rw-r--r--docs/testing/ecosystem/overview.rst201
-rw-r--r--docs/testing/testing-dev.rst41
-rw-r--r--docs/testing/testing-user.rst62
-rw-r--r--etc/requirements.txt8
-rw-r--r--opnfv-theme/MANIFEST.in2
-rw-r--r--opnfv-theme/README.rst20
-rw-r--r--opnfv-theme/setup.py18
-rw-r--r--opnfv-theme/sphinx_opnfv_theme/__init__.py3
-rw-r--r--opnfv-theme/sphinx_opnfv_theme/layout.html (renamed from opnfv-theme/sphinx_opnfv_theme/opnfv/layout.html)0
-rw-r--r--opnfv-theme/sphinx_opnfv_theme/my_custom_sidebar.html (renamed from opnfv-theme/sphinx_opnfv_theme/opnfv/my_custom_sidebar.html)0
-rwxr-xr-xopnfv-theme/sphinx_opnfv_theme/opnfv/static/favicon.icobin15086 -> 0 bytes
-rw-r--r--opnfv-theme/sphinx_opnfv_theme/opnfv/static/logo.pngbin2829 -> 0 bytes
-rw-r--r--opnfv-theme/sphinx_opnfv_theme/opnfv/static/my-styles.css33
-rw-r--r--opnfv-theme/sphinx_opnfv_theme/relations.html (renamed from opnfv-theme/sphinx_opnfv_theme/opnfv/relations.html)0
-rwxr-xr-xopnfv-theme/sphinx_opnfv_theme/static/favicon.icobin0 -> 11741 bytes
-rw-r--r--opnfv-theme/sphinx_opnfv_theme/static/logo.pngbin0 -> 8991 bytes
-rw-r--r--opnfv-theme/sphinx_opnfv_theme/static/my-styles.css (renamed from docs/_static/my-styles.css)0
-rw-r--r--opnfv-theme/sphinx_opnfv_theme/theme.conf (renamed from opnfv-theme/sphinx_opnfv_theme/opnfv/theme.conf)0
-rw-r--r--tox.ini6
130 files changed, 929 insertions, 2161 deletions
diff --git a/.gitignore b/.gitignore
index 7c4785069..f0b2bd26a 100644
--- a/.gitignore
+++ b/.gitignore
@@ -3,4 +3,6 @@
/docs_build/
/docs/projects/
/docs_output/
-/releng/ \ No newline at end of file
+/releng/
+.tox
+docs/_build/*
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
new file mode 100644
index 000000000..f69a91bca
--- /dev/null
+++ b/.gitlab-ci.yml
@@ -0,0 +1,12 @@
+# Docs jobs
+#
+# On Merge requests, tags and merges:
+# - Run tox
+# - Build documentation
+# On Merges and Pull Requests:
+# - Run code quality analysis
+---
+include:
+ - template: Jobs/Code-Quality.gitlab-ci.yml
+ - project: anuket/releng
+ file: '/gitlab-templates/RTD.gitlab-ci.yml'
diff --git a/.gitmodules b/.gitmodules
index 846ab2455..e69de29bb 100644
--- a/.gitmodules
+++ b/.gitmodules
@@ -1,252 +0,0 @@
-[submodule "docs/submodules/apex"]
- path = docs/submodules/apex
- url = ../apex
- branch = .
- ignore = dirty
-[submodule "docs/submodules/armband"]
- path = docs/submodules/armband
- url = ../armband
- branch = .
- ignore = dirty
-[submodule "docs/submodules/auto"]
- path = docs/submodules/auto
- url = ../auto
- branch = .
- ignore = dirty
-[submodule "docs/submodules/bottlenecks"]
- path = docs/submodules/bottlenecks
- url = ../bottlenecks
- branch = .
- ignore = dirty
-[submodule "docs/submodules/compass4nfv"]
- path = docs/submodules/compass4nfv
- url = ../compass4nfv
- branch = .
- ignore = dirty
-[submodule "docs/submodules/container4nfv"]
- path = docs/submodules/container4nfv
- url = https://gerrit.opnfv.org/gerrit/container4nfv
- branch = .
- ignore = dirty
-[submodule "docs/submodules/copper"]
- path = docs/submodules/copper
- url = ../copper
- branch = .
- ignore = dirty
-[submodule "docs/submodules/daisy"]
- path = docs/submodules/daisy
- url = ../daisy
- branch = .
- ignore = dirty
-[submodule "docs/submodules/domino"]
- path = docs/submodules/domino
- url = ../domino
- branch = .
- ignore = dirty
-[submodule "docs/submodules/dovetail"]
- path = docs/submodules/dovetail
- url = ../dovetail
- branch = .
- ignore = dirty
-[submodule "docs/submodules/escalator"]
- path = docs/submodules/escalator
- url = ../escalator
- branch = .
- ignore = dirty
-[submodule "docs/submodules/fastpathmetrics"]
- path = docs/submodules/fastpathmetrics
- url = ../fastpathmetrics
- branch = .
- ignore = dirty
-[submodule "docs/submodules/fds"]
- path = docs/submodules/fds
- url = ../fds
- branch = .
- ignore = dirty
-[submodule "docs/submodules/fuel"]
- path = docs/submodules/fuel
- url = ../fuel
- branch = .
- ignore = dirty
-[submodule "docs/submodules/functest"]
- path = docs/submodules/functest
- url = ../functest
- branch = .
- ignore = dirty
-[submodule "docs/submodules/ipv6"]
- path = docs/submodules/ipv6
- url = ../ipv6
- branch = .
- ignore = dirty
-[submodule "docs/submodules/joid"]
- path = docs/submodules/joid
- url = ../joid
- branch = .
- ignore = dirty
-[submodule "docs/submodules/kvmfornfv"]
- path = docs/submodules/kvmfornfv
- url = ../kvmfornfv
- branch = .
- ignore = dirty
-[submodule "docs/submodules/multisite"]
- path = docs/submodules/multisite
- url = ../multisite
- branch = .
- ignore = dirty
-[submodule "docs/submodules/netready"]
- path = docs/submodules/netready
- url = ../netready
- branch = .
- ignore = dirty
-[submodule "docs/submodules/nfvbench"]
- path = docs/submodules/nfvbench
- url = https://gerrit.opnfv.org/gerrit/nfvbench
- branch = .
- ignore = dirty
-[submodule "docs/submodules/octopus"]
- path = docs/submodules/octopus
- url = ../octopus
- branch = .
- ignore = dirty
-[submodule "docs/submodules/onosfw"]
- path = docs/submodules/onosfw
- url = ../onosfw
- branch = .
- ignore = dirty
-[submodule "docs/submodules/orchestra"]
- path = docs/submodules/orchestra
- url = https://gerrit.opnfv.org/gerrit/orchestra
- branch = .
- ignore = dirty
-[submodule "docs/submodules/ovn4nfv"]
- path = docs/submodules/ovn4nfv
- url = https://gerrit.opnfv.org/gerrit/ovn4nfv
- branch = .
- ignore = dirty
-[submodule "docs/submodules/ovsnfv"]
- path = docs/submodules/ovsnfv
- url = ../ovsnfv
- branch = .
- ignore = dirty
-[submodule "docs/submodules/parser"]
- path = docs/submodules/parser
- url = ../parser
- branch = .
- ignore = dirty
-[submodule "docs/submodules/pharos"]
- path = docs/submodules/pharos
- url = ../pharos
- branch = .
- ignore = dirty
-[submodule "docs/submodules/promise"]
- path = docs/submodules/promise
- url = ../promise
- branch = .
- ignore = dirty
-[submodule "docs/submodules/qtip"]
- path = docs/submodules/qtip
- url = ../qtip
- branch = .
- ignore = dirty
-[submodule "docs/submodules/releng"]
- path = docs/submodules/releng
- url = ../releng
- branch = master
-[submodule "docs/submodules/sdnvpn"]
- path = docs/submodules/sdnvpn
- url = ../sdnvpn
- branch = .
- ignore = dirty
-[submodule "docs/submodules/sfc"]
- path = docs/submodules/sfc
- url = ../sfc
- branch = .
- ignore = dirty
-[submodule "docs/submodules/storperf"]
- path = docs/submodules/storperf
- url = ../storperf
- branch = .
- ignore = dirty
-[submodule "docs/submodules/stor4nfv"]
- path = docs/submodules/stor4nfv
- url = ../stor4nfv
- branch = .
- ignore = dirty
-[submodule "docs/submodules/ves"]
- path = docs/submodules/ves
- url = ../ves
- branch = .
- ignore = dirty
-[submodule "docs/submodules/vnf_forwarding_graph"]
- path = docs/submodules/vnf_forwarding_graph
- url = ../vnf_forwarding_graph
- branch = .
- ignore = dirty
-[submodule "docs/submodules/vswitchperf"]
- path = docs/submodules/vswitchperf
- url = ../vswitchperf
- branch = .
- ignore = dirty
-[submodule "docs/submodules/yardstick"]
- path = docs/submodules/yardstick
- url = ../yardstick
- branch = .
- ignore = dirty
-[submodule "docs/submodules/doctor"]
- path = docs/submodules/doctor
- url = ../doctor
- branch = .
- ignore = dirty
-[submodule "docs/submodules/availability"]
- path = docs/submodules/availability
- url = ../availability
- branch = .
- ignore = dirty
-[submodule "docs/submodules/opera"]
- path = docs/submodules/opera
- url = ../opera
- branch = .
- ignore = dirty
-[submodule "docs/submodules/samplevnf"]
- path = docs/submodules/samplevnf
- url = ../samplevnf
- branch = .
- ignore = dirty
-[submodule "docs/submodules/snaps"]
- path = docs/submodules/snaps
- url = ../snaps
- branch = .
- ignore = dirty
-[submodule "docs/submodules/barometer"]
- path = docs/submodules/barometer
- url = ../barometer
- branch = .
- ignore = dirty
-[submodule "docs/submodules/releng-xci"]
- path = docs/submodules/releng-xci
- url = ../releng-xci
- branch = .
- ignore = dirty
-[submodule "docs/submodules/ovno"]
- path = docs/submodules/ovno
- url = https://gerrit.opnfv.org/gerrit/ovno
- branch = .
- ignore = dirty
-[submodule "docs/submodules/moon"]
- path = docs/submodules/moon
- url = ../moon
- branch = .
- ignore = dirty
-[submodule "docs/submodules/calipso"]
- path = docs/submodules/calipso
- url = https://gerrit.opnfv.org/gerrit/calipso
- branch = .
- ignore = dirty
-[submodule "docs/submodules/stor4nfv"]
- path = docs/submodules/stor4nfv
- url = https://gerrit.opnfv.org/gerrit/stor4nfv
-[submodule "docs/submodules/clover"]
- path = docs/submodules/clover
- url = https://gerrit.opnfv.org/gerrit/clover
- branch = .
- ignore = dirty
diff --git a/.readthedocs.yml b/.readthedocs.yml
new file mode 100644
index 000000000..e24c07619
--- /dev/null
+++ b/.readthedocs.yml
@@ -0,0 +1,15 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+---
+version: 2
+
+sphinx:
+ configuration: docs/conf.py
+
+submodules:
+ exclude: all
+
+python:
+ version: 3.7
+ install:
+ - requirements: docs/requirements.txt
diff --git a/CODEOWNERS b/CODEOWNERS
new file mode 100644
index 000000000..81cc120d9
--- /dev/null
+++ b/CODEOWNERS
@@ -0,0 +1,3 @@
+README.md @acmacm
+
+docs/*.rst @acmacm
diff --git a/INFO b/INFO
index 5c3cdd868..13e902a88 100644
--- a/INFO
+++ b/INFO
@@ -16,6 +16,7 @@ fatih.degirmenci@ericsson.com
Iben.Rodriguez@spirent.com
r-mibu@cq.jp.nec.com
sofia.wallin@ericsson.com
+tbramwell@linuxfoundation.org
Link to TSC approval of the project: http://ircbot.wl.linuxfoundation.org/meetings/opnfv-meeting/2015/opnfv-meeting.2015-03-31-13.56.html
Link(s) to approval of additional committers:
diff --git a/INFO.yaml b/INFO.yaml
index eb32801bd..3c8d87fc4 100644
--- a/INFO.yaml
+++ b/INFO.yaml
@@ -4,10 +4,10 @@ project_creation_date: 'March 31, 2015'
project_category: 'Documentation'
lifecycle_state: 'Incubation'
project_lead: &opnfv_opnfvdocs_ptl
- name: 'Sofia Wallin'
- email: 'sofia.wallin@ericsson.com'
- id: 'sofiawallin'
- company: 'ericsson.com'
+ name: 'Beth Cohen'
+ email: 'beth.cohen@verizon.com'
+ id: 'bfcohen'
+ company: 'verizon'
timezone: 'Unknown'
primary_contact: *opnfv_opnfvdocs_ptl
issue_tracking:
@@ -34,19 +34,33 @@ repositories:
- 'opnfvdocs'
committers:
- <<: *opnfv_opnfvdocs_ptl
- - name: 'Christopher Price'
- email: 'christopher.price@est.tech'
- company: 'est.tech'
- id: 'ChristopherPrice'
- - name: 'Fatih Degirmenci'
- email: 'fdegir@gmail.com'
- company: 'gmail.com'
- id: 'fdegir'
- - name: 'Ryota Mibu'
- email: 'r-mibu@cq.jp.nec.com'
- company: 'cq.jp.nec.com'
- id: 'r-mibu'
+ - name: 'Scot Steele'
+ email: 'scotsteele@microsoft.com'
+ company: 'Microsoft'
+ id: 'ss8171'
+ - name: 'Gergely Csatari'
+ email: 'gergely.csatari@nokia.com'
+ company: 'Nokia'
+ id: 'csatari'
+ - name: 'Al Morton'
+ email: 'acmorton@att.com'
+ company: 'AT&T'
+ id: 'acm'
+ - name: 'Georg Kunz'
+ email: 'georg.kunz@ericsson.com'
+ id: 'georgkunz'
+ company: 'Ericsson'
tsc:
# yamllint disable rule:line-length
approval: 'http//ircbot.wl.linuxfoundation.org/meetings/opnfv-meeting/2015/opnfv-meeting.2015-03-31-13.56.html'
- # yamllint enable rule:line-length
+ changes:
+ - type: 'removal'
+ name: 'Sofia Wallin'
+ link: 'https://lists.anuket.io/g/anuket-tsc/message/118'
+ - type: 'promotion'
+ name: 'Beth Cohen'
+ link: 'https://wiki.anuket.io/display/HOME/2021-05-25+TSC+Agenda+and+Minutes'
+ - type: 'promotion'
+ name: 'Scot Steele'
+ link: 'https://wiki.anuket.io/display/HOME/2021-05-25+TSC+Agenda+and+Minutes'
+ # yamllint enable rule:line-length
diff --git a/docs/_static/android-chrome-192x192.png b/docs/_static/android-chrome-192x192.png
new file mode 100644
index 000000000..74c81a35d
--- /dev/null
+++ b/docs/_static/android-chrome-192x192.png
Binary files differ
diff --git a/docs/_static/android-chrome-512x512.png b/docs/_static/android-chrome-512x512.png
new file mode 100644
index 000000000..d6b7457ba
--- /dev/null
+++ b/docs/_static/android-chrome-512x512.png
Binary files differ
diff --git a/docs/_static/anuket-logo.png b/docs/_static/anuket-logo.png
new file mode 100644
index 000000000..fe256a64a
--- /dev/null
+++ b/docs/_static/anuket-logo.png
Binary files differ
diff --git a/docs/_static/apple-touch-icon.png b/docs/_static/apple-touch-icon.png
new file mode 100644
index 000000000..9cfaf49e0
--- /dev/null
+++ b/docs/_static/apple-touch-icon.png
Binary files differ
diff --git a/docs/_static/custom.css b/docs/_static/custom.css
new file mode 100644
index 000000000..46c961617
--- /dev/null
+++ b/docs/_static/custom.css
@@ -0,0 +1,66 @@
+/* Changing the color of top navbar in piccolo */
+div#top_nav nav {
+ background-color: #16326c;
+ padding:0.5rem;
+}
+
+/* Changing the size of the logo in the top navbar in piccolo */
+div#top_nav nav h1 img {
+ height: 2rem;
+}
+
+/* Changing the margin of the main text in piccolo */
+div.document {
+ margin-left: 10rem;
+ margin-right: 20rem;
+}
+
+/* Changing link color in piccolo */
+a {
+ color: #007574ff;
+}
+
+/* Changing link color in the left sidebar in piccolo */
+div.sphinxsidebar ul li a.current {
+ color: #007574ff;
+}
+
+/* Changing the hover color in the left sidebar in piccolo */
+div.sphinxsidebar ul li a:hover {
+ color: #007574ff;
+}
+
+/* Changing the hover color in the right sidebar in piccolo */
+div#right_sidebar ul li a:hover {
+ color: #007574ff;
+}
+
+/* Changing the color of the > icon next to Page contents */
+div#right_sidebar p span.icon {
+ color: #007574ff;
+}
+
+/* Changing the color of the Page contents title */
+div#right_sidebar p span {
+ color: #007574ff;
+}
+
+/* Changing the color of the search button */
+div.document form input[type=submit], div.document form button {
+ background-color: #16326c;
+}
+
+/* Changing the color of the Search text in the Search button */
+div#searchbox form.search input[type="submit"] {
+ color: #16326c;
+}
+
+/* Changing the color of the > icon next to the collapsed Page contents */
+div#show_right_sidebar p span.icon {
+ color: rgba(0, 0, 0, 0.6);
+}
+
+/* Removing option to switch to dark mode */
+div#top_nav nav a#mode_toggle, div#top_nav nav a#source_link {
+ display: none;
+} \ No newline at end of file
diff --git a/docs/_static/favicon-16x16.png b/docs/_static/favicon-16x16.png
new file mode 100644
index 000000000..fa55f39ca
--- /dev/null
+++ b/docs/_static/favicon-16x16.png
Binary files differ
diff --git a/docs/_static/favicon-32x32.png b/docs/_static/favicon-32x32.png
new file mode 100644
index 000000000..e2cccffa3
--- /dev/null
+++ b/docs/_static/favicon-32x32.png
Binary files differ
diff --git a/docs/_static/favicon.ico b/docs/_static/favicon.ico
index bbe55ab40..3d410f6e9 100755..100644
--- a/docs/_static/favicon.ico
+++ b/docs/_static/favicon.ico
Binary files differ
diff --git a/docs/_static/images/OPNFV_testing_group.png b/docs/_static/images/OPNFV_testing_group.png
deleted file mode 100644
index 4b8c2c053..000000000
--- a/docs/_static/images/OPNFV_testing_group.png
+++ /dev/null
Binary files differ
diff --git a/docs/_static/images/opnfvplatformgraphic.png b/docs/_static/images/opnfvplatformgraphic.png
deleted file mode 100644
index 9d6074f02..000000000
--- a/docs/_static/images/opnfvplatformgraphic.png
+++ /dev/null
Binary files differ
diff --git a/docs/_static/site.webmanifest b/docs/_static/site.webmanifest
new file mode 100644
index 000000000..45dc8a206
--- /dev/null
+++ b/docs/_static/site.webmanifest
@@ -0,0 +1 @@
+{"name":"","short_name":"","icons":[{"src":"/android-chrome-192x192.png","sizes":"192x192","type":"image/png"},{"src":"/android-chrome-512x512.png","sizes":"512x512","type":"image/png"}],"theme_color":"#ffffff","background_color":"#ffffff","display":"standalone"} \ No newline at end of file
diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html
index 975cd9813..7a1cf9fe6 100644
--- a/docs/_templates/layout.html
+++ b/docs/_templates/layout.html
@@ -2,4 +2,11 @@
{% extends "!layout.html" %}
{# Custom CSS overrides #}
-{% set css_files = css_files + ['_static/my-styles.css'] %}
+{% set css_files = css_files + ['_static/custom.css'] %}
+
+{%- block extrahead %}
+{# Add custom things to the head HTML tag #}
+{# Call the parent block #}
+
+{{ super() }}
+{%- endblock %} \ No newline at end of file
diff --git a/docs/_templates/my_custom_sidebar.html b/docs/_templates/my_custom_sidebar.html
index 6b259bc93..1d0dfac5a 100644
--- a/docs/_templates/my_custom_sidebar.html
+++ b/docs/_templates/my_custom_sidebar.html
@@ -1,3 +1,3 @@
<ul class="globaltoc">
{{ toctree(maxdepth=theme_globaltoc_depth|toint, collapse=False,includehidden=theme_globaltoc_includehidden|tobool) }}
-</ul> \ No newline at end of file
+</ul>
diff --git a/docs/conf.py b/docs/conf.py
index 9d9f28168..d875acb7c 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -1,40 +1,18 @@
-import sphinx_bootstrap_theme
-import os
-
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-# -- General configuration ------------------------------------------------
-
-# If your documentation needs a minimal Sphinx version, state it here.
-# needs_sphinx = '1.0'
-needs_sphinx = '1.3'
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
-extensions = ['sphinxcontrib.httpdomain', 'sphinx.ext.autodoc',
- 'sphinx.ext.viewcode', 'sphinx.ext.napoleon']
-# Disable javasphinx generation until we have a solution to long build
-# times. readthedocs timesout after 902 seconds.
-
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
-
-# The suffix(es) of source filenames.
-# You can specify multiple suffix as a list of string:
-# source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
-
-# The encoding of source files.
-# source_encoding = 'utf-8-sig'
-
-# The master toctree document.
master_doc = 'index'
-
-# General information about the project.
-project = ''
-copyright = '2017, OPNFV. Licensed under CC BY 4.0'
-author = 'Open Platform for NFV'
+project = "Anuket Documentation"
+html_title = "Anuket Documentation"
+copyright = '2021, Anuket. Licensed under CC BY 4.0'
+author = 'Anuket Project of Linux Foundation Networking'
+extensions = ['sphinx.ext.intersphinx',
+ 'sphinx.ext.autosectionlabel'
+ ]
+html_theme = "piccolo_theme"
+exclude_patterns = [
+ '**/.tox',
+ 'templates', # suppress warning that these files are not included in any toctree
+ 'how-to-use-docs/files', # suppress warning that these files are not included in any toctree
+ 'development/feature.templates' # suppress warning that these files are not included in any toctree
+]
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
@@ -44,239 +22,83 @@ author = 'Open Platform for NFV'
version = 'Latest'
# The full version, including alpha/beta/rc tags.
release = 'Latest'
+# The branch this project should link against for projects
+# following the stable-branch process. On the opnfvdocs stable branch
+# this should be set to 'stable/<release>' where '<release>' is the
+# current stable release (Ex: 'stable/gambia')
+branch = 'latest'
+
+intersphinx_mapping = {}
+intersphinx_mapping['airship'] = ('https://docs.anuket.io/projects/airship/en/%s' % branch, None)
+#intersphinx_mapping['apex'] = ('https://opnfv-apex.readthedocs.io/en/%s' % branch, None)
+#intersphinx_mapping['armband'] = ('https://opnfv-armband.readthedocs.io/en/%s' % branch, None)
+intersphinx_mapping['auto'] = ('https://docs.anuket.io/projects/auto/en/%s' % branch, None)
+intersphinx_mapping['availability'] = ('https://opnfv-availability.readthedocs.io/en/%s' % branch, None)
+intersphinx_mapping['barometer'] = ('https://docs.anuket.io/projects/barometer/en/%s' % branch, None)
+#intersphinx_mapping['bottlenecks'] = ('https://opnfv-bottlenecks.readthedocs.io/en/%s' % branch, None)
+intersphinx_mapping['calipso'] = ('https://docs.anuket.io/projects/calipso/en/%s' % branch, None)
+intersphinx_mapping['cirv-sdv'] = ('https://docs.anuket.io/projects/cirv-sdv/en/%s' % branch, None)
+#intersphinx_mapping['clover'] = ('https://opnfv-clover.readthedocs.io/en/%s' % branch, None)
+#intersphinx_mapping['compass4nfv'] = ('https://opnfv-compass4nfv.readthedocs.io/en/%s' % branch, None)
+intersphinx_mapping['container4nfv'] = ('https://opnfv-container4nfv.readthedocs.io/en/%s' % branch, None)
+# intersphinx_mapping['copper'] = ('https://opnfv-copper.readthedocs.io/en/%s' % branch, None)
+#intersphinx_mapping['daisy'] = ('https://opnfv-daisy.readthedocs.io/en/%s' % branch, None)
+#intersphinx_mapping['doctor'] = ('https://opnfv-doctor.readthedocs.io/en/%s' % branch, None)
+intersphinx_mapping['dovetail'] = ('https://docs.anuket.io/projects/dovetail/en/%s' % branch, None)
+intersphinx_mapping['edgecloud'] = ('https://opnfv-edgecloud.readthedocs.io/en/%s' % branch, None)
+# intersphinx_mapping['fds'] = ('https://opnfv-fds.readthedocs.io/en/%s' % branch, None)
+#intersphinx_mapping['fuel'] = ('https://opnfv-fuel.readthedocs.io/en/%s' % branch, None)
+intersphinx_mapping['functest'] = ('https://docs.anuket.io/projects/functest/en/%s' % branch, None)
+#intersphinx_mapping['ipv6'] = ('https://opnfv-ipv6.readthedocs.io/en/%s' % branch, None)
+# intersphinx_mapping['moon'] = ('https://opnfv-moon.readthedocs.io/en/%s' % branch, None)
+# intersphinx_mapping['netready'] = ('https://opnfv-netready.readthedocs.io/en/%s' % branch, None)
+intersphinx_mapping['kuberef'] = ('https://docs.anuket.io/projects/kuberef/en/%s' % branch, None)
+intersphinx_mapping['nfvbench'] = ('https://docs.anuket.io/projects/nfvbench/en/%s' % branch, None)
+#intersphinx_mapping['onosfw'] = ('https://opnfv-onosfw.readthedocs.io/en/%s' % branch, None)
+#intersphinx_mapping['orchestra'] = ('https://opnfv-orchestra.readthedocs.io/en/%s' % branch, None)
+intersphinx_mapping['ovn4nfv'] = ('https://opnfv-ovn4nfv.readthedocs.io/en/%s' % branch, None)
+intersphinx_mapping['ovno'] = ('https://opnfv-ovno.readthedocs.io/en/%s' % branch, None)
+intersphinx_mapping['parser'] = ('https://opnfv-parser.readthedocs.io/en/%s' % branch, None)
+intersphinx_mapping['pharos'] = ('https://opnfv-pharos.readthedocs.io/en/%s' % branch, None)
+#intersphinx_mapping['promise'] = ('https://opnfv-promise.readthedocs.io/en/%s' % branch, None)
+#intersphinx_mapping['qtip'] = ('https://opnfv-qtip.readthedocs.io/en/%s' % branch, None)
+intersphinx_mapping['releng'] = ('https://docs.anuket.io/projects/releng/en/latest', None)
+intersphinx_mapping['releng-xci'] = ('https://opnfv-releng-xci.readthedocs.io/en/%s' % branch, None)
+intersphinx_mapping['samplevnf'] = ('https://docs.anuket.io/projects/samplevnf/en/%s' % branch, None)
+intersphinx_mapping['sdnvpn'] = ('https://opnfv-sdnvpn.readthedocs.io/en/%s' % branch, None)
+#intersphinx_mapping['sfc'] = ('https://opnfv-sfc.readthedocs.io/en/%s' % branch, None)
+#intersphinx_mapping['snaps'] = ('https://opnfv-snaps.readthedocs.io/en/%s' % branch, None)
+intersphinx_mapping['stor4nfv'] = ('https://opnfv-stor4nfv.readthedocs.io/en/%s' % branch, None)
+#intersphinx_mapping['storperf'] = ('https://opnfv-storperf.readthedocs.io/en/%s' % branch, None)
+intersphinx_mapping['vineperf'] = ('https://docs.anuket.io/projects/vineperf/en/%s' % branch, None)
+#intersphinx_mapping['yardstick'] = ('https://opnfv-yardstick.readthedocs.io/en/%s' % branch, None)
+intersphinx_mapping['cntt'] = ('https://cntt.readthedocs.io/en/%s' % branch, None)
+
+
+autosectionlabel_prefix_document = True
+autosectionlabel_maxdepth = 4
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-#
-# This is also used if you do content translation via gettext catalogs.
-# Usually you set "language" from the command line for these cases.
-language = None
-
-# There are two options for replacing |today|: either, you set today to some
-# non-false value, then it is used:
-# today = ''
-# Else, today_fmt is used as the format for a strftime call.
-# today_fmt = '%B %d, %Y'
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-# This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = []
-
-# The reST default role (used for this markup: `text`) to use for all
-# documents.
-# default_role = None
-
-# If true, '()' will be appended to :func: etc. cross-reference text.
-# add_function_parentheses = True
-
-# If true, the current module name will be prepended to all description
-# unit titles (such as .. function::).
-# add_module_names = True
-
-# If true, sectionauthor and moduleauthor directives will be shown in the
-# output. They are ignored by default.
-# show_authors = False
-
-# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
-
-# A list of ignored prefixes for module index sorting.
-# modindex_common_prefix = []
-
-# If true, keep warnings as "system message" paragraphs in the built documents.
-# keep_warnings = False
-
-# If true, `todo` and `todoList` produce output, else they produce nothing.
-todo_include_todos = False
-
-
-# -- Options for HTML output ----------------------------------------------
-
-# The theme to use for HTML and HTML Help pages. See the documentation for
-# a list of builtin themes.
-html_theme = 'bootstrap'
+html_static_path = ['_static']
+templates_path = ['_templates']
-# Theme options are theme-specific and customize the look and feel of a theme
-# further. For a list of options available for each theme, see the
-# documentation.
-# html_theme_options = {}
+html_show_sourcelink = False
html_theme_options = {
- 'bootswatch_theme': "journal",
- 'navbar_sidebarrel': False,
+ 'nav_title': '',
+ # Set the color and the accent color
+ 'color_primary': 'blue-grey,',
+ 'color_accent': 'white',
+ # Visible levels of the global TOC; -1 means unlimited
+ 'globaltoc_depth': 0,
+ # If False, expand all TOC entries
+ 'globaltoc_collapse': False,
+ # If True, show hidden TOC entries
+ 'globaltoc_includehidden': False,
+ 'base_url': "https://docs.anuket.io/",
+ 'repo_url': 'https://gerrit.opnfv.org/',
+ 'repo_name': '',
+ 'repo_type': 'github',
}
-# Add any paths that contain custom themes here, relative to this directory.
-# html_theme_path = []
-html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
-
-# The name for this set of Sphinx documents.
-# "<project> v<release> documentation" by default.
-# html_title = 'OpenDaylight Documentation v0.3.0'
-
-# A shorter title for the navigation bar. Default is the same as html_title.
-# html_short_title = None
-
-# The name of an image file (relative to this directory) to place at the top
-# of the sidebar.
-html_logo = '_static/opnfv-logo.png'
-
-# The name of an image file (relative to this directory) to use as a favicon of
-# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
-# pixels large.
+# Inverse png
+html_logo = '_static/anuket-logo.png'
html_favicon = '_static/favicon.ico'
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
-
-# Add any extra paths that contain custom files (such as robots.txt or
-# .htaccess) here, relative to this directory. These files are copied
-# directly to the root of the documentation.
-# html_extra_path = []
-
-# If not None, a 'Last updated on:' timestamp is inserted at every page
-# bottom, using the given strftime format.
-# The empty string is equivalent to '%b %d, %Y'.
-# html_last_updated_fmt = None
-
-# If true, SmartyPants will be used to convert quotes and dashes to
-# typographically correct entities.
-# html_use_smartypants = True
-
-# Custom sidebar templates, maps document names to template names.
-# html_sidebars = {}
-
-# Additional templates that should be rendered to pages, maps page names to
-# template names.
-# html_additional_pages = {}
-
-# If false, no module index is generated.
-# html_domain_indices = True
-
-# If false, no index is generated.
-# html_use_index = True
-
-# If true, the index is split into individual pages for each letter.
-# html_split_index = False
-
-# If true, links to the reST sources are added to the pages.
-# html_show_sourcelink = True
-
-# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-# html_show_sphinx = True
-
-# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-# html_show_copyright = True
-
-# If true, an OpenSearch description file will be output, and all pages will
-# contain a <link> tag referring to it. The value of this option must be the
-# base URL from which the finished HTML is served.
-# html_use_opensearch = ''
-
-# This is the file name suffix for HTML files (e.g. ".xhtml").
-# html_file_suffix = None
-
-# Language to be used for generating the HTML full-text search index.
-# Sphinx supports the following languages:
-# 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
-# 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr', 'zh'
-# html_search_language = 'en'
-
-# A dictionary with options for the search language support, empty by default.
-# 'ja' uses this config value.
-# 'zh' user can custom change `jieba` dictionary path.
-# html_search_options = {'type': 'default'}
-
-# The name of a javascript file (relative to the configuration directory) that
-# implements a search results scorer. If empty, the default will be used.
-# html_search_scorer = 'scorer.js'
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = 'OPNFV'
-
-# -- Options for LaTeX output ---------------------------------------------
-
-latex_elements = {
- # The paper size ('letterpaper' or 'a4paper').
- #'papersize': 'letterpaper',
-
- # The font size ('10pt', '11pt' or '12pt').
- #'pointsize': '10pt',
-
- # Additional stuff for the LaTeX preamble.
- #'preamble': '',
-
- # Latex figure (float) alignment
- #'figure_align': 'htbp',
-}
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title,
-# author, documentclass [howto, manual, or own class]).
-latex_documents = [
- (master_doc, 'OPNFV.tex', 'OPNFV Documentation',
- 'OPNFV Project', 'manual'),
-]
-
-# The name of an image file (relative to this directory) to place at the top of
-# the title page.
-# latex_logo = None
-
-# For "manual" documents, if this is true, then toplevel headings are parts,
-# not chapters.
-# latex_use_parts = False
-
-# If true, show page references after internal links.
-# latex_show_pagerefs = False
-
-# If true, show URL addresses after external links.
-# latex_show_urls = False
-
-# Documents to append as an appendix to all manuals.
-# latex_appendices = []
-
-# If false, no module index is generated.
-# latex_domain_indices = True
-
-
-# -- Options for manual page output ---------------------------------------
-
-# One entry per manual page. List of tuples
-# (source start file, name, description, authors, manual section).
-man_pages = [
- (master_doc, 'OPNFVDocs', 'OPNFV Documentation',
- [author], 1)
-]
-
-# If true, show URL addresses after external links.
-# man_show_urls = False
-
-
-# -- Options for Texinfo output -------------------------------------------
-
-# Grouping the document tree into Texinfo files. List of tuples
-# (source start file, target name, title, author,
-# dir menu entry, description, category)
-texinfo_documents = [
- (master_doc, 'OPNFVDocs', 'OPNFV Documentation',
- author, 'OPNFV', 'One line description of project.',
- 'Miscellaneous'),
-]
-
-html_sidebars = {'**': ['localtoc.html', 'relations.html'],}
-# Documents to append as an appendix to all manuals.
-# texinfo_appendices = []
-
-# If false, no module index is generated.
-# texinfo_domain_indices = True
-
-# How to display URL addresses: 'footnote', 'no', or 'inline'.
-# texinfo_show_urls = 'footnote'
-
-# If true, do not generate a @detailmenu in the "Top" node's menu.
-# texinfo_no_detailmenu = False
-
-# intersphinx_mapping =
-# {'RTD':('http://opnfvdocsdemo.readthedocs.io/projects/', None)}
diff --git a/docs/development/opnfvsecguide/audit.rst b/docs/development/opnfvsecguide/audit.rst
index cdeecba60..014f6c634 100644
--- a/docs/development/opnfvsecguide/audit.rst
+++ b/docs/development/opnfvsecguide/audit.rst
@@ -5,5 +5,3 @@ Audit
:maxdepth: 2
audit/audit_reqs
- audit/configuring
-
diff --git a/docs/development/opnfvsecguide/audit/audit_reqs.rst b/docs/development/opnfvsecguide/audit/audit_reqs.rst
index ce76d016b..7923e515e 100644
--- a/docs/development/opnfvsecguide/audit/audit_reqs.rst
+++ b/docs/development/opnfvsecguide/audit/audit_reqs.rst
@@ -15,6 +15,7 @@ http://www.etsi.org/deliver/etsi_gs/NFV-INF/001_099/004/01.01.01_60/gs_NFV-INF00
.. _NFV-SEC-003: http://www.etsi.org/deliver/etsi_gs/NFV-SEC/001_099/003/01.01.01_60/gs_NFV-SEC003v010101p.pdf
+
* ETSI GS NFV 004 V1.1.1 (2013-10)
- Network Functions Virtualisation (NFV);
diff --git a/docs/development/opnfvsecguide/compute/trust.rst b/docs/development/opnfvsecguide/compute/trust.rst
index 3022e59c0..ac4f37ae4 100644
--- a/docs/development/opnfvsecguide/compute/trust.rst
+++ b/docs/development/opnfvsecguide/compute/trust.rst
@@ -114,8 +114,6 @@ To switch between the secure world and the normal world, Intel provides SMX
Instructions, while ARM uses SMC. Programmatically, they all achieve very
similar results.
-Read more about Trusted Execution Environments `here. <http://www.openvirtualization.org/open-source-arm-trustzone.html>`_
-
`NIST SP800-147 <http://csrc.nist.gov/publications/nistpubs/800-147/NIST-SP800-147-April2011.pdf>`_
, is a guidelines for firmware security, to ensure that the firmware itself is secure.
diff --git a/docs/development/scenario/featurematrix.rst b/docs/development/scenario/featurematrix.rst
deleted file mode 100644
index 2d00a4097..000000000
--- a/docs/development/scenario/featurematrix.rst
+++ /dev/null
@@ -1,39 +0,0 @@
-Each scenario provides a set of platform capabilities and features that it supports. It is
-possible to identify which features are provided by reviewing the scenario name, however
-not all features and capabilities are discernible from the name itself.
-
-Brahmaputra feature support matrix
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The following table provides an overview of the available scenarios and supported features
-in the Brahmaputra release of OPNFV.
-
-.. image:: ../images/brahmaputrafeaturematrix.jpg
- :alt: OPNFV Brahmaputra Feature Matrix
-
-The table above provides an overview of which scenarios will support certain feature capabilities.
-The table does not indicate if the feature or scenario has limitations. Refer to the
-`Configuration Guide <http://artifacts.opnfv.org/opnfvdocs/brahmaputra/docs/configguide/configoptions.html#opnfv-scenarios>`_
-for details on the state of each scenario and further information.
-
-Feature development in the Brahmaputra release often consisted of the development of specific
-requirements and the further integration and validation of those requirements. This results in some
-features only being supported on the platform when a specific scenario, providing the
-capabilities necessary to run the feature, is deployed.
-
-Scenario Naming
-^^^^^^^^^^^^^^^
-
-In OPNFV, scenarios are identified by short scenario names. These names follow a scheme that
-identifies the key components and behaviours of the scenario, the rules for scenario naming are as follows:
-
- os-[controller]-[feature]-[mode]-[option]
-
-For example: *os-nosdn-kvm-noha* provides an OpenStack based deployment using neutron including
-the OPNFV enhanced KVM hypervisor.
-
-The [feature] tag in the scenario name describes the main feature provided by the scenario.
-This scenario may also provide support for features, such as advanced fault management, which are
-not apparent in the scenario name.
-The following section describes the features available in each scenario.
-
diff --git a/docs/development/scenario/scenariointro.rst b/docs/development/scenario/scenariointro.rst
deleted file mode 100644
index dd808432b..000000000
--- a/docs/development/scenario/scenariointro.rst
+++ /dev/null
@@ -1,13 +0,0 @@
-OPNFV Scenarios
----------------
-
-The OPNFV project provides an integration and deployment environment for a variety of components
-that can make up a virtualisation platform. OPNFV identifies these variations on the composition of
-the platform as scenarios.
-
-A scenario in OPNFV can be defined as "a deployment of a specific set of platform components". The
-composition of a scenario may include specific SDN controller technologies, specific accelerate
-switching technologies, or even specific configurations of components to achieve targeted platform
-capabilities. Each scenario behaves differetly and it is important to understand the behaviour you
-want in order to target the specific scenario you wish to deploy prior to working with the
-OPNFV platform.
diff --git a/docs/development/scenario/scenariomatrix.rst b/docs/development/scenario/scenariomatrix.rst
deleted file mode 100644
index 64e115015..000000000
--- a/docs/development/scenario/scenariomatrix.rst
+++ /dev/null
@@ -1,100 +0,0 @@
-Scenarios are implemented as deployable compositions through integration with an installation tool.
-OPNFV supports multiple installation tools and for any given release not all tools will support all
-scenarios. While our target is to establish parity across the installation tools to ensure they
-can provide all scenarios, the practical challenge of achieving that goal for any given feature and
-release results in some disparity.
-
-Brahmaputra scenario overeview
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The following table provides an overview of the installation tools and available scenario's
-in the Brahmaputra release of OPNFV.
-
-.. image:: ../images/brahmaputrascenariomatrix.jpg
- :alt: OPNFV Brahmaputra Scenario Matrix
-
-Scenario status is indicated by a weather pattern icon. All scenarios listed with
-a weather pattern are possible to deploy and run in your environment or a Pharos lab,
-however they may have known limitations or issues as indicated by the icon.
-
-Weather pattern icon legend:
-
-+---------------------------------------------+----------------------------------------------------------+
-| Weather Icon | Scenario Status |
-+=============================================+==========================================================+
-| .. image:: ../images/weather-clear.jpg | Stable, no known issues |
-+---------------------------------------------+----------------------------------------------------------+
-| .. image:: ../images/weather-few-clouds.jpg | Stable, documented limitations |
-+---------------------------------------------+----------------------------------------------------------+
-| .. image:: ../images/weather-overcast.jpg | Deployable, stability or feature limitations |
-+---------------------------------------------+----------------------------------------------------------+
-| .. image:: ../images/weather-dash.jpg | Not deployed with this installer |
-+---------------------------------------------+----------------------------------------------------------+
-
-Scenarios that are not yet in a state of "Stable, no known issues" will continue to be stabilised
-and updates will be made on the stable/brahmaputra branch. While we intend that all Brahmaputra
-scenarios should be stable it is worth checking regularly to see the current status. Due to
-our dependency on upstream communities and code some issues may not be resolved prior to the C release.
-
-Scenario Naming
-^^^^^^^^^^^^^^^
-
-In OPNFV scenarios are identified by short scenario names, these names follow a scheme that
-identifies the key components and behaviours of the scenario. The rules for scenario naming are as follows:
-
- os-[controller]-[feature]-[mode]-[option]
-
-Details of the fields are
- * os: mandatory
-
- * Refers to the platform type used
- * possible value: os (OpenStack)
-
-* [controller]: mandatory
-
- * Refers to the SDN controller integrated in the platform
- * example values: nosdn, ocl, odl, onos
-
- * [feature]: mandatory
-
- * Refers to the feature projects supported by the scenario
- * example values: nofeature, kvm, ovs, sfc
-
- * [mode]: mandatory
-
- * Refers to the deployment type, which may include for instance high availability
- * possible values: ha, noha
-
- * [option]: optional
-
- * Used for the scenarios those do not fit into naming scheme.
- * The optional field in the short scenario name should not be included if there is no optional scenario.
-
-Some examples of supported scenario names are:
-
- * os-nosdn-kvm-noha
-
- * This is an OpenStack based deployment using neutron including the OPNFV enhanced KVM hypervisor
-
- * os-onos-nofeature-ha
-
- * This is an OpenStack deployment in high availability mode including ONOS as the SDN controller
-
- * os-odl_l2-sfc
-
- * This is an OpenStack deployment using OpenDaylight and OVS enabled with SFC features
-
-Installing your scenario
-^^^^^^^^^^^^^^^^^^^^^^^^
-
-There are two main methods of deploying your target scenario, one method is to follow this guide which will
-walk you through the process of deploying to your hardware using scripts or ISO images, the other method is
-to set up a Jenkins slave and connect your infrastructure to the OPNFV Jenkins master.
-
-For the purposes of evaluation and development a number of Brahmaputra scenarios are able to be deployed
-virtually to mitigate the requirements on physical infrastructure. Details and instructions on performing
-virtual deployments can be found in the installer specific installation instructions.
-
-To set up a Jenkins slave for automated deployment to your lab, refer to the `Jenkins slave connect guide.
-<http://artifacts.opnfv.org/brahmaputra.1.0/docs/opnfv-jenkins-slave-connection.brahmaputra.1.0.html>`_
-
diff --git a/docs/development/scenario/scenariovalidation.rst b/docs/development/scenario/scenariovalidation.rst
deleted file mode 100644
index e69de29bb..000000000
--- a/docs/development/scenario/scenariovalidation.rst
+++ /dev/null
diff --git a/docs/featureprojects.rst b/docs/featureprojects.rst
index 18a6ea282..d4a2b3503 100644
--- a/docs/featureprojects.rst
+++ b/docs/featureprojects.rst
@@ -1,256 +1,19 @@
.. _opnfv-featureprojects:
-OPNFV Projects
-================
-
-Apex
-----
-.. toctree::
- :maxdepth: 1
-
- ../submodules/apex/docs/development/overview/index
- ../submodules/apex/docs/development/requirements/index
- ../submodules/apex/docs/release/installation/index
- ../submodules/apex/docs/release/configguide/index
- ../submodules/apex/docs/release/userguide/index
- ../submodules/apex/docs/development/design/index
- ../submodules/apex/docs/development/manuals/index
-
-
-Armband
--------
-.. toctree::
- :maxdepth: 1
-
- ../submodules/armband/docs/development/overview/index
- ../submodules/armband/docs/development/requirements/index
- ../submodules/armband/docs/release/installation/index
- ../submodules/armband/docs/release/configguide/index
- ../submodules/armband/docs/release/userguide/index
- ../submodules/armband/docs/development/design/index
- ../submodules/armband/docs/development/manuals/index
-
+Anuket Projects
+===============
Availability
------------
-.. toctree::
- :maxdepth: 1
-
- ../submodules/availability/docs/development/overview/index
- ../submodules/availability/docs/development/requirements/index
- ../submodules/availability/docs/release/installation/index
- ../submodules/availability/docs/release/configguide/index
- ../submodules/availability/docs/release/userguide/index
- ../submodules/availability/docs/development/design/index
- ../submodules/availability/docs/development/manuals/index
+* :doc:`Availability overview <availability:index>`
+* :doc:`High Availability Requirement Analysis in OPNFV <availability:development/overview/index>`
Barometer
---------
-.. toctree::
- :maxdepth: 1
-
- ../submodules/barometer/docs/development/overview/index
- ../submodules/barometer/docs/development/requirements/index
- ../submodules/barometer/docs/release/installation/index
- ../submodules/barometer/docs/release/configguide/index
- ../submodules/barometer/docs/release/userguide/index
- ../submodules/barometer/docs/development/design/index
- ../submodules/barometer/docs/development/manuals/index
-
-Clover
-------
-.. toctree::
- :maxdepth: 1
- ../submodules/clover/docs/development/design/index
-
-Compass4Nfv
------------
-.. toctree::
- :maxdepth: 1
-
- ../submodules/compass4nfv/docs/development/overview/index
- ../submodules/compass4nfv/docs/development/requirements/index
- ../submodules/compass4nfv/docs/release/installation/index
- ../submodules/compass4nfv/docs/release/configguide/index
- ../submodules/compass4nfv/docs/release/userguide/index
- ../submodules/compass4nfv/docs/development/design/index
- ../submodules/compass4nfv/docs/development/manuals/index
-
-
-Copper
-------
-.. toctree::
- :maxdepth: 1
-
- ../submodules/copper/docs/development/overview/index
- ../submodules/copper/docs/development/requirements/index
- ../submodules/copper/docs/release/installation/index
- ../submodules/copper/docs/release/configguide/index
- ../submodules/copper/docs/release/userguide/index
- ../submodules/copper/docs/development/design/index
- ../submodules/copper/docs/development/manuals/index
-
-
-Daisy4NFV
----------
-.. toctree::
- :maxdepth: 1
-
- ../submodules/daisy/docs/development/design/index
- ../submodules/daisy/docs/release/configguide/index
- ../submodules/daisy/docs/release/installation/index
-
-
-Doctor
-------
-.. toctree::
- :maxdepth: 1
-
- ../submodules/doctor/docs/development/overview/index
- ../submodules/doctor/docs/development/requirements/index
- ../submodules/doctor/docs/release/installation/index
- ../submodules/doctor/docs/release/configguide/index
- ../submodules/doctor/docs/release/userguide/index
- ../submodules/doctor/docs/development/design/index
- ../submodules/doctor/docs/development/manuals/index
-
-
-Domino
-------
-.. toctree::
- :maxdepth: 1
-
- ../submodules/domino/docs/development/overview/index
- ../submodules/domino/docs/development/requirements/index
- ../submodules/domino/docs/release/installation/index
- ../submodules/domino/docs/release/configguide/index
- ../submodules/domino/docs/release/userguide/index
- ../submodules/domino/docs/development/design/index
- ../submodules/domino/docs/development/manuals/index
-
-
-IPV6
-----
-.. toctree::
- :maxdepth: 1
-
- ../submodules/ipv6/docs/development/overview/index
- ../submodules/ipv6/docs/development/requirements/index
- ../submodules/ipv6/docs/release/installation/index
- ../submodules/ipv6/docs/release/configguide/index
- ../submodules/ipv6/docs/release/userguide/index
- ../submodules/ipv6/docs/development/design/index
- ../submodules/ipv6/docs/development/manuals/index
-
-
-Joid
-----
-.. toctree::
- :maxdepth: 1
-
- ../submodules/joid/docs/development/overview/index
- ../submodules/joid/docs/development/requirements/index
- ../submodules/joid/docs/release/installation/index
- ../submodules/joid/docs/release/configguide/index
- ../submodules/joid/docs/release/userguide/index
- ../submodules/joid/docs/development/design/index
- ../submodules/joid/docs/development/manuals/index
-
-
-Kvmfornfv
----------
-.. toctree::
- :maxdepth: 1
-
- ../submodules/kvmfornfv/docs/development/overview/index
- ../submodules/kvmfornfv/docs/development/requirements/index
- ../submodules/kvmfornfv/docs/release/installation/index
- ../submodules/kvmfornfv/docs/release/configguide/index
- ../submodules/kvmfornfv/docs/release/userguide/index
- ../submodules/kvmfornfv/docs/development/design/index
- ../submodules/kvmfornfv/docs/development/manuals/index
-
-
-Multisite
----------
-.. toctree::
- :maxdepth: 1
-
- ../submodules/multisite/docs/development/overview/index
- ../submodules/multisite/docs/development/requirements/index
- ../submodules/multisite/docs/release/installation/index
- ../submodules/multisite/docs/release/configguide/index
- ../submodules/multisite/docs/release/userguide/index
- ../submodules/multisite/docs/development/design/index
- ../submodules/multisite/docs/development/manuals/index
-
-
-Netready
---------
-.. toctree::
- :maxdepth: 1
-
- ../submodules/netready/docs/development/overview/index
- ../submodules/netready/docs/development/requirements/index
- ../submodules/netready/docs/release/installation/index
- ../submodules/netready/docs/release/configguide/index
- ../submodules/netready/docs/release/userguide/index
- ../submodules/netready/docs/development/design/index
- ../submodules/netready/docs/development/manuals/index
-
-
-Opera
------
-.. toctree::
- :maxdepth: 1
-
- ../submodules/opera/docs/development/overview/index
- ../submodules/opera/docs/development/requirements/index
- ../submodules/opera/docs/release/installation/index
- ../submodules/opera/docs/release/configguide/index
- ../submodules/opera/docs/release/userguide/index
- ../submodules/opera/docs/development/design/index
- ../submodules/opera/docs/development/manuals/index
-
-
-Parser
-------
-.. toctree::
- :maxdepth: 1
-
- ../submodules/parser/docs/development/overview/index
- ../submodules/parser/docs/development/requirements/index
- ../submodules/parser/docs/release/installation/index
- ../submodules/parser/docs/release/configguide/index
- ../submodules/parser/docs/release/userguide/index
- ../submodules/parser/docs/development/design/index
- ../submodules/parser/docs/development/manuals/index
-
-
-SDNVPN
---------
-.. toctree::
- :maxdepth: 1
-
- ../submodules/sdnvpn/docs/development/overview/index
- ../submodules/sdnvpn/docs/development/requirements/index
- ../submodules/sdnvpn/docs/release/installation/index
- ../submodules/sdnvpn/docs/release/configguide/index
- ../submodules/sdnvpn/docs/release/userguide/index
- ../submodules/sdnvpn/docs/development/design/index
-
-
-SFC
----
-.. toctree::
- :maxdepth: 1
-
- ../submodules/sfc/docs/development/overview/index
- ../submodules/sfc/docs/development/requirements/index
- ../submodules/sfc/docs/release/installation/index
- ../submodules/sfc/docs/release/configguide/index
- ../submodules/sfc/docs/release/userguide/index
- ../submodules/sfc/docs/development/design/index
- ../submodules/sfc/docs/development/manuals/index
+* :doc:`Barometer Overview <barometer:index>`
+* :doc:`Barometer Requirements <barometer:development/requirements/index>`
+* :doc:`Barometer Config Guide <barometer:release/configguide/index>`
+* :doc:`Barometer User Guide <barometer:release/userguide/index>`
+* :doc:`Barometer Design Guide <barometer:development/design/index>`
diff --git a/docs/glossary/index.rst b/docs/glossary/index.rst
index be5b6d732..1ee12de02 100644
--- a/docs/glossary/index.rst
+++ b/docs/glossary/index.rst
@@ -1,117 +1,218 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-.. (c) Christopher Price (Ericsson AB)
+.. SPDX-License-Identifier: CC-BY-4.0
+.. (c) Christopher Price (Ericsson AB), AT&T, Anuket
-**************
-OPNFV Glossary
-**************
+***************************
+Anuket Development Glossary
+***************************
========
Contents
========
-This glossary provides a common definition of phrases and words commonly used in OPNFV.
+This glossary provides a common definition of phrases and words commonly used in the OPNFV project, and its successor, the Anuket Project.
--------
A
-
+.. glossary::
-Arno
+ Anuket
- A river running through Tuscany and the name of the first OPNFV release.
+ The ancient Egyptian Goddess Anuket was a personification of the Nile as “Nourisher of the Fields”, and the name for the combined OPNFV and CNTT project.
+
+ Arno
+
+ A river running through Tuscany and the name of the first OPNFV release.
+
+ API
-API
Application Programming Interface
--------
B
-
+.. glossary::
-Brahmaputra
+ Brahmaputra
- A river running through Asia and the name of the Second OPNFV release.
+ A river running through Asia and the name of the Second OPNFV release.
--------
C
-
+.. glossary::
+
+ Colorado
-Colorado
+ A river in Argentina and the name of the Third OPNFV release.
- A river in Argentina and the name of the Third OPNFV release.
+ CNTT
+
+ Cloud iNfrastructure Telco Task Force
--------
D
-
+.. glossary::
+
+ Danube
+
+ A river in Europe and the name of the Fourth OPNFV release.
+
+ DPDK
+
+ Data Plane Development Kit
+
+ DPI
+
+ Deep Packet Inspection
+
+ DSCP
+
+ Differentiated Services Code Point
+
+--------
+
+E
+-
+.. glossary::
+
+ Euphrates
+
+ A river in Southeast Asia and the name of the Fifth OPNFV release.
+
+--------
+
+F
+-
+.. glossary::
+
+ Fraser
+
+ A river in British Columbia, Canada, and the name of the Sixth OPNFV release.
+
+--------
+
+G
+-
+.. glossary::
-DPDK
+ Gambia
- Data Plane Development Kit
+ A river in Western Africa and the name of the Seventh OPNFV release.
-DPI
+--------
- Deep Packet Inspection
+H
+-
+.. glossary::
-DSCP
+ Hunter
- Differentiated Services Code Point
+ A river in New South Wales, Australia and the name of the Eighth OPNFV release.
--------
I
-
+.. glossary::
+
+ IGMP
+
+ Internet Group Management Protocol
+
+ IOPS
-IGMP
+ Input/Output Operations Per Second
- Internet Group Management Protocol
+ Iruya
-IOPS
+ A river in Salta Province, Argentina and the name of the Ninth OPNFV release.
- Input/Output Operations Per Second
+--------
+
+J
+-
+.. glossary::
+
+ Jerma
+
+ A river in Serbia and the name of the Tenth OPNFV release.
+
+--------
+
+K
+-
+.. glossary::
+
+ Kali
+ A river in Uttara Kannada district of Karnataka state in India and the name of the First Anuket (OPNFV+CNTT) release.
+
+
+ Kubernetes
+
+ An operating system container management system, sometimes abbreviated "K8s" (meaning K, eight letters, and s).
+
+--------
+
+L
+-
+.. glossary::
+
+ Lakelse
+
+ A river in Britsh Columbia, Canada (name derived from the Coast Tsimshian language word "LaxGyels"), and the name of the Second Anuket (OPNFV+CNTT) Release.
--------
N
-
+.. glossary::
-NFV
+ NFV
- Network Functions Virtualisation, an industry initiative to leverage virtualisation technologies in carrier networks.
+ Network Functions Virtualisation, an industry initiative to leverage virtualisation technologies in carrier networks.
-NFVI
+ NFVI
- Network Function Virtualization Infrastructure
+ Network Function Virtualization Infrastructure
-NIC
+ NIC
- Network Interface Controller
+ Network Interface Controller
--------
O
-
+.. glossary::
-OPNFV
+ OPNFV
- Open Platform for NFV, an open source project developing an NFV reference platform and features.
+ Open Platform for NFV, an open source project developing an NFV reference platform and features.
--------
V
-
+.. glossary::
+
+ VLAN
-VLAN
+ A virtual local area network, typically an isolated ethernet network.
- A virtual local area network, typically an isolated ethernet network.
+ VM
-VM
+ Virtual machine, an emulation in software of a computer system.
- Virtual machine, an emulation in software of a computer system.
+ VNF
-VNF
+ Virtual network function, typically a networking application or function running in a virtual environment.
- Virtual network function, typically a networking application or function running in a virtual environment.
diff --git a/docs/how-to-use-docs/documentation-guide.rst b/docs/how-to-use-docs/documentation-guide.rst
index 56bf273bc..270097bea 100644
--- a/docs/how-to-use-docs/documentation-guide.rst
+++ b/docs/how-to-use-docs/documentation-guide.rst
@@ -2,9 +2,7 @@
Documentation Guide
===================
-This page intends to cover the documentation handling for OPNFV. OPNFV projects are expected to create a variety of document types,
-according to the nature of the project. Some of these are common to projects that develop/integrate features into the OPNFV platform, e.g.
-Installation Instructions and User/Configurations Guides. Other document types may be project-specific.
+This page intends to cover the documentation handling for OPNFV. OPNFV projects are expected to create a variety of document types.
.. contents::
:depth: 3
@@ -15,14 +13,17 @@ Getting Started with Documentation for Your Project
OPNFV documentation is automated and integrated into our git & gerrit toolchains.
We use RST document templates in our repositories and automatically render to HTML and PDF versions of the documents in our artifact
-store, our WiKi is also able to integrate these rendered documents directly allowing projects to use the revision controlled documentation
-process for project information, content and deliverables.
-Read :ref:`this page <include-documentation>` which elaborates on how documentation is to be included within opnfvdocs.
+store.
+
+The `LFN documenatation guide <https://docs.releng.linuxfoundation.org/en/latest/project-documentation.html>`_ explains how to enable
+your documenation build.
Licencing your documentation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-All contributions to the OPNFV project are done in accordance with the OPNFV licensing requirements. Documentation in OPNFV is contributed
-in accordance with the `Creative Commons 4.0 <https://creativecommons.org/licenses/by/4.0/>`_ and the `SPDX https://spdx.org/>`_ licence.
+All contributions to the OPNFV project are done in accordance with the OPNFV licensing requirements. Documentation in OPNFV is
+contributed
+in accordance with the `Creative Commons 4.0 <https://creativecommons.org/licenses/by/4.0/>`_ and the `SPDX <https://spdx.org/>`_
+licence.
All documentation files need to be licensed using the text below. The license may be applied in the first lines of
all contributed RST files:
@@ -42,7 +43,7 @@ look in these directories and be triggered on events in these directories when g
Document structure and contribution
-----------------------------------
A general structure is proposed for storing and handling documents that are common across many projects but also for documents that may be
-project specific. The documentation is divided into three areas Release, Development and Testing. Templates for these areas can be found
+project specific. The documentation is divided into three areas Release, Testing and Infrastructure. Templates for these areas can be found
under :code:`opnfvdocs/docs/templates/`.
Project teams are encouraged to use templates provided by the opnfvdocs project to ensure that there is consistency across the community.
@@ -50,62 +51,40 @@ Following representation shows the expected structure:
::
- docs/
- ├── development
- │ ├── design
- │ ├── overview
- │ └── requirements
+ docs/
├── release
- │ ├── configguide
│ ├── installation
- │ ├── release-notes
- │ ├── scenarios
- │ │ └── scenario.name
- │ └── userguide
+ │ ├── user and configuration guide
+ │ └── release notes
├── testing
- │ ├── developer
- │ └── user
- └── infrastructure
- ├── hardware-infrastructure
- ├── software-infrastructure
- ├── continuous-integration
- └── cross-community-continuous-integration
+ │ ├── user guide
+ │ ├── developer guide
+ ├── infrastructure
+ │ ├── infrastructure overview
+ │ ├── continuous integration (CI)
+ │ ├── cross community continuous integration (XCI)
+
Release documentation
^^^^^^^^^^^^^^^^^^^^^
Release documentation is the set of documents that are published for each OPNFV release. These documents are created and developed
following the OPNFV release process and milestones and should reflect the content of the OPNFV release.
-These documents have a master index.rst file in the <opnfvdocs> repository and extract content from other repositories.
-To provide content into these documents place your <content>.rst files in a directory in your repository that matches the master document
-and add a reference to that file in the correct place in the corresponding index.rst file in :code:`opnfvdocs/docs/release/`.
-
-**Platform Overview**: :code:`opnfvdocs/docs/release/overview`
-
-- Note this document is not a contribution driven document
-- Content for this is prepared by the Marketing team together with the opnfvdocs team
**Installation Instruction**: :code:`<repo>/docs/release/installation`
-- Folder for documents describing how to deploy each installer and scenario descriptions
-- Release notes will be included here <To Confirm>
-- Security related documents will be included here
-- Note that this document will be compiled into 'OPNFV Installation Instruction'
+- This document is shall describe how to get started and install OPNFV'
**User Guide**: :code:`<repo>/docs/release/userguide`
-- Folder for manuals to use specific features
-- Folder for documents describing how to install/configure project specific components and features
-- Can be the directory where API reference for project specific features are stored
-- Note this document will be compiled into 'OPNFV userguide'
+- This document shall describe the usage of a OPNFV component'
**Configuration Guide**: :code:`<repo>/docs/release/configguide`
-- Brief introduction to configure OPNFV with its dependencies.
+- Brief introduction to configure a OPNFV component'
**Release Notes**: :code:`<repo>/docs/release/release-notes`
-- Changes brought about in the release cycle.
-- Include version details.
+- Applicable for all projects participating in a release'
Testing documentation
^^^^^^^^^^^^^^^^^^^^^
@@ -119,25 +98,6 @@ e.g. Functest/Yardstick/Vsperf/Storperf/Bottlenecks/Qtip installation/config & u
**Development documentation**: :code:`<repo>/testing/developent/`
Will collect documentation to explain how to create your own test case and leverage existing testing frameworks e.g. developer guides.
-Development Documentation
-^^^^^^^^^^^^^^^^^^^^^^^^^
-Project specific documents such as design documentation, project overview or requirement documentation can be stored under
-/docs/development. Links to generated documents will be dislayed under Development Documentaiton section on docs.opnfv.org.
-You are encouraged to establish the following basic structure for your project as needed:
-
-**Requirement Documentation**: :code:`<repo>/docs/development/requirements/`
-
-- Folder for your requirement documentation
-- For details on requirements projects' structures see the `Requirements Projects <https://wiki.opnfv.org/display/PROJ/Requirements+Projects>`_ page.
-
-**Design Documentation**: :code:`<repo>/docs/development/design`
-
-- Folder for your upstream design documents (blueprints, development proposals, etc..)
-
-**Project overview**: :code:`<repo>/docs/development/overview`
-
-- Folder for any project specific documentation.
-
Infrastructure Documentation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Infrastructure documentation can be stored under :code:`<repo>/docs/` folder of
diff --git a/docs/how-to-use-docs/files/build.yaml b/docs/how-to-use-docs/files/build.yaml
new file mode 100644
index 000000000..e04521e35
--- /dev/null
+++ b/docs/how-to-use-docs/files/build.yaml
@@ -0,0 +1,12 @@
+---
+- project:
+ name: PROJECT
+ project: PROJECT
+ project-name: 'PROJECT'
+
+ project-pattern: 'PROJECT'
+ rtd-build-url: RTD_BUILD_URL
+ rtd-token: RTD_TOKEN
+
+ jobs:
+ - '{project-name}-rtd-jobs'
diff --git a/docs/how-to-use-docs/files/conf.py b/docs/how-to-use-docs/files/conf.py
new file mode 100644
index 000000000..eb12e74b6
--- /dev/null
+++ b/docs/how-to-use-docs/files/conf.py
@@ -0,0 +1 @@
+from docs_conf.conf import * # noqa: F401,F403
diff --git a/docs/how-to-use-docs/files/conf.yaml b/docs/how-to-use-docs/files/conf.yaml
new file mode 100644
index 000000000..caad28ff4
--- /dev/null
+++ b/docs/how-to-use-docs/files/conf.yaml
@@ -0,0 +1,3 @@
+---
+project_cfg: opnfv
+project: Example
diff --git a/docs/infrastructure/hardware-infrastructure.rst b/docs/how-to-use-docs/files/index
index f800cdb05..21da2ac4e 100644
--- a/docs/infrastructure/hardware-infrastructure.rst
+++ b/docs/how-to-use-docs/files/index
@@ -1,11 +1,17 @@
-.. _hardware-infrastructure:
-
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. SPDX-License-Identifier: CC-BY-4.0
.. (c) Open Platform for NFV Project, Inc. and its contributors
-=======================
-Hardware Infrastructure
-=======================
+.. _opnfv-project-foo:
+
+===
+FOO
+===
+
+.. toctree::
+ :numbered:
+ :maxdepth: 2
-TBD
+ development
+ release
+ testing
diff --git a/docs/how-to-use-docs/files/index.rst b/docs/how-to-use-docs/files/index.rst
new file mode 100644
index 000000000..0fa6784ab
--- /dev/null
+++ b/docs/how-to-use-docs/files/index.rst
@@ -0,0 +1,18 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-BY-4.0
+.. (c) Open Platform for NFV Project, Inc. and its contributors
+
+.. _<project-name>:
+
+==============
+<project-name>
+==============
+
+.. toctree::
+ :numbered:
+ :maxdepth: 2
+
+ release/release-notes/index
+ release/installation/index
+ release/userguide/index
+ scenarios/index
diff --git a/docs/how-to-use-docs/files/requirements.txt b/docs/how-to-use-docs/files/requirements.txt
new file mode 100644
index 000000000..440843584
--- /dev/null
+++ b/docs/how-to-use-docs/files/requirements.txt
@@ -0,0 +1,5 @@
+lfdocs-conf
+sphinx_opnfv_theme
+# Uncomment the following line if your project uses Sphinx to document
+# HTTP APIs
+# sphinxcontrib-httpdomain
diff --git a/docs/how-to-use-docs/files/tox.ini b/docs/how-to-use-docs/files/tox.ini
new file mode 100644
index 000000000..69aa18937
--- /dev/null
+++ b/docs/how-to-use-docs/files/tox.ini
@@ -0,0 +1,17 @@
+[tox]
+minversion = 1.6
+envlist =
+ docs,
+ docs-linkcheck
+skipsdist = true
+
+[testenv:docs]
+deps = -rdocs/requirements.txt
+commands =
+ sphinx-build -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
+ echo "Generated docs available in {toxinidir}/docs/_build/html"
+whitelist_externals = echo
+
+[testenv:docs-linkcheck]
+deps = -rdocs/requirements.txt
+commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck
diff --git a/docs/how-to-use-docs/include-documentation.rst b/docs/how-to-use-docs/include-documentation.rst
index d1a5a6227..78abfc63f 100644
--- a/docs/how-to-use-docs/include-documentation.rst
+++ b/docs/how-to-use-docs/include-documentation.rst
@@ -1,4 +1,5 @@
.. _include-documentation:
+
============================
Including your Documentation
============================
@@ -36,15 +37,6 @@ the documentation to the project repository.
In OPNFVDocs Composite Documentation
------------------------------------
-In toctree
-+++++++++++
-
-To import project documents from project repositories, we use submodules.
- Each project is stored in :code:`opnfvdocs/docs/submodule/` as follows:
-
-.. image:: Submodules.jpg
- :scale: 50 %
-
To include your project specific documentation in the composite documentation,
first identify where your project documentation should be included.
Say your project userguide should figure in the ‘OPNFV Userguide’, then:
@@ -76,7 +68,7 @@ It's pretty common to want to reference another location in the
OPNFV documentation and it's pretty easy to do with
reStructuredText. This is a quick primer, more information is in the
`Sphinx section on Cross-referencing arbitrary locations
-<http://www.sphinx-doc.org/en/stable/markup/inline.html#ref-role>`_.
+<http://www.sphinx-doc.org/en/stable/markup/inline.html#roles>`_.
Within a single document, you can reference another section simply by::
@@ -226,29 +218,3 @@ Your documentation shall be built as HTML inside the
specified output folder directory.
.. note:: Be sure to remove the `conf.py`, the static/ files and the output folder from the `<project>/docs/`. This is for testing only. Only commit the rst files and related content.
-
-
-Adding your project repository as a submodule
---------------------------
-
-Clone the opnfvdocs repository and your submodule to .gitmodules following the convention of the file
-
-.. code-block:: bash
-
- cd docs/submodules/
- git submodule add https://gerrit.opnfv.org/gerrit/$reponame
- git submodule init $reponame/
- git submodule update $reponame/
- git add .
- git commit -sv
- git review
-
-Removing a project repository as a submodule
---------------------------
- git rm docs/submodules/$reponame
- rm -rf .git/modules/$reponame
- git config -f .git/config --remove-section submodule.$reponame 2> /dev/null
- git add .
- git commit -sv
- git review
-
diff --git a/docs/images/Anuket-structure.png b/docs/images/Anuket-structure.png
new file mode 100644
index 000000000..a570cc86c
--- /dev/null
+++ b/docs/images/Anuket-structure.png
Binary files differ
diff --git a/docs/images/Anuket-structure.pptx b/docs/images/Anuket-structure.pptx
new file mode 100644
index 000000000..0960faea7
--- /dev/null
+++ b/docs/images/Anuket-structure.pptx
Binary files differ
diff --git a/docs/images/diagram_euphrates.png b/docs/images/diagram_euphrates.png
deleted file mode 100644
index 2673a5297..000000000
--- a/docs/images/diagram_euphrates.png
+++ /dev/null
Binary files differ
diff --git a/docs/images/diagram_fraser.png b/docs/images/diagram_fraser.png
new file mode 100644
index 000000000..13ae32198
--- /dev/null
+++ b/docs/images/diagram_fraser.png
Binary files differ
diff --git a/docs/images/gambia.png b/docs/images/gambia.png
new file mode 100644
index 000000000..1e89f9f09
--- /dev/null
+++ b/docs/images/gambia.png
Binary files differ
diff --git a/docs/images/hunter.png b/docs/images/hunter.png
new file mode 100644
index 000000000..dfaab2e14
--- /dev/null
+++ b/docs/images/hunter.png
Binary files differ
diff --git a/docs/index.rst b/docs/index.rst
index 191153f97..391be47f0 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,65 +1,133 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. SPDX-License-Identifier: CC-BY-4.0
-OPNFV Documentation
-===================
+Anuket Documentation
+====================
-Open Platform for NFV (OPNFV) facilitates the development and evolution
-of NFV components across various open source ecosystems. Through
-system level integration, deployment and testing, OPNFV creates a
-reference NFV platform to accelerate the transformation of enterprise
-and service provider networks. Participation is open to anyone,
-whether you are an employee of a member company or just passionate
-about network transformation.
+Remembrance of the late Al Morton
+---------------------------------
+
+The Orinoco Anuket Release is dedicated in remembrance of the late Al Morton who was instrumental for the establishment
+of the OPNFV project and in the formation of Anuket from the merger of CNTT and OPNFV. As a co-chair of the TSC and
+PTL on the ViNePERF project, he contributed so much to the success of the project. Al was a tireless believer in Open
+Source and standards, who spent his entire career at Bell Labs and AT&T Laboratories as a researcher and engineer
+extraordinaire. He will be missed.
+
+Mission and intro
+-----------------
+
+The mission of the Anuket project is to empower the global communications community by creating and developing reference
+cloud infrastructure models, architectures, tools, and programs to deliver network services faster, more reliably, and
+securely.
+
+Anuket approaches its mission by providing a set of cloud infrastructure reference
+specifications, reference implementations, conformance tests, testing tools, testing frameworks and implementation
+projects.
+
+.. image:: /images/Anuket-structure.png
+ :alt: Project structure of Anuket
+
+
+Participation is open to anyone, whether you are an employee of a member company or just passionate about network
+transformation.
+
+Documentation for Anuket users
+------------------------------
+
+These documents are targeted to the users of the different Anuket sub-projects and here they are organized by
+sub-project categories.
+
+Anuket specifications
+~~~~~~~~~~~~~~~~~~~~~
+
+:doc:`Anuket Specifications <cntt:index>` provide reference specifications for cloud infrastructures and their
+workloads. The specifications are organized to the following documents:
+
+* Reference Model (RM) - a technology independent specification of cloud infrastructures for telecom workloads
+* Reference Architecture (RA1) for OpenStack based cloud infrastructure - a specification of an OpenStack cloud
+ infrastructure based on the requirements of the Reference Model
+* Reference Conformance (RC1) for RA1 based Implementations - an automatic conformance testing framework to test RA1
+ conformance of OpenStack cloud infrastrucutres and their workloads
+* Reference Implementation based on RA1 specifications (RI1) - a blueprint to build an OpenStack cloud based on the
+ requirements of the RA1 specifications
+* Reference Architecture (RA2) for Kubernetes based cloud infrastructure - a specification of a Kubernetes container
+ orchestration platform based on the requirements of the Reference Model
+* Reference Conformance (RC2) for RA2 based Implementations - an automatic conformance testing framework to test RA2
+ conformance of OpenStack cloud infrastrucutres and their workloads
+* Reference Implementation based on RA2 specifications (RI2) - a blueprint to build a Kubernetes container orchestration
+ platform based on the RA2 specificcations.
.. toctree::
:maxdepth: 1
+ :hidden:
- release/overview
- how-to-use-docs/getting.started
release/installation.introduction
release/userguide.introduction
release/release-notes
+Implementation projects
+~~~~~~~~~~~~~~~~~~~~~~~
-Testing Frameworks
-------------------
+Implementation projects address specific needs in the cloud technology relevant for the community and provide a
+reuseable implementation. The implementation projects have their release notes, installation and user guides in the
+aggregated documentation set referred here:
-.. toctree::
- :maxdepth: 1
+- :doc:`Installation Introduction<release/installation.introduction>`
+- :doc:`User Guide and Configuration Guide<release/userguide.introduction>`
+- :doc:`Release Notes<release/release-notes>`
+
+Testing projects and frameworks
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Testing projects, like ViNePERF provide testing tools to assess certain characteristics of cloud infrastructures while
+the Functest testing framework provides an automatic test suite to test the cloud infrastructures. The testing projects
+and frameworks have their release notes, installation and user guides in the aggregated documentation set referred here:
+
+- :doc:`Installation Introduction<release/installation.introduction>`
+- :doc:`User Guide and Configuration Guide<release/userguide.introduction>`
+- :doc:`Release Notes<release/release-notes>`
+
+Integration projects
+~~~~~~~~~~~~~~~~~~~~
+
+The integration projects integrate OpenStack and Kubernetes based cloud infrastructures based on the blueprints of RI1
+and RI2. The integration projects have their release notes, installation and user guides in the aggregated documentation
+set referred here:
+
+- :doc:`Installation Introduction<release/installation.introduction>`
+- :doc:`User Guide and Configuration Guide<release/userguide.introduction>`
+- :doc:`Release Notes<release/release-notes>`
- testing/ecosystem/index
- testing/testing-user
- testing/testing-dev
+Documentation for Anuket contributors
+-------------------------------------
-Developer
----------
+Contribution guide for the documentation
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. toctree::
:maxdepth: 1
how-to-use-docs/index
- featureprojects
-Infrastructure
---------------
+Software and hardware infrastructure guide
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. toctree::
:maxdepth: 1
infrastructure/overview
infrastructure/ci
- infrastructure/xci
-Operations Supporting Tools
----------------------------
+Glossary
+--------
.. toctree::
:maxdepth: 1
- submodules/calipso/docs/release/index
+ glossary/index
-Found a typo or any other feedback? Send an email to users@opnfv.org or
-talk to us on IRC_.
+Found a typo or any other feedback? Send us an email_ or
+talk to us on Slack_.
-.. _IRC: https://webchat.freenode.net/?channels=%23opnfv
+.. _email: mailto:users@opnfv.org
+.. _Slack: https://anuketworkspace.slack.com/
diff --git a/docs/infrastructure/ci.rst b/docs/infrastructure/ci.rst
index a6323ef76..97429a505 100644
--- a/docs/infrastructure/ci.rst
+++ b/docs/infrastructure/ci.rst
@@ -10,5 +10,5 @@ Continuous Integration - CI
Please see the details of CI from the chapters below.
-- :ref:`CI Overview <ci-overview>`
-- :ref:`CI User Guide <ci-user-guide>`
+- :ref:`CI Overview <releng:ci-overview>`
+- :ref:`CI User Guide <releng:ci-user-guide>`
diff --git a/docs/infrastructure/gce-machines.rst b/docs/infrastructure/gce-machines.rst
new file mode 100644
index 000000000..901b1750c
--- /dev/null
+++ b/docs/infrastructure/gce-machines.rst
@@ -0,0 +1,131 @@
+==================
+OPNFV-GCE-MACHINES
+==================
+
+code-block:: yaml
+
+ hosts:
+ gce-opnfv-jenkins-2:
+ location: us-central1-a
+ flavor: n1-standard-4
+ purpose: 'main jenkins server'
+ network: gce-wl
+ contact: 'opnfv-helpdesk@rt.linuxfoundation.org'
+ gce-opnfv-jenkins-dev-1:
+ location: us-central1-a
+ flavor: n1-standard-2
+ purpose: 'main sandbox server'
+ network: gce-wl
+ contact: 'opnfv-helpdesk@rt.linuxfoundation.org'
+ gce-opnfv-jenkins-dev-build-1:
+ location: us-central1-a
+ flavor: n1-standard-1
+ purpose: 'static centos builder'
+ network: opnfv-sandbox
+ contact: 'opnfv-helpdesk@rt.linuxfoundation.org'
+ gce-opnfv-jenkins-dev-build-2-ubuntu:
+ location: us-central1-a
+ flavor: n1-standard-1
+ purpose: 'static ubuntu builder'
+ network: opnfv-sandbox
+ contact: 'opnfv-helpdesk@rt.linuxfoundation.org'
+ gce-opnfv-nginx-1:
+ location: us-central1-a
+ flavor: n1-highcpu-2
+ purpose: 'main load balancer'
+ network: gce-wl
+ contact: 'opnfv-helpdesk@rt.linuxfoundation.org'
+ gce-wl-openvpn:
+ location: us-central1-a
+ flavor: g1-small
+ purpose: 'vpn bridge'
+ network: gce-wl
+ contact: 'opnfv-helpdesk@rt.linuxfoundation.org'
+ gke-cluster-1-bamboo-gke-default-pool-76eef41f-dvfd:
+ location: us-central1-a
+ flavor: n1-standard-1
+ purpose: 'kubernetes cluster'
+ contact: 'chu.wenjing@gmail.com'
+ gke-cluster-1-bamboo-gke-default-pool-76eef41f-fnt7:
+ location: us-central1-a
+ flavor: n1-standard-1
+ purpose: 'kubernetes cluster'
+ contact: 'chu.wenjing@gmail.com'
+ gke-cluster-1-bamboo-gke-default-pool-76eef41f-m798:
+ location: us-central1-a
+ flavor: n1-standard-1
+ purpose: 'kubernetes cluster'
+ contact: 'chu.wenjing@gmail.com'
+ gke-cluster-1-bamboo-gke-default-pool-76eef41f-w5h8:
+ location: us-central1-a
+ flavor: n1-standard-1
+ purpose: 'kubernetes cluster'
+ contact: 'chu.wenjing@gmail.com'
+ gke-cluster-1-bamboo-gke-default-pool-76eef41f-wjs5:
+ location: us-central1-a
+ flavor: n1-standard-1
+ purpose: 'kubernetes cluster'
+ contact: 'chu.wenjing@gmail.com'
+ gke-cluster-1-bamboo-gke-default-pool-76eef41f-znj9:
+ location: us-central1-a
+ flavor: n1-standard-1
+ purpose: 'kubernetes cluster'
+ contact: 'chu.wenjing@gmail.com'
+ gce-opnfv-cvp:
+ location: us-central1-c
+ flavor: n1-standard-2
+ purpose: 'verified.opnfv.org'
+ contact: 'eddie.arrage@huawei.com'
+ network: opnfv-sandbox
+ gce-opnfv-discourse-ash-1:
+ location: us-central1-f
+ flavor: n1-standard-1
+ purpose: 'techdiscuss.opnfv.org'
+ contact: 'ashleeyoung@huawei.com'
+ network: opnfv-sandbox
+ gce-opnfv-influxdb-fbrockners:
+ location: us-central1-f
+ flavor: n1-standard-1
+ purpose: 'testresults.opnfv.org database server'
+ contact: 'feng.xiaowei@zte.com.cn'
+ network: opnfv-sandbox
+ gce-opnfv-pharos-dashboard:
+ location: us-central1-f
+ flavor: n1-standard-1
+ purpose: 'labs.opnfv.org'
+ contact: 'pberberian@iol.unh.edu'
+ network: opnfv-sandbox
+ gce-opnfv-plugfest-influxdb-fbrockners-1:
+ location: us-central1-f
+ flavor: n1-standard-1
+ purpose: 'Plugfest only testresults database server'
+ contact: 'feng.xiaowei@zte.com.cn'
+ network: opnfv-sandbox
+ gce-opnfv-plugfest-sandbox-fbrockners-1:
+ location: us-central1-f
+ flavor: n1-standard-2
+ purpose: 'Plugfest only testresults server'
+ contact: 'feng.xiaowei@zte.com.cn'
+ network: opnfv-sandbox
+ gce-opnfv-sandbox-fbrockners:
+ location: us-central1-f
+ flavor: n1-standard-2
+ purpose: 'testresults.opnfv.org'
+ contact: 'feng.xiaowei@zte.com.cn'
+ network: opnfv-sandbox
+ gce-opnfv-vnf-opnfv-org:
+ location: us-central1-f
+ flavor: n1-standard-1
+ purpose: 'vnf.opnfv.org'
+ contact: 'shailrishabh@gmail.com'
+ network: opnfv-sandbox
+ zuul-test-machine:
+ location: us-central1-f
+ flavor: n1-standard-4
+ purpose: 'Technology test macine'
+ contact: 'fatih.degirmenci@ericsson.com'
+ network: opnfv-sandbox
+ gce-korg-lkml-public-inbox:
+ location: us-west1-b
+ flavor: n1-standard-4
+ purpose: 'This is not an OPNFV resource'
diff --git a/docs/infrastructure/overview.rst b/docs/infrastructure/overview.rst
index 1bd792000..ed4dc11d9 100644
--- a/docs/infrastructure/overview.rst
+++ b/docs/infrastructure/overview.rst
@@ -8,48 +8,40 @@
Infrastructure Overview
=======================
-OPNFV develops, operates, and maintains infrastructure which is used by the OPNFV
-Community for development, integration, and testing purposes. `OPNFV
-Infrastructure Working Group (Infra WG) <https://wiki.opnfv.org/display/INF>`_
-oversees the OPNFV Infrastructure, ensures it is kept in a state which serves
-the community in best possible way and always up to date.
-
-Infra WG is working towards a model whereby we have a seamless pipeline
-for handing resource requests from the OPNFV community for both development and
+Anuket develops, operates, and maintains infrastructure which is used by the Anuket
+Community for development, integration, and testing purposes.
+
+Anuket is working towards a model whereby we have a seamless pipeline
+for handing resource requests from the Anuket community for both development and
Continuous Integration perspectives. Automation of requests and integration to
-existing automation tools is a primary driver in reaching this model. In the
-Infra WG, we imagine a model where the Infrastructure Requirements that are
-specified by a Feature, Installer or otherrelevant projects within OPNFV are
+existing automation tools is a primary driver in reaching this model. In Anuket,
+we imagine a model where the Infrastructure Requirements that are
+specified by a Feature, Installer or otherrelevant projects within Anuket are
requested, provisioned, used, reported on and subsequently torn down with no (or
minimal) user intervention at the physical/infrastructure level.
-Objectives of the Infra WG are
-
-* Deliver efficiently dimensions resources to OPNFV community needs on request in a timely manner that ensure maximum usage (capacity) and maximum density (distribution of workloads)
-* Satisfy the needs of the twice-yearly release projects, this includes being able to handle load (amount of projects and requests) as well as need (topology and different layouts)
-* Support OPNFV community users. As the INFRA group, we are integral to all aspects of the OPNFV Community (since it starts with the Hardware) - this can mean troubleshooting any element within the stack
-* Provide a method to expand and adapt as OPNFV community needs grow and provide this to Hosting Providers (lab providers) for input in growth forecast so they can better judge how best to contribute with their resources.
-* Work with reporting and other groups to ensure we have adequate feedback to the end-users of the labs on how their systems, code, feature performs.
+Objectives of Anuket are
-The details of what is provided as part of the infrastructure can be seen in following chapters.
+* Deliver efficiently dimensions resources to Anuket community needs on request
+ in a timely manner that ensure maximum usage (capacity) and maximum density
+ (distribution of workloads)
+* Satisfy the needs of the twice-yearly release projects, this includes being
+ able to handle load (amount of projects and requests) as well as need
+ (topology and different layouts)
+* Support Anuket community users. As the INFRA group, we are integral to all
+ aspects of the Anuket Community (since it starts with the Hardware) - this
+ can mean troubleshooting any element within the stack
+* Provide a method to expand and adapt as Anuket community needs grow and
+ provide this to Hosting Providers (lab providers) for input in growth
+ forecast so they can better judge how best to contribute with their resources.
+* Work with reporting and other groups to ensure we have adequate feedback to
+ the end-users of the labs on how their systems, code, feature performs.
-Hardware Infrastructure
------------------------
+The details of what is provided as part of the infrastructure can be seen in
+following chapters.
-TBD
Software Infrastructure
-----------------------
-.. toctree::
- :maxdepth: 1
-
- ../submodules/releng/docs/infra/index
-
-Security
---------
-
-.. toctree::
- :maxdepth: 1
-
- ../submodules/releng-anteater/docs/index
+- :ref:`releng:software-infrastructure`
diff --git a/docs/infrastructure/software-infrastructure.rst b/docs/infrastructure/software-infrastructure.rst
deleted file mode 100644
index 5c7158316..000000000
--- a/docs/infrastructure/software-infrastructure.rst
+++ /dev/null
@@ -1,11 +0,0 @@
-.. _software-infrastructure:
-
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. SPDX-License-Identifier: CC-BY-4.0
-.. (c) Open Platform for NFV Project, Inc. and its contributors
-
-=======================
-Software Infrastructure
-=======================
-
-TBD
diff --git a/docs/infrastructure/xci.rst b/docs/infrastructure/xci.rst
deleted file mode 100644
index fe4eaf9de..000000000
--- a/docs/infrastructure/xci.rst
+++ /dev/null
@@ -1,16 +0,0 @@
-.. _xci:
-
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. SPDX-License-Identifier: CC-BY-4.0
-.. (c) Open Platform for NFV Project, Inc. and its contributors
-
-============================================
-Cross Community Continuous Integration - XCI
-============================================
-
-Please see the details of XCI from the chapters below.
-
-- :ref:`XCI Overview <xci-overview>`
-- :ref:`XCI Way of Working <xci-wow>`
-- :ref:`XCI Sandbox and User Guide <xci-user-guide>`
-- :ref:`XCI Developer Guide <xci-developer-guide>`
diff --git a/docs/release/installation.introduction.rst b/docs/release/installation.introduction.rst
index 33955f59a..22ccd55b3 100644
--- a/docs/release/installation.introduction.rst
+++ b/docs/release/installation.introduction.rst
@@ -2,100 +2,37 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. SPDX-License-Identifier: CC-BY-4.0
-.. (c) Sofia Wallin Ericsson AB and other contributors
+.. (c) Anuket CCC, AT&T, and other contributors
-============
-Installation
-============
+=========================
+Installation Introduction
+=========================
-Abstract
-========
+This is the collection of installation documents for Anuket. Use this document for further reference.
-This an overview document for the installation of the Fraser release of OPNFV.
-
-The Fraser release can be installed making use of any of the installer projects in OPNFV:
-Apex, Compass4Nfv, Daisy4NFV, Fuel or JOID. Each installer provides the ability to install a common OPNFV
-platform as well as integrating additional features delivered through a variety of scenarios by
-the OPNFV community.
-
-
-Introduction
-============
-
-The OPNFV platform is comprised of a variety of upstream components that may be deployed on your
-infrastructure. A composition of components, tools and configurations is identified in OPNFV as a
-deployment scenario.
-
-The various OPNFV scenarios provide unique features and capabilities that you may want to leverage, and
-it is important to understand your required target platform capabilities before installing and
-configuring your scenarios.
-
-An OPNFV installation requires either a physical infrastructure environment as defined
-in the `Pharos specification <https://wiki.opnfv.org/display/pharos/Pharos+Specification>`_, or a virtual one.
-When configuring a physical infrastructure it is strongly advised to follow the Pharos configuration guidelines.
-
-
-Scenarios
-=========
-
-OPNFV scenarios are designed to host virtualised network functions (VNF’s) in a variety of deployment
-architectures and locations. Each scenario provides specific capabilities and/or components aimed at
-solving specific problems for the deployment of VNF’s.
-
-A scenario may, for instance, include components such as OpenStack, OpenDaylight, OVS, KVM etc.,
-where each scenario will include different source components or configurations.
+Anuket specifications
+=====================
-To learn more about the scenarios supported in the Fraser release refer to the scenario
-description documents provided:
+It is recommended to use the online version of the :doc:`Anuket Specifications <cntt:index>`.
-- :ref:`os-nosdn-kvm-ha <kvmfornfv-os-nosdn-kvm-ha>`
-- :ref:`os-nosdn-fdio-noha <os-nosdn-fdio-noha>`
-- `os-odl_l2-sfc-ha <http://docs.opnfv.org/en/stable-danube/submodules/sfc/docs/release/scenarios/os-odl_l2-sfc-ha/index.html>`_
-- `os-odl_l2-sfc-noha <http://docs.opnfv.org/en/stable-danube/submodules/sfc/docs/release/scenarios/os-odl_l2-sfc-noha/index.html>`_
-- :ref:`os-nosdn-lxd-ha <os-nosdn-lxd-ha>`
-- :ref:`os-nosdn-lxd-noha <os-nosdn-lxd-noha>`
-- :ref:`k8-nosdn-nofeature-noha <k8-nosdn-nofeature-noha>`
-- :ref:`k8-nosdn-lb-noha <k8-nosdn-lb-noha>`
-- :ref:`os-nosdn-ovs-ha <os-nosdn-ovs-ha1>`
-- :ref:`os-nosdn-ovs-noha <os-nosdn-ovs-noha1>`
-- :ref:`os-nosdn-calipso-noha <os-nosdn-calipso-noha>`
-- :ref:`os-nosdn-ovs_dpdk-ha <os-nosdn-ovs_dpdk-ha>`
-- :ref:`os-nosdn-ovs_dpdk-noha <os-nosdn-ovs_dpdk-noha>`
-- :ref:`os-odl-fdio-dvr-noha <os-odl-fdio-dvr-noha>`
-- :ref:`os-nosdn-fdio-ha <os-nosdn-fdio-ha>`
-- :ref:`os-nosdn-kvm_ovs_dpdk-ha <os-nosdn-kvm_ovs_dpdk-ha>`
-- :ref:`os-odl_l2-moon-ha <os-odl_l2-moon-ha>`
-- :ref:`k8-nosdn-lb-noha <k8-nosdn-lb-noha>`
-- :ref:`os-odl-sfc-ha <os-odl-sfc-ha>`
-- :ref:`os-onos-sfc-ha <os-onos-sfc-ha>`
-- :ref:`os-nosdn-ovs_dpdk-ha <os-nosdn-ovs_dpdk-ha>`
-- :ref:`os-nosdn-openbaton-ha <os-nosdn-openbaton-ha>`
-- :ref:`k8-ovn-lb-noha <k8-ovn-lb-noha>`
-- :ref:`os-nosdn-bar-ha <os-nosdn-bar-ha>`
-- :ref:`os-nosdn-bar-noha <os-nosdn-bar-noha>`
+Implementation projects
+=======================
-Installation Procedure
-======================
+- :ref:`Barometer Installation Guide <barometer-docker-userguide>`
-Detailed step by step instructions for working with an installation toolchain and installing
-the required scenario are provided by the installation projects. The projects providing installation
-support for the OPNFV Euphrates release are: Apex, Compass4nfv, Daisy4NFV, Fuel and JOID.
+Testing projects and frameworks
+===============================
-The instructions for each toolchain can be found in these links:
+- :ref:`ViNePERF installation Guide <vineperf-installation>`
+- :doc:`Functest Installation Guide <functest:testing/user/configguide/index>`
-- :ref:`Apex installation instruction <apex-installation>`
-- :ref:`Compass4nfv installation instruction <compass4nfv-installation>`
-- :ref:`Daisy installation instruction <daisy-installation>`
-- :ref:`Fuel installation instruction <fuel-installation>`
-- :ref:`JOID installation instruction <joid-installation>`
+Testing can be started after the installation of the test frameworks. The basic deployment validation only addresses
+some of the generic capabilities of cloud infrastructures. To run more exhaustive tests, some investigation is
+required to select the right test suites to run.
-OPNFV Test Frameworks
-=====================
+For more instructions on using the Anuket testing projects after installation, see :ref:`this document <testing-userguide>`.
-If you have elected to install the OPNFV platform using the deployment toolchain provided by OPNFV,
-your system will have been validated once the installation is completed.
-The basic deployment validation only addresses a small part of capabilities in
-the platform and you may want to execute more exhaustive tests. Some investigation will be required to
-select the right test suites to run on your platform.
+Integration projects
+====================
-Many of the OPNFV test project provide user-guide documentation and installation instructions in :ref:`this document <testing-userguide>`
+- :ref:`Kuberef Installation Guide <kuberef-installation>`
diff --git a/docs/release/overview.rst b/docs/release/overview.rst
index c7614de5c..3014da40f 100644
--- a/docs/release/overview.rst
+++ b/docs/release/overview.rst
@@ -4,6 +4,8 @@
.. SPDX-License-Identifier: CC-BY-4.0
.. (c) Open Platform for NFV Project, Inc. and its contributors
+NOTE: This Document will be updated for Anuket in the Lakelse Release.
+
=================
Platform overview
=================
@@ -28,20 +30,16 @@ NFV use cases. OPNFV also works upstream with other open source communities to b
and learnings from its work directly to those communities in the form of blueprints, patches, bugs,
and new code.
-OPNFV focuses on building NFV Infrastructure (NFVI) and Virtualised Infrastructure
-Management (VIM) by integrating components from upstream projects such as OpenDaylight, ONOS, OpenContrail,
-OVN, OpenStack, Kubernetes, Ceph Storage, KVM, Open vSwitch, and Linux.
-More recently, OPNFV has extended its portfolio of forwarding solutions to include DPDK, fd.io and ODP,
-is able to run on both Intel and ARM commercial and white-box hardware, support VM, Container and
-BareMetal workloads, and includes Management and Network Orchestration MANO components primarily
-for application composition and management in the Danube release.
+OPNFV focuses on building NFV Infrastructure (NFVI) and Virtualized Infrastructure Management (VIM) by
+integrating components from upstream projects such as OpenDaylight, OVN, OpenStack, Kubernetes,
+Ceph Storage, KVM, Open vSwitch, Linux, DPDK and FD.io. OPNFV- is able to run on both Intel and
+ARM commercial and white-box hardware, support VM, Container and BareMetal workloads.
These capabilities, along with application programmable interfaces (APIs) to other NFV
elements, form the basic infrastructure required for Virtualized Network Functions (VNF)
and MANO components.
-Concentrating on these components while also considering proposed projects on additional
-topics (such as the MANO components and applications themselves), OPNFV aims to enhance
+Concentrating on these components, OPNFV aims to enhance
NFV services by increasing performance and power efficiency improving reliability,
availability and serviceability, and delivering comprehensive platform instrumentation.
@@ -55,7 +53,7 @@ platform including common hardware requirements, software architecture, MANO and
OPNFV Platform Overview Diagram
-.. image:: ../images/diagram_euphrates.png
+.. image:: ../images/hunter.png
:alt: Overview infographic of the opnfv platform and projects.
@@ -64,7 +62,6 @@ into the following basic building blocks:
* Hardware: Infrastructure working group, Pharos project and associated activities
* Software Platform: Platform integration and deployment projects
-* MANO: MANO working group and associated projects
* Tooling and testing: Testing working group and test projects
* Applications: All other areas and drive requirements for OPNFV
@@ -88,9 +85,10 @@ performance characteristics.
Community labs are hosted by OPNFV member companies on a voluntary basis.
The Linux Foundation also hosts an OPNFV lab that provides centralized CI
and other production resources which are linked to community labs.
-Future lab capabilities will include the ability easily automate deploy and test of any
-OPNFV install scenario in any lab environment as well as on a nested "lab as a service"
-virtual infrastructure.
+
+The Lab-as-a-service (LaaS) offering provides developers to readily access NFV infrastructure on demand.
+Ongoing lab capabilities will include the ability to easily automate deployment and test of any OPNFV install
+scenario in any lab environment using a concept called “Dynamic CI”.
OPNFV Software Platform Architecture
====================================
@@ -104,22 +102,21 @@ components in conjunction with our upstream communities.
Virtual Infrastructure Management
---------------------------------
-OPNFV derives it's virtual infrastructure management from one of our largest upstream ecosystems
-OpenStack. OpenStack provides a complete reference cloud management system and associated technologies.
-While the OpenStack community sustains a broad set of projects, not all technologies are relevant in
-the NFV domain, the OPNFV community consumes a sub-set of OpenStack projects and the usage and
-composition may vary depending on the installer and scenario.
+OPNFV derives its Virtual Infrastructure Management from OpenStack and Kubernetes. OpenStack provides a
+complete reference cloud management system and associated technologies. While the OpenStack community
+sustains a broad set of projects, not all technologies are relevant in the NFV domain, the OPNFV community
+consumes a sub-set of OpenStack projects and the usage and composition may vary depending on the installer and scenario.
+Additionally, OPNFV also uses Kubernetes, the popular Container Orchestration Engine. Kubernetes is intended to be a VIM for
+Cloud Native Network Functions (CNFs).
For details on the scenarios available in OPNFV and the specific composition of components
refer to the :ref:`OPNFV User Guide & Configuration Guide <opnfv-user-config>`.
-OPNFV now also has initial support for containerized VNFs.
-
-----------------
Operating Systems
-----------------
-OPNFV currently uses Linux on all target machines, this can include Ubuntu, Centos or SUSE Linux. The
+OPNFV currently uses Linux on all target machines. The
specific version of Linux used for any deployment is documented in the installation guide.
Networking Technologies
@@ -141,10 +138,8 @@ being worked on by the community during this release of OPNFV include:
interface devices (e.g., vNICs) managed by other OpenStack services (e.g. Nova).
* OpenDaylight: addresses multivendor, traditional and greenfield networks, establishing the
industry’s de facto SDN platform and providing the foundation for networks of the future.
-* OpenContrail: An open source SDN controller designed for cloud and NFV use cases. It has an
- analytics engine, well defined northbound REST APIs to configure and gather ops/analytics data.
-* OVN: A virtual networking solution developed by the same team that created OVS. OVN stands for
- Open Virtual Networking and is dissimilar from the above projects in that it focuses only on overlay networks.
+* OVN: a distributed control-plane on top of the popular Open vSwitch (OVS) offers network virtualization
+ services.
----------
Data Plane
@@ -162,16 +157,6 @@ networks.
* DPDK: a set of libraries that bypass the kernel and provide polling mechanisms, instead of interrupt based operations,
to speed up packet processing. DPDK works with both OVS and FD.io.
-----
-MANO
-----
-OPNFV integrates open source MANO projects for NFV orchestration and VNF management.
-New MANO projects are constantly being added, currently OPNFV integrates:
-* OpenBaton: Open Baton is a ETSI NFV compliant Management and Orchestration (MANO) Framework.
- It enables virtual Network Services deployments on top of heterogeneous NFV Infrastructures.
- OpenBaton is also used to deploy vIMS (clearwater and openIMS).
-
-
Deployment Architecture
=======================
@@ -249,6 +234,9 @@ There are two types of test cases in Yardstick:
* OPNFV feature test cases include basic telecom feature testing from OPNFV projects;
for example nfv-kvm, sfc, ipv6, Parser, Availability and SDN VPN
+With the addition of the Network Service Benchmarking (NSB) initiative, it is possible to use Yardstick NSB
+for benchmarking the performance of VNFs and Network Services.
+
System Evaluation and compliance testing
========================================
@@ -257,12 +245,9 @@ behaviors and capabilities for NFV systems developed externally from the OPNFV e
evaluate and measure their ability to provide the features and capabilities developed in the
OPNFV ecosystem.
-The Dovetail project will provide a test framework and methodology able to be used on any NFV platform,
+The Dovetail project provides a test framework and methodology able to be used on any NFV platform,
including an agreed set of test cases establishing an evaluation criteria for exercising
-an OPNFV compatible system. The Dovetail project has begun establishing the test framework
-and will provide a preliminary methodology for the Danube release. Work will continue to
-develop these test cases to establish a stand alone compliance evaluation solution
-in future releases.
+an OPNFV compatible system.
Additional Testing
==================
@@ -287,13 +272,6 @@ NFVBench
NFVbench is a lightweight end-to-end dataplane benchmarking framework project.
It includes traffic generator(s) and measures a number of packet performance related metrics.
-----
-QTIP
-----
-QTIP boils down NFVI compute and storage performance into one single metric for easy comparison.
-QTIP crunches these numbers based on five different categories of compute metrics and relies on
-Storperf for storage metrics.
-
--------
Storperf
--------
diff --git a/docs/release/release-notes.rst b/docs/release/release-notes.rst
index 8aad8a4d6..9f7f08061 100644
--- a/docs/release/release-notes.rst
+++ b/docs/release/release-notes.rst
@@ -2,64 +2,25 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
+.. (c) Anuket CCC, AT&T, and other contributors
=============
Release Notes
=============
-Release notes as provided by participating projects in OPNFV are captured in this section.
+Release notes as provided by participating projects in Anuket are captured in this section.
These include details of software versions used, known limitations, and outstanding trouble
reports.
Project release notes:
----------------------
-:ref:`Apex Release Notes <apex-releasenotes>`
-
-:ref:`Auto Release Notes <auto-releasenotes>`
-
:ref:`Barometer Release Notes <barometer-releasenotes>`
-:ref:`Bottlenecks Release Notes <bottlenecks-releasenotes>`
-
-:ref:`Compass4nfv Release Notes <compass4nfv-releasenotes>`
-
-:ref:`Daisy Release Notes <daisy-releasenotes>`
-
-:ref:`Doctor Release Notes <doctor-releasenotes>`
-
-:ref:`FDS Release Notes <fds-releasenotes>`
-
-:ref:`Fuel Release Notes <fuel-releasenotes>`
+:ref:`CIRV-SDV Release Notes <cirv-sdv-releasenotes>`
:ref:`Functest Release Notes <functest-releasenotes>`
-:ref:`IPV6 Release Notes <ipv6-releasenotes>`
-
-:ref:`Joid Release Notes <joid-releasenotes>`
-
-:ref:`KVMforNFV Release Notes <kvmfornfv-releasenotes>`
-
-:ref:`Moon Release Notes <moon-releasenotes>`
-
-:ref:`Netready Release Notes <netready-releasenotes>`
-
-:ref:`NFVBench Release Notes <nfvbench-releasenotes>`
-
-:ref:`Orchestra Release Notes <orchestra-releasenotes>`
-
-:ref:`Parser Release Notes <parser-releasenotes>`
-
-:ref:`Promise Release Notes <promise-releasenotes>`
-
-:ref:`QTIP Release Notes <qtip-releasenotes>`
-
-:ref:`SampleVNF Release Notes <samplevnf-releasenotes>`
-
-:ref:`SDNVPN Release Notes <sdnvpn-releasenotes>`
-
-:ref:`SFC Release Notes <sfc-releasenotes>`
-
-:ref:`VSPERF Release Notes <vswitchperf-releasenotes>`
+:ref:`Kuberef Release Notes <kuberef-releasenotes>`
-:ref:`Yardstick Release Notes <yardstick-releasenotes>`
+:ref:`ViNePERF Release Notes <vineperf-releasenotes>`
diff --git a/docs/release/subrelease.rst b/docs/release/subrelease.rst
index 075fcbde1..e39b6ca79 100644
--- a/docs/release/subrelease.rst
+++ b/docs/release/subrelease.rst
@@ -2,42 +2,4 @@
Subrelease Guides
==================
-Apex
------
-.. toctree::
- :maxdepth: 1
-
- ../submodules/apex/docs/releasenotes/index
- ../submodules/apex/docs/installationprocedure/index
-
-Compass
---------
-.. toctree::
- :maxdepth: 1
-
- ../submodules/compass4nfv/docs/releasenotes/index
- ../submodules/compass4nfv/docs/installationprocedure/index
-
-Daisy
--------
-.. toctree::
- :maxdepth: 1
-
- ../submodules/daisy/docs/release/release-notes/index
- ../submodules/daisy/docs/release/installation/index
-
-Fuel
------
-.. toctree::
- :maxdepth: 1
-
- ../submodules/fuel/docs/releasenotes/index
- ../submodules/fuel/docs/installationprocedure/index
-
-Joid
------
-.. toctree::
- :maxdepth: 1
-
- ../submodules/joid/docs/releasenotes/index
- ../submodules/joid/docs/installationprocedure/index
+None.
diff --git a/docs/release/userguide.introduction.rst b/docs/release/userguide.introduction.rst
index 3b747e61e..827d2c7b8 100644
--- a/docs/release/userguide.introduction.rst
+++ b/docs/release/userguide.introduction.rst
@@ -2,91 +2,59 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. SPDX-License-Identifier: CC-BY-4.0
-.. (c) Sofia Wallin (sofia.wallin@ericsson.com) and other contributors
+.. (c) Anuket CCC, AT&T, and other contributors
================================
-User Guide & Configuration Guide
+User Guide and Configuration Guide
================================
Abstract
========
-OPNFV is a collaborative project aimed at providing a variety of virtualisation
-deployments intended to host applications serving the networking and carrier
-industries. This document provides guidance and instructions for using platform
-features designed to support these applications that are made available in the OPNFV
-Fraser release.
-
-This document is not intended to replace or replicate documentation from other
-upstream open source projects such as KVM, OpenDaylight, OpenStack, etc., but to highlight the
-features and capabilities delivered through the OPNFV project.
+One of Anuket's project goals is to reduce time to integrate and deploy cloud infrastructures and onboard VNF/CNFs for
+those who supply components and those who operationalize these platforms. The Anuket community does this by
+implementing, testing and deploying tools for conformance and performance of cloud infrastructures, aligned with
+industry reference architectures. This document provides guidance and instructions for using platform features designed
+to support the tools that are made available in the Anuket project.
+This document is not intended to replace or replicate documentation from other upstream open source projects such as
+KVM, OpenDaylight, OpenStack, etc., but to highlight the features and capabilities delivered through the Anuket project.
Introduction
============
-OPNFV provides a suite of scenarios, infrastructure deployment options, which
-are able to be installed to host virtualised network functions (VNFs).
-This document intends to help users of the platform leverage the features and
-capabilities delivered by OPNFV.
+Anuket provides infrastructure deployment options, which are able to be installed to host virtualised network functions
+(VNFs) and cloud native network functions (CNFs). This document intends to help users leverage the features and
+capabilities delivered by Anuket.
+
+Feature overview
+================
-OPNFVs' Continuous Integration builds, deploys and tests combinations of virtual
-infrastructure components in what are defined as scenarios. A scenario may
-include components such as KVM, OpenDaylight, OpenStack, OVS, etc., where each
-scenario will include different source components or configurations. Scenarios
-are designed to enable specific features and capabilities in the platform that
-can be leveraged by the OPNFV user community.
+The following links outline the feature deliverables from Anuket sub-projects. Each of the sub-projects provide detailed
+descriptions about the features delivered including use cases, implementation, and configuration specifics in the
+sub-project documentation.
+The following Configuration Guides and User Guides assume that the reader already has some knowledge about a given
+sub-project's specifics and capabilities. These Guides are intended to allow users to deploy and implement features that
+are part of the Anuket release.
-Feature Overview
-================
+The `Anuket developer wiki <http://wiki.anuket.io>`_ might contain more details about the specific projects.
+
+Configuration guides
+====================
+
+* :ref:`Barometer Configuration Guide <barometer-configguide>`
+* :ref:`CIRV-SDV Configuration Guide <cirv-sdv-configguide>`
+* :ref:`Kuberef Configuration Guide <kuberef-configguide>`
+* :doc:`ViNePERF Configuration Guide <vineperf:testing/user/configguide/index>`
+* :doc:`Functest Configuration Guide <functest:testing/user/configguide/index>`
+
+User guides
+===========
-The following links outline the feature deliverables from participating OPNFV
-projects in the Fraser release. Each of the participating projects provides
-detailed descriptions about the delivered features including use cases,
-implementation, and configuration specifics.
-
-The following Configuration Guides and User Guides assume that the reader already has some
-knowledge about a given project's specifics and deliverables. These Guides
-are intended to be used following the installation with an OPNFV installer
-to allow users to deploy and implement feature delivered by OPNFV.
-
-If you are unsure about the specifics of a given project, please refer to the
-OPNFV wiki page at http://wiki.opnfv.org for more details.
-
-
-Feature Configuration Guides
-============================
-
-- :ref:`Auto Configuration Guide <auto-configguide>`
-- :ref:`Barometer Configuration Guide <barometer-configguide>`
-- :ref:`Doctor Configuration Guide <doctor-configguide>`
-- :ref:`Domino Configuration Guide <domino-configguide>`
-- :ref:`IPv6 Configuration Guide <ipv6-configguide>`
-- :ref:`KVMforNFV Configuration Guide <kvmfornfv-configguide>`
-- :ref:`Moon Configuration Guide <moon-configguide>`
-- :ref:`Netready Configuration Guide <netready-configguide>`
-- :ref:`ONOSFW Configuration Guide <onosfw-configguide>`
-- :ref:`Orchestra Configuration Guide <orchestra-configguide>`
-- :ref:`Parser Configuration Guide <parser-configguide>`
-- :ref:`Promise Configuration Guide <promise-configguide>`
-- :ref:`SDNVPN Configuration Guide <sdnvpn-configguide>`
-- :ref:`SFC Configuration Guide <sfc-configguide>`
-
-
-Feature User Guides
-===================
-
-- :ref:`Auto User Guide <auto-userguide>`
-- :ref:`Barometer User Guide <barometer-userguide>`
-- :ref:`Doctor User Guide <doctor-userguide>`
-- :ref:`Domino User Guide <domino-userguide>`
-- :ref:`IPv6 User Guide <ipv6-userguide>`
-- :ref:`KVMforNFV User Guide <kvmfornfv-userguide>`
-- :ref:`OpenContrail Virtual Networking User Guide <ovno-userguide>`
-- :ref:`Orchestra User Guide <orchestra-userguide>`
-- :ref:`Parser User Guide <parser-userguide>`
-- :ref:`Promise User Guide <promise-userguide>`
-- :ref:`SDNVPN User Guide <sdnvpn-userguide>`
-- :ref:`SFC User Guide <sfc-userguide>`
+* :ref:`Barometer User Guide <barometer-userguide>`
+* :ref:`CIRV-SDV User Guide <cirv-sdv-userguide>`
+* :ref:`Kuberef User Guide <kuberef-userguide>`
+* :doc:`ViNePerf Configuration and User Guide <vineperf:testing/user/configguide/index>`
+* :doc:`Functest User Guide <functest:testing/user/userguide/index>`
diff --git a/docs/requirements.txt b/docs/requirements.txt
new file mode 100644
index 000000000..c67f212a7
--- /dev/null
+++ b/docs/requirements.txt
@@ -0,0 +1,6 @@
+# The order of packages is significant, because pip processes them in the order
+# of appearance. Changing the order has an impact on the overall integration
+# process, which may cause wedges in the gate later.
+sphinx==4.5.0 # BSD
+doc8==0.11.2 # Apache-2.0
+piccolo-theme==0.16.0 # MIT
diff --git a/docs/submodules/apex b/docs/submodules/apex
deleted file mode 160000
-Subproject 94ce44fe6e3450a1217ec3838a43049e53da9f6
diff --git a/docs/submodules/armband b/docs/submodules/armband
deleted file mode 160000
-Subproject 5491081be01a3ec9cedc5a8f57a07510ef951a3
diff --git a/docs/submodules/auto b/docs/submodules/auto
deleted file mode 160000
-Subproject a85a3366e4ca2094facf69b696e0c03e97ab45d
diff --git a/docs/submodules/availability b/docs/submodules/availability
deleted file mode 160000
-Subproject c1ee3631b59009ff61450808e2bd33fe1d4b17f
diff --git a/docs/submodules/barometer b/docs/submodules/barometer
deleted file mode 160000
-Subproject ed61877e2ba389ada8c4e60160b43e999f23d60
diff --git a/docs/submodules/bottlenecks b/docs/submodules/bottlenecks
deleted file mode 160000
-Subproject 73bd5d30fb9d5ee3bc01d78b431282332a53b44
diff --git a/docs/submodules/calipso b/docs/submodules/calipso
deleted file mode 160000
-Subproject 8f3b074fafd2271557a152f43a676abaee6a32e
diff --git a/docs/submodules/clover b/docs/submodules/clover
deleted file mode 160000
-Subproject 867c4309a10df56eeb5098a78956e5d6951b8ba
diff --git a/docs/submodules/compass4nfv b/docs/submodules/compass4nfv
deleted file mode 160000
-Subproject 3ede18e758c77b31e56ca9164dbeb8e06b0223b
diff --git a/docs/submodules/container4nfv b/docs/submodules/container4nfv
deleted file mode 160000
-Subproject 84ce45c8bf6e03f0373d9c46e0a8b7e0b3faa60
diff --git a/docs/submodules/copper b/docs/submodules/copper
deleted file mode 160000
-Subproject 37434bd4a46f7df1d3e41e9bbe613f3a2827638
diff --git a/docs/submodules/daisy b/docs/submodules/daisy
deleted file mode 160000
-Subproject 6a7ee18538561c772b0bfbc48805e2a2de74a9c
diff --git a/docs/submodules/doctor b/docs/submodules/doctor
deleted file mode 160000
-Subproject 697f0cc6ed39b139a2ef022b8e5ef8ef80bbff1
diff --git a/docs/submodules/domino b/docs/submodules/domino
deleted file mode 160000
-Subproject eb2fbb1315e6489dd159c8227030d035bdeb186
diff --git a/docs/submodules/dovetail b/docs/submodules/dovetail
deleted file mode 160000
-Subproject 749946dcc5b17cfca43c6e8692359f4972e48b2
diff --git a/docs/submodules/escalator b/docs/submodules/escalator
deleted file mode 160000
-Subproject 96c35cdeba27d2e290cb9bd254b3871452ea623
diff --git a/docs/submodules/fastpathmetrics b/docs/submodules/fastpathmetrics
deleted file mode 160000
-Subproject 5541131a92d2616e08daa9ea3374ff808d20ad4
diff --git a/docs/submodules/fds b/docs/submodules/fds
deleted file mode 160000
-Subproject 6eb4ed8ce9be7135ec65318b7b833f3c487498b
diff --git a/docs/submodules/fuel b/docs/submodules/fuel
deleted file mode 160000
-Subproject ed7bb355c93af5c163d5ae7926012652021abf7
diff --git a/docs/submodules/functest b/docs/submodules/functest
deleted file mode 160000
-Subproject 03b09edc5991ee93677131e25c4e4ac1517edb2
diff --git a/docs/submodules/ipv6 b/docs/submodules/ipv6
deleted file mode 160000
-Subproject dfcc0745ef76e684593c8284f9dcb81cca2f795
diff --git a/docs/submodules/joid b/docs/submodules/joid
deleted file mode 160000
-Subproject 104906bfb36c79c0837349ffe7ecb22fd82b44c
diff --git a/docs/submodules/kvmfornfv b/docs/submodules/kvmfornfv
deleted file mode 160000
-Subproject 5f28ffec33fb4b548353854abf51ff75b9814c3
diff --git a/docs/submodules/moon b/docs/submodules/moon
deleted file mode 160000
-Subproject e93c1de651a76f06ef0a3f247db4be5a4086013
diff --git a/docs/submodules/multisite b/docs/submodules/multisite
deleted file mode 160000
-Subproject 05394d97a05f589e9b2dcb21a3b4606368e82f5
diff --git a/docs/submodules/netready b/docs/submodules/netready
deleted file mode 160000
-Subproject a0f1cb6d759679e66d6da7fcd0471ddca22b5b6
diff --git a/docs/submodules/nfvbench b/docs/submodules/nfvbench
deleted file mode 160000
-Subproject e456fff7801702f1cf672d9ebda54eabd5100ec
diff --git a/docs/submodules/octopus b/docs/submodules/octopus
deleted file mode 160000
-Subproject 1c1b92913c93cfddb9fee16bc9c15b1873fc4e0
diff --git a/docs/submodules/onosfw b/docs/submodules/onosfw
deleted file mode 160000
-Subproject e3d61c3ff1cd23d27389794186cf45b4befc634
diff --git a/docs/submodules/opera b/docs/submodules/opera
deleted file mode 160000
-Subproject 8485b9753cd1eb6e5d6db01821dd747316ccbff
diff --git a/docs/submodules/orchestra b/docs/submodules/orchestra
deleted file mode 160000
-Subproject 30b62474866c11465c9ae15af740378cde2c5e4
diff --git a/docs/submodules/ovn4nfv b/docs/submodules/ovn4nfv
deleted file mode 160000
-Subproject 9623c07f59e059ed0b1cdc6fdfec9c7d9996d88
diff --git a/docs/submodules/ovno b/docs/submodules/ovno
deleted file mode 160000
-Subproject 8d1f11e6e6b114bd1a21295e6b47ddf59305ee3
diff --git a/docs/submodules/ovsnfv b/docs/submodules/ovsnfv
deleted file mode 160000
-Subproject 5b7a8fe64efa5d1bc32a0c5328e073463fd2393
diff --git a/docs/submodules/parser b/docs/submodules/parser
deleted file mode 160000
-Subproject cabfeecb3259c5e22488756d91b6f72d27c4c18
diff --git a/docs/submodules/pharos b/docs/submodules/pharos
deleted file mode 160000
-Subproject c7034503e2bb8da20f2b5c678719c7c7fbe6e61
diff --git a/docs/submodules/promise b/docs/submodules/promise
deleted file mode 160000
-Subproject 7c28b66a376d8a441c40c2926b218497d63516a
diff --git a/docs/submodules/qtip b/docs/submodules/qtip
deleted file mode 160000
-Subproject 879963d90e74a4fd003bb73e8d4e50e51679f92
diff --git a/docs/submodules/releng b/docs/submodules/releng
deleted file mode 160000
-Subproject 1a1f26ad80125bb78dda21ab8742fc064078d6a
diff --git a/docs/submodules/releng-xci b/docs/submodules/releng-xci
deleted file mode 160000
-Subproject 59678e0bad4c4572d6a2933d60e996bcbdad3aa
diff --git a/docs/submodules/samplevnf b/docs/submodules/samplevnf
deleted file mode 160000
-Subproject 3981ce6fed44db09af235100526ab8bc1666e38
diff --git a/docs/submodules/sdnvpn b/docs/submodules/sdnvpn
deleted file mode 160000
-Subproject fdabb0a5e92200c09e1476be01bf4353b0823e6
diff --git a/docs/submodules/sfc b/docs/submodules/sfc
deleted file mode 160000
-Subproject 9fc412714c038f69f959105e1f5dc8e8a670d0b
diff --git a/docs/submodules/snaps b/docs/submodules/snaps
deleted file mode 160000
-Subproject bd658dbe250e93a9fa4405b99ecdb2ad1a7029b
diff --git a/docs/submodules/stor4nfv b/docs/submodules/stor4nfv
deleted file mode 160000
-Subproject 957abb60ddc82354234687328460147e19607ca
diff --git a/docs/submodules/storperf b/docs/submodules/storperf
deleted file mode 160000
-Subproject 64c8b3b561ccac6159241cd0485a3259887c6bb
diff --git a/docs/submodules/ves b/docs/submodules/ves
deleted file mode 160000
-Subproject 6e0bfeb045314a0964bffee025889619d427522
diff --git a/docs/submodules/vnf_forwarding_graph b/docs/submodules/vnf_forwarding_graph
deleted file mode 160000
-Subproject 237b13c7fbaf4fa856d32d000ef1122290c8b3f
diff --git a/docs/submodules/vswitchperf b/docs/submodules/vswitchperf
deleted file mode 160000
-Subproject 5829fcd9c14c92729820f5c5e72ca49d23257de
diff --git a/docs/submodules/yardstick b/docs/submodules/yardstick
deleted file mode 160000
-Subproject 810410c8a30ffc5f4ef48923721f816c9a6e087
diff --git a/docs/testing/developer/devguide/dev-guide.rst b/docs/testing/developer/devguide/dev-guide.rst
index 50ddf3ad3..5cf9b94d2 100644
--- a/docs/testing/developer/devguide/dev-guide.rst
+++ b/docs/testing/developer/devguide/dev-guide.rst
@@ -14,12 +14,9 @@ Testing developer guide
Introduction
============
-The OPNFV testing ecosystem is wide.
-
The goal of this guide consists in providing some guidelines for new developers
involved in test areas.
-For the description of the ecosystem, see `[DEV1]`_.
=================
Developer journey
@@ -38,11 +35,11 @@ resource accross the different projects.
If you develop new test cases, the best practice is to contribute upstream as
much as possible. You may contact the testing group to know which project - in
-OPNFV or upstream - would be the best place to host the test cases. Such
+Anuket or upstream - would be the best place to host the test cases. Such
contributions are usually directly connected to a specific project, more details
can be found in the user guides of the testing projects.
-Each OPNFV testing project provides test cases and the framework to manage them.
+Each Anuket testing project provides test cases and the framework to manage them.
As a developer, you can obviously contribute to them. The developer guide of
the testing projects shall indicate the procedure to follow.
@@ -55,18 +52,6 @@ event is organized after each release. Most of the test projects are present.
The summit is also a good opportunity to meet most of the actors `[DEV4]`_.
-Be involved in the testing group
-================================
-
-The testing group is a self organized working group. The OPNFV projects dealing
-with testing are invited to participate in order to elaborate and consolidate a
-consistant test strategy (test case definition, scope of projects, resources for
-long duration, documentation, ...) and align tooling or best practices.
-
-A weekly meeting is organized, the agenda may be amended by any participant.
-2 slots have been defined (US/Europe and APAC). Agendas and minutes are public.
-See `[DEV3]`_ for details.
-The testing group IRC channel is #opnfv-testperf
Best practices
==============
@@ -130,19 +115,17 @@ possible to prepare the environement and run tests through a CLI.
Dockerization
-------------
Dockerization has been introduced in Brahmaputra and adopted by most of the test
-projects. Docker containers are pulled on the jumphost of OPNFV POD.
-<TODO Jose/Mark/Alec>
+projects.
Code quality
------------
It is recommended to control the quality of the code of the testing projects,
and more precisely to implement some verifications before any merge:
- * pep8
- * pylint
- * unit tests (python 2.7)
- * unit tests (python 3.5)
+* pep8
+* pylint
+* unit tests
The code of the test project must be covered by unit tests. The coverage
shall be reasonable and not decrease when adding new features to the framework.
@@ -160,39 +143,13 @@ and/or traffic generation. Some of the tools can be listed as follows:
+---------------+----------------------+------------------------------------+
| Project | Tool | Comments |
+===============+======================+====================================+
-| Bottlenecks | TODO | |
-+---------------+----------------------+------------------------------------+
| Functest | Tempest | OpenStack test tooling |
| | Rally | OpenStack test tooling |
| | Refstack | OpenStack test tooling |
| | RobotFramework | Used for ODL tests |
+---------------+----------------------+------------------------------------+
-| QTIP | Unixbench | |
-| | RAMSpeed | |
-| | nDPI | |
-| | openSSL | |
-| | inxi | |
-+---------------+----------------------+------------------------------------+
-| Storperf | TODO | |
-+---------------+----------------------+------------------------------------+
| VSPERF | TODO | |
+---------------+----------------------+------------------------------------+
-| Yardstick | Moongen | Traffic generator |
-| | Trex | Traffic generator |
-| | Pktgen | Traffic generator |
-| | IxLoad, IxNet | Traffic generator |
-| | SPEC | Compute |
-| | Unixbench | Compute |
-| | RAMSpeed | Compute |
-| | LMBench | Compute |
-| | Iperf3 | Network |
-| | Netperf | Network |
-| | Pktgen-DPDK | Network |
-| | Testpmd | Network |
-| | L2fwd | Network |
-| | Fio | Storage |
-| | Bonnie++ | Storage |
-+---------------+----------------------+------------------------------------+
======================================
@@ -212,7 +169,7 @@ categories can be used to group test suites.
+----------------+-------------------------------------------------------------+
| Smoke | Set of smoke test cases/suites to validate the release |
+----------------+-------------------------------------------------------------+
-| Features | Test cases that validate a specific feature on top of OPNFV.|
+| Features | Test cases that validate a specific feature on top of Anuket|
| | Those come from Feature projects and need a bit of support |
| | for integration |
+----------------+-------------------------------------------------------------+
@@ -275,84 +232,19 @@ impairments to transmission.
These kinds of "load" will cause "disruption" which could be easily found in
system logs. It is the purpose to raise such "load" to evaluate the SUT if it
could provide an acceptable level of service or level of confidence during such
-circumstances. In Danube and Euphrates, we only considered the stress test with
-excess load over OPNFV Platform.
-
-In Danube, Bottlenecks and Yardstick project jointly implemented 2 stress tests
-(concurrently create/destroy VM pairs and do ping, system throughput limit)
-while Bottlenecks acts as the load manager calling yardstick to execute each
-test iteration. These tests are designed to test for breaking points and provide
-level of confidence of the system to users. Summary of the test cases are listed
-in the following addresses:
-
- * https://wiki.opnfv.org/display/bottlenecks/Stress+Testing+over+OPNFV+Platform
- * https://wiki.opnfv.org/download/attachments/2926539/Testing%20over%20Long%20Duration%20POD.pptx?version=2&modificationDate=1502943821000&api=v2
-
-**Stress test cases** for OPNFV Euphrates (OS Ocata) release can be seen as
-extension/enhancement of those in D release. These tests are located in
-Bottlenecks/Yardstick repo (Bottlenecks as load manager while Yardstick execute
-each test iteration):
-
- * VNF scale out/up tests (also plan to measure storage usage simultaneously): https://wiki.opnfv.org/pages/viewpage.action?pageId=12390101
- * Life-cycle event with throughputs (measure NFVI to support concurrent
- network usage from different VM pairs):
- https://wiki.opnfv.org/display/DEV/Intern+Project%3A+Baseline+Stress+Test+Case+for+Bottlenecks+E+Release
-
-In OPNFV E release, we also plan to do **long duration testing** over OS Ocata.
-A separate CI pipe testing OPNFV XCI (OSA) is proposed to accomplish the job.
-We have applied specific pod for the testing.
-Proposals and details are listed below:
- * https://wiki.opnfv.org/display/testing/Euphrates+Testing+needs
- * https://wiki.opnfv.org/download/attachments/2926539/testing%20evolution%20v1_4.pptx?version=1&modificationDate=1503937629000&api=v2
- * https://wiki.opnfv.org/download/attachments/2926539/Testing%20over%20Long%20Duration%20POD.pptx?version=2&modificationDate=1502943821000&api=v2
-
-The long duration testing is supposed to be started when OPNFV E release is
-published.
-A simple monitoring module for these tests is also planned to be added:
-https://wiki.opnfv.org/display/DEV/Intern+Project%3A+Monitoring+Stress+Testing+for+Bottlenecks+E+Release
+circumstances.
=======
How TOs
=======
-Where can I find information on the different test projects?
-===========================================================
-On http://docs.opnfv.org! A section is dedicated to the testing projects. You
-will find the overview of the ecosystem and the links to the project documents.
-
-Another source is the testing wiki on https://wiki.opnfv.org/display/testing
-
-You may also contact the testing group on the IRC channel #opnfv-testperf or by
-mail at test-wg AT lists.opnfv.org (testing group) or opnfv-tech-discuss AT
-lists.opnfv.org (generic technical discussions).
-
-
How can I contribute to a test project?
=======================================
As any project, the best solution is to contact the project. The project
members with their email address can be found under
https://git.opnfv.org/<project>/tree/INFO
-You may also send a mail to the testing mailing list or use the IRC channel
-#opnfv-testperf
-
-
-Where can I find hardware resources?
-====================================
-You should discuss this topic with the project you are working with. If you need
-access to an OPNFV community POD, it is possible to contact the infrastructure
-group. Depending on your needs (scenario/installer/tooling), it should be
-possible to find free time slots on one OPNFV community POD from the Pharos
-federation. Create a JIRA ticket to describe your needs on
-https://jira.opnfv.org/projects/INFRA.
-You must already be an OPNFV contributor. See
-https://wiki.opnfv.org/display/DEV/Developer+Getting+Started.
-
-Please note that lots of projects have their own "how to contribute" or
-"get started" page on the OPNFV wiki.
-
-
How do I integrate my tests in CI?
==================================
It shall be discussed directly with the project you are working with. It is
@@ -376,8 +268,9 @@ Click on *Spec*, the list of available methods must be displayed.
:alt: Testing Group Test API swagger
For the declaration of a new project use the POST /api/v1/projects method.
+
For the declaration of new test cases in an existing project, use the POST
- /api/v1/projects/{project_name}/cases method
+/api/v1/projects/{project_name}/cases method
.. figure:: ../../../images/CreateCase.png
:align: center
@@ -397,8 +290,6 @@ The architecture and associated API is described in previous chapter.
If you want to push your results from CI, you just have to call the API
at the end of your script.
-You can also reuse a python function defined in functest_utils.py `[DEV2]`_
-
Where can I find the documentation on the test API?
===================================================
@@ -406,8 +297,6 @@ Where can I find the documentation on the test API?
The Test API is now documented in this document (see sections above).
You may also find autogenerated documentation in
http://artifacts.opnfv.org/releng/docs/testapi.html
-A web protal is also under construction for certification at
-http://testresults.opnfv.org/test/#/
I have tests, to which category should I declare them?
======================================================
@@ -442,20 +331,9 @@ http://artifacts.opnfv.org/<project name>
References
==========
-`[DEV1]`_: OPNFV Testing Ecosystem
-
-`[DEV2]`_: Python code sample to push results into the Database
-
-`[DEV3]`_: Testing group wiki page
-
`[DEV4]`_: Conversation with the testing community, OPNFV Beijing Summit
`[DEV5]`_: GS NFV 003
-.. _`[DEV1]`: http://docs.opnfv.org/en/latest/testing/ecosystem/index.html
-.. _`[DEV2]`: https://git.opnfv.org/functest/tree/functest/utils/functest_utils.py#176
-.. _`[DEV3]`: https://wiki.opnfv.org/display/meetings/Test+Working+Group+Weekly+Meeting
.. _`[DEV4]`: https://www.youtube.com/watch?v=f9VAUdEqHoA
-.. _`[DEV5]`: http://www.etsi.org/deliver/etsi_gs/NFV/001_099/003/01.01.01_60/gs_NFV003v010101p.pdf
-
-IRC support chan: #opnfv-testperf
+.. _`[DEV5]`: http://www.etsi.org/deliver/etsi_gs/NFV/001_099/003/01.01.01_60/gs_NFV003v010101p.pdf \ No newline at end of file
diff --git a/docs/testing/developer/devguide/index.rst b/docs/testing/developer/devguide/index.rst
index f661ed335..93faaffed 100644
--- a/docs/testing/developer/devguide/index.rst
+++ b/docs/testing/developer/devguide/index.rst
@@ -1,3 +1,5 @@
+.. _developer-devguide:
+
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. (c) Christopher Price (Ericsson AB)
@@ -9,5 +11,4 @@ Test Framework Overview
.. toctree::
:maxdepth: 2
- ./abstract
./dev-guide
diff --git a/docs/testing/ecosystem/energy-monitoring.rst b/docs/testing/ecosystem/energy-monitoring.rst
deleted file mode 100644
index fa1f28214..000000000
--- a/docs/testing/ecosystem/energy-monitoring.rst
+++ /dev/null
@@ -1,260 +0,0 @@
-.. _energy-monitoring:
-
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. SPDX-License-Identifier: CC-BY-4.0
-.. (c) Open Platform for NFV Project, Inc. and its contributors
-
-Power Consumption Monitoring Framework
-======================================
-
-Introduction
-------------
-Power consumption is a key driver for NFV.
-As an end user is interested to know which application is good or bad regarding
-power consumption and explains why he/she has to plug his/her smartphone every
-day, we would be interested to know which VNF is power consuming.
-
-Power consumption is hard to evaluate empirically. It is however possible to
-collect information and leverage Pharos federation to try to detect some
-profiles/footprints.
-In fact thanks to CI, we know that we are running a known/deterministic list of
-cases. The idea is to correlate this knowledge with the power consumption to try
-at the end to find statistical biais.
-
-
-High Level Architecture
------------------------
-
-The energy recorder high level architecture may be described as follows:
-
-.. figure:: ../../images/energyrecorder.png
- :align: center
- :alt: Energy recorder high level architecture
-
-The energy monitoring system in based on 3 software components:
-
- * Power info collector: poll server to collect instantaneous power consumption information
- * Energy recording API + influxdb: On one leg receive servers consumption and
- on the other, scenarios notfication. It then able to establish te correlation
- between consumption and scenario and stores it into a time-series database (influxdb)
- * Python SDK: A Python SDK using decorator to send notification to Energy
- recording API from testcases scenarios
-
-Power Info Collector
---------------------
-It collects instantaneous power consumption information and send it to Event
-API in charge of data storing.
-The collector use different connector to read the power consumption on remote
-servers:
-
- * IPMI: this is the basic method and is manufacturer dependent. Depending on manufacturer, refreshing delay may vary (generally for 10 to 30 sec.)
- * RedFish: redfish is an industry RESTFUL API for hardware managment. Unfortunatly it is not yet supported by many suppliers.
- * ILO: HP RESTFULL API: This connector support as well 2.1 as 2.4 version of HP-ILO
-
-IPMI is supported by at least:
-
- * HP
- * IBM
- * Dell
- * Nokia
- * Advantech
- * Lenovo
- * Huawei
-
-Redfish API has been successfully tested on:
-
- * HP
- * Dell
- * Huawei (E9000 class servers used in OPNFV Community Labs are IPMI 2.0
- compliant and use Redfish login Interface through Browsers supporting JRE1.7/1.8)
-
-Several test campaigns done with physical Wattmeter showed that IPMI results
-were notvery accurate but RedFish were. So if Redfish is available, it is
-highly recommended to use it.
-
-Installation
-^^^^^^^^^^^^
-
-To run the server power consumption collector agent, you need to deploy a
-docker container locally on your infrastructure.
-
-This container requires:
-
- * Connectivy on the LAN where server administration services (ILO, eDrac, IPMI,...) are configured and IP access to the POD's servers
- * Outgoing HTTP access to the Event API (internet)
-
-Build the image by typing::
-
- curl -s https://raw.githubusercontent.com/bherard/energyrecorder/master/docker/server-collector.dockerfile|docker build -t energyrecorder/collector -
-
-Create local folder on your host for logs and config files::
-
- mkdir -p /etc/energyrecorder
- mkdir -p /var/log/energyrecorder
-
-In /etc/energyrecorder create a configuration for logging in a file named
-collector-logging.conf::
-
- curl -s https://raw.githubusercontent.com/bherard/energyrecorder/master/server-collector/conf/collector-logging.conf.sample > /etc/energyrecorder/collector-logging.conf
-
-Check configuration for this file (folders, log levels.....)
-In /etc/energyrecorder create a configuration for the collector in a file named
-collector-settings.yaml::
-
- curl -s https://raw.githubusercontent.com/bherard/energyrecorder/master/server-collector/conf/collector-settings.yaml.sample > /etc/energyrecorder/collector-settings.yaml
-
-Define the "PODS" section and their "servers" section according to the
-environment to monitor.
-Note: The "environment" key should correspond to the pod name, as defined in
-the "NODE_NAME" environment variable by CI when running.
-
-**IMPORTANT NOTE**: To apply a new configuration, you need to kill the running
-container an start a new one (see below)
-
-Run
-^^^
-
-To run the container, you have to map folder located on the host to folders in
-the container (config, logs)::
-
- docker run -d --name energy-collector --restart=always -v /etc/energyrecorder:/usr/local/energyrecorder/server-collector/conf -v /var/log/energyrecorder:/var/log/energyrecorder energyrecorder/collector
-
-
-Energy Recording API
---------------------
-An event API to insert contextual information when monitoring energy (e.g.
-start Functest, start Tempest, destroy VM, ..)
-It is associated with an influxDB to store the power consumption measures
-It is hosted on a shared environment with the folling access points:
-
-+------------------------------------+----------------------------------------+
-| Component | Connectivity |
-+====================================+========================================+
-| Energy recording API documentation | http://energy.opnfv.fr/resources/doc/ |
-+------------------------------------+----------------------------------------+
-| influxDB (data) | http://energy.opnfv.fr:8086 |
-+------------------------------------+----------------------------------------+
-
-In you need, you can also host your own version of the Energy recording API
-(in such case, the Python SDK may requires a settings update)
-If you plan to use the default shared API, following steps are not required.
-
-Image creation
-^^^^^^^^^^^^^^
-First, you need to buid an image::
-
- curl -s https://raw.githubusercontent.com/bherard/energyrecorder/master/docker/recording-api.dockerfile|docker build -t energyrecorder/api -
-
-Setup
-^^^^^
-Create local folder on your host for logs and config files::
-
- mkdir -p /etc/energyrecorder
- mkdir -p /var/log/energyrecorder
- mkdir -p /var/lib/influxdb
-
-In /etc/energyrecorder create a configuration for logging in a file named
-webapp-logging.conf::
-
- curl -s https://raw.githubusercontent.com/bherard/energyrecorder/master/recording-api/conf/webapp-logging.conf.sample > /etc/energyrecorder/webapp-logging.conf
-
-Check configuration for this file (folders, log levels.....)
-
-In /etc/energyrecorder create a configuration for the collector in a file
-named webapp-settings.yaml::
-
- curl -s https://raw.githubusercontent.com/bherard/energyrecorder/master/recording-api/conf/webapp-settings.yaml.sample > /etc/energyrecorder/webapp-settings.yaml
-
-Normaly included configuration is ready to use except username/passwer for
-influx (see run-container.sh bellow). Use here the admin user.
-
-**IMPORTANT NOTE**: To apply a new configuration, you need to kill the running
-container an start a new one (see bellow)
-
-Run
-^^^
-To run the container, you have to map folder located on the host to folders in
-the container (config, logs)::
-
- docker run -d --name energyrecorder-api -p 8086:8086 -p 8888:8888 -v /etc/energyrecorder:/usr/local/energyrecorder/web.py/conf -v /var/log/energyrecorder/:/var/log/energyrecorder -v /var/lib/influxdb:/var/lib/influxdb energyrecorder/webapp admin-influx-user-name admin-password readonly-influx-user-name user-password
-
-with
-
-+---------------------------+--------------------------------------------+
-| Parameter name | Description |
-+===========================+============================================+
-| admin-influx-user-name | Influx user with admin grants to create |
-|---------------------------+--------------------------------------------+
-| admin-password | Influx password to set to admin user |
-|---------------------------+--------------------------------------------+
-| readonly-influx-user-name | Influx user with readonly grants to create |
-|---------------------------+--------------------------------------------+
-| user-password | Influx password to set to readonly user |
-+---------------------------+--------------------------------------------+
-
-**NOTE**: Local folder /var/lib/influxdb is the location web influx data are
-stored. You may used anything else at your convience. Just remember to define
-this mapping properly when running the container.
-
-Power consumption Python SDK
-----------------------------
-a Python SDK - almost not intrusive, based on python decorator to trigger call
-to the event API.
-
-It is currently hosted in Functest repo but if other projects adopt it, a
-dedicated project could be created and/or it could be hosted in Releng.
-
-How to use the SDK
-^^^^^^^^^^^^^^^^^^
-
-import the energy library::
-
- import functest.energy.energy as energy
-
-Notify that you want power recording in your testcase::
-
- @energy.enable_recording
- def run(self):
- self.do_some_stuff1()
- self.do_some_stuff2()
-
-If you want to register additional steps during the scenarios you can to it in
-2 different ways.
-
-Notify step on method definition::
-
- @energy.set_step("step1")
- def do_some_stuff1(self):
- ...
- @energy.set_step("step2")
- def do_some_stuff2(self):
-
-Notify directly from code::
-
- @energy.enable_recording
- def run(self):
- Energy.set_step("step1")
- self.do_some_stuff1()
- ...
- Energy.set_step("step2")
- self.do_some_stuff2()
-
-SDK Setting
-^^^^^^^^^^^
-Settings delivered in the project git are ready to use and assume that you will
-use the sahre energy recording API.
-If you want to use an other instance, you have to update the key
-"energy_recorder.api_url" in <FUNCTEST>/functest/ci/config_functest.yaml" by
-setting the proper hostname/IP
-
-Results
--------
-Here is an example of result comming from LF POD2. This sequence represents
-several CI runs in a raw. (0 power corresponds to hard reboot of the servers)
-
-You may connect http://energy.opnfv.fr:3000 for more results (ask for
-credentials to infra team).
-
-.. figure:: ../../images/energy_LF2.png
- :align: center
- :alt: Energy monitoring of LF POD2
diff --git a/docs/testing/ecosystem/index.rst b/docs/testing/ecosystem/index.rst
index 669f5cc19..f8532403c 100644
--- a/docs/testing/ecosystem/index.rst
+++ b/docs/testing/ecosystem/index.rst
@@ -9,6 +9,5 @@ Testing Framework Overview
.. toctree::
:maxdepth: 2
- ./abstract
./overview
diff --git a/docs/testing/ecosystem/overview.rst b/docs/testing/ecosystem/overview.rst
index ef7705b6f..b67cac24d 100644
--- a/docs/testing/ecosystem/overview.rst
+++ b/docs/testing/ecosystem/overview.rst
@@ -1,133 +1,70 @@
+.. _testing_overview:
+
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. SPDX-License-Identifier: CC-BY-4.0
======================
-OPNFV Testing Overview
+Anuket Testing Overview
======================
Introduction
============
-Testing is one of the key activities in OPNFV and includes unit, feature,
+Testing is one of the key activities in Anuket and includes unit, feature,
component, system level testing for development, automated deployment,
performance characterization and stress testing.
Test projects are dedicated to provide frameworks, tooling and test-cases categorized as
functional, performance or compliance testing. Test projects fulfill different roles such as
verifying VIM functionality, benchmarking components and platforms or analysis of measured
-KPIs for OPNFV release scenarios.
+KPIs for Anuket release scenarios.
Feature projects also provide their own test suites that either run independently or within a
test project.
-This document details the OPNFV testing ecosystem, describes common test components used
-by individual OPNFV projects and provides links to project specific documentation.
+This document details the Anuket testing ecosystem, describes common test components used
+by individual Anuket projects and provides links to project specific documentation.
-The OPNFV Testing Ecosystem
+The Anuket Testing Ecosystem
===========================
-The OPNFV testing projects are represented in the following diagram:
+The Anuket testing projects are represented in the following diagram:
.. figure:: ../../images/OPNFV_testing_working_group.png
:align: center
- :alt: Overview of OPNFV Testing projects
+ :alt: Overview of Anuket Testing projects
The major testing projects are described in the table below:
+----------------+---------------------------------------------------------+
| Project | Description |
+================+=========================================================+
-| Bottlenecks | This project aims to find system bottlenecks by testing |
-| | and verifying OPNFV infrastructure in a staging |
-| | environment before committing it to a production |
-| | environment. Instead of debugging a deployment in |
-| | production environment, an automatic method for |
-| | executing benchmarks which plans to validate the |
-| | deployment during staging is adopted. This project |
-| | forms a staging framework to find bottlenecks and to do |
-| | analysis of the OPNFV infrastructure. |
-+----------------+---------------------------------------------------------+
-| CPerf | SDN Controller benchmarks and performance testing, |
-| | applicable to controllers in general. Collaboration of |
-| | upstream controller testing experts, external test tool |
-| | developers and the standards community. Primarily |
-| | contribute to upstream/external tooling, then add jobs |
-| | to run those tools on OPNFV's infrastructure. |
-+----------------+---------------------------------------------------------+
-| Dovetail | This project intends to define and provide a set of |
-| | OPNFV related validation criteria/tests that will |
-| | provide input for the OPNFV Complaince Verification |
-| | Program. The Dovetail project is executed with the |
-| | guidance and oversight of the Complaince and |
-| | Certification (C&C) committee and work to secure the |
-| | goals of the C&C committee for each release. The |
-| | project intends to incrementally define qualification |
-| | criteria that establish the foundations of how one is |
-| | able to measure the ability to utilize the OPNFV |
-| | platform, how the platform itself should behave, and |
-| | how applications may be deployed on the platform. |
-+----------------+---------------------------------------------------------+
| Functest | This project deals with the functional testing of the |
| | VIM and NFVI. It leverages several upstream test suites |
| | (OpenStack, ODL, ONOS, etc.) and can be used by feature |
| | project to launch feature test suites in CI/CD. |
| | The project is used for scenario validation. |
+----------------+---------------------------------------------------------+
-| NFVbench | NFVbench is a compact and self contained data plane |
-| | performance measurement tool for OpensStack based NFVi |
-| | platforms. It is agnostic of the NFVi distribution, |
-| | Neutron networking implementation and hardware. |
-| | It runs on any Linux server with a DPDK compliant |
-| | NIC connected to the NFVi platform data plane and |
-| | bundles a highly efficient software traffic generator. |
-| | Provides a fully automated measurement of most common |
-| | packet paths at any level of scale and load using |
-| | RFC-2544. Available as a Docker container with simple |
-| | command line and REST interfaces. |
-| | Easy to use as it takes care of most of the guesswork |
-| | generally associated to data plane benchmarking. |
-| | Can run in any lab or in production environments. |
-+----------------+---------------------------------------------------------+
-| QTIP | QTIP as the project for "Platform Performance |
-| | Benchmarking" in OPNFV aims to provide user a simple |
-| | indicator for performance, supported by comprehensive |
-| | testing data and transparent calculation formula. |
-| | It provides a platform with common services for |
-| | performance benchmarking which helps users to build |
-| | indicators by themselves with ease. |
-+----------------+---------------------------------------------------------+
-| StorPerf | The purpose of this project is to provide a tool to |
-| | measure block and object storage performance in an NFVI.|
-| | When complemented with a characterization of typical VF |
-| | storage performance requirements, it can provide |
-| | pass/fail thresholds for test, staging, and production |
-| | NFVI environments. |
-+----------------+---------------------------------------------------------+
-| VSPERF | VSPERF is an OPNFV project that provides an automated |
-| | test-framework and comprehensive test suite based on |
-| | Industry Test Specifications for measuring NFVI |
-| | data-plane performance. The data-path includes switching|
-| | technologies with physical and virtual network |
-| | interfaces. The VSPERF architecture is switch and |
-| | traffic generator agnostic and test cases can be easily |
-| | customized. Software versions and configurations |
-| | including the vSwitch (OVS or VPP) as well as the |
-| | network topology are controlled by VSPERF (independent |
-| | of OpenStack). VSPERF is used as a development tool for |
-| | optimizing switching technologies, qualification of |
-| | packet processing components and for pre-deployment |
-| | evaluation of the NFV platform data-path. |
-+----------------+---------------------------------------------------------+
-| Yardstick | The goal of the Project is to verify the infrastructure |
-| | compliance when running VNF applications. NFV Use Cases |
-| | described in ETSI GS NFV 001 show a large variety of |
-| | applications, each defining specific requirements and |
-| | complex configuration on the underlying infrastructure |
-| | and test tools.The Yardstick concept decomposes typical |
-| | VNF work-load performance metrics into a number of |
-| | characteristics/performance vectors, which each of them |
-| | can be represented by distinct test-cases. |
+|  ViNePerf | ViNePerf provides an automated test-framework and |
+| | comprehensive test suite based on industry standards for|
+| | measuring the data-plane performance in different cloud |
+| | environments. Dataplane in a cloud includes different |
+| | switching technologies with physical and virtual network|
+| | interfaces, and carries traffic to and from workloads |
+| | running as virtual-machines and containers. The |
+| | architecture of ViNePerf is agnostic of cloud-type, |
+| | switching-technology, and traffic-generator. ViNePerf |
+| | allows user to customize the test-cases, |
+| | network-topology, workload-deployment, hardware- |
+| | configuration, and the versions of the software |
+| | components such vswitch, vnf, cnf, cni, etc. ViNePerf |
+| | can be used both pre-deployment and post-deployment of |
+| | the cloud. Though ViNePerf architecture is designed for |
+| | evaluation of dataplane of clouds in Lab environments, |
+| | it can also be in production clouds. ViNePerf methods |
+| | follows standards developed by the IETF and ETSI NFV, |
+| | and contribute to the development of new standards. |
+----------------+---------------------------------------------------------+
@@ -138,8 +75,8 @@ Testing Working Group Resources
Test Results Collection Framework
=================================
-Any test project running in the global OPNFV lab infrastructure and is
-integrated with OPNFV CI can push test results to the community Test Database
+Any test project running in the global Anuket lab infrastructure and is
+integrated with Anuket CI can push test results to the community Test Database
using a common Test API. This database can be used to track the evolution of
testing and analyse test runs to compare results across installers, scenarios
and between technically and geographically diverse hardware environments.
@@ -188,16 +125,17 @@ The Test Database
-----------------
A Mongo DB Database was introduced for the Brahmaputra release.
The following collections are declared in this database:
- * pods: the list of pods used for production CI
- * projects: the list of projects providing test cases
- * test cases: the test cases related to a given project
- * results: the results of the test cases
- * scenarios: the OPNFV scenarios tested in CI
+
+* pods: the list of pods used for production CI
+* projects: the list of projects providing test cases
+* test cases: the test cases related to a given project
+* results: the results of the test cases
+* scenarios: the Anuket scenarios tested in CI
This database can be used by any project through the Test API.
Please note that projects may also use additional databases. The Test
Database is mainly use to collect CI test results and generate scenario
-trust indicators. The Test Database is also cloned for OPNFV Plugfests in
+trust indicators. The Test Database is also cloned for Anuket Plugfests in
order to provide a private datastore only accessible to Plugfest participants.
@@ -262,7 +200,7 @@ The reporting page for the test projects is http://testresults.opnfv.org/reporti
:align: center
:alt: Testing group reporting page
-This page provides reporting per OPNFV release and per testing project.
+This page provides reporting per Anuket release and per testing project.
.. figure:: ../../images/reportingMaster.png
:align: center
@@ -275,7 +213,7 @@ per scenario and show:
* the status of the deployment
* the score from each test suite. There is no overall score, it is determined
- by each test project.
+ by each test project.
* a trust indicator
@@ -307,65 +245,13 @@ contains raw results.
The dashboard can be used in addition to the reporting page (high level view) to allow
the creation of specific graphs according to what the test owner wants to show.
-In Brahmaputra, a basic dashboard was created in Functest.
-In Colorado, Yardstick used Grafana (time based graphs) and ELK (complex
-graphs).
-Since Danube, the OPNFV testing community decided to adopt the ELK framework and to
-use Bitergia for creating highly flexible dashboards `[TST5]`_.
-
-.. figure:: ../../images/DashboardBitergia.png
- :align: center
- :alt: Testing group testcase catalog
-
-
-.. include:: ./energy-monitoring.rst
-
-
-OPNFV Test Group Information
-============================
-
-For more information or to participate in the OPNFV test community please see the
-following:
-
-wiki: https://wiki.opnfv.org/testing
-
-mailing list: test-wg@lists.opnfv.org
-
-IRC channel: #opnfv-testperf
-
-weekly meeting (https://wiki.opnfv.org/display/meetings/TestPerf):
- * Usual time: Every Thursday 15:00-16:00 UTC / 7:00-8:00 PST
- * APAC time: 2nd Wednesday of the month 8:00-9:00 UTC
-
=======================
Reference Documentation
=======================
-+----------------+---------------------------------------------------------+
-| Project | Documentation links |
-+================+=========================================================+
-| Bottlenecks | https://wiki.opnfv.org/display/bottlenecks/Bottlenecks |
-+----------------+---------------------------------------------------------+
-| CPerf | https://wiki.opnfv.org/display/cperf |
-+----------------+---------------------------------------------------------+
-| Dovetail | https://wiki.opnfv.org/display/dovetail |
-+----------------+---------------------------------------------------------+
-| Functest | https://wiki.opnfv.org/display/functest/ |
-+----------------+---------------------------------------------------------+
-| NFVbench | https://wiki.opnfv.org/display/nfvbench/ |
-+----------------+---------------------------------------------------------+
-| QTIP | https://wiki.opnfv.org/display/qtip |
-+----------------+---------------------------------------------------------+
-| StorPerf | https://wiki.opnfv.org/display/storperf/Storperf |
-+----------------+---------------------------------------------------------+
-| VSPERF | https://wiki.opnfv.org/display/vsperf |
-+----------------+---------------------------------------------------------+
-| Yardstick | https://wiki.opnfv.org/display/yardstick/Yardstick |
-+----------------+---------------------------------------------------------+
-
-`[TST1]`_: OPNFV web site
+`[TST1]`_: Anuket web site
`[TST2]`_: TestAPI code repository link in releng-testresults
@@ -373,10 +259,7 @@ Reference Documentation
`[TST4]`_: Testcase catalog
-`[TST5]`_: Testing group dashboard
-
-.. _`[TST1]`: http://www.opnfv.org
+.. _`[TST1]`: http://www.anuket.org
.. _`[TST2]`: https://git.opnfv.org/releng-testresults
.. _`[TST3]`: http://artifacts.opnfv.org/releng/docs/testapi.html
.. _`[TST4]`: http://testresults.opnfv.org/testing/index.html#!/select/visual
-.. _`[TST5]`: https://opnfv.biterg.io:443/goto/283dba93ca18e95964f852c63af1d1ba
diff --git a/docs/testing/testing-dev.rst b/docs/testing/testing-dev.rst
index 7f56b7bfa..8c505be9b 100644
--- a/docs/testing/testing-dev.rst
+++ b/docs/testing/testing-dev.rst
@@ -14,41 +14,18 @@ Testing group
./developer/devguide/index
-Bottlenecks
-------------
-.. toctree::
- :maxdepth: 1
-
- ../submodules/bottlenecks/docs/testing/developer/devguide/index
+Anuket Assured Program
+----------------------
+Releases of Anuket Assured program are on a separate schedule from Anuket releases. The current status and latest
+documentation for Anuket Assured can be found on the `Anuket Assured pages <https://lfnetworking.org/verification/>`_.
Functest
----------
-.. toctree::
- :maxdepth: 1
-
- ../submodules/functest/docs/testing/developer/devguide/index
-
-
-QTIP
------
-.. toctree::
- :maxdepth: 1
-
- ../submodules/qtip/docs/testing/developer/devguide/index
-
+--------
-VSPERF
--------
-.. toctree::
- :maxdepth: 1
+* :doc:`Functest Developer Guide <functest:testing/developer/devguide/index>`
- ../submodules/vswitchperf/docs/testing/developer/devguide/index
-
-
-Yardstick
----------
-.. toctree::
- :maxdepth: 1
+ViNePERF
+--------
- ../submodules/yardstick/docs/testing/developer/devguide/index
+* :doc:`ViNePERF Developer Guide <vineperf:testing/developer/devguide/index>`
diff --git a/docs/testing/testing-user.rst b/docs/testing/testing-user.rst
index c7c4709c6..8d0910006 100644
--- a/docs/testing/testing-user.rst
+++ b/docs/testing/testing-user.rst
@@ -10,63 +10,27 @@ Testing User Guides
This page provides the links to the installation, configuration and user guides
of the different test projects.
-Bottlenecks
-------------
-.. toctree::
- :maxdepth: 1
-
- ../submodules/bottlenecks/docs/testing/user/configguide/index
- ../submodules/bottlenecks/docs/testing/user/userguide/index
+Anuket Assured Program
+----------------------
+Releases of Anuket Assured program are on a separate schedule from Anuket releases. The current status and latest
+documentation for Anuket Assured can be found on the `Anuket Assured pages <https://lfnetworking.org/verification/>`_.
Functest
----------
-.. toctree::
- :maxdepth: 1
-
- ../submodules/functest/docs/testing/user/configguide/index
- ../submodules/functest/docs/testing/user/userguide/index
-
-NFVbench
------
-.. toctree::
- :maxdepth: 1
-
- ../submodules/nfvbench/docs/testing/user/userguide/index
-
-
-QTIP
------
-.. toctree::
- :maxdepth: 1
-
- ../submodules/qtip/docs/testing/user/configguide/index
- ../submodules/qtip/docs/testing/user/userguide/index
-
-
-Storperf
--------
-.. toctree::
- :maxdepth: 1
-
- ../submodules/storperf/docs/testing/user/index
+* :doc:`Functest Installation Guide <functest:testing/user/configguide/index>`
+* :doc:`Functest User Guide <functest:testing/user/userguide/index>`
+SampleVNF
+---------
-VSPERF
-------
-
-.. toctree::
- :maxdepth: 1
+* :doc:`SampleVNF User Guide <samplevnf:testing/user/userguide/index>`
- ../submodules/vswitchperf/docs/testing/user/configguide/index
- ../submodules/vswitchperf/docs/testing/user/userguide/index
+ViNePERF
+--------
+* :doc:`ViNePERF Configuration and User Guide <vineperf:testing/user/configguide/index>`
+* :doc:`ViNePERF Test Guide <vineperf:testing/user/userguide/index>`
-Yardstick
-----------
-.. toctree::
- :maxdepth: 1
- ../submodules/yardstick/docs/testing/user/configguide/index
- ../submodules/yardstick/docs/testing/user/userguide/index
diff --git a/etc/requirements.txt b/etc/requirements.txt
deleted file mode 100644
index 7550086ff..000000000
--- a/etc/requirements.txt
+++ /dev/null
@@ -1,8 +0,0 @@
-tox
-Sphinx==1.3.1
-doc8
-docutils==0.12
-setuptools
-six
-sphinxcontrib-httpdomain
-sphinx_bootstrap_theme>=0.4.11
diff --git a/opnfv-theme/MANIFEST.in b/opnfv-theme/MANIFEST.in
index a5886cd20..34bc06617 100644
--- a/opnfv-theme/MANIFEST.in
+++ b/opnfv-theme/MANIFEST.in
@@ -2,6 +2,6 @@ include *.txt
include *.rst
recursive-include sphinx_opnfv_theme *
-recursive-include sphinx_opnfv_theme/opnfv *
+recursive-include sphinx_opnfv_theme/static *
global-exclude *.pyc
diff --git a/opnfv-theme/README.rst b/opnfv-theme/README.rst
index 484a7a793..c307768fb 100644
--- a/opnfv-theme/README.rst
+++ b/opnfv-theme/README.rst
@@ -12,21 +12,23 @@ Here's how to install the theme from PyPI_
To install and configure the theme do the following.
-#. Install the theme from pypi::
+#. Install the theme from pypi:
- $ pip install sphinx_opnfv_theme
+ .. code-block:: bash
+
+ $ pip install sphinx_opnfv_theme
#. Configure Sphinx to use the theme:
-.. code-block:: python
+ .. code-block:: python
- # conf.py
- import sphinx_opnfv_theme
+ # conf.py
+ import sphinx_opnfv_theme
- # ...
+ # ...
- html_theme = 'opnfv'
- html_theme_path = sphinx_opnfv_theme.get_html_theme_path()
+ html_theme = 'opnfv'
+ html_theme_path = sphinx_opnfv_theme.get_html_theme_path()
Customization
-------------
@@ -39,7 +41,7 @@ following options for the bootstrap theme::
html_theme_options = {
'bootswatch_theme': 'journal',
- 'navbar_sidebarrel': false,
+ 'navbar_sidebarrel': False,
'navbar_title': '',
}
diff --git a/opnfv-theme/setup.py b/opnfv-theme/setup.py
index 5375c0940..55f55bc92 100644
--- a/opnfv-theme/setup.py
+++ b/opnfv-theme/setup.py
@@ -2,29 +2,29 @@ from setuptools import setup, find_packages
from sphinx_opnfv_theme import __version__
-with open('README.rst') as f:
- readme_text = f.read()
setup(
name='sphinx_opnfv_theme',
description="OPNFV Theme for Sphinx",
- long_description=readme_text,
+ long_description=open('README.rst').read(),
url='https://docs.opnfv.org/',
author='Trevor Bramwell',
author_email='tbramwell@linuxfoundation.org',
version=__version__,
- entry_points = {
+ entry_points={
'sphinx.html_themes': [
'opnfv = sphinx_opnfv_theme',
]
},
packages=find_packages(),
- install_requires = [
+ install_requires=[
'sphinx_bootstrap_theme',
- 'sphinxcontrib.httpdomain',
+ 'sphinxcontrib-httpdomain',
],
include_package_data=True,
- package_data = {
- 'sphinx_opnfv_theme': ['opnfv/**',]
- },
+ package_data={'sphinx_opnfv_theme': [
+ 'theme.conf',
+ 'static/*',
+ '*.html',
+ ]},
)
diff --git a/opnfv-theme/sphinx_opnfv_theme/__init__.py b/opnfv-theme/sphinx_opnfv_theme/__init__.py
index 007927521..2bf05c3ae 100644
--- a/opnfv-theme/sphinx_opnfv_theme/__init__.py
+++ b/opnfv-theme/sphinx_opnfv_theme/__init__.py
@@ -2,7 +2,7 @@
from os import path
-__version__='0.1.1'
+__version__ = '0.2.0'
def get_html_theme_path():
@@ -10,6 +10,7 @@ def get_html_theme_path():
local_path = path.abspath(path.dirname(__file__))
return [local_path]
+
def setup(app):
"""Required by Sphinx to create the theme."""
app.add_html_theme('opnfv', path.abspath(path.dirname(__file__)))
diff --git a/opnfv-theme/sphinx_opnfv_theme/opnfv/layout.html b/opnfv-theme/sphinx_opnfv_theme/layout.html
index ddd674cf1..ddd674cf1 100644
--- a/opnfv-theme/sphinx_opnfv_theme/opnfv/layout.html
+++ b/opnfv-theme/sphinx_opnfv_theme/layout.html
diff --git a/opnfv-theme/sphinx_opnfv_theme/opnfv/my_custom_sidebar.html b/opnfv-theme/sphinx_opnfv_theme/my_custom_sidebar.html
index 6b259bc93..6b259bc93 100644
--- a/opnfv-theme/sphinx_opnfv_theme/opnfv/my_custom_sidebar.html
+++ b/opnfv-theme/sphinx_opnfv_theme/my_custom_sidebar.html
diff --git a/opnfv-theme/sphinx_opnfv_theme/opnfv/static/favicon.ico b/opnfv-theme/sphinx_opnfv_theme/opnfv/static/favicon.ico
deleted file mode 100755
index bbe55ab40..000000000
--- a/opnfv-theme/sphinx_opnfv_theme/opnfv/static/favicon.ico
+++ /dev/null
Binary files differ
diff --git a/opnfv-theme/sphinx_opnfv_theme/opnfv/static/logo.png b/opnfv-theme/sphinx_opnfv_theme/opnfv/static/logo.png
deleted file mode 100644
index 1519503eb..000000000
--- a/opnfv-theme/sphinx_opnfv_theme/opnfv/static/logo.png
+++ /dev/null
Binary files differ
diff --git a/opnfv-theme/sphinx_opnfv_theme/opnfv/static/my-styles.css b/opnfv-theme/sphinx_opnfv_theme/opnfv/static/my-styles.css
deleted file mode 100644
index 8feb45bfd..000000000
--- a/opnfv-theme/sphinx_opnfv_theme/opnfv/static/my-styles.css
+++ /dev/null
@@ -1,33 +0,0 @@
-body {
- font-family: Helvetica, sans-serif;
- font-size: 16px;
-}
-
-body a {
- color: #27CCC0;
-}
-
-body a:hover {
- color: #676767;
-}
-
-.navbar-brand img {
- height: 200%;
- margin-top: -5%;
-}
-
-.navbar, h1, h2, h3, h4, h5, h6 {
- font-family: Helvetica, sans-serif;
-}
-
-.navbar-text{
- color: #676767;
-}
-
-.navbar-form.navbar-right{
- padding: 0;
-}
-
-.navbar-form .form-control{
- width: 150px;
-}
diff --git a/opnfv-theme/sphinx_opnfv_theme/opnfv/relations.html b/opnfv-theme/sphinx_opnfv_theme/relations.html
index 5bad0b562..5bad0b562 100644
--- a/opnfv-theme/sphinx_opnfv_theme/opnfv/relations.html
+++ b/opnfv-theme/sphinx_opnfv_theme/relations.html
diff --git a/opnfv-theme/sphinx_opnfv_theme/static/favicon.ico b/opnfv-theme/sphinx_opnfv_theme/static/favicon.ico
new file mode 100755
index 000000000..77a123aee
--- /dev/null
+++ b/opnfv-theme/sphinx_opnfv_theme/static/favicon.ico
Binary files differ
diff --git a/opnfv-theme/sphinx_opnfv_theme/static/logo.png b/opnfv-theme/sphinx_opnfv_theme/static/logo.png
new file mode 100644
index 000000000..0320800f6
--- /dev/null
+++ b/opnfv-theme/sphinx_opnfv_theme/static/logo.png
Binary files differ
diff --git a/docs/_static/my-styles.css b/opnfv-theme/sphinx_opnfv_theme/static/my-styles.css
index 8feb45bfd..8feb45bfd 100644
--- a/docs/_static/my-styles.css
+++ b/opnfv-theme/sphinx_opnfv_theme/static/my-styles.css
diff --git a/opnfv-theme/sphinx_opnfv_theme/opnfv/theme.conf b/opnfv-theme/sphinx_opnfv_theme/theme.conf
index 66424aa1f..66424aa1f 100644
--- a/opnfv-theme/sphinx_opnfv_theme/opnfv/theme.conf
+++ b/opnfv-theme/sphinx_opnfv_theme/theme.conf
diff --git a/tox.ini b/tox.ini
index c1993d9ee..d262976e4 100644
--- a/tox.ini
+++ b/tox.ini
@@ -4,12 +4,12 @@ envlist = docs,docs-linkcheck
skipsdist = true
[testenv:docs]
-deps = -r{toxinidir}/etc/requirements.txt
+deps = -r{toxinidir}/docs/requirements.txt
commands =
sphinx-build -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
echo "Generated docs available in {toxinidir}/docs/_build/html"
whitelist_externals = echo
[testenv:docs-linkcheck]
-deps = -r{toxinidir}/etc/requirements.txt
-commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck \ No newline at end of file
+deps = -r{toxinidir}/docs/requirements.txt
+commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck