From 34c8b93c43b3cf80750d8b296123305e4e09f70c Mon Sep 17 00:00:00 2001 From: "Claudio D. Gasparini" Date: Tue, 1 Jun 2021 13:38:04 +0200 Subject: [PATCH] Document env variables or docker-compose Issue-ID: OAM-208 Signed-off-by: Claudio D. Gasparini Change-Id: Iafcdbc133edc8f738e5544d2781cf8184d37a062 --- docs/deployment-guide.rst | 30 +++++++++++++++++++++++++++++- docs/pm/index.rst | 2 +- 2 files changed, 30 insertions(+), 2 deletions(-) diff --git a/docs/deployment-guide.rst b/docs/deployment-guide.rst index 8e17ce0..4a905e4 100644 --- a/docs/deployment-guide.rst +++ b/docs/deployment-guide.rst @@ -17,4 +17,32 @@ Go to solution folder and execute .. code-block:: bash cd solution - docker-compose up \ No newline at end of file + 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. + + + diff --git a/docs/pm/index.rst b/docs/pm/index.rst index 8088dc7..5b680b1 100644 --- a/docs/pm/index.rst +++ b/docs/pm/index.rst @@ -182,7 +182,7 @@ REST PM Configuration Configuration file **application.yml** contains global definitions required to be consumed by PM REST adapters services. - **synchronization-time-start** Defines the time for execution of pull of PM files and forwarding as VES Message -- **synchronization-time-frequency** Defines the time for execution of pull of PM files and forwarding as VES Message +- **synchronization-time-frequency** Define the frequency to trigger the pull and forward of PM data after first execution. - **mapping-config-path** Defines the path where mapping configuration file is located **Rest SB Client Adapter configuration** -- 2.16.6