Skip to content

Commit a9072ff

Browse files
authored
Versions.MD file (#985)
* Add software versions and label details
1 parent 56d948a commit a9072ff

File tree

2 files changed

+91
-0
lines changed

2 files changed

+91
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@ Welcome to AWS for Fluent Bit! Before using this Docker Image, please read this
3737

3838
### Consuming AWS for Fluent Bit versions
3939

40+
> Current Version/tag information can be found in [VERSIONS.md](VERSIONS.md)
41+
4042
> 🔥⚠️**WARNING**⚠️🔥: Please read and understand the following information on how to consume AWS for Fluent Bit. Failure to do so may cause outages to your production environment. 😭💔
4143
4244
#### AWS Distro for Fluent Bit Release Tags

VERSIONS.md

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
# AWS for Fluent Bit Versions
2+
3+
We follow [Semantic Versioning](https://semver.org/), for our images using:
4+
- MAJOR version when you make incompatible API changes
5+
- MINOR version when you add functionality in a backward compatible manner
6+
- PATCH version when you make backwards compatible bug fixes, or add backwards-compatible functionality which does not currently have a stable API or behavior
7+
- BUILD version when you import backwards-compatible updates and/or CVE fixes from dependency packages (e.g. AL2), but do not modify aws-for-fluent-bit code or behavior
8+
9+
## Fluent Bit Versions
10+
11+
The version of the AWS for Fluent Bit image is not linked to the version of Fluent Bit which it contains.
12+
13+
Example: https://github.com/aws/aws-for-fluent-bit/releases/tag/v2.33.2
14+
15+
> Fluent Bit [1.9.10](https://github.com/fluent/fluent-bit/tree/v1.9.10)
16+
17+
## Software Versions
18+
19+
For images built after version `2.33.2`, we have added docker labels to help identify what software versions are in the container image for:
20+
- AWS for Fluent Bit - `version` and `org.opencontainers.image.version` labels
21+
- AmazonLinux - `com.aws-for-fluent-bit.os.version` label
22+
- fluent-bit - `com.aws-for-fluent-bit.fluent-bit.version` label
23+
24+
To observe these labels it is necessary to:
25+
1. Pull the image locally - `docker pull public.ecr.aws/aws-observability/aws-for-fluent-bit:latest`
26+
2. Inspect the image
27+
- (Linux) `docker inspect public.ecr.aws/aws-observability/aws-for-fluent-bit:latest --format='{{json .Config.Labels}}' | jq -C '.'`
28+
- (Windows) `docker inspect public.ecr.aws/aws-observability/aws-for-fluent-bit:latest --format='{{json .Config.Labels}}' | ConvertFrom-Json | ConvertTo-Json -Depth 10 | Out-Host
29+
`
30+
3. Validate the labels
31+
32+
Example Labels
33+
```
34+
{
35+
"author": "FireLens Team <[email protected]>",
36+
"com.aws-for-fluent-bit.fluent-bit.version": "1.9.10",
37+
"com.aws-for-fluent-bit.os.version": "Amazon Linux 2",
38+
"org.opencontainers.image.authors": "FireLens Team <[email protected]>",
39+
"org.opencontainers.image.description": "Fluent Bit is an open source and multi-platform Log Processor and Forwarder which allows you to collect data/logs from different sources, unify and send them to multiple destinations. It's fully compatible with Docker and Kubernetes environments.",
40+
"org.opencontainers.image.documentation": "https://github.com/aws/aws-for-fluent-bit",
41+
"org.opencontainers.image.licenses": "Apache-2.0",
42+
"org.opencontainers.image.source": "https://github.com/aws/aws-for-fluent-bit",
43+
"org.opencontainers.image.title": "AWS for Fluent Bit",
44+
"org.opencontainers.image.url": "https://gallery.ecr.aws/aws-observability/aws-for-fluent-bit",
45+
"org.opencontainers.image.vendor": "Amazon Web Services",
46+
"org.opencontainers.image.version": "2.33.3",
47+
"vendor": "Amazon Web Services",
48+
"version": "2.33.3"
49+
}
50+
```
51+
52+
## Version 3.0.0
53+
54+
With the upcoming release of AWS for Fluent Bit 3.0.0 we expect to introduce the following changes:
55+
1. Migration from AL2 to AL2023
56+
- We are aware of the upcoming End of Life, EOL for AL2 on 2026-06-30[^1]
57+
- We want to take advantage of bare-bones AL2023 container images to reduce CVE risk we observed AL2 based AWS for Fluent Bit images
58+
2. Migration from fluent-bit 1.9.10 to 4.x
59+
- We are aware of many changes our customers have been asking for from newer versions[^2]
60+
- We do not want to continue managing backports to 1.9.10 via [upstream-to-fluent-bit](https://github.com/amazon-contributing/upstream-to-fluent-bit)
61+
62+
## Sample Versions
63+
64+
Below is a table providing a small set of versions with the bump type and reason.
65+
66+
| Version | Release Notes | Bump | Reason |
67+
|---------|---------------|------|--------|
68+
| 2.32.5.20250626 | [v2.32.5.20250626](https://github.com/aws/aws-for-fluent-bit/releases/tag/v2.32.5.20250626) | BUILD | Amazon Linux base container image version: 2.0.20250623.0 |
69+
| 2.33.0 | [v2.33.0](https://github.com/aws/aws-for-fluent-bit/releases/tag/v2.33.0) | MINOR | Feature: Add support for non-root user mode to the init image |
70+
| 2.33.0.20250731 | [v2.33.0.20250731](https://github.com/aws/aws-for-fluent-bit/releases/tag/v2.33.0.20250731) | BUILD | Amazon Linux base container image version: 2.0.20250728.1 |
71+
| 2.33.1 | [v2.33.1](https://github.com/aws/aws-for-fluent-bit/releases/tag/v2.33.1) | PATCH | Enhancement - Rework AL2 dockerfiles, Fix - Disable buildkit features |
72+
| 3.0.0 | [v3.0.0](https://github.com/aws/aws-for-fluent-bit/releases) | MAJOR | Feature: AL2023 support, fluent-bit 4.x support
73+
74+
## Tags
75+
76+
* `latest`: The most recent version
77+
* `Version number tag`: Each release has a version number, for example `2.33.0.20250731`, `2.33.1`
78+
* `stable`: The most recent version that we have high confidence is stable for AWS use cases
79+
80+
### Additional Tags
81+
82+
* `debug-latest`: `latest` image with debug tooling[^3]
83+
* `init-latest`: `latest` image using init process[^4]
84+
* `init-debug-latest`: `init-latest` image with debug tooling[^3]
85+
86+
[^1]: https://aws.amazon.com/amazon-linux-2/faqs/
87+
[^2]: https://www.cncf.io/blog/2025/04/25/fluent-bit-v4-0-celebrating-new-features-and-10th-anniversary/
88+
[^3]: debug build, valgrind, core file uploading
89+
[^4]: [init-process-for-fluent-bit](use_cases/init-process-for-fluent-bit/README.md)

0 commit comments

Comments
 (0)