onap/sdc/README.md

   1 ##############################################################################################################################################
   2 ## SDC logging configuration
   3 =================================================================================================
   4 SDC has two docker containers - sdc-BE and sdc-FE.
   5 Each one has its own separate logback.xml file.
   6 Canonical logs will be generated at /var/log/onap/sdc/
   7 =================================================================================================
   8 ## Instructions for deployment
   9 =================================================================================================
  10 ### SDC logging deployment for sdc-FE
  11 -------------------------------------------------------------------------------------------------
  12   1. Create the canonical path for log provider, /etc/onap/sdc/conf.d/fe, on the host VM.
  13   2. Copy the logback.xml from 'fe' directory (of gerrit) into the path created in step 1.
  14   3. Create the canonical path for logs, /var/log/onap/sdc/sdc-fe, on the host VM.
  15   4. Provide write permissions for "others" user for directory created in step 3.
  16   5. Volume-Mount: The sdc-FE container requires two host paths mapped as volume in the container
  17           5.1. Log Provider file path:
  18               Host path -      /etc/onap/sdc/conf.d/fe/logback.xml mapped to
  19         Container path - ${JETTY_BASE}/config/catalog-fe/logback.xml
  20       5.2. Log file path:
  21              Host path -      /var/log/onap/sdc/sdc-fe/ mapped to
  22         Container path - /var/log/onap/sdc/sdc-fe/
  23 -------------------------------------------------------------------------------------------------
  24 ### SDC logging deployment for sdc-BE
  25 -------------------------------------------------------------------------------------------------
  26   1. Create the canonical path for log provider, /etc/onap/sdc/conf.d/be, on the host VM.
  27   2. Copy the logback.xml from 'be' directory (of gerrit) into the canonical path created in step 1.
  28   3. Create the canonical path for logs, /var/log/onap/sdc/sdc-be, on the host VM.
  29   4. Provide write permissions for "others" user for directory created in step 3.
  30   5. Volume-Mount: The sdc-BE container requires two host paths mapped as volume in the container
  31        5.1. Log Provider file path:
  32        Host path -      /etc/onap/sdc/conf.d/be/logback.xml mapped to
  33        Container path - ${JETTY_BASE}/config/catalog-be/logback.xml
  34      5.2. Log file path:
  35           Host path -      /var/log/onap/sdc/sdc-be/ mapped to
  36        Container path - /var/log/onap/sdc/sdc-be/
  37 -------------------------------------------------------------------------------------------------
  38 Note - ${JETTY_BASE} in the test environment was set to /var/lib/jetty/
  39 ##############################################################################################################################################