summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTimotej S <6674623+underhood@users.noreply.github.com>2021-12-10 17:31:40 +0100
committerGitHub <noreply@github.com>2021-12-10 16:31:40 +0000
commit063e353c77aa490756c87b1e808f2a85f2e26909 (patch)
tree97796a00523710487aec8e601ff89dfd1a0db16c
parent2632f3f3eac4d6d68ad90b6f7558a2b2b03c9961 (diff)
Minor ACLK docu updates (#11882)
* update docs * update netdatacli list * remove implied * Update aclk/README.md Co-authored-by: Tiny <kickoke@users.noreply.github.com> Co-authored-by: Tiny <kickoke@users.noreply.github.com>
-rw-r--r--aclk/README.md9
-rw-r--r--claim/README.md31
-rw-r--r--cli/README.md10
3 files changed, 36 insertions, 14 deletions
diff --git a/aclk/README.md b/aclk/README.md
index 13a9be27f7..2293f97afd 100644
--- a/aclk/README.md
+++ b/aclk/README.md
@@ -63,7 +63,7 @@ You can configure following keys in the `netdata.conf` section `[cloud]`:
[cloud]
statistics = yes
query thread count = 2
- aclk implementation = legacy
+ aclk implementation = ng
```
- `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.
@@ -84,7 +84,12 @@ Features:
To verify which ACLK implementation Netdata uses, visit the `/api/v1/info` endpoint on your local dashboard and check the `aclk-implementation` key.
-New Netdata Cloud features will be implemented on top of ACLK-NG from this point on. ACLK Legacy is therefore kept as a fallback in case some users have issues with ACLK-NG or need to use features which are not yet available in ACLK-NG *(like IPv6 support and SOCKS proxy)*.
+New Netdata Cloud features will be implemented on top of ACLK-NG only. ACLK Legacy is therefore kept as a fallback in case some users have issues.
+
+
+> Note: ACLK Legacy will be removed in following releases!
+> Update your ACLK configuration to ACLK-NG to prevent any disruptions.
+
### Improvements of ACLK-NG over Legacy are:
- No dependency on custom patched `libmosquitto` (no bundling of libraries). Which should remove obstacles many GNU/Linux distribution package maintainers had trying to provide Netdata with Cloud support
diff --git a/claim/README.md b/claim/README.md
index bbccaac198..b709b0f06f 100644
--- a/claim/README.md
+++ b/claim/README.md
@@ -239,7 +239,7 @@ for details on connecting a parent Netdata pod.
### Connect through a proxy
-A Space's administrator can connect a node through a SOCKS5 or HTTP(S) proxy.
+A Space's administrator can connect a node through HTTP(S) proxy.
You should first configure the proxy in the `[cloud]` section of `netdata.conf`. The proxy settings you specify here
will also be used to tunnel the ACLK. The default `proxy` setting is `none`.
@@ -252,16 +252,15 @@ will also be used to tunnel the ACLK. The default `proxy` setting is `none`.
The `proxy` setting can take one of the following values:
- `none`: Do not use a proxy, even if the system configured otherwise.
-- `env`: Try to read proxy settings from set environment variables `http_proxy`/`socks_proxy`.
-- `socks5[h]://[user:pass@]host:ip`: The ACLK and connection process will use the specified SOCKS5 proxy.
+- `env`: Try to read proxy settings from set environment variables `http_proxy`.
- `http://[user:pass@]host:ip`: The ACLK and connection process will use the specified HTTP(S) proxy.
-For example, a SOCKS5 proxy setting may look like the following:
+For example, a HTTP proxy setting may look like the following:
```conf
[cloud]
- proxy = socks5h://203.0.113.0:1080 # With an IP address
- proxy = socks5h://proxy.example.com:1080 # With a URL
+ proxy = http://203.0.113.0:1080 # With an IP address
+ proxy = http://proxy.example.com:1080 # With a URL
```
You can now move on to connecting. When you connect with the [kickstart](/packaging/installer/#automatic-one-line-installation-script) script, add the `--claim-proxy=` parameter and
@@ -289,6 +288,18 @@ might be having with the ACLK or connection process.
"aclk-available"
```
+On Netdata agent version `1.32` (`netdata -v` to find your version) and newer, the `netdata -W aclk-state` command can be used to get some diagnostic information about ACLK. Sample output:
+
+```
+ACLK Available: Yes
+ACLK Implementation: Next Generation
+New Cloud Protocol Support: Yes
+Claimed: Yes
+Claimed Id: 53aa76c2-8af5-448f-849a-b16872cc4ba1
+Online: Yes
+Used Cloud Protocol: New
+```
+
Use these keys and the information below to troubleshoot the ACLK.
#### kickstart: unsupported Netdata installation
@@ -347,7 +358,7 @@ Additionally, check that the `enabled` setting in `var/lib/netdata/cloud.d/cloud
To fix this issue, reinstall Netdata using your [preferred method](/packaging/installer/README.md) and do not add the
`--disable-cloud` option.
-#### cloud-available is false
+#### cloud-available is false / ACLK Available: No
If `cloud-available` is `false` after you verified Cloud is enabled in the previous step, the most likely issue is that
Cloud features failed to build during installation.
@@ -377,7 +388,7 @@ You may see one of the following error messages during installation:
- Unable to fetch sources for JSON-C. Netdata Cloud support will be disabled.
One common cause of the installer failing to build Cloud features is not having one of the following dependencies on
-your system: `cmake` and OpenSSL, including the `devel` package.
+your system: `cmake`, `json-c` and `OpenSSL`, including corresponding `devel` packages.
You can also look for error messages in `/var/log/netdata/error.log`. Try one of the following two commands to search
for ACLK-related errors.
@@ -391,11 +402,11 @@ If the installer's output does not help you enable Cloud features, contact us by
GitHub](https://github.com/netdata/netdata/issues/new?labels=bug%2C+needs+triage%2C+ACLK&template=bug_report.md&title=The+installer+failed+to+prepare+the+required+dependencies+for+Netdata+Cloud+functionality)
with details about your system and relevant output from `error.log`.
-#### agent-claimed is false
+#### agent-claimed is false / Claimed: No
You must [connect your node](#how-to-connect-a-node).
-#### aclk-available is false
+#### aclk-available is false / Online: No
If `aclk-available` is `false` and all other keys are `true`, your Agent is having trouble connecting to the Cloud
through the ACLK. Please check your system's firewall.
diff --git a/cli/README.md b/cli/README.md
index 1962b2ede5..6eb121be5f 100644
--- a/cli/README.md
+++ b/cli/README.md
@@ -17,8 +17,10 @@ help
Show this help menu.
reload-health
Reload health configuration.
+reload-labels
+ Reload all labels.
save-database
- Save internal DB to disk for for memory mode save.
+ Save internal DB to disk for memory mode save.
reopen-logs
Close and reopen log files.
shutdown-agent
@@ -26,7 +28,11 @@ shutdown-agent
fatal-agent
Log the state and halt the netdata agent.
reload-claiming-state
- Reload agent connection state from disk.
+ Reload agent claiming state from disk.
+ping
+ Return with 'pong' if agent is alive.
+aclk-state [json]
+ Returns current state of ACLK and Cloud connection. (optionally in json)
```
Those commands are the same that can be sent to netdata via [signals](/daemon/README.md#command-line-options).