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