Skip to content

Commit 7fcecbd

Browse files
authored
Merge pull request #1549 from fluent/lynettemiles/sc-105724/update-installation-linux-redhat-centos-md
Updating Centos install page for grammar and style
2 parents 25bb5ee + 7e08793 commit 7fcecbd

File tree

1 file changed

+61
-43
lines changed

1 file changed

+61
-43
lines changed

installation/linux/redhat-centos.md

Lines changed: 61 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,68 @@
1-
# Redhat / CentOS
1+
# Red Hat and CentOS
22

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

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

7-
The following architectures are supported
8+
- `x86_64`
9+
- `aarch64`
10+
- `arm64v8`
811

9-
* x86\_64
10-
* aarch64 / arm64v8
11-
12-
For CentOS 9+ we use CentOS Stream as the canonical base system.
12+
For CentOS 9 and later, Fluent Bit uses [CentOS Stream](https://www.centos.org/centos-stream/)
13+
as the canonical base system.
1314

1415
## Single line install
1516

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

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

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

2627
## CentOS 8
2728

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

30-
Make sure to configure to use an appropriate mirror, for example:
31+
Ensure you've configured an appropriate mirror. For example:
3132

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

37-
An alternative is to use Rocky or Alma Linux which _should_ be equivalent.
38+
An alternative is to use Rocky or Alma Linux, which should be equivalent.
3839

3940
## Configure Yum
4041

41-
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:
42+
The `fluent-bit` is provided through a Yum repository. To add the repository
43+
reference to your system:
4244

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

53-
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.
48+
```text
49+
[fluent-bit]
50+
name = Fluent Bit
51+
baseurl = https://packages.fluentbit.io/centos/$releasever/
52+
gpgcheck=1
53+
gpgkey=https://packages.fluentbit.io/fluentbit.key
54+
repo_gpgcheck=1
55+
enabled=1
56+
```
57+
58+
1. As a best practice, enable `gpgcheck` and `repo_gpgcheck` for security reasons.
59+
Fluent Bit signs its repository metadata and all Fluent Bit packages.
5460

5561
### Updated key from March 2022
5662

57-
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.
63+
For the 1.9.0 and 1.8.15 and later releases, the
64+
[GPG key has been updated](https://packages.fluentbit.io/fluentbit.key). Ensure
65+
this new one is added.
5866

5967
The GPG Key fingerprint of the new key is:
6068

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

66-
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.
74+
The previous key is [still available](https://packages.fluentbit.io/fluentbit-legacy.key)
75+
and might be required to install previous versions.
6776

6877
The GPG Key fingerprint of the old key is:
6978

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

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

7686
### Install
7787

78-
Once your repository is configured, run the following command to install it:
88+
1. After your repository is configured, run the following command to install it:
7989

80-
```bash
81-
sudo yum install fluent-bit
82-
```
90+
```bash
91+
sudo yum install fluent-bit
92+
```
8393

84-
Now the following step is to instruct _Systemd_ to enable the service:
94+
1. Instruct `Systemd` to enable the service:
8595

86-
```bash
87-
sudo systemctl start fluent-bit
88-
```
96+
```bash
97+
sudo systemctl start fluent-bit
98+
```
8999

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

@@ -100,13 +110,17 @@ $ systemctl status fluent-bit
100110
...
101111
```
102112

103-
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.
113+
The default Fluent Bit configuration collect metrics of CPU usage and sends the
114+
records to the standard output. You can see the outgoing data in your
115+
`/var/log/messages` file.
104116

105117
## FAQ
106118

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

109-
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:
121+
The `fluent-bit.repo` file for the latest installations of Fluent Bit uses a
122+
`$releasever` variable to determine the correct version of the package to install to
123+
your system:
110124

111125
```text
112126
[fluent-bit]
@@ -115,9 +129,13 @@ baseurl = https://packages.fluentbit.io/centos/$releasever/$basearch/
115129
...
116130
```
117131

118-
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.
132+
Depending on your Red Hat distribution version, this variable can return a value
133+
other than the OS major release version (for example, RHEL7 Server distributions return
134+
`7Server` instead of `7`). The Fluent Bit package URL uses the major OS
135+
release version, so any other value here will cause a 404.
119136

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

122140
```text
123141
[fluent-bit]

0 commit comments

Comments
 (0)