summaryrefslogtreecommitdiffstats
path: root/docs/development/design/logging.rst
diff options
context:
space:
mode:
authorYujun Zhang <zhang.yujunz@zte.com.cn>2018-04-03 16:48:24 +0800
committerYujun Zhang <zhang.yujunz@zte.com.cn>2018-04-04 09:05:06 +0800
commitc8a6fe5bb4233eb0551b8424f5d57121e86124a1 (patch)
treee20b2d5586b9b1da5afdd2e90f0dfc83bf3b00b5 /docs/development/design/logging.rst
parent67b7fb49e6ea6ac9c2547af263355e5f1aeade42 (diff)
Move design document to dedicated folder
Change-Id: I20c85b7116cd2b29d0efcaae5ee0b0381a685bbb Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
Diffstat (limited to 'docs/development/design/logging.rst')
-rw-r--r--docs/development/design/logging.rst28
1 files changed, 28 insertions, 0 deletions
diff --git a/docs/development/design/logging.rst b/docs/development/design/logging.rst
new file mode 100644
index 0000000..196ba40
--- /dev/null
+++ b/docs/development/design/logging.rst
@@ -0,0 +1,28 @@
+#######
+Logging
+#######
+
+************
+Installation
+************
+
+Currently, we use the `sample configuration`_ in Istio to install fluentd::
+
+ cd clover/logging
+ kubectl apply -f install
+
+.. _sample configuration: https://istio.io/docs/tasks/telemetry/fluentd.html
+
+********
+Validate
+********
+
+The scripts in ``clover/logging`` validates fluentd installation::
+
+ python clover/logging/validate.py
+
+It validates the installation with the following criterias
+
+#. existence of fluented pod
+#. fluentd input is configured correctly
+#. TBD