Skip to content

Commit 175ac3b

Browse files
agup006gitbook-bot
authored andcommitted
GitBook: [#2] Adding single line install to Linux package documentation
1 parent 2832b8c commit 175ac3b

File tree

4 files changed

+75
-24
lines changed

4 files changed

+75
-24
lines changed

installation/linux/amazon-linux.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,21 @@ Fluent Bit is distributed as **fluent-bit** package and is available for the lat
77
* x86\_64
88
* aarch64 / arm64v8
99

10+
## Single line install
11+
12+
A simple installation script is provided to be used for most Linux targets. This will always install the most recent version released.
13+
14+
```bash
15+
curl https://raw.githubusercontent.com/fluent/fluent-bit/master/install.sh | sh
16+
```
17+
18+
If this fails or for more details on the installation then please refer to the specific sections below.
19+
1020
## Configure Yum
1121

1222
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:
1323

14-
```text
24+
```
1525
[fluent-bit]
1626
name = Fluent Bit
1727
baseurl = https://packages.fluentbit.io/amazonlinux/2/$basearch/
@@ -27,6 +37,7 @@ note: we encourage you always enable the _gpgcheck_ for security reasons. All ou
2737
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.
2838

2939
The GPG Key fingerprint of the new key is:
40+
3041
```
3142
C3C0 A285 34B9 293E AF51 FABD 9F9D DC08 3888 C1CD
3243
Fluentbit releases (Releases signing key) <[email protected]>
@@ -35,10 +46,13 @@ Fluentbit releases (Releases signing key) <[email protected]>
3546
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.
3647

3748
The GPG Key fingerprint of the old key is:
49+
3850
```
3951
F209 D876 2A60 CD49 E680 633B 4FF8 368B 6EA0 722A
4052
```
41-
Refer to the [supported platform documentation](./../supported-platforms.md) to see which platforms are supported in each release.
53+
54+
Refer to the [supported platform documentation](../supported-platforms.md) to see which platforms are supported in each release.
55+
4256
### Install
4357

4458
Once your repository is configured, run the following command to install it:
@@ -68,4 +82,3 @@ Redirecting to /bin/systemctl status fluent-bit.service
6882
```
6983

7084
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.
71-

installation/linux/debian.md

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,20 @@
11
# Debian
22

3-
Fluent Bit is distributed as **fluent-bit** package and is available for the latest \(and old\) stable Debian systems: Buster, Stretch and Jessie.
3+
Fluent Bit is distributed as **fluent-bit** package and is available for the latest (and old) stable Debian systems: Buster, Stretch and Jessie.
4+
5+
## Single line install
6+
7+
A simple installation script is provided to be used for most Linux targets. This will always install the most recent version released.
8+
9+
```bash
10+
curl https://raw.githubusercontent.com/fluent/fluent-bit/master/install.sh | sh
11+
```
12+
13+
If this fails or for more details on the installation then please refer to the specific sections below.
414

515
## Server GPG key
616

7-
The first step is to add our server GPG key to your keyring, on that way you can get our signed packages.
8-
Follow the official Debian wiki guidance: https://wiki.debian.org/DebianRepository/UseThirdParty#OpenPGP_Key_distribution
17+
The first step is to add our server GPG key to your keyring, on that way you can get our signed packages. Follow the official Debian wiki guidance: https://wiki.debian.org/DebianRepository/UseThirdParty#OpenPGP\_Key\_distribution
918

1019
```bash
1120
curl https://packages.fluentbit.io/fluentbit.key | gpg --dearmor > /usr/share/keyrings/fluentbit-keyring.gpg
@@ -16,6 +25,7 @@ curl https://packages.fluentbit.io/fluentbit.key | gpg --dearmor > /usr/share/ke
1625
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.
1726

1827
The GPG Key fingerprint of the new key is:
28+
1929
```
2030
C3C0 A285 34B9 293E AF51 FABD 9F9D DC08 3888 C1CD
2131
Fluentbit releases (Releases signing key) <[email protected]>
@@ -24,13 +34,16 @@ Fluentbit releases (Releases signing key) <[email protected]>
2434
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.
2535

2636
The GPG Key fingerprint of the old key is:
37+
2738
```
2839
F209 D876 2A60 CD49 E680 633B 4FF8 368B 6EA0 722A
2940
```
30-
Refer to the [supported platform documentation](./../supported-platforms.md) to see which platforms are supported in each release.
41+
42+
Refer to the [supported platform documentation](../supported-platforms.md) to see which platforms are supported in each release.
43+
3144
## Update your sources lists
3245

33-
On Debian, you need to add our APT server entry to your sources lists, please add the following content at bottom of your **/etc/apt/sources.list** file - ensure to set `CODENAME` to your specific [Debian release name](https://wiki.debian.org/DebianReleases#Production_Releases) (e.g. `bullseye` for Debian 11):
46+
On Debian, you need to add our APT server entry to your sources lists, please add the following content at bottom of your **/etc/apt/sources.list** file - ensure to set `CODENAME` to your specific [Debian release name](https://wiki.debian.org/DebianReleases#Production\_Releases) (e.g. `bullseye` for Debian 11):
3447

3548
```bash
3649
deb [signed-by=/usr/share/keyrings/fluentbit-keyring.gpg] https://packages.fluentbit.io/debian/${CODENAME} ${CODENAME} main
@@ -45,14 +58,14 @@ $ sudo apt-get update
4558
```
4659

4760
{% hint style="info" %}
48-
We recommend upgrading your system (```sudo apt-get upgrade```). This could avoid potential issues with expired certificates.
61+
We recommend upgrading your system (`sudo apt-get upgrade`). This could avoid potential issues with expired certificates.
4962
{% endhint %}
5063

5164
## Install Fluent Bit
5265

5366
Using the following _apt-get_ command you are able now to install the latest _fluent-bit_:
5467

55-
```text
68+
```
5669
$ sudo apt-get install fluent-bit
5770
```
5871

@@ -79,4 +92,3 @@ sudo service fluent-bit status
7992
```
8093

8194
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/syslog_ file.
82-

installation/linux/redhat-centos.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,22 +7,34 @@ Fluent Bit is distributed as **fluent-bit** package and is available for the lat
77
* x86\_64
88
* aarch64 / arm64v8
99

10+
## Single line install
11+
12+
A simple installation script is provided to be used for most Linux targets. This will always install the most recent version released.
13+
14+
```bash
15+
curl https://raw.githubusercontent.com/fluent/fluent-bit/master/install.sh | sh
16+
```
17+
18+
If this fails or for more details on the installation then please refer to the specific sections below.
19+
1020
## CentOS 8
21+
1122
CentOS 8 is now EOL so the default Yum repositories are unavailable.
1223

1324
Make sure to configure to use an appropriate mirror, for example:
25+
1426
```
1527
$ sed -i 's/mirrorlist/#mirrorlist/g' /etc/yum.repos.d/CentOS-* && \
1628
sed -i 's|#baseurl=http://mirror.centos.org|baseurl=http://vault.centos.org|g' /etc/yum.repos.d/CentOS-*
1729
```
1830

19-
An alternative is to use Rocky or Alma Linux which *should* be equivalent.
31+
An alternative is to use Rocky or Alma Linux which _should_ be equivalent.
2032

2133
## Configure Yum
2234

2335
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:
2436

25-
```text
37+
```
2638
[fluent-bit]
2739
name = Fluent Bit
2840
baseurl = https://packages.fluentbit.io/centos/7/$basearch/
@@ -32,14 +44,14 @@ repo_gpgcheck=1
3244
enabled=1
3345
```
3446

35-
It is best practice to always enable the _gpgcheck_ and _repo_gpgcheck_ for security reasons.
36-
We sign our repository metadata as well as all of our packages.
47+
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.
3748

3849
### Updated key from March 2022
3950

4051
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.
4152

4253
The GPG Key fingerprint of the new key is:
54+
4355
```
4456
C3C0 A285 34B9 293E AF51 FABD 9F9D DC08 3888 C1CD
4557
Fluentbit releases (Releases signing key) <[email protected]>
@@ -48,10 +60,13 @@ Fluentbit releases (Releases signing key) <[email protected]>
4860
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.
4961

5062
The GPG Key fingerprint of the old key is:
63+
5164
```
5265
F209 D876 2A60 CD49 E680 633B 4FF8 368B 6EA0 722A
5366
```
54-
Refer to the [supported platform documentation](./../supported-platforms.md) to see which platforms are supported in each release.
67+
68+
Refer to the [supported platform documentation](../supported-platforms.md) to see which platforms are supported in each release.
69+
5570
### Install
5671

5772
Once your repository is configured, run the following command to install it:
@@ -81,4 +96,3 @@ Redirecting to /bin/systemctl status fluent-bit.service
8196
```
8297

8398
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.
84-

installation/linux/ubuntu.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,30 @@
22

33
Fluent Bit is distributed as **fluent-bit** package and is available for the latest stable Ubuntu system: Focal Fossa.
44

5+
## Single line install
6+
7+
A simple installation script is provided to be used for most Linux targets. This will always install the most recent version released.
8+
9+
```bash
10+
curl https://raw.githubusercontent.com/fluent/fluent-bit/master/install.sh | sh
11+
```
12+
13+
If this fails or for more details on the installation then please refer to the specific sections below.
14+
515
## Server GPG key
616

7-
The first step is to add our server GPG key to your keyring to ensure you can get our signed packages.
8-
Follow the official Debian wiki guidance: https://wiki.debian.org/DebianRepository/UseThirdParty#OpenPGP_Key_distribution
17+
The first step is to add our server GPG key to your keyring to ensure you can get our signed packages. Follow the official Debian wiki guidance: https://wiki.debian.org/DebianRepository/UseThirdParty#OpenPGP\_Key\_distribution
918

1019
```bash
1120
curl https://packages.fluentbit.io/fluentbit.key | gpg --dearmor > /usr/share/keyrings/fluentbit-keyring.gpg
1221
```
22+
1323
### Updated key from March 2022
1424

1525
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.
1626

1727
The GPG Key fingerprint of the new key is:
28+
1829
```
1930
C3C0 A285 34B9 293E AF51 FABD 9F9D DC08 3888 C1CD
2031
Fluentbit releases (Releases signing key) <[email protected]>
@@ -23,10 +34,13 @@ Fluentbit releases (Releases signing key) <[email protected]>
2334
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.
2435

2536
The GPG Key fingerprint of the old key is:
37+
2638
```
2739
F209 D876 2A60 CD49 E680 633B 4FF8 368B 6EA0 722A
2840
```
29-
Refer to the [supported platform documentation](./../supported-platforms.md) to see which platforms are supported in each release.
41+
42+
Refer to the [supported platform documentation](../supported-platforms.md) to see which platforms are supported in each release.
43+
3044
## Update your sources lists
3145

3246
On Ubuntu, you need to add our APT server entry to your sources lists, please add the following content at bottom of your **/etc/apt/sources.list** file - ensure to set `CODENAME` to your specific [Ubuntu release name](https://wiki.ubuntu.com/Releases) (e.g. `focal` for Ubuntu 20.04):
@@ -44,15 +58,14 @@ sudo apt-get update
4458
```
4559

4660
{% hint style="info" %}
47-
We recommend upgrading your system (```sudo apt-get upgrade```). This could avoid potential issues with expired certificates.
61+
We recommend upgrading your system (`sudo apt-get upgrade`). This could avoid potential issues with expired certificates.
4862
{% endhint %}
4963

50-
5164
## Install Fluent Bit
5265

5366
Using the following _apt-get_ command you are able now to install the latest _fluent-bit_:
5467

55-
```text
68+
```
5669
sudo apt-get install fluent-bit
5770
```
5871

@@ -79,4 +92,3 @@ sudo service fluent-bit status
7992
```
8093

8194
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/syslog_ file.
82-

0 commit comments

Comments
 (0)