README.md

   1 #
   2 # ============LICENSE_START==========================================
   3 # org.onap.dmaap
   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
  10 #
  11 #        http://www.apache.org/licenses/LICENSE-2.0
  12 #
  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.
  20 #
  21 #
  22 DMaaP Bus Controller API
  23 =======================
  24
  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.
  28
  29 ### Build Instructions for a Continuous Integration environment using Jenkins
  30
  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:
  32 ```
  33 clean install
  34 javadoc:javadoc
  35 sonar:sonar
  36 ```
  37
  38 ### Build Instructions for external developers
  39
  40 This project is organized as a mvn project for a jar package.
  41 After cloning from this git repo:
  42
  43 ```
  44 mvn clean install javadoc:javadoc
  45 ```
  46
  47 A description of the API is generated, and found in targets/generated-source/swagger.json.
  48
  49 ### Properties File
  50
  51 This section is intended to describe the behavior customization of Bus Controller that can be obtained via properties file used by the dbcapi library.
  52 By default, this file is located in etc/dmaapbc.properties.
  53 However, a java argument -DConfigFile  can be set to a different path.  (Our kubernetes deployment relies on this and points to a configmap, for example.)
  54
  55 The table below lists all the settings, default values (if not set), and shows any explicit setting in ONAP oom kubernetes deployment.
  56
  57 |-|-|-|-|
  58 | Property | Description | Default | ONAP Kubernetes Setting |
  59 |-|-|-|-|
  60 |UseAAF                | Flag for whether AAF authz API is to be used            | false                                  | false |
  61 |-|-|-|-|
  62 |csit                  | Flag for stubbing out many southbound calls in a CSIT environment | No                           | No |
  63 |-|-|-|-|
  64 |DR.provhost           | FQDN of Data Router Provisioning Server (deprecated - now set via API) | notSet                  | dcae-drps.domain.not.set |
  65 |-|-|-|-|
  66 |ProvisioningURI       | URI to retrieve dynamic DR configuration                | /internal/prov                         | /internal/prov |
  67 |-|-|-|-|
  68 |Feed.deleteHandling   | indicator for handling feed delete request              | DeleteOnDR                             | SimulateDelete |
  69 |                      | DeleteOnDR - means use the DR API to DELETE a feed.  (default for backwards compatibility) | | |
  70 |                      | SimulateDelete - means preserve the feed on DR (after cleaning it up), and mark as DELETED in DBCL. | | |
  71 |-|-|-|-|
  72 |UsePGSQL              | flag indicates whether to retain data in Postgresql     | false                                  | true |
  73 |                      | when false, objects will be kept in memory but will be  |                                        | |
  74 |                      | lost on restart and not shared between instances        |                                        | |
  75 |-|-|-|-|
  76 |DB.host               | FQDN or service name of Postresql host                  | dcae-pstg-write-ftl.domain.notset.com  | dbc-pg-primary |
  77 |-|-|-|-|
  78 |DB.name               | name of Postresql database                              | dmaap                                  | |
  79 |-|-|-|-|
  80 |DB.schema             | name of database schema                                 | public                                 | |
  81 |-|-|-|-|
  82 |DB.user               | username for Postgresql access                          | dmaap_admin                            | |
  83 |-|-|-|-|
  84 |DB.cred               | password for Postrgresql access                         | test234-ftl                            | onapdemodb |
  85 |-|-|-|-|
  86 |MR.multisite          | Indicates if there can be multiple sites (locations) where MR is deployed | true                 | false |
  87 |-|-|-|-|
  88 |MR.CentralCname       |  FQDN or service name of MR (deployed in central if multilocation is true) | MRcname.not.set     | message-router |
  89 |-|-|-|-|
  90 |MR ClientDeleteLevel  | MR Client Delete thoroughness                           | 0                                      |  1 |
  91 |                      | 0 = don't delete | | |
  92 |                      | 1 = delete from persistent store (PG) | | |
  93 |                      | 2 = delete from persistent store (PG) and authorization store (AAF) | | |
  94 |-|-|-|-|
  95 |MR.TopicFactoryNS     | AAF namespace used to create perms for MR topics        | MR.topicFactoryNS.not.set              | org.onap.dmaap.mr.topicFactory |
  96 |-|-|-|-|
  97 |MR.TopicMgrRole       | AAF Role used by Buscontroller to create topics on MR   | MR.TopicMgrRole.not.set                | org.onap.dmaap-bc-topic-mgr.client |
  98 |-|-|-|-|
  99 |MR.projectID          | Value for some constructs of fully qualified topic names | 99999                                 | ONAP |
 100 |-|-|-|-|
 101 |MR.hostnameVerify     | Indicates if we want to relax hostname verification on SSL connection  | true                                 | false |
 102 |-|-|-|-|
 103 |MR.authentication     | Authentication method used when connecting to MR | none                                 | basicAuth |
 104 |                      | none = no creds sent (default)                   |  |  |
 105 |                      | basicAuth = formulate Basic Auth HTTP Header using name and pwd credentials |     |  |
 106 |                      | cert = use client certificate                    |  |  |
 107 |-|-|-|-|
 108 |cadi.properties       | Path to CADI properties file                            | /opt/app/osaaf/local/org.onap.dmaap-bc.props | /opt/app/osaaf/lcoal/org.onap.dmaap-bc.props |
 109 |-|-|-|-|
 110 |aaf.URL               | URL of the AAF server                                   | https://authentication.domain.netset.com:8100/proxy/ | https://aaf-service.onap:8100/ |
 111 |-|-|-|-|
 112 |aaf.TopicMgrUser      | AAF Identity of Topic Mgr                               | noMechId@domain.netset.com             | dmaap-bc-topic-mgr@dmaap-bc-topic-mgr.onap.org |
 113 |-|-|-|-|
 114 |aaf.TopicMgrPassword  | AAF Credential for Topic Mgr                            | notSet                                 | demo123456! |
 115 |-|-|-|-|
 116 |aaf.AdminUser         | AAF Identity of user with Admin role for API namespace  | noMechId@domain.netset.com             | aaf_admin@people.osaaf.org |
 117 |-|-|-|-|
 118 |aaf.AdminPassword     | AAF credential of AdminUser                             | notSet                                 | demo123456! |
 119 |-|-|-|-|
 120 |aaf.NsOwnerIdentity     | AAF Identity to be used as topic Namespace owner      | notSet                                 | aaf_admin@people.osaaf.org |
 121 |topicNsRoot           | AAF namespace value used to create FQTN                 | org.onap.dcae.dmaap                    | org.onap.dcae.dmaap |
 122 |-|-|-|-|
 123 |CredentialCodeKeyfile | location of the codec keyfile used to decrypt passwords | LocalKey                               | etc/LocalKey |
 124 |                      | in this properties file before they are passed to AAF   | LocalKey                               | etc/LocalKey |
 125 |-|-|-|-|
 126 |AafDecryption.Class   | Specifies the Class to be used for decryption           | org.onap.dmaap.dbcapi.aaf.ClearDecrypt | |
 127 |-|-|-|-|
 128 |ApiNamespace          | Root namespace for AAF perms related to dbcapi access   | apiNamespace.not.set                   | org.onap.dmaap-bc.api |
 129 |-|-|-|-|
 130 |ApiPermission.Class   | the Class that determines if a call to API is authorized| allow                                  | |
 131 |-|-|-|-|
 132 |MM.ProvRole           | AAF Role of client publishing MM prov cmds              | notSet                                 | org.onap.dmaap-bc-mm-prov.prov |
 133 |-|-|-|-|
 134 |MM.ProvUserMechId     | AAF Identity when publishing to MM command topic        | notSet                                 | dmaap-bc-mm-prov@dmaap-bc-mm-prov.onap.org|
 135 |-|-|-|-|
 136 |MM.ProvUserPwd        | AAF credenital for ProvUserMechId                       | notSet                                 | demo123456! |
 137 |-|-|-|-|
 138 |MM.AgentRole          | AAF Role of client susbcribing to MM command topic      | notSet                                 | org.onal.dmaap-bc-mm-prov.agent |
 139 |-|-|-|-|
 140 |DR.provApi            | Version name of DR API (ONAP or AT&T)                   | ONAP                                   | ONAP |
 141 |-|-|-|-|
 142 |DR.onBehalfHeader     | String for "On Behalf Of" HTTP Header in DR API         | X-DR-ON-BEHALF-OF                      | X-DR-ON-BEHALF-OF |
 143 |-|-|-|-|
 144 |DR.feedContentType    | Value for Content-Type Header in DR Feed API            | application/vnd.dr.feed                | application/vnd.dr.feed |
 145 |-|-|-|-|
 146 |DR subContentType     | Value for Content-Type Header in DR Subscription API    | application/vnd.dr.subscription        | application/vnd.dr.subscription |
 147 |-|-|-|-|
 148 |HttpAllowed           | flag indicating whether http is supported               | false                                  | true |
 149 |-|-|-|-|
 150 |IntHttpPort           | Internal port for http service                          | 80                                     | 8080 |
 151 |-|-|-|-|
 152 |IntHttpsPort          | Internal port for https service (0 if no cert is avail) | 443                                    | 8443 |
 153 |-|-|-|-|
 154 |ExtHttpsPort          | Externally advertised port for https service (deprecated)| 443                                   | 443 |
 155 |-|-|-|-|
 156 |KeyStoreType          | Format of Java keystore                                 | jks                                    | jks |
 157 |-|-|-|-|
 158 |KeyStoreFile          | Path to java keystore                                   | etc/keystore                           | etc/keystore |
 159 |-|-|-|-|
 160 |KeyStorePassword      | Password for keystore                                   | changeit                               | <provided by Certificate Authority> |
 161 |-|-|-|-|
 162 |KeyPassword           | Password for private key in the https keystore          | changeit                               | <provided by Certificate Authority> |
 163 |-|-|-|-|
 164 |TrustStoreType        | Format of Trust Store file                              | jks                                    | jks |
 165 |-|-|-|-|
 166 |TrustStoreFile        | Path to Trust Store file                                |                                        | etc/org.onap.dmaap-bc.trust.jks |
 167 |-|-|-|-|
 168 |TrustStorePassword    | Password for Trust Store                                |                                        | <provided by Certificate Authority> |
 169 |-|-|-|-|
 170 |QuiesceFile           | Path to file which signals needs to queiesce            |                                        | etc/SHUTDOWN |
 171 |-|-|-|-|
 172