1 DMaaP Bus Controller API
2 =======================
4 Data Movement as a Platform (DMaaP) Bus Controller provides an API for other ONAP infrastructure components to provision DMaaP resources.
5 A typical DMaaP resource is a Data Router Feed or a Message Router Topic, and their associated publishers and subscribers.
6 Other infrastucture resources such as DR Nodes and MR Clusters are also provisioned through this API.
8 ### Build Instructions for a Continuous Integration environment using Jenkins
10 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:
17 ### Build Instructions for external developers
19 This project is organized as a mvn project for a jar package.
20 After cloning from this git repo:
23 mvn clean install javadoc:javadoc
26 ### Configurable Parameters
28 Behavior of the API is controlled by settings in a properties file (typically etc/dmaapbc.properties).
29 The following describes these properties:
34 # Configuration parameters fixed at startup for the DMaaP Bus Controller
37 # URI to retrieve dynamic DR configuration
39 ProvisioningURI: /internal/prov
41 # Allow http access to API
45 # The port number for http as seen within the server
49 # The port number for https as seen within the server
50 # Set to 0 if no certificate is available yet...
54 # The external port number for https taking port mapping into account
58 # The type of keystore for https
62 # The path to the keystore for https
64 KeyStoreFile: etc/keystore
66 # The password for the https keystore
68 KeyStorePassword: changeit
70 # The password for the private key in the https keystore
74 # The type of truststore for https
78 # The path to the truststore for https
80 TrustStoreFile: /opt/app/java/jdk/jdk180/jre/security/cacerts
82 # The password for the https truststore
84 TrustStorePassword: changeit
86 # The path to the file used to trigger an orderly shutdown
88 QuiesceFile: etc/SHUTDOWN
94 # The host for postgres access
102 # Name of this environment
104 DmaapName: DeploymentEnvName
106 # Name of DR prov server
108 DR.provhost: dcae-drps.domain.notset.com
110 # The Role and credentials of the MirrorMaker Provisioner. This is used by DMaaP Bus Controller to pub to the provisioning topic
113 #MM.ProvRole: org.openecomp.dmaapBC.MMprov.prov
114 #MM.ProvUserMechId: idNotSet@namespaceNotSet
115 #MM.ProvUserPwd: enc:fMxh-hzYZldbtyXumQq9aJU08SslhbM6mXtt
117 # The Role of the MirrorMaker Agent. This is used by MM to sub to provisioning topic
119 MM.AgentRole: org.openecomp.dmaapBC.MMagent.agent
123 # regarding password encryption:
124 # In the dependencies that Maven retrieves (e.g., under dcae_dmaapbc/target/deps/ is a jar file cadi-core-version.jar. Generate the key file with:
126 # java \u2013jar wherever/cadi-core-*.jar keygen keyfilename
127 # chmod 400 keyfilename
131 # java \u2013jar wherever/cadi-core-*.jar digest password-to-encrypt keyfilename
133 # This will generate a string. Put \u201Cenc:\u201D on the front of the string, and put the result in this properties file.
135 # Location of the Codec Keyfile which is used to decrypt passwords in this properties file before they are passed to AAF
137 # REF: https://wiki.domain.notset.com/display/cadi/CADI+Deployment
139 CredentialCodecKeyfile: etc/LocalKey
141 # URL of AAF environment to use.
143 aaf.URL: https://authentication.simpledemo.openecomp.org:8095/proxy/
145 # TopicMgr mechid@namespace
147 aaf.TopicMgrUser: idNotSet@namespaceNotSet
151 aaf.TopicMgrPassword: enc:zyRL9zbI0py3rJAjMS0dFOnYfEw_mJhO
153 # Bus Controller Namespace Admin mechid@namespace
155 aaf.AdminUser: idNotSet@namespaceNotSet
157 # Bus Controller Namespace Admin password
159 aaf.AdminPassword: enc:YEaHwOJrwhDY8a6usetlhbB9mEjUq9m
161 # endof AAF Properties
164 # PolicyEngine Properties
166 # Flag to turn on/off Authentication
169 # Argument to decisionAttributes.put("AAF_ENVIRONMENT", X);
170 # where X is: TEST= UAT, PROD = PROD, DEVL = TEST
172 PeAafEnvironment: DEVL
174 # Name of PolicyEngineApi properties file
175 PolicyEngineProperties: config/PolicyEngineApi.properties
177 # Namespace for URI values for API used to create AAF permissions
178 # e.g. if ApiNamespace is X.Y..dmaapBC.api then for URI /topics we create an AAF perm X.Y..dmaapBC.api.topics
179 ApiNamespace: org.onap.dmaap.dbcapi
181 # endof PolicyEngineProperties