[DMAAP-BC] Consolidate bus controller repos

[dmaap/buscontroller.git] / docs / installation.rst

diff --git a/docs/Installation/Installation.rst b/docs/installation.rst
similarity index 96%
rename from docs/Installation/Installation.rst
rename to docs/installation.rst
index 3a8e732..cee606c 100644 (file)
--- a/docs/Installation/Installation.rst
+++ b/docs/installation.rst
@@ -4,8 +4,6 @@
 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.
@@ -25,6 +23,7 @@ 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.
@@ -38,7 +37,7 @@ On Intel dev machine, in terminal (> indicates prompt) :
     > git clone https://gerrit.onap.org/r/dmaap/buscontroller
         - anonymous http, can't push changes
     > cd buscontroller
-    > mvn clean install -Pdocker
+    > mvn clean install -P docker
         - builds dmaap-bc and dbc-client images
 2) Run tests
     > cd dmaap-bc/src/main/resources/
@@ -56,7 +55,7 @@ On Arm:
     > git clone https://gerrit.onap.org/r/dmaap/buscontroller
         - anonymous http, can't push changes
     > cd buscontroller
-    > mvn clean install -Pdocker  -Ddocker.pull.registry=docker.io
+    > mvn clean install -P docker  -Ddocker.pull.registry=docker.io
         - ensure we pull Arm version of base image
 2) Run tests
     > cd dmaap-bc/src/main/resources/