diff --git a/.gitbook.yaml b/.gitbook.yaml index f763fd123..239c01b56 100644 --- a/.gitbook.yaml +++ b/.gitbook.yaml @@ -1,7 +1,9 @@ redirects: # Installation installation/upgrade_notes: ./installation/upgrade-notes.md - installation/supported_platforms: ./installation/supported-platforms.md + installation/supported_platforms: ./installation/downloads.md + installation/docker.md: ./installation/downloads/docker.md + installation/windows.md: ./installation/downloads/windows.md # Inputs input/collectd: ./pipeline/inputs/ diff --git a/SUMMARY.md b/SUMMARY.md index 412d6b773..ac8b71a45 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -19,28 +19,27 @@ ## Installation * [Get started with Fluent Bit](installation/getting-started-with-fluent-bit.md) -* [Upgrade notes](installation/upgrade-notes.md) -* [Supported platforms](installation/supported-platforms.md) * [Requirements](installation/requirements.md) -* [Sources](installation/sources/README.md) - * [Download source code](installation/sources/download-source-code.md) - * [Build and install](installation/sources/build-and-install.md) - * [Build with static configuration](installation/sources/build-with-static-configuration.md) -* [Linux packages](installation/linux.md) - * [Amazon Linux](installation/linux/amazon-linux.md) - * [Rocky Linux and Alma Linux ](installation/linux/alma-rocky.md) - * [Red Hat and CentOS](installation/linux/redhat-centos.md) - * [Debian](installation/linux/debian.md) - * [Ubuntu](installation/linux/ubuntu.md) - * [Raspbian and Raspberry Pi](installation/linux/raspbian-raspberry-pi.md) -* [Docker](installation/docker.md) -* [Containers on AWS](installation/aws-container.md) -* [Amazon EC2](installation/amazon-ec2.md) -* [Kubernetes](installation/kubernetes.md) -* [macOS](installation/macos.md) -* [Windows](installation/windows.md) -* [Yocto embedded Linux](installation/yocto-embedded-linux.md) -* [Buildroot embedded Linux](installation/buildroot-embedded-linux.md) +* [Download and install Fluent Bit](installation/downloads.md) + * [Build from source code](installation/downloads/source.md) + * [Build and install](installation/downloads/source/build-and-install.md) + * [Build with static configuration](installation/downloads/source/build-with-static-configuration.md) + * [Linux packages](installation/downloads/linux.md) + * [Amazon Linux](installation/downloads/linux/amazon-linux.md) + * [Rocky Linux and Alma Linux ](installation/downloads/linux/alma-rocky.md) + * [Red Hat and CentOS](installation/downloads/linux/redhat-centos.md) + * [Debian](installation/downloads/linux/debian.md) + * [Ubuntu](installation/downloads/linux/ubuntu.md) + * [Raspbian and Raspberry Pi](installation/downloads/linux/raspbian-raspberry-pi.md) + * [Yocto embedded Linux](installation/downloads/linux/yocto-embedded-linux.md) + * [Buildroot embedded Linux](installation/downloads/linux/buildroot-embedded-linux.md) + * [Docker](installation/downloads/docker.md) + * [Containers on AWS](installation/downloads/aws-container.md) + * [Amazon EC2](installation/downloads/amazon-ec2.md) + * [Kubernetes](installation/downloads/kubernetes.md) + * [macOS](installation/downloads/macos.md) + * [Windows](installation/downloads/windows.md) +* [Upgrade notes](installation/upgrade-notes.md) ## Administration diff --git a/installation/downloads.md b/installation/downloads.md new file mode 100644 index 000000000..da9d662d7 --- /dev/null +++ b/installation/downloads.md @@ -0,0 +1,32 @@ +# Download Fluent Bit for supported platforms + +Fluent Bit supports the following operating systems and architectures: + +| Operating System | Distribution | Architectures | +| :--- | :--- | :--- | +| Linux | [Amazon Linux 2023](downloads/linux/amazon-linux.md) | x86_64, Arm64v8 | +| | [Amazon Linux 2](downloads/linux/amazon-linux.md) | x86_64, Arm64v8 | +| | [CentOS 9 Stream](downloads/linux/redhat-centos.md) | x86_64, Arm64v8 | +| | [CentOS 8](downloads/linux/redhat-centos.md) | x86_64, Arm64v8 | +| | [CentOS 7](downloads/linux/redhat-centos.md) | x86_64, Arm64v8 | +| | [Rocky Linux 8](downloads/linux/alma-rocky.md) | x86_64, Arm64v8 | +| | [Rocky Linux 9](downloads/linux/alma-rocky.md) | x86_64, Arm64v8 | +| | [Alma Linux 8](downloads/linux/alma-rocky.md) | x86_64, Arm64v8 | +| | [Alma Linux 9](downloads/linux/alma-rocky.md) | x86_64, Arm64v8 | +| | [Debian 12 (Bookworm)](downloads/linux/debian.md) | x86_64, Arm64v8 | +| | [Debian 11 (Bullseye)](downloads/linux/debian.md) | x86_64, Arm64v8 | +| | [Debian 10 (Buster)](downloads/linux/debian.md) | x86_64, Arm64v8 | +| | [Ubuntu 24.04 (Noble Numbat)](downloads/linux/ubuntu.md) | x86_64, Arm64v8 | +| | [Ubuntu 22.04 (Jammy Jellyfish)](downloads/linux/ubuntu.md) | x86_64, Arm64v8 | +| | [Raspbian 12 (Bookworm)](downloads/linux/raspbian-raspberry-pi.md) | Arm32v7 | +| macOS | * | x86_64, Apple M1 | +| Windows | [Windows Server 2019](downloads/windows.md) | x86_64, x86 | +| | [Windows 10 1903](downloads/windows.md) | x86_64, x86 | + +From an architecture support perspective, Fluent Bit is fully functional on x86_64, Arm64v8, and Arm32v7 based processors. + +Fluent Bit can work also on macOS and Berkeley Software Distribution (BSD) systems, but not all plugins will be available on all platforms. + +Official support is based on community demand. Fluent Bit might run on older operating systems, but must be built from source, or using custom packages from [enterprise providers](https://fluentbit.io/enterprise). + +Fluent Bit is supported for Linux on IBM Z (s390x) environments with some restrictions, but only container images are provided for these targets officially. diff --git a/installation/amazon-ec2.md b/installation/downloads/amazon-ec2.md similarity index 100% rename from installation/amazon-ec2.md rename to installation/downloads/amazon-ec2.md diff --git a/installation/aws-container.md b/installation/downloads/aws-container.md similarity index 100% rename from installation/aws-container.md rename to installation/downloads/aws-container.md diff --git a/installation/docker.md b/installation/downloads/docker.md similarity index 100% rename from installation/docker.md rename to installation/downloads/docker.md diff --git a/installation/kubernetes.md b/installation/downloads/kubernetes.md similarity index 100% rename from installation/kubernetes.md rename to installation/downloads/kubernetes.md diff --git a/installation/linux.md b/installation/downloads/linux.md similarity index 93% rename from installation/linux.md rename to installation/downloads/linux.md index ffacf16d4..ab88220ea 100644 --- a/installation/linux.md +++ b/installation/downloads/linux.md @@ -1,5 +1,7 @@ # Linux packages +Fluent Bit is available for a variety of Linux distributions and embedded Linux systems. + The most secure option is to create the repositories according to the instructions for your specific OS. An installation script is provided for use with most Linux targets. This will by default install the most recent version released. diff --git a/installation/linux/alma-rocky.md b/installation/downloads/linux/alma-rocky.md similarity index 100% rename from installation/linux/alma-rocky.md rename to installation/downloads/linux/alma-rocky.md diff --git a/installation/linux/amazon-linux.md b/installation/downloads/linux/amazon-linux.md similarity index 100% rename from installation/linux/amazon-linux.md rename to installation/downloads/linux/amazon-linux.md diff --git a/installation/buildroot-embedded-linux.md b/installation/downloads/linux/buildroot-embedded-linux.md similarity index 100% rename from installation/buildroot-embedded-linux.md rename to installation/downloads/linux/buildroot-embedded-linux.md diff --git a/installation/linux/debian.md b/installation/downloads/linux/debian.md similarity index 100% rename from installation/linux/debian.md rename to installation/downloads/linux/debian.md diff --git a/installation/linux/raspbian-raspberry-pi.md b/installation/downloads/linux/raspbian-raspberry-pi.md similarity index 100% rename from installation/linux/raspbian-raspberry-pi.md rename to installation/downloads/linux/raspbian-raspberry-pi.md diff --git a/installation/linux/redhat-centos.md b/installation/downloads/linux/redhat-centos.md similarity index 100% rename from installation/linux/redhat-centos.md rename to installation/downloads/linux/redhat-centos.md diff --git a/installation/linux/ubuntu.md b/installation/downloads/linux/ubuntu.md similarity index 100% rename from installation/linux/ubuntu.md rename to installation/downloads/linux/ubuntu.md diff --git a/installation/yocto-embedded-linux.md b/installation/downloads/linux/yocto-embedded-linux.md similarity index 100% rename from installation/yocto-embedded-linux.md rename to installation/downloads/linux/yocto-embedded-linux.md diff --git a/installation/macos.md b/installation/downloads/macos.md similarity index 100% rename from installation/macos.md rename to installation/downloads/macos.md diff --git a/installation/sources/download-source-code.md b/installation/downloads/source.md similarity index 80% rename from installation/sources/download-source-code.md rename to installation/downloads/source.md index 7282caf9b..225e24bba 100644 --- a/installation/sources/download-source-code.md +++ b/installation/downloads/source.md @@ -23,4 +23,11 @@ git clone https://github.com/fluent/fluent-bit The `master` branch is where the development of Fluent Bit happens. Development version users should expect issues when compiling or at run time. -Fluent Bit users are encouraged to help test every development version to ensure a stable release. \ No newline at end of file +Fluent Bit users are encouraged to help test every development version to ensure a stable release. + +## Next step + +After downloading Fluent Bit, install it using one of the following methods: + +- [Build and install](./source/build-and-install.md) +- [Build with a static configuration](./source/build-with-static-configuration.md) diff --git a/installation/sources/build-and-install.md b/installation/downloads/source/build-and-install.md similarity index 100% rename from installation/sources/build-and-install.md rename to installation/downloads/source/build-and-install.md diff --git a/installation/sources/build-with-static-configuration.md b/installation/downloads/source/build-with-static-configuration.md similarity index 100% rename from installation/sources/build-with-static-configuration.md rename to installation/downloads/source/build-with-static-configuration.md diff --git a/installation/windows.md b/installation/downloads/windows.md similarity index 100% rename from installation/windows.md rename to installation/downloads/windows.md diff --git a/installation/getting-started-with-fluent-bit.md b/installation/getting-started-with-fluent-bit.md index 1a1ca2dc0..5f25a6a9c 100644 --- a/installation/getting-started-with-fluent-bit.md +++ b/installation/getting-started-with-fluent-bit.md @@ -17,7 +17,7 @@ All Fluent Bit installations must meet certain [requirements](./requirements.md) Fluent Bit software is available for a variety of platforms and can be installed using several methods. -You can [direct download and compile the source code](../installation/sources/README.md). +You can [direct download and compile the source code](../installation/source.md). To select a package for a container or operating system, use the instructions for that option from the following links: @@ -25,42 +25,42 @@ To select a package for a container or operating system, use the instructions fo | Deployment Type | Instructions | | ----------------- | -------------------------------------------------- | -| Kubernetes | [Deploy on Kubernetes](kubernetes.md#installation) | -| Docker | [Deploy with Docker](docker.md) | -| Containers on AWS | [Deploy on Containers on AWS](aws-container.md) | +| Kubernetes | [Deploy on Kubernetes](downloads/kubernetes.md#installation) | +| Docker | [Deploy with Docker](downloads/docker.md) | +| Containers on AWS | [Deploy on Containers on AWS](downloads/aws-container.md) | ### Install on Linux (packages) | Operating System | Installation instructions | | ---------------------- | ------------------------- | -| CentOS / Red Hat | [CentOS 7](linux/redhat-centos.md#install-on-redhat-centos), [CentOS 8](linux/redhat-centos.md#install-on-redhat-centos), [CentOS 9 Stream](linux/redhat-centos.md#install-on-redhat-centos) | -| Ubuntu | [Ubuntu 16.04 LTS](linux/ubuntu.md), [Ubuntu 18.04 LTS](linux/ubuntu.md), [Ubuntu 20.04 LTS](linux/ubuntu.md), [Ubuntu 22.04 LTS](linux/ubuntu.md), [Ubuntu 24.04 LTS](linux/ubuntu.md) | -| Debian | [Debian 10](linux/debian.md), [Debian 11](linux/debian.md), [Debian 12](linux/debian.md) | -| Amazon Linux | [Amazon Linux 2](linux/amazon-linux.md#install-on-amazon-linux-2), [Amazon Linux 2022](linux/amazon-linux.md#amazon-linux-2022) | -| Raspbian / Raspberry Pi | [Raspbian 10](linux/raspbian-raspberry-pi.md#raspbian-10-buster), [Raspbian 11](linux/raspbian-raspberry-pi.md#raspbian-11-bullseye) | -| Yocto / Embedded Linux | [Yocto / Embedded Linux](yocto-embedded-linux.md#fluent-bit-and-other-architectures) | -| Buildroot / Embedded Linux | [Buildroot / Embedded Linux](buildroot-embedded-linux.md) | +| CentOS / Red Hat | [CentOS 7](downloads/linux/redhat-centos.md#install-on-redhat-centos), [CentOS 8](downloads/linux/redhat-centos.md#install-on-redhat-centos), [CentOS 9 Stream](downloads/linux/redhat-centos.md#install-on-redhat-centos) | +| Ubuntu | [Ubuntu 16.04 LTS](downloads/linux/ubuntu.md), [Ubuntu 18.04 LTS](downloads/linux/ubuntu.md), [Ubuntu 20.04 LTS](downloads/linux/ubuntu.md), [Ubuntu 22.04 LTS](downloads/linux/ubuntu.md), [Ubuntu 24.04 LTS](downloads/linux/ubuntu.md) | +| Debian | [Debian 10](downloads/linux/debian.md), [Debian 11](downloads/linux/debian.md), [Debian 12](downloads/linux/debian.md) | +| Amazon Linux | [Amazon Linux 2](downloads/linux/amazon-linux.md#install-on-amazon-linux-2), [Amazon Linux 2022](downloads/linux/amazon-linux.md#amazon-linux-2022) | +| Raspbian / Raspberry Pi | [Raspbian 10](downloads/linux/raspbian-raspberry-pi.md#raspbian-10-buster), [Raspbian 11](downloads/linux/raspbian-raspberry-pi.md#raspbian-11-bullseye) | +| Yocto / Embedded Linux | [Yocto / Embedded Linux](downloads/linux/yocto-embedded-linux.md#fluent-bit-and-other-architectures) | +| Buildroot / Embedded Linux | [Buildroot / Embedded Linux](downloads/linux/buildroot-embedded-linux.md) | ### Install on Windows (packages) | Operating System | Installation instructions | | ------------------- | ------------------------- | -| Windows Server 2019 | [Windows Server `EXE`](windows.md#installing-from-exe-installer), [Windows Server ZIP](windows.md#installing-from-zip-archive) | -| Windows 10 2019.03 | [Windows `EXE`](windows.md#installing-from-exe-installer), [Windows ZIP](windows.md#installing-from-zip-archive) | +| Windows Server 2019 | [Windows Server `EXE`](downloads/windows.md#installing-from-exe-installer), [Windows Server ZIP](downloads/windows.md#installing-from-zip-archive) | +| Windows 10 2019.03 | [Windows `EXE`](downloads/windows.md#installing-from-exe-installer), [Windows ZIP](downloads/windows.md#installing-from-zip-archive) | ### Install on macOS (packages) | Operating System | Installation instructions | | ------------------- | --------------------------------------------- | -| macOS | [Homebrew](macos.md#installing-from-homebrew) | +| macOS | [Homebrew](downloads/macos.md#installing-from-homebrew) | ### Compile from source (Linux, Windows, FreeBSD, macOS) | Operating system | Installation instructions | | ---------------- | ----------------------------------------------------------- | -| Linux, FreeBSD | [Compile from source](sources/build-and-install.md) | -| macOS | [Compile from source](macos.md#compile-from-source) | -| Windows | [Compile from Source](windows.md#compile-from-source) | +| Linux, FreeBSD | [Compile from source](downloads/source/build-and-install.md) | +| macOS | [Compile from source](downloads/macos.md#compile-from-source) | +| Windows | [Compile from Source](downloads/windows.md#compile-from-source) | ### Enterprise packages diff --git a/installation/sources/README.md b/installation/sources/README.md deleted file mode 100644 index a76d395d0..000000000 --- a/installation/sources/README.md +++ /dev/null @@ -1,2 +0,0 @@ -# Sources - diff --git a/installation/supported-platforms.md b/installation/supported-platforms.md deleted file mode 100644 index 260759f1f..000000000 --- a/installation/supported-platforms.md +++ /dev/null @@ -1,32 +0,0 @@ -# Supported platforms - -Fluent Bit supports the following operating systems and architectures: - -| Operating System | Distribution | Architectures | -| :--- | :--- | :--- | -| Linux | [Amazon Linux 2023](linux/amazon-linux.md) | x86_64, Arm64v8 | -| | [Amazon Linux 2](linux/amazon-linux.md) | x86_64, Arm64v8 | -| | [CentOS 9 Stream](linux/redhat-centos.md) | x86_64, Arm64v8 | -| | [CentOS 8](linux/redhat-centos.md) | x86_64, Arm64v8 | -| | [CentOS 7](linux/redhat-centos.md) | x86_64, Arm64v8 | -| | [Rocky Linux 8](linux/alma-rocky.md) | x86_64, Arm64v8 | -| | [Rocky Linux 9](linux/alma-rocky.md) | x86_64, Arm64v8 | -| | [Alma Linux 8](linux/alma-rocky.md) | x86_64, Arm64v8 | -| | [Alma Linux 9](linux/alma-rocky.md) | x86_64, Arm64v8 | -| | [Debian 12 (Bookworm)](linux/debian.md) | x86_64, Arm64v8 | -| | [Debian 11 (Bullseye)](linux/debian.md) | x86_64, Arm64v8 | -| | [Debian 10 (Buster)](linux/debian.md) | x86_64, Arm64v8 | -| | [Ubuntu 24.04 (Noble Numbat)](linux/ubuntu.md) | x86_64, Arm64v8 | -| | [Ubuntu 22.04 (Jammy Jellyfish)](linux/ubuntu.md) | x86_64, Arm64v8 | -| | [Raspbian 12 (Bookworm)](linux/raspbian-raspberry-pi.md) | Arm32v7 | -| macOS | * | x86_64, Apple M1 | -| Windows | [Windows Server 2019](windows.md) | x86_64, x86 | -| | [Windows 10 1903](windows.md) | x86_64, x86 | - -From an architecture support perspective, Fluent Bit is fully functional on x86_64, Arm64v8, and Arm32v7 based processors. - -Fluent Bit can work also on macOS and Berkeley Software Distribution (BSD) systems, but not all plugins will be available on all platforms. - -Official support is based on community demand. Fluent Bit might run on older operating systems, but must be built from source, or using custom packages from [enterprise providers](https://fluentbit.io/enterprise). - -Fluent Bit is supported for Linux on IBM Z (s390x) environments with some restrictions, but only container images are provided for these targets officially. diff --git a/update-release-version-docs.sh b/update-release-version-docs.sh index c92c28c0b..df6bc66b4 100755 --- a/update-release-version-docs.sh +++ b/update-release-version-docs.sh @@ -29,11 +29,11 @@ if [[ -z "$MAJOR_VERSION" ]]; then fi # Add Docker after first line in the table -if grep -Fq "$NEW_VERSION" "$SCRIPT_DIR"/installation/docker.md; then +if grep -Fq "$NEW_VERSION" "$SCRIPT_DIR"/installation/downloads/docker.md; then echo "Found $NEW_VERSION already in the Docker docs so skipping update" else - sed_wrapper -i -e "/| -.*$/a | $NEW_VERSION | x86\_64, arm64v8, arm32v7, s390x | Release [v$NEW_VERSION](https://fluentbit.io/announcements/v$NEW_VERSION/) |" "$SCRIPT_DIR"/installation/docker.md - sed_wrapper -i -e "/| -.*$/a | $NEW_VERSION-debug | x86\_64, arm64v8, arm32v7, s390x | Debug images |" "$SCRIPT_DIR"/installation/docker.md + sed_wrapper -i -e "/| -.*$/a | $NEW_VERSION | x86\_64, arm64v8, arm32v7, s390x | Release [v$NEW_VERSION](https://fluentbit.io/announcements/v$NEW_VERSION/) |" "$SCRIPT_DIR"/installation/downloads/docker.md + sed_wrapper -i -e "/| -.*$/a | $NEW_VERSION-debug | x86\_64, arm64v8, arm32v7, s390x | Debug images |" "$SCRIPT_DIR"/installation/downloads/docker.md fi WIN_32_EXE_HASH=${WIN_32_EXE_HASH:?} @@ -43,17 +43,17 @@ WIN_64_ZIP_HASH=${WIN_64_ZIP_HASH:?} WIN_64_ARM_EXE_HASH=${WIN_64_ARM_EXE_HASH:-} WIN_64_ARM_ZIP_HASH=${WIN_64_ARM_ZIP_HASH:-} -sed_wrapper -i -e "s/The latest stable version is .*$/The latest stable version is $NEW_VERSION./g" "$SCRIPT_DIR"/installation/windows.md -sed_wrapper -i -e "s/fluent-bit-[0-9\.]*-win/fluent-bit-$NEW_VERSION-win/g" "$SCRIPT_DIR"/installation/windows.md +sed_wrapper -i -e "s/The latest stable version is .*$/The latest stable version is $NEW_VERSION./g" "$SCRIPT_DIR"/installation/downloads/windows.md +sed_wrapper -i -e "s/fluent-bit-[0-9\.]*-win/fluent-bit-$NEW_VERSION-win/g" "$SCRIPT_DIR"/installation/downloads/windows.md -sed_wrapper -i -e "s/win32.exe) | \[.*\]/win32.exe) | \[$WIN_32_EXE_HASH\]/g" "$SCRIPT_DIR"/installation/windows.md -sed_wrapper -i -e "s/win32.zip) | \[.*\]/win32.zip) | \[$WIN_32_ZIP_HASH\]/g" "$SCRIPT_DIR"/installation/windows.md -sed_wrapper -i -e "s/win64.exe) | \[.*\]/win64.exe) | \[$WIN_64_EXE_HASH\]/g" "$SCRIPT_DIR"/installation/windows.md -sed_wrapper -i -e "s/win64.zip) | \[.*\]/win64.zip) | \[$WIN_64_ZIP_HASH\]/g" "$SCRIPT_DIR"/installation/windows.md +sed_wrapper -i -e "s/win32.exe) | \[.*\]/win32.exe) | \[$WIN_32_EXE_HASH\]/g" "$SCRIPT_DIR"/installation/downloads/windows.md +sed_wrapper -i -e "s/win32.zip) | \[.*\]/win32.zip) | \[$WIN_32_ZIP_HASH\]/g" "$SCRIPT_DIR"/installation/downloads/windows.md +sed_wrapper -i -e "s/win64.exe) | \[.*\]/win64.exe) | \[$WIN_64_EXE_HASH\]/g" "$SCRIPT_DIR"/installation/downloads/windows.md +sed_wrapper -i -e "s/win64.zip) | \[.*\]/win64.zip) | \[$WIN_64_ZIP_HASH\]/g" "$SCRIPT_DIR"/installation/downloads/windows.md if [[ -n "$WIN_64_ARM_EXE_HASH" ]]; then - sed_wrapper -i -e "s/winarm64.exe) | \[.*\]/winarm64.exe) | \[$WIN_64_ARM_EXE_HASH\]/g" "$SCRIPT_DIR"/installation/windows.md + sed_wrapper -i -e "s/winarm64.exe) | \[.*\]/winarm64.exe) | \[$WIN_64_ARM_EXE_HASH\]/g" "$SCRIPT_DIR"/installation/downloads/windows.md fi if [[ -n "$WIN_64_ARM_ZIP_HASH" ]]; then - sed_wrapper -i -e "s/winarm64.zip) | \[.*\]/winarm64.zip) | \[$WIN_64_ARM_ZIP_HASH\]/g" "$SCRIPT_DIR"/installation/windows.md + sed_wrapper -i -e "s/winarm64.zip) | \[.*\]/winarm64.zip) | \[$WIN_64_ARM_ZIP_HASH\]/g" "$SCRIPT_DIR"/installation/downloads/windows.md fi