From 7b09e9782c4e6892a8d16fd4e3aa2cca440a41e6 Mon Sep 17 00:00:00 2001
From: Rich Megginson <rmeggins@redhat.com>
Date: Wed, 22 Aug 2018 08:37:03 -0600
Subject: [PATCH] url not required - add information about CRI-O
The KubernetesURL parameter is not mandatory since it has
a useful default value.
Add information about CRI-O.
Minor cleanup.
---
source/configuration/modules/mmkubernetes.rst | 18 +++++++++---------
1 file changed, 9 insertions(+), 9 deletions(-)
diff --git a/source/configuration/modules/mmkubernetes.rst b/source/configuration/modules/mmkubernetes.rst
index be9e710f..a3cd4d49 100644
--- a/source/configuration/modules/mmkubernetes.rst
+++ b/source/configuration/modules/mmkubernetes.rst
@@ -19,14 +19,14 @@ namespace.
.. note::
- This **only** works with log files in `/var/log/containers/*.log`
- (docker `--log-driver=json-file`), or with journald entries with
+ This **only** works with log files in `/var/log/containers/*.log` (docker
+ `--log-driver=json-file`, or CRI-O log files), or with journald entries with
message properties `CONTAINER_NAME` and `CONTAINER_ID_FULL` (docker
- `--log-driver=journald`), and when the application running inside
- the container writes logs to `stdout`/`stderr`. This **does not**
- currently work with other log drivers.
+ `--log-driver=journald`), and when the application running inside the
+ container writes logs to `stdout`/`stderr`. This **does not** currently
+ work with other log drivers.
-For json-file logs, you must use the `imfile` module with the
+For json-file and CRI-O logs, you must use the `imfile` module with the
`addmetadata="on"` parameter, and the filename must match the
liblognorm rules specified by the `filenamerules`
(:ref:`filenamerules`) or `filenamerulebase` (:ref:`filenamerulebase`)
@@ -70,7 +70,7 @@ KubernetesURL
:widths: auto
:class: parameter-table
- "word", "https://kubernetes.default.svc.cluster.local:443", "yes", "none"
+ "word", "https://kubernetes.default.svc.cluster.local:443", "no", "none"
The URL of the Kubernetes API server. Example: `https://localhost:8443`.
@@ -248,8 +248,6 @@ match the filename and extract metadata. The default value is::
In the above rules, the slashes ``\`` ending each line indicate
line wrapping - they are not part of the rule.
-There are two rules because the `container_hash` is optional.
-
.. _filenamerulebase:
filenamerulebase
@@ -351,6 +349,8 @@ get the basic necessary Kubernetes metadata from the filename:
input(type="imfile" file="/var/log/containers/*.log"
tag="kubernetes" addmetadata="on")
+(Add `reopenOnTruncate="on"` if using Docker, not required by CRI-O).
+
and/or an `imjournal` input for docker journald container logs annotated by
Kubernetes: