Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions installation/aws-container.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,13 @@ Also, Fluent Bit includes an S3 output plugin named `s3`.

- [Amazon S3](https://docs.fluentbit.io/manual/pipeline/outputs/s3)

## Versions and Regional Repositories
## Versions and regional repositories

AWS vends their container image using [Docker Hub](https://hub.docker.com/r/amazon/aws-for-fluent-bit), and a set of highly available regional Amazon ECR repositories. For more information, see the [AWS for Fluent Bit GitHub repository](https://github.com/aws/aws-for-fluent-bit#public-images).

The AWS for Fluent Bit image uses a custom versioning scheme because it contains multiple projects. To see what each release contains, see the [release notes on GitHub](https://github.com/aws/aws-for-fluent-bit/releases).

## SSM Public Parameters
## SSM public parameters

AWS vends SSM public parameters with the regional repository link for each image. These parameters can be queried by any AWS account.

Expand Down
2 changes: 1 addition & 1 deletion installation/buildroot-embedded-linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ Fluent Bit is started by the `S99fluent-bit` script.

## Support

All configurations with a toolchain that supports threads and dynamic library linking are supported.
All configurations with a tool chain that supports threads and dynamic library linking are supported.
6 changes: 3 additions & 3 deletions installation/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ docker run -ti -v ./fluent-bit.yaml:/fluent-bit/etc/fluent-bit.yaml \

## Tags and versions

The following table describes the Linux container tags that are available on Docker Hub [fluent/fluent-bit](https://hub.docker.com/r/fluent/fluent-bit/) repository:
The following table describes the Linux container tags that are available on Docker Hub [`fluent/fluent-bit`](https://hub.docker.com/r/fluent/fluent-bit/) repository:

| Tags | Manifest Architectures | Description |
| ------------ | ------------------------- | -------------------------------------------------------------- |
Expand Down Expand Up @@ -250,9 +250,9 @@ Alpine Linux uses Musl C library instead of Glibc. Musl isn't fully compatible w
- Alpine Linux Musl Time format parser doesn't support Glibc extensions.
- The Fluent Bit maintainers' preference for base images are Distroless and Debian for security and maintenance reasons.

### Why use Distroless containers?
### Why use distroless containers?

The reasons for using Distroless are well covered in
The reasons for using distroless are well covered in
[Why should I use Distroless images?](https://github.com/GoogleContainerTools/distroless#why-should-i-use-distroless-images).

- Include only what you need, reduce the attack surface available.
Expand Down
12 changes: 6 additions & 6 deletions installation/getting-started-with-fluent-bit.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,31 +29,31 @@ description: A guide on how to install, deploy, and upgrade Fluent Bit

| Operating System | Installation instructions |
| ------------------- | ------------------------- |
| Windows Server 2019 | [Windows Server EXE](windows.md#installing-from-exe-installer), [Windows Server ZIP](windows.md#installing-from-zip-archive) |
| Windows 10 2019.03 | [Windows EXE](windows.md#installing-from-exe-installer), [Windows ZIP](windows.md#installing-from-zip-archive) |
| Windows Server 2019 | [Windows Server `EXE`](windows.md#installing-from-exe-installer), [Windows Server ZIP](windows.md#installing-from-zip-archive) |
| Windows 10 2019.03 | [Windows `EXE`](windows.md#installing-from-exe-installer), [Windows ZIP](windows.md#installing-from-zip-archive) |

## Install on macOS (packages)

| Operating System | Installation instructions |
| ------------------- | --------------------------------------------- |
| macOS | [Homebrew](macos.md#installing-from-homebrew) |

## Compile from Source (Linux, Windows, FreeBSD, macOS)
## Compile from source (Linux, Windows, FreeBSD, macOS)

| Operating system | Installation instructions |
| ---------------- | ----------------------------------------------------------- |
| Linux, FreeBSD | [Compile from source](sources/build-and-install.md) |
| macOS | [Compile from source](macos.md#compile-from-source) |
| Windows | [Compile from Source](windows.md#compile-from-source) |

## Sandbox Environment
## Sandbox environment

If you are interested in learning about Fluent Bit you can try out the sandbox environment:

{% embed url="https://play.instruqt.com/embed/Fluent/tracks/fluent-bit-getting-started-101?token=em_S2zOzhhDQepM0vDS" %}
Fluent Bit Sandbox Environment
Fluent Bit sandbox environment
{% endembed %}

## Enterprise Packages
## Enterprise packages

Fluent Bit packages are also provided by [enterprise providers](https://fluentbit.io/enterprise) for older end of life versions, Unix systems, and additional support and features including aspects like CVE backporting.
2 changes: 1 addition & 1 deletion installation/kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The recommended way to deploy Fluent Bit for Kubernetes is with the official [He

If you are using Red Hat OpenShift you must set up Security Context Constraints (SCC) using the relevant option in the helm chart.

### Installing with Helm Chart
### Installing with Helm chart

[Helm](https://helm.sh) is a package manager for Kubernetes and lets you deploy application packages into your running cluster. Fluent Bit is distributed using a Helm chart found in the [Fluent Helm Charts repository](https://github.com/fluent/helm-charts).

Expand Down
15 changes: 10 additions & 5 deletions installation/linux/alma-rocky.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,21 +10,26 @@ Fluent Bit supports the following architectures:

## Single line install

Fluent Bit provides an installation script to use for most Linux targets.This will always install the most recently released version.
Fluent Bit provides an installation script to use for most Linux targets. This will always install the most recently released version.

```shell
curl https://raw.githubusercontent.com/fluent/fluent-bit/master/install.sh | sh
```

This is a convenience helper and should always be validated prior to use. Older versions of this install script will not support auto-detecting Rocky or Alma Linux. The recommended secure deployment approach is to use the following instructions:
This is a convenience helper and should always be validated prior to use. Older versions of this install script won't support auto-detecting Rocky or Alma Linux. The recommended secure deployment approach is to use the following instructions:

## RHEL 9

From CentOS 9 Stream onwards, the CentOS dependencies will update more often than downstream usage. This may mean that incompatible (more recent) versions are provided of certain dependencies (e.g. OpenSSL). For OSS, we also provide RockyLinux and AlmaLinux repositories. This may be required for RHEL 9 as well which will no longer track equivalent CentOS 9 stream dependencies. No RHEL 9 build is provided, it is expected to use one of the OSS variants listed.
From CentOS 9 Stream and later, the CentOS dependencies will update more often than
downstream usage. This might mean that incompatible (more recent) versions are
provided of certain dependencies (for example, OpenSSL). For OSS, there are RockyLinux
and AlmaLinux repositories. This might be required for RHEL 9 as well which will no
longer track equivalent CentOS 9 stream dependencies. No RHEL 9 build is provided, it
is expected to use one of the OSS variants listed.

## Configure Yum
## Configure YUM

The `fluent-bit` is provided through a Yum repository. To add the repository reference to your system:
The `fluent-bit` package is provided through a Yum repository. To add the repository reference to your system:

1. In `/etc/yum.repos.d/`, add a new file called `fluent-bit.repo`.
1. Add the following content to the file - replace `almalinux` with `rockylinux` if required:
Expand Down
2 changes: 1 addition & 1 deletion installation/linux/amazon-linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ curl https://raw.githubusercontent.com/fluent/fluent-bit/master/install.sh | sh

This is a convenience helper and should always be validated prior to use. The recommended secure deployment approach is to use the following instructions:

## Configure Yum
## Configure YUM

The `fluent-bit` is provided through a Yum repository. To add the repository reference to your system, add a new file called `fluent-bit.repo` in `/etc/yum.repos.d/` with the following content:

Expand Down
6 changes: 3 additions & 3 deletions installation/linux/debian.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,15 +52,15 @@ Refer to the [supported platform documentation](../supported-platforms.md) to se
## Update your sources lists

For Debian, you must add the Fluent Bit APT server entry to your sources lists.
Ensure codename is set to your specific [Debian release name](https://wiki.debian.org/DebianReleases#Production\_Releases). (for example: `bookworm` for Debian 12)
Ensure codename is set to your specific [Debian release name](https://wiki.debian.org/DebianReleases#Production_Releases). (for example: `bookworm` for Debian 12).

```shell
codename=$(grep -oP '(?<=VERSION_CODENAME=).*' /etc/os-release 2>/dev/null || lsb_release -cs 2>/dev/null)
```

Now Update your sources lists
Update your source's lists:

```shell
```bash
echo "deb [signed-by=/usr/share/keyrings/fluentbit-keyring.gpg] https://packages.fluentbit.io/ubuntu/$codename $codename main" | sudo tee /etc/apt/sources.list.d/fluent-bit.list
```

Expand Down
17 changes: 9 additions & 8 deletions installation/linux/redhat-centos.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,16 @@ $ sed -i 's|#baseurl=http://mirror.centos.org|baseurl=http://vault.centos.org|g'

An alternative is to use Rocky or Alma Linux, which should be equivalent.

## RHEL/AlmaLinux/RockyLinux and CentOS 9 Stream
## RHEL, AlmaLinux, RockyLinux, and CentOS 9 Stream

From CentOS 9 Stream onwards, the CentOS dependencies will update more often than downstream usage. This may mean that incompatible (more recent) versions are provided of certain dependencies (e.g. OpenSSL). For OSS, we also provide RockyLinux and AlmaLinux repositories.
From CentOS 9 Stream and later, the CentOS dependencies will update more often than downstream usage. This might mean that incompatible (more recent) versions are
provided of certain dependencies (for example, OpenSSL). For OSS, Fluent Bit also provide RockyLinux and AlmaLinux repositories.

Replace the `centos` string in Yum configuration below with `almalinux` or `rockylinux` to use those repositories instead. This may be required for RHEL 9 as well which will no longer track equivalent CentOS 9 stream dependencies. No RHEL 9 build is provided, it is expected to use one of the OSS variants listed.
Replace the `centos` string in Yum configuration with `almalinux` or `rockylinux` to use those repositories instead. This might be required for RHEL 9 as well which will no longer track equivalent CentOS 9 stream dependencies. No RHEL 9 build is provided, as it's expected you're using one of the OSS variants listed.

## Configure Yum
## Configure YUM

The `fluent-bit` is provided through a Yum repository. To add the repository reference to your system:
The`fluent-bit` package is provided through a Yum repository. To add the repository reference to your system:

1. In `/etc/yum.repos.d/`, add a new file called `fluent-bit.repo`.
1. Add the following content to the file:
Expand Down Expand Up @@ -112,7 +113,7 @@ The default Fluent Bit configuration collect metrics of CPU usage and sends the

## FAQ

### Yum install fails with a "404 - Page not found" error for the package mirror
### Yum install fails with a `404 - Page not found` error for the package mirror

The `fluent-bit.repo` file for the latest installations of Fluent Bit uses a `$releasever` variable to determine the correct version of the package to install to your system:

Expand All @@ -138,6 +139,6 @@ To resolve this issue, replace the `$releasever` variable with your system's OS

### Yum install fails with incompatible dependencies using CentOS 9+

CentOS 9 onwards will no longer be compatible with RHEL 9 as it may track more recent dependencies. Alternative AlmaLinux and RockyLinux repositories are available.
CentOS 9 and later will no longer be compatible with RHEL 9 as it might track more recent dependencies. Alternative AlmaLinux and RockyLinux repositories are available.

See the guidance above.
See the previous guidance.
3 changes: 2 additions & 1 deletion installation/linux/ubuntu.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,8 @@ Ensure `codename` is set to your specific [Ubuntu release name](https://wiki.ubu
```shell
codename=$(grep -oP '(?<=VERSION_CODENAME=).*' /etc/os-release 2>/dev/null || lsb_release -cs 2>/dev/null)
```
Now Update your sources lists

Update your source's list:

```shell
echo "deb [signed-by=/usr/share/keyrings/fluentbit-keyring.gpg] https://packages.fluentbit.io/ubuntu/$codename $codename main" | sudo tee /etc/apt/sources.list.d/fluent-bit.list
Expand Down
2 changes: 1 addition & 1 deletion installation/macos.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Fluent Bit is compatible with the latest Apple macOS software for x86_64 and App

## Installation packages

Installation packages can be found [here](https://packages.fluentbit.io/macos/).
Installation packages can be found [in the Fluent Bit repository](https://packages.fluentbit.io/macos/).

## Requirements

Expand Down
Loading