Skip to content

Commit bc64c0c

Browse files
authored
Merge pull request #2014 from fluent/lynettemiles/sc-143161/final-vale-cleanup-for-installation
2 parents 89303ad + f2331ab commit bc64c0c

19 files changed

+181
-156
lines changed

installation/aws-container.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,13 @@ Also, Fluent Bit includes an S3 output plugin named `s3`.
2222

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

25-
## Versions and Regional Repositories
25+
## Versions and regional repositories
2626

2727
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).
2828

2929
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).
3030

31-
## SSM Public Parameters
31+
## SSM public parameters
3232

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

installation/buildroot-embedded-linux.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,4 @@ Fluent Bit is started by the `S99fluent-bit` script.
2222

2323
## Support
2424

25-
All configurations with a toolchain that supports threads and dynamic library linking are supported.
25+
All configurations with a tool chain that supports threads and dynamic library linking are supported.

installation/docker.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ docker run -ti -v ./fluent-bit.yaml:/fluent-bit/etc/fluent-bit.yaml \
3838

3939
## Tags and versions
4040

41-
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:
41+
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:
4242

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

253-
### Why use Distroless containers?
253+
### Why use distroless containers?
254254

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

258258
- Include only what you need, reduce the attack surface available.

installation/getting-started-with-fluent-bit.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,31 +29,31 @@ description: A guide on how to install, deploy, and upgrade Fluent Bit
2929

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

3535
## Install on macOS (packages)
3636

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

41-
## Compile from Source (Linux, Windows, FreeBSD, macOS)
41+
## Compile from source (Linux, Windows, FreeBSD, macOS)
4242

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

49-
## Sandbox Environment
49+
## Sandbox environment
5050

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

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

57-
## Enterprise Packages
57+
## Enterprise packages
5858

5959
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.

installation/kubernetes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ The recommended way to deploy Fluent Bit for Kubernetes is with the official [He
2828

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

31-
### Installing with Helm Chart
31+
### Installing with Helm chart
3232

3333
[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).
3434

installation/linux/alma-rocky.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,21 +10,26 @@ Fluent Bit supports the following architectures:
1010

1111
## Single line install
1212

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

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

19-
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:
19+
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:
2020

2121
## RHEL 9
2222

23-
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.
23+
From CentOS 9 Stream and later, the CentOS dependencies will update more often than
24+
downstream usage. This might mean that incompatible (more recent) versions are
25+
provided of certain dependencies (for example, OpenSSL). For OSS, there are RockyLinux
26+
and AlmaLinux repositories. This might be required for RHEL 9 as well which will no
27+
longer track equivalent CentOS 9 stream dependencies. No RHEL 9 build is provided, it
28+
is expected to use one of the OSS variants listed.
2429

25-
## Configure Yum
30+
## Configure YUM
2631

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

2934
1. In `/etc/yum.repos.d/`, add a new file called `fluent-bit.repo`.
3035
1. Add the following content to the file - replace `almalinux` with `rockylinux` if required:

installation/linux/amazon-linux.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ curl https://raw.githubusercontent.com/fluent/fluent-bit/master/install.sh | sh
1919

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

22-
## Configure Yum
22+
## Configure YUM
2323

2424
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:
2525

installation/linux/debian.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,15 +52,15 @@ Refer to the [supported platform documentation](../supported-platforms.md) to se
5252
## Update your sources lists
5353

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

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

61-
Now Update your sources lists
61+
Update your source's lists:
6262

63-
```shell
63+
```bash
6464
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
6565
```
6666

installation/linux/redhat-centos.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -34,15 +34,16 @@ $ sed -i 's|#baseurl=http://mirror.centos.org|baseurl=http://vault.centos.org|g'
3434

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

37-
## RHEL/AlmaLinux/RockyLinux and CentOS 9 Stream
37+
## RHEL, AlmaLinux, RockyLinux, and CentOS 9 Stream
3838

39-
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.
39+
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
40+
provided of certain dependencies (for example, OpenSSL). For OSS, Fluent Bit also provide RockyLinux and AlmaLinux repositories.
4041

41-
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.
42+
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.
4243

43-
## Configure Yum
44+
## Configure YUM
4445

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

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

113114
## FAQ
114115

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

117118
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:
118119

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

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

141-
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.
142+
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.
142143

143-
See the guidance above.
144+
See the previous guidance.

installation/linux/ubuntu.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,8 @@ Ensure `codename` is set to your specific [Ubuntu release name](https://wiki.ubu
5151
```shell
5252
codename=$(grep -oP '(?<=VERSION_CODENAME=).*' /etc/os-release 2>/dev/null || lsb_release -cs 2>/dev/null)
5353
```
54-
Now Update your sources lists
54+
55+
Update your source's list:
5556

5657
```shell
5758
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

0 commit comments

Comments
 (0)