2 # ============LICENSE_START==========================================
4 # ===================================================================
5 # Copyright © 2018 AT&T Intellectual Property. All rights reserved.
6 # ===================================================================
7 # Licensed under the Apache License, Version 2.0 (the "License");
8 # you may not use this file except in compliance with the License.
9 # You may obtain a copy of the License at
11 # http://www.apache.org/licenses/LICENSE-2.0
13 # Unless required by applicable law or agreed to in writing, software
14 # distributed under the License is distributed on an "AS IS" BASIS,
15 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 # See the License for the specific language governing permissions and
17 # limitations under the License.
18 # ============LICENSE_END============================================
19 # ECOMP is a trademark and service mark of AT&T Intellectual Property.
22 DMaaP Bus Controller API
23 =======================
25 Data Movement as a Platform (DMaaP) Bus Controller provides an API for other ONAP infrastructure components to provision DMaaP resources.
26 A typical DMaaP resource is a Data Router Feed or a Message Router Topic, and their associated publishers and subscribers.
27 Other infrastucture resources such as DR Nodes and MR Clusters are also provisioned through this API.
29 ### Build Instructions for a Continuous Integration environment using Jenkins
31 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 ### Build Instructions for external developers
40 This project is organized as a mvn project for a jar package.
41 After cloning from this git repo:
44 mvn clean install javadoc:javadoc
47 A description of the API is generated, and found in targets/generated-source/swagger.json.
49 ### Configurable Parameters
51 Behavior of the API is controlled by settings in a properties file (typically etc/dmaapbc.properties).
52 The following describes these properties:
57 # Configuration parameters fixed at startup for the DMaaP Bus Controller
60 # URI to retrieve dynamic DR configuration
62 ProvisioningURI: /internal/prov
64 # Allow http access to API
68 # The port number for http as seen within the server
72 # The port number for https as seen within the server
73 # Set to 0 if no certificate is available yet...
77 # The external port number for https taking port mapping into account
81 # The type of keystore for https
85 # The path to the keystore for https
87 KeyStoreFile: etc/keystore
89 # The password for the https keystore
91 KeyStorePassword: changeit
93 # The password for the private key in the https keystore
97 # The type of truststore for https
101 # The path to the truststore for https
103 TrustStoreFile: /opt/app/java/jdk/jdk180/jre/security/cacerts
105 # The password for the https truststore
107 TrustStorePassword: changeit
109 # The path to the file used to trigger an orderly shutdown
111 QuiesceFile: etc/SHUTDOWN
117 # The host for postgres access
121 # For postgres access
125 # Name of this environment
127 DmaapName: DeploymentEnvName
129 # Name of DR prov server
131 DR.provhost: dcae-drps.domain.notset.com
133 # The Role and credentials of the MirrorMaker Provisioner. This is used by DMaaP Bus Controller to pub to the provisioning topic
136 #MM.ProvRole: org.openecomp.dmaapBC.MMprov.prov
137 #MM.ProvUserMechId: idNotSet@namespaceNotSet
138 #MM.ProvUserPwd: enc:fMxh-hzYZldbtyXumQq9aJU08SslhbM6mXtt
140 # The Role of the MirrorMaker Agent. This is used by MM to sub to provisioning topic
142 MM.AgentRole: org.openecomp.dmaapBC.MMagent.agent
146 # regarding password encryption:
147 # 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:
149 # java \u2013jar wherever/cadi-core-*.jar keygen keyfilename
150 # chmod 400 keyfilename
154 # java \u2013jar wherever/cadi-core-*.jar digest password-to-encrypt keyfilename
156 # This will generate a string. Put \u201Cenc:\u201D on the front of the string, and put the result in this properties file.
158 # Location of the Codec Keyfile which is used to decrypt passwords in this properties file before they are passed to AAF
160 # REF: https://wiki.domain.notset.com/display/cadi/CADI+Deployment
162 CredentialCodecKeyfile: etc/LocalKey
164 # URL of AAF environment to use.
166 aaf.URL: https://authentication.simpledemo.openecomp.org:8095/proxy/
168 # TopicMgr mechid@namespace
170 aaf.TopicMgrUser: idNotSet@namespaceNotSet
174 aaf.TopicMgrPassword: enc:zyRL9zbI0py3rJAjMS0dFOnYfEw_mJhO
176 # Bus Controller Namespace Admin mechid@namespace
178 aaf.AdminUser: idNotSet@namespaceNotSet
180 # Bus Controller Namespace Admin password
182 aaf.AdminPassword: enc:YEaHwOJrwhDY8a6usetlhbB9mEjUq9m
184 # endof AAF Properties
187 # PolicyEngine Properties
189 # Flag to turn on/off Authentication
192 # Argument to decisionAttributes.put("AAF_ENVIRONMENT", X);
193 # where X is: TEST= UAT, PROD = PROD, DEVL = TEST
195 PeAafEnvironment: DEVL
197 # Name of PolicyEngineApi properties file
198 PolicyEngineProperties: config/PolicyEngineApi.properties
200 # Namespace for URI values for API used to create AAF permissions
201 # e.g. if ApiNamespace is X.Y..dmaapBC.api then for URI /topics we create an AAF perm X.Y..dmaapBC.api.topics
202 ApiNamespace: org.onap.dmaap.dbcapi
204 # endof PolicyEngineProperties