23237a65dd2029cc3a3a0db0bb70896c9c4c8afb
[dmaap/buscontroller.git] / misc / dmaapbc.properties.tmpl
1 cat <<!EOF
2 #
3 #       Configuration parameters fixed at startup for the DMaaP Bus Controller
4 #
5 # CSIT TESTING
6 csit: ${DMAAPBC_CSIT:-No}
7
8 #
9 #       URI to retrieve dynamic DR configuration
10 #
11 ProvisioningURI:        ${DMAAPBC_INTURI:-/internal/prov}
12 #
13 #       Allow http access to API 
14 #
15 HttpAllowed:    ${DMAAPBC_HTTPALLOWED:-true}
16 #
17 #       The port number for http as seen within the server
18 #
19 IntHttpPort:    ${DMAAPBC_INT_HTTP_PORT:-8080}
20 #
21 #       The port number for https as seen within the server
22 #   Set to 0 if no certificate is available yet...
23 #
24 IntHttpsPort:   ${DMAAPBC_INT_HTTPS_PORT:-8443}
25 #
26 #       The external port number for https taking port mapping into account
27 #
28 ExtHttpsPort:   ${DMAAPBC_EXT_HTTPS_PORT:-443}
29 #
30 #       The type of keystore for https
31 #
32 KeyStoreType:   jks
33 #
34 #       The path to the keystore for https
35 #
36 KeyStoreFile:   ${DMAAPBC_KSTOREFILE:-etc/keystore}
37 #
38 #       The password for the https keystore
39 #
40 KeyStorePassword:       ${DMAAPBC_KSTOREPASS:-Demolition Artist Floating}
41 #
42 #       The password for the private key in the https keystore
43 #
44 KeyPassword:    ${DMAAPBC_PVTKEYPASS:-Demolition Artist Floating}
45 #
46 #       The type of truststore for https
47 #
48 TrustStoreType: jks
49 #
50 #       The path to the truststore for https
51 #
52 TrustStoreFile: ${DMAAPBC_TSTOREFILE}
53 #
54 #       The password for the https truststore
55 #
56 TrustStorePassword:     ${DMAAPBC_TSTOREPASS:-changeit}
57 #
58 #       The path to the file used to trigger an orderly shutdown
59 #
60 QuiesceFile:    etc/SHUTDOWN
61 #
62 #       Enable postgress
63 #
64 UsePGSQL:       ${DMAAPBC_PG_ENABLED:-false}
65 #
66 #       The host for postgres access
67 #
68 DB.host:        ${DMAAPBC_PGHOST:-HostNotSet}
69 #
70 #       For postgres access
71 #
72 DB.cred:        ${DMAAPBC_PGCRED:-ValueNotSet}
73 #
74 #       Name of this environment
75 #
76 DmaapName:      ${DMAAPBC_INSTANCE_NAME:-demo}
77 #
78 #       Name of DR prov server
79 #
80 DR.provhost:    ${DMAAPBC_DRPROV_FQDN:-dcae-drps.domain.notset.com}
81 #
82 # handling of feed delete
83 # DeleteOnDR - means use the DR API to DELETE a feed. (default for backwards compatibility)
84 # SimulateDelete - means preserve the feed on DR (after cleaning it up), and mark as DELETED in DBCL.  Better for cfy environments
85 Feed.deleteHandling: ${DMAAPBC_FEED_DELETE:-DeleteOnDR}
86
87 ################################################################################
88 # MR Related Properties:
89 #
90 # ONAP Beijing is a single site deployment.
91 MR.multisite:  false
92 #
93 #   Value of the CNAME DNS entry which resolves to the primary central MR cluster (when there are more than one central clusters).
94 #   if there is only one MR cluster in an environment, set this to the DNS name for that cluster
95 #
96 MR.CentralCname:  ${DMAAPBC_MR_CNAME:-dmaap.onap}
97 #
98 #   MR Client Delete Level thoroughness:
99 #   0 = don't delete
100 #   1 = delete from persistent store
101 #   2 = delete from persistent store (DB) and authorization store (AAF)
102 MR.ClientDeleteLevel: 1
103 #
104 #   MR Topic Factory Namespace
105 #
106 MR.TopicFactoryNS: org.onap.dcae.dmaap.topicFactory
107 #
108 #   MR TopicMgr Role
109 MR.TopicMgrRole:    org.onap.dmaapBC.TopicMgr
110
111 #   MR topic name style
112 MR.topicStyle:  FQTN_LEGACY_FORMAT
113
114 #   MR topic ProjectID
115 MR.projectID:  23456
116 #
117 # end of MR Related Properties
118 ################################################################################
119
120 #
121 #       The Role and credentials of the MirrorMaker Provisioner.  This is used by DMaaP Bus Controller to pub to the provisioning topic
122 #   Not part of 1701
123 #
124 MM.ProvRole: ${DMAAPBC_MMPROV_ROLE:-org.onap.dmaapBC.MMprov.prov}
125 MM.ProvUserMechId: ${DMAAPBC_MMPROV_ID:-idNotSet@namespaceNotSet}
126 MM.ProvUserPwd: ${DMAAPBC_MMPROV_PWD:-pwdNotSet}
127 #
128 #       The Role of the MirrorMaker Agent. This is used by MM to sub to provisioning topic
129 #
130 MM.AgentRole: ${DMAAPBC_MMAGENT_ROLE:-org.onap.dmaapBC.MMagent.agent}
131 #################
132 # AAF Properties:
133 #
134 # regarding password encryption:
135 # 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:
136 #
137 # java \u2013jar wherever/cadi-core-*.jar keygen keyfilename
138 # chmod 400 keyfilename
139 #
140 # To encrypt a key:
141 #
142 # java \u2013jar wherever/cadi-core-*.jar digest password-to-encrypt keyfilename
143 #
144 # This will generate a string.  Put \u201Cenc:\u201D on the front of the string, and put the result in this properties file.
145 #
146 # Location of the Codec Keyfile which is used to decrypt passwords in this properties file before they are passed to AAF
147 #
148 # REF: https://wiki.domain.notset.com/display/cadi/CADI+Deployment
149 #
150 CredentialCodecKeyfile: ${DMAAPBC_CODEC_KEYFILE:-etc/LocalKey}
151 #
152 # This overrides the Class used for Decryption.
153 # This allows for a plugin encryption/decryption method if needed.
154 # Call this Class for decryption at runtime.
155 #AafDecryption.Class: com.company.proprietaryDecryptor 
156
157 #
158 # This overrides the Class used for API Permission check.
159 # This allows for a plugin policy check, if needed
160 #ApiPermission.Class: com.company.policy.DecisionPolicy
161
162 #
163 # URL of AAF environment to use.
164 #
165 aaf.URL:        ${DMAAPBC_AAF_URL:-https://authentication.simpledemo.onap.org:8095/proxy/}
166 #
167 # TopicMgr mechid@namespace
168 #
169 aaf.TopicMgrUser:       ${DMAAPBC_TOPICMGR_USER:-idNotSet@namespaceNotSet}
170 #
171 # TopicMgr password
172
173 aaf.TopicMgrPassword:   ${DMAAPBC_TOPICMGR_PWD:-pwdNotSet}
174 #
175 # Bus Controller Namespace Admin  mechid@namespace
176 #
177 aaf.AdminUser:  ${DMAAPBC_ADMIN_USER:-idNotSet@namespaceNotSet}
178 #
179 # Bus Controller Namespace Admin password
180 #
181 aaf.AdminPassword:      ${DMAAPBC_ADMIN_PWD:-pwdNotSet}
182 #
183 # endof AAF Properties
184 #################
185 #################
186 # PolicyEngine Properties
187 #
188 # Flag to turn on/off Authentication
189 UsePE: ${DMAAPBC_PE_ENABLED:-false}
190 #
191 # Argument to decisionAttributes.put("AAF_ENVIRONMENT", X); 
192 # where X is:  TEST= UAT, PROD = PROD, DEVL = TEST
193 #
194 PeAafEnvironment: ${DMAAPBC_PE_AAF_ENV:-CSIT}
195 PeAafUrl.CSIT:  ${DMAAPBC_AAF_URL:-http://localhost:8095/proxy/}
196 PeAafUrl.DEVL:  https://aafdev.onap.org:8095/proxy/
197 PeAafUrl.TEST:  https://aafist..onap.org:8095/proxy/
198 PeAafUrl.PROD:  https://aafprod.onap.org:8095/proxy/
199
200 #
201 # Name of PolicyEngineApi properties file
202 PolicyEngineProperties: config/PolicyEngineApi.properties
203 #
204 # Namespace for URI values for API used to create AAF permissions
205 # e.g. if ApiNamespace is X.Y..dmaapBC.api then for URI /topics we create an AAF perm X.Y..dmaapBC.api.topics
206 ApiNamespace: ${DMAAPBC_API_NAMESPACE:-org.onap.dmaapBC.api}
207 #
208 # endof PolicyEngineProperties
209 #################
210 !EOF