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>
Timotej S committed
Dec 10, 2021 at 17:31 UTC
063e353c77aa490756c87b1e808f2a85f2e26909
3 files changed
+36
-14
aclk/README.md
+7
-2
@@ -63,7 +63,7 @@ You can configure following keys in the `netdata.conf` section `[cloud]`:
63
[cloud]
64
statistics = yes
65
query thread count = 2
66
- aclk implementation = legacy
66
+ aclk implementation = ng
67
```
68
69
- `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:
84
85
To verify which ACLK implementation Netdata uses, visit the `/api/v1/info` endpoint on your local dashboard and check the `aclk-implementation` key.
86
87
-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)*.
87
+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.
88
+
89
+
90
+> Note: ACLK Legacy will be removed in following releases!
91
+> Update your ACLK configuration to ACLK-NG to prevent any disruptions.
92
+
93
94
### Improvements of ACLK-NG over Legacy are:
95
- 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
claim/README.md
+21
-10
@@ -239,7 +239,7 @@ for details on connecting a parent Netdata pod.
239
240
### Connect through a proxy
241
242
-A Space's administrator can connect a node through a SOCKS5 or HTTP(S) proxy.
242
+A Space's administrator can connect a node through HTTP(S) proxy.
243
244
You should first configure the proxy in the `[cloud]` section of `netdata.conf`. The proxy settings you specify here
245
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`.
252
The `proxy` setting can take one of the following values:
253
254
- `none`: Do not use a proxy, even if the system configured otherwise.
255
-- `env`: Try to read proxy settings from set environment variables `http_proxy`/`socks_proxy`.
256
-- `socks5[h]://[user:pass@]host:ip`: The ACLK and connection process will use the specified SOCKS5 proxy.
255
+- `env`: Try to read proxy settings from set environment variables `http_proxy`.
256
- `http://[user:pass@]host:ip`: The ACLK and connection process will use the specified HTTP(S) proxy.
257
259
-For example, a SOCKS5 proxy setting may look like the following:
258
+For example, a HTTP proxy setting may look like the following:
259
260
```conf
261
[cloud]
263
- proxy = socks5h://203.0.113.0:1080 # With an IP address
264
- proxy = socks5h://proxy.example.com:1080 # With a URL
262
+ proxy = http://203.0.113.0:1080 # With an IP address
263
+ proxy = http://proxy.example.com:1080 # With a URL
264
```
265
266
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.
288
"aclk-available"
289
```
290
291
+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:
292
+
293
+```
294
+ACLK Available: Yes
295
+ACLK Implementation: Next Generation
296
+New Cloud Protocol Support: Yes
297
+Claimed: Yes
298
+Claimed Id: 53aa76c2-8af5-448f-849a-b16872cc4ba1
299
+Online: Yes
300
+Used Cloud Protocol: New
301
+```
302
+
303
Use these keys and the information below to troubleshoot the ACLK.
304
305
#### kickstart: unsupported Netdata installation
@@ -347,7 +358,7 @@ Additionally, check that the `enabled` setting in `var/lib/netdata/cloud.d/cloud
358
To fix this issue, reinstall Netdata using your [preferred method](/packaging/installer/README.md) and do not add the
359
`--disable-cloud` option.
360
350
-#### cloud-available is false
361
+#### cloud-available is false / ACLK Available: No
362
363
If `cloud-available` is `false` after you verified Cloud is enabled in the previous step, the most likely issue is that
364
Cloud features failed to build during installation.
@@ -377,7 +388,7 @@ You may see one of the following error messages during installation:
388
- Unable to fetch sources for JSON-C. Netdata Cloud support will be disabled.
389
390
One common cause of the installer failing to build Cloud features is not having one of the following dependencies on
380
-your system: `cmake` and OpenSSL, including the `devel` package.
391
+your system: `cmake`, `json-c` and `OpenSSL`, including corresponding `devel` packages.
392
393
You can also look for error messages in `/var/log/netdata/error.log`. Try one of the following two commands to search
394
for ACLK-related errors.
@@ -391,11 +402,11 @@ If the installer's output does not help you enable Cloud features, contact us by
402
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)
403
with details about your system and relevant output from `error.log`.
404
394
-#### agent-claimed is false
405
+#### agent-claimed is false / Claimed: No
406
407
You must [connect your node](#how-to-connect-a-node).
408
398
-#### aclk-available is false
409
+#### aclk-available is false / Online: No
410
411
If `aclk-available` is `false` and all other keys are `true`, your Agent is having trouble connecting to the Cloud
412
through the ACLK. Please check your system's firewall.
cli/README.md
+8
-2
@@ -17,8 +17,10 @@ help
17
Show this help menu.
18
reload-health
19
Reload health configuration.
20
+reload-labels
21
+ Reload all labels.
22
save-database
21
- Save internal DB to disk for for memory mode save.
23
+ Save internal DB to disk for memory mode save.
24
reopen-logs
25
Close and reopen log files.
26
shutdown-agent
@@ -26,7 +28,11 @@ shutdown-agent
28
fatal-agent
29
Log the state and halt the netdata agent.
30
reload-claiming-state
29
- Reload agent connection state from disk.
31
+ Reload agent claiming state from disk.
32
+ping
33
+ Return with 'pong' if agent is alive.
34
+aclk-state [json]
35
+ Returns current state of ACLK and Cloud connection. (optionally in json)
36
```
37
38
Those commands are the same that can be sent to netdata via [signals](/daemon/README.md#command-line-options).