summaryrefslogtreecommitdiffstats
path: root/onap/aai/README.md
diff options
context:
space:
mode:
authorVidya Shinde <vidya.shinde@amdocs.com>2017-09-22 21:03:43 +0530
committerVidya Shinde <vidya.shinde@amdocs.com>2017-09-22 21:03:43 +0530
commit65f9feec471b1180b7e0d466ce198290a62fc07d (patch)
tree757a42cd0b21fb1a66eebcacf79216e973b773fc /onap/aai/README.md
parentaa41076737c6f58f524d10c806904889ddc606d1 (diff)
[LOG] Add canonicalization for AAI logs
Canonicalization of path for log provider configuration file and log files for new AAI components Change-Id: I34611392f25cfcd0e7e180ef672f64d7dd20928a Issue-ID: LOG-63 Signed-off-by: Vidya Shinde <vidya.shinde@amdocs.com>
Diffstat (limited to 'onap/aai/README.md')
-rw-r--r--onap/aai/README.md95
1 files changed, 74 insertions, 21 deletions
diff --git a/onap/aai/README.md b/onap/aai/README.md
index a930eb9..2721df2 100644
--- a/onap/aai/README.md
+++ b/onap/aai/README.md
@@ -1,44 +1,97 @@
####################################################################################################################################################################
## AAI Logging Configuration
====================================================================================================================================================================
-AAI has two docker containers- aai-service, hbase-1.2.3 and model-loader-service.
+AAI has two vm instances
+vm1-aai-inst1 has docker containers- testconfig_aai.searchservice.simpledemo.openecomp.org_1,testconfig_datarouter_1,
+testconfig_aai-traversal.api.simpledemo.openecomp.org_1,testconfig_aai-resources.api.simpledemo.openecomp.org_1,testconfig_sparky-be_1,testconfig_model-loader_1,
+vm1-aai-inst2 has docker containers- elasticsearch,testconfig_aai.gremlinserver.simpledemo.openecomp.org_1,testconfig_aai.hbase.simpledemo.openecomp.org_1.
Each container has its own logback.xml
Canonical logs will be generated at /var/log/onap/aai/
====================================================================================================================================================================
## Instructions for deployment
====================================================================================================================================================================
-### AAI logging deployment for aai-service
+### AAI logging deployment for search_search.amdocs.lab_1
--------------------------------------------------------------------------------------------------------------------------------------------------------------------
- 1. Log provider file is available at the path, /etc/onap/aai/conf.d/, on the host VM.
+ 1. Create the log provider file path, /etc/onap/aai/conf.d/aai-search, on the host VM.
2. Copy the canonical ‘logback.xml’ from 'aai' directory (of gerrit) into the path created in step 1.
- 3. Give the read access to 'others' for the file, /etc/onap/aai/conf.d/logback.xml.
+ 3. Give the read access to 'others' for the file, /etc/onap/aai/conf.d/aai-search/logback.xml.
This will give access to the 'aaiadmin' user used by the AAI container to read this file.
- 4. Create the canonical path for logs, /var/log/onap/aai, on the host VM.
+ 4. Create the canonical path for logs, /var/log/onap/aai/aai-search, on the host VM.
5. Provide write permissions for "others" users for directory created in step 4.
6. Volume-Mount: The aai container requires two host paths mapped as volume in the container
- 6.1. Log file path:
- Host path - /var/log/onap/aai/ mapped to
- Container path - /var/log/onap/aai/
+ 6.1. Log file path:
+ Host path - /var/log/onap/aai/aai-search mapped to
+ Container path - /var/log/onap/aai/aai-sdb
6.2. Log provider file path:
- Host Path : /etc/onap/aai/conf.d/logback.xml mapped to
- Container path : /opt/app/aai/bundleconfig/etc/logback.xml
+ Host Path : /etc/onap/aai/conf.d/aai-search/logback.xml mapped to
+ Container path : /opt/app/search-data-service/bundleconfig/etc/logback.xml
-------------------------------------------------------------------------------------------------------------------------------------------------------------------
-### AAI logging deployment for Model-Loader
+### AAI logging deployment for sparky_sparky.amdocs.lab_1
--------------------------------------------------------------------------------------------------------------------------------------------------------------------
- 1. Log provider file is available at the path, /opt/jetty/jetty*/webapps/model-loader/WEB-INF/classes/, in the container.
- Note: Inside model-loader docker image. (jetty* refers to the particular version being used.
- In release-1.0 environment, the name is '/jetty-distribution-9.3.9.v20160517')
+ 1. Create the log provider file path, /etc/onap/aai/conf.d/aai-sparky, on the host VM.
2. Copy the canonical ‘logback.xml’ from 'aai' directory (of gerrit) into the path created in step 1.
- 3. Give the read access to 'others' for the file, /etc/onap/aai/conf.d/logback.xml.
+ 3. Give the read access to 'others' for the file, /etc/onap/aai/conf.d/aai-search/logback.xml.
This will give access to the 'aaiadmin' user used by the AAI container to read this file.
- 4. Create the canonical path for logs, /var/log/onap/aai/aai-ml, on the host VM.
+ 4. Create the canonical path for logs, /var/log/onap/aai/aai-sparky, on the host VM.
5. Provide write permissions for "others" users for directory created in step 4.
- 6. Volume-Mount: The aai container requires one host path mapped as volume in the container
+ 6. Volume-Mount: The aai container requires two host paths mapped as volume in the container
+
+ 6.1. Log file path:
+ Host path - /var/log/onap/aai/aai-sparky mapped to
+ Container path - /var/log/onap/aai/aai-ui
+ 6.2. Log provider file path:
+ Host Path : /etc/onap/aai/conf.d/aai-sparky/logback.xml mapped to
+ Container path : /opt/app/sparky/bundleconfig/etc/logback.xml
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------
+### AAI logging deployment for modelloader_model-loader.amdocs.lab_1
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------
+ 1. Create the log provider file path, /etc/onap/aai/conf.d/aai-model-loader, on the host VM.
+ 2. Copy the canonical ‘logback.xml’ from 'aai' directory (of gerrit) into the path created in step 1.
+ 3. Give the read access to 'others' for the file, /etc/onap/aai/conf.d/aai-model-loader/logback.xml.
+ This will give access to the 'aaiadmin' user used by the AAI container to read this file.
+ 4. Create the canonical path for logs, /var/log/onap/aai/aai-model-loader, on the host VM.
+ 5. Provide write permissions for "others" users for directory created in step 4.
+ 6. Volume-Mount: The aai container requires two host paths mapped as volume in the container
+
+ 6.1. Log file path:
+ Host path - /var/log/onap/aai/aai-model-loader mapped to
+ Container path - /var/log/onap/aai/aai-ml
+ 6.2. Log provider file path:
+ Host Path : /etc/onap/aai/conf.d/aai-model-loader/logback.xml mapped to
+ Container path : /opt/app/model-loader/bundleconfig/etc/logback.xml
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------
+### AAI logging deployment for testconfig_aai-traversal.api.simpledemo.openecomp.org_1
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------
+ 1. Create the log provider file path, /etc/onap/aai/conf.d/aai-traversal, on the host VM.
+ 2. Copy the canonical ‘logback.xml’ from 'aai' directory (of gerrit) into the path created in step 1.
+ 3. Give the read access to 'others' for the file, /etc/onap/aai/conf.d/aai-traversal/logback.xml.
+ This will give access to the 'aaiadmin' user used by the AAI container to read this file.
+ 4. Create the canonical path for logs, /var/log/onap/aai/aai-traversal, on the host VM.
+ 5. Provide write permissions for "others" users for directory created in step 4.
+ 6. Volume-Mount: The aai container requires two host paths mapped as volume in the container
+
+ 6.1. Log file path:
+ Host path - /var/log/onap/aai/aai-traversal mapped to
+ Container path - /var/log/onap/aai/
+ 6.2. Log provider file path:
+ Host Path : /etc/onap/aai/conf.d/aai-traversal/logback.xml mapped to
+ Container path : /opt/app/aai-traversal/bundleconfig/etc/logback.xml
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------
+### AAI logging deployment for testconfig_aai-resources.api.simpledemo.openecomp.org_1
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------
+ 1. Create the log provider file path, /etc/onap/aai/conf.d/aai-resources, on the host VM.
+ 2. Copy the canonical ‘logback.xml’ from 'aai' directory (of gerrit) into the path created in step 1.
+ 3. Give the read access to 'others' for the file, /etc/onap/aai/conf.d/aai-resources/logback.xml.
+ This will give access to the 'aaiadmin' user used by the AAI container to read this file.
+ 4. Create the canonical path for logs, /var/log/onap/aai/aai-resources, on the host VM.
+ 5. Provide write permissions for "others" users for directory created in step 4.
+ 6. Volume-Mount: The aai container requires two host paths mapped as volume in the container
- 6.1. Log file path:
- Host path - /var/log/onap/aai/aai-ml mapped to
- Container path - /var/log/onap/aai/aai-ml
+ 6.1. Log file path:
+ Host path - /var/log/onap/aai/aai-resources mapped to
+ Container path - /var/log/onap/aai/aai-resources
6.2. Log provider file path:
- Note: Log provider path cannot be configured externally as it is bundled inside a WAR.
+ Host Path : /etc/onap/aai/conf.d/aai-resources/logback.xml mapped to
+ Container path : /opt/app/aai-resources/bundleconfig/etc/logback.xml
####################################################################################################################################################################