diff options
| author |   Emma Foley <efoley@redhat.com> | 2021-08-06 12:18:21 +0100 |
|---|---|---|
| committer | Emma Foley <efoley@redhat.com> | 2021-08-26 20:56:36 +0100 |
| commit | 18e27d1c59cf34373b8079e066a296a5922a5b04 (patch) | |
| tree | 15f13c3ebe71dc3f3759fa5e40425369603b3fb3 /docs/release/userguide | |
| parent | aa2982090189856bcf082d71c0d15d80367fa0d1 (diff) | |
[docs] Update config and post-installation guides
The configguide was removed previously because it only contained
information about using the OPNFV installers, however, now there appears
to be no config information about the plugins. The config information
for each plugin is included in the user guide in
docs/release/userguide/feature.userguide.rst.
This change adds in a note to the the config guide on where to look.
Signed-off-by: Emma Foley <efoley@redhat.com>
Change-Id: I7f71d51846c9116bed3882b96e762ab5d70fdfa4
Diffstat (limited to 'docs/release/userguide')
| -rw-r--r-- | docs/release/userguide/feature.userguide.rst | 2 | ||||
| -rw-r--r-- | docs/release/userguide/installguide.docker.rst | 8 |
2 files changed, 7 insertions, 3 deletions
diff --git a/docs/release/userguide/feature.userguide.rst b/docs/release/userguide/feature.userguide.rst index 2f4639c7..02f8bdaa 100644 --- a/docs/release/userguide/feature.userguide.rst +++ b/docs/release/userguide/feature.userguide.rst @@ -1,3 +1,5 @@ +.. _feature-userguide: + .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 .. (c) Anuket and others diff --git a/docs/release/userguide/installguide.docker.rst b/docs/release/userguide/installguide.docker.rst index 20836af7..38d467a4 100644 --- a/docs/release/userguide/installguide.docker.rst +++ b/docs/release/userguide/installguide.docker.rst @@ -1,7 +1,7 @@ +.. _barometer-docker-userguide: .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 .. (c) Anuket and others -.. _barometer-docker-userguide: ===================================== Anuket Barometer Docker Install Guide @@ -31,7 +31,9 @@ For steps to build and run VES and Kafka images please see section `Build and Ru For overview of running VES application with Kafka please see the :ref:`VES Application User Guide <barometer-ves-userguide>` -For an alternative installation method using ansible, please see the :ref:`Barometer One Click Install Guide <barometer-oneclick-userguide>`. +For an alternative installation method using ansible, please see the :ref:`Barometer One Click Install Guide <barometer-oneclick-userguide>`. + +For post-installation verification and troubleshooting, please see the :ref:`Barometer post installation guide <barometer-postinstall>`. Barometer Docker Images Description ----------------------------------- @@ -93,7 +95,7 @@ The Barometer project's VES application and Kafka docker images are based on a C docker image has a dependancy on `Zookeeper <https://zookeeper.apache.org/>`_. Kafka must be able to connect and register with an instance of Zookeeper that is either running on local or remote host. Kafka recieves and stores metrics recieved from Collectd. VES application pulls latest metrics from Kafka -which it normalizes into VES format for sending to a VES collector. Please see details in +which it normalizes into VES format for sending to a VES collector. Please see details in :ref:`VES Application User Guide <barometer-ves-userguide>` Installing Docker |