forked from netdata/netdata
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Plans and ACLK docs edits (netdata#19140)
* plans and aclk docs read-through * aclk readme update --------- Co-authored-by: ilyam8 <[email protected]>
- Loading branch information
Showing
2 changed files
with
30 additions
and
40 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,45 +1,36 @@ | ||
| # Agent-Cloud link (ACLK) | ||
|
|
||
| The Agent-Cloud link (ACLK) is the mechanism responsible for securely connecting a Netdata Agent to your web browser | ||
| through Netdata Cloud. The ACLK establishes an outgoing secure WebSocket (WSS) connection to Netdata Cloud on port | ||
| `443`. The ACLK is encrypted, safe, and _is only established if you connect your node_. | ||
| The Agent-Cloud Link (ACLK) provides secure communication between your Netdata Agents and Cloud. This connection: | ||
|
|
||
| The Cloud App lives at app.netdata.cloud which currently resolves to the following list of IPs: | ||
| - Uses outgoing secure WebSocket (WSS) on port `443` | ||
| - Activates only after you [connect a node](/src/claim/README.md)) to your Space | ||
| - Ensures encrypted, safe data transmission | ||
|
|
||
| - 54.198.178.11 | ||
| - 44.207.131.212 | ||
| - 44.196.50.41 | ||
| For ACLK to function properly, your Agents need outbound access to Netdata Cloud services. | ||
|
|
||
| > **Caution** | ||
| > | ||
| >This list of IPs can change without notice, we strongly advise you to whitelist following domains `app.netdata.cloud`, `mqtt.netdata.cloud`, if this is not an option in your case always verify the current domain resolution (e.g via the `host` command). | ||
| | Allowlisting Method | Required Access | | ||
| |---------------------|---------------------------------------------------------| | ||
| | Domain | • `app.netdata.cloud`<br/>• `mqtt.netdata.cloud` | | ||
| | IP | • 54.198.178.11<br/>• 44.207.131.212<br/>• 44.196.50.41 | | ||
|
|
||
| For a guide to connecting a node using the ACLK, plus additional troubleshooting and reference information, read our [connect to Cloud | ||
| documentation](/src/claim/README.md). | ||
| > **Important** | ||
| > | ||
| > IP addresses can change without notice. Always **prefer domain allowlisting**. If you must use IP addresses, verify them regularly with the host command. | ||
| ## Data privacy | ||
|
|
||
| [Data privacy](https://netdata.cloud/privacy/) is very important to us. We firmly believe that your data belongs to | ||
| you. This is why **we don't store any metric data in Netdata Cloud**. | ||
| Your monitoring data belongs to you. Here's how we ensure this: | ||
|
|
||
| All the data that you see in the web browser when using Netdata Cloud, is actually streamed directly from the Netdata Agent to the Netdata Cloud dashboard. The data passes through our systems, but it isn't stored. | ||
| - **Zero Metric Storage**: We do not store any metrics or logs in Netdata Cloud. | ||
| - **Local Data Control**: All your monitoring data stays within your infrastructure. | ||
| - **Minimal Metadata**: We store only essential metadata needed for coordination and access control. | ||
|
|
||
| However, to be able to offer the stunning visualizations and advanced functionality of Netdata Cloud, it does store a limited number of _metadata_. Read more about our [security and privacy design](/docs/security-and-privacy-design/README.md). | ||
|
|
||
| ## Enable and configure the ACLK | ||
| For complete transparency: | ||
|
|
||
| The ACLK is enabled by default, with its settings automatically configured and stored in the Agent's memory. | ||
| - Read our detailed [Privacy Policy](https://netdata.cloud/privacy/) | ||
| - Learn more about [stored metadata](/docs/netdata-cloud/README.md#stored-metadata) | ||
|
|
||
| If your Agent needs to use a proxy to access the internet, you must [set up a proxy for | ||
| connecting to cloud](/src/claim/README.md). | ||
|
|
||
| You can configure following keys in the `netdata.conf` section `[cloud]`: | ||
|
|
||
| ```text | ||
| [cloud] | ||
| statistics = yes | ||
| query thread count = 2 | ||
| ``` | ||
| ## Enable and configure the ACLK | ||
|
|
||
| - `statistics` enables/disables ACLK related statistics and their charts. You can disable this to save some space in the database and slightly reduce memory usage of Netdata Agent. | ||
| - `query thread count` specifies the number of threads to process cloud queries. Increasing this setting is useful for nodes with many children (streaming), which can expect to handle more queries (and/or more complicated queries). | ||
| The Agent-Cloud Link is enabled automatically—no configuration needed. | ||
| If your Agent requires a proxy to access the internet, you'll need to [configure proxy settings](/src/claim/README.md#automatically-via-a-provisioning-system-or-the-command-line). |