Improve info in README

Change-Id: I44ed0e23bd2b37a643ada00e7b3d7af57edcc785
Signed-off-by: dglFromAtt <dgl@research.att.com>
Issue-ID: DMAAP-829

1 files changed, 133 insertions, 2 deletions

diff --git a/README.md b/README.md
index 1ccaefa..10d635d 100644
--- a/README.md
+++ b/README.md
@@ -61,11 +61,29 @@ $ mvn -P docker docker:build
 
 ### ONAP deployment
 
-Details TBD.
+Two styles of deployment are supported for ONAP.
+1. OOM - by the time of Release Casablanca, this is the preferred deployment method which relies on a kubernetes environment, and uses helm charts.  Buscontroller is part of a larger overall dmaap chart which also deploys Message Router and Data Router.  See https://gerrit.onap.org/r/#/admin/projects/oom
+2. HEAT - an older style deployment which assumes VM running docker.
 
+#### ONAP OOM Deployment
+
+The default DMaaP charts for an OOM deployment should be able to be used without modification because the interdependencies between components rely on kubernetes service names.
+However, overrides can be made to the buscontroller values.yaml file (found in oom/kubernetes/dmaap/charts/dmaap-bus-controller/values.yaml) as needed.
+
+Following a convention where Release is set to the component name (--name=dmaap) and using a dev namespace:
+```
+<clone oom>
+cd kubernetes
+<edit values.yaml if necessary>
+make dmaap
+helm install dmaap --debug --name=dmaap --namespace=dev
+
+```
+
+#### ONAP Heat deployment
 Prior to starting container, place environment specific vars in /tmp/docker-databus-controller.conf on the Docker host,
 and map that file to /opt/app/config/conf.
-Run the container which will run the dmaapbc deploy command, which will update the container runtime properties appropriately, and start the Bus Controller.
+Run the buscontroller image which starts execution of the dmaapbc deploy command, which will update the container runtime properties appropriately, and start the Bus Controller.
 
 For example, in ONAP Future Lab environment, /tmp/docker-databus-controller.conf looks like:
 ```
@@ -105,3 +123,116 @@ $ docker pull nexus3.onap.org:10003/onap/dmaap/buscontroller:latest
 $ docker run -d -p 18080:8080 -p 18443:8443 -v /tmp/docker-databus-controller.conf:/opt/app/config/conf nexus3.onap.org:10003/onap/dmaap/buscontroller:latest
 ```
 
+### Properties
+
+This section is intended to describe the behavior customization of Bus Controller that can be obtained via properties file used by the dbcapi library.
+By default, this file is located in etc/dmaapbc.properties.
+However, a java argument -DConfigFile  can be set to a different path.  (Our kubernetes deployment relies on this and points to a configmap, for example.)
+
+The table below lists all the settings, default values (if not set), and shows any explicit setting in ONAP oom kubernetes deployment.
+
+|-|-|-|-|
+| Property | Description | Default | Kubernetes Setting | 
+|-|-|-|-|
+|UseAAF                | Flag for whether AAF authz API is to be used            | false                                  | false |
+|-|-|-|-|
+|csit                  | Flag for stubbing out many southbound calls in a CSIT environment | No                           | No |
+|-|-|-|-|
+|DR.provhost           | FQDN of Data Router Provisioning Server (deprecated - now set via API) | notSet                  | dcae-drps.domain.not.set |
+|-|-|-|-|
+|ProvisioningURI       | URI to retrieve dynamic DR configuration                | /internal/prov                         | /internal/prov |
+|-|-|-|-|
+|Feed.deleteHandling   | indicator for handling feed delete request              | DeleteOnDR                             | SimulateDelete |
+|                      | DeleteOnDR - means use the DR API to DELETE a feed.  (default for backwards compatibility) | | |
+|                      | SimulateDelete - means preserve the feed on DR (after cleaning it up), and mark as DELETED in DBCL. | | |
+|-|-|-|-|
+|UsePGSQL              | flag indicates whether to retain data in Postgresql     | false                                  | true |
+|                      | when false, objects will be kept in memory but will be  |                                        | |
+|                      | lost on restart and not shared between instances        |                                        | |
+|-|-|-|-|
+|DB.host               | FQDN or service name of Postresql host                  | dcae-pstg-write-ftl.domain.notset.com  | dbc-pg-primary |
+|-|-|-|-|
+|DB.name               | name of Postresql database                              | dmaap                                  | |
+|-|-|-|-|
+|DB.schema             | name of database schema                                 | public                                 | |
+|-|-|-|-|
+|DB.user               | username for Postgresql access                          | dmaap_admin                            | |
+|-|-|-|-|
+|DB.cred               | password for Postrgresql access                         | test234-ftl                            | onapdemodb |
+|-|-|-|-|
+|MR.multisite          | Indicates if there can be multiple sites (locations) where MR is deployed | true                 | false |
+|-|-|-|-|
+|MR.CentralCname       |  FQDN or service name of MR (deployed in central if multilocation is true) | MRcname.not.set     | message-router |
+|-|-|-|-|
+|MR ClientDeleteLevel  | MR Client Delete thoroughness                           | 0                                      |  1 |
+|                      | 0 = don't delete | | |
+|                      | 1 = delete from persistent store (PG) | | |
+|                      | 2 = delete from persistent store (PG) and authorization store (AAF) | | |
+|-|-|-|-|
+|MR.TopicFactoryNS     | AAF namespace used to create perms for MR topics        | MR.topicFactoryNS.not.set              | org.onap.dmaap.mr.topicFactory |
+|-|-|-|-|
+|MR.TopicMgrRole       | AAF Role used by Buscontroller to create topics on MR   | MR.TopicMgrRole.not.set                | org.onap.dmaap-bc-topic-mgr.client |
+|-|-|-|-|
+|MR.projectID          | Value for some constructs of fully qualified topic names | 99999                                 | ONAP |
+|-|-|-|-|
+|cadi.properties       | Path to CADI properties file                            | /opt/app/osaaf/local/org.onap.dmaap-bc.props | /opt/app/osaaf/lcoal/org.onap.dmaap-bc.props |
+|-|-|-|-|
+|aaf.URL               | URL of the AAF server                                   | https://authentication.domain.netset.com:8095/proxy/ | https://aaf-authz/ |
+|-|-|-|-|
+|aaf.TopicMgrUser      | AAF Identity of Topic Mgr                               | noMechId@domain.netset.com             | dmaap-bc-topic-mgr@dmaap-bc-topic-mgr.onap.org | 
+|-|-|-|-|
+|aaf.TopicMgrPassword  | AAF Credential for Topic Mgr                            | notSet                                 | demo123456! |
+|-|-|-|-|
+|aaf.AdminUser         | AAF Identity of user with Admin role for API namespace  | noMechId@domain.netset.com             | aaf_admin@people.osaaf.org |
+|-|-|-|-|
+|aaf.AdminPassword     | AAF credential of AdminUser                             | notSet                                 | demo123456! |
+|-|-|-|-|
+|CredentialCodeKeyfile | location of the codec keyfile used to decrypt passwords | LocalKey                               | etc/LocalKey |
+|                      | in this properties file before they are passed to AAF   | LocalKey                               | etc/LocalKey |
+|-|-|-|-|
+|AafDecryption.Class   | Specifies the Class to be used for decryption           | org.onap.dmaap.dbcapi.aaf.ClearDecrypt | |
+|-|-|-|-|
+|ApiNamespace          | Root namespace for AAF perms related to dbcapi access   | apiNamespace.not.set                   | org.onap.dmaap-bc.api |
+|-|-|-|-|
+|ApiPermission.Class   | the Class that determines if a call to API is authorized| allow                                  | | 
+|-|-|-|-|
+|MM.ProvRole           | AAF Role of client publishing MM prov cmds              | notSet                                 | org.onap.dmaap-bc-mm-prov.prov |
+|-|-|-|-|
+|MM.ProvUserMechId     | AAF Identity when publishing to MM command topic        | notSet                                 | dmaap-bc-mm-prov@dmaap-bc-mm-prov.onap.org|
+|-|-|-|-|
+|MM.ProvUserPwd        | AAF credenital for ProvUserMechId                       | notSet                                 | demo123456! | 
+|-|-|-|-|
+|MM.AgentRole          | AAF Role of client susbcribing to MM command topic      | notSet                                 | org.onal.dmaap-bc-mm-prov.agent |
+|-|-|-|-|
+|HttpAllowed           | flag indicating whether http is supported               | false                                  | true |
+|-|-|-|-|
+|IntHttpPort           | Internal port for http service                          | 80                                     | 8080 |
+|-|-|-|-|
+|IntHttpsPort          | Internal port for https service (0 if no cert is avail) | 443                                    | 8443 |
+|-|-|-|-|
+|ExtHttpsPort          | Externally advertised port for https service (deprecated)| 443                                   | 443 |
+|-|-|-|-|
+|KeyStoreType          | Format of Java keystore                                 | jks                                    | jks |
+|-|-|-|-|
+|KeyStoreFile          | Path to java keystore                                   | etc/keystore                           | etc/keystore |
+|-|-|-|-|
+|KeyStorePassword      | Password for keystore                                   | changeit                               | <provided by Certificate Authority> |
+|-|-|-|-|
+|KeyPassword           | Password for private key in the https keystore          | changeit                               | <provided by Certificate Authority> |
+|-|-|-|-|
+|TrustStoreType        | Format of Trust Store file                              | jks                                    | jks |
+|-|-|-|-|
+|TrustStoreFile        | Path to Trust Store file                                |                                        | etc/org.onap.dmaap-bc.trust.jks |
+|-|-|-|-|
+|TrustStorePassword    | Password for Trust Store                                |                                        | <provided by Certificate Authority> |
+|-|-|-|-|
+|QuiesceFile           | Path to file which signals needs to queiesce            |                                        | etc/SHUTDOWN |
+|-|-|-|-|
+
+### Environment Variables
+The following environment variables can be set in the container environment to further effect behavior:
+- DMAAPBC_WAIT_TOEXIT=Y   when set this will attempt to keep the dmaap-bc container running.  Sometimes needed to get a better look at logs when the main proces is exiting for some reason.
+
+- CONFIGMAP_ROOT defaults to /opt/app/config/conf  but can be overwritten if needed.  This value serves as the root to where the buscontroller.env file is found.
+
+- CONFIGMAP_PROPS defaults to /opt/app/config/conf/dmaapbc.properties but can be overwritten if needed