docs/APPC Properties/APPC Properties.rst

   1 ===========================
   2 APPC - Available Properties
   3 ===========================
   4
   5 Introduction
   6 ============
   7
   8 The current list of properties that can be overwritten from all
   9 default.properties files to `appc.properties
  10 <https://gerrit.onap.org/r/gitweb?p=appc/deployment.git;a=blob;f=installation/src/main/properties/appc.properties;h=b2d4e1c0dfe44a6c5d7cab4b9d2a0463b2889bfd;hb=HEAD>`_ are listed below. Please note
  11 that some properties have default values since some code requires it to
  12 be defined as part of the building/compilation process.
  13
  14 -  The only defined property values in appc.properties are the
  15    following:
  16
  17    -  "appc.ClosedLoop1607.\*" properties (needed for demo)
  18    -  "appc.provider.vfodl.url" property (needed for demo)
  19    -  "appc.service.logic.module.name" property (needed for demo)
  20    -  "appc.topology.dg.\*" properties (needed for demo)
  21
  22 Properties List
  23 ===============
  24
  25 The following properties are ready to be defined based on which feature
  26 needs to be tested or used:
  27
  28 -  **provider1.\* properties**:
  29
  30    -  Applies to the following features: appc-rest-adapter-bundle,
  31       appc-chef-adapter-bundle, appc-iaas-adapter-bundle
  32    -  These properties need to be defined in order to use
  33       OpenStack-based API executions. For example, the APPC function
  34       "restart" is in charge of restarting a VM when requested.
  35       Therefore, properties such as OpenStack credentials, tenant name,
  36       VM ID, and others pre-defined in the appc.properties need to be
  37       defined with the information of the OpenStack Environment you are
  38       deploying APPC from.
  39
  40 -  **dmaap.poolMembers property**:
  41
  42    -  Applies to the following features: appc-command-executor-core,
  43       appc-license-manager-core, appc-lifecycle-management-core,
  44       appc-request-handler-core, and appc-workflow-management-core (all
  45       part of the appc-dispatcher package)
  46    -  Defines the DMaaP IP or URL location of the DMaaP Pool Members
  47       involved in the DMaaP Communication of that feature in specific
  48       (NOTE: More than one Pool Member can be defined in the form of a
  49       comma-delimited list)
  50
  51 -  **appc.ClosedLoop.\* properties**:
  52
  53    -  Applies to the following feature: appc-event-listener-bundle (both
  54       in src/main and src/test)
  55    -  These properties define in which DMaaP will the
  56       appc-event-listener feature will listen in
  57
  58 -  **appc.LCM.\* properties**:
  59
  60    -  Applies to the following feature: appc-event-listener-bundle (in
  61       src/test only)
  62    -  These properties define in which DMaaP will the
  63       appc-event-listener feature will listen in. These properties are
  64       especifically used to define LCM (LifeCycle Management) actions,
  65       and are only used as part of JUnit Test Cases.
  66
  67 -  **test.\* properties**:
  68
  69    -  Applies to the following features: appc-rest-adapter-bundle,
  70       appc-chef-adapter-bundle, appc-iaas-adapter-bundle
  71    -  These are properties that test OpenStack-based APPC API requests
  72
  73 -  **appc.asdc.\* properties**:
  74
  75    -  Applies to the following feature: appc-asdc-listener-bundle
  76    -  These properties are used to test integration between the SDC
  77       ONAP component & APPC. Properties such as pointing to the
  78       DMaaP listener & topic, SDC credentials to authenticate into the
  79       SDC component, define the RESTCONF URL, and others are mapped
  80       here.
  81
  82 -  **Other properties**:
  83
  84    -  poolMembers, event.pool.members, restconf.user, restconf.pass
  85
  86       -  Applies to the following features: appc-netconf-adapter-bundle,
  87          appc-dg-common, appc-dmaap-adapter-bundle
  88       -  These properties can be defined to use the features defined
  89          above. They are used to point to current DMaaP listener, and to
  90          define the RESTCONF credentials needed to execute APPC API
  91          requests from the features impacted above.