Documentation changes, new files and restructuring the hierarchy (net…

…data#17014) * docs additions * docs from writerside, not to be published in this state, links need work and Learn map needs to include them * rename some files to reduce repetition on filenames * use new packaging documentation and replace links to old * change learn-rel-path to new category names * replace configuration file with new one, add conf directory section to it, and replace links to point to that * linkfix * run integrations pipeline to get new links * catoverpage * fix writerside style links * addition in on-prem mention * comment out mermaid problematic line * change path of alerting integrations docs for Learn * fix * fixes * fix diagrams
webfutureiorepo · Feb 20, 2024 · f27f4f7 · f27f4f7
1 parent 3da2004
commit f27f4f7
Show file tree

Hide file tree

Showing 281 changed files with 3,171 additions and 1,179 deletions.
diff --git a/docs/category-overview-pages/developer-and-contributor-corner.md b/docs/category-overview-pages/developer-and-contributor-corner.md
@@ -0,0 +1,3 @@
+# Developer and Contributor Corner
+
+In this section of our Documentation you will find more advanced information, suited for developers and contributors alike.
diff --git a/docs/category-overview-pages/installation-overview.md b/docs/category-overview-pages/installation-overview.md
@@ -1,7 +1,7 @@
 # Installation
 
 In this category you can find instructions on all the possible ways you can install Netdata on the
-[supported platforms](https://github.com/netdata/netdata/blob/master/packaging/PLATFORM_SUPPORT.md).
+[supported platforms](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/versions-and-platforms.md).
 
 If this is your first time using Netdata, we recommend that you first start with the 
 [quick installation guide](https://github.com/netdata/netdata/edit/master/packaging/installer/README.md) and then 

diff --git a/docs/contributing/style-guide.md b/docs/contributing/style-guide.md
@@ -305,7 +305,7 @@ Don't include full paths, beginning from the system's root (`/`), as these might
 |                 |                                                                                                                                                                                                                                                                                                    |
 |-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | Not recommended | Use `edit-config` to edit Netdata's configuration: `sudo /etc/netdata/edit-config netdata.conf`.                                                                                                                                                                                                   |
-| **Recommended** | Use `edit-config` to edit Netdata's configuration by first navigating to your [Netdata config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory), which is typically at `/etc/netdata`, then running `sudo edit-config netdata.conf`. |
+| **Recommended** | Use `edit-config` to edit Netdata's configuration by first navigating to your [Netdata config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration.md#the-netdata-config-directory), which is typically at `/etc/netdata`, then running `sudo edit-config netdata.conf`. |
 
 ### `sudo`
 

diff --git a/docs/deployment-guides/README.md b/docs/deployment-guides/README.md
@@ -0,0 +1,25 @@
+# Deployment Guides
+
+Netdata can be used to monitor all kinds of infrastructure, from stand-alone tiny IoT devices to complex hybrid setups combining on-premise and cloud infrastructure, mixing bare-metal servers, virtual machines and containers.
+
+There are 3 components to structure your Netdata ecosystem:
+
+1. **Netdata Agents**
+
+   To monitor the physical or virtual nodes of your infrastructure, including all applications and containers running on them.
+
+   Netdata Agents are Open-Source, licensed under GPL v3+.
+
+2. **Netdata Parents**
+
+   To create [observability centralization points](https://github.com/netdata/netdata/blob/master/docs/observability-centralization-points/README.md) within your infrastructure, to offload Netdata Agents functions from your production systems, to provide high-availability of your data, increased data retention and isolation of your nodes.
+
+   Netdata Parents are implemented using the Netdata Agent software. Any Netdata Agent can be an Agent for a node and a Parent  for other Agents, at the same time.
+
+   It is recommended to set up multiple Netdata Parents. They will all seamlessly be integrated by Netdata Cloud into one monitoring solution.
+
+3. **Netdata Cloud**
+
+   Our SaaS, combining all your infrastructure, all your Netdata Agents and Parents, into one uniform, distributed, scalable, monitoring database, offering advanced data slicing and dicing capabilities, custom dashboards, advanced troubleshooting tools, user management, centralized management of alerts, and more.
+
+The Netdata Agent is a highly modular software piece, providing data collection via numerous plugins, an in-house crafted time-series database, a query engine, health monitoring and alerts, machine learning and anomaly detection, metrics exporting to third party systems.
diff --git a/docs/deployment-guides/deployment-with-centralization-points.md b/docs/deployment-guides/deployment-with-centralization-points.md
@@ -0,0 +1,121 @@
+# Deployment with Centralization Points
+
+An observability centralization point can centralize both metrics and logs. The sending systems are called Children, while the receiving systems are called a Parents.
+
+When metrics and logs are centralized, the Children are never queried for metrics and logs. The Netdata Parents have all the data needed to satisfy queries.
+
+- **Metrics** are centralized by Netdata, with a feature we call **Streaming**. The Parents listen for incoming connections and permit access only to Children that connect to it with the right API key. Children are configured to push their metrics to the Parents and they initiate the connections to do so.
+
+- **Logs** are centralized with methodologies provided by `systemd-journald`. This involves installing `systemd-journal-remote` on both the Parent and the Children, and configuring the keys required for this communication.
+
+|                    Feature                    |                                                 How it works                                                  |
+|:---------------------------------------------:|:-------------------------------------------------------------------------------------------------------------:|
+| Unified infrastructure dashboards for metrics |                                             Yes, at Netdata Cloud                                             |
+|  Unified infrastructure dashboards for logs   | All logs are accessible via the same dashboard at Netdata Cloud, although they are unified per Netdata Parent |
+|          Centrally configured alerts          |                                            Yes, at Netdata Parents                                            |
+|   Centrally dispatched alert notifications    |                                             Yes, at Netdata Cloud                                             |
+|         Data are exclusively on-prem          |                                                 Yes, Netdata Cloud queries Netdata Agents to satisfy dashboard queries.                                                 |
+
+A configuration with 2 observability centralization points, looks like this:
+
+```mermaid
+flowchart LR
+    WEB[["One unified
+        dashboard
+        for all nodes"]]
+    NC(["<b>Netdata Cloud</b>
+        decides which agents
+        need to be queried"])
+    SA1["Netdata at AWS
+         A1"]
+    SA2["Netdata at AWS
+         A2"]
+    SAN["Netdata at AWS
+         AN"]
+    PA["<b>Netdata Parent A</b>
+        at AWS
+        having all metrics & logs
+        for all Ax nodes"]
+    SB1["Netdata On-Prem
+         B1"]
+    SB2["Netdata On-Prem
+         B2"]
+    SBN["Netdata On-Prem
+         BN"]
+    PB["<b>Netdata Parent B</b>
+        On-Prem
+        having all metrics & logs
+        for all Bx nodes"]
+    WEB -->|query| NC -->|query| PA & PB
+    PA ---|stream| SA1 & SA2 & SAN
+    PB ---|stream| SB1 & SB2 & SBN 
+```
+
+Netdata Cloud queries the Netdata Parents to provide aggregated dashboard views.
+
+For alerts, the dispatch of notifications looks like in the following chart:
+
+```mermaid
+flowchart LR
+    NC(["<b>Netdata Cloud</b>
+        applies silencing
+        & user settings"])
+    SA1["Netdata at AWS
+         A1"]
+    SA2["Netdata at AWS
+         A2"]
+    SAN["Netdata at AWS
+         AN"]
+    PA["<b>Netdata Parent A</b>
+        at AWS
+        having all metrics & logs
+        for all Ax nodes"]
+    SB1["Netdata On-Prem
+         B1"]
+    SB2["Netdata On-Prem
+         B2"]
+    SBN["Netdata On-Prem
+         BN"]
+    PB["<b>Netdata Parent B</b>
+        On-Prem
+        having all metrics & logs
+        for all Bx nodes"]
+    EMAIL{{"<b>e-mail</b>
+        notifications"}}
+    MOBILEAPP{{"<b>Netdata Mobile App</b>
+        notifications"}}
+    SLACK{{"<b>Slack</b>
+        notifications"}}
+    OTHER{{"Other
+        notifications"}}
+    PA & PB -->|alert transitions| NC -->|notification| EMAIL & MOBILEAPP & SLACK & OTHER 
+    SA1 & SA2 & SAN ---|stream| PA
+    SB1 & SB2 & SBN ---|stream| PB 
+```
+
+### Configuration steps for deploying Netdata with Observability Centralization Points
+
+For Metrics:
+
+- Install Netdata agents on all systems and the Netdata Parents.
+
+- Configure `stream.conf` at the Netdata Parents to enable streaming access with an API key.
+
+- Configure `stream.conf` at the Netdata Children to enable streaming to the configured Netdata Parents.
+
+For Logs:
+
+- Install `systemd-journal-remote` on all systems and the Netdata Parents.
+
+- Configure `systemd-journal-remote` at the Netdata Parents to enable logs reception.
+
+- Configure `systemd-journal-upload` at the Netdata Children to enable transmission of their logs to the Netdata Parents.
+
+Optionally:
+
+- Disable ML, health checks and dashboard access at Netdata Children to save resources and avoid duplicate notifications.
+
+When using Netdata Cloud:
+
+- Optionally: disable dashboard access on all Netdata agents (including Netdata Parents).
+- Optionally: disable alert notifications on all Netdata agents (including Netdata Parents).
diff --git a/docs/deployment-guides/standalone-deployment.md b/docs/deployment-guides/standalone-deployment.md
@@ -0,0 +1,139 @@
+# Standalone Deployment
+
+To help our users have a complete experience of Netdata when they install it for the first time, a Netdata Agent with default configuration is a complete monitoring solution out of the box, having all its features enabled and available.
+
+So, each Netdata agent acts as a standalone monitoring system by default.
+
+## Standalone agents, without Netdata Cloud
+
+|                    Feature                    |                     How it works                     |
+|:---------------------------------------------:|:----------------------------------------------------:|
+| Unified infrastructure dashboards for metrics |  No, each Netdata agent provides its own dashboard   |
+|  Unified infrastructure dashboards for logs   |     No, each Netdata agent exposes its own logs      |
+|          Centrally configured alerts          |  No, each Netdata has its own alerts configuration   |
+|   Centrally dispatched alert notifications    | No, each Netdata agent sends notifications by itself |
+|         Data are exclusively on-prem          |                         Yes                          |
+
+When using Standalone Netdata agents, each of them offers an API and a dashboard, at its own unique URL, that looks like `http://agent-ip:19999`.
+
+So, each of the Netdata agents has to be accessed individually and independently of the others:
+
+```mermaid
+flowchart LR
+    WEB[["Multiple
+        Independent
+        Dashboards"]]
+    S1["Standalone
+        Netdata
+         1"]
+    S2["Standalone
+        Netdata
+         2"]
+    SN["Standalone
+        Netdata
+         N"]
+    WEB -->|URL 1| S1
+    WEB -->|URL 2| S2
+    WEB -->|URL N| SN
+```
+
+The same is true for alert notifications. Each of the Netdata agents runs its own alerts and sends notifications by itself, according to its configuration:
+
+```mermaid
+flowchart LR
+    S1["Standalone
+        Netdata
+         1"]
+    S2["Standalone
+        Netdata
+         2"]
+    SN["Standalone
+        Netdata
+         N"]
+    EMAIL{{"<b>e-mail</b>
+        notifications"}}
+    SLACK{{"<b>Slack</b>
+        notifications"}}
+    OTHER{{"Other
+        notifications"}}
+    S1 & S2 & SN .-> SLACK
+    S1 & S2 & SN ---> EMAIL
+    S1 & S2 & SN ==> OTHER
+```
+
+### Configuration steps for standalone Netdata agents without Netdata Cloud
+
+No special configuration needed.
+
+- Install Netdata agents on all your systems, then access each of them via its own unique URL, that looks like `http://agent-ip:19999/`.
+
+## Standalone agents, with Netdata Cloud
+
+|                    Feature                    |                                                                              How it works                                                                               |
+|:---------------------------------------------:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
+| Unified infrastructure dashboards for metrics |                                                 Yes, via Netdata Cloud, all charts aggregate metrics from all servers.                                                  |
+|  Unified infrastructure dashboards for logs   | All logs are accessible via the same dashboard at Netdata Cloud, although they are not unified (ie. logs from different servers are not multiplexed into a single view) |
+|             Centrally configured alerts       |                                                            No, each Netdata has its own alerts configuration                                                            |
+|   Centrally dispatched alert notifications    |                                                                         Yes, via Netdata Cloud                                                                          |
+|         Data are exclusively on-prem          |                                                 Yes, Netdata Cloud queries Netdata Agents to satisfy dashboard queries.                                                 |
+
+By [connecting all Netdata agents to Netdata Cloud](https://github.com/netdata/netdata/blob/master/src/claim/README.md), you can have a unified infrastructure view of all your nodes, with aggregated charts, without configuring [observability centralization points](https://github.com/netdata/netdata/blob/master/docs/observability-centralization-points/README.md).
+
+```mermaid
+flowchart LR
+    WEB[["One unified
+        dashboard
+        for all nodes"]]
+    NC(["<b>Netdata Cloud</b>
+        decides which agents
+        need to be queried"])
+    S1["Standalone
+        Netdata
+         1"]
+    S2["Standalone
+        Netdata
+         2"]
+    SN["Standalone
+        Netdata
+         N"]
+    WEB -->|queries| NC
+    NC -->|queries| S1 & S2 & SN
+```
+
+Similarly for alerts, Netdata Cloud receives all alert transitions from all agents, decides which notifications should be sent and how, applies silencing rules, maintenance windows and based on each Netdata Cloud space and user settings, dispatches notifications:
+
+```mermaid
+flowchart LR
+    EMAIL{{"<b>e-mail</b>
+        notifications"}}
+    MOBILEAPP{{"<b>Netdata Mobile App</b>
+        notifications"}}
+    SLACK{{"<b>Slack</b>
+        notifications"}}
+    OTHER{{"Other
+        notifications"}}
+    NC(["<b>Netdata Cloud</b>
+        applies silencing
+        & user settings"])
+    S1["Standalone
+        Netdata
+         1"]
+    S2["Standalone
+        Netdata
+         2"]
+    SN["Standalone
+        Netdata
+         N"]
+    NC -->|notification| EMAIL & MOBILEAPP & SLACK & OTHER
+    S1 & S2 & SN -->|alert transition| NC
+```
+
+> Note that alerts are still triggered by Netdata agents. Netdata Cloud takes care of the notifications only.
+
+### Configuration steps for standalone Netdata agents with Netdata Cloud
+
+- Install Netdata agents using the commands given by Netdata Cloud, so that they will be automatically added to your Netdata Cloud space. Otherwise, install Netdata agents and then claim them via the command line or their dashboard.
+
+- Optionally: disable their direct dashboard access to secure them.
+
+- Optionally: disable their alert notifications to avoid receiving email notifications directly from them (email notifications are automatically enabled when a working MTA is found on the systems Netdata agents are installed).
diff --git a/docs/export/enable-connector.md b/docs/export/enable-connector.md
@@ -24,7 +24,7 @@ Once you understand the process of enabling a connector, you can translate that
 ## Enable the exporting engine
 
 Use `edit-config` from your
-[Netdata config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory)
+[Netdata config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration.md#the-netdata-config-directory)
 to open `exporting.conf`:
 
 ```bash

diff --git a/docs/guides/monitor/raspberry-pi-anomaly-detection.md b/docs/guides/monitor/raspberry-pi-anomaly-detection.md
@@ -24,7 +24,7 @@ Read on to learn all the steps and enable unsupervised anomaly detection on your
 First make sure Netdata is using Python 3 when it runs Python-based data collectors. 
 
 Next, open `netdata.conf` using [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#use-edit-config-to-edit-configuration-files)
-from within the [Netdata config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory). Scroll down to the
+from within the [Netdata config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration.md#the-netdata-config-directory). Scroll down to the
 `[plugin:python.d]` section to pass in the `-ppython3` command option. 
 
 ```conf

diff --git a/docs/metrics-storage-management/enable-streaming.md b/docs/metrics-storage-management/enable-streaming.md
@@ -114,7 +114,7 @@ itself while initiating a streaming connection. Copy that into a separate text f
 > Find out how to [install `uuidgen`](https://command-not-found.com/uuidgen) on your node if you don't already have it.
 
 Next, open `stream.conf` using [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#use-edit-config-to-edit-configuration-files)
-from within the [Netdata config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory).
+from within the [Netdata config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration.md#the-netdata-config-directory).
 
 ```bash
 cd /etc/netdata
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Developer and Contributor Corner

		In this section of our Documentation you will find more advanced information, suited for developers and contributors alike.