Skip to content

Commit 5c625de

Browse files
committed
Extract the detail of tagging rules from README.md
It is better to be shorter description in README.md to sync explanation with docker.com. https://hub.docker.com/repository/docker/fluent/fluentd/general Signed-off-by: Kentaro Hayashi <[email protected]>
1 parent ccd804e commit 5c625de

File tree

2 files changed

+72
-71
lines changed

2 files changed

+72
-71
lines changed

README.md

Lines changed: 2 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -42,81 +42,12 @@ Current images use fluentd v1 series.
4242
4343
We recommend to use debian version for production because it uses jemalloc to mitigate memory fragmentation issue.
4444

45+
If you want to know the detail of supported image tags, see [TAGRULE](TAGRULE.md) explanation.
46+
4547
### Using Kubernetes?
4648

4749
Check [fluentd-kubernetes-daemonset](https://github.com/fluent/fluentd-kubernetes-daemonset) images.
4850

49-
## The detail of image tag
50-
51-
This image is based on the popular Debian images and [Alpine Linux project][1], available in
52-
[the alpine official image][2].
53-
54-
### For current images
55-
56-
#### `edge`
57-
58-
Latest released version of Fluentd.
59-
60-
#### `vX.Y-A`
61-
62-
Latest version of `vX.Y` Fluentd branch.
63-
64-
`A` will be incremented when image has major changes.
65-
66-
When fluentd version is updated, A is reset to `1`.
67-
68-
#### `vX.Y.Z-A.B`
69-
70-
Concrete `vX.Y.Z` version of Fluentd. This tag is recommeded for the production environment.
71-
72-
`A` will be incremented when image has major changes.
73-
`B` will be incremented when image has small changes, e.g. library update or bug fixes.
74-
75-
When fluentd version is updated, `A.B` is reset to `1.0`.
76-
77-
#### `debian` included tag
78-
79-
The image based on [Debian Linux image][7].
80-
You may use this image when you require plugins which cannot be installed on Alpine (like `fluent-plugin-systemd`).
81-
82-
#### `armhf` included tag
83-
84-
The `armhf` images use ARM base images for use on devices such as Raspberry Pis.
85-
86-
Furthermore, the base images enable support for cross-platform builds using the cross-build tools from [resin.io](https://docs.resin.io/reference/base-images/resin-base-images/#resin-xbuild-qemu).
87-
88-
In order to build these images natively on ARM devices, the `CROSS_BUILD_START` and `CROSS_BUILD_END` Docker build arguments must be set to the shell no-op (`:`), for example:
89-
```bash
90-
docker build --build-arg CROSS_BUILD_START=":" --build-arg CROSS_BUILD_END=":" -t fluent/fluentd:v1.3-onbuild-1 v1.3/armhf/alpine-onbuild
91-
```
92-
(assuming the command is run from the root of this repository).
93-
94-
### For older images
95-
96-
These images/tags are kept for backward compatibility. No update anymore and don't use for new deployment. Use "current images" instead.
97-
98-
#### `stable`, `latest`
99-
100-
These tags are obsolete, already removed to avoid confusing.
101-
Use `edge`, `vX.Y-A` or `vX.Y.Z-A.B` images instead.
102-
103-
#### `vX.Y`
104-
105-
Latest version of `vX.Y` Fluentd branch.
106-
107-
#### `vX.Y.Z`
108-
109-
Concrete `vX.Y.Z` version of Fluentd.
110-
111-
#### `onbuild` included tag
112-
113-
`onbuild` images are deprecated. Use non-`onbuild ` images instead to build your image.
114-
New images, v1.5 or later, don't provide `onbuild` version.
115-
116-
#### `debian` included tag, `armhf` included tag
117-
118-
Same as current images.
119-
12051
## How to use this image
12152

12253
To create endpoint that collects logs on your host just run:

TAGRULE.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
## The detail of image tag
2+
3+
This image is based on the popular Debian images and [Alpine Linux project][1], available in
4+
[the alpine official image][2].
5+
6+
### For current images
7+
8+
#### `edge`
9+
10+
Latest released version of Fluentd.
11+
12+
#### `vX.Y-A`
13+
14+
Latest version of `vX.Y` Fluentd branch.
15+
16+
`A` will be incremented when image has major changes.
17+
18+
When fluentd version is updated, A is reset to `1`.
19+
20+
#### `vX.Y.Z-A.B`
21+
22+
Concrete `vX.Y.Z` version of Fluentd. This tag is recommeded for the production environment.
23+
24+
`A` will be incremented when image has major changes.
25+
`B` will be incremented when image has small changes, e.g. library update or bug fixes.
26+
27+
When fluentd version is updated, `A.B` is reset to `1.0`.
28+
29+
#### `debian` included tag
30+
31+
The image based on [Debian Linux image][7].
32+
You may use this image when you require plugins which cannot be installed on Alpine (like `fluent-plugin-systemd`).
33+
34+
#### `armhf` included tag
35+
36+
The `armhf` images use ARM base images for use on devices such as Raspberry Pis.
37+
38+
Furthermore, the base images enable support for cross-platform builds using the cross-build tools from [resin.io](https://docs.resin.io/reference/base-images/resin-base-images/#resin-xbuild-qemu).
39+
40+
In order to build these images natively on ARM devices, the `CROSS_BUILD_START` and `CROSS_BUILD_END` Docker build arguments must be set to the shell no-op (`:`), for example:
41+
```bash
42+
docker build --build-arg CROSS_BUILD_START=":" --build-arg CROSS_BUILD_END=":" -t fluent/fluentd:v1.3-onbuild-1 v1.3/armhf/alpine-onbuild
43+
```
44+
(assuming the command is run from the root of this repository).
45+
46+
### For older images
47+
48+
These images/tags are kept for backward compatibility. No update anymore and don't use for new deployment. Use "current images" instead.
49+
50+
#### `stable`, `latest`
51+
52+
These tags are obsolete, already removed to avoid confusing.
53+
Use `edge`, `vX.Y-A` or `vX.Y.Z-A.B` images instead.
54+
55+
#### `vX.Y`
56+
57+
Latest version of `vX.Y` Fluentd branch.
58+
59+
#### `vX.Y.Z`
60+
61+
Concrete `vX.Y.Z` version of Fluentd.
62+
63+
#### `onbuild` included tag
64+
65+
`onbuild` images are deprecated. Use non-`onbuild ` images instead to build your image.
66+
New images, v1.5 or later, don't provide `onbuild` version.
67+
68+
#### `debian` included tag, `armhf` included tag
69+
70+
Same as current images.

0 commit comments

Comments
 (0)