diff options
Diffstat (limited to 'docs/deployment-guides/standalone-deployment.md')
| -rw-r--r-- | docs/deployment-guides/standalone-deployment.md | 139 |
1 files changed, 139 insertions, 0 deletions
diff --git a/docs/deployment-guides/standalone-deployment.md b/docs/deployment-guides/standalone-deployment.md new file mode 100644 index 0000000000..5baef805a9 --- /dev/null +++ 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). |