Changes to property docs

Modifying properties documentation.

Change-Id: Idc4907c1ffc540e625235632708bd0e93707beed
Signed-off-by: Patrick Brady <pb071s@att.com>
Issue-id: APPC-275

1 files changed, 125 insertions, 100 deletions

diff --git a/docs/APPC Properties/APPC Properties.rst b/docs/APPC Properties/APPC Properties.rst
index 58f7880..b917b44 100644
--- a/docs/APPC Properties/APPC Properties.rst
+++ b/docs/APPC Properties/APPC Properties.rst
@@ -23,52 +23,53 @@ APPC Available Properties
 Overview
 ========
 
-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 primary properties file for appc is: `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>`_.
 
--  The only defined property values in appc.properties are the
-   following:
+The properties in the appc.properties file override properties which are defined in "default.properties" files throughout the project. The properties in these default files should not be modified, instead the properties should be added to the appc.properties which will override the default values.
 
-   -  "appc.demo.\*" 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)
+There are several other property files as well, which are covered on this page. All property files can be found in the `appc deployment project /installation/src/main/properties
+<https://gerrit.onap.org/r/gitweb?p=appc/deployment.git;a=tree;f=installation/src/main/properties;h=9472f0eca62d393c7af7ebe69f55d02301616a3e;hb=refs/heads/master>`_.
 
-Properties List
-===============
-
-The following features have properties that can be defined by the user as explained below:
-
-**DMaaP Event Bus**
-
-APPC sends asynchronous responses using the DMaaP. It also receives requests from DMaaP (see the `APPC API Guide <http://onap.readthedocs.io/en/latest/submodules/appc.git/docs/APPC%20API%20Guide/APPC%20API%20Guide.html>`_ for further details).
-
-The DMaaP Adapter Bundle handles all DMaaP operations (send / receive messages), and requires the following properties configured in */opt/openecomp/appc/data/properties/appc.properties*.
-
--  **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** & **appc.ClosedLoop1607.\* properties**:
 
-  -  Applies to the following feature: appc-event-listener-bundle
-  -  These properties define in which DMaaP will the appc-event-listener feature will listen in
+Notes
+=====
 
--  **appc.LCM.\* properties**:
+-  When changing a property, please make sure to restart the APPC Docker Container so that the changes kick in using "docker stop <APPC_CONTAINER_NAME>" and then "docker start <APPC_CONTAINER_NAME>".
 
-  -  Applies to the following features: appc-event-listener-bundle, appc-command-executor-core, appc-license-manager-core, appc-request-handler-core, appc-workflow-management-core, and appc-lifecycle-management-core
-  -  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.
+-  When deploying APPC using the `docker-compose.yml <https://gerrit.onap.org/r/gitweb?p=appc/deployment.git;a=blob;f=docker-compose/docker-compose.yml;h=f95a5fed5820a263a546eded6b1e9bdb8eff9a0b;hb=HEAD>`_ script, please make sure that the *SDNC_CONFIG_DIR* environment variable in the appc container configuration parameters points to */opt/openecomp/appc/data/properties* (default parameter value).
 
--  **Other properties**:
 
-  -  \*poolMembers, event.pool.members
+appc.properties
+===============
 
-    -  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
+The following features have properties that can be defined by the user as explained below:
+**Event Listener Properties**
+
+Each event listener which is defined ("LCM" and "demo" by default) has the following properties. Each property name is prefixed by the event listener which the property is for (for example
+appc.demo.property_name or appc.LCM.property_name). In the below list, each property will be prefixed with "appc.eventListener".
+
+-  **appc.eventListener.poolMembers**:
+   Comma separated list which defines the DMaaP servers which will be used by the event listener.
+-  **appc.eventListener.topic.read**:
+   The DMaaP topic name that will be used for incoming messages.
+-  **appc.eventListener.topic.write**:
+   The DMaaP topic name which will be used for outgoing messages.
+-  **appc.eventListener.client.name**:
+   The DMaaP client name. The client name should be unique within the topic name that you are using.
+-  **appc.eventListener.threads.queuesize.min**:
+   The minimum size of the event listener message processing queue. The listener will request new messages once the queue has dropped below this size.
+-  **appc.eventListener.threads.queuesize.max**:
+   The maximum size of the event listener message processing queue. The listener will request no new messages once this maximum size has been reached.
+-  **appc.eventListener.threads.poolsize.min**:
+   The minimum size of the worker threads pool. This is the pool each listener will use to launch longer running operations.
+-  **appc.eventListener.threads.poolsize.max**:
+   The maximum size of the worker threads pool. This is the pool each listener will use to launch longer running operations.
+-  **appc.eventListener.provider.url**:
+   The url of the local OpenDaylight instance that the event listener will use to process the DMaaP message once it has been parsed into the correct format.
+-  **appc.eventListener.provider.user / appc.eventListener.provider.pass**:
+   The username and password for the local OpenDaylight instance, defined by the url property above.
 
 -  **Example**:
 
@@ -84,16 +85,99 @@ The DMaaP Adapter Bundle handles all DMaaP operations (send / receive messages),
 
 	### LCM API (rpc) – synchronous ###
 	# The following properties are required for sending an LCM request over DMaaP
-	appc.LCM.provider.url=https://localhost:8443/restconf/operations/appc-provider-lcm
 	appc.LCM.poolMembers=<HOST_IP_1>:<PORT_NUMBER>,<HOST_IP_2>:<PORT_NUMBER> # e.g. 192.168.1.10:3904
 	appc.LCM.topic.read=<READ_TOPIC> # e.g. test123
 	appc.LCM.topic.write=<WRITE_TOPIC> # e.g. APPC-LCM-TEST
 	appc.LCM.client.name=<CLIENT_NAME> # e.g name1
 	appc.LCM.client.name.id=<CLIENT_ID> # e.g 0
+	appc.LCM.provider.url=https://localhost:8443/restconf/operations/appc-provider-lcm
 	appc.LCM.provider.user=<LCM PROVIDER Username> # e.g. admin
 	appc.LCM.provider.pass=<LCM PROVIDER Username> # e.g. admin
 
+**Properties specific to the demo event listener and use case**
+
+-  **appc.provider.vfodl.url**:
+   The URl to the pg-streams method of the mounted vfirewall/traffic generator. The url string should have the placeholder "NODE_NAME", which will be filled in by the "generic-vnf.vnf-id" of the incoming DMaaP message.
+-  **appc.service.logic.module.name**:
+   The module name in the svclogic database table of the directed graph which will be used by the demo provider to process the request.
+-  **appc.topology.dg.method**:
+   The method name in the svclogic database table of the directed graph which will be used by the demo provider to process the request.
+-  **appc.topology.dg.version**:
+   The version number in the svclogic database table of the directed graph which will be used by the demo provider to process the request.
+
+**IaaS (Infracstructure as a Service) Adapter**
+
+The APPC IaaS Adapter is the southbound adapter of APPC which is responsible of executing VIM-based actions (i.e. OpenStack actions).
+
+To initialize the IaaS Adapter service, the following properties need to be configured in */opt/openecomp/appc/data/properties/appc.properties*. The current default properties for the IaaS adaptor are located in `here <https://gerrit.onap.org/r/gitweb?p=appc/deployment.git;a=blob;f=installation/src/main/properties/appc.properties;h=7900843184eb41f518156e6f285d21adce5fae2e;hb=HEAD>`_.
+
+Note: The IaaS Adapter currently supports the OpenStack VIM *only*, and uses the CDP Libraries to implement the code necessary to run VIM-based LCM actions.
+
+-  **provider1.\* properties**:
+
+  -  Applies to the following features: appc-rest-adapter-bundle, appc-chef-adapter-bundle, appc-iaas-adapter-bundle, appc-ansible-adapter-bundle, appc-rest-healthcheck-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.
+  -  **Properties**:
+
+    -  **provider1.type**:
+       Default value is OpenStackProvider for OpenStack conn.
+    -  **provider1.name**:
+       Default value is OpenStackProvider for OpenStack conn.
+    -  **provider1.identity**:
+       The VIM authentication URL.
+    -  **provider1.tenant1.name**:
+       The Tenant Name of the VIM.
+    -  **provider1.tenant1.userid / provider1.tenant1.password**:
+       The VIM username and password.
+
+
+-  **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
+
+-  **Other iaas properties**:
+
+  -  **org.openecomp.appc.iaas.skiphypervisorcheck**:
+     Skips the hypervisor check which usually occurs during iaas-adapter-bundle startup.
+  -  **org.openecomp.appc.server.state.change.timeout**:
+     The amount of time, in seconds, that the application waits for a change of state of a server to a known valid state before giving up and failing the request.
+  -  **org.openecomp.appc.openstack.poll.interval**:
+     The amount of time, in seconds, between subsequent polls to the openstack provider to update the state of a resource.
+  -  **org.openecomp.appc.stack.state.change.timeout**:
+     The amount of time, in seconds, that the application waits for a change of state of a stacj to a known valid state before giving up and failing the request.
+
+
+**Other Properties**
+
+-  **appc.sdc.\* properties**:
+
+  -  Used to connect to a SDC instance. Applies to the following feature: appc-sdc-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.
+
+-  **restconf.user, restconf.pass properties**:
+
+  -  Applies to the following features: appc-netconf-adapter-bundle, appc-dg-common
+  -  These properties can be defined to define the RESTCONF credentials needed to execute APPC API requests from the features impacted above.
+
+-  **org.openecomp.appc.provider.retry.delay / org.openecomp.appc.provider.retry.limit**:
+
+  -  Applies to the following features: appc-rest-adapter-bundle, appc-iaas-adapter-bundle, appc-chef-adapter-bundle
+  -  These properties are used to configure the retry logic for connection to the IaaS provider(s).  The retry delay property is the amount of time, in seconds, the application waits between retry attempts.  The retry limit is the number of retries that are allowed before the request is failed.
+
+**APPC Transactions Database Connection**
+
+Applies to the following features: appc-dg-common, appc-command-executor-core, appc-request-handler-core, appc-workflow-management-core.
+
+.. code:: bash
+	
+	# appcctl is the default name of the APPC Database Table, equivalent to sdnctl
+	org.openecomp.appc.db.url.appcctl=jdbc:mysql://<HOST_IP>:3306/appcctl
+	org.openecomp.appc.db.user.appcctl=appcctl
+	org.openecomp.appc.db.pass.appcctl=appcctl
 
+aaiclient.properties
+====================
 **AAI Adaptor (SDNC-based)**
 
 APPC connects with ONAP AAI using the SDNC AAI service (sdnc-aai-service-<VERSION_NUMBER>.zip).
@@ -109,6 +193,8 @@ To initialize AAI services on an APPC instance, the following AAI properties nee
 	org.onap.ccsdk.sli.adaptors.aai.uri=<AAI_INSTANCE_LOCATION> # Default value is https://aai.api.simpledemo.openecomp.org:8443
 
 
+dblib.properties
+================
 **Database Connection**
 
 APPC uses the SDNC dblib service (*sdnc-dblib-<VERSION_NUMBER>.zip*) for all database operations. The SQL driver used to connect to the MySQL Database is the MariaDB Driver/Connector.
@@ -130,18 +216,8 @@ NOTE: The values in the default dblib.properties (link referenced above) are the
 	org.onap.ccsdk.sli.jdbc.limit.max=<CONNECTION_POOL_MAX_SIZE> # default is 20
 
 
-**APPC Transactions Database Connection**
-
-Applies to the following features: appc-dg-common, appc-command-executor-core, appc-request-handler-core, appc-workflow-management-core.
-
-.. code:: bash
-	
-	# appcctl is the default name of the APPC Database Table, equivalent to sdnctl
-	org.openecomp.appc.db.url.appcctl=jdbc:mysql://<HOST_IP>:3306/appcctl
-	org.openecomp.appc.db.user.appcctl=appcctl
-	org.openecomp.appc.db.pass.appcctl=appcctl
-
-
+svclogic.properties
+===================
 **Service Logic Interpreter (SLI) - SVCLOGIC**
 
 APPC uses the SDNC SLI service (*sdnc-sli-<VERSION_NUMBER>.zip*) to execute the DG.
@@ -157,54 +233,3 @@ To initialize SLI services, the following properties need to be configured in */
 	org.onap.ccsdk.sli.jdbc.database=<DB_NAME> # e.g. sdnctl
 	org.onap.ccsdk.sli.jdbc.user=<USER> # e.g. sdnctl
 	org.onap.ccsdk.sli.jdbc.password=<PASSWORD>
-
-
-**IaaS (Infracstructure as a Service) Adapter**
-
-The APPC IaaS Adapter is the southbound adapter of APPC which is responsible of executing VIM-based actions (i.e. OpenStack actions).
-
-To initialize the IaaS Adapter service, the following properties need to be configured in */opt/openecomp/appc/data/properties/appc.properties*. The current default properties for the IaaS adaptor are located in `here <https://gerrit.onap.org/r/gitweb?p=appc/deployment.git;a=blob;f=installation/src/main/properties/appc.properties;h=7900843184eb41f518156e6f285d21adce5fae2e;hb=HEAD>`_.
-
-Note: The IaaS Adapter currently supports the OpenStack VIM *only*, and uses the CDP Libraries to implement the code necessary to run VIM-based LCM actions.
-
--  **provider1.\* properties**:
-
-  -  Applies to the following features: appc-rest-adapter-bundle, appc-chef-adapter-bundle, appc-iaas-adapter-bundle, appc-ansible-adapter-bundle, appc-rest-healthcheck-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.
-
--  **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
-
--  **Example**:
-
-  .. code:: bash
-
-	# Provider (VIM) configuration
-	provider1.type=<VIM_TYPE> # default value is OpenStackProvider for OpenStack conn.
-	provider1.name=<VIM_PROVIDER_NAME> # default value is OpenStack for OpenStack conn.
-	provider1.identity=<VIM_IDENTITY_URL> # The VIM authentication URL
-	provider1.tenant1.name=<TENANT_NAME> # The Tenant Name of the VIM
-	provider1.tenant1.userid=<USER_NAME> # The VIM username
-	provider1.tenant1.password=<PASSWORD> # The VIM password
-
-
-**Other Properties**
-
--  **appc.sdc.\* properties**:
-
-  -  Used to connect to a SDC instance. Applies to the following feature: appc-sdc-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.
-
--  **restconf.user, restconf.pass properties**:
-
-  -  Applies to the following features: appc-netconf-adapter-bundle, appc-dg-common
-  -  These properties can be defined to define the RESTCONF credentials needed to execute APPC API requests from the features impacted above.
-
-
-**Notes**
-
--  When changing a property, please make sure to restart the APPC Docker Container so that the changes kick in using "docker stop <APPC_CONTAINER_NAME>" and then "docker start <APPC_CONTAINER_NAME>".
-
--  When deploying APPC using the `docker-compose.yml <https://gerrit.onap.org/r/gitweb?p=appc/deployment.git;a=blob;f=docker-compose/docker-compose.yml;h=f95a5fed5820a263a546eded6b1e9bdb8eff9a0b;hb=HEAD>`_ script, please make sure that the *SDNC_CONFIG_DIR* environment variable in the appc container configuration parameters points to */opt/openecomp/appc/data/properties* (default parameter value).