diff options
Diffstat (limited to '')
| -rw-r--r-- | source/containers/container_features.rst | 9 | ||||
| -rw-r--r-- | source/containers/docker_specifics.rst | 23 | ||||
| -rw-r--r-- | source/containers/index.rst | 20 |
3 files changed, 52 insertions, 0 deletions
diff --git a/source/containers/container_features.rst b/source/containers/container_features.rst new file mode 100644 index 0000000..7e00db8 --- /dev/null +++ b/source/containers/container_features.rst @@ -0,0 +1,9 @@ +Container-Features +------------------ + +Upon start, rsyslog checks if it is running as pid 1. If so, this is +a clear indication it is running inside a container. This changes +some parameter defaults: + +- :kbd:`Control-C` is enabled +- no pid file is written diff --git a/source/containers/docker_specifics.rst b/source/containers/docker_specifics.rst new file mode 100644 index 0000000..7459df8 --- /dev/null +++ b/source/containers/docker_specifics.rst @@ -0,0 +1,23 @@ +docker specifics +---------------- + +This page talks about docker, as this is the platform the rsyslog +team has hands-on experience with. Some or all of the information +might also apply to other solutions. + +Potential Trouble causes: + +- container terminate timeout + + By default, a docker container has 10 seconds to shut down. If rsyslog + is running with a large queue that needs to be persisted to disk, + that amount of time might be insufficient. This can lead to a hard + kill of rsyslog and potentially cause queue corruption. + +- shared work directories + + Shared work directories call for problems and shall be avoided. If + multiple instances use the same work directory, the may even overwrite + some files, resulting in a total mess. Each container instance should + have its own work directory. + diff --git a/source/containers/index.rst b/source/containers/index.rst new file mode 100644 index 0000000..9699a00 --- /dev/null +++ b/source/containers/index.rst @@ -0,0 +1,20 @@ +rsyslog and containers +====================== + +In this chapter, we describe how rsyslog can be used together with +containers. + +All versions of rsyslog work well in containers. Versions beginning with +8.32.0 have also been made explicitly container-aware and provide some +extra features that are useful inside containers. + +Note: the sources for docker containers created by the rsyslog project +can be found at https://github.com/rsyslog/rsyslog-docker - these may +be useful as a starting point for similar efforts. Feedback, bug +reports and pull requests are also appreciated for this project. + +.. toctree:: + :maxdepth: 2 + + container_features + docker_specifics |