From 3bac7654b70d1a61416f2c13d8ece679b20f7e5a Mon Sep 17 00:00:00 2001 From: Joel Hans Date: Thu, 16 Apr 2020 13:57:00 -0700 Subject: Docs: Combined claiming+ACLK documentation (#8724) * Init new documents * Finalize draft of combined claiming doc * Add notice to anonymous stats * Remove .. from links * Update none proxy setting * Changes for Andrew and Manos * Remove E2EE from ACLK * Add details about netdata user --- aclk/README.md | 43 +++++++++++++++++++++++++++++++++---------- 1 file changed, 33 insertions(+), 10 deletions(-) (limited to 'aclk/README.md') diff --git a/aclk/README.md b/aclk/README.md index 1afda5a148..b4f94ea974 100644 --- a/aclk/README.md +++ b/aclk/README.md @@ -1,25 +1,48 @@ # Agent-cloud link (ACLK) +The Agent-Cloud link (ACLK) is the mechanism responsible for connecting a Netdata Agent to Netdata Cloud. The ACLK uses +[MQTT](https://en.wikipedia.org/wiki/MQTT) over secure websockets to first create, persist, encrypt the connection, and +then enable the features found in Netdata Cloud. _No data is exchanged with Netdata Cloud until you claim a node._ -## Configuration Options +Read our [claiming documentation](/claim/README.md) for a guide for claiming a node using the ACLK and additional +troubleshooting and reference information. -In `netdata.conf`: +## Enable and configure the ACLK -```ini +The ACLK is enabled by default and automatically configured if the prerequisites installed correctly. You can see this +in the `[cloud]` section of `netdata.conf`. + +```conf [cloud] - proxy = none + cloud base url = https://app.netdata.cloud ``` -Parameter proxy can take one of the following values: +If your Agent needs to use a proxy to access the internet, you must [set up a proxy for +claiming](/claim/README.md#claiming-through-a-proxy). + +## Disable the ACLK + +You have two options if you prefer to disable the ACLK and not use Netdata Cloud: + +1. Pass `--disable-cloud` to `netdata-installer.sh` during installation. When you pass this parameter, the installer + does not download or compile any extra libraries, and the Agent behaves as though the ACLK, and thus Netdata Cloud, + does not exist. ACLK functionality is available in the Agent but remains fully inactive. + +2. Change a runtime setting in your `netdata.conf` file. This setting only stops the Agent from attempting any + connection via the ACLK, but does not prevent the installer from downloading and compiling the ACLK's dependencies. + +```conf +[global] + netdata cloud = disable +``` -- `env` - the default (try to read environment variables `http_proxy` and `socks_proxy`) -- `none` - do not use any proxy (even if system configured otherwise) -- `socks5[h]://[user:pass@]host:ip` - will use specified socks proxy -- `http://[user:pass@]host:ip` - will use specified http proxy +[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Faclk%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>) -- cgit v1.2.3