summaryrefslogtreecommitdiffstats
path: root/elasticstack/kibana/conf/README.md
diff options
context:
space:
mode:
authoralkac <alkac@amdocs.com>2017-08-09 18:01:29 +0530
committeralkac <alkac@amdocs.com>2017-08-09 18:20:12 +0530
commitd909f3025be234e619be20687aa2de1a75544819 (patch)
tree0111b20862c1445e86e62d75c18319c3257df50f /elasticstack/kibana/conf/README.md
parent51102c49bd61dad9df9ab664be8d478405877bde (diff)
[LOG]Add Config of Kibana for ONAP Log
Issue-ID: LOG-40 Change-Id: I20d9aad75e8a78d14b77c0b5fb698a6bf1c8671f Signed-off-by: alkac <alkac@amdocs.com>
Diffstat (limited to 'elasticstack/kibana/conf/README.md')
-rw-r--r--elasticstack/kibana/conf/README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/elasticstack/kibana/conf/README.md b/elasticstack/kibana/conf/README.md
new file mode 100644
index 0000000..e04dd64
--- /dev/null
+++ b/elasticstack/kibana/conf/README.md
@@ -0,0 +1,27 @@
+#Kibana canonical configuration
+-------------------------------
+This kibana configuration is the deployment settings for kibana environment.
+
+#Files provided for kibana deployment
+---------------------------------------
+# kibana.yml
+# kibana.properties
+
+#Instructions for deployment
+----------------------------
+1. Create canonical path /etc/onap/kibana/conf.d on the host on which the kibana has to be installed.
+1. The kibana.yml is parameterized and has tokens instead of values for certain deployment specific parameters. These tokens has a syntax as '$[a-zA-Z_]+'.
+3. These tokens are listed in another file kibana.properties. These properties are also provided with commented description about them in the file itself. These tokens have to be replaced with the appropriate values as per the deployment environment before deployment.
+4. Now, save the final kibana.yml at location created in step 1.
+5. Following is the list of specifications for kibana container creation-
+
+ Image - 'docker.elastic.co/kibana/kibana:5.5.0' available in the Elastic Docker Registry.
+
+ Port mapping - Default port published by kibana is 5601
+ The container port 5601 should be published to host port 5601
+
+ Volume mapping - The kibana container must have one host paths mapped as volume in the container
+ Host path - /etc/onap/kibana/conf.d/kibana.yml mapped to
+ Container path - /usr/share/kibana/config/kibana.yml
+
+6. kibana.properties need not be deployed after the values from it are used.