diff options
| author | Andrew Moss <1043609+amoss@users.noreply.github.com> | 2020-05-11 08:34:29 +0200 |
|---|---|---|
| committer | James Mills <prologic@shortcircuit.net.au> | 2020-05-11 16:37:27 +1000 |
| commit | aa3ec552c896aebafd03b9d2c1864272dcb34749 (patch) | |
| tree | 02f7cd95ed84d888c27fb4bfb55df2b251b97b7b /claim/README.md | |
| parent | fd05e1d87751ecaa45ebd3aed2499435b1627cea (diff) | |
Enable support for Netdata Cloud.
This PR merges the feature-branch to make the cloud live. It contains the following work:
Co-authored-by: Andrew Moss <1043609+amoss@users.noreply.github.com(opens in new tab)>
Co-authored-by: Jacek Kolasa <jacek.kolasa@gmail.com(opens in new tab)>
Co-authored-by: Austin S. Hemmelgarn <austin@netdata.cloud(opens in new tab)>
Co-authored-by: James Mills <prologic@shortcircuit.net.au(opens in new tab)>
Co-authored-by: Markos Fountoulakis <44345837+mfundul@users.noreply.github.com(opens in new tab)>
Co-authored-by: Timotej S <6674623+underhood@users.noreply.github.com(opens in new tab)>
Co-authored-by: Stelios Fragkakis <52996999+stelfrag@users.noreply.github.com(opens in new tab)>
* dashboard with new navbars, v1.0-alpha.9: PR #8478
* dashboard v1.0.11: netdata/dashboard#76
Co-authored-by: Jacek Kolasa <jacek.kolasa@gmail.com(opens in new tab)>
* Added installer code to bundle JSON-c if it's not present. PR #8836
Co-authored-by: James Mills <prologic@shortcircuit.net.au(opens in new tab)>
* Fix claiming config PR #8843
* Adds JSON-c as hard dep. for ACLK PR #8838
* Fix SSL renegotiation errors in old versions of openssl. PR #8840. Also - we have a transient problem with opensuse CI so this PR disables them with a commit from @prologic.
Co-authored-by: James Mills <prologic@shortcircuit.net.au(opens in new tab)>
* Fix claiming error handling PR #8850
* Added CI to verify JSON-C bundling code in installer PR #8853
* Make cloud-enabled flag in web/api/v1/info be independent of ACLK build success PR #8866
* Reduce ACLK_STABLE_TIMEOUT from 10 to 3 seconds PR #8871
* remove old-cloud related UI from old dashboard (accessible now via /old suffix) PR #8858
* dashboard v1.0.13 PR #8870
* dashboard v1.0.14 PR #8904
* Provide feedback on proxy setting changes PR #8895
* Change the name of the connect message to update during an ongoing session PR #8927
* Fetch active alarms from alarm_log PR #8944
Diffstat (limited to 'claim/README.md')
| -rw-r--r-- | claim/README.md | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/claim/README.md b/claim/README.md index 651a9b515f..2743851e33 100644 --- a/claim/README.md +++ b/claim/README.md @@ -96,7 +96,7 @@ docker run -d --name=netdata \ --cap-add SYS_PTRACE \ --security-opt apparmor=unconfined \ netdata/netdata \ - /usr/sbin/netdata -D -W set global "netdata cloud" enable -W set cloud "cloud base url" "https://app.netdata.cloud" -W "claim -token=TOKEN -rooms=ROOM1,ROOM2 -url=https://app.netdata.cloud" + /usr/sbin/netdata -D -W set cloud global enabled true -W set cloud global "cloud base url" "https://app.netdata.cloud" -W "claim -token=TOKEN -rooms=ROOM1,ROOM2 -url=https://app.netdata.cloud" ``` The container runs in detached mode, so you won't see any output. If the node does not appear in your Space, you can run @@ -167,11 +167,11 @@ Use these keys and the information below to troubleshoot the ACLK. If `cloud-enabled` is `false`, you probably ran the installer with `--disable-cloud` option. -Additionally, check that the `netdata cloud` setting in `netdata.conf` is set to `enable`: +Additionally, check that the `enabled` setting in `var/lib/netdata/cloud.d/cloud.conf` is set to `true`: ```ini -[general] - netadata cloud = enable +[global] + enabled = true ``` To fix this issue, reinstall Netdata using your [preferred method](/packaging/installer/README.md) and do not add the @@ -234,23 +234,23 @@ with details about your system and relevant output from `error.log`. ### Unclaim (remove) an Agent from Netdata Cloud -The best method to remove an Agent from Netdata Cloud is to unclaim it by deleting the `claim.d/` directory in your -Netdata configuration directory. +The best method to remove an Agent from Netdata Cloud is to unclaim it by deleting the `cloud.d/` directory in your +Netdata library directory. ```bash -cd /etc/netdata # Replace with your Netdata configuration directory, if not /etc/netdata/ -rm -rf claim.d/ +cd /var/lib/netdata # Replace with your Netdata library directory, if not /var/lib/netdata/ +rm -rf cloud.d/ ``` > You may need to use `sudo` or another method of elevating your privileges. -Once you delete the `claim.d/` directory, the ACLK will not connect to Cloud the next time the Agent starts, and Cloud +Once you delete the `cloud.d/` directory, the ACLK will not connect to Cloud the next time the Agent starts, and Cloud will then remove it from the interface. ## Claiming reference In the sections below, you can find reference material for the claiming script, claiming via the Agent's command line -tool, and details about the files found in `claim.d`. +tool, and details about the files found in `cloud.d`. ### Claiming script @@ -263,7 +263,7 @@ and passing the following arguments: -rooms=ROOM1,ROOM2,... where ROOMX is the War Room this node should be added to. This list is optional. -url=URL_BASE - where URL_BASE is the Netdata Cloud endpoint base URL. By default, this is https://netdata.cloud. + where URL_BASE is the Netdata Cloud endpoint base URL. By default, this is https://app.netdata.cloud. -id=AGENT_ID where AGENT_ID is the unique identifier of the Agent. This is the Agent's MACHINE_GUID by default. -hostname=HOSTNAME @@ -306,14 +306,14 @@ If need be, the user can override the Agent's defaults by providing additional a ### Claiming directory -Netdata stores the agent claiming-related state in the user configuration directory under `claim.d`, e.g. in -`/etc/netdata/claim.d`. The user can put files in this directory to provide defaults to the `-token` and `-rooms` +Netdata stores the agent claiming-related state in the Netdata library directory under `cloud.d`, e.g. in +`/var/lib/netdata/cloud.d`. The user can put files in this directory to provide defaults to the `-token` and `-rooms` arguments. These files should be owned **by the `netdata` user**. -The `claim.d/token` file should contain the claiming-token and the `claim.d/rooms` file should contain the list of +The `cloud.d/token` file should contain the claiming-token and the `cloud.d/rooms` file should contain the list of war-rooms. -The user can also put the Cloud endpoint's full certificate chain in `claim.d/cloud_fullchain.pem` so that the Agent +The user can also put the Cloud endpoint's full certificate chain in `cloud.d/cloud_fullchain.pem` so that the Agent can trust the endpoint if necessary. [](<>) |