fix(docs): update mermaid diagrams leftovers plus syntax issues (#21034)
Co-authored-by: ilyam8 <ilya@netdata.cloud>
Kanela committed
Sep 22, 2025 at 22:31 UTC
4bdf00e2245f60eff2dfc55ac09bc1e46518d69c
10 files changed
+240
-204
docs/deployment-guides/standalone-deployment.md
+36
-32
@@ -36,15 +36,17 @@ flowchart TB
36
37
NC <--> Agents
38
39
- %% Style definitions
40
- classDef alert fill:#ffeb3b,stroke:#000000,stroke-width:3px,color:#000000,font-size:18px
41
- classDef neutral fill:#f9f9f9,stroke:#000000,stroke-width:3px,color:#000000,font-size:18px
42
- classDef complete fill:#4caf50,stroke:#000000,stroke-width:3px,color:#000000,font-size:18px
43
- classDef database fill:#2196F3,stroke:#000000,stroke-width:3px,color:#000000,font-size:18px
44
-
45
- %% Apply styles
46
- class Users,Agents alert
47
- class NC,Notifications neutral
39
+%% Style definitions
40
+ classDef alert fill:#ffeb3b, stroke:#000000, stroke-width:3px, color:#000000, font-size:18px
41
+ classDef neutral fill:#f9f9f9, stroke:#000000, stroke-width:3px, color:#000000, font-size:18px
42
+ classDef complete fill:#4caf50, stroke:#000000, stroke-width:3px, color:#000000, font-size:18px
43
+ classDef database fill:#2196F3, stroke:#000000, stroke-width:3px, color:#000000, font-size:18px
44
+
45
+%% Apply styles
46
+ class Users alert
47
+ class Agents alert
48
+ class NC neutral
49
+ class Notifications neutral
50
class Data complete
51
class infrastructure database
52
```
@@ -93,15 +95,15 @@ You can also run Agents independently, though you'll miss out on unified dashboa
95
flowchart TB
96
subgraph infrastructure["Your Infrastructure"]
97
direction TB
96
- A1["Agent 1"]
97
- A2["Agent 2"]
98
- A3["Agent 3"]
99
- D1["Dashboard 1<br/>:19999"]
100
- D2["Dashboard 2<br/>:19999"]
101
- D3["Dashboard 3<br/>:19999"]
102
- N1["Alerts"]
103
- N2["Alerts"]
104
- N3["Alerts"]
98
+ A1("**Agent 1**<br/>Independent monitoring")
99
+ A2("**Agent 2**<br/>Independent monitoring")
100
+ A3("**Agent 3**<br/>Independent monitoring")
101
+ D1("**Dashboard 1**<br/>:19999")
102
+ D2("**Dashboard 2**<br/>:19999")
103
+ D3("**Dashboard 3**<br/>:19999")
104
+ N1("**Alerts**<br/>Local notifications")
105
+ N2("**Alerts**<br/>Local notifications")
106
+ N3("**Alerts**<br/>Local notifications")
107
A1 --> D1
108
A2 --> D2
109
A3 --> D3
@@ -110,20 +112,22 @@ flowchart TB
112
A3 --> N3
113
end
114
113
- classDef agents fill: #e8f5e8, stroke: #27ae60, stroke-width: 2px, color: #2c3e50, rx: 10, ry: 10
114
- classDef dashboards fill: #fff2e8, stroke: #f39c12, stroke-width: 2px, color: #2c3e50, rx: 10, ry: 10
115
- classDef alerts fill: #ffe8e8, stroke: #e74c3c, stroke-width: 2px, color: #2c3e50, rx: 10, ry: 10
116
- classDef subgraphStyle fill: #f8f9fa, stroke: #6c757d, stroke-width: 2px, color: #2c3e50, rx: 15, ry: 15
117
- class A1 agents
118
- class A2 agents
119
- class A3 agents
120
- class D1 dashboards
121
- class D2 dashboards
122
- class D3 dashboards
123
- class N1 alerts
124
- class N2 alerts
125
- class N3 alerts
126
- class infrastructure subgraphStyle
115
+%% Style definitions matching the reference
116
+ classDef alert fill: #ffeb3b, stroke: #000000, stroke-width: 3px, color: #000000, font-size: 18px
117
+ classDef neutral fill: #f9f9f9, stroke: #000000, stroke-width: 3px, color: #000000, font-size: 18px
118
+ classDef complete fill: #4caf50, stroke: #000000, stroke-width: 3px, color: #000000, font-size: 18px
119
+ classDef database fill: #2196F3, stroke: #000000, stroke-width: 3px, color: #000000, font-size: 18px
120
+%% Apply styles
121
+ class A1 alert
122
+ class A2 alert
123
+ class A3 alert
124
+ class D1 neutral
125
+ class D2 neutral
126
+ class D3 neutral
127
+ class N1 complete
128
+ class N2 complete
129
+ class N3 complete
130
+ class infrastructure database
131
```
132
133
</details>
docs/streaming-routing.md
+45
-22
@@ -2,7 +2,7 @@
2
3
Streaming routing controls how Netdata child nodes connect to parent nodes when multiple parents are available. It handles three key operations: initial parent selection, connection management, and failover.
4
5
-:::info Prerequisites
5
+:::info
6
7
This feature requires configuring streaming in `netdata.conf`. See [Streaming Configuration](/src/streaming/README.md) for setup instructions.
8
@@ -15,24 +15,34 @@ This feature requires configuring streaming in `netdata.conf`. See [Streaming Co
15
When a child node starts, it queries all configured parents simultaneously to determine the best connection:
16
17
```mermaid
18
-graph LR
19
- A[Start] --> B[Query all parents]
20
- B --> C{Data recency<br/>delta < 1min?}
21
- C -->|Multiple| D[Random select]
22
- C -->|One best| E[Connect to<br/>most recent]
18
+flowchart LR
19
+ A("**Start**<br/>Child node startup") --> B("**Query all parents**<br/>Parallel HTTP requests")
20
+ B --> C("**Data recency<br/>delta < 1min?**<br/>Compare timestamps")
21
+ C -->|Multiple| D("**Random select**<br/>Load balancing")
22
+ C -->|One best| E("**Connect to<br/>most recent**<br/>Data continuity")
23
C -->|No data| D
24
- D --> F[Connect]
24
+ D --> F("**Connect**<br/>Streaming active")
25
E --> F
26
+%% Style definitions matching the reference
27
+ classDef alert fill: #ffeb3b, stroke: #000000, stroke-width: 3px, color: #000000, font-size: 18px
28
+ classDef neutral fill: #f9f9f9, stroke: #000000, stroke-width: 3px, color: #000000, font-size: 18px
29
+ classDef complete fill: #4caf50, stroke: #000000, stroke-width: 3px, color: #000000, font-size: 18px
30
+ classDef database fill: #2196F3, stroke: #000000, stroke-width: 3px, color: #000000, font-size: 18px
31
+%% Apply styles
32
+ class A alert
33
+ class B neutral
34
+ class C neutral
35
+ class D database
36
+ class E database
37
+ class F complete
38
```
39
40
**How it works:**
41
42
1. Child sends HTTP requests to all parents in parallel
43
2. Each parent responds with:
32
-
33
-- Last timestamp of this child's data (if any)
34
-- Random seed for load balancing
35
-
44
+ - Last timestamp of this child's data (if any)
45
+ - Random seed for load balancing
46
3. Child calculates time delta for each parent
47
4. Selection based on data recency (not data amount)
48
@@ -65,7 +75,7 @@ Once connected, the child maintains a persistent connection:
75
- **No automatic rebalancing**: Child stays connected until failure
76
- **Data integrity**: Historical metrics are replicated automatically after reconnection
77
68
-:::info Data Recovery
78
+:::info
79
80
Netdata automatically replicates missing historical data when reconnection occurs. Data is only lost if:
81
@@ -77,7 +87,7 @@ For persistent data, use `memory mode = dbengine`.
87
88
:::
89
80
-:::warning Important
90
+:::warning
91
92
Children do not automatically reconnect to their original parent after failover. This prevents connection flapping but requires manual intervention for load redistribution.
93
@@ -88,17 +98,30 @@ Children do not automatically reconnect to their original parent after failover.
98
When the active connection fails, the child repeats the parent selection process:
99
100
```mermaid
91
-graph LR
92
- A[Failed] --> B[Wait 5-X sec]
93
- B --> C[Query all parents]
94
- C --> D{Select best<br/>by recency}
95
- D --> E[Try connect]
96
- E --> F{OK?}
101
+flowchart LR
102
+ A("**Failed**<br/>Connection lost") --> B("**Wait 5-X sec**<br/>Randomized delay")
103
+ B --> C("**Query all parents**<br/>Re-evaluate options")
104
+ C --> D("**Select best<br/>by recency**<br/>Data continuity priority")
105
+ D --> E("**Try connect**<br/>Attempt connection")
106
+ E --> F("**OK?**<br/>Connection test")
107
F -->|No| B
98
- F -->|Yes| G[Stream]
108
+ F -->|Yes| G("**Stream**<br/>Active monitoring")
109
+%% Style definitions matching the reference
110
+ classDef alert fill: #ffeb3b, stroke: #000000, stroke-width: 3px, color: #000000, font-size: 18px
111
+ classDef neutral fill: #f9f9f9, stroke: #000000, stroke-width: 3px, color: #000000, font-size: 18px
112
+ classDef complete fill: #4caf50, stroke: #000000, stroke-width: 3px, color: #000000, font-size: 18px
113
+ classDef database fill: #2196F3, stroke: #000000, stroke-width: 3px, color: #000000, font-size: 18px
114
+%% Apply styles
115
+ class A alert
116
+ class B neutral
117
+ class C neutral
118
+ class E neutral
119
+ class D database
120
+ class F database
121
+ class G complete
122
```
123
101
-:::note Smart Failover
124
+:::note
125
126
Unlike traditional round-robin failover, Netdata re-evaluates all parents on each attempt. This means a child might connect to a different parent than expected if data states have changed.
127
@@ -203,7 +226,7 @@ If a child connects to an unexpected parent, check the data retention on all par
226
227
:::caution Maintenance Planning
228
206
-When taking a parent offline for maintenance, its children will failover to other parents and won't automatically return. Plan capacity accordingly.
229
+When taking a parent offline for maintenance, its children will fail over to other parents and won't automatically return. Plan capacity accordingly.
230
231
:::
232
packaging/docker/README.md
+49
-25
@@ -5,11 +5,11 @@ import TabItem from '@theme/TabItem';
5
6
## Limitations running the Agent in Docker
7
8
-We don’t officially support using Docker’s `--user` option or Docker Compose’s `user:` parameter with our images. While they may work, some features could be unavailable. The Agent drops privileges at startup, so most processes don’t run as UID 0 even without these options.
8
+We don’t officially support using Docker’s `--user` option or Docker Compose’s `user:` parameter with our images. While they may work, some features could be unavailable. The Agent drops privileges at startup, so most processes don’t run as UID 0 even without these options.
9
10
## Create a new Netdata Agent container
11
12
-You can create a new Agent container with `docker run` or `docker-compose`, then access the dashboard at `http://NODE:19999`.
12
+You can create a new Agent container with `docker run` or `docker-compose`, then access the dashboard at `http://NODE:19999`.
13
14
The Netdata container requires specific **privileges** and **mounts** to provide full monitoring capabilities equivalent to a direct host installation. Below is a list of required components and their purposes.
15
@@ -127,9 +127,11 @@ volumes:
127
</TabItem>
128
</Tabs>
129
130
-> :bookmark_tabs: Note
131
->
132
-> 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" view.
130
+:::note
131
+
132
+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" view.
133
+
134
+:::
135
136
### With NVIDIA GPUs monitoring
137
@@ -252,7 +254,7 @@ volumes:
254
255
### With SSL/TLS enabled HTTP Proxy
256
255
-Below is an example of installing Netdata with an **SSL reverse proxy** and **basic authentication** using Docker.
257
+Below is an example of installing Netdata with an **SSL reverse proxy** and **basic authentication** using Docker.
258
259
#### Caddyfile Setup
260
@@ -326,9 +328,13 @@ to Caddyfile.
328
329
### With Docker socket proxy
330
329
-> **Note:** Using Netdata with a Docker socket proxy may cause some features to not work as expected. It hasn't been fully tested by the Netdata team.
331
+:::note
332
+
333
+Using Netdata with a Docker socket proxy may cause some features to not work as expected. It hasn't been fully tested by the Netdata team.
334
+
335
+:::
336
331
-For better security, deploy a **Docker socket proxy** with a tool like [HAProxy](/docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-haproxy.md) or [CetusGuard](https://github.com/hectorm/cetusguard). This ensures the socket is **read-only** and restricted to the `/containers` endpoint.
337
+For better security, deploy a **Docker socket proxy** with a tool like [HAProxy](/docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-haproxy.md) or [CetusGuard](https://github.com/hectorm/cetusguard). This ensures the socket is **read-only** and restricted to the `/containers` endpoint.
338
339
Exposing the socket to a proxy is safer because Netdata’s TCP port is accessible outside the Docker network, while the proxy container remains isolated within it.
340
@@ -376,11 +382,19 @@ volumes:
382
netdatacache:
383
```
384
379
-**Note:** Replace `2375` with the port of your proxy.
385
+:::note
386
+
387
+Replace `2375` with the port of your proxy.
388
+
389
+:::
390
391
#### CetusGuard
392
383
-> Note: This deployment method is supported by the community
393
+:::note
394
+
395
+This deployment method is supported by the community
396
+
397
+:::
398
399
```yaml
400
version: '3'
@@ -429,14 +443,17 @@ volumes:
443
netdatacache:
444
```
445
432
-You can run the socket proxy in its own Docker Compose file and leave it on a private network that you can add to
433
-other services that require access.
446
+:::tip
447
+
448
+You can run the socket proxy in its own Docker Compose file and leave it on a private network that you can add to other services that require access.
449
+
450
+:::
451
452
### Rootless mode
453
454
Netdata can be run successfully in a non-root environment, such as [rootless Docker](https://docs.docker.com/engine/security/rootless/).
455
439
-Netdata can run in a rootless Docker environment, but its data collection is limited due to restricted access to resources requiring elevated privileges.
456
+Netdata can run in a rootless Docker environment, but its data collection is limited due to restricted access to resources requiring elevated privileges.
457
The following components won't work:
458
459
- container network interfaces monitoring (cgroup-network helper)
@@ -481,9 +498,11 @@ docker run -d --name=netdata \
498
499
</Tabs>
500
484
-> :bookmark_tabs: Note
485
->
486
-> 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" view.
501
+:::note
502
+
503
+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" view.
504
+
505
+:::
506
507
## Docker tags
508
@@ -539,15 +558,15 @@ services:
558
hostname: my_docker_compose_netdata
559
```
560
542
-If you prefer not to recreate the container, edit the Agent’s `netdata.conf` file. See [configuring Agent containers](#configure-agent-containers) for the right method based on how you created it.
561
+If you prefer not to recreate the container, edit the Agent’s `netdata.conf` file. See [configuring Agent containers](#configure-agent-containers) for the right method based on how you created it.
562
544
-Alternatively, use the **host’s hostname** by mounting `/etc/hostname` in the container:
563
+Alternatively, use the **host’s hostname** by mounting `/etc/hostname` in the container:
564
546
-- **With `docker run`**, add:
565
+- **With `docker run`**, add:
566
```sh
567
--volume /etc/hostname:/host/etc/hostname:ro
568
```
550
-- **With Docker Compose**, add this to the `volumes` section:
569
+- **With Docker Compose**, add this to the `volumes` section:
570
```yaml
571
- /etc/hostname:/host/etc/hostname:ro
572
```
@@ -556,16 +575,17 @@ Alternatively, use the **host’s hostname** by mounting `/etc/hostname` in the
575
576
By default, Netdata’s official container images exclude some optional runtime dependencies. You can install them at runtime by setting the `NETDATA_EXTRA_DEB_PACKAGES` environment variable.
577
559
-Commonly useful packages:
560
-- `apcupsd` – Monitors APC UPS devices.
561
-- `lm-sensors` – Monitors hardware sensors.
578
+Commonly useful packages:
579
+
580
+- `apcupsd` – Monitors APC UPS devices.
581
+- `lm-sensors` – Monitors hardware sensors.
582
- `netcat-openbsd` – Enables IRC alerts.
583
584
## Health Checks
585
566
-Netdata’s Docker image supports **health checks** via standard Docker interfaces. You can control them using the `NETDATA_HEALTHCHECK_TARGET` environment variable:
586
+Netdata’s Docker image supports **health checks** via standard Docker interfaces. You can control them using the `NETDATA_HEALTHCHECK_TARGET` environment variable:
587
568
-- **Unset** – Defaults to checking `/api/v1/info`.
588
+- **Unset** – Defaults to checking `/api/v1/info`.
589
- **`cli`** – Uses `netdatacli ping` to confirm the Agent is running (but not full data collection).
590
591
The default `/api/v1/info` check is usually sufficient. However, if the web server is disabled or API access is restricted, you'll need to customize the health check configuration.
@@ -574,4 +594,8 @@ The default `/api/v1/info` check is usually sufficient. However, if the web serv
594
595
At Netdata, we provide multiple ways of testing your Docker images using your own repositories.
596
597
+:::tip
598
+
599
You may either use the command line tools available or take advantage of our GitHub Actions infrastructure.
600
+
601
+:::
packaging/installer/methods/ansible.md
+26
-20
@@ -10,34 +10,42 @@ With Ansible, you can deploy Netdata repeatedly without disrupting your infrastr
10
11
:::
12
13
----
14
-
13
## Prerequisites
14
15
- Netdata Cloud account. [Sign in and create one](https://app.netdata.cloud) if you don't have one already.
16
- An administration system with [Ansible](https://www.ansible.com/) installed.
17
- One or more nodes that your administration system can access via [SSH public keys](https://git-scm.com/book/en/v2/Git-on-the-Server-Generating-Your-SSH-Public-Key) (preferably password-less).
18
21
----
22
-
19
## Deployment Architecture
20
21
Below is a visual representation of the deployment architecture, illustrating the relationship between the host system, Docker, the Netdata container, and key mounts/privileges.
22
23
```mermaid
28
-graph TD
29
- A[Host System] -->|SSH| B[Ansible]
30
- B -->|Deploys| C[Netdata Agent]
31
- C -->|Collects Metrics| D[Monitored Services]
32
- C -->|Sends Data| E[Netdata Cloud]
33
- subgraph " "
24
+flowchart TD
25
+ A("**Host System**<br/>Administration server") -->|SSH| B("**Ansible**<br/>Configuration management")
26
+ B -->|Deploys| C("**Netdata Agent**<br/>Monitoring daemon")
27
+ C -->|Collects Metrics| D("**Monitored Services**<br/>Applications & infrastructure")
28
+ C -->|Sends Data| E("**Netdata Cloud**<br/>Unified dashboard")
29
+
30
+ subgraph infrastructure["Target Infrastructure"]
31
direction TB
32
+ C
33
D
36
- E
34
end
38
-```
35
40
----
36
+%% Style definitions matching the reference
37
+ classDef alert fill: #ffeb3b, stroke: #000000, stroke-width: 3px, color: #000000, font-size: 18px
38
+ classDef neutral fill: #f9f9f9, stroke: #000000, stroke-width: 3px, color: #000000, font-size: 18px
39
+ classDef complete fill: #4caf50, stroke: #000000, stroke-width: 3px, color: #000000, font-size: 18px
40
+ classDef database fill: #2196F3, stroke: #000000, stroke-width: 3px, color: #000000, font-size: 18px
41
+%% Apply styles
42
+ class A alert
43
+ class B database
44
+ class C complete
45
+ class D complete
46
+ class E neutral
47
+ class infrastructure database
48
+```
49
50
## Download and Configure the Playbook
51
@@ -57,8 +65,6 @@ Next, navigate into the Ansible directory.
65
cd ansible-quickstart
66
```
67
60
----
61
-
68
### Edit the `hosts` File
69
70
The `hosts` file contains a list of IP addresses or hostnames that Ansible will target. Replace the example IP addresses with those of your nodes.
@@ -87,8 +93,6 @@ If you use an SSH key other than `~/.ssh/id_rsa` for logging into your nodes, sp
93
203.0.113.1 hostname=ansible-02 ansible_ssh_private_key_file=~/.ssh/LightsailDefaultKey-us-east-1.pem
94
```
95
90
----
91
-
96
### Edit the `vars/main.yml` File
97
98
To connect your node(s) to your Space in Netdata Cloud and see all their metrics in real-time, set the `claim_token` and `claim_rooms` variables.
@@ -108,9 +112,11 @@ Since this node connects to Netdata Cloud, we'll view its dashboards there inste
112
113
You can read more about this decision, or other ways to lock down the local dashboard, in our [node security documentation](https://learn.netdata.cloud/docs/netdata-agent/security/overview).
114
111
-> Curious about why Netdata's dashboard is open by default? Read our [blog post](https://www.netdata.cloud/blog/netdata-agent-dashboard/) on that zero-configuration design decision.
115
+:::tip
116
113
----
117
+Curious about why Netdata's dashboard is open by default? Read our [blog post](https://www.netdata.cloud/blog/netdata-agent-dashboard/) on that zero-configuration design decision.
118
+
119
+:::
120
121
## Run the Playbook
122
@@ -122,4 +128,4 @@ ansible-playbook -i hosts tasks/main.yml
128
129
Ansible connects to your node(s) via SSH, collects [facts](https://docs.ansible.com/ansible/latest/user_guide/playbooks_vars_facts.html#ansible-facts) about the system, and then applies the defined tasks.
130
125
-The task to install Netdata may take a few minutes per node. Once the playbook reaches the "connect to Cloud" task, your nodes will start appearing in your Space in Netdata Cloud.
\ No newline at end of file
131
+The task to install Netdata may take a few minutes per node. Once the playbook reaches the "connect to Cloud" task, your nodes will start appearing in your Space in Netdata Cloud.
packaging/installer/methods/freebsd.md
+17
-20
@@ -1,10 +1,10 @@
1
# Install Netdata on FreeBSD
2
3
-> 💡 This guide is community-maintained and might not always reflect the latest details (like package versions).
4
-> Double-check before proceeding!
5
-> Want to help? [Submit a PR!](https://github.com/netdata/netdata/edit/master/packaging/installer/methods/freebsd.md)
3
+:::info
4
7
----
5
+This guide is community-maintained and might not always reflect the latest details (like package versions). Double-check before proceeding! Want to help? [Submit a PR!](https://github.com/netdata/netdata/edit/master/packaging/installer/methods/freebsd.md)
6
+
7
+:::
8
9
## 1. Install dependencies
10
@@ -16,11 +16,10 @@ pkg install bash e2fsprogs-libuuid git curl autoconf automake pkgconf pidof libl
16
17
Approve any prompts that appear.
18
19
----
20
-
19
## 2. Choose an Installation Method
20
23
-### Option A: Kickstart Installer (Recommended)
21
+<details>
22
+<summary><strong>Option A: Kickstart Installer (Recommended)</strong></summary>
23
24
The simplest approach is to use our one-line [kickstart installer](/packaging/installer/methods/kickstart.md).
25
@@ -32,7 +31,12 @@ The simplest approach is to use our one-line [kickstart installer](/packaging/in
31
```bash
32
wget -O /tmp/netdata-kickstart.sh https://get.netdata.cloud/kickstart.sh && sh /tmp/netdata-kickstart.sh --claim-token <YOUR_TOKEN> --claim-url https://app.netdata.cloud
33
```
35
- > Replace `<YOUR_TOKEN>` with your actual claim token.
34
+
35
+:::note
36
+
37
+Replace `<YOUR_TOKEN>` with your actual claim token.
38
+
39
+:::
40
41
- After installation, access your Netdata dashboard at:
42
@@ -42,7 +46,7 @@ The simplest approach is to use our one-line [kickstart installer](/packaging/in
46
47
(`NODE` = your FreeBSD machine's hostname or IP)
48
45
----
49
+</details>
50
51
### Option B: FreeBSD Ports Installation
52
@@ -50,9 +54,8 @@ Netdata is also available through the FreeBSD Ports collection:
54
55
https://www.freshports.org/net-mgmt/netdata/
56
53
----
54
-
55
-### Option C: Manual Installation (For Advanced Users)
57
+<details>
58
+<summary><strong>Option C: Manual Installation (For Advanced Users)</strong></summary>
59
60
- Download the latest Netdata release:
61
@@ -91,7 +94,7 @@ https://www.freshports.org/net-mgmt/netdata/
94
service netdata start
95
```
96
94
----
97
+</details>
98
99
## 3. Updating Netdata Installation
100
@@ -104,8 +107,6 @@ cd /opt/netdata/usr/libexec/netdata/
107
./netdata-updater.sh
108
```
109
107
----
108
-
110
## Optional Kickstart Parameters
111
112
| Option | Description |
@@ -120,8 +121,6 @@ cd /opt/netdata/usr/libexec/netdata/
121
| `--install-prefix /opt` | Change installation directory. |
122
| `--prepare-offline-install-source ./netdata-offline` | Prepare offline installation source. See [Offline Install Guide](/packaging/installer/methods/offline.md). |
123
123
----
124
-
124
## Environment Variables (Advanced Users)
125
126
| Variable | Purpose |
@@ -130,8 +129,6 @@ cd /opt/netdata/usr/libexec/netdata/
129
| `ROOTCMD` | Command used for privilege escalation (default: `sudo` or `doas`). |
130
| `DISABLE_TELEMETRY=1` | Disables anonymous telemetry data. |
131
133
----
134
-
132
## Telemetry Notice
133
137
-Anonymous usage data is collected by default. You can learn more or opt-out [here](/docs/netdata-agent/configuration/anonymous-telemetry-events.md).
\ No newline at end of file
134
+Anonymous usage data is collected by default. You can learn more or opt-out [here](/docs/netdata-agent/configuration/anonymous-telemetry-events.md).
packaging/installer/methods/kickstart.md
-14
@@ -22,8 +22,6 @@ This installation script works on all major Linux distributions. It automaticall
22
23
</details>
24
25
----
26
-
25
## Quick Overview
26
27
| Task | Command / Location | Notes |
@@ -33,8 +31,6 @@ This installation script works on all major Linux distributions. It automaticall
31
| Customize install | Pass flags to control behavior | Directory, release, update control |
32
| Export config for IaC | Copy config from Cloud UI | For automation & Infrastructure as Code |
33
36
----
37
-
34
## Run the One-Line Install Command
35
36
To install and connect to Netdata Cloud in a single step from your terminal:
@@ -67,8 +63,6 @@ To install and connect to Netdata Cloud in a single step from your terminal:
63
64
</details>
65
70
----
71
-
66
## Optional Parameters for kickstart.sh
67
68
Use these flags to customize your installation.
@@ -88,8 +82,6 @@ Use these flags to customize your installation.
82
| **Reinstall/Uninstall** | `--reinstall` | Reinstall existing Netdata |
83
| | `--uninstall` | Uninstall Netdata completely |
84
91
----
92
-
85
## Environment Variables
86
87
These environment variables provide additional customization options (most users won't need these):
@@ -103,8 +95,6 @@ These environment variables provide additional customization options (most users
95
> [!NOTE]
96
> The user running the script needs write and execute permissions in the temporary directory specified by TMPDIR.
97
106
----
107
-
98
## Verify Script Integrity
99
100
Before running the installation script, you can verify its integrity using the following command:
@@ -115,8 +105,6 @@ Before running the installation script, you can verify its integrity using the f
105
106
If the script is valid, this command will return `OK, VALID`. We recommend verifying script integrity before installation, especially in production environments.
107
118
----
119
-
108
## Notes & Best Practices
109
110
- Stop the Agent with `sudo systemctl stop netdata` before reinstalling
@@ -124,8 +112,6 @@ If the script is valid, this command will return `OK, VALID`. We recommend verif
112
- Always verify the downloaded script for security
113
- Use the `--non-interactive` flag in CI/CD pipelines
114
127
----
128
-
115
## Related Docs
116
117
- [Connect to Netdata Cloud](/docs/netdata-cloud/connect-agent-to-cloud)
packaging/installer/methods/kubernetes.md
+22
-21
@@ -3,7 +3,7 @@ import TabItem from '@theme/TabItem';
3
4
# Install Netdata on Kubernetes
5
6
-This document details how to install Netdata on an existing Kubernetes (k8s) cluster, and connect it to Netdata Cloud.
6
+This document details how to install Netdata on an existing Kubernetes (k8s) cluster, and connect it to Netdata Cloud.
7
8
Read our [Kubernetes visualizations](/docs/dashboards-and-charts/kubernetes-tab.md) documentation, to see what you will get.
9
@@ -14,9 +14,7 @@ The [Netdata Helm chart](https://github.com/netdata/helmchart/blob/master/charts
14
To deploy Kubernetes monitoring with Netdata, you'll need:
15
16
- A working cluster running Kubernetes v1.9 or newer.
17
-- The [kubectl](https://kubernetes.io/docs/reference/kubectl/overview/) command line tool, within [one minor version
18
- difference](https://kubernetes.io/docs/tasks/tools/install-kubectl/#before-you-begin) of your cluster, on an
19
- administrative system.
17
+- The [kubectl](https://kubernetes.io/docs/reference/kubectl/overview/) command line tool, within [one minor version difference](https://kubernetes.io/docs/tasks/tools/install-kubectl/#before-you-begin) of your cluster, on an administrative system.
18
- The [Helm package manager](https://helm.sh/) v3.0.0 or newer on the same administrative system.
19
- A Netdata Cloud account with a Space to connect the cluster to.
20
@@ -44,11 +42,13 @@ The installation process securely connects your Kubernetes cluster to stream met
42
helm install netdata netdata/netdata
43
```
44
47
- > **Note**
48
- >
49
- > 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.
45
+ :::note
46
51
- For more installation options, please read our [Netdata Helm chart for Kubernetes](https://github.com/netdata/helmchart/blob/master/charts/netdata/README.md) reference.
47
+ 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
+
49
+ :::
50
+
51
+ 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
53
#### Expected Result
54
@@ -93,16 +93,20 @@ On an existing installation, in order to connect it to Netdata Cloud you will ne
93
enabled = no
94
```
95
96
- > **Note**
97
- >
98
- > Make sure to replace `YOUR_CLAIM_TOKEN` with the claim token of your space,
99
- > and `YOUR_ROOM_ID` with the ID of the Room you are willing to connect to.
96
+ :::note
97
+
98
+ Make sure to replace `YOUR_CLAIM_TOKEN` with the claim token of your space,
99
+ and `YOUR_ROOM_ID` with the ID of the Room you are willing to connect to.
100
+
101
+ :::
102
101
- These settings connect your `parent`/`child` nodes to Netdata Cloud and store more metrics in the nodes' time-series databases.
103
+ These settings connect your `parent`/`child` nodes to Netdata Cloud and store more metrics in the nodes' time-series databases.
104
103
- > **Info**
104
- >
105
- > 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.
105
+ :::info
106
+
107
+ 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.
108
+
109
+ :::
110
111
3. To apply these new settings, run:
112
@@ -117,10 +121,7 @@ The cluster terminates the old pods and creates new ones with the proper persist
121
</TabItem>
122
</Tabs>
123
120
-
122
-
123
-If you don't need to configure your Netdata deployment, [skip down](#whats-next) to see how Kubernetes monitoring works in Netdata, in addition to more guides and resources.
124
+
125
126
## Configure your Netdata monitoring deployment
127
@@ -185,4 +186,4 @@ To update Netdata's Helm chart to the latest version, run `helm repo update`, th
186
```bash
187
helm repo update
188
helm upgrade netdata netdata/netdata
188
-```
\ No newline at end of file
189
+```
packaging/installer/methods/macos.md
+24
-10
@@ -2,14 +2,23 @@
2
3
You can install Netdata in one of the three following ways:
4
5
-- **[Install Netdata with the our automatic one-line installation script (recommended)](#install-netdata-with-our-automatic-one-line-installation-script)**,
5
+- **[Install Netdata with the automatic one-line installation script (recommended)](#install-netdata-with-our-automatic-one-line-installation-script)**,
6
- [Install Netdata via Homebrew](#install-netdata-via-homebrew)
7
- [Install Netdata from source](#install-netdata-from-source)
8
9
Each of these installation option requires [Homebrew](https://brew.sh/) for handling dependencies.
10
11
-> The Netdata Homebrew package is community-created and -maintained.
12
-> 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).
11
+:::info
12
+
13
+The Netdata Homebrew package is community-created and -maintained.
14
+
15
+:::
16
+
17
+:::note
18
+
19
+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).
20
+
21
+:::
22
23
## Install Netdata with our automatic one-line installation script
24
@@ -33,7 +42,7 @@ Cloud](https://app.netdata.cloud/sign-in?cloudRoute=/spaces), then clicking on *
42
after the install.
43
- `--claim-rooms`: Specify a comma-separated list of tokens for each Room this node should appear in.
44
- `--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.
36
- See [connecting through a proxy](/src/claim/README.md#automatically-via-a-provisioning-system-or-the-command-line) for details.
45
+ See [connecting through a proxy](/src/claim/README.md#proxy-configuration) for details.
46
- `--claim-url`: Specify a URL to use when connecting to the Cloud. Defaults to `https://app.netdata.cloud`.
47
48
For example:
@@ -44,7 +53,7 @@ curl https://get.netdata.cloud/kickstart.sh > /tmp/netdata-kickstart.sh && sh /t
53
54
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.
55
47
-If you experience issues while connecting your node, follow the steps in our [Troubleshoot](/src/claim/README.md#troubleshoot) documentation.
56
+If you experience issues while connecting your node, follow the steps in our [Troubleshoot](/src/claim/README.md#troubleshooting) documentation.
57
58
## Install Netdata via Homebrew
59
@@ -102,10 +111,15 @@ We don't recommend installing Netdata from source on macOS, as it can be difficu
111
sudo ./netdata-installer.sh --install-prefix /usr/local
112
```
113
105
-> Your Netdata configuration directory will be at `/usr/local/netdata/`.
106
-> Your stock configuration directory will be at `/usr/local/lib/netdata/conf.d/`.
107
-> The installer will also install a startup plist to start Netdata when your macOS system boots.
114
+:::info
115
+
116
+- Your Netdata configuration directory will be at `/usr/local/netdata/`.
117
+- Your stock configuration directory will be at `/usr/local/lib/netdata/conf.d/`.
118
+- The installer will also install a startup plist to start Netdata when your macOS system boots.
119
+
120
+:::
121
122
Netdata works on macOS, albeit with some limitations.
110
-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.
111
-You could also use a macOS system as the parent node in a [streaming configuration](/src/streaming/README.md).
\ No newline at end of file
123
+
124
+- 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.
125
+- You could also use a macOS system as the parent node in a [streaming configuration](/src/streaming/README.md).
packaging/installer/methods/offline.md
+1
-9
@@ -16,8 +16,6 @@ Local package tools like `apt-offline` may work for DEB/RPM installs — but we
16
17
:::
18
19
----
20
-
19
## Step 1: Prepare the Offline Installation Package
20
21
On your internet-connected machine, you'll need::
@@ -61,8 +59,6 @@ The script creates a directory with all necessary files:
59
└── sha256sums.txt # Verification hashes
60
```
61
64
----
65
-
62
## Step 2: Transfer to Offline System
63
64
Copy the entire `netdata-offline` directory to your offline system using your preferred method (USB drive, secure copy, etc.).
@@ -80,8 +76,6 @@ The folder name `netdata-offline` is just an example — use any name you want.
76
77
:::
78
83
----
84
-
79
### Output
80
81
This will create a directory like:
@@ -126,8 +120,6 @@ Don't rename or modify the files.
120
121
:::
122
129
----
130
-
123
2. On the offline system, run:
124
125
```bash
@@ -143,4 +135,4 @@ The `install.sh` script accepts the [same parameters](/packaging/installer/metho
135
136
Automatic updates are *disabled* by default for offline installations — since there’s no network connection.
137
146
-:::
\ No newline at end of file
138
+:::
packaging/installer/methods/pfsense.md
+20
-31
@@ -1,13 +1,12 @@
1
# Install Netdata on pfSense CE
2
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
9
-> PR](https://github.com/netdata/netdata/edit/master/packaging/installer/methods/pfsense.md) with your recommended
10
-> improvements or changes. Thank you!
3
+:::info
4
+
5
+This document is maintained by Netdata's community, and may not be completely up-to-date. Please double-check the details of the installation process, such as version numbers for downloadable packages, before proceeding.
6
+
7
+You can help improve this document by [submitting a PR](https://github.com/netdata/netdata/edit/master/packaging/installer/methods/pfsense.md) with your recommended improvements or changes. Thank you!
8
+
9
+:::
10
11
## Install prerequisites/dependencies
12
@@ -36,17 +35,6 @@ pkg install py39-urllib3
35
pkg install py39-yaml
36
```
37
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.
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.
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`.
49
-
38
## Install Netdata
39
40
You can now install Netdata from the FreeBSD repository.
@@ -55,9 +43,11 @@ You can now install Netdata from the FreeBSD repository.
43
pkg install netdata
44
```
45
58
-> ⚠️ If the above command returns a `Not Found` error, you need to manually search for the latest version of Netdata in
59
-> the [FreeBSD repository](https://www.freebsd.org/ports/). Search for `netdata`, find the latest version number, and
60
-> update the command accordingly.
46
+:::warning
47
+
48
+If the above command returns a `Not Found` error, you need to manually search for the latest version of Netdata in the [FreeBSD repository](https://www.freebsd.org/ports/). Search for `netdata`, find the latest version number, and update the command accordingly.
49
+
50
+:::
51
52
You must edit `/usr/local/etc/netdata/netdata.conf` and change `bind to = 127.0.0.1` to `bind to = 0.0.0.0`.
53
@@ -65,14 +55,13 @@ To start Netdata manually, run `service netdata onestart`.
55
56
Visit the Netdata dashboard to confirm it's working: `http://<pfsenseIP>:19999`
57
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`.
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.
58
+To start Netdata automatically every boot, add `service netdata onestart` as a Shellcmd entry within the pfSense web interface under **Services/Shellcmd**. You'll need to install the Shellcmd package beforehand under **System/Package Manager/Available Packages**. The Shellcmd Type should be set to `Shellcmd`.
59
+ Alternatively, more information can be found in <https://doc.pfsense.org/index.php/Installing_FreeBSD_Packages>, for achieving the same via the command line and scripts.
60
+
61
+If you experience an issue with `/usr/bin/install` being absent in pfSense 2.3 or earlier, update pfSense or use a workaround from <https://redmine.pfsense.org/issues/6643>
62
+
63
+:::note
64
75
-If you experience an issue with `/usr/bin/install` being absent in pfSense 2.3 or earlier, update pfSense or use a
76
-workaround from <https://redmine.pfsense.org/issues/6643>
65
+In pfSense, the Netdata configuration files are located under `/usr/local/etc/netdata`.
66
78
-**Note:** In pfSense, the Netdata configuration files are located under `/usr/local/etc/netdata`.
67
+:::