X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=README.md;h=cefbd42c5c9645db840af79ad0a8ea452bee674c;hb=7f7da1e1af9b4a273ce166984ba0113d6355f442;hp=10d635d62dff029e73415b965c9c0e5a37a2ea79;hpb=31b09346679c636b0f54a99381b602e47bdefd84;p=dmaap%2Fbuscontroller.git

diff --git a/README.md b/README.md
index 10d635d..cefbd42 100644
--- a/README.md
+++ b/README.md
@@ -28,6 +28,12 @@ Data Movement as a Platform (DMaaP) Bus Controller provides an API for other ONA
 A typical DMaaP resource is a Data Router Feed or a Message Router Topic, and their associated publishers and subscribers.
 Other infrastucture resources such as DR Nodes and MR Clusters are also provisioned through this API.
 
+### Sub-components
+
+This project produces the following mvn modules in their respective sub-directories:
+- dmaap-bc is a docker image intended to be used to instantiate the DMaaP Bus Controller container
+- dbc-client is a docker image intended to serve as a temporary http client of the Bus Controller API.  It will be instantiated in a container that is a Helm hook (e.g. post-install hook) that knows how to invoke the Bus Controller API.
+
 ### Build Instructions for a Continuous Integration environment using Jenkins
 
 When this component is included in a Continuous Integration environment, such as structured by the Linux Foundation, the artifacts can be created and deployed via Jenkins.  The following maven targets are currently supported in the Build step:
@@ -38,7 +44,7 @@ clean install
 
 ### Build Instructions for external developers
 
-This project is organized as a mvn project for a jar package.
+This project is organized as a mvn project for a docker image.
 After cloning from this git repo:
 
 ```
@@ -49,13 +55,12 @@ mvn clean install
 ### Docker Packaging
 
 We can utilize docker to build and register the buscontroller container in a local dev repository.
-Note the Dockerfile follows ONAP convention of running app as root.
 
 ```
 
 <assuming DOCKER_HOST is set appropriately for your environment>
 
-$ mvn -P docker docker:build
+$ mvn -P docker 
 ```
 
 
@@ -119,8 +124,8 @@ DMAAPBC_PE_AAF_ENV=TBD
 Then the following steps could be used to pull and run the Bus Controller.  (onap-nexus is just an example)
 ```
 $ 
-$ 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
+$ docker pull nexus3.onap.org:10003/onap/dmaap/dmaap-bc: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/dmaap-bc:latest
 ```
 
 ### Properties
@@ -132,7 +137,7 @@ However, a java argument -DConfigFile  can be set to a different path.  (Our kub
 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 | 
+| Property | Description | Default | ONAP Kubernetes Setting | 
 |-|-|-|-|
 |UseAAF                | Flag for whether AAF authz API is to be used            | false                                  | false |
 |-|-|-|-|
@@ -187,6 +192,9 @@ The table below lists all the settings, default values (if not set), and shows a
 |-|-|-|-|
 |aaf.AdminPassword     | AAF credential of AdminUser                             | notSet                                 | demo123456! |
 |-|-|-|-|
+|aaf.NsOwnerIdentity     | AAF Identity to be used as topic Namespace owner      | notSet                                 | aaf_admin@people.osaaf.org |
+|topicNsRoot           | AAF namespace value used to create FQTN                 | org.onap.dcae.dmaap                    | org.onap.dcae.dmaap | 
+|-|-|-|-|
 |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 |
 |-|-|-|-|
@@ -204,6 +212,14 @@ The table below lists all the settings, default values (if not set), and shows a
 |-|-|-|-|
 |MM.AgentRole          | AAF Role of client susbcribing to MM command topic      | notSet                                 | org.onal.dmaap-bc-mm-prov.agent |
 |-|-|-|-|
+|DR.provApi            | Version name of DR API (ONAP or AT&T)                   | ONAP                                   | ONAP |
+|-|-|-|-|
+|DR.onBehalfHeader     | String for "On Behalf Of" HTTP Header in DR API         | X-DR-ON-BEHALF-OF                      | X-DR-ON-BEHALF-OF |
+|-|-|-|-|
+|DR.feedContentType    | Value for Content-Type Header in DR Feed API            | application/vnd.dr.feed                | application/vnd.dr.feed |
+|-|-|-|-|
+|DR subContentType     | Value for Content-Type Header in DR Subscription API    | application/vnd.dr.subscription        | application/vnd.dr.subscription |
+|-|-|-|-|
 |HttpAllowed           | flag indicating whether http is supported               | false                                  | true |
 |-|-|-|-|
 |IntHttpPort           | Internal port for http service                          | 80                                     | 8080 |