From a9b5f53ed75c885d2f633d460bf4b3c14840cf36 Mon Sep 17 00:00:00 2001 From: Lynette Miles Date: Tue, 14 Jan 2025 11:39:24 -0800 Subject: [PATCH 1/3] Updating Centos install page for grammar and style Signed-off-by: Lynette Miles --- installation/linux/redhat-centos.md | 104 ++++++++++++++++------------ 1 file changed, 61 insertions(+), 43 deletions(-) diff --git a/installation/linux/redhat-centos.md b/installation/linux/redhat-centos.md index 277a26f8a..5f225622a 100644 --- a/installation/linux/redhat-centos.md +++ b/installation/linux/redhat-centos.md @@ -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: @@ -63,7 +71,8 @@ C3C0 A285 34B9 293E AF51 FABD 9F9D DC08 3888 C1CD Fluentbit releases (Releases signing key) ``` -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: @@ -71,21 +80,22 @@ The GPG Key fingerprint of the old key is: 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. Once 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: @@ -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] @@ -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] From d5a65a8be81233135e96caf631ce47d80f42cb8a Mon Sep 17 00:00:00 2001 From: esmerel <6818907+esmerel@users.noreply.github.com> Date: Wed, 15 Jan 2025 08:22:47 -0800 Subject: [PATCH 2/3] Apply suggestions from code review Co-authored-by: Craig Norris <112565517+cnorris-cs@users.noreply.github.com> Signed-off-by: esmerel <6818907+esmerel@users.noreply.github.com> --- installation/linux/redhat-centos.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/installation/linux/redhat-centos.md b/installation/linux/redhat-centos.md index 5f225622a..92099e3ca 100644 --- a/installation/linux/redhat-centos.md +++ b/installation/linux/redhat-centos.md @@ -85,7 +85,7 @@ which platforms are supported in each release. ### Install -1. 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 @@ -131,7 +131,7 @@ baseurl = https://packages.fluentbit.io/centos/$releasever/$basearch/ 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 +`7Server` instead of `7`). The Fluent Bit package URL uses the major OS release version, so any other value here will cause a 404. To resolve this issue, replace the `$releasever` variable with your system's OS major From 7e08793a270c3d842a4b13eac2b465593c673062 Mon Sep 17 00:00:00 2001 From: esmerel <6818907+esmerel@users.noreply.github.com> Date: Wed, 15 Jan 2025 08:23:05 -0800 Subject: [PATCH 3/3] Update installation/linux/redhat-centos.md Co-authored-by: Craig Norris <112565517+cnorris-cs@users.noreply.github.com> Signed-off-by: esmerel <6818907+esmerel@users.noreply.github.com> --- installation/linux/redhat-centos.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/installation/linux/redhat-centos.md b/installation/linux/redhat-centos.md index 92099e3ca..c4c5fc5b6 100644 --- a/installation/linux/redhat-centos.md +++ b/installation/linux/redhat-centos.md @@ -118,7 +118,7 @@ records to the standard output. You can see the outgoing data in your ### 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 +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: