summaryrefslogtreecommitdiffstats
path: root/onap/vid/README.md
diff options
context:
space:
mode:
authorVidya Shinde <VIDYASH@amdocs.com>2017-08-11 15:11:49 +0530
committerVidya Shinde <vidya.shinde@amdocs.com>2017-08-11 15:52:41 +0530
commitf54e335ef68b28e087fb8625098fc49bd285b4d4 (patch)
treea67a7bdf4c4bbe450a610f0e1f7732fa75690d7f /onap/vid/README.md
parentd909f3025be234e619be20687aa2de1a75544819 (diff)
[LOG] Add canonicalization for VID logs
Canonicalization of path for log provider configuration file and log files Change-Id: Ifc7fec117f7d6f2fcb7a67b0861582ce5f50342f Issue-ID: LOG-27 Signed-off-by: Vidya Shinde <vidya.shinde@amdocs.com>
Diffstat (limited to 'onap/vid/README.md')
-rw-r--r--onap/vid/README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/onap/vid/README.md b/onap/vid/README.md
new file mode 100644
index 0000000..05c5a0a
--- /dev/null
+++ b/onap/vid/README.md
@@ -0,0 +1,20 @@
+##############################################################################################################################################
+## VID logging configuration
+=====================================================================================
+VID has two docker containers - vid-server and vid-mariadb.
+The canonical logging implementation is only done for the container, vid-server.
+Canonical logs will be generated at /var/log/onap/vid/
+=================================================================================================
+## Instructions for deployment
+=================================================================================================
+ 1. Log provider file is available at the path, /tomcat/webapps/vid/WEB-INF/classes/, in the container
+ 2. Copy the canonical logback.xml from 'vid' directory (of gerrit) into the path mentioned in step 1.
+ 3. Create the canonical path, /var/log/onap/vid/, on the host VM.
+ 4. Provide write permissions for "others" user for directory created in step 3.
+ 5. Volume-Mount: The vid-server container requires one host path mapped as volume in the container
+ 5.1. Log file path:
+ Host path - /var/log/onap/vid/ mapped to
+ Container path - /var/log/onap/vid/
+ 5.2. Log Provider file path:
+ Note: Log provider path cannot be configured externally as it is bundled inside a WAR.
+##############################################################################################################################################