summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMaryam Tahhan <maryam.tahhan@intel.com>2016-08-31 13:37:04 +0100
committerMaryam Tahhan <maryam.tahhan@intel.com>2016-09-07 14:49:15 +0000
commit0a461892f7425ec6c35948508fdc9a3b010512f3 (patch)
tree8317c753665b68d11d6fd81d3ddb1ce861b7c475
parentcea70a737be5948f5252319ce41bbd5175026034 (diff)
docs: add a configguide
JIRA: DOCS-137 Change-Id: I0b5f1d767bb866dae4e406b8dbbb9f42b27111b0 Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com>
-rw-r--r--docs/configguide/featureconfig.rst28
-rw-r--r--docs/configguide/index.rst13
-rw-r--r--docs/index.rst1
3 files changed, 42 insertions, 0 deletions
diff --git a/docs/configguide/featureconfig.rst b/docs/configguide/featureconfig.rst
new file mode 100644
index 00000000..e7c8d5ce
--- /dev/null
+++ b/docs/configguide/featureconfig.rst
@@ -0,0 +1,28 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright (c) 2016 Open Platform for NFV Project, Inc. and its contributors
+
+Installing Collectd Ceilometer Fuel Plugin
+==========================================
+
+* On the Fuel UI, create a new environment.
+* In Settings > OpenStack Services
+* Enable "Install Ceilometer and Aodh"
+* In Settings > Other
+* Enable "Deploy Collectd Ceilometer Plugin"
+* Continue with environment configuration and deployment as normal.
+
+
+Upgrading the plugin
+--------------------
+
+From time to time new versions of the plugin may become available.
+
+The plugin cannot be upgraded if an active environment is using the plugin.
+
+In order to upgrade the plugin:
+
+* Copy the updated plugin file to the fuel-master.
+* On the Fuel UI, reset the environment.
+* On the Fuel CLI "fuel plugins --update <fuel-plugin-file>"
+* On the Fuel UI, re-deploy the environment.
diff --git a/docs/configguide/index.rst b/docs/configguide/index.rst
new file mode 100644
index 00000000..9b02e8ca
--- /dev/null
+++ b/docs/configguide/index.rst
@@ -0,0 +1,13 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright (c) 2016 Open Platform for NFV Project, Inc. and its contributors
+
+==============================
+SFQM Guides and Installation
+==============================
+
+.. toctree::
+ :numbered:
+ :maxdepth: 3
+
+ featureconfig.rst
diff --git a/docs/index.rst b/docs/index.rst
index 5f0aae49..e22c95e7 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -25,5 +25,6 @@ Table of Contents:
:numbered:
requirements/index.rst
+ conffiguide/index.rst
userguide/index.rst
release/index.rst