onap/aai/README.md

   1 ####################################################################################################################################################################
   2 ## AAI Logging Configuration
   3 ====================================================================================================================================================================
   4 AAI has two vm instances
   5 vm1-aai-inst1 has docker containers- testconfig_aai.searchservice.simpledemo.openecomp.org_1,testconfig_datarouter_1,
   6 testconfig_aai-traversal.api.simpledemo.openecomp.org_1,testconfig_aai-resources.api.simpledemo.openecomp.org_1,testconfig_sparky-be_1,testconfig_model-loader_1,
   7 vm1-aai-inst2 has docker containers- elasticsearch,testconfig_aai.gremlinserver.simpledemo.openecomp.org_1,testconfig_aai.hbase.simpledemo.openecomp.org_1.
   8 Each container has its own logback.xml
   9 Canonical logs will be generated at /var/log/onap/aai/
  10 ====================================================================================================================================================================
  11 ## Instructions for deployment
  12 ====================================================================================================================================================================
  13 ### AAI logging deployment for search_search.amdocs.lab_1
  14 --------------------------------------------------------------------------------------------------------------------------------------------------------------------
  15   1. Create the log provider file path, /etc/onap/aai/conf.d/aai-search, on the host VM.
  16   2. Copy the canonical \91logback.xml\92 from 'aai' directory (of gerrit) into the path created in step 1.
  17   3. Give the read access to 'others' for the file, /etc/onap/aai/conf.d/aai-search/logback.xml.
  18      This will give access to the 'aaiadmin' user used by the AAI container to read this file.
  19   4. Create the canonical path for logs, /var/log/onap/aai/aai-search, on the host VM.
  20   5. Provide write permissions for "others" users for directory created in step 4.
  21   6. Volume-Mount: The aai container requires two host paths mapped as volume in the container
  22
  23       6.1. Log file path:
  24         Host path -      /var/log/onap/aai/aai-search mapped to
  25         Container path - /var/log/onap/aai/aai-sdb
  26       6.2. Log provider file path:
  27         Host Path               : /etc/onap/aai/conf.d/aai-search/logback.xml mapped to
  28         Container path          : /opt/app/search-data-service/bundleconfig/etc/logback.xml
  29 -------------------------------------------------------------------------------------------------------------------------------------------------------------------
  30 ### AAI logging deployment for sparky_sparky.amdocs.lab_1
  31 --------------------------------------------------------------------------------------------------------------------------------------------------------------------
  32   1. Create the log provider file path, /etc/onap/aai/conf.d/aai-sparky, on the host VM.
  33   2. Copy the canonical \91logback.xml\92 from 'aai' directory (of gerrit) into the path created in step 1.
  34   3. Give the read access to 'others' for the file, /etc/onap/aai/conf.d/aai-search/logback.xml.
  35      This will give access to the 'aaiadmin' user used by the AAI container to read this file.
  36   4. Create the canonical path for logs, /var/log/onap/aai/aai-sparky, on the host VM.
  37   5. Provide write permissions for "others" users for directory created in step 4.
  38   6. Volume-Mount: The aai container requires two host paths mapped as volume in the container
  39
  40       6.1. Log file path:
  41         Host path -      /var/log/onap/aai/aai-sparky mapped to
  42         Container path - /var/log/onap/aai/aai-ui
  43       6.2. Log provider file path:
  44         Host Path               : /etc/onap/aai/conf.d/aai-sparky/logback.xml mapped to
  45         Container path          : /opt/app/sparky/bundleconfig/etc/logback.xml
  46 -------------------------------------------------------------------------------------------------------------------------------------------------------------------
  47 ### AAI logging deployment for modelloader_model-loader.amdocs.lab_1
  48 --------------------------------------------------------------------------------------------------------------------------------------------------------------------
  49   1. Create the log provider file path, /etc/onap/aai/conf.d/aai-model-loader, on the host VM.
  50   2. Copy the canonical \91logback.xml\92 from 'aai' directory (of gerrit) into the path created in step 1.
  51   3. Give the read access to 'others' for the file, /etc/onap/aai/conf.d/aai-model-loader/logback.xml.
  52      This will give access to the 'aaiadmin' user used by the AAI container to read this file.
  53   4. Create the canonical path for logs, /var/log/onap/aai/aai-model-loader, on the host VM.
  54   5. Provide write permissions for "others" users for directory created in step 4.
  55   6. Volume-Mount: The aai container requires two host paths mapped as volume in the container
  56
  57       6.1. Log file path:
  58         Host path -      /var/log/onap/aai/aai-model-loader mapped to
  59         Container path - /var/log/onap/aai/aai-ml
  60       6.2. Log provider file path:
  61         Host Path               : /etc/onap/aai/conf.d/aai-model-loader/logback.xml mapped to
  62         Container path          : /opt/app/model-loader/bundleconfig/etc/logback.xml
  63 -------------------------------------------------------------------------------------------------------------------------------------------------------------------
  64 ### AAI logging deployment for testconfig_aai-traversal.api.simpledemo.openecomp.org_1
  65 --------------------------------------------------------------------------------------------------------------------------------------------------------------------
  66   1. Create the log provider file path, /etc/onap/aai/conf.d/aai-traversal, on the host VM.
  67   2. Copy the canonical \91logback.xml\92 from 'aai' directory (of gerrit) into the path created in step 1.
  68   3. Give the read access to 'others' for the file, /etc/onap/aai/conf.d/aai-traversal/logback.xml.
  69      This will give access to the 'aaiadmin' user used by the AAI container to read this file.
  70   4. Create the canonical path for logs, /var/log/onap/aai/aai-traversal, on the host VM.
  71   5. Provide write permissions for "others" users for directory created in step 4.
  72   6. Volume-Mount: The aai container requires two host paths mapped as volume in the container
  73
  74       6.1. Log file path:
  75         Host path -      /var/log/onap/aai/aai-traversal mapped to
  76         Container path - /var/log/onap/aai/
  77       6.2. Log provider file path:
  78         Host Path               : /etc/onap/aai/conf.d/aai-traversal/logback.xml mapped to
  79         Container path          : /opt/app/aai-traversal/bundleconfig/etc/logback.xml
  80 -------------------------------------------------------------------------------------------------------------------------------------------------------------------
  81 ### AAI logging deployment for testconfig_aai-resources.api.simpledemo.openecomp.org_1
  82 --------------------------------------------------------------------------------------------------------------------------------------------------------------------
  83   1. Create the log provider file path, /etc/onap/aai/conf.d/aai-resources, on the host VM.
  84   2. Copy the canonical \91logback.xml\92 from 'aai' directory (of gerrit) into the path created in step 1.
  85   3. Give the read access to 'others' for the file, /etc/onap/aai/conf.d/aai-resources/logback.xml.
  86      This will give access to the 'aaiadmin' user used by the AAI container to read this file.
  87   4. Create the canonical path for logs, /var/log/onap/aai/aai-resources, on the host VM.
  88   5. Provide write permissions for "others" users for directory created in step 4.
  89   6. Volume-Mount: The aai container requires two host paths mapped as volume in the container
  90
  91       6.1. Log file path:
  92         Host path -      /var/log/onap/aai/aai-resources mapped to
  93         Container path - /var/log/onap/aai/aai-resources
  94       6.2. Log provider file path:
  95         Host Path               : /etc/onap/aai/conf.d/aai-resources/logback.xml mapped to
  96         Container path          : /opt/app/aai-resources/bundleconfig/etc/logback.xml
  97 ####################################################################################################################################################################