rsyslog/rsyslog
1
0
Fork 0
mirror of https://github.com/rsyslog/rsyslog.git synced 2026-05-10 17:20:50 +02:00
Code Issues Packages Projects Releases Wiki Activity

packaging/docker: clarify host is not an image

Browse Source 
Why:
Recent review feedback treated `packaging/docker/rsyslog/host/` as a
missing image variant because its README read like an image-specific
artifact. The current tree needs a sharper boundary between published
images and auxiliary packaging material.

Impact: No behavior change; documentation now states the support scope.

Before/After: `host/` looked like an image variant; it now reads as
auxiliary host-side material outside the published image family.

Technical Overview:
The top-level rsyslog container README now states explicitly that the
published image family in this subtree is limited to the five variants
built by the Makefile.

The `host/README.md` file now says this directory is not a built or
published Docker image target. It explains that the contents are
host-side forwarding configuration material and points readers back to
the main container README for the actual supported image list.

With the help of AI-Agents: Codex
This commit is contained in:
Rainer Gerhards 2026-03-21 12:51:05 +01:00
parent 73e409dcf1
commit 1e0889ed8a
No known key found for this signature in database
GPG Key ID: 0CB6B2A8BE80B499
2 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
packaging/docker/rsyslog/README.md
View File

@ -9,6 +9,10 @@ container image family:
- `rsyslog/rsyslog-dockerlogs`
- `rsyslog/rsyslog-etl`
These are the only published image variants in this subtree.
The `host/` subdirectory contains auxiliary host-side forwarding
material and is not a built or published container image target.
Docker Hub descriptions for these repos can be maintained from this
subtree with `sync_dockerhub_metadata.py` and `dockerhub_metadata.json`.
The script reads credentials from `DOCKERHUB_USERNAME` /

11
packaging/docker/rsyslog/host/README.md
View File

@ -1,5 +1,10 @@
## rsyslog container for forwarding host logs
## Host-side forwarding example material
This configuration is meant for a container that ships logs from the local host to a remote collector using rsyslog.
This directory is not a built or published Docker image variant.
See the [main README](../../README.md) for an overview of all images and build instructions.
It contains auxiliary rsyslog configuration material for forwarding host
logs to a remote collector. It is not part of the supported container
image family built by `packaging/docker/rsyslog/Makefile`.
See the [main README](../README.md) for the actual published image
variants and build instructions.