Skip to content

Commit

Permalink
Merge pull request #1549 from fluent/lynettemiles/sc-105724/update-in…
Browse files Browse the repository at this point in the history
…stallation-linux-redhat-centos-md

Updating Centos install page for grammar and style
  • Loading branch information
esmerel authored Jan 15, 2025
2 parents 25bb5ee + 7e08793 commit 7fcecbd
Showing 1 changed file with 61 additions and 43 deletions.
104 changes: 61 additions & 43 deletions installation/linux/redhat-centos.md
Original file line number Diff line number Diff line change
@@ -1,60 +1,68 @@
# Redhat / CentOS
# Red Hat and CentOS

## Install on Redhat / CentOS
Fluent Bit is distributed as the `fluent-bit` package and is available for the latest
stable CentOS system.

Fluent Bit is distributed as **fluent-bit** package and is available for the latest stable CentOS system.
Fluent Bit supports the following architectures:

The following architectures are supported
- `x86_64`
- `aarch64`
- `arm64v8`

* x86\_64
* aarch64 / arm64v8

For CentOS 9+ we use CentOS Stream as the canonical base system.
For CentOS 9 and later, Fluent Bit uses [CentOS Stream](https://www.centos.org/centos-stream/)
as the canonical base system.

## Single line install

A simple installation script is provided to be used for most Linux targets.
This will always install the most recent version released.
Fluent Bit provides an installation script to use for most Linux targets.
This will always install the most recently released version.

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

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

## CentOS 8

CentOS 8 is now EOL so the default Yum repositories are unavailable.
CentOS 8 is now end-of-life, so the default Yum repositories are unavailable.

Make sure to configure to use an appropriate mirror, for example:
Ensure you've configured an appropriate mirror. For example:

```shell
$ sed -i 's/mirrorlist/#mirrorlist/g' /etc/yum.repos.d/CentOS-* && \
sed -i 's|#baseurl=http://mirror.centos.org|baseurl=http://vault.centos.org|g' /etc/yum.repos.d/CentOS-*
sed -i 's/mirrorlist/#mirrorlist/g' /etc/yum.repos.d/CentOS-* && \
sed -i 's|#baseurl=http://mirror.centos.org|baseurl=http://vault.centos.org|g' /etc/yum.repos.d/CentOS-*
```

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

## Configure Yum

We provide **fluent-bit** through a Yum repository. In order to add the repository reference to your system, please add a new file called _fluent-bit.repo_ in _/etc/yum.repos.d/_ with the following content:
The `fluent-bit` is provided through a Yum repository. To add the repository
reference to your system:

```shell
[fluent-bit]
name = Fluent Bit
baseurl = https://packages.fluentbit.io/centos/$releasever/
gpgcheck=1
gpgkey=https://packages.fluentbit.io/fluentbit.key
repo_gpgcheck=1
enabled=1
```
1. In `/etc/yum.repos.d/`, add a new file called `fluent-bit.repo`.
1. Add the following content to the file:

It is best practice to always enable the _gpgcheck_ and _repo\_gpgcheck_ for security reasons. We sign our repository metadata as well as all of our packages.
```text
[fluent-bit]
name = Fluent Bit
baseurl = https://packages.fluentbit.io/centos/$releasever/
gpgcheck=1
gpgkey=https://packages.fluentbit.io/fluentbit.key
repo_gpgcheck=1
enabled=1
```

1. As a best practice, enable `gpgcheck` and `repo_gpgcheck` for security reasons.
Fluent Bit signs its repository metadata and all Fluent Bit packages.

### Updated key from March 2022

From the 1.9.0 and 1.8.15 releases please note that the GPG key has been updated at [https://packages.fluentbit.io/fluentbit.key](https://packages.fluentbit.io/fluentbit.key) so ensure this new one is added.
For the 1.9.0 and 1.8.15 and later releases, the
[GPG key has been updated](https://packages.fluentbit.io/fluentbit.key). Ensure
this new one is added.

The GPG Key fingerprint of the new key is:

Expand All @@ -63,29 +71,31 @@ C3C0 A285 34B9 293E AF51 FABD 9F9D DC08 3888 C1CD
Fluentbit releases (Releases signing key) <[email protected]>
```

The previous key is still available at [https://packages.fluentbit.io/fluentbit-legacy.key](https://packages.fluentbit.io/fluentbit-legacy.key) and may be required to install previous versions.
The previous key is [still available](https://packages.fluentbit.io/fluentbit-legacy.key)
and might be required to install previous versions.

The GPG Key fingerprint of the old key is:

```text
F209 D876 2A60 CD49 E680 633B 4FF8 368B 6EA0 722A
```

Refer to the [supported platform documentation](../supported-platforms.md) to see which platforms are supported in each release.
Refer to the [supported platform documentation](../supported-platforms.md) to see
which platforms are supported in each release.

### Install

Once your repository is configured, run the following command to install it:
1. After your repository is configured, run the following command to install it:

```bash
sudo yum install fluent-bit
```
```bash
sudo yum install fluent-bit
```

Now the following step is to instruct _Systemd_ to enable the service:
1. Instruct `Systemd` to enable the service:

```bash
sudo systemctl start fluent-bit
```
```bash
sudo systemctl start fluent-bit
```

If you do a status check, you should see a similar output like this:

Expand All @@ -100,13 +110,17 @@ $ systemctl status fluent-bit
...
```

The default configuration of **fluent-bit** is collecting metrics of CPU usage and sending the records to the standard output, you can see the outgoing data in your _/var/log/messages_ file.
The default Fluent Bit configuration collect metrics of CPU usage and sends the
records to the standard output. You can see the outgoing data in your
`/var/log/messages` file.

## FAQ

### 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:
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:

```text
[fluent-bit]
Expand All @@ -115,9 +129,13 @@ baseurl = https://packages.fluentbit.io/centos/$releasever/$basearch/
...
```

Depending on your Red Hat distribution version, this variable may return a value other than the OS major release version (e.g., RHEL7 Server distributions return "7Server" instead of just "7"). The Fluent-Bit package url uses just the major OS release version, so any other value here will cause a 404.
Depending on your Red Hat distribution version, this variable can return a value
other than the OS major release version (for example, RHEL7 Server distributions return
`7Server` instead of `7`). The Fluent Bit package URL uses the major OS
release version, so any other value here will cause a 404.

In order to resolve this issue, you can replace the $releasever variable with your system's OS major release version. For example:
To resolve this issue, replace the `$releasever` variable with your system's OS major
release version. For example:

```text
[fluent-bit]
Expand Down

0 comments on commit 7fcecbd

Please sign in to comment.