diff options
author | Promise Akpan <akpanpromise@hotmail.com> | 2019-08-15 12:06:39 +0100 |
---|---|---|
committer | Chris Akritidis <43294513+cakrit@users.noreply.github.com> | 2019-08-15 13:06:39 +0200 |
commit | f5006d51e8caf9148d393eb68d53dc9fcd28b7b6 (patch) | |
tree | 03b757236d6b45e46813a4a875c77dc775e5f896 /packaging | |
parent | 69172fd57472df75d877f43de2dcc693c48ab5c0 (diff) |
Fix Markdown Lint warnings (#6664)
* make remark access all directories
* detailed fix after autofix by remark lint
* cross check autofix for this set of files
* crosscheck more files
* crosschecking and small fixes
* crosscheck autofixed md files
Diffstat (limited to 'packaging')
-rw-r--r-- | packaging/DISTRIBUTIONS.md | 325 | ||||
-rw-r--r-- | packaging/docker/README.md | 51 | ||||
-rw-r--r-- | packaging/installer/README.md | 235 | ||||
-rw-r--r-- | packaging/installer/UNINSTALL.md | 15 | ||||
-rw-r--r-- | packaging/installer/UPDATE.md | 8 | ||||
-rw-r--r-- | packaging/maintainers/README.md | 25 | ||||
-rw-r--r-- | packaging/makeself/README.md | 20 |
7 files changed, 351 insertions, 328 deletions
diff --git a/packaging/DISTRIBUTIONS.md b/packaging/DISTRIBUTIONS.md index fd1bdf8296..6a5472bb85 100644 --- a/packaging/DISTRIBUTIONS.md +++ b/packaging/DISTRIBUTIONS.md @@ -1,4 +1,5 @@ # Netdata distribution support matrix + ![](https://raw.githubusercontent.com/netdata/netdata/master/web/gui/images/packaging-beta-tag.svg?sanitize=true) In the following table we've listed Netdata's official supported operating systems. We detail the distributions, flavors, and the level of support Netdata is currently capable to provide. @@ -9,84 +10,82 @@ have complete visibility over the range of support. **Legend**: -- **Version**: Operating system version supported -- **Family**: The family that the OS belongs to -- **CI Smoke Testing**: Smoke testing has been implemented on our CI, to prevent broken code reaching our users -- **CI Testing**: Testing has been implemented to prevent broken or problematic code reaching our users -- **CI Integration**: CI Integration has been fully implemented for the particular operating system version -- **CD**: Continious deployment support has been fully enabled for this operating system -- **.DEB**: We provide a `.DEB` package for that particular operating system -- **.RPM**: We provide a `.RPM` package for that particular operating system -- **Installer**: Running netdata from source, using our installer, is working for this operating system -- **Kickstart**: Kickstart installation is working fine for this operating system -- **Kickstart64**: Kickstart static64 installation is working fine for this operating system -- **Community**: This operating system receives community support, such as packaging maintainers, contributors, and so on - +- **Version**: Operating system version supported +- **Family**: The family that the OS belongs to +- **CI Smoke Testing**: Smoke testing has been implemented on our CI, to prevent broken code reaching our users +- **CI Testing**: Testing has been implemented to prevent broken or problematic code reaching our users +- **CI Integration**: CI Integration has been fully implemented for the particular operating system version +- **CD**: Continious deployment support has been fully enabled for this operating system +- **.DEB**: We provide a `.DEB` package for that particular operating system +- **.RPM**: We provide a `.RPM` package for that particular operating system +- **Installer**: Running netdata from source, using our installer, is working for this operating system +- **Kickstart**: Kickstart installation is working fine for this operating system +- **Kickstart64**: Kickstart static64 installation is working fine for this operating system +- **Community**: This operating system receives community support, such as packaging maintainers, contributors, and so on ## AMD64 Architecture -Version | Family | CI Smoke testing | CI Testing | CD | .DEB | .RPM | Installer | Kickstart | Kickstart64 | Community +| Version | Family | CI Smoke testing | CI Testing | CD | .DEB | .RPM | Installer | Kickstart | Kickstart64 | Community :------------------: | :------------------: | :----------------: | :----------------: | :----------------: | :----------------: | :----------------: | :----------------: | :----------------: | :----------------: | :----------------: -14.04.6 LTS (Trusty Tahr) | Ubuntu | ✔ | ? | ✔ | ✔ | N/A | ✔ | ✔ | ✔ | ? -16.04.6 LTS (Xenial Xerus) | Ubuntu | ✔ | ? | ✔ | ✔ | N/A | ✔ | ✔ | ✔ | ? -18.04.2 LTS (Bionic Beaver) | Ubuntu | ✔ | ? | ✔ | ✔ | N/A | ✔ | ✔ | ✔ | ? -19.04 (Disco Dingo) Latest | Ubuntu | ✔ | ? | ✔ | ✔ | N/A | ✔ | ✔ | ✔ | ? -Debian 7 (Wheezy) | Debian | ✔ | ? | ✔ | ✗ | N/A | ✔ | ✔ | ✔ | ? -Debian 8 (Jessie) | Debian | ✔ | ? | ✔ | ✔ | N/A | ✔ | ✔ | ✔ | ? -Debian 9 (Stretch) | Debian | ✔ | ? | ✔ | ✔ | N/A | ✔ | ✔ | ✔ | ? -Debian 10 (Buster) | Debian | ✔ | ? | ✔ | ✔ | N/A | ✔ | ✔ | ✔ | ? -Versions 6.* | RHEL | ✔ | ? | ✔ | N/A | ✔ | ✔ | ✔ | ✔ | ? -Versions 7.* | RHEL | ✔ | ? | ✔ | N/A | ✔ | ✔ | ✔ | ✔ | ? -Versions 8.* | RHEL | ? | ? | ? | N/A | ✗ | ? | ? | ✔ | ? -Fedora 28 | Fedora | ✔ | ? | ✔ | N/A | ✗ | ✔ | ✔ | ✔ | ? -Fedora 29 | Fedora | ✔ | ? | ✔ | N/A | ✗ | ✔ | ✔ | ✔ | ? -Fedora 30 | Fedora | ✔ | ? | ✔ | N/A | ✗ | ✔ | ✔ | ✔ | ? -Fedora 31 | Fedora | ? | ? | ? | N/A | ✗ | ? | ? | ✔ | ? -CentOS 6.* | Cent OS | ✔ | ? | ✔ | N/A | ✔ | ✔ | ✔ | ✔ | ? -CentOS 7.* | Cent OS | ✔ | ? | ✔ | N/A | ✔ | ✔ | ✔ | ✔ | ? -CentOS 8.* | Cent OS | ? | ? | ? | N/A | ✗ | ? | ? | ✔ | ? -OpenSuSE Leap 15.0 | Open SuSE | ✔ | ? | ✔ | N/A | ✗ | ✔ | ✔ | ✔ | ? -OpenSuSE Leap 15.1 | Open SuSE | ✔ | ? | ✔ | N/A | ✗ | ✔ | ✔ | ✔ | ? -OpenSuSE Tumbleweed | Open SuSE | ✔ | ? | ? | N/A | ✗ | ✔ | ? | ✔ | ? -SLES 11 | SLES | ? | ? | ? | N/A | ✗ | ? | ? | ✔ | ? -SLES 12 | SLES | ? | ? | ? | N/A | ✗ | ? | ? | ✔ | ? -SLES 15 | SLES | ? | ? | ? | N/A | ✗ | ? | ? | ✔ | ? -Alpine | Alpine | ✔ | ? | ✗ | N/A | N/A | ✔ | ✔ | ✔ | ? -Arch Linux (latest) | Arch | ✔ | ? | ✗ | N/A | ✗ | ✔ | ✔ | ✔ | ? -All other linux | Other | ? | ? | ? | ✗ | ✗ | ? | ? | ✔ | ? +| 14.04.6 LTS (Trusty Tahr) | Ubuntu | ✔ | ? | ✔ | ✔ | N/A | ✔ | ✔ | ✔ | ? +| 16.04.6 LTS (Xenial Xerus) | Ubuntu | ✔ | ? | ✔ | ✔ | N/A | ✔ | ✔ | ✔ | ? +| 18.04.2 LTS (Bionic Beaver) | Ubuntu | ✔ | ? | ✔ | ✔ | N/A | ✔ | ✔ | ✔ | ? +| 19.04 (Disco Dingo) Latest | Ubuntu | ✔ | ? | ✔ | ✔ | N/A | ✔ | ✔ | ✔ | ? +| Debian 7 (Wheezy) | Debian | ✔ | ? | ✔ | ✗ | N/A | ✔ | ✔ | ✔ | ? +| Debian 8 (Jessie) | Debian | ✔ | ? | ✔ | ✔ | N/A | ✔ | ✔ | ✔ | ? +| Debian 9 (Stretch) | Debian | ✔ | ? | ✔ | ✔ | N/A | ✔ | ✔ | ✔ | ? +| Debian 10 (Buster) | Debian | ✔ | ? | ✔ | ✔ | N/A | ✔ | ✔ | ✔ | ? +| Versions 6.* | RHEL | ✔ | ? | ✔ | N/A | ✔ | ✔ | ✔ | ✔ | ? +| Versions 7.* | RHEL | ✔ | ? | ✔ | N/A | ✔ | ✔ | ✔ | ✔ | ? +| Versions 8.* | RHEL | ? | ? | ? | N/A | ✗ | ? | ? | ✔ | ? +| Fedora 28 | Fedora | ✔ | ? | ✔ | N/A | ✗ | ✔ | ✔ | ✔ | ? +| Fedora 29 | Fedora | ✔ | ? | ✔ | N/A | ✗ | ✔ | ✔ | ✔ | ? +| Fedora 30 | Fedora | ✔ | ? | ✔ | N/A | ✗ | ✔ | ✔ | ✔ | ? +| Fedora 31 | Fedora | ? | ? | ? | N/A | ✗ | ? | ? | ✔ | ? +| CentOS 6.* | Cent OS | ✔ | ? | ✔ | N/A | ✔ | ✔ | ✔ | ✔ | ? +| CentOS 7.* | Cent OS | ✔ | ? | ✔ | N/A | ✔ | ✔ | ✔ | ✔ | ? +| CentOS 8.* | Cent OS | ? | ? | ? | N/A | ✗ | ? | ? | ✔ | ? +| OpenSuSE Leap 15.0 | Open SuSE | ✔ | ? | ✔ | N/A | ✗ | ✔ | ✔ | ✔ | ? +| OpenSuSE Leap 15.1 | Open SuSE | ✔ | ? | ✔ | N/A | ✗ | ✔ | ✔ | ✔ | ? +| OpenSuSE Tumbleweed | Open SuSE | ✔ | ? | ? | N/A | ✗ | ✔ | ? | ✔ | ? +| SLES 11 | SLES | ? | ? | ? | N/A | ✗ | ? | ? | ✔ | ? +| SLES 12 | SLES | ? | ? | ? | N/A | ✗ | ? | ? | ✔ | ? +| SLES 15 | SLES | ? | ? | ? | N/A | ✗ | ? | ? | ✔ | ? +| Alpine | Alpine | ✔ | ? | ✗ | N/A | N/A | ✔ | ✔ | ✔ | ? +| Arch Linux (latest) | Arch | ✔ | ? | ✗ | N/A | ✗ | ✔ | ✔ | ✔ | ? +| All other linux | Other | ? | ? | ? | ✗ | ✗ | ? | ? | ✔ | ? ## x86 Architecture -Version | Family | CI Smoke testing | CI Testing | CD | .DEB | .RPM | Installer | Kickstart | Kickstart64 | Community +| Version | Family | CI Smoke testing | CI Testing | CD | .DEB | .RPM | Installer | Kickstart | Kickstart64 | Community :------------------: | :------------------: | :----------------: | :----------------: | :----------------: | :----------------: | :----------------: | :----------------: | :----------------: | :----------------: | :----------------: -14.04.6 LTS (Trusty Tahr) | Ubuntu | ✔ | ? | ✔ | ✗ | N/A | ✔ | ✔ | ✔ | ? -16.04.6 LTS (Xenial Xerus) | Ubuntu | ✔ | ? | ✔ | ✗ | N/A | ✔ | ✔ | ✔ | ? -18.04.2 LTS (Bionic Beaver) | Ubuntu | ✔ | ? | ✔ | ✔ | N/A | ✔ | ✔ | ✔ | ? -19.04 (Disco Dingo) Latest | Ubuntu | ✔ | ? | ✔ | ✔ | N/A | ✔ | ✔ | ✔ | ? -Debian 7 (Wheezy) | Debian | ✔ | ? | ✔ | ✗ | N/A | ✔ | ✔ | ✔ | ? -Debian 8 (Jessie) | Debian | ✔ | ? | ✔ | ✔ | N/A | ✔ | ✔ | ✔ | ? -Debian 9 (Stretch) | Debian | ✔ | ? | ✔ | ✔ | N/A | ✔ | ✔ | ✔ | ? -Debian 10 (Buster) | Debian | ✔ | ? | ✔ | ✔ | N/A | ✔ | ✔ | ✔ | ? -Versions 6.* | RHEL | ✔ | ? | ✔ | N/A | ✔ | ✔ | ✔ | ✔ | ? -Versions 7.* | RHEL | ✔ | ? | ✔ | N/A | ✔ | ✔ | ✔ | ✔ | ? -Versions 8.* | RHEL | ? | ? | ? | N/A | ✗ | ? | ? | ✔ | ? -Fedora 28 | Fedora | ✔ | ? | ✔ | N/A | ✗ | ✔ | ✔ | ✔ | ? -Fedora 29 | Fedora | ✔ | ? | ✔ | N/A | ✗ | ✔ | ✔ | ✔ | ? -Fedora 30 | Fedora | ✔ | ? | ✔ | N/A | ✗ | ✔ | ✔ | ✔ | ? -Fedora 31 | Fedora | ? | ? | ? | N/A | ✗ | ? | ? | ✔ | ? -CentOS 6.* | Cent OS | ✔ | ? | ✔ | N/A | ✔ | ✔ | ✔ | ✔ | ? -CentOS 7.* | Cent OS | ✔ | ? | ✔ | N/A | ✔ | ✔ | ✔ | ✔ | ? -CentOS 8.* | Cent OS | ? | ? | ? | N/A | ✗ | ? | ? | ✔ | ? -OpenSuSE Leap 15.0 | Open SuSE | ✔ | ? | ✔ | N/A | ✗ | ✔ | ✔ | ✔ | ? -OpenSuSE Leap 15.1 | Open SuSE | ✔ | ? | ✔ | N/A | ✗ | ✔ | ✔ | ✔ | ? -OpenSuSE Tumbleweed | Open SuSE | ✔ | ? | ? | N/A | ✗ | ✔ | ? | ✔ | ? -SLES 11 | SLES | ? | ? | ? | N/A | ✗ | ? | ? | ✔ | ? -SLES 12 | SLES | ? | ? | ? | N/A | ✗ | ? | ? | ✔ | ? -SLES 15 | SLES | ? | ? | ? | N/A | ✗ | ? | ? | ✔ | ? -Alpine | Alpine | ✔ | ? | ✗ | N/A | N/A | ✔ | ✔ | ✔ | ? -Arch Linux (latest) | Arch | ✔ | ? | ✗ | N/A | ✗ | ✔ | ✔ | ✔ | ? -All other linux | Other | ? | ? | ? | ✗ | ✗ | ? | ? | ✔ | ? - +| 14.04.6 LTS (Trusty Tahr) | Ubuntu | ✔ | ? | ✔ | ✗ | N/A | ✔ | ✔ | ✔ | ? +| 16.04.6 LTS (Xenial Xerus) | Ubuntu | ✔ | ? | ✔ | ✗ | N/A | ✔ | ✔ | ✔ | ? +| 18.04.2 LTS (Bionic Beaver) | Ubuntu | ✔ | ? | ✔ | ✔ | N/A | ✔ | ✔ | ✔ | ? +| 19.04 (Disco Dingo) Latest | Ubuntu | ✔ | ? | ✔ | ✔ | N/A | ✔ | ✔ | ✔ | ? +| Debian 7 (Wheezy) | Debian | ✔ | ? | ✔ | ✗ | N/A | ✔ | ✔ | ✔ | ? +| Debian 8 (Jessie) | Debian | ✔ | ? | ✔ | ✔ | N/A | ✔ | ✔ | ✔ | ? +| Debian 9 (Stretch) | Debian | ✔ | ? | ✔ | ✔ | N/A | ✔ | ✔ | ✔ | ? +| Debian 10 (Buster) | Debian | ✔ | ? | ✔ | ✔ | N/A | ✔ | ✔ | ✔ | ? +| Versions 6.* | RHEL | ✔ | ? | ✔ | N/A | ✔ | ✔ | ✔ | ✔ | ? +| Versions 7.* | RHEL | ✔ | ? | ✔ | N/A | ✔ | ✔ | ✔ | ✔ | ? +| Versions 8.* | RHEL | ? | ? | ? | N/A | ✗ | ? | ? | ✔ | ? +| Fedora 28 | Fedora | ✔ | ? | ✔ | N/A | ✔ | ✔ | ✔ | ✔ | ? +| Fedora 29 | Fedora | ✔ | ? | ✔ | N/A | ✔ | ✔ | ✔ | ✔ | ? +| Fedora 30 | Fedora | ✔ | ? | ✔ | N/A | ✔ | ✔ | ✔ | ✔ | ? +| Fedora 31 | Fedora | ? | ? | ? | N/A | ✗ | ? | ? | ✔ | ? +| CentOS 6.* | Cent OS | ✔ | ? | ✔ | N/A | ✔ | ✔ | ✔ | ✔ | ? +| CentOS 7.* | Cent OS | ✔ | ? | ✔ | N/A | ✔ | ✔ | ✔ | ✔ | ? +| CentOS 8.* | Cent OS | ? | ? | ? | N/A | ✗ | ? | ? | ✔ | ? +| OpenSuSE Leap 15.0 | Open SuSE | ✔ | ? | ✔ | N/A | ✔ | ✔ | ✔ | ✔ | ? +| OpenSuSE Leap 15.1 | Open SuSE | ✔ | ? | ✔ | N/A | ✔ | ✔ | ✔ | ✔ | ? +| OpenSuSE Tumbleweed | Open SuSE | ✔ | ? | ? | N/A | ✗ | ✔ | ? | ✔ | ? +| SLES 11 | SLES | ? | ? | ? | N/A | ✗ | ? | ? | ✔ | ? +| SLES 12 | SLES | ? | ? | ? | N/A | ✗ | ? | ? | ✔ | ? +| SLES 15 | SLES | ? | ? | ? | N/A | ✗ | ? | ? | ✔ | ? +| Alpine | Alpine | ✔ | ? | ✗ | N/A | N/A | ✔ | ✔ | ✔ | ? +| Arch Linux (latest) | Arch | ✔ | ? | ✗ | N/A | ✗ | ✔ | ✔ | ✔ | ? +| All other linux | Other | ? | ? | ? | ✗ | ✗ | ? | ? | ✔ | ? ## Supported functionalities accross different distribution channels @@ -95,157 +94,161 @@ There are various limitations and problems we try to attend as we evolve and gro **Legend**: -- **Auto-detect**: Depends on the programs package dependencies. If the required dependencies are covered during compile time, capability is enabled -- **YES**: This flag implies that the functionality is available for that distribution channel -- **NO**: Not available at the moment for that distribution channel at this time, but may be a work-in-progress effort from the Netdata team. -- **At Runtime**: The given module or functionality is available and only requires configuration after install to enable it +- **Auto-detect**: Depends on the programs package dependencies. If the required dependencies are covered during compile time, capability is enabled +- **YES**: This flag implies that the functionality is available for that distribution channel +- **NO**: Not available at the moment for that distribution channel at this time, but may be a work-in-progress effort from the Netdata team. +- **At Runtime**: The given module or functionality is available and only requires configuration after install to enable it ### Core functionality #### Core + This is the base netdata capability, that includes basic monitoring, embedded web server, and so on. -| make/make install | netdata-installer.sh | kickstart.sh | kickstart-static64.sh | Docker image | RPM packaging | DEB packaging | -| :-----------------: | :-----------------: | :-----------------: | :-----------------: | :-----------------: | :-----------------: | :-----------------: | -| YES | YES | YES | YES | YES | YES | YES | +|make/make install|netdata-installer.sh|kickstart.sh|kickstart-static64.sh|Docker image|RPM packaging|DEB packaging| +|:---------------:|:------------------:|:----------:|:-------------------:|:----------:|:-----------:|:-----------:| +|YES|YES|YES|YES|YES|YES|YES| -- **Flags/instructions to enable**: None -- **Flags to disable from source**: None -- **What packages required for auto-detect?**: `install-required-packages.sh netdata` +- **Flags/instructions to enable**: None +- **Flags to disable from source**: None +- **What packages required for auto-detect?**: `install-required-packages.sh netdata` #### DB Engine + This is the brand new database engine capability of netdata. It is a mandatory facility required by netdata. Given it's special needs and dependencies though, it remains an optional facility so that users can enjoy netdata even when they cannot cover the dependencies or the H/W requirements. -| make/make install | netdata-installer.sh | kickstart.sh | kickstart-static64.sh | Docker image | RPM packaging | DEB packaging | -| :-----------------: | :-----------------: | :-----------------: | :-----------------: | :-----------------: | :-----------------: | :-----------------: | -| Auto-detect | Auto-detect | YES | YES | YES | YES | YES | +|make/make install|netdata-installer.sh|kickstart.sh|kickstart-static64.sh|Docker image|RPM packaging|DEB packaging| +|:---------------:|:------------------:|:----------:|:-------------------:|:----------:|:-----------:|:-----------:| +|Auto-detect|Auto-detect|YES|YES|YES|YES|YES| -- **Flags/instructions to enable**: None -- **Flags to disable from source**: `--disable-dbengine` -- **What packages required for auto-detect?**: `openssl`, `libuv1`, `lz4`, `Judy` +- **Flags/instructions to enable**: None +- **Flags to disable from source**: `--disable-dbengine` +- **What packages required for auto-detect?**: `openssl`, `libuv1`, `lz4`, `Judy` #### Encryption Support (HTTPS) -This is Netdata's TLS capability that incorporates encryption on the web server and the APIs between master and slaves. Also a mandatory facility for Netdata, but remains optional for users who are limited or not interested in tight security -| make/make install | netdata-installer.sh | kickstart.sh | kickstart-static64.sh | Docker image | RPM packaging | DEB packaging | -| :-----------------: | :-----------------: | :-----------------: | :-----------------: | :-----------------: | :-----------------: | :-----------------: | -| Auto-detect | Auto-detect | YES | YES | YES | YES | YES | +This is Netdata's TLS capability that incorporates encryption on the web server and the APIs between master and slaves. Also a mandatory facility for Netdata, but remains optional for users who are limited or not interested in tight security -- **Flags/instructions to enable**: None -- **Flags to disable from source**: --disable-https -- **What packages required for auto-detect?**: `openssl` +|make/make install|netdata-installer.sh|kickstart.sh|kickstart-static64.sh|Docker image|RPM packaging|DEB packaging| +|:---------------:|:------------------:|:----------:|:-------------------:|:----------:|:-----------:|:-----------:| +|Auto-detect|Auto-detect|YES|YES|YES|YES|YES| +- **Flags/instructions to enable**: None +- **Flags to disable from source**: --disable-https +- **What packages required for auto-detect?**: `openssl` ### Libraries/optimizations #### JSON-C Support -| make/make install | netdata-installer.sh | kickstart.sh | kickstart-static64.sh | Docker image | RPM packaging | DEB packaging | -| :-----------------: | :-----------------: | :-----------------: | :-----------------: | :-----------------: | :-----------------: | :-----------------: | -| Auto-detect | Auto-detect | Auto-detect | Auto-detect | NO | YES | YES | -- **Flags/instructions to enable**: None -- **Flags to disable from source**: --disable-jsonc -- **What packages required for auto-detect?**: `json-c` +|make/make install|netdata-installer.sh|kickstart.sh|kickstart-static64.sh|Docker image|RPM packaging|DEB packaging| +|:---------------:|:------------------:|:----------:|:-------------------:|:----------:|:-----------:|:-----------:| +|Auto-detect|Auto-detect|Auto-detect|Auto-detect|NO|YES|YES| + +- **Flags/instructions to enable**: None +- **Flags to disable from source**: --disable-jsonc +- **What packages required for auto-detect?**: `json-c` #### Link time optimizations -| make/make install | netdata-installer.sh | kickstart.sh | kickstart-static64.sh | Docker image | RPM packaging | DEB packaging | -| :-----------------: | :-----------------: | :-----------------: | :-----------------: | :-----------------: | :-----------------: | :-----------------: | -| Auto-detect | Auto-detect | Auto-detect | Auto-detect | Auto-detect | Auto-detect | Auto-detect | -- **Flags/instructions to enable**: None -- **Flags to disable from source**: --disable-lto -- **What packages required for auto-detect?**: No package dependency, depends on GCC version +|make/make install|netdata-installer.sh|kickstart.sh|kickstart-static64.sh|Docker image|RPM packaging|DEB packaging| +|:---------------:|:------------------:|:----------:|:-------------------:|:----------:|:-----------:|:-----------:| +|Auto-detect|Auto-detect|Auto-detect|Auto-detect|Auto-detect|Auto-detect|Auto-detect| + +- **Flags/instructions to enable**: None +- **Flags to disable from source**: --disable-lto +- **What packages required for auto-detect?**: No package dependency, depends on GCC version ### Collectors #### FREEIPMI -| make/make install | netdata-installer.sh | kickstart.sh | kickstart-static64.sh | Docker image | RPM packaging | DEB packaging | -| :-----------------: | :-----------------: | :-----------------: | :-----------------: | :-----------------: | :-----------------: | :-----------------: | -| Auto-detect | Auto-detect | Auto-detect | Auto-detect | No | YES | YES | -- **Flags/instructions to enable**: None -- **Flags to disable from source**: --disable-plugin-freeipmi -- **What packages required for auto-detect?**: `freeipmi-dev (or -devel)` +|make/make install|netdata-installer.sh|kickstart.sh|kickstart-static64.sh|Docker image|RPM packaging|DEB packaging| +|:---------------:|:------------------:|:----------:|:-------------------:|:----------:|:-----------:|:-----------:| +|Auto-detect|Auto-detect|Auto-detect|Auto-detect|No|YES|YES| +- **Flags/instructions to enable**: None +- **Flags to disable from source**: --disable-plugin-freeipmi +- **What packages required for auto-detect?**: `freeipmi-dev (or -devel)` #### NFACCT -| make/make install | netdata-installer.sh | kickstart.sh | kickstart-static64.sh | Docker image | RPM packaging | DEB packaging | -| :-----------------: | :-----------------: | :-----------------: | :-----------------: | :-----------------: | :-----------------: | :-----------------: | -| Auto-detect | Auto-detect | Auto-detect | Auto-detect | NO | YES | YES | -- **Flags/instructions to enable**: None -- **Flags to disable from source**: --disable-plugin-nfacct -- **What packages required for auto-detect?**: `libmnl-dev`, `libnetfilter_acct-dev` +|make/make install|netdata-installer.sh|kickstart.sh|kickstart-static64.sh|Docker image|RPM packaging|DEB packaging| +|:---------------:|:------------------:|:----------:|:-------------------:|:----------:|:-----------:|:-----------:| +|Auto-detect|Auto-detect|Auto-detect|Auto-detect|NO|YES|YES| +- **Flags/instructions to enable**: None +- **Flags to disable from source**: --disable-plugin-nfacct +- **What packages required for auto-detect?**: `libmnl-dev`, `libnetfilter_acct-dev` #### Xenstat -| make/make install | netdata-installer.sh | kickstart.sh | kickstart-static64.sh | Docker image | RPM packaging | DEB packaging | -| :-----------------: | :-----------------: | :-----------------: | :-----------------: | :-----------------: | :-----------------: | :-----------------: | -| Auto-detect | Auto-detect | Auto-detect | Auto-detect | NO | NO | NO | - -- **Flags/instructions to enable**: None -- **Flags to disable from source**: --disable-plugin-xenstat -- **What packages required for auto-detect?**: `xen-dom0-libs-devel`, `yajl-dev` +|make/make install|netdata-installer.sh|kickstart.sh|kickstart-static64.sh|Docker image|RPM packaging|DEB packaging| +|:---------------:|:------------------:|:----------:|:-------------------:|:----------:|:-----------:|:-----------:| +|Auto-detect|Auto-detect|Auto-detect|Auto-detect|NO|NO|NO| +- **Flags/instructions to enable**: None +- **Flags to disable from source**: --disable-plugin-xenstat +- **What packages required for auto-detect?**: `xen-dom0-libs-devel`, `yajl-dev` #### CUPS -| make/make install | netdata-installer.sh | kickstart.sh | kickstart-static64.sh | Docker image | RPM packaging | DEB packaging | -| :-----------------: | :-----------------: | :-----------------: | :-----------------: | :-----------------: | :-----------------: | :-----------------: | -| Auto-detect | Auto-detect | Auto-detect | Auto-detect | NO | YES | YES | -- **Flags/instructions to enable**: None -- **Flags to disable from source**: --disable-plugin-cups -- **What packages required for auto-detect?**: `cups-devel` +|make/make install|netdata-installer.sh|kickstart.sh|kickstart-static64.sh|Docker image|RPM packaging|DEB packaging| +|:---------------:|:------------------:|:----------:|:-------------------:|:----------:|:-----------:|:-----------:| +|Auto-detect|Auto-detect|Auto-detect|Auto-detect|NO|YES|YES| +- **Flags/instructions to enable**: None +- **Flags to disable from source**: --disable-plugin-cups +- **What packages required for auto-detect?**: `cups-devel` #### FPING -| make/make install | netdata-installer.sh | kickstart.sh | kickstart-static64.sh | Docker image | RPM packaging | DEB packaging | -| :-----------------: | :-----------------: | :-----------------: | :-----------------: | :-----------------: | :-----------------: | :-----------------: | -| At Runtime | At Runtime | At Runtime | At Runtime | At Runtime | At Runtime | At Runtime | -- **Flags/instructions to enable**: ${INSTALL_PATH}/netdata/plugins.d/fping.plugin install -- **Flags to disable from source**: None -- just dont install -- **What packages required for auto-detect?**: None - only fping installed to start it up +|make/make install|netdata-installer.sh|kickstart.sh|kickstart-static64.sh|Docker image|RPM packaging|DEB packaging| +|:---------------:|:------------------:|:----------:|:-------------------:|:----------:|:-----------:|:-----------:| +|At Runtime|At Runtime|At Runtime|At Runtime|At Runtime|At Runtime|At Runtime| +- **Flags/instructions to enable**: ${INSTALL_PATH}/netdata/plugins.d/fping.plugin install +- **Flags to disable from source**: None -- just dont install +- **What packages required for auto-detect?**: None - only fping installed to start it up #### IOPING -| make/make install | netdata-installer.sh | kickstart.sh | kickstart-static64.sh | Docker image | RPM packaging | DEB packaging | -| :-----------------: | :-----------------: | :-----------------: | :-----------------: | :-----------------: | :-----------------: | :-----------------: | -| At Runtime | At Runtime | At Runtime | At Runtime | At Runtime | At Runtime | At Runtime | -- **Flags/instructions to enable**: ${INSTALL_PATH}/netdata/plugins.d/ioping.plugin install -- **Flags to disable from source**: None -- just dont install -- **What packages required for auto-detect?**: None - only ioping installed to start it up +|make/make install|netdata-installer.sh|kickstart.sh|kickstart-static64.sh|Docker image|RPM packaging|DEB packaging| +|:---------------:|:------------------:|:----------:|:-------------------:|:----------:|:-----------:|:-----------:| +|At Runtime|At Runtime|At Runtime|At Runtime|At Runtime|At Runtime|At Runtime| +- **Flags/instructions to enable**: ${INSTALL_PATH}/netdata/plugins.d/ioping.plugin install +- **Flags to disable from source**: None -- just dont install +- **What packages required for auto-detect?**: None - only ioping installed to start it up #### PERF -| make/make install | netdata-installer.sh | kickstart.sh | kickstart-static64.sh | Docker image | RPM packaging | DEB packaging | -| :-----------------: | :-----------------: | :-----------------: | :-----------------: | :-----------------: | :-----------------: | :-----------------: | -| At Runtime | At Runtime | At Runtime | At Runtime | At Runtime | At Runtime | At Runtime | -- **Flags/instructions to enable**: Inside netdata.conf, section `[Plugins]`, set `"perf = yes"` -- **Flags to disable from source**: --disable-perf -- **What packages required for auto-detect?**: None +|make/make install|netdata-installer.sh|kickstart.sh|kickstart-static64.sh|Docker image|RPM packaging|DEB packaging| +|:---------------:|:------------------:|:----------:|:-------------------:|:----------:|:-----------:|:-----------:| +|At Runtime|At Runtime|At Runtime|At Runtime|At Runtime|At Runtime|At Runtime| +- **Flags/instructions to enable**: Inside netdata.conf, section `[Plugins]`, set `"perf = yes"` +- **Flags to disable from source**: --disable-perf +- **What packages required for auto-detect?**: None ### Backends - #### Prometheus remote write -| make/make install | netdata-installer.sh | kickstart.sh | kickstart-static64.sh | Docker image | RPM packaging | DEB packaging | -| :-----------------: | :-----------------: | :-----------------: | :-----------------: | :-----------------: | :-----------------: | :-----------------: | -| Auto-detect | Auto-detect | Auto-detect | Auto-detect | NO | YES | YES | -- **Flags/instructions to enable**: None -- **Flags to disable from source**: --disable-backend-prometheus-remote-write -- **What packages required for auto-detect?**: `snappy-devel`, `protobuf`, `protobuf-compiler` +|make/make install|netdata-installer.sh|kickstart.sh|kickstart-static64.sh|Docker image|RPM packaging|DEB packaging| +|:---------------:|:------------------:|:----------:|:-------------------:|:----------:|:-----------:|:-----------:| +|Auto-detect|Auto-detect|Auto-detect|Auto-detect|NO|YES|YES| + +- **Flags/instructions to enable**: None +- **Flags to disable from source**: --disable-backend-prometheus-remote-write +- **What packages required for auto-detect?**: `snappy-devel`, `protobuf`, `protobuf-compiler` #### AWS Kinesis -| make/make install | netdata-installer.sh | kickstart.sh | kickstart-static64.sh | Docker image | RPM packaging | DEB packaging | -| :-----------------: | :-----------------: | :-----------------: | :-----------------: | :-----------------: | :-----------------: | :-----------------: | -| Auto-detect | Auto-detect | Auto-detect | Auto-detect | NO | NO | NO | -- **Flags/instructions to enable**: [Instructions for AWS Kinesis](https://docs.netdata.cloud/backends/aws_kinesis) -- **Flags to disable from source**: --disable-backend-kinesis -- **What packages required for auto-detect?**: `AWS SDK for C++`, `libcurl`, `libssl`, `libcrypto` +|make/make install|netdata-installer.sh|kickstart.sh|kickstart-static64.sh|Docker image|RPM packaging|DEB packaging| +|:---------------:|:------------------:|:----------:|:-------------------:|:----------:|:-----------:|:-----------:| +|Auto-detect|Auto-detect|Auto-detect|Auto-detect|NO|NO|NO| + +- **Flags/instructions to enable**: [Instructions for AWS Kinesis](https://docs.netdata.cloud/backends/aws_kinesis) +- **Flags to disable from source**: --disable-backend-kinesis +- **What packages required for auto-detect?**: `AWS SDK for C++`, `libcurl`, `libssl`, `libcrypto` diff --git a/packaging/docker/README.md b/packaging/docker/README.md index ca3a0e1529..7828203c8c 100644 --- a/packaging/docker/README.md +++ b/packaging/docker/README.md @@ -2,7 +2,7 @@ > :warning: As of Sep 9th, 2018 we ship [new docker builds](https://github.com/netdata/netdata/pull/3995), running Netdata in Docker with an [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint) directive, not a COMMAND directive. Please adapt your execution scripts accordingly. You can find more information about ENTRYPOINT vs COMMAND is presented by goinbigdata [here](http://goinbigdata.com/docker-run-vs-cmd-vs-entrypoint/) and by docker docs [here](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). > -> Also, the `latest` is now based on alpine, so **`alpine` is not updated any more** and `armv7hf` is now replaced with `armhf` (to comply with https://github.com/multiarch naming), so **`armv7hf` is not updated** either. +> Also, the `latest` is now based on alpine, so **`alpine` is not updated any more** and `armv7hf` is now replaced with `armhf` (to comply with <https://github.com/multiarch> naming), so **`armv7hf` is not updated** either. ## Limitations @@ -16,7 +16,7 @@ For more information go to [Polyverse site](https://polyverse.io/how-it-works/) ## Run Netdata with the docker command -Quickly start Netdata with the `docker` command. Netdata is then available at http://host:19999 +Quickly start Netdata with the `docker` command. Netdata is then available at <http://host:19999> This is good for an internal network or to quickly analyse a host. @@ -99,7 +99,7 @@ services: - DOCKER_USR=root ``` -### Pass command line options to Netdata +### Pass command line options to Netdata Since we use an [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint) directive, you can provide [Netdata daemon command line options](https://docs.netdata.cloud/daemon/#command-line-options) such as the IP address Netdata will be running on, using the [command instruction](https://docs.docker.com/engine/reference/builder/#cmd). @@ -110,15 +110,16 @@ For a permanent installation on a public server, you should [secure your Netdata You can use use the following docker-compose.yml and Caddyfile files to run Netdata with docker. Replace the Domains and email address for [Letsencrypt](https://letsencrypt.org/) before starting. ### Prerequisites -* [Docker](https://docs.docker.com/install/#server) -* [Docker Compose](https://docs.docker.com/compose/install/) -* Domain configured in DNS pointing to host. + +- [Docker](https://docs.docker.com/install/#server) +- [Docker Compose](https://docs.docker.com/compose/install/) +- Domain configured in DNS pointing to host. ### Caddyfile This file needs to be placed in /opt with name `Caddyfile`. Here you customize your domain and you need to provide your email address to obtain a Letsencrypt certificate. Certificate renewal will happen automatically and will be executed internally by the caddy server. -``` +```caddyfile netdata.example.org { proxy / netdata:19999 tls admin@example.org @@ -165,7 +166,7 @@ services: You can restrict access by following [official caddy guide](https://caddyserver.com/docs/basicauth) and adding lines to Caddyfile. -[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fpackaging%2Fdocker%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)]() +[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fpackaging%2Fdocker%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>) ## Publish a test image to your own repository @@ -186,7 +187,7 @@ This is especially useful when testing a Pull Request for Kubernetes, since you Example: -We get a local copy of the Helm chart at https://github.com/netdata/helmchart. We modify `values.yaml` to have the following: +We get a local copy of the Helm chart at <https://github.com/netdata/helmchart>. We modify `values.yaml` to have the following: ``` image: @@ -196,6 +197,7 @@ image: ``` We check out PR5576 and run the following: + ``` ./packaging/docker/build-test.sh -r cakrit/netdata-prs -v PR5576 -u cakrit -p 'XXX' ``` @@ -209,20 +211,21 @@ If we make changes to the code, we execute the same `build-test.sh` command, fol To enable Travis CI integration on your own repositories (Docker and Github), you need to be part of the Netdata organization. Once you have contacted the Netdata owners to setup you up on Github and Travis, execute the following steps -- Preparation - - Have Netdata forked on your personal GitHub account - - Get a GITHUB token: Go to GitHub settings -> Developer Settings -> Personal access tokens, generate a new token with full access to repo_hook, read only access to admin:org, public_repo, repo_deployment, repo:status and user:email settings enabled. This will be your GITHUB_TOKEN that is described later in the instru |