summaryrefslogtreecommitdiffstats
path: root/docs/sections/blueprints
diff options
context:
space:
mode:
authorLusheng Ji <lji@research.att.com>2018-06-06 00:20:03 -0400
committerLusheng Ji <lji@research.att.com>2018-06-06 08:13:38 -0400
commiteaac78d809a0a019718cb8b070f496b6883bb130 (patch)
treeb562042115bdef60061edd9babc5a38b6e860b82 /docs/sections/blueprints
parent768421bae7586ffe6c4dc2f967471a2c5434cd98 (diff)
Fix doc build warnings2.0.0-ONAP2.0.0-ONAP
Issue-ID: DCAEGEN2-516 Change-Id: I94f1c7fcf5e4a21752c3ce9d8d71d98f2140e1ee Signed-off-by: Lusheng Ji <lji@research.att.com>
Diffstat (limited to 'docs/sections/blueprints')
-rw-r--r--docs/sections/blueprints/DockerHost.rst2
-rw-r--r--docs/sections/blueprints/PGaaS.rst14
-rw-r--r--docs/sections/blueprints/cbs.rst2
-rw-r--r--docs/sections/blueprints/cdap.rst2
-rw-r--r--docs/sections/blueprints/cdapbroker.rst2
-rw-r--r--docs/sections/blueprints/consul.rst2
-rw-r--r--docs/sections/blueprints/deploymenthandler.rst2
-rw-r--r--docs/sections/blueprints/holmes.rst4
-rw-r--r--docs/sections/blueprints/index.rst11
-rw-r--r--docs/sections/blueprints/inventoryapi.rst2
-rw-r--r--docs/sections/blueprints/policyhandler.rst2
-rw-r--r--docs/sections/blueprints/servicechangehandler.rst2
-rw-r--r--docs/sections/blueprints/tca.rst4
13 files changed, 20 insertions, 31 deletions
diff --git a/docs/sections/blueprints/DockerHost.rst b/docs/sections/blueprints/DockerHost.rst
index a6f21339..1cbc7584 100644
--- a/docs/sections/blueprints/DockerHost.rst
+++ b/docs/sections/blueprints/DockerHost.rst
@@ -19,5 +19,5 @@ How To Run
Cfy command for running the blueprint
Additional Information
----------------------
+----------------------
Any additional information that help other people understanding and using yor blueprint
diff --git a/docs/sections/blueprints/PGaaS.rst b/docs/sections/blueprints/PGaaS.rst
index 080e5757..eedcfe56 100644
--- a/docs/sections/blueprints/PGaaS.rst
+++ b/docs/sections/blueprints/PGaaS.rst
@@ -1,12 +1,12 @@
PostgreSQL as a Service
-============
+=======================
PostgreSQL as a Service (PGaaS) comes in two flavors: all-in-one blueprint, and
separate disk/cluster/database blueprints to separate the management of
the lifetime of those constituent parts. Both are provided for use.
Why Three Flavors?
-------------
+------------------
The reason there are three flavors of blueprints lays in the difference in
lifetime management of the constituent parts and the number of VMs created.
@@ -24,10 +24,10 @@ be deployed too. OR, the database should have a lifetime beyond the scope
of the applications that are writing to it or reading from it.
Blueprint Files
-------------
+---------------
The Blueprints for PG Services and Cinder
-^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The all-in-one blueprint ``pgaas.yaml`` assumes that the PG servers and Cinder volumes can be allocated and
deallocated together. The ``pgaas.yaml`` blueprint creates a cluster of two VMs named "``pstg``" by default.
@@ -40,7 +40,7 @@ Cinder volume, and ``pgaas-cluster.yaml`` to allocate a PG cluster. Create the C
redeployed without affecting the data on the Cinder volumes.
The Blueprints for Databases
-^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The ``pgaas-database.yaml`` blueprint shows how a database can be created separately from any application
that uses it. That database will remain present until the pgaas-database.yaml blueprint is
@@ -56,7 +56,7 @@ adds the ``use_existing: true`` property.
What is Created by the Blueprints
-^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Each PostgreSQL cluster has a name, represented below as ``${CLUSTER}`` or ``CLNAME``. Each cluster is created
with two VMs, one VM used for the writable master and the other as a cascaded read-only secondary.
@@ -84,7 +84,7 @@ How to Run
To install the PostgreSQL as a Service
-^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Installing the all-in-one blueprint is straightforward:
diff --git a/docs/sections/blueprints/cbs.rst b/docs/sections/blueprints/cbs.rst
index adb728e6..74217ccb 100644
--- a/docs/sections/blueprints/cbs.rst
+++ b/docs/sections/blueprints/cbs.rst
@@ -19,5 +19,5 @@ How To Run
Cfy command for running the blueprint
Additional Information
----------------------
+----------------------
Any additional information that help other people understanding and using yor blueprint
diff --git a/docs/sections/blueprints/cdap.rst b/docs/sections/blueprints/cdap.rst
index 9dd3bd85..cff25617 100644
--- a/docs/sections/blueprints/cdap.rst
+++ b/docs/sections/blueprints/cdap.rst
@@ -12,7 +12,7 @@ applications. The template for the blueprint is at
will be the CDAP master.
Blueprint Input Parameters
----------------------
+--------------------------
This blueprint has the following required input parameters:
diff --git a/docs/sections/blueprints/cdapbroker.rst b/docs/sections/blueprints/cdapbroker.rst
index fcbce247..cf42fe5c 100644
--- a/docs/sections/blueprints/cdapbroker.rst
+++ b/docs/sections/blueprints/cdapbroker.rst
@@ -19,5 +19,5 @@ How To Run
Cfy command for running the blueprint
Additional Information
----------------------
+----------------------
Any additional information that help other people understanding and using yor blueprint
diff --git a/docs/sections/blueprints/consul.rst b/docs/sections/blueprints/consul.rst
index 257b0605..2d3ceed7 100644
--- a/docs/sections/blueprints/consul.rst
+++ b/docs/sections/blueprints/consul.rst
@@ -19,5 +19,5 @@ How To Run
Cfy command for running the blueprint
Additional Information
----------------------
+----------------------
Any additional information that help other people understanding and using yor blueprint
diff --git a/docs/sections/blueprints/deploymenthandler.rst b/docs/sections/blueprints/deploymenthandler.rst
index 7ef5f425..763afbe4 100644
--- a/docs/sections/blueprints/deploymenthandler.rst
+++ b/docs/sections/blueprints/deploymenthandler.rst
@@ -19,5 +19,5 @@ How To Run
Cfy command for running the blueprint
Additional Information
----------------------
+----------------------
Any additional information that help other people understanding and using yor blueprint
diff --git a/docs/sections/blueprints/holmes.rst b/docs/sections/blueprints/holmes.rst
index 28370d09..4d965c05 100644
--- a/docs/sections/blueprints/holmes.rst
+++ b/docs/sections/blueprints/holmes.rst
@@ -1,5 +1,5 @@
Holmes Correlation Analytics
-======================
+============================
Overview of my blueprint and the part it plays in DCAE.
@@ -19,5 +19,5 @@ How To Run
Cfy command for running the blueprint
Additional Information
----------------------
+----------------------
Any additional information that help other people understanding and using yor blueprint
diff --git a/docs/sections/blueprints/index.rst b/docs/sections/blueprints/index.rst
deleted file mode 100644
index ae267b74..00000000
--- a/docs/sections/blueprints/index.rst
+++ /dev/null
@@ -1,11 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-
-Data Collection, Analytics, and Events (DCAE) blueprints
-=======================
-
-.. toctree::
- :maxdepth: 1
-
- ./PGaaS.rst
diff --git a/docs/sections/blueprints/inventoryapi.rst b/docs/sections/blueprints/inventoryapi.rst
index 016eccec..cdbc164c 100644
--- a/docs/sections/blueprints/inventoryapi.rst
+++ b/docs/sections/blueprints/inventoryapi.rst
@@ -19,5 +19,5 @@ How To Run
Cfy command for running the blueprint
Additional Information
----------------------
+----------------------
Any additional information that help other people understanding and using yor blueprint
diff --git a/docs/sections/blueprints/policyhandler.rst b/docs/sections/blueprints/policyhandler.rst
index b5557d02..79ac538f 100644
--- a/docs/sections/blueprints/policyhandler.rst
+++ b/docs/sections/blueprints/policyhandler.rst
@@ -19,5 +19,5 @@ How To Run
Cfy command for running the blueprint
Additional Information
----------------------
+----------------------
Any additional information that help other people understanding and using yor blueprint
diff --git a/docs/sections/blueprints/servicechangehandler.rst b/docs/sections/blueprints/servicechangehandler.rst
index 1665727e..e23a6213 100644
--- a/docs/sections/blueprints/servicechangehandler.rst
+++ b/docs/sections/blueprints/servicechangehandler.rst
@@ -19,5 +19,5 @@ How To Run
Cfy command for running the blueprint
Additional Information
----------------------
+----------------------
Any additional information that help other people understanding and using yor blueprint
diff --git a/docs/sections/blueprints/tca.rst b/docs/sections/blueprints/tca.rst
index ac0cb55e..2e09a202 100644
--- a/docs/sections/blueprints/tca.rst
+++ b/docs/sections/blueprints/tca.rst
@@ -1,5 +1,5 @@
Threshold Crossing Analytics
-======================
+============================
Overview of my blueprint and the part it plays in DCAE.
@@ -19,5 +19,5 @@ How To Run
Cfy command for running the blueprint
Additional Information
----------------------
+----------------------
Any additional information that help other people understanding and using yor blueprint