From 8258a4101256955a0439c9de2e074870a70462ec Mon Sep 17 00:00:00 2001 From: Patrick Stephens Date: Wed, 2 Feb 2022 11:32:04 +0000 Subject: [PATCH 1/4] installation: update to use new one line install and other fixes Signed-off-by: Patrick Stephens --- installation/linux/README.md | 14 ++++++ installation/linux/amazon-linux.md | 28 +++++------ installation/linux/debian.md | 49 ++++++++------------ installation/linux/raspbian-raspberry-pi.md | 33 +++++++------ installation/linux/redhat-centos.md | 33 +++++++------ installation/linux/snap.md | 4 -- installation/linux/ubuntu.md | 51 ++++++++------------- 7 files changed, 102 insertions(+), 110 deletions(-) diff --git a/installation/linux/README.md b/installation/linux/README.md index 712bd3349..3c7b9ce42 100644 --- a/installation/linux/README.md +++ b/installation/linux/README.md @@ -1,2 +1,16 @@ # Linux Packages +A simple installation script is provided to be used for most Linux targets. +This will always install the most recent version released. + +```bash +curl https://raw.githubusercontent.com/fluent/fluent-bit/master/update_version.sh | sh +``` + +If this fails or for more details on the installation then please refer to the specific section for your OS. + +## Migration to Fluent Bit + +From version 1.9, `td-agent-bit` is a deprecated package and will be removed in the future. +The correct package name to use now is `fluent-bit`. +Both are currently provided to allow migration. diff --git a/installation/linux/amazon-linux.md b/installation/linux/amazon-linux.md index 3491a2ed9..0980d1d6e 100644 --- a/installation/linux/amazon-linux.md +++ b/installation/linux/amazon-linux.md @@ -2,18 +2,18 @@ ## Install on Amazon Linux 2 -Fluent Bit is distributed as **td-agent-bit** package and is available for the latest Amazon Linux 2. The following architectures are supported +Fluent Bit is distributed as **fluent-bit** package and is available for the latest Amazon Linux 2. The following architectures are supported * x86\_64 * aarch64 / arm64v8 ## Configure Yum -We provide **td-agent-bit** through a Yum repository. In order to add the repository reference to your system, please add a new file called _td-agent-bit.repo_ in _/etc/yum.repos.d/_ with the following content: +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: ```text -[td-agent-bit] -name = TD Agent Bit +[fluent-bit] +name = Fluent Bit baseurl = https://packages.fluentbit.io/amazonlinux/2/$basearch/ gpgcheck=1 gpgkey=https://packages.fluentbit.io/fluentbit.key @@ -29,28 +29,28 @@ The GPG Key fingerprint is `F209 D876 2A60 CD49 E680 633B 4FF8 368B 6EA0 722A` Once your repository is configured, run the following command to install it: ```bash -$ yum install td-agent-bit +$ yum install fluent-bit ``` Now the following step is to instruct _systemd_ to enable the service: ```bash -$ sudo service td-agent-bit start +$ sudo service fluent-bit start ``` If you do a status check, you should see a similar output like this: ```bash -$ service td-agent-bit status -Redirecting to /bin/systemctl status td-agent-bit.service -● td-agent-bit.service - TD Agent Bit - Loaded: loaded (/usr/lib/systemd/system/td-agent-bit.service; disabled; vendor preset: disabled) +$ service fluent-bit status +Redirecting to /bin/systemctl status fluent-bit.service +● fluent-bit.service - Fluent Bit + Loaded: loaded (/usr/lib/systemd/system/fluent-bit.service; disabled; vendor preset: disabled) Active: active (running) since Thu 2016-07-07 02:08:01 BST; 9s ago - Main PID: 3820 (td-agent-bit) - CGroup: /system.slice/td-agent-bit.service - └─3820 /opt/td-agent-bit/bin/td-agent-bit -c etc/td-agent-bit/td-agent-bit.conf + Main PID: 3820 (fluent-bit) + CGroup: /system.slice/fluent-bit.service + └─3820 /opt/fluent-bit/bin/fluent-bit -c etc/fluent-bit/fluent-bit.conf ... ``` -The default configuration of **td-agent-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 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. diff --git a/installation/linux/debian.md b/installation/linux/debian.md index eb6fcaf97..f70d4c845 100644 --- a/installation/linux/debian.md +++ b/installation/linux/debian.md @@ -1,32 +1,24 @@ # Debian -Fluent Bit is distributed as **td-agent-bit** package and is available for the latest \(and old\) stable Debian systems: Buster, Stretch and Jessie. +Fluent Bit is distributed as **fluent-bit** package and is available for the latest \(and old\) stable Debian systems: Buster, Stretch and Jessie. ## Server GPG key -The first step is to add our server GPG key to your keyring, on that way you can get our signed packages: +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 -```text -curl https://packages.fluentbit.io/fluentbit.key | sudo apt-key add - +```bash +curl https://packages.fluentbit.io/fluentbit.key | gpg --dearmor > /usr/share/keyrings/fluentbit-keyring.gpg ``` - ## Update your sources lists -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: +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 [Ubuntu release name](https://wiki.ubuntu.com/Releases) (e.g. `focal` for Ubuntu 20.04): -#### Debian 10 \(Buster\) - -```text -deb https://packages.fluentbit.io/debian/buster buster main -``` - -#### Debian 9 \(Stretch\) - -```text -deb https://packages.fluentbit.io/debian/stretch stretch main +```bash +deb [signed-by=/usr/share/keyrings/fluentbit-keyring.gpg] https://packages.fluentbit.io/debian/${CODENAME} ${CODENAME} main ``` -### Update your repositories database +## Update your repositories database Now let your system update the _apt_ database: @@ -38,36 +30,35 @@ $ sudo apt-get update We recommend upgrading your system (```sudo apt-get upgrade```). This could avoid potential issues with expired certificates. {% endhint %} +## Install Fluent Bit -## Install TD Agent Bit - -Using the following _apt-get_ command you are able now to install the latest _td-agent-bit_: +Using the following _apt-get_ command you are able now to install the latest _fluent-bit_: ```text -$ sudo apt-get install td-agent-bit +$ sudo apt-get install fluent-bit ``` Now the following step is to instruct _systemd_ to enable the service: ```bash -$ sudo service td-agent-bit start +$ sudo service fluent-bit start ``` If you do a status check, you should see a similar output like this: ```bash -sudo service td-agent-bit status -● td-agent-bit.service - TD Agent Bit - Loaded: loaded (/lib/systemd/system/td-agent-bit.service; disabled; vendor preset: enabled) +sudo service fluent-bit status +● fluent-bit.service - Fluent Bit + Loaded: loaded (/lib/systemd/system/fluent-bit.service; disabled; vendor preset: enabled) Active: active (running) since mié 2016-07-06 16:58:25 CST; 2h 45min ago - Main PID: 6739 (td-agent-bit) + Main PID: 6739 (fluent-bit) Tasks: 1 Memory: 656.0K CPU: 1.393s - CGroup: /system.slice/td-agent-bit.service - └─6739 /opt/td-agent-bit/bin/td-agent-bit -c /etc/td-agent-bit/td-agent-bit.conf + CGroup: /system.slice/fluent-bit.service + └─6739 /opt/fluent-bit/bin/fluent-bit -c /etc/fluent-bit/fluent-bit.conf ... ``` -The default configuration of **td-agent-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. +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. diff --git a/installation/linux/raspbian-raspberry-pi.md b/installation/linux/raspbian-raspberry-pi.md index b9397073f..5b4ed185a 100644 --- a/installation/linux/raspbian-raspberry-pi.md +++ b/installation/linux/raspbian-raspberry-pi.md @@ -1,10 +1,9 @@ # Raspbian / Raspberry Pi -Fluent Bit is distributed as **td-agent-bit** package and is available for the Raspberry, specifically for [Raspbian](http://raspbian.org) distribution, the following versions are supported: +Fluent Bit is distributed as **fluent-bit** package and is available for the Raspberry, specifically for [Raspbian](http://raspbian.org) distribution, the following versions are supported: +* Raspbian Bullseye \(11\) * Raspbian Buster \(10\) -* Raspbian Stretch \(9\) -* Raspbian Jessie \(8\) ## Server GPG key @@ -18,6 +17,12 @@ curl https://packages.fluentbit.io/fluentbit.key | sudo apt-key add - On Debian and derivative systems such as Raspbian, 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: +#### Raspbian 11 \(Bullseye\) + +```text +deb https://packages.fluentbit.io/raspbian/bullseye bullseye main +``` + #### Raspbian 10 \(Buster\) ```text @@ -37,35 +42,35 @@ We recommend upgrading your system (```sudo apt-get upgrade```). This could avoi {% endhint %} -## Install TD-Agent Bit +## Install fluent Bit -Using the following _apt-get_ command you are able now to install the latest _td-agent-bit_: +Using the following _apt-get_ command you are able now to install the latest _fluent-bit_: ```text -$ sudo apt-get install td-agent-bit +$ sudo apt-get install fluent-bit ``` Now the following step is to instruct _systemd_ to enable the service: ```bash -$ sudo service td-agent-bit start +$ sudo service fluent-bit start ``` If you do a status check, you should see a similar output like this: ```bash -sudo service td-agent-bit status -● td-agent-bit.service - TD Agent Bit - Loaded: loaded (/lib/systemd/system/td-agent-bit.service; disabled; vendor preset: enabled) +sudo service fluent-bit status +● fluent-bit.service - Fluent Bit + Loaded: loaded (/lib/systemd/system/fluent-bit.service; disabled; vendor preset: enabled) Active: active (running) since mié 2016-07-06 16:58:25 CST; 2h 45min ago - Main PID: 6739 (td-agent-bit) + Main PID: 6739 (fluent-bit) Tasks: 1 Memory: 656.0K CPU: 1.393s - CGroup: /system.slice/td-agent-bit.service - └─6739 /opt/td-agent-bit/bin/td-agent-bit -c /etc/td-agent-bit/td-agent-bit.conf + CGroup: /system.slice/fluent-bit.service + └─6739 /opt/fluent-bit/bin/fluent-bit -c /etc/fluent-bit/fluent-bit.conf ... ``` -The default configuration of **td-agent-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. +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. diff --git a/installation/linux/redhat-centos.md b/installation/linux/redhat-centos.md index 408b32096..4f4ded762 100644 --- a/installation/linux/redhat-centos.md +++ b/installation/linux/redhat-centos.md @@ -2,55 +2,54 @@ ## Install on Redhat / CentOS -Fluent Bit is distributed as **td-agent-bit** package and is available for the latest stable CentOS system. The following architectures are supported +Fluent Bit is distributed as **fluent-bit** package and is available for the latest stable CentOS system. The following architectures are supported * x86\_64 * aarch64 / arm64v8 ## Configure Yum -We provide **td-agent-bit** through a Yum repository. In order to add the repository reference to your system, please add a new file called _td-agent-bit.repo_ in _/etc/yum.repos.d/_ with the following content: +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: ```text -[td-agent-bit] -name = TD Agent Bit +[fluent-bit] +name = Fluent Bit baseurl = https://packages.fluentbit.io/centos/7/$basearch/ gpgcheck=1 gpgkey=https://packages.fluentbit.io/fluentbit.key enabled=1 ``` -note: we encourage you always enable the _gpgcheck_ for security reasons. All our packages are signed. - -The GPG Key fingerprint is `F209 D876 2A60 CD49 E680 633B 4FF8 368B 6EA0 722A` +It is best practice to always enable the _gpgcheck_ for security reasons. +All our packages are signed. ### Install Once your repository is configured, run the following command to install it: ```bash -$ yum install td-agent-bit +$ yum install fluent-bit ``` Now the following step is to instruct _Systemd_ to enable the service: ```bash -$ sudo service td-agent-bit start +$ sudo service fluent-bit start ``` If you do a status check, you should see a similar output like this: ```bash -$ service td-agent-bit status -Redirecting to /bin/systemctl status td-agent-bit.service -● td-agent-bit.service - TD Agent Bit - Loaded: loaded (/usr/lib/systemd/system/td-agent-bit.service; disabled; vendor preset: disabled) +$ service fluent-bit status +Redirecting to /bin/systemctl status fluent-bit.service +● fluent-bit.service - Fluent Bit + Loaded: loaded (/usr/lib/systemd/system/fluent-bit.service; disabled; vendor preset: disabled) Active: active (running) since Thu 2016-07-07 02:08:01 BST; 9s ago - Main PID: 3820 (td-agent-bit) - CGroup: /system.slice/td-agent-bit.service - └─3820 /opt/td-agent-bit/bin/td-agent-bit -c etc/td-agent-bit/td-agent-bit.conf + Main PID: 3820 (fluent-bit) + CGroup: /system.slice/fluent-bit.service + └─3820 /opt/fluent-bit/bin/fluent-bit -c etc/fluent-bit/fluent-bit.conf ... ``` -The default configuration of **td-agent-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 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. diff --git a/installation/linux/snap.md b/installation/linux/snap.md index 5f54a89b1..4316d83c5 100644 --- a/installation/linux/snap.md +++ b/installation/linux/snap.md @@ -2,12 +2,8 @@ If you use any Linux distribution [supported by](https://snapcraft.io/docs/installing-snapd) Snapcraft, you can get Fluent Bit as a Snap in your system. - - [![Get it from the Snap Store](https://snapcraft.io/static/images/badges/en/snap-store-white.svg)](https://snapcraft.io/fluent-bit) - - ## Getting Started Install Fluent Bit Snap in your system diff --git a/installation/linux/ubuntu.md b/installation/linux/ubuntu.md index 76fe10fb5..e4a24cae5 100644 --- a/installation/linux/ubuntu.md +++ b/installation/linux/ubuntu.md @@ -1,35 +1,22 @@ # Ubuntu -Fluent Bit is distributed as **td-agent-bit** package and is available for the latest stable Ubuntu system: Focal Fossa. +Fluent Bit is distributed as **fluent-bit** package and is available for the latest stable Ubuntu system: Focal Fossa. ## Server GPG key -The first step is to add our server GPG key to your keyring, on that way you can get our signed packages: +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 -```text -$ wget -qO - https://packages.fluentbit.io/fluentbit.key | sudo apt-key add - +```bash +curl https://packages.fluentbit.io/fluentbit.key | gpg --dearmor > /usr/share/keyrings/fluentbit-keyring.gpg ``` ## Update your sources lists -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: - -#### Ubuntu 20.04 LTS \(Focal Fossa\) - -```text -deb https://packages.fluentbit.io/ubuntu/focal focal main -``` - -#### Ubuntu 18.04 LTS \(Bionic Beaver\) +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): -```text -deb https://packages.fluentbit.io/ubuntu/bionic bionic main -``` - -#### Ubuntu 16.04 LTS \(Xenial Xerus\) - -```text -deb https://packages.fluentbit.io/ubuntu/xenial xenial main +```bash +deb [signed-by=/usr/share/keyrings/fluentbit-keyring.gpg] https://packages.fluentbit.io/debian/${CODENAME} ${CODENAME} main ``` ### Update your repositories database @@ -45,35 +32,35 @@ We recommend upgrading your system (```sudo apt-get upgrade```). This could avoi {% endhint %} -## Install TD-Agent Bit +## Install fluent Bit -Using the following _apt-get_ command you are able now to install the latest _td-agent-bit_: +Using the following _apt-get_ command you are able now to install the latest _fluent-bit_: ```text -sudo apt-get install td-agent-bit +sudo apt-get install fluent-bit ``` Now the following step is to instruct _systemd_ to enable the service: ```bash -sudo service td-agent-bit start +sudo service fluent-bit start ``` If you do a status check, you should see a similar output like this: ```bash -sudo service td-agent-bit status -● td-agent-bit.service - TD Agent Bit - Loaded: loaded (/lib/systemd/system/td-agent-bit.service; disabled; vendor preset: enabled) +sudo service fluent-bit status +● fluent-bit.service - Fluent Bit + Loaded: loaded (/lib/systemd/system/fluent-bit.service; disabled; vendor preset: enabled) Active: active (running) since mié 2016-07-06 16:58:25 CST; 2h 45min ago - Main PID: 6739 (td-agent-bit) + Main PID: 6739 (fluent-bit) Tasks: 1 Memory: 656.0K CPU: 1.393s - CGroup: /system.slice/td-agent-bit.service - └─6739 /opt/td-agent-bit/bin/td-agent-bit -c /etc/td-agent-bit/td-agent-bit.conf + CGroup: /system.slice/fluent-bit.service + └─6739 /opt/fluent-bit/bin/fluent-bit -c /etc/fluent-bit/fluent-bit.conf ... ``` -The default configuration of **td-agent-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. +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. From 8c639f40336d1424624a5799423f333ef322092a Mon Sep 17 00:00:00 2001 From: Patrick Stephens Date: Wed, 2 Feb 2022 11:34:46 +0000 Subject: [PATCH 2/4] installation: minor tweak Signed-off-by: Patrick Stephens --- installation/linux/raspbian-raspberry-pi.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/installation/linux/raspbian-raspberry-pi.md b/installation/linux/raspbian-raspberry-pi.md index 5b4ed185a..27a3a6a18 100644 --- a/installation/linux/raspbian-raspberry-pi.md +++ b/installation/linux/raspbian-raspberry-pi.md @@ -15,7 +15,7 @@ curl https://packages.fluentbit.io/fluentbit.key | sudo apt-key add - ## Update your sources lists -On Debian and derivative systems such as Raspbian, 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: +On Debian and derivative systems such as Raspbian, 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. #### Raspbian 11 \(Bullseye\) From 82ef8b3ba076efc62df49fdf5f116c9c5e699c77 Mon Sep 17 00:00:00 2001 From: Pat Date: Thu, 3 Feb 2022 20:12:20 +0000 Subject: [PATCH 3/4] Update installation/linux/raspbian-raspberry-pi.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: José Lecaros --- installation/linux/raspbian-raspberry-pi.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/installation/linux/raspbian-raspberry-pi.md b/installation/linux/raspbian-raspberry-pi.md index 27a3a6a18..f29f923e3 100644 --- a/installation/linux/raspbian-raspberry-pi.md +++ b/installation/linux/raspbian-raspberry-pi.md @@ -42,7 +42,7 @@ We recommend upgrading your system (```sudo apt-get upgrade```). This could avoi {% endhint %} -## Install fluent Bit +## Install Fluent Bit Using the following _apt-get_ command you are able now to install the latest _fluent-bit_: From 9ac87eaca2c4a3fa3a9c18ed34b47baeebd2b846 Mon Sep 17 00:00:00 2001 From: Pat Date: Thu, 3 Feb 2022 20:12:25 +0000 Subject: [PATCH 4/4] Update installation/linux/ubuntu.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: José Lecaros --- installation/linux/ubuntu.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/installation/linux/ubuntu.md b/installation/linux/ubuntu.md index e4a24cae5..315d94507 100644 --- a/installation/linux/ubuntu.md +++ b/installation/linux/ubuntu.md @@ -32,7 +32,7 @@ We recommend upgrading your system (```sudo apt-get upgrade```). This could avoi {% endhint %} -## Install fluent Bit +## Install Fluent Bit Using the following _apt-get_ command you are able now to install the latest _fluent-bit_: