Files missing License text
[dmaap/dbcapi.git] / etc / dmaapbc.properties
1 #
2 #
3 # ============LICENSE_START==========================================
4 # org.onap.dmaap
5 # ===================================================================
6 # Copyright © 2018 AT&T Intellectual Property. All rights reserved.
7 # ===================================================================
8 # Licensed under the Apache License, Version 2.0 (the "License");
9 # you may not use this file except in compliance with the License.
10 # You may obtain a copy of the License at
11 #
12 #        http://www.apache.org/licenses/LICENSE-2.0
13 #
14 # Unless required by applicable law or agreed to in writing, software
15 # distributed under the License is distributed on an "AS IS" BASIS,
16 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 # See the License for the specific language governing permissions and
18 # limitations under the License.
19 # ============LICENSE_END============================================
20 # ECOMP is a trademark and service mark of AT&T Intellectual Property.
21 #
22 #
23 #       Configuration parameters fixed at startup for the DMaaP Bus Controller
24 #
25 #
26 #       URI to retrieve dynamic DR configuration
27 #
28 UnitTest: Yes
29 ProvisioningURI:        /internal/prov
30 #
31 #       Allow http access to API 
32 #
33 HttpAllowed:    true
34 #
35 #       The port number for http as seen within the server
36 #
37 IntHttpPort:    8080
38 #
39 #       The port number for https as seen within the server
40 #   Set to 0 if no certificate is available yet...
41 #
42 IntHttpsPort:   0
43 #
44 #       The external port number for https taking port mapping into account
45 #
46 ExtHttpsPort:   0
47 #
48 #       The type of keystore for https
49 #
50 KeyStoreType:   jks
51 #
52 #       The path to the keystore for https
53 #
54 KeyStoreFile:   etc/keystore
55 #
56 #       The password for the https keystore
57 #
58 KeyStorePassword:       changeit
59 #
60 #       The password for the private key in the https keystore
61 #
62 KeyPassword:    changeit
63 #
64 #       The type of truststore for https
65 #
66 TrustStoreType: jks
67 #
68 #       The path to the truststore for https
69 #
70 TrustStoreFile: ${DMAAPBC_TSTOREFILE}
71 #
72 #       The password for the https truststore
73 #
74 TrustStorePassword:     changeit
75 #
76 #       The path to the file used to trigger an orderly shutdown
77 #
78 QuiesceFile:    etc/SHUTDOWN
79 #
80 #       Enable postgress
81 #
82 UsePGSQL:       false
83 #
84 #       The host for postgres access
85 #
86 DB.host:        none
87 #
88 #       For postgres access
89 #
90 DB.cred:        none
91 #
92 #       Name of this environment
93 #
94 DmaapName:      onap-cit
95 #
96 #       Name of DR prov server
97 #
98 DR.provhost:    localhost
99 #
100 # handling of feed delete
101 # DeleteOnDR - means use the DR API to DELETE a feed. (default for backwards compatibility)
102 # SimulateDelete - means preserve the feed on DR (after cleaning it up), and mark as DELETED in DBCL.  Better for cfy environments
103 Feed.deleteHandling: DeleteOnDR
104
105 ################################################################################
106 # MR Related Properties:
107 #
108 #   Value of the CNAME DNS entry which resolves to the primary central MR cluster (when there are more than one central clusters).
109 #   if there is only one MR cluster in an environment, set this to the DNS name for that cluster
110 #
111 MR.CentralCname:  notSet.onap.org
112 #
113 #   MR Client Delete Level thoroughness:
114 #   0 = don't delete
115 #   1 = delete from persistent store
116 #   2 = delete from persistent store (DB) and authorization store (AAF)
117 MR.ClientDeleteLevel: 1
118 #
119 #   MR Topic Factory Namespace
120 #
121 MR.TopicFactoryNS: org.onap.dcae.dmaap.topicFactory
122 #
123 #   MR TopicMgr Role
124 MR.TopicMgrRole:    org.onap.dmaapBC.TopicMgr
125
126 #   MR topic name style
127 MR.topicStyle:  FQTN_LEGACY_FORMAT
128
129 #   MR topic ProjectID
130 MR.projectID:  23456
131 #
132 # end of MR Related Properties
133 ################################################################################
134
135 #
136 #       The Role and credentials of the MirrorMaker Provisioner.  This is used by DMaaP Bus Controller to pub to the provisioning topic
137 #   Not part of 1701
138 #
139 MM.ProvRole: org.onap.dmaapBC.MMprov.prov
140 MM.ProvUserMechId: idNotSet@namespaceNotSet
141 MM.ProvUserPwd: pwdNotSet
142 #
143 #       The Role of the MirrorMaker Agent. This is used by MM to sub to provisioning topic
144 #
145 MM.AgentRole: org.onap.dmaapBC.MMagent.agent
146 #################
147 # AAF Properties:
148 #
149 # regarding password encryption:
150 # 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:
151 #
152 # java \u2013jar wherever/cadi-core-*.jar keygen keyfilename
153 # chmod 400 keyfilename
154 #
155 # To encrypt a key:
156 #
157 # java \u2013jar wherever/cadi-core-*.jar digest password-to-encrypt keyfilename
158 #
159 # This will generate a string.  Put \u201Cenc:\u201D on the front of the string, and put the result in this properties file.
160 #
161 # Location of the Codec Keyfile which is used to decrypt passwords in this properties file before they are passed to AAF
162 #
163 # REF: https://wiki.domain.notset.com/display/cadi/CADI+Deployment
164 #
165 CredentialCodecKeyfile: etc/LocalKey
166 #
167 # This overrides the Class used for Decryption.
168 # This allows for a plugin encryption/decryption method if needed.
169 # Call this Class for decryption at runtime.
170 #AafDecryption.Class: com.company.proprietaryDecryptor 
171
172 #
173 # This overrides the Class used for API Permission check.
174 # This allows for a plugin policy check, if needed
175 #ApiPermission.Class: com.company.policy.DecisionPolicy
176
177 #
178 # URL of AAF environment to use.
179 #
180 aaf.URL:        https://localhost:8095/proxy/
181 #
182 # TopicMgr mechid@namespace
183 #
184 aaf.TopicMgrUser:       idNotSet@namespaceNotSet
185 #
186 # TopicMgr password
187
188 aaf.TopicMgrPassword:   pwdNotSet
189 #
190 # Bus Controller Namespace Admin  mechid@namespace
191 #
192 aaf.AdminUser:  idNotSet@namespaceNotSet
193 #
194 # Bus Controller Namespace Admin password
195 #
196 aaf.AdminPassword:      pwdNotSet
197 #
198 # endof AAF Properties
199 #################
200 #################
201 # PolicyEngine Properties
202 #
203 # Flag to turn on/off Authentication
204 UsePE: false
205 #
206 # Argument to decisionAttributes.put("AAF_ENVIRONMENT", X); 
207 # where X is:  TEST= UAT, PROD = PROD, DEVL = TEST
208 #
209 PeAafEnvironment: DEVL
210 PeAafUrl.DEVL:  https://localhost:8095/proxy/
211 PeAafUrl.TEST:  https://aafist..onap.org:8095/proxy/
212 PeAafUrl.PROD:  https://aafprod.onap.org:8095/proxy/
213
214 #
215 # Name of PolicyEngineApi properties file
216 PolicyEngineProperties: config/PolicyEngineApi.properties
217 #
218 # Namespace for URI values for API used to create AAF permissions
219 # e.g. if ApiNamespace is X.Y..dmaapBC.api then for URI /topics we create an AAF perm X.Y..dmaapBC.api.topics
220 ApiNamespace: org.onap.dmaapBC.api
221 #
222 # endof PolicyEngineProperties
223 #################