Introduce buscontroller to readthedocs1.0.24

Change-Id: I929bf1d3eacd35dc0ff97cdabd053cdfd1897e7d
Signed-off-by: dglFromAtt <dgl@research.att.com>
Issue-ID: DOC-328

1 files changed, 32 insertions, 0 deletions

diff --git a/docs/Installation/Installation.rst b/docs/Installation/Installation.rst
new file mode 100644
index 0000000..5788845
--- /dev/null
+++ b/docs/Installation/Installation.rst
@@ -0,0 +1,32 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Installation
+============
+
+Environment
+===========
+Bus Controller is developed using Postgresql.  An embedded Jetty server is used to create the REST service.
+The service is packaged as a Docker container image.
+Helm charts for Bus Controller are part of the overall dmaap chart set.
+
+Steps for OOM Deployment
+------------------------
+
+1) Clone the oom repo
+2) cd oom/kubernetes
+3) (optionally, customize the buscontroller configuration - see below)
+4) make dmaap
+5) helm install dmaap --name=dmaap --namespace=mr
+
+
+Customizing the Bus Controller configuration
+--------------------------------------------
+
+The Bus Controller is highly configurable, but by default has settings that should work for a standard ONAP oom deployment.
+However, if some customization is desired, there are places to change behavior:
+1) The --namespace argument of the helm install step is also refernced to compose the topic namespace used.  i.e. the value is appended to org.onap.dmaap.   Since Message Router uses org.onap.dmaap.mr by default, we also use --namespace=mr.  But this can be changed to a value that matches a different deployment of MR.
+2) oom/kubernetes/dmaap/charts/dmaap-bus-controller/values.yaml  contains the set of tags used within the charts.  These can be modified if necessary.
+3) oom/kubernetes/dmaap/charts/dmaap-bus-controller/resources/config/buscontroller.env contains some environment settings for the container.  These can be modified.  For example, to indicate that AAF integration should be enabled, set USE_AAF=true in this file.
+4) oom/kubernetes/dmaap/charts/dmaap-bus-controller/resources/config/dmaapbc.properties  contains many properties which can be modified.  For example, if a differerent Postgresql instance needed to be used, the value could be specified here.
+