onap/so/README.md

   1 ####################################################################################################################################################################
   2 ## SO Logging Configuration
   3 ====================================================================================================================================================================
   4 SO has 2 docker containers with names - testlab_mso_1 and testlab_mariadb_1.
   5 The canonical logging implementation is only done for the container, testlab_mso_1.
   6 SO has 9 sub-modules and each module has its own logback.xml file.
   7 Canonical logs will be generated at /var/log/onap/so/
   8 ====================================================================================================================================================================
   9 ## Instructions for deployment
  10 ====================================================================================================================================================================
  11 ### SO logging deployment for sub-modules
  12 -------------------------------------------------------------------------------------------------------------------------------------------------------------------
  13     1. Create the canonical path for log provider, /etc/onap/so/conf.d/, on the host VM.
  14   2. Copy the canonical logback.xmls listed below from 'so' directory (of gerrit) into the path created in step 1.
  15        2.1. logback.apihandler-infra.xml
  16              2.2. logback.appc.xml
  17              2.3. logback.asdc.xml
  18              2.4. logback.bpmn.xml
  19              2.5. logback.msorequestsdbadapter.xml
  20              2.6. logback.network.xml
  21              2.7. logback.sdnc.xml
  22              2.8. logback.tenant.xml
  23              2.9. logback.vnf.xml
  24   3. Create the canonical path for logs, /var/log/onap/so, on the host VM.
  25   4. Provide write permissions for "others" users for directory created in step 3.
  26   5. Volume-Mount: The so container requires two host paths mapped as volume in the container
  27           5.1. Log file path:
  28              Host path -      /var/log/onap/so/ mapped to
  29         Container path - /var/log/onap/so/
  30       5.2. Log provider file path has two mappings:
  31           # The below container paths are where the provider files are kept initially
  32                          /etc/onap/so/conf.d/logback.apihandler-infra.xml           : /var/berks-cookbooks/mso-config/files/default/mso-api-handler-infra-config/logback.apihandler-infra.xml
  33                          /etc/onap/so/conf.d/logback.network.xml                         : /var/berks-cookbooks/mso-config/files/default/mso-po-adapter-config/logback.network.xml
  34                          /etc/onap/so/conf.d/logback.tenant.xml                           : /var/berks-cookbooks/mso-config/files/default/mso-po-adapter-config/logback.tenant.xml
  35                          /etc/onap/so/conf.d/logback.vnf.xml                               : /var/berks-cookbooks/mso-config/files/default/mso-po-adapter-config/logback.vnf.xml
  36                          /etc/onap/so/conf.d/logback.appc.xml                             : /var/berks-cookbooks/mso-config/files/default/mso-appc-adapter-config/logback.appc.xml
  37                          /etc/onap/so/conf.d/logback.msorequestsdbadapter.xml     : /var/berks-cookbooks/mso-config/files/default/mso-requests-db-adapter-config/logback.msorequestsdbadapter.xml
  38                          /etc/onap/so/conf.d/logback.asdc.xml                             : /var/berks-cookbooks/mso-config/files/default/mso-asdc-controller-config/logback.asdc.xml
  39                          /etc/onap/so/conf.d/logback.sdnc.xml                             : /var/berks-cookbooks/mso-config/files/default/mso-sdnc-adapter-config/logback.sdnc.xml
  40                          /etc/onap/so/conf.d/logback.bpmn.xml                             : /var/berks-cookbooks/mso-config/files/default/mso-bpmn-config/logback.bpmn.xml
  41
  42              # The below container paths are where the provider files are copied to after the docker starts
  43            /etc/onap/so/conf.d/logback.apihandler-infra.xml            : /etc/mso/config.d/logback.apihandler-infra.xml
  44            /etc/onap/so/conf.d/logback.network.xml                            : /etc/mso/config.d/logback.network.xml
  45            /etc/onap/so/conf.d/logback.tenant.xml                            : /etc/mso/config.d/logback.tenant.xml
  46            /etc/onap/so/conf.d/logback.vnf.xml                                  : /etc/mso/config.d/logback.vnf.xml
  47            /etc/onap/so/conf.d/logback.appc.xml                              : /etc/mso/config.d/logback.appc.xml
  48            /etc/onap/so/conf.d/logback.msorequestsdbadapter.xml      : /etc/mso/config.d/logback.msorequestsdbadapter.xml
  49            /etc/onap/so/conf.d/logback.asdc.xml                              : /etc/mso/config.d/logback.asdc.xml
  50            /etc/onap/so/conf.d/logback.sdnc.xml                              : /etc/mso/config.d/logback.sdnc.xml
  51            /etc/onap/so/conf.d/logback.bpmn.xml                              : /etc/mso/config.d/logback.bpmn.xml
  52 ####################################################################################################################################################################