Docs lint on `packaging/` dir (#18665)
* docker readme pass * installer/methods docs pass * installer/ docs pass * maintainers dir docs pass * rest of packaging dir md docs pass
Fotis Voutsas committed
Oct 3, 2024 at 12:07 UTC
1ddbc6610dd0e6fcec74300449d89e32cf7e7aae
23 files changed
+296
-462
packaging/PLATFORM_SUPPORT.md
+40
-52
@@ -1,14 +1,3 @@
1
-<!--
2
-title: "Platform support policy"
3
-sidebar_label: "Platform support policy"
4
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/packaging/PLATFORM_SUPPORT.md"
5
-learn_status: "Published"
6
-sidebar_position: "1"
7
-learn_topic_type: "Tasks"
8
-learn_rel_path: "Installation"
9
-learn_docs_purpose: "Present all the supported platform in the Netdata solution"
10
--->
11
-
1
# Platform support policy
2
3
Netdata defines three tiers of official support:
@@ -30,13 +19,13 @@ Any platforms not listed in any of these categories may or may not work.
19
20
The following table shows a general outline of the various support tiers and categories.
21
33
-| | Bug Support | Guaranteed Configurations | CI Coverage | Native Packages | Static Build Support |
34
-| - | ----------- | ------------------------- | ----------- | --------------- | -------------------- |
35
-| Core | High priority | Everything but rare edge cases | Full | Yes, if we can provide them | Full |
36
-| Intermediate | Normal priority | Common cases | Partial (CI mostly equivalent to **Core**, but possibly with some gaps, and not required to pass) | Possibly | Full |
37
-| Community | Best Effort | Default only | None | No | Best Effort |
38
-| Third-party Supported | Users directed to platform maintainers | None | None | No | Best Effort |
39
-| Previously Supported | Users asked to upgrade | None | None | Yes, but only already published versions | Best Effort |
22
+| | Bug Support | Guaranteed Configurations | CI Coverage | Native Packages | Static Build Support |
23
+|-----------------------|----------------------------------------|--------------------------------|---------------------------------------------------------------------------------------------------|------------------------------------------|----------------------|
24
+| Core | High priority | Everything but rare edge cases | Full | Yes, if we can provide them | Full |
25
+| Intermediate | Normal priority | Common cases | Partial (CI mostly equivalent to **Core**, but possibly with some gaps, and not required to pass) | Possibly | Full |
26
+| Community | Best Effort | Default only | None | No | Best Effort |
27
+| Third-party Supported | Users directed to platform maintainers | None | None | No | Best Effort |
28
+| Previously Supported | Users asked to upgrade | None | None | Yes, but only already published versions | Best Effort |
29
30
- ‘Bug Support’: How we handle of platform-specific bugs.
31
- ‘Guaranteed Configurations’: Which runtime configurations for the agent we try to guarantee will work with minimal
@@ -56,30 +45,29 @@ Our [static builds](#static-builds) are expected to work on these platforms if a
45
expected
46
to work on these platforms with minimal user effort.
47
59
-| Platform | Version | Official Native Packages | Notes |
60
-|--------------------------|----------------|----------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|
61
-| Alpine Linux | 3.18 | No | The latest release of Alpine Linux is guaranteed to remain at **Core** tier due to usage for our Docker images |
62
-| Alma Linux | 9.x | x86\_64, AArch64 | Also includes support for Rocky Linux and other ABI compatible RHEL derivatives |
63
-| Alma Linux | 8.x | x86\_64, AArch64 | Also includes support for Rocky Linux and other ABI compatible RHEL derivatives |
64
-| Amazon Linux | 2023 | x86\_64, AArch64 | |
65
-| Amazon Linux | 2 | x86\_64, AArch64 | |
66
-| CentOS | 7.x | x86\_64 | |
67
-| Docker | 19.03 or newer | x86\_64, i386, ARMv7, AArch64, POWER8+ | See our [Docker documentation](/packaging/docker/README.md) for more info on using Netdata on Docker |
68
-| Debian | 12.x | x86\_64, i386, ARMv7, AArch64 | |
69
-| Debian | 11.x | x86\_64, i386, ARMv7, AArch64 | |
70
-| Fedora | 40 | x86\_64, AArch64 | |
71
-| Fedora | 39 | x86\_64, AArch64 | |
72
-| openSUSE | Leap 15.5 | x86\_64, AArch64 | |
73
-| openSUSE | Leap 15.4 | x86\_64, AArch64 | |
74
-| Oracle Linux | 9.x | x86\_64, AArch64 | |
75
-| Oracle Linux | 8.x | x86\_64, AArch64 | |
76
-| Red Hat Enterprise Linux | 9.x | x86\_64, AArch64 | |
77
-| Red Hat Enterprise Linux | 8.x | x86\_64, AArch64 | |
78
-| Red Hat Enterprise Linux | 7.x | x86\_64 | |
79
-| Ubuntu | 24.04 | x86\_64, AArch64, ARMv7 | |
80
-| Ubuntu | 22.04 | x86\_64, ARMv7, AArch64 | |
81
-| Ubuntu | 20.04 | x86\_64, ARMv7, AArch64 | |
82
-
48
+| Platform | Version | Official Native Packages | Notes |
49
+|--------------------------|----------------|----------------------------------------|----------------------------------------------------------------------------------------------------------------|
50
+| Alpine Linux | 3.18 | No | The latest release of Alpine Linux is guaranteed to remain at **Core** tier due to usage for our Docker images |
51
+| Alma Linux | 9.x | x86\_64, AArch64 | Also includes support for Rocky Linux and other ABI compatible RHEL derivatives |
52
+| Alma Linux | 8.x | x86\_64, AArch64 | Also includes support for Rocky Linux and other ABI compatible RHEL derivatives |
53
+| Amazon Linux | 2023 | x86\_64, AArch64 | |
54
+| Amazon Linux | 2 | x86\_64, AArch64 | |
55
+| CentOS | 7.x | x86\_64 | |
56
+| Docker | 19.03 or newer | x86\_64, i386, ARMv7, AArch64, POWER8+ | See our [Docker documentation](/packaging/docker/README.md) for more info on using Netdata on Docker |
57
+| Debian | 12.x | x86\_64, i386, ARMv7, AArch64 | |
58
+| Debian | 11.x | x86\_64, i386, ARMv7, AArch64 | |
59
+| Fedora | 40 | x86\_64, AArch64 | |
60
+| Fedora | 39 | x86\_64, AArch64 | |
61
+| openSUSE | Leap 15.5 | x86\_64, AArch64 | |
62
+| openSUSE | Leap 15.4 | x86\_64, AArch64 | |
63
+| Oracle Linux | 9.x | x86\_64, AArch64 | |
64
+| Oracle Linux | 8.x | x86\_64, AArch64 | |
65
+| Red Hat Enterprise Linux | 9.x | x86\_64, AArch64 | |
66
+| Red Hat Enterprise Linux | 8.x | x86\_64, AArch64 | |
67
+| Red Hat Enterprise Linux | 7.x | x86\_64 | |
68
+| Ubuntu | 24.04 | x86\_64, AArch64, ARMv7 | |
69
+| Ubuntu | 22.04 | x86\_64, ARMv7, AArch64 | |
70
+| Ubuntu | 20.04 | x86\_64, ARMv7, AArch64 | |
71
72
### Intermediate
73
@@ -106,16 +94,16 @@ to add support for a new platform, that platform generally will start in this ti
94
are expected to work on these platforms if available. Source-based installs are usually expected to work on these
95
platforms, but may require some extra effort from users.
96
109
-| Platform | Version | Official Native Packages | Notes |
110
-|--------------|------------|--------------------------|-----------------------------------------------------------------------------------------------------------|
111
-| Clear Linux | Latest | No | |
112
-| Debian | Sid | No | |
113
-| Fedora | Rawhide | No | |
114
-| FreeBSD | 13-STABLE | No | Netdata is included in the FreeBSD Ports Tree, and this is the recommended installation method on FreeBSD |
115
-| Gentoo | Latest | No | |
116
-| macOS | 13 | No | Currently only works for Intel-based hardware. Requires Homebrew for dependencies |
117
-| macOS | 12 | No | Currently only works for Intel-based hardware. Requires Homebrew for dependencies |
118
-| macOS | 11 | No | Currently only works for Intel-based hardware. Requires Homebrew for dependencies. |
97
+| Platform | Version | Official Native Packages | Notes |
98
+|-------------|-----------|--------------------------|-----------------------------------------------------------------------------------------------------------|
99
+| Clear Linux | Latest | No | |
100
+| Debian | Sid | No | |
101
+| Fedora | Rawhide | No | |
102
+| FreeBSD | 13-STABLE | No | Netdata is included in the FreeBSD Ports Tree, and this is the recommended installation method on FreeBSD |
103
+| Gentoo | Latest | No | |
104
+| macOS | 13 | No | Currently only works for Intel-based hardware. Requires Homebrew for dependencies |
105
+| macOS | 12 | No | Currently only works for Intel-based hardware. Requires Homebrew for dependencies |
106
+| macOS | 11 | No | Currently only works for Intel-based hardware. Requires Homebrew for dependencies. |
107
108
## Third-party supported platforms
109
packaging/VERSIONING_AND_PUBLIC_API.md
+5
-5
@@ -36,7 +36,7 @@ will be as up-to-date as possible.
36
Versions for nightly builds of the Netdata Agent consist of four parts, a major version, a minor version, a revision
37
number, and an optional commit ID, presented like `<major>.<minor>.0-<revision>-<commit>`. For example, a version
38
of `1.43.0-11-gb15437502` has a major version of 1, a minor version of 43, a revision of 11, and a commit ID of
39
-`gb15437502`. A commit ID consists of a lowercaase letter `g`, followed by the short commit hash for the corresponding
39
+`gb15437502`. A commit ID consists of a lowercase letter `g`, followed by the short commit hash for the corresponding
40
commit. If the commit ID is not included, it may be replaced by the word ‘nightly’.
41
42
The major and minor version numbers for a nightly build correspond exactly to an associated stable release. A
@@ -80,9 +80,9 @@ notes at least one minor release prior to being merged:
80
81
- All mandatory build dependencies which are not vendored in the Netdata Agent code. This includes, but is not
82
limited to:
83
- - The underlying build system (such as autotools or CMake).
84
- - Primary library dependencies (such as libuv).
85
- - Any external tooling that is required at build time.
83
+ - The underlying build system (such as autotools or CMake).
84
+ - Primary library dependencies (such as libuv).
85
+ - Any external tooling that is required at build time.
86
- The REST API provided by the Netdata Agent’s internal web server, accessible via the `/api` endpoint. This
87
does not extend to the charts, labels, or other system-specific data returned by some API endpoints.
88
- The protocol used for streaming and replicating data between Netdata Agents.
@@ -138,7 +138,7 @@ Any components which are not explicitly listed above as being part of the public
138
API. This includes, but is not limited to:
139
140
- Any mandatory build components which are vendored as part of the Netdata sources, such as SQLite3 or libJudy. This
141
- extends to both the presence or abscence of such components, as well as the exact version being bundled.
141
+ extends to both the presence or absence of such components, as well as the exact version being bundled.
142
- The exact installation mechanism that will be used on any given system when using our `kickstart.sh` installation
143
script.
144
- The exact underlying implementation of any data collection plugin.
packaging/building-native-packages-locally.md
+7
-7
@@ -39,16 +39,16 @@ inspect the state of the container and look at build logs.
39
40
### Detailed explanation
41
42
-The environments used for building our packages are fully self-contianed Docker images built from [Dockerfiles](https://github.com/netdata/helper-images/tree/master/package-builders)
42
+The environments used for building our packages are fully self-contained Docker images built from [Dockerfiles](https://github.com/netdata/helper-images/tree/master/package-builders)
43
These are published on Docker
44
Hub with the image name `netdata/package-builders`, and tagged using the name and version of the distribution
45
(with the tag corresponding to the suffix on the associated Dockerfile).
46
47
The build code expects the following requirements to be met:
48
49
-- It expects the source tree it should build from to be located at `/netdata`, and expects that said source tree
49
+* It expects the source tree it should build from to be located at `/netdata`, and expects that said source tree
50
is clean (no artifacts left over from previous builds).
51
-- It expects an environment variable named `VERSION` to be defined, and uses this to control what version number
51
+* It expects an environment variable named `VERSION` to be defined, and uses this to control what version number
52
will be shown in the package metadata and filenames.
53
54
Internally, the source tree gets copied to a temporary location for the build process so that the source tree can
@@ -95,7 +95,7 @@ Once you have that set up, the command to build the packages is the same as abov
95
`--platform` option to the `docker run` or `podman run` command. The current list of architectures we build for,
96
and the correct value for the `--platform` option is:
97
98
-- 32-bit ARMv7: `linux/arm/v7`
99
-- 64-bit ARMv8: `linux/arm64/v8`
100
-- 32-bit x86: `linux/i386`
101
-- 64-bit x86: `linux/amd64`
98
+* 32-bit ARMv7: `linux/arm/v7`
99
+* 64-bit ARMv8: `linux/arm64/v8`
100
+* 32-bit x86: `linux/i386`
101
+* 64-bit x86: `linux/amd64`
packaging/docker/README.md
+2
-13
@@ -1,12 +1,3 @@
1
-<!--
2
-title: "Install Netdata with Docker"
3
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/packaging/docker/README.md"
4
-sidebar_label: "Docker"
5
-learn_status: "Published"
6
-learn_rel_path: "Installation/Installation methods"
7
-sidebar_position: 40
8
--->
9
-
1
import Tabs from '@theme/Tabs';
2
import TabItem from '@theme/TabItem';
3
@@ -34,7 +25,7 @@ along with their descriptions.
25
<details open>
26
<summary>Privileges</summary>
27
37
-| Component | Privileges | Description |
28
+| Component | Privileges | Description |
29
|:---------------------:|:-----------------------------:|--------------------------------------------------------------------------------------------------------------------------|
30
| cgroups.plugin | host PID mode, SYS_ADMIN | Container network interfaces monitoring. Map virtual interfaces in the system namespace to interfaces inside containers. |
31
| proc.plugin | host network mode | Host system networking stack monitoring. |
@@ -47,7 +38,7 @@ along with their descriptions.
38
<details open>
39
<summary>Mounts</summary>
40
50
-| Component | Mounts | Description |
41
+| Component | Mounts | Description |
42
|:----------------------:|:--------------------------:|--------------------------------------------------------------------------------------------------------------------------------------------|
43
| netdata | /etc/os-release | Host info detection. |
44
| diskspace.plugin | / | Host mount points monitoring. |
@@ -177,14 +168,12 @@ Add `- /run/dbus:/run/dbus:ro` to the netdata service `volumes`.
168
169
### With NVIDIA GPUs monitoring
170
180
-
171
Monitoring NVIDIA GPUs requires:
172
173
- Using official [NVIDIA driver](https://www.nvidia.com/Download/index.aspx).
174
- Installing [NVIDIA Container Toolkit](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html).
175
- Allowing the Netdata container to access GPU resources.
176
187
-
177
<Tabs>
178
<TabItem value="docker_run" label="docker run">
179
packaging/installer/UNINSTALL.md
+9
-9
@@ -1,7 +1,7 @@
1
# Uninstall Netdata
2
3
-> ### Note
4
->
3
+> **Note**
4
+>
5
> If you're having trouble updating Netdata, moving from one installation method to another, or generally having
6
> issues with your Netdata Agent installation, consider our [reinstalling Netdata](/packaging/installer/REINSTALL.md) instead of removing the Netdata Agent entirely.
7
@@ -40,15 +40,15 @@ installation prefix it will usually be located in a similar place under that pre
40
41
A workflow for uninstallation looks like this:
42
43
-1. Find your `.environment` file, which is usually `/etc/netdata/.environment` in a default installation.
44
-2. If you cannot find that file and would like to uninstall Netdata, then create a new file with the following content:
43
+1. Find your `.environment` file, which is usually `/etc/netdata/.environment` in a default installation.
44
+2. If you cannot find that file and would like to uninstall Netdata, then create a new file with the following content:
45
46
-```sh
47
-NETDATA_PREFIX="<installation prefix>" # put what you used as a parameter to shell installed `--install-prefix` flag. Otherwise it should be empty
48
-NETDATA_ADDED_TO_GROUPS="<additional groups>" # Additional groups for a user running the Netdata process
49
-```
46
+ ```sh
47
+ NETDATA_PREFIX="<installation prefix>" # put what you used as a parameter to shell installed `--install-prefix` flag. Otherwise it should be empty
48
+ NETDATA_ADDED_TO_GROUPS="<additional groups>" # Additional groups for a user running the Netdata process
49
+ ```
50
51
-3. Run `netdata-uninstaller.sh` as follows
51
+3. Run `netdata-uninstaller.sh` as follows
52
53
3.1 **Interactive mode (Default)**
54
packaging/installer/UPDATE.md
+6
-7
@@ -13,15 +13,15 @@ icon in the local Agent dashboard's top navigation. This modal informs you wheth
13
14
The exact update method to use depends on the install type:
15
16
-- Installs with an install type of 'custom' usually indicate installing a third-party package through the system
16
+- Installs with an install type of 'custom' usually indicate installing a third-party package through the system
17
package manager. To update these installs, you should update the package just like you would any other package
18
on your system.
19
-- Installs with an install type starting with `binpkg` or ending with `build` or `static` can be updated using
19
+- Installs with an install type starting with `binpkg` or ending with `build` or `static` can be updated using
20
our [regular update method](#updates-for-most-systems).
21
-- Installs with an install type of 'oci' were created from our official Docker images, and should be updated
21
+- Installs with an install type of 'oci' were created from our official Docker images, and should be updated
22
using our [Docker](#docker) update procedure.
23
-- macOS users should check [our update instructions for macOS](#macos).
24
-- Manually built installs should check [our update instructions for manual builds](#manual-installation-from-git).
23
+- macOS users should check [our update instructions for macOS](#macos).
24
+- Manually built installs should check [our update instructions for manual builds](#manual-installation-from-git).
25
26
## Determine which installation method you used
27
@@ -46,7 +46,6 @@ The following table contains all possible installation types:
46
| custom | Anything not covered by the other identifiers, including manual builds, manually running netdata-installer.sh, and third-party packages (community). |
47
| Unknown | Same as custom. |
48
49
-
49
If you are using an older version of Netdata, or the above command produces no output, you can run our one-line
50
installation script in dry-run mode to attempt to determine what method to use to update by running the following
51
command:
@@ -189,7 +188,7 @@ and:
188
/opt/netdata/usr/libexec/netdata/netdata-updater.sh --disable-auto-updates
189
```
190
192
-## Control runtime behavior of the updater script.
191
+## Control runtime behavior of the updater script
192
193
Starting with v1.40.0, the `netdata-updater.sh` script supports a config file called `netdata-updater.conf`,
194
located in the same directory as the main `netdata.conf` file. This file uses POSIX shell script syntax to define
packaging/installer/methods/ansible.md
+7
-17
@@ -1,13 +1,3 @@
1
-<!--
2
-title: "Deploy Netdata with Ansible"
3
-description: "Deploy an infrastructure monitoring solution in minutes with the Netdata Agent and Ansible. Use and customize a simple playbook for monitoring as code."
4
-image: /img/seo/guides/deploy/ansible.png
5
-custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/ansible.md
6
-sidebar_label: "Ansible"
7
-learn_status: "Published"
8
-learn_rel_path: "Installation/Install on specific environments"
9
--->
10
-
1
# Deploy Netdata with Ansible
2
3
Netdata's [one-line kickstart](/packaging/installer/README.md) is zero-configuration, highly adaptable, and compatible with tons
@@ -22,7 +12,7 @@ code?
12
Enter [Ansible](https://ansible.com), a popular system provisioning, configuration management, and infrastructure as
13
code (IaC) tool. Ansible uses **playbooks** to glue many standardized operations together with a simple syntax, then run
14
those operations over standard and secure SSH connections. There's no agent to install on the remote system, so all you
25
-have to worry about is your application and your monitoring software.
15
+have to worry about is your application and your monitoring software.
16
17
Ansible has some competition from the likes of [Puppet](https://puppet.com/) or [Chef](https://www.chef.io/), but the
18
most valuable feature about Ansible is **idempotent**. From the [Ansible
@@ -42,9 +32,9 @@ minutes.
32
33
## Prerequisites
34
45
-- A Netdata Cloud account. [Sign in and create one](https://app.netdata.cloud) if you don't have one already.
46
-- An administration system with [Ansible](https://www.ansible.com/) installed.
47
-- One or more nodes that your administration system can access via [SSH public
35
+- A Netdata Cloud account. [Sign in and create one](https://app.netdata.cloud) if you don't have one already.
36
+- An administration system with [Ansible](https://www.ansible.com/) installed.
37
+- One or more nodes that your administration system can access via [SSH public
38
keys](https://git-scm.com/book/en/v2/Git-on-the-Server-Generating-Your-SSH-Public-Key) (preferably password-less).
39
40
## Download and configure the playbook
@@ -71,7 +61,7 @@ cd ansible-quickstart
61
62
The `hosts` file contains a list of IP addresses or hostnames that Ansible will try to run the playbook against. The
63
`hosts` file that comes with the repository contains two example IP addresses, which you should replace according to the
74
-IP address/hostname of your nodes.
64
+IP address/hostname of your nodes.
65
66
```conf
67
203.0.113.0 hostname=node-01
@@ -110,7 +100,7 @@ and `claim_room` variables.
100
101
To find your `claim_token` and `claim_room`, go to Netdata Cloud, then click on your Space's name in the top navigation,
102
then click on **Manage your Space**. Click on the **Nodes** tab in the panel that appears, which displays a script with
113
-`token` and `room` strings.
103
+`token` and `room` strings.
104
105
@@ -123,7 +113,7 @@ claim_rooms: XXXXX
113
```
114
115
Change the `dbengine_multihost_disk_space` if you want to change the metrics retention policy by allocating more or less
126
-disk space for storing metrics. The default is 2048 Mib, or 2 GiB.
116
+disk space for storing metrics. The default is 2048 Mib, or 2 GiB.
117
118
Because we're connecting this node to Netdata Cloud, and will view its dashboards there instead of via the IP address or
119
hostname of the node, the playbook disables that local dashboard by setting `web_mode` to `none`. This gives a small
packaging/installer/methods/aws.md
+5
-14
@@ -1,12 +1,3 @@
1
-<!--
2
-title: "Install Netdata on AWS"
3
-description: "The Netdata Agent runs on all popular cloud providers, but often requires additional steps and configuration for full functionality."
4
-custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/aws.md
5
-sidebar_label: "AWS"
6
-learn_status: "Published"
7
-learn_rel_path: "Installation/Install on specific environments"
8
--->
9
-
1
# Install Netdata on AWS
2
3
Netdata is fully compatible with Amazon Web Services (AWS).
@@ -41,11 +32,11 @@ command from a remote system, and it fails, it's likely that a firewall is block
32
Another option is to put Netdata behind web server, which will proxy requests through standard HTTP/HTTPS ports
33
(80/443), which are likely already open on your instance. We have a number of guides available:
34
44
-- [Apache](/docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-apache.md)
45
-- [Nginx](/docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-nginx.md)
46
-- [Caddy](/docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-caddy.md)
47
-- [HAProxy](/docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-haproxy.md)
48
-- [lighttpd](/docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-lighttpd.md)
35
+- [Apache](/docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-apache.md)
36
+- [Nginx](/docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-nginx.md)
37
+- [Caddy](/docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-caddy.md)
38
+- [HAProxy](/docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-haproxy.md)
39
+- [lighttpd](/docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-lighttpd.md)
40
41
Sign in to the [AWS console](https://console.aws.amazon.com/) and navigate to the EC2 dashboard. Click on the **Security
42
Groups** link in the navigation, beneath the **Network & Security** heading. Find the Security Group your instance
packaging/installer/methods/azure.md
+6
-17
@@ -1,15 +1,6 @@
1
-<!--
2
-title: "Install Netdata on Azure"
3
-description: "The Netdata Agent runs on all popular cloud providers, but often requires additional steps and configuration for full functionality."
4
-custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/azure.md
5
-sidebar_label: "Azure"
6
-learn_status: "Published"
7
-learn_rel_path: "Installation/Install on specific environments"
8
--->
9
-
1
# Install Netdata on Azure
2
12
-Netdata is fully compatible with Azure.
3
+Netdata is fully compatible with Azure.
4
You can install Netdata on cloud instances to monitor the apps/services running there, or use
5
multiple instances in a [parent-child streaming](/src/streaming/README.md) configuration.
6
@@ -41,11 +32,11 @@ command from a remote system, and it fails, it's likely that a firewall is block
32
Another option is to put Netdata behind web server, which will proxy requests through standard HTTP/HTTPS ports
33
(80/443), which are likely already open on your instance. We have a number of guides available:
34
44
-- [Apache](/docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-apache.md)
45
-- [Nginx](/docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-nginx.md)
46
-- [Caddy](/docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-caddy.md)
47
-- [HAProxy](/docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-haproxy.md)
48
-- [lighttpd](/docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-lighttpd.md)
35
+- [Apache](/docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-apache.md)
36
+- [Nginx](/docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-nginx.md)
37
+- [Caddy](/docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-caddy.md)
38
+- [HAProxy](/docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-haproxy.md)
39
+- [lighttpd](/docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-lighttpd.md)
40
41
Sign in to the [Azure portal](https://portal.azure.com) and open the virtual machine running Netdata. Click on the
42
**Networking** link beneath the **Settings** header, then click on the **Add inbound security rule** button.
@@ -64,5 +55,3 @@ Name: Netdata
55
```
56
57
Click **Add** to apply your new inbound security rule.
67
-
68
-
packaging/installer/methods/freebsd.md
+12
-19
@@ -1,12 +1,3 @@
1
-<!--
2
-title: "Install Netdata on FreeBSD"
3
-description: "Install Netdata on FreeBSD to monitor the health and performance of bare metal or VMs with thousands of real-time, per-second metrics."
4
-custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/freebsd.md
5
-sidebar_label: "FreeBSD"
6
-learn_status: "Published"
7
-learn_rel_path: "Installation/Install on specific environments"
8
--->
9
-
1
# Install Netdata on FreeBSD
2
3
> 💡 This document is maintained by Netdata's community, and may not be completely up-to-date. Please double-check the
@@ -24,7 +15,7 @@ This step needs root privileges.
15
pkg install bash e2fsprogs-libuuid git curl autoconf automake pkgconf pidof liblz4 libuv json-c cmake gmake
16
```
17
27
-Please respond in the affirmative for any relevant prompts during the installation process.
18
+Please respond in the affirmative for any relevant prompts during the installation process.
19
20
## Install Netdata
21
@@ -35,9 +26,10 @@ If you have a Netdata cloud account then clicking on the **Connect Nodes** butto
26
```sh
27
wget -O /tmp/netdata-kickstart.sh https://get.netdata.cloud/kickstart.sh && sh /tmp/netdata-kickstart.sh --claim-token <CLAIM_TOKEN> --claim-url https://app.netdata.cloud
28
```
38
-Please respond in the affirmative for any relevant prompts during the installation process.
29
40
-Once the installation is completed, you should be able to start monitoring the FreeBSD server using Netdata.
30
+Please respond in the affirmative for any relevant prompts during the installation process.
31
+
32
+Once the installation is completed, you should be able to start monitoring the FreeBSD server using Netdata.
33
34
Netdata can also be installed via [FreeBSD ports](https://www.freshports.org/net-mgmt/netdata).
35
@@ -89,7 +81,8 @@ more about the information collected and how to opt-out, check the [anonymous st
81
page](/docs/netdata-agent/configuration/anonymous-telemetry-events.md).
82
83
## Updating the Agent on FreeBSD
92
-If you have not passed the `--auto-update` or `-u` parameter for the installer to enable automatic updating, repeat the last step to update Netdata whenever a new version becomes available.
84
+
85
+If you have not passed the `--auto-update` or `-u` parameter for the installer to enable automatic updating, repeat the last step to update Netdata whenever a new version becomes available.
86
The `netdata-updater.sh` script will update your Agent.
87
88
## Optional parameters to alter your installation
@@ -102,9 +95,9 @@ The `kickstart.sh` script accepts a number of optional parameters to control how
95
- `--dry-run`: Show what the installer would do, but don’t actually do any of it.
96
- `--dont-start-it`: Don’t auto-start the daemon after installing. This parameter is not guaranteed to work.
97
- `--release-channel`: Specify a particular release channel to install from. Currently supported release channels are:
105
- - `nightly`: Installs a nightly build (this is currently the default).
106
- - `stable`: Installs a stable release.
107
- - `default`: Explicitly request whatever the current default is.
98
+ - `nightly`: Installs a nightly build (this is currently the default).
99
+ - `stable`: Installs a stable release.
100
+ - `default`: Explicitly request whatever the current default is.
101
- `--nightly-channel`: Synonym for `--release-channel nightly`.
102
- `--stable-channel`: Synonym for `--release-channel stable`.
103
- `--auto-update`: Enable automatic updates (this is the default).
@@ -119,15 +112,15 @@ The `kickstart.sh` script accepts a number of optional parameters to control how
112
- `--local-build-options`: Specify additional options to pass to the installer code when building locally. Only valid if `--build-only` is also specified.
113
- `--static-install-options`: Specify additional options to pass to the static installer code. Only valid if --static-only is also specified.
114
122
-The following options are mutually exclusive and specifiy special operations other than trying to install Netdata normally or update an existing install:
115
+The following options are mutually exclusive and specify special operations other than trying to install Netdata normally or update an existing install:
116
117
- `--reinstall`: If there is an existing install, reinstall it instead of trying to update it. If there is not an existing install, install netdata normally.
125
-- `--reinstall-even-if-unsafe`: If there is an existing install, reinstall it instead of trying to update it, even if doing so is known to potentially break things (for example, if we cannot detect what tyep of installation it is). If there is not an existing install, install Netdata normally.
118
+- `--reinstall-even-if-unsafe`: If there is an existing install, reinstall it instead of trying to update it, even if doing so is known to potentially break things (for example, if we cannot detect what type of installation it is). If there is not an existing install, install Netdata normally.
119
- `--reinstall-clean`: If there is an existing install, uninstall it before trying to install Netdata. Fails if there is no existing install.
120
- `--uninstall`: Uninstall an existing installation of Netdata. Fails if there is no existing install.
121
- `--claim-only`: If there is an existing install, only try to claim it without attempting to update it. If there is no existing install, install and claim Netdata normally.
122
- `--repositories-only`: Only install repository configuration packages instead of doing a full install of Netdata. Automatically sets --native-only.
130
-- `--prepare-offline-install-source`: Instead of insallling the agent, prepare a directory that can be used to install on another system without needing to download anything. See our [offline installation documentation](/packaging/installer/methods/offline.md) for more info.
123
+- `--prepare-offline-install-source`: Instead of installing the agent, prepare a directory that can be used to install on another system without needing to download anything. See our [offline installation documentation](/packaging/installer/methods/offline.md) for more info.
124
125
Additionally, the following environment variables may be used to further customize how the script runs (most users
126
should not need to use special values for any of these):
packaging/installer/methods/gcp.md
+5
-17
@@ -1,13 +1,3 @@
1
-<!--
2
-title: "Install Netdata on GCP"
3
-description: "The Netdata Agent runs on all popular cloud providers, but often requires additional steps and configuration for full functionality."
4
-custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/gcp.md
5
-sidebar_label: "GCP"
6
-learn_status: "Published"
7
-learn_topic_type: "Tasks"
8
-learn_rel_path: "Installation/Install on specific environments"
9
--->
10
-
1
# Install Netdata on GCP
2
3
Netdata is fully compatible with the Google Cloud Platform (GCP).
@@ -42,12 +32,11 @@ command from a remote system, and it fails, it's likely that a firewall is block
32
Another option is to put Netdata behind web server, which will proxy requests through standard HTTP/HTTPS ports
33
(80/443), which are likely already open on your instance. We have a number of guides available:
34
45
-- [Apache](/docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-apache.md)
46
-- [Nginx](/docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-nginx.md)
47
-- [Caddy](/docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-caddy.md)
48
-- [HAProxy](/docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-haproxy.md)
49
-- [lighttpd](/docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-lighttpd.md)
50
-
35
+- [Apache](/docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-apache.md)
36
+- [Nginx](/docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-nginx.md)
37
+- [Caddy](/docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-caddy.md)
38
+- [HAProxy](/docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-haproxy.md)
39
+- [lighttpd](/docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-lighttpd.md)
40
41
To add a firewall rule, go to the [Firewall rules page](https://console.cloud.google.com/networking/firewalls/list) and
42
click **Create firewall rule**.
@@ -67,4 +56,3 @@ Priority: 1000
56
57
Read GCP's [firewall documentation](https://cloud.google.com/vpc/docs/using-firewalls) for specific instructions on how
58
to create a new firewall rule.
70
-
packaging/installer/methods/kickstart.md
+3
-3
@@ -5,7 +5,7 @@ import TabItem from '@theme/TabItem';
5
6
# Install Netdata with kickstart.sh
7
8
- 
8
+ 
9
10
`kickstart.sh` is the recommended way of installing Netdata.
11
@@ -242,7 +242,7 @@ By default, the kickstart script will provide a Netdata agent installation that
242
- `--claim-rooms`
243
Specify a comma-separated list of tokens for each Room this node should appear in.
244
- `--claim-proxy`
245
- Specify a proxy to use when connecting to the cloud in the form of `http://[user:pass@]host:ip` for an HTTP(S) proxy. See [connecting through a proxy](/src/claim/README.md#connect-through-a-proxy) for details.
245
+ Specify a proxy to use when connecting to the cloud in the form of `http://[user:pass@]host:ip` for an HTTP(S) proxy. See [connecting through a proxy](/src/claim/README.md#automatically-via-a-provisioning-system-or-the-command-line) for details.
246
- `--claim-only`
247
If there is an existing install, only try to claim it without attempting to update it. If there is no existing install, install and claim Netdata normally.
248
@@ -281,7 +281,7 @@ The following options are mutually exclusive and specify special operations othe
281
- `--repositories-only`
282
Only install repository configuration packages instead of doing a full install of Netdata. Automatically sets --native-only.
283
- `--prepare-offline-install-source`
284
- Instead of insallling the agent, prepare a directory that can be used to install on another system without needing to download anything. See our [offline installation documentation](/packaging/installer/methods/offline.md) for more info.
284
+ Instead of installing the agent, prepare a directory that can be used to install on another system without needing to download anything. See our [offline installation documentation](/packaging/installer/methods/offline.md) for more info.
285
286
### environment variables
287
packaging/installer/methods/kubernetes.md
+49
-59
@@ -35,21 +35,21 @@ The installation process securely connects your Kubernetes cluster to stream met
35
36
1. Add the Netdata Helm chart repository by running:
37
38
- ```bash
39
- helm repo add netdata https://netdata.github.io/helmchart/
40
- ```
38
+ ```bash
39
+ helm repo add netdata https://netdata.github.io/helmchart/
40
+ ```
41
42
2. To install Netdata using the `helm install` command, run:
43
44
- ```bash
45
- helm install netdata netdata/netdata
46
- ```
44
+ ```bash
45
+ helm install netdata netdata/netdata
46
+ ```
47
48
- > ### Note
49
- >
50
- > If you plan to connect the node to Netdata Cloud, you can find the command with the right parameters by clicking the "Add Nodes" button in your Space's Nodes tab.
48
+ > **Note**
49
+ >
50
+ > If you plan to connect the node to Netdata Cloud, you can find the command with the right parameters by clicking the "Add Nodes" button in your Space's Nodes tab.
51
52
- For more installation options, please read our [Netdata Helm chart for Kubernetes](https://github.com/netdata/helmchart/blob/master/charts/netdata/README.md) reference.
52
+ For more installation options, please read our [Netdata Helm chart for Kubernetes](https://github.com/netdata/helmchart/blob/master/charts/netdata/README.md) reference.
53
54
#### Expected Result
55
@@ -66,50 +66,50 @@ On an existing installation, in order to connect it to Netdata Cloud you will ne
66
67
1. You can start with creating a file called `override.yml`
68
69
- ```bash
70
- touch override.yml
71
- ```
72
-
69
+ ```bash
70
+ touch override.yml
71
+ ```
72
+
73
2. Paste the following into your `override.yml` file.
74
75
- ```yaml
76
- parent:
77
- claiming:
78
- enabled: true
79
- token: YOUR_CLAIM_TOKEN
80
- rooms: YOUR_ROOM_ID_A,YOUR_ROOM_ID_B
81
-
82
- child:
83
- claiming:
84
- enabled: true
85
- token: YOUR_CLAIM_TOKEN
86
- rooms: YOUR_ROOM_ID_A,YOUR_ROOM_ID_B
87
- configs:
88
- netdata:
89
- data: |
90
- [db]
91
- db = ram
92
- retention = 3600
93
- [health]
94
- enabled = no
95
- ```
96
-
97
- > :bookmark_tabs: Note
98
- >
99
- > Make sure to replace `YOUR_CLAIM_TOKEN` with the claim token of your space,
100
- > and `YOUR_ROOM_ID` with the ID of the Room you are willing to connect to.
101
-
102
- These settings connect your `parent`/`child` nodes to Netdata Cloud and store more metrics in the nodes' time-series databases.
103
-
104
- > :bookmark_tabs: Info
105
- >
106
- > These override settings, along with the Helm chart's defaults, will retain an hour's worth of metrics (`retention = 3600`, or `3600 seconds`) on each child node. Based on your metrics retention needs, and the resources available on your cluster, you may want to increase the `history` setting.
75
+ ```yaml
76
+ parent:
77
+ claiming:
78
+ enabled: true
79
+ token: YOUR_CLAIM_TOKEN
80
+ rooms: YOUR_ROOM_ID_A,YOUR_ROOM_ID_B
81
+
82
+ child:
83
+ claiming:
84
+ enabled: true
85
+ token: YOUR_CLAIM_TOKEN
86
+ rooms: YOUR_ROOM_ID_A,YOUR_ROOM_ID_B
87
+ configs:
88
+ netdata:
89
+ data: |
90
+ [db]
91
+ db = ram
92
+ retention = 3600
93
+ [health]
94
+ enabled = no
95
+ ```
96
+
97
+ > **Note**
98
+ >
99
+ > Make sure to replace `YOUR_CLAIM_TOKEN` with the claim token of your space,
100
+ > and `YOUR_ROOM_ID` with the ID of the Room you are willing to connect to.
101
+
102
+ These settings connect your `parent`/`child` nodes to Netdata Cloud and store more metrics in the nodes' time-series databases.
103
+
104
+ > **Info**
105
+ >
106
+ > These override settings, along with the Helm chart's defaults, will retain an hour's worth of metrics (`retention = 3600`, or `3600 seconds`) on each child node. Based on your metrics retention needs, and the resources available on your cluster, you may want to increase the `history` setting.
107
108
3. To apply these new settings, run:
109
110
- ```bash
111
- helm upgrade -f override.yml netdata netdata/netdata
112
- ```
110
+ ```bash
111
+ helm upgrade -f override.yml netdata netdata/netdata
112
+ ```
113
114
#### Expected Result
115
@@ -188,13 +188,3 @@ To update Netdata's Helm chart to the latest version, run `helm repo update`, th
188
helm repo update
189
helm upgrade netdata netdata/netdata
190
```
191
-
192
-## What's next?
193
-
194
-[Start Kubernetes monitoring](/docs/dashboards-and-charts/kubernetes-tab.md) in Netdata Cloud, which comes with meaningful visualizations out of the box.
195
-
196
-### Related reference documentation
197
-
198
-- [Netdata Cloud · Kubernetes monitoring](/docs/dashboards-and-charts/kubernetes-tab.md)
199
-- [Netdata Helm chart](https://github.com/netdata/helmchart)
200
-- [Netdata service discovery](https://github.com/netdata/agent-service-discovery/)
packaging/installer/methods/macos.md
+24
-26
@@ -1,39 +1,33 @@
1
-<!--
2
-title: "Install Netdata on macOS"
3
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/packaging/installer/methods/macos.md"
4
-sidebar_label: "macOS"
5
-learn_status: "Published"
6
-learn_rel_path: "Installation/Install on specific environments"
7
--->
8
-
1
# Install Netdata on macOS
2
11
-Netdata works on macOS, albeit with some limitations.
12
-The number of charts displaying system metrics is limited, but you can use any of Netdata's [external plugins](/src/plugins.d/README.md) to monitor any services you might have installed on your macOS system.
3
+Netdata works on macOS, albeit with some limitations.
4
+The number of charts displaying system metrics is limited, but you can use any of Netdata's [external plugins](/src/plugins.d/README.md) to monitor any services you might have installed on your macOS system.
5
You could also use a macOS system as the parent node in a [streaming configuration](/src/streaming/README.md).
6
15
-You can install Netdata in one of the three following ways:
7
+You can install Netdata in one of the three following ways:
8
17
-- **[Install Netdata with the our automatic one-line installation script (recommended)](#install-netdata-with-our-automatic-one-line-installation-script)**,
9
+- **[Install Netdata with the our automatic one-line installation script (recommended)](#install-netdata-with-our-automatic-one-line-installation-script)**,
10
- [Install Netdata via Homebrew](#install-netdata-via-homebrew)
11
- [Install Netdata from source](#install-netdata-from-source)
12
21
-Each of these installation option requires [Homebrew](https://brew.sh/) for handling dependencies.
13
+Each of these installation option requires [Homebrew](https://brew.sh/) for handling dependencies.
14
15
> The Netdata Homebrew package is community-created and -maintained.
16
> Community-maintained packages _may_ receive support from Netdata, but are only a best-effort affair. Learn more about [Netdata's platform support policy](/docs/netdata-agent/versions-and-platforms.md).
17
18
## Install Netdata with our automatic one-line installation script
19
28
-**Local Netdata Agent installation**
29
-To install Netdata using our automatic [kickstart](/packaging/installer/README.md#automatic-one-line-installation-script) open a new terminal and run:
20
+### Local Netdata Agent installation
21
+
22
+To install Netdata using our automatic [kickstart](/packaging/installer/methods/kickstart.md) open a new terminal and run:
23
24
```bash
25
curl https://get.netdata.cloud/kickstart.sh > /tmp/netdata-kickstart.sh && sh /tmp/netdata-kickstart.sh
26
```
27
+
28
The Netdata Agent is installed under `/usr/local/netdata`. Dependencies are handled via Homebrew.
29
36
-**Automatically connect to Netdata Cloud during installation**
30
+### Automatically connect to Netdata Cloud during installation
31
32
The `kickstart.sh` script accepts additional parameters to automatically [connect](/src/claim/README.md) your node to Netdata
33
Cloud immediately after installation. Find the `token` and `rooms` strings by [signing in to Netdata
@@ -44,38 +38,42 @@ area](/docs/netdata-cloud/organize-your-infrastructure-invite-your-team.md#netda
38
after the install.
39
- `--claim-rooms`: Specify a comma-separated list of tokens for each Room this node should appear in.
40
- `--claim-proxy`: Specify a proxy to use when connecting to the cloud in the form of `http://[user:pass@]host:ip` for an HTTP(S) proxy.
47
- See [connecting through a proxy](/src/claim/README.md#connect-through-a-proxy) for details.
41
+ See [connecting through a proxy](/src/claim/README.md#automatically-via-a-provisioning-system-or-the-command-line) for details.
42
- `--claim-url`: Specify a URL to use when connecting to the cloud. Defaults to `https://app.netdata.cloud`.
43
50
-For example:
44
+For example:
45
+
46
```bash
47
curl https://get.netdata.cloud/kickstart.sh > /tmp/netdata-kickstart.sh && sh /tmp/netdata-kickstart.sh --install-prefix /usr/local/ --claim-token TOKEN --claim-rooms ROOM1,ROOM2 --claim-url https://app.netdata.cloud
48
```
49
+
50
The Netdata Agent is installed under `/usr/local/netdata` on your machine. Your machine will also show up as a node in your Netdata Cloud.
51
56
-If you experience issues while claiming your node, follow the steps in our [Troubleshooting](/src/claim/README.md#troubleshooting) documentation.
52
+If you experience issues while claiming your node, follow the steps in our [Troubleshoot](/src/claim/README.md#troubleshoot) documentation.
53
+
54
## Install Netdata via Homebrew
55
56
### For macOS Intel
57
61
-To install Netdata and all its dependencies, run Homebrew using the following command:
58
+To install Netdata and all its dependencies, run Homebrew using the following command:
59
60
```sh
61
brew install netdata
62
```
66
-Homebrew will place your Netdata configuration directory at `/usr/local/etc/netdata/`.
63
+
64
+Homebrew will place your Netdata configuration directory at `/usr/local/etc/netdata/`.
65
66
Use the `edit-config` script and the files in this directory to configure Netdata. For reference, you can find stock configuration files at `/usr/local/Cellar/netdata/{NETDATA_VERSION}/lib/netdata/conf.d/`.
67
68
### For Apple Silicon
69
72
-To install Netdata and all its dependencies, run Homebrew using the following command:
70
+To install Netdata and all its dependencies, run Homebrew using the following command:
71
72
```sh
73
brew install netdata
74
```
75
78
-Homebrew will place your Netdata configuration directory at `/opt/homebrew/etc/netdata/`.
76
+Homebrew will place your Netdata configuration directory at `/opt/homebrew/etc/netdata/`.
77
78
Use the `edit-config` script and the files in this directory to configure Netdata. For reference, you can find stock configuration files at `/opt/homebrew/Cellar/netdata/{NETDATA_VERSION}/lib/netdata/conf.d/`.
79
@@ -89,13 +87,13 @@ We don't recommend installing Netdata from source on macOS, as it can be difficu
87
xcode-select --install
88
```
89
92
-2. Click **Install** on the Software Update popup window that appears.
90
+2. Click **Install** on the Software Update popup window that appears.
91
3. Use the same terminal session to install some of Netdata's prerequisites using Homebrew. If you don't want to use [Netdata Cloud](/docs/netdata-cloud/README.md), you can omit `cmake`.
92
93
```bash
94
brew install ossp-uuid autoconf automake pkg-config libuv lz4 json-c openssl libtool cmake
95
```
98
-
96
+
97
4. Download Netdata from our GitHub repository:
98
99
```bash
@@ -109,6 +107,6 @@ We don't recommend installing Netdata from source on macOS, as it can be difficu
107
sudo ./netdata-installer.sh --install-prefix /usr/local
108
```
109
112
-> Your Netdata configuration directory will be at `/usr/local/netdata/`.
110
+> Your Netdata configuration directory will be at `/usr/local/netdata/`.
111
> Your stock configuration directory will be at `/usr/local/lib/netdata/conf.d/`.
112
> The installer will also install a startup plist to start Netdata when your macOS system boots.
packaging/installer/methods/manual.md
+59
-73
@@ -1,22 +1,12 @@
1
-<!--
2
-title: "Install Netdata on Linux from a Git checkout"
3
-description: "Use the Netdata Agent source code from GitHub, plus helper scripts to set up your system, to install Netdata without packages or binaries."
4
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/packaging/installer/methods/manual.md"
5
-sidebar_label: "From a Git checkout"
6
-learn_status: "Published"
7
-learn_rel_path: "Installation/Installation methods"
8
-sidebar_position: 30
9
--->
10
-
1
# Install Netdata on Linux from a Git checkout
2
3
To install the latest git version of Netdata, please follow these 2 steps:
4
15
-1. [Prepare your system](#prepare-your-system)
5
+1. [Prepare your system](#prepare-your-system)
6
7
Install the required packages on your system.
8
19
-2. [Install Netdata](#install-netdata)
9
+2. [Install Netdata](#install-netdata)
10
11
Download and install Netdata. You can also update it the same way.
12
@@ -29,23 +19,23 @@ Use our automatic requirements installer (_no need to be `root`_), which attempt
19
should be installed on your system to build and run Netdata. It supports a large variety of major Linux distributions
20
and other operating systems and is regularly tested. You can find this tool [here](https://raw.githubusercontent.com/netdata/netdata/master/packaging/installer/install-required-packages.sh) or run it directly with `bash <(curl -sSL https://raw.githubusercontent.com/netdata/netdata/master/packaging/installer/install-required-packages.sh)`. Otherwise read on for how to get requires packages manually:
21
32
-- **Alpine** Linux and its derivatives
33
- - You have to install `bash` yourself, before using the installer.
22
+- **Alpine** Linux and its derivatives
23
+ - You have to install `bash` yourself, before using the installer.
24
35
-- **Gentoo** Linux and its derivatives
25
+- **Gentoo** Linux and its derivatives
26
37
-- **Debian** Linux and its derivatives (including **Ubuntu**, **Mint**)
27
+- **Debian** Linux and its derivatives (including **Ubuntu**, **Mint**)
28
39
-- **Red Hat Enterprise Linux** and its derivatives (including **Fedora**, **CentOS**, **Amazon Machine Image**)
40
- - Please note that for RHEL/CentOS you need
29
+- **Red Hat Enterprise Linux** and its derivatives (including **Fedora**, **CentOS**, **Amazon Machine Image**)
30
+ - Please note that for RHEL/CentOS you need
31
[EPEL](http://www.tecmint.com/how-to-enable-epel-repository-for-rhel-centos-6-5/).
32
In addition, RHEL/CentOS version 6 also need
33
[OKay](https://okay.com.mx) for package libuv version 1.
44
- - CentOS 8 / RHEL 8 requires a bit of extra work. See the dedicated section below.
34
+ - CentOS 8 / RHEL 8 requires a bit of extra work. See the dedicated section below.
35
46
-- **SUSE** Linux and its derivatives (including **openSUSE**)
36
+- **SUSE** Linux and its derivatives (including **openSUSE**)
37
48
-- **SLE12** Must have your system registered with SUSE Customer Center or have the DVD. See
38
+- **SLE12** Must have your system registered with SUSE Customer Center or have the DVD. See
39
[#1162](https://github.com/netdata/netdata/issues/1162)
40
41
Install the packages for having a **basic Netdata installation** (system monitoring and many applications, without `mysql` / `mariadb`, `named`, hardware sensors and `SNMP`):
@@ -85,51 +75,51 @@ zypper install zlib-devel libuuid-devel libuv-devel liblz4-devel libopenssl-deve
75
76
Once Netdata is compiled, to run it the following packages are required (already installed using the above commands):
77
88
-| package | description|
89
-|:-----:|-----------|
90
-| `libuuid` | part of `util-linux` for GUIDs management|
91
-| `zlib` | gzip compression for the internal Netdata web server|
92
-| `libuv` | Multi-platform support library with a focus on asynchronous I/O, version 1 or greater|
78
+| package | description |
79
+|:---------:|---------------------------------------------------------------------------------------|
80
+| `libuuid` | part of `util-linux` for GUIDs management |
81
+| `zlib` | gzip compression for the internal Netdata web server |
82
+| `libuv` | Multi-platform support library with a focus on asynchronous I/O, version 1 or greater |
83
94
-*Netdata will fail to start without the above.*
84
+_Netdata will fail to start without the above._
85
86
Netdata plugins and various aspects of Netdata can be enabled or benefit when these are installed (they are optional):
87
98
-| package |description|
99
-|:-----:|-----------|
100
-| `bash`|for shell plugins and **alert notifications**|
101
-| `curl`|for shell plugins and **alert notifications**|
102
-| `iproute` or `iproute2`|for monitoring **Linux traffic QoS**<br/>use `iproute2` if `iproute` reports as not available or obsolete|
103
-| `python`|for most of the external plugins|
104
-| `python-yaml`|used for monitoring **beanstalkd**|
105
-| `python-beanstalkc`|used for monitoring **beanstalkd**|
106
-| `python-mysqldb`<br/>or<br/>`python-pymysql`|used for monitoring **mysql** or **mariadb** databases<br/>`python-mysqldb` is a lot faster and thus preferred|
107
-| `nodejs`|used for `node.js` plugins for monitoring **named** and **SNMP** devices|
108
-| `lm-sensors`|for monitoring **hardware sensors**|
109
-| `libelf`|for monitoring kernel-level metrics using eBPF|
110
-| `libmnl`|for collecting netfilter metrics|
111
-| `netcat`|for shell plugins to collect metrics from remote systems|
112
-
113
-*Netdata will greatly benefit if you have the above packages installed, but it will still work without them.*
88
+| package | description |
89
+|:--------------------------------------------:|----------------------------------------------------------------------------------------------------------------|
90
+| `bash` | for shell plugins and **alert notifications** |
91
+| `curl` | for shell plugins and **alert notifications** |
92
+| `iproute` or `iproute2` | for monitoring **Linux traffic QoS**<br/>use `iproute2` if `iproute` reports as not available or obsolete |
93
+| `python` | for most of the external plugins |
94
+| `python-yaml` | used for monitoring **beanstalkd** |
95
+| `python-beanstalkc` | used for monitoring **beanstalkd** |
96
+| `python-mysqldb`<br/>or<br/>`python-pymysql` | used for monitoring **mysql** or **mariadb** databases<br/>`python-mysqldb` is a lot faster and thus preferred |
97
+| `nodejs` | used for `node.js` plugins for monitoring **named** and **SNMP** devices |
98
+| `lm-sensors` | for monitoring **hardware sensors** |
99
+| `libelf` | for monitoring kernel-level metrics using eBPF |
100
+| `libmnl` | for collecting netfilter metrics |
101
+| `netcat` | for shell plugins to collect metrics from remote systems |
102
+
103
+_Netdata will greatly benefit if you have the above packages installed, but it will still work without them._
104
105
Netdata DB engine can be enabled when these are installed (they are optional):
106
117
-| package | description|
118
-|:-----:|-----------|
119
-| `liblz4` | Extremely fast compression algorithm, version r129 or greater|
120
-| `openssl`| Cryptography and SSL/TLS toolkit|
107
+| package | description |
108
+|:---------:|---------------------------------------------------------------|
109
+| `liblz4` | Extremely fast compression algorithm, version r129 or greater |
110
+| `openssl` | Cryptography and SSL/TLS toolkit |
111
122
-*Netdata will greatly benefit if you have the above packages installed, but it will still work without them.*
112
+_Netdata will greatly benefit if you have the above packages installed, but it will still work without them._
113
114
Netdata Cloud support may require the following packages to be installed:
115
126
-| package | description |
127
-|:---------:|--------------------------------------------------------------------------------------------------------------------------------------|
128
-| `cmake` | Needed at build time if you aren't using your distribution's version of libwebsockets or are building on a platform other than Linux |
129
-| `openssl` | Needed to secure communications with the Netdata Cloud |
130
-| `protobuf`| Used for the new Cloud<->Agent binary protocol |
116
+| package | description |
117
+|:----------:|--------------------------------------------------------------------------------------------------------------------------------------|
118
+| `cmake` | Needed at build time if you aren't using your distribution's version of libwebsockets or are building on a platform other than Linux |
119
+| `openssl` | Needed to secure communications with the Netdata Cloud |
120
+| `protobuf` | Used for the new Cloud<->Agent binary protocol |
121
132
-*Netdata will greatly benefit if you have the above packages installed, but it will still work without them.*
122
+_Netdata will greatly benefit if you have the above packages installed, but it will still work without them._
123
124
### CentOS / RHEL 6.x
125
@@ -189,28 +179,28 @@ cd netdata
179
./netdata-installer.sh
180
```
181
192
-- If you don't want to run it straight-away, add `--dont-start-it` option.
182
+- If you don't want to run it straight-away, add `--dont-start-it` option.
183
194
-- You can also append `--stable-channel` to fetch and install only the official releases from GitHub, instead of the nightly builds.
184
+- You can also append `--stable-channel` to fetch and install only the official releases from GitHub, instead of the nightly builds.
185
196
-- If you don't want to install it on the default directories, you can run the installer like this: `./netdata-installer.sh --install-prefix /opt`. This one will install Netdata in `/opt/netdata`.
186
+- If you don't want to install it on the default directories, you can run the installer like this: `./netdata-installer.sh --install-prefix /opt`. This one will install Netdata in `/opt/netdata`.
187
198
-- If your server does not have access to the internet and you have manually put the installation directory on your server, you will need to pass the option `--disable-go` to the installer. The option will prevent the installer from attempting to download and install `go.d.plugin`.
188
+- If your server does not have access to the internet and you have manually put the installation directory on your server, you will need to pass the option `--disable-go` to the installer. The option will prevent the installer from attempting to download and install `go.d.plugin`.
189
190
## Optional parameters to alter your installation
191
192
`netdata-installer.sh` accepts a few parameters to customize your installation:
193
204
-- `--dont-wait`: Enable automated installs by not prompting for permission to install any required packages.
205
-- `--dont-start-it`: Prevent the installer from starting Netdata automatically.
206
-- `--stable-channel`: Automatically update only on the release of new major versions.
207
-- `--nightly-channel`: Automatically update on every new nightly build.
208
-- `--disable-telemetry`: Opt-out of [anonymous statistics](/docs/netdata-agent/configuration/anonymous-telemetry-events.md) we use to make
194
+- `--dont-wait`: Enable automated installs by not prompting for permission to install any required packages.
195
+- `--dont-start-it`: Prevent the installer from starting Netdata automatically.
196
+- `--stable-channel`: Automatically update only on the release of new major versions.
197
+- `--nightly-channel`: Automatically update on every new nightly build.
198
+- `--disable-telemetry`: Opt-out of [anonymous statistics](/docs/netdata-agent/configuration/anonymous-telemetry-events.md) we use to make
199
Netdata better.
210
-- `--no-updates`: Prevent automatic updates of any kind.
211
-- `--reinstall`: If an existing install is detected, reinstall instead of trying to update it. Note that this
200
+- `--no-updates`: Prevent automatic updates of any kind.
201
+- `--reinstall`: If an existing install is detected, reinstall instead of trying to update it. Note that this
202
cannot be used to change installation types.
213
-- `--local-files`: Used for [offline installations](/packaging/installer/methods/offline.md). Pass four file paths: the Netdata
203
+- `--local-files`: Used for [offline installations](/packaging/installer/methods/offline.md). Pass four file paths: the Netdata
204
tarball, the checksum file, the go.d plugin tarball, and the go.d plugin config tarball, to force kickstart run the
205
process using those files. This option conflicts with the `--stable-channel` option. If you set this _and_
206
`--stable-channel`, Netdata will use the local files.
@@ -226,23 +216,19 @@ See the [connect to cloud](/src/claim/README.md) doc for details on connecting a
216
217
Our current build process unfortunately has some issues when using certain configurations of the `clang` C compiler on Linux.
218
229
-If the installation fails with errors like `/bin/ld: externaldeps/libwebsockets/libwebsockets.a(context.c.o): relocation R_X86_64_32 against '.rodata.str1.1' can not be used when making a PIE object; recompile with -fPIC`, and you are trying to build with `clang` on Linux, you will need to build Netdata using GCC to get a fully functional install.
219
+If the installation fails with errors like `/bin/ld: externaldeps/libwebsockets/libwebsockets.a(context.c.o): relocation R_X86_64_32 against '.rodata.str1.1' can not be used when making a PIE object; recompile with -fPIC`, and you are trying to build with `clang` on Linux, you will need to build Netdata using GCC to get a fully functional install.
220
221
In most cases, you can do this by running `CC=gcc ./netdata-installer.sh`.
222
233
-
223
### Perform a cleanup in your netdata repo
224
225
The Netdata repo consist of the main git tree and it's submodules. Either working on a fork or on the main repo you need to make sure that there
226
are no "leftover" artifacts from previous builds and that your submodules are up to date to the **corresponding checkouts**.
227
239
-> #### Important: Make sure that you have commited any work in progress, before you proceed the with the clean up instruction below
240
-
228
+> #### Important: Make sure that you have committed any work in progress, before you proceed the with the clean up instruction below
229
230
```sh
231
git clean -dfx && git submodule foreach 'git clean -dfx' && git submodule update --recursive --init
232
```
233
246
-
247
-> Note: In previous builds, you may have created artifacts belonging to an another user (e.g root), so you may need to run
248
-> each of the _git clean_ commands as sudoer.
234
+> Note: In previous builds, you may have created artifacts belonging to an another user (e.g root), so you may need to run each of the _git clean_ commands as a sudoer.
packaging/installer/methods/methods.md
+1
-13
@@ -1,13 +1,3 @@
1
-<!--
2
-title: "Installation methods"
3
-description: "Netdata can be installed as a DEB/RPM package, a static binary, a docker container or from source"
4
-custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/methods.md
5
-sidebar_label: "Installation methods"
6
-learn_status: "Published"
7
-learn_rel_path: "Installation/Installation methods"
8
-sidebar_position: 30
9
--->
10
-
1
# Installation methods
2
3
Netdata can be installed:
@@ -21,6 +11,4 @@ The [one line installer kickstart.sh](/packaging/installer/methods/kickstart.md)
11
picks the most appropriate method out of the first three for any system
12
and is the recommended installation method, if you don't use containers.
13
24
-`kickstart.sh` can also be used for
25
-[offline installation](/packaging/installer/methods/offline.md),
26
-suitable for air-gapped systems.
14
+`kickstart.sh` can also be used for [offline installation](/packaging/installer/methods/offline.md), suitable for air-gapped systems.
packaging/installer/methods/offline.md
-10
@@ -1,13 +1,3 @@
1
-<!--
2
-title: "Install Netdata on offline systems"
3
-description: "Install the Netdata Agent on offline/air gapped systems to benefit from real-time, per-second monitoring without connecting to the internet."
4
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/packaging/installer/methods/offline.md"
5
-sidebar_label: "Offline systems"
6
-learn_status: "Published"
7
-learn_rel_path: "Installation/Installation methods"
8
-sidebar_position: 50
9
--->
10
-
1
# Install Netdata on offline systems
2
3
Our kickstart install script provides support for installing the Netdata Agent on air-gapped systems which do not have a
packaging/installer/methods/packages.md
+5
-15
@@ -1,13 +1,3 @@
1
-<!--
2
-title: "Install Netdata using native DEB/RPM packages."
3
-description: "Instructions for how to install Netdata using native DEB or RPM packages."
4
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/packaging/installer/methods/packages.md"
5
-sidebar_label: "Native DEB/RPM packages"
6
-learn_status: "Published"
7
-learn_rel_path: "Installation/Installation methods"
8
-sidebar_position: 20
9
--->
10
-
1
# Install Netdata using native DEB/RPM packages
2
3
For most common Linux distributions that use either DEB or RPM packages, Netdata provides pre-built native packages
@@ -20,7 +10,7 @@ When using the kickstart script, you can force usage of native DEB or RPM packag
10
`--native-only` when invoking the script. This will cause it to only attempt to use native packages for the install,
11
and fail if it cannot do so.
12
23
-> ### Note
13
+> **Note**
14
>
15
> In July 2022, we switched hosting of our native packages from Package Cloud to self-hosted repositories.
16
> We still maintain the Package cloud repositories, but they are not guaranteed to work and may be removed
@@ -63,9 +53,9 @@ appropriate repository configuration package from <https://repo.netdata.cloud/re
53
directly on the target system using the system package manager. This will ensure any packages needed to use the
54
repository are also installed, and will help enable a seamless transition if we ever need to change our infrastructure.
55
66
-> ### Note
56
+> **Note**
57
>
68
-> On RHEL and other systems that use the `el` repostiroies, some of the dependencies for Netdata can only be found
58
+> On RHEL and other systems that use the `el` repositories, some of the dependencies for Netdata can only be found
59
> in the EPEL repository, which is not enabled or installed by default on most of these systems. This additional
60
> repository _should_ be pulled in automatically by our repository config packages, but if it is not you may need
61
> to manually install `epel-release` to be able to successfully install the Netdata packages.
@@ -91,7 +81,7 @@ These repositories are set up as what Debian calls ‘flat repositories’, and
81
82
As a result of this structure, the required APT sources entry for stable packages for Debian 11 (Bullseye) is:
83
94
-```
84
+```txt
85
deb http://repo.netdata.cloud/repos/stable/debian/ bullseye/
86
```
87
@@ -134,7 +124,7 @@ but we do have some tips for anyone looking to do so:
124
- A full mirror of all of our repositories currently requires up to 100 GB of storage space, though the exact
125
amount of space needed fluctuates over time. Because of this, users seeking to mirror our repositories are
126
encouraged to mirror only those repositories they actually need instead of mirroring everything.
137
-- If syncing daily (or less frequently), some time between 05:00 and 08:00 UTC each day is usually the saftest
127
+- If syncing daily (or less frequently), some time between 05:00 and 08:00 UTC each day is usually the safest
128
time to do so, as publishing nightly packages will almost always be done by this point, and publishing of stable
129
releases typically happens after that time window.
130
- If you intend to use our existing GPG signatures on the repository metadata and packages, you probably also want
packaging/installer/methods/pfsense.md
+6
-15
@@ -1,15 +1,8 @@
1
-<!--
2
-title: "Install Netdata on pfSense"
3
-description: "Install Netdata on pfSense to monitor the health and performance of firewalls with thousands of real-time, per-second metrics."
4
-custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/pfsense.md
5
-sidebar_label: "pfSense"
6
-learn_status: "Published"
7
-learn_rel_path: "Installation/Install on specific environments"
8
--->
9
-
1
# Install Netdata on pfSense CE
2
12
-> 💡 This document is maintained by Netdata's community, and may not be completely up-to-date. Please double-check the
3
+> **Info**
4
+>
5
+> This document is maintained by Netdata's community, and may not be completely up-to-date. Please double-check the
6
> details of the installation process, such as version numbers for downloadable packages, before proceeding.
7
>
8
> You can help improve this document by [submitting a
@@ -46,10 +39,10 @@ pkg install py39-yaml
39
> ⚠️ If any of the above commands return a `Not Found` error, you need to manually search for the latest package in the
40
> [FreeBSD repository](https://www.freebsd.org/ports/) or by running `pkg search`. Search for the package's name, such as `py37-cffi`, find the
41
> latest version number, and update the command accordingly.
49
-
42
+>
43
> ⚠️ On pfSense 2.4.5, Python version 3.7 may be installed by the system, in which case you should should not install
44
> Python from the FreeBSD repository as instructed above.
52
-
45
+>
46
> ⚠️ If you are using the `apcupsd` collector, you need to make sure that apcupsd is up before starting Netdata.
47
> Otherwise a infinitely running `cat` process triggered by the default activated apcupsd charts plugin will eat up CPU
48
> and RAM (`/tmp/.netdata-charts.d-*/run-*`). This also applies to `OPNsense`.
@@ -75,7 +68,7 @@ Visit the Netdata dashboard to confirm it's working: `http://<pfsenseIP>:19999`
68
To start Netdata automatically every boot, add `service netdata onestart` as a Shellcmd entry within the pfSense web
69
interface under **Services/Shellcmd**. You'll need to install the Shellcmd package beforehand under **System/Package
70
Manager/Available Packages**. The Shellcmd Type should be set to `Shellcmd`.
78
- Alternatively more information can be found in
71
+ Alternatively more information can be found in
72
<https://doc.pfsense.org/index.php/Installing_FreeBSD_Packages>, for achieving the same via the command line and
73
scripts.
74
@@ -83,5 +76,3 @@ If you experience an issue with `/usr/bin/install` being absent in pfSense 2.3 o
76
workaround from <https://redmine.pfsense.org/issues/6643>
77
78
**Note:** In pfSense, the Netdata configuration files are located under `/usr/local/etc/netdata`.
86
-
87
-
packaging/installer/methods/source.md
+23
-35
@@ -1,13 +1,3 @@
1
-<!--
2
-title: "Manually build Netdata from source"
3
-description: "Package maintainers and power users may be interested in manually building Netdata from source without using any of our installation scripts."
4
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/packaging/installer/methods/source.md"
5
-sidebar_label: "Manually build Netdata from source"
6
-learn_status: "Published"
7
-learn_rel_path: "Installation/Package maintainers"
8
-sidebar_position: 100
9
--->
10
-
1
# Manually build Netdata from source
2
3
These instructions are for advanced users and distribution package
@@ -20,33 +10,33 @@ checkout](/packaging/installer/methods/manual.md) instead.
10
At a bare minimum, Netdata requires the following libraries and tools
11
to build and run successfully:
12
23
-- libuuid
24
-- libuv version 1.0 or newer
25
-- zlib
26
-- CMake 3.13 or newer
27
-- GCC or Xcode (Clang is known to have issues in certain configurations, see [Using Clang](#using-clang))
28
-- Ninja or Make (Ninja is preferred as it results in significantly faster builds)
29
-- Git (we use git in the build system to generate version info, you don't need a full install, just a working `git show` command)
13
+- libuuid
14
+- libuv version 1.0 or newer
15
+- zlib
16
+- CMake 3.13 or newer
17
+- GCC or Xcode (Clang is known to have issues in certain configurations, see [Using Clang](#using-clang))
18
+- Ninja or Make (Ninja is preferred as it results in significantly faster builds)
19
+- Git (we use git in the build system to generate version info, you don't need a full install, just a working `git show` command)
20
21
The following additional dependencies are also needed, but will be prepared automatically by CMake if they are not available on the build system.
22
33
-- libyaml
34
-- JSON-C
23
+- libyaml
24
+- JSON-C
25
26
Additionally, the following build time features require additional dependencies:
27
38
-- TLS support for the web GUI:
39
- - OpenSSL 1.0.2 or newer _or_ LibreSSL 3.0.0 or newer.
40
-- dbengine metric storage:
41
- - liblz4 r129 or newer
42
- - OpenSSL 1.0 or newer (LibreSSL _amy_ work, but is largely untested).
43
-- Netdata Cloud support:
44
- - A working internet connection
45
- - OpenSSL 1.0.2 or newer _or_ LibreSSL 3.0.0 or newer.
46
- - protobuf (Google Protocol Buffers) and protoc compiler. If protobuf is not available on the system,
28
+- TLS support for the web GUI:
29
+ - OpenSSL 1.0.2 or newer _or_ LibreSSL 3.0.0 or newer.
30
+- dbengine metric storage:
31
+ - liblz4 r129 or newer
32
+ - OpenSSL 1.0 or newer (LibreSSL _amy_ work, but is largely untested).
33
+- Netdata Cloud support:
34
+ - A working internet connection
35
+ - OpenSSL 1.0.2 or newer _or_ LibreSSL 3.0.0 or newer.
36
+ - protobuf (Google Protocol Buffers) and protoc compiler. If protobuf is not available on the system,
37
CMake can be instructed to fetch and build a usable version for Netdata.
48
-- Netdata Go collectors:
49
- - Go 1.21 or newer
38
+- Netdata Go collectors:
39
+ - Go 1.21 or newer
40
41
## Preparing the source tree
42
@@ -111,12 +101,12 @@ a pre-built copy of the required code, or build it locally.
101
We provide pre-built copies of the eBPF code for 64-bit x86 systems
102
using glibc or musl. To use one of these:
103
114
-1. Verify the release version that Netdata expects to be used by checking
104
+1. Verify the release version that Netdata expects to be used by checking
105
the contents of `packaging/ebpf.version` in your Netdata sources.
116
-2. Go to https://github.com/netdata/kernel-collector/releases, select the
106
+2. Go to <https://github.com/netdata/kernel-collector/releases>, select the
107
required release, and download the `netdata-kernel-collector-*.tar.xz`
108
file for the libc variant your system uses (either rmusl or glibc).
119
-3. Extract the contents of the archive to a temporary location, and then
109
+3. Extract the contents of the archive to a temporary location, and then
110
copy all of the `.o` and `.so.*` files and the contents of the `library/`
111
directory to `/usr/libexec/netdata/plugins.d` or the equivalent location
112
for your build of Netdata.
@@ -128,5 +118,3 @@ instructions, please consult [the README file for our kernel-collector
118
repository](https://github.com/netdata/kernel-collector/#readme),
119
which outlines both the required dependencies, as well as multiple
120
options for building the code.
131
-
132
-
packaging/installer/methods/synology.md
+10
-22
@@ -1,24 +1,14 @@
1
-<!--
2
-title: "Install Netdata on Synology"
3
-description: "The Netdata Agent can be installed on AMD64-compatible NAS systems using the 64-bit pre-compiled static binary."
4
-custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/synology.md
5
-sidebar_label: "Synology"
6
-learn_status: "Published"
7
-learn_rel_path: "Installation/Install on specific environments"
8
--->
9
-
1
# Install Netdata on Synology
2
3
> 💡 This document is maintained by Netdata's community, and may not be completely up-to-date. Please double-check the
4
> details of the installation process, before proceeding.
5
>
15
-> You can help improve this document by
16
-> [submitting a PR](https://github.com/netdata/netdata/edit/master/packaging/installer/methods/synology.md)
6
+> You can help improve this document by
7
+> [submitting a PR](https://github.com/netdata/netdata/edit/master/packaging/installer/methods/synology.md)
8
> with your recommended improvements or changes. Thank you!
9
19
-
20
-The good news is that our
21
-[one-line installation script](/packaging/installer/methods/kickstart.md)
10
+The good news is that our
11
+[one-line installation script](/packaging/installer/methods/kickstart.md)
12
works fine if your NAS is one that uses the amd64 architecture. It
13
will install the content into `/opt/netdata`, making future removal safe and simple.
14
@@ -49,15 +39,13 @@ installations run it as the `netdata` user, you might wish to do the same. This
39
Additionally, as of 2018/06/24, the Netdata installer doesn't recognize DSM as an operating system, so no init script is
40
installed. You'll have to do this manually:
41
52
-1. Add [this file](https://gist.github.com/oskapt/055d474d7bfef32c49469c1b53e8225f) as `/etc/rc.netdata`. Make it
42
+1. Add [this file](https://gist.github.com/oskapt/055d474d7bfef32c49469c1b53e8225f) as `/etc/rc.netdata`. Make it
43
executable with `chmod 0755 /etc/rc.netdata`.
54
-2. Add or edit `/etc/rc.local` and add a line calling `/etc/rc.netdata` to have it start on boot:
44
+2. Add or edit `/etc/rc.local` and add a line calling `/etc/rc.netdata` to have it start on boot:
45
56
-```conf
57
-# Netdata startup
58
-[ -x /etc/rc.netdata ] && /etc/rc.netdata start
59
-```
46
+ ```conf
47
+ # Netdata startup
48
+ [ -x /etc/rc.netdata ] && /etc/rc.netdata start
49
+ ```
50
51
3. Make sure `/etc/rc.local` is executable: `chmod 0755 /etc/rc.local`.
62
-
63
-
packaging/maintainers/README.md
+10
-12
@@ -39,9 +39,9 @@ This page tracks the package maintainers for Netdata, for various operating syst
39
40
## Unofficial Linux Packages
41
42
-| Linux Distribution | Netdata Version | Maintainer | Related URL |
43
-|:------------------:|:---------------:|:----------:|:------------------------------------------------------------------------------------------------------------------------------------------------|
44
-| Ubuntu | Release | @gslin | [netdata @ gslin ppa](https://launchpad.net/~gslin/+archive/ubuntu/netdata) https://github.com/netdata/netdata/issues/69#issuecomment-217458543 |
42
+| Linux Distribution | Netdata Version | Maintainer | Related URL |
43
+|:------------------:|:---------------:|:----------:|:--------------------------------------------------------------------------------------------------------------------------------------------------|
44
+| Ubuntu | Release | @gslin | [netdata @ gslin ppa](https://launchpad.net/~gslin/+archive/ubuntu/netdata) <https://github.com/netdata/netdata/issues/69#issuecomment-217458543> |
45
46
---
47
@@ -50,23 +50,21 @@ This page tracks the package maintainers for Netdata, for various operating syst
50
| Embedded Linux | Netdata Version | Maintainer | Related URL |
51
|:--------------:|:---------------:|:-------------:|:---------------------------------------------------------------------------------|
52
| OpenWRT | Release | @nitroshift | [openwrt package](https://github.com/openwrt/packages/tree/master/admin/netdata) |
53
-| ReadyNAS | Release | @NAStools | https://github.com/nastools/netdata |
54
-| QNAP | Release | QNAP_Stephane | https://forum.qnap.com/viewtopic.php?t=121518 |
55
-| DietPi | Release | @Fourdee | https://github.com/Fourdee/DietPi |
53
+| ReadyNAS | Release | @NAStools | <https://github.com/nastools/netdata> |
54
+| QNAP | Release | QNAP_Stephane | <https://forum.qnap.com/viewtopic.php?t=121518> |
55
+| DietPi | Release | @Fourdee | <https://github.com/Fourdee/DietPi> |
56
57
---
58
59
## Automation Systems
60
61
-| Automation Systems | Netdata Version | Maintainer | Related URL |
62
-|:------------------:|:---------------:|:-----------:|:-----------------------------------------------|
63
-| Ansible | git | @jffz | https://galaxy.ansible.com/jffz/netdata/ |
64
-| Chef | ? | @sergiopena | https://github.com/sergiopena/netdata-cookbook |
61
+| Automation Systems | Netdata Version | Maintainer | Related URL |
62
+|:------------------:|:---------------:|:-----------:|:-------------------------------------------------|
63
+| Ansible | git | @jffz | <https://galaxy.ansible.com/jffz/netdata/> |
64
+| Chef | ? | @sergiopena | <https://github.com/sergiopena/netdata-cookbook> |
65
66
---
67
68
## Packages summary from repology.org
69
70
[](https://repology.org/metapackage/netdata/versions)
71
-
72
-
packaging/windows/WINDOWS_INSTALLER.md
+2
-2
@@ -26,7 +26,7 @@ The installer will then guide you through these steps:
26
This section provides instructions for installing Netdata in silent mode, which is ideal for automated deployments.
27
Silent mode skips displaying license agreements, but requires explicitly accepting them using the `/A` option.
28
29
-**Available Options**:
29
+### Available Options
30
31
| Option | Description |
32
|-----------|--------------------------------------------------------------------------------------------------|
@@ -39,7 +39,7 @@ Silent mode skips displaying license agreements, but requires explicitly accepti
39
| `/ROOMS=` | Comma-separated list of Room IDs where you want your node to appear. |
40
| `/PROXY=` | Sets the proxy server address if your network requires one. |
41
42
-**Example Usage**
42
+### Example Usage
43
44
Connect your Agent to your Netdata Cloud Space with token `<YOUR_TOKEN>` and room `<YOUR_ROOM>`:
45