Skip to content

Commit 09ab68e

Browse files
committed
docs(fluentd-images): adjustments
Signed-off-by: Bence Csati <bence.csati@axoflow.com>
1 parent 70590fd commit 09ab68e

File tree

1 file changed

+5
-23
lines changed

1 file changed

+5
-23
lines changed

images/fluentd/README.md

Lines changed: 5 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,22 @@
11
# [Fluentd](https://www.fluentd.org/) container images for the [Logging operator](https://github.com/kube-logging/logging-operator)
22

3-
This repository publishes [Fluentd](https://www.fluentd.org/) container images to be used with the [Logging operator](https://github.com/kube-logging/logging-operator).
3+
You can find [Fluentd](https://www.fluentd.org/) container images to be used with the [Logging operator](https://github.com/kube-logging/logging-operator) in here.
44

55
## Usage
66

7-
Pick Fluentd version (either full semver or a shortened major-minor version).
87
Pick an image type (`filters` contains filter plugins only, `full` has output plugins as well).
98
Image tags are constructed according to the following pattern:
109

1110
```sh
12-
ghcr.io/kube-logging/fluentd:VERSION-IMAGE-TYPE
11+
ghcr.io/kube-logging/logging-operator/fluentd:{LOGGING-OPERATOR-VERSION}-{IMAGE-TYPE}
1312
```
1413

15-
To ensure that subsequent builds don't break your production environment,
16-
you may want to pin your image to a specific build:
17-
18-
```sh
19-
ghcr.io/kube-logging/fluentd:VERSION-IMAGE-TYPE-build.BUILD_NUMBER
20-
```
21-
22-
While the tag in the first example is a moving tag (subsequent builds of the same versions produce the same tags),
23-
build number annotated tags are immutable.
24-
2514
### Add new plugins
2615

2716
If you wish to add a new plugin, use this image as a base image in your `Dockerfile`:
2817

2918
```dockerfile
30-
FROM ghcr.io/kube-logging/fluentd:VERSION-IMAGE-TYPE-build.BUILD_NUMBER
19+
FROM ghcr.io/kube-logging/logging-operator/fluentd:{LOGGING-OPERATOR-VERSION}-{IMAGE-TYPE}
3120
```
3221

3322
Then add your plugin:
@@ -42,16 +31,9 @@ According to the Logging Operators release-cycle (6 weeks) we maintain the corre
4231

4332
## Maintenance
4433

45-
Whenever a new Fluentd version is released, check the supported versions and add/remove versions in this repository accordingly.
46-
47-
The versioned directories in the repository root are Fluentd versions.
34+
Whenever a new Fluentd version is released, check the supported versions and add/remove versions in this directory accordingly.
4835

49-
When a new Fluentd minor version is released, copy the directory of an earlier version and update the version numbers in it.
5036
Based on the supported Fluentd versions, you may drop old versions from the repository.
5137

52-
When adding and deleting versions from this repository, don't forget to update the build matrix in [.github/workflows/depdency-images.yaml](../../.github/workflows/dependency-images.yaml).
53-
54-
Dockerfiles in this repository are not generated and they don't use build args to keep things simple.
38+
The `Dockerfile` in this directory is not generated and it doesn't use build args to keep things simple.
5539
We may revisit that decision in the future.
56-
57-
Patch versions are automatically updated by renovate.

0 commit comments

Comments
 (0)