Release oam-ves-adopter Contatiner

[oam/nf-oam-adopter.git] / docs / deployment-guide.rst

diff --git a/docs/deployment-guide.rst b/docs/deployment-guide.rst
index 69c1bde..4a905e4 100644 (file)
--- a/docs/deployment-guide.rst
+++ b/docs/deployment-guide.rst
@@ -5,4 +5,44 @@
 Deployment Guide
 ================
 
-This document provides a quickstart for deployment of the NF OAM Adopter.
\ No newline at end of file
+Build
+
+.. code-block:: bash
+
+    cd ves-nf-oam-adopter
+    mvn clean install -Pdocker
+
+Go to solution folder and execute
+
+.. code-block:: bash
+
+    cd solution
+    docker-compose up
+
+**Environment variables**
+
+- **SERVER_PORT:** Application server port. Default 443.
+- **USERNAME:** basic auth username for adapter service. Default admin.
+- **PASSWORD:** basic auth password for adapter service. Default admin.
+
+- **KEYSTORE_PATH:** path to ssl certificates key store.
+- **KEY_STORE_PASSWORD:** key store password.
+- **KEY_PASSWORD:** key password.
+- **TRUST_STORE_PATH:** path to ssl certificates trust store.
+- **TRUST_STORE_PASSWORD:** trust store password.
+
+- **VES_COLLECTOR:** ves collector url.
+- **VES_ENCODED_AUTH:** Base64-encoded basic auth e.g. YWRtaW46YWRtaW4= (admin:admin)
+
+- **CONNECTION_TIMEOUT:** HTTP client connection timeout(seconds). Default value 600.
+- **RESPONSE_TIMEOUT:** HTTP client response timeout(seconds). Default value 600.
+
+- **PM_SYNC_TIME_START:** Defines the time for first execution of pull of PM files and forwarding as VES Message.
+- **PM_SYNC_TIME_FREQ:** Define the frequency to trigger the pull and forward of PM data after first execution.
+- **PM_MAPPING_FILE_PATH:** Defines the path where mapping configuration file is located. Default value.
+
+- **SNMP_PORT:** UDP port to listen SNMP traps. Default value 162.
+- **FM_MAPPING_FILE_PATH:** Defines the path where mapping configuration file is located. Default value.
+
+
+