Initial OpenECOMP appc/deployment commit
[appc/deployment.git] / installation / README.md
1 # OpenECOMP APP-C - Available Properties
2
3 ---
4 ---
5
6 # Introduction
7
8 The current list of properties that can be overwritten from all default.properties files to appc.properties (./src/main/appc-properties/appc.properties) are list below. Please note that some properties have default values since some code requires it to be defined as part of the building/compilation process. 
9
10 - NOTE: The only defined property values in appc.properties are the following:
11     - "appc.ClosedLoop1607.*" properties (needed for demo)
12     - "appc.provider.vfodl.url" property (needed for demo)
13     - "appc.service.logic.module.name" property (needed for demo)
14     - "appc.topology.dg.*" properties (needed for demo)
15
16 # Properties List
17 The following properties are ready to be defined based on which feature needs to be tested or used:
18
19 - provider1.* properties:
20     - Applies to the following features: appc-rest-adapter-bundle, appc-chef-adapter-bundle, appc-iaas-adapter-bundle
21     - These properties need to be defined in order to use OpenStack-based API executions. For example, the APP-C function "restart" is in charge of restarting a VM when requested. Therefore, properties such as OpenStack credentials, tenant name, VM ID, and others pre-defined in the appc.properties need to be defined with the information of the OpenStack Environment you are deploying APP-C from.
22
23 - dmaap.poolMembers property:
24     - Applies to the following features: appc-command-executor-core, appc-license-manager-core, appc-lifecycle-management-core, appc-request-handler-core, and appc-workflow-management-core (all part of the appc-dispatcher package)
25     - Defines the DMaaP IP or URL location of the DMaaP Pool Members involved in the DMaaP Communication of that feature in specific (NOTE: More than one Pool Member can be defined in the form of a comma-delimited list)
26
27 - appc.ClosedLoop.* properties:
28     - Applies to the following feature: appc-event-listener-bundle (both in src/main and src/test)
29     - These properties define in which DMaaP will the appc-event-listener feature will listen in
30
31 - appc.LCM.* properties:
32     - Applies to the following feature: appc-event-listener-bundle (in src/test only)
33     - These properties define in which DMaaP will the appc-event-listener feature will listen in. These properties are especifically used to define LCM (LifeCycle Management) actions, and are only used as part of JUnit Test Cases.
34
35 - test.* properties:
36     - Applies to the following features: appc-rest-adapter-bundle, appc-chef-adapter-bundle, appc-iaas-adapter-bundle
37     - These are properties that test OpenStack-based APP-C API requests
38
39 - appc.asdc.*:
40     - Applies to the following feature: appc-asdc-listener-bundle
41     - These properties are used to test integration between the SDC OpenECOMP component & APP-C. Properties such as pointing to the DMaaP listener & topic, SDC credentials to authenticate into the SDC component, define the RESTCONF URL, and others are mapped here.
42
43 - Other properties:
44     - poolMembers, event.pool.members, restconf.user, restconf.pass
45         - Applies to the following features: appc-netconf-adapter-bundle, appc-dg-common, appc-dmaap-adapter-bundle
46         - These properties can be defined to use the features defined above. They are used to point to current DMaaP listener, and to define the RESTCONF credentials needed to execute APP-C API requests from the features impacted above.