aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEmma Foley <efoley@redhat.com>2021-06-03 18:24:00 +0100
committerEmma Foley <efoley@redhat.com>2021-06-04 14:43:13 +0100
commit375460d8d7a5f2ced230f78bcc32fec879c9d9c5 (patch)
tree207dda9d9d0d6f09110f2963f47ef58c64b871d8
parent28517f841a3261987114869e04624cdd686c31a5 (diff)
[docs] Update docs
Update references of OPNFV to Anuket Update redirected and invalud links Signed-off-by: Emma Foley <efoley@redhat.com> Change-Id: If5663398319c5a0a5c99cff414bc7b2a216218f0
-rw-r--r--docs/development/requirements/01-intro.rst4
-rw-r--r--docs/development/requirements/03-dpdk.rst4
-rw-r--r--docs/index.rst6
-rw-r--r--docs/release/configguide/postinstall.rst2
-rw-r--r--docs/release/release-notes/index.rst4
-rw-r--r--docs/release/userguide/collectd.ves.userguide.rst6
-rw-r--r--docs/release/userguide/feature.userguide.rst24
-rw-r--r--docs/release/userguide/index.rst4
-rw-r--r--docs/release/userguide/installguide.docker.rst10
-rw-r--r--docs/release/userguide/installguide.oneclick.rst4
10 files changed, 35 insertions, 33 deletions
diff --git a/docs/development/requirements/01-intro.rst b/docs/development/requirements/01-intro.rst
index 70abc553..c34961a5 100644
--- a/docs/development/requirements/01-intro.rst
+++ b/docs/development/requirements/01-intro.rst
@@ -1,6 +1,6 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-.. (c) OPNFV, Intel Corporation and others.
+.. (c) Anuket, Intel Corporation and others.
Problem Statement
------------------
@@ -16,7 +16,7 @@ useful information as possible off the platform so that faults and errors in
the NFVI can be detected promptly and reported to the appropriate fault
management entity.
-The OPNFV platform (NFVI) requires functionality to:
+The Anuket platform (NFVI) requires functionality to:
* Create a low latency, high performance packet processing path (fast path)
through the NFVI that VNFs can take advantage of;
diff --git a/docs/development/requirements/03-dpdk.rst b/docs/development/requirements/03-dpdk.rst
index ad7c8c78..fa960f4e 100644
--- a/docs/development/requirements/03-dpdk.rst
+++ b/docs/development/requirements/03-dpdk.rst
@@ -1,6 +1,6 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-.. (c) OPNFV, Intel Corporation and others.
+.. (c) Anuket, Intel Corporation and others.
DPDK Enhancements
==================
@@ -167,4 +167,4 @@ Through extending the dpdkstat plugin for collectd with KA functionality, and
integrating the extended plugin with Monasca for high performing, resilient,
and scalable fault detection.
-.. _L2 Forwarding Sample Application (in Real and Virtualized Environments): http://dpdk.org/doc/guides/sample_app_ug/l2_forward_real_virtual.html
+.. _L2 Forwarding Sample Application (in Real and Virtualized Environments): http://doc.dpdk.org/guides/sample_app_ug/l2_forward_real_virtual.html
diff --git a/docs/index.rst b/docs/index.rst
index 8f80b559..e6424919 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,6 +1,6 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-.. (c) OPNFV, Intel Corporation and others.
+.. (c) Anuket, Intel Corporation and others.
=========
Barometer
@@ -77,6 +77,6 @@ Indices
=======
* :ref:`search`
-.. _Barometer: https://wiki.opnfv.org/display/fastpath
-.. _collectd: http://collectd.org/
+.. _Barometer: https://wiki.anuket.io/display/HOME/Barometer
+.. _collectd: https://collectd.org/
diff --git a/docs/release/configguide/postinstall.rst b/docs/release/configguide/postinstall.rst
index d7347b19..7424cec7 100644
--- a/docs/release/configguide/postinstall.rst
+++ b/docs/release/configguide/postinstall.rst
@@ -6,6 +6,8 @@ Barometer post installation procedures
======================================
This document describes briefly the methods of validating the Barometer installation.
+.. TODO: Update this to include reference to containers rather than an Openstack deployment.
+
Automated post installation activities
--------------------------------------
The Barometer test-suite in Functest is called ``barometercollectd`` and is part of the ``Features``
diff --git a/docs/release/release-notes/index.rst b/docs/release/release-notes/index.rst
index db8221ab..9eb1348e 100644
--- a/docs/release/release-notes/index.rst
+++ b/docs/release/release-notes/index.rst
@@ -2,10 +2,10 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-.. (c) OPNFV, Intel Corporation and others.
+.. (c) Anuket, Intel Corporation and others.
==================================================
-OPNFV Barometer Release Notes
+Anuket Barometer Release Notes
==================================================
.. toctree::
diff --git a/docs/release/userguide/collectd.ves.userguide.rst b/docs/release/userguide/collectd.ves.userguide.rst
index bbfd763e..2d3760b8 100644
--- a/docs/release/userguide/collectd.ves.userguide.rst
+++ b/docs/release/userguide/collectd.ves.userguide.rst
@@ -1,6 +1,6 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-.. (c) OPNFV, Intel Corporation and others.
+.. (c) Anuket, Intel Corporation and others.
.. _barometer-ves-userguide:
==========================
@@ -932,9 +932,9 @@ Limitations
definition and the format is descibed in the document.
-.. _collectd: http://collectd.org/
+.. _collectd: https://collectd.org/
.. _Kafka: https://kafka.apache.org/
-.. _`VES`: https://wiki.opnfv.org/display/fastpath/VES+plugin+updates
+.. _`VES`: https://wiki.anuket.io/display/HOME/VES+plugin+updates
.. _`VES shema definition`: https://gerrit.onap.org/r/gitweb?p=demo.git;a=tree;f=vnfs/VES5.0/evel/evel-test-collector/docs/att_interface_definition;hb=refs/heads/master
.. _`PyYAML documentation`: https://pyyaml.org/wiki/PyYAMLDocumentation
.. _`collectd plugin description`: https://github.com/collectd/collectd/blob/main/src/collectd.conf.pod
diff --git a/docs/release/userguide/feature.userguide.rst b/docs/release/userguide/feature.userguide.rst
index 50d59cf5..c7cece47 100644
--- a/docs/release/userguide/feature.userguide.rst
+++ b/docs/release/userguide/feature.userguide.rst
@@ -1,6 +1,6 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-.. (c) <optionally add copywriters name>
+.. (c) Anuket and others
===================================
OPNFV Barometer User Guide
@@ -182,7 +182,7 @@ Repo: https://github.com/collectd/collectd
Branch: main
-Dependencies: DPDK (http://dpdk.org/)
+Dependencies: DPDK (https://dpdk.org/)
.. note:: DPDK statistics plugin requires DPDK version 16.04 or later.
@@ -299,7 +299,7 @@ To fully enable ASLR:
and only when all implications of this change have been understood.
For more information on multi-process support, please see:
-http://dpdk.org/doc/guides/prog_guide/multi_proc_support.html
+https://doc.dpdk.org/guides/prog_guide/multi_proc_support.html
**DPDK stats plugin limitations:**
@@ -321,7 +321,7 @@ http://dpdk.org/doc/guides/prog_guide/multi_proc_support.html
**DPDK telemetry plugin**
-Please refer https://wiki.opnfv.org/display/fastpath/DPDK+Telemetry+Plugin
+Please refer to https://wiki.anuket.io/display/HOME/DPDK+Telemetry+Plugin
Hugepages Plugin
^^^^^^^^^^^^^^^^^
@@ -482,14 +482,14 @@ Branch: main
Dependencies:
- * PQoS/Intel RDT library https://github.com/01org/intel-cmt-cat.git
+ * PQoS/Intel RDT library https://github.com/intel/intel-cmt-cat
* msr kernel module
Building and installing PQoS/Intel RDT library:
.. code:: bash
- $ git clone https://github.com/01org/intel-cmt-cat.git
+ $ git clone https://github.com/intel/intel-cmt-cat
$ cd intel-cmt-cat
$ make
$ make install PREFIX=/usr
@@ -638,7 +638,7 @@ collectd IPMI documentation can be used:
IPMI documentation:
- https://www.kernel.org/doc/Documentation/IPMI.txt
-- http://www.intel.com/content/www/us/en/servers/ipmi/ipmi-second-gen-interface-spec-v2-rev1-1.html
+- https://www.intel.com/content/www/us/en/products/docs/servers/ipmi/ipmi-second-gen-interface-spec-v2-rev1-1.html
Mcelog Plugin
^^^^^^^^^^^^^^
@@ -856,7 +856,7 @@ On Centos, install the dependencies and Open vSwitch:
$ sudo yum install yajl-devel
Steps to install Open vSwtich can be found at
-http://docs.openvswitch.org/en/latest/intro/install/fedora/
+https://docs.openvswitch.org/en/latest/intro/install/fedora/
Start the Open vSwitch service:
@@ -1133,7 +1133,7 @@ metrics depends on running libvirt daemon version.
.. note:: Please keep in mind that RDT metrics (part of *Performance monitoring
events*) have to be supported by hardware. For more details on hardware support,
please see:
- https://github.com/01org/intel-cmt-cat
+ https://github.com/intel/intel-cmt-cat
Additionally perf metrics **cannot** be collected if *Intel RDT* plugin is enabled.
@@ -1377,7 +1377,7 @@ Security
* `CVE-2010-4336`_ fixed https://mailman.verplant.org/pipermail/collectd/2010-November/004277.html
in Version 4.10.2.
- * http://www.cvedetails.com/product/20310/Collectd-Collectd.html?vendor_id=11242
+ * https://www.cvedetails.com/product/20310/Collectd-Collectd.html?vendor_id=11242
* It's recommended to only use collectd plugins from signed packages.
@@ -1394,8 +1394,8 @@ References
.. _Barometer OPNFV Summit demo: https://prezi.com/kjv6o8ixs6se/software-fastpath-service-quality-metrics-demo/
.. _gnocchi plugin: https://github.com/openstack/collectd-openstack-plugins/tree/stable/ocata/
.. _aodh plugin: https://github.com/openstack/collectd-openstack-plugins/tree/stable/ocata/
-.. _collectd-openstack-plugins GSG: https://github.com/openstack/collectd-openstack-plugins/blob/master/doc/source/GSG.rst
-.. _grafana guide: https://wiki.opnfv.org/display/fastpath/Installing+and+configuring+InfluxDB+and+Grafana+to+display+metrics+with+collectd
+.. _collectd-openstack-plugins GSG: https://opendev.org/x/collectd-openstack-plugins/src/branch/master/doc/source/GSG.rst
+.. _grafana guide: https://wiki.anuket.io/display/HOME/Installing+and+configuring+InfluxDB+and+Grafana+to+display+metrics+with+collectd
.. _CVE-2017-7401: https://www.cvedetails.com/cve/CVE-2017-7401/
.. _CVE-2016-6254: https://www.cvedetails.com/cve/CVE-2016-6254/
.. _CVE-2010-4336: https://www.cvedetails.com/cve/CVE-2010-4336/
diff --git a/docs/release/userguide/index.rst b/docs/release/userguide/index.rst
index 673d6c12..f7bdad7f 100644
--- a/docs/release/userguide/index.rst
+++ b/docs/release/userguide/index.rst
@@ -2,10 +2,10 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-.. (c) Intel and OPNFV
+.. (c) Intel, Anuket and others
===========================
-OPNFV Barometer User Guide
+Anuket Barometer User Guide
===========================
.. The feature user guide should provide an OPNFV user with enough information to
diff --git a/docs/release/userguide/installguide.docker.rst b/docs/release/userguide/installguide.docker.rst
index ca113c65..1852b507 100644
--- a/docs/release/userguide/installguide.docker.rst
+++ b/docs/release/userguide/installguide.docker.rst
@@ -1,11 +1,11 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-.. (c) <optionally add copywriters name>
+.. (c) Anuket and others
.. _barometer-docker-userguide:
-====================================
-OPNFV Barometer Docker Install Guide
-====================================
+=====================================
+Anuket Barometer Docker Install Guide
+=====================================
.. contents::
:depth: 3
@@ -417,7 +417,7 @@ Run the collectd stable docker image
List of barometer-collectd dependencies on host for various plugins
can be found at:
- https://wiki.opnfv.org/display/fastpath/Barometer-collectd+host+dependencies
+ https://wiki.anuket.io/display/HOME/Barometer-collectd+host+dependencies
The Resource Control file system (/sys/fs/resctrl) can be bound from host to
container only if this directory exists on the host system. Otherwise omit
diff --git a/docs/release/userguide/installguide.oneclick.rst b/docs/release/userguide/installguide.oneclick.rst
index bdb7a06a..b73ab79b 100644
--- a/docs/release/userguide/installguide.oneclick.rst
+++ b/docs/release/userguide/installguide.oneclick.rst
@@ -1,6 +1,6 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-.. (c) <optionally add copywriters name>
+.. (c) Anuket and others
.. _barometer-oneclick-userguide:
=======================================
@@ -251,7 +251,7 @@ To make some changes when a container is running run:
Connect to ``<host_ip>:3000`` with a browser and log into Grafana: admin/admin.
For short introduction please see the:
-`Grafana guide <http://docs.grafana.org/guides/getting_started/>`_.
+`Grafana guide <https://grafana.com/docs/grafana/latest/guides/getting_started/>`_.
The collectd configuration files can be accessed directly on target system in
``/opt/collectd/etc/collectd.conf.d``. It can be used for manual changes or