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