Add APPC Properties documentation to readthedocs

Adding documentation regarding APPC properties, which ones are available to be modified in appc.properties, and how they are used to implement/use APPC features.

Change-Id: I95719a628df1a11a68aaff8711f67cc2dbcb053f
Signed-off-by: Hector Anapan <ha076r@att.com>
Issue-Id: [APPC-247]

diff --git a/docs/APPC Properties/APPC Properties.rst b/docs/APPC Properties/APPC Properties.rst
new file mode 100644 (file)
index 0000000..67c1460
--- /dev/null
+++ b/docs/APPC Properties/APPC Properties.rst
@@ -0,0 +1,91 @@
+===========================
+APPC - Available Properties
+===========================
+
+Introduction
+============
+
+The current list of properties that can be overwritten from all
+default.properties files to `appc.properties
+<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
+that some properties have default values since some code requires it to
+be defined as part of the building/compilation process.
+
+-  The only defined property values in appc.properties are the
+   following:
+
+   -  "appc.ClosedLoop1607.\*" properties (needed for demo)
+   -  "appc.provider.vfodl.url" property (needed for demo)
+   -  "appc.service.logic.module.name" property (needed for demo)
+   -  "appc.topology.dg.\*" properties (needed for demo)
+
+Properties List
+===============
+
+The following properties are ready to be defined based on which feature
+needs to be tested or used:
+
+-  **provider1.\* properties**:
+
+   -  Applies to the following features: appc-rest-adapter-bundle,
+      appc-chef-adapter-bundle, appc-iaas-adapter-bundle
+   -  These properties need to be defined in order to use
+      OpenStack-based API executions. For example, the APPC 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 APPC from.
+
+-  **dmaap.poolMembers property**:
+
+   -  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)
+   -  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)
+
+-  **appc.ClosedLoop.\* properties**:
+
+   -  Applies to the following feature: appc-event-listener-bundle (both
+      in src/main and src/test)
+   -  These properties define in which DMaaP will the
+      appc-event-listener feature will listen in
+
+-  **appc.LCM.\* properties**:
+
+   -  Applies to the following feature: appc-event-listener-bundle (in
+      src/test only)
+   -  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.
+
+-  **test.\* properties**:
+
+   -  Applies to the following features: appc-rest-adapter-bundle,
+      appc-chef-adapter-bundle, appc-iaas-adapter-bundle
+   -  These are properties that test OpenStack-based APPC API requests
+
+-  **appc.asdc.\* properties**:
+
+   -  Applies to the following feature: appc-asdc-listener-bundle
+   -  These properties are used to test integration between the SDC
+      ONAP component & APPC. 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.
+
+-  **Other properties**:
+
+   -  poolMembers, event.pool.members, restconf.user, restconf.pass
+
+      -  Applies to the following features: appc-netconf-adapter-bundle,
+         appc-dg-common, appc-dmaap-adapter-bundle
+      -  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 APPC API
+         requests from the features impacted above.

diff --git a/docs/index.rst b/docs/index.rst
index 6d3c9aa..e3c87e2 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -10,3 +10,4 @@ APPC Deployment Documentation Repository
    Chef Adapter/Chef Adapter
    Ansible Adapter/Ansible Adapter
    Platform Logic/Platform Logic
+   APPC Properties/APPC Properties