Installation review (#11442)
* first draft of how to connect node with new scripts for installing and connecting (e.g. kickstart) * further work on related pages to keep things synced * reviewed the command on docker exec and aded more to-do's for review and to add details * first draft of how to connect node with new scripts for installing and connecting (e.g. kickstart) * further work on related pages to keep things synced * reviewed the command on docker exec and aded more to-do's for review and to add details * completed and reviewed some todo's based on conversation with Austin * add the kubernetes reviewed part * add references to macOS * rectified the parameter and value separator from = to ' ' * added that kickstart wih claiming options needs to specific privileges * first draft of how to connect node with new scripts for installing and connecting (e.g. kickstart) * further work on related pages to keep things synced * reviewed the command on docker exec and aded more to-do's for review and to add details * first draft of how to connect node with new scripts for installing and connecting (e.g. kickstart) * further work on related pages to keep things synced * reviewed the command on docker exec and aded more to-do's for review and to add details * completed and reviewed some todo's based on conversation with Austin * add the kubernetes reviewed part * add references to macOS * rectified the parameter and value separator from = to ' ' * added that kickstart wih claiming options needs to specific privileges * remove FreeBSD from text and reviewed some text as per Austin's suggestion * removed TODOs, printscreen can be added later on and updated as per a review comment * first draft of how to connect node with new scripts for installing and connecting (e.g. kickstart) * further work on related pages to keep things synced * reviewed the command on docker exec and aded more to-do's for review and to add details * first draft of how to connect node with new scripts for installing and connecting (e.g. kickstart) * further work on related pages to keep things synced * reviewed the command on docker exec and aded more to-do's for review and to add details * completed and reviewed some todo's based on conversation with Austin * add the kubernetes reviewed part * add references to macOS * rectified the parameter and value separator from = to ' ' * added that kickstart wih claiming options needs to specific privileges * remove FreeBSD from text and reviewed some text as per Austin's suggestion * first draft of how to connect node with new scripts for installing and connecting (e.g. kickstart) * further work on related pages to keep things synced * reviewed the command on docker exec and aded more to-do's for review and to add details * first draft of how to connect node with new scripts for installing and connecting (e.g. kickstart) * further work on related pages to keep things synced * reviewed the command on docker exec and aded more to-do's for review and to add details * completed and reviewed some todo's based on conversation with Austin * added that kickstart wih claiming options needs to specific privileges * removed TODOs, printscreen can be added later on and updated as per a review comment * rebased from master and removed kickstart for reconnect a node as a possibility * added adding nodes from Node view after Kaskavelis callout * added adding nodes from Node view after Kaskavelis callout
Hugo Valente committed
Aug 31, 2021 at 10:32 UTC
6fd6bc72e4c628b542aa752632cca65022bbbab4
5 files changed
+219
-49
claim/README.md
+168
-40
@@ -6,7 +6,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/claim/README.md
6
7
# Connect Agent to Cloud
8
9
-You can securely connect a Netdata Agent, running on a distributed node, to securely connect to Netdata Cloud. A Space's
9
+You can securely connect a Netdata Agent, running on a distributed node, to Netdata Cloud. A Space's
10
administrator creates a **claiming token**, which is used to add an Agent to their Space via the [Agent-Cloud link
11
(ACLK)](/aclk/README.md).
12
@@ -14,10 +14,7 @@ Are you just starting out with Netdata Cloud? See our [get started with
14
Cloud](https://learn.netdata.cloud/docs/cloud/get-started) guide for a walkthrough of the process and simplified
15
instructions.
16
17
-Connecting Agents, also referrered as **nodes**, is a security feature in Netdata Cloud. Through the connection process, you demonstrate in a few ways
18
-that you have administrative access to that node and the configuration settings for the Netdata Agent. By logging into the node,
19
-you prove you have access, and by using the claiming script or the Netdata command line, you prove you have write access
20
-and administrative privileges.
17
+When connecting an agent (also referred to as a node) to Netdata Cloud, you must complete a verification process that proves you have some level of authorization to manage the node itself. This verification is a security feature that helps prevent unauthorized users from seeing the data on your node.
18
19
Only the administrators of a Space in Netdata Cloud can view the claiming token and accompanying script generated by
20
Netdata Cloud.
@@ -41,27 +38,57 @@ There are two important notes regarding connecting nodes:
38
39
## How to connect a node
40
41
+There will be three main flows from where you might want to connect a node to Netdata Cloud.
42
+* when you are on an [empty War Room](#empty-war-room) and you want to connect your first node
43
+* when you are at the [Manage Space](#manage-space-or-war-room) area and you select **Connect Nodes** to connect a node, coming from Manage Space or Manage War Room
44
+* when you are the the [Nodes view page](learn.netdata.cloud/docs/cloud/visualize/nodes) and want to connect a node - this process falls into the [Manage Space](#manage-space-or-war-room) flow
45
+
46
+Please note that only the administrators of a Space in Netdata Cloud can view the claiming token and accompanying script, generated by Netdata Cloud, to trigger the connection process.
47
+
48
+### Empty War Room
49
+
50
+Either at your first sign in or following ones, when you enter Netdata Cloud and are at a War Room that doesn’t have any node added to it you will be able to:
51
+* connect a new node to Netdata Cloud and add it to the War Room you are in
52
+* add a previously connected node to the War Room you are in
53
+
54
+If your case is to connect a new node and add it to the War Room, you will need to tell us what environment the node is running on (Linux, Docker, macOS, Kubernetes) and then we will provide you with a script to initiate the connection process. You just will need to copy and paste it into your node's terminal. See one of the following sections depending on your case:
55
+* [Linux](#connect-an-agent-running-in-linux)
56
+* [Docker](#connect-an-agent-running-in-docker)
57
+* [macOS](#connect-an-agent-running-in-macos)
58
+* [Kubernetes](#connect-a-kubernetes-clusters-parent-netdata-pod)
59
+
60
+Repeat this process with every node you want to add to Netdata Cloud during onboarding. You can also add more nodes once you've
61
+finished onboarding.
62
+### Manage Space or War Room
63
+
64
To connect a node, select which War Rooms you want to add this node to with the dropdown, then copy and paste the script
45
-given by Cloud into your node's terminal. Hit **Enter**.
65
+given by Netdata Cloud into your node's terminal.
66
+
67
+When coming from [Nodes view page](learn.netdata.cloud/docs/cloud/visualize/nodes) the room parameter is already defined to current War Room.
68
+
69
+### Connect an agent running in Linux
70
+
71
+If you want to connect a node that is running on a Linux environment, the script that will be provided to you by Netdata Cloud is the [kickstart](/packaging/installer/#automatic-one-line-installation-script) which will install the Netdata Agent on your node, if it isn't already installed, and connect the node to Netdata Cloud. It should be similar to:
72
47
-```bash
48
-sudo netdata-claim.sh -token=TOKEN -rooms=ROOM1,ROOM2 -url=https://app.netdata.cloud
73
```
74
+bash <(curl -Ss https://my-netdata.io/kickstart.sh) --claim-token TOKEN --claim-rooms ROOM1,ROOM2 --claim-url https://app.netdata.cloud
75
+```
76
+The script should return `Agent was successfully claimed.`. If the connecting to Netdata Cloud process returns errors, or if you don't see
77
+the node in your Space after 60 seconds, see the [troubleshooting information](#troubleshooting).
78
51
-The script should return `Agent was successfully claimed.`. If the claiming script returns errors, or if you don't see
52
-the node in your Space after 60 seconds, see the [troubleshooting information](#troubleshooting). If you prefer not to
53
-use root privileges via `sudo` to run the claiming script, see the next section.
79
+Please note that to run it you will either need to have root privileges or run it with the user that is running the agent, more details on the [Connect an agent without root privileges](#connect-an-agent-without-root-privileges) section.
80
55
-Repeat this process with every node you want to add to Cloud during onboarding. You can also add more nodes once you've
56
-finished onboarding.
81
+For more details on what are the extra parameters `claim-token`, `claim-rooms` and `claim-url` please refer to [Connect node to Netdata Cloud during installation](/packaging/installer/methods/kickstart#connect-node-to-netdata-cloud-during-installation).
82
83
### Connect an agent without root privileges
84
60
-If you don't want to run the claiming script with root privileges, you can discover which user is running the Agent,
61
-switch to that user, and run the claiming script.
85
+If you don't want to run the installation script to connect your nodes to Netdata Cloud with root privileges, you can discover which user is running the Agent,
86
+switch to that user, and run the script.
87
88
Use `grep` to search your `netdata.conf` file, which is typically located at `/etc/netdata/netdata.conf`, for the `run
89
as user` setting. For example:
90
+To connect a node, select which War Rooms you want to add this node to with the dropdown, then copy and paste the script
91
+given by Netdata Cloud into your node's terminal.
92
93
```bash
94
grep "run as user" /etc/netdata/netdata.conf
@@ -69,16 +96,12 @@ grep "run as user" /etc/netdata/netdata.conf
96
```
97
98
The default user is `netdata`. Yours may be different, so pay attention to the output from `grep`. Switch to that user
72
-and run the claiming script.
99
+and run the script.
100
101
```bash
75
-netdata-claim.sh -token=TOKEN -rooms=ROOM1,ROOM2 -url=https://app.netdata.cloud
102
+bash <(curl -Ss https://my-netdata.io/kickstart.sh) --claim-token TOKEN --claim-rooms ROOM1,ROOM2 --claim-url https://app.netdata.cloud
103
```
77
-
78
-Hit **Enter**. The script should return `Agent was successfully claimed.`. If the claiming script returns errors, or if
79
-you don't see the node in your Space after 60 seconds, see the [troubleshooting information](#troubleshooting).
80
-
81
-### Connect an Agent running in Docker
104
+### Connect an agent running in Docker
105
106
To connect an instance of the Netdata Agent running inside of a Docker container, either set claiming environment
107
variables in the container to have it automatically connected on startup or restart, or use `docker exec` to manually
@@ -102,12 +125,16 @@ it will use these values to attempt to connect the container, automatically addi
125
Rooms. If a proxy is specified, it will be used for the connection process and for connecting to Netdata Cloud.
126
127
These variables can be specified using any mechanism supported by your container tooling for setting environment
105
-variables inside containers. For example, when creating a new Netdata continer using `docker run`, the following
106
-modified version of the command can be used to set the variables:
128
+variables inside containers. For example, when creating a new Netdata container using `docker run`, the following
129
108
-```bash
130
+When using the `docker run` command, if you have an agent container already running, it is important to know that there will be a short period of downtime. This is due to the process of recreating the new agent container.
131
+
132
+The command that Netdata Cloud will provide to you is:
133
+
134
+```bash
135
docker run -d --name=netdata \
136
-p 19999:19999 \
137
+ -v netdataconfig:/etc/netdata \
138
-v netdatalib:/var/lib/netdata \
139
-v netdatacache:/var/cache/netdata \
140
-v /etc/passwd:/host/etc/passwd:ro \
@@ -115,32 +142,87 @@ docker run -d --name=netdata \
142
-v /proc:/host/proc:ro \
143
-v /sys:/host/sys:ro \
144
-v /etc/os-release:/host/etc/os-release:ro \
118
- -e NETDATA_CLAIM_TOKEN=TOKEN \
119
- -e NETDATA_CLAIM_URL="https://app.netdata.cloud" \
120
- -e NETDATA_CLAIM_ROOMS=ROOM1,ROOM2 \
145
--restart unless-stopped \
146
--cap-add SYS_PTRACE \
147
--security-opt apparmor=unconfined \
124
- netdata/netdata
148
+ -e NETDATA_CLAIM_TOKEN=TOKEN \
149
+ -e NETDATA_CLAIM_URL="https://app.netdata.cloud" \
150
+ -e NETDATA_CLAIM_ROOMS=ROOM1,ROOM2 \
151
+ -e NETDATA_CLAIM_PROXY=PROXY \
152
+ netdata/netdata
153
```
154
127
-Output that would be seen from the claiming script when using other methods will be present in the container logs.
155
+The output that would be seen from the connection process when using other methods will be present in the container logs.
156
157
Using the environment variables like this to handle the connection process is the preferred method of connecting Docker containers
158
as it works in the widest variety of situations and simplifies configuration management.
159
160
+#### Using Docker compose
161
+
162
+If you use `docker compose` you can copy the config provided by Netdata Cloud, which should be same as the one below:
163
+
164
+```bash
165
+version: '3'
166
+services:
167
+ netdata:
168
+ image: netdata/netdata
169
+ container_name: netdata
170
+ hostname: example.com # set to fqdn of host
171
+ ports:
172
+ - 19999:19999
173
+ restart: unless-stopped
174
+ cap_add:
175
+ - SYS_PTRACE
176
+ security_opt:
177
+ - apparmor:unconfined
178
+ volumes:
179
+ - netdataconfig:/etc/netdata
180
+ - netdatalib:/var/lib/netdata
181
+ - netdatacache:/var/cache/netdata
182
+ - /etc/passwd:/host/etc/passwd:ro
183
+ - /etc/group:/host/etc/group:ro
184
+ - /proc:/host/proc:ro
185
+ - /sys:/host/sys:ro
186
+ - /etc/os-release:/host/etc/os-release:ro
187
+ environment:
188
+ - NETDATA_CLAIM_TOKEN=TOKEN
189
+ - NETDATA_CLAIM_URL="https://app.netdata.cloud"
190
+ - NETDATA_CLAIM_ROOMS=ROOM1,ROOM2
191
+
192
+volumes:
193
+ netdataconfig:
194
+ netdatalib:
195
+ netdatacache:
196
+```
197
+
198
+Then run the following command in the same directory as the `docker-compose.yml` file to start the container.
199
+
200
+```bash
201
+docker-compose up -d
202
+```
203
+
204
#### Using docker exec
205
134
-Connect a _running Netdata Agent container_ by appending the script offered by Cloud to a `docker exec ...` command, replacing
206
+Connect a _running Netdata Agent container_, where you don't want to recreate the existing container, append the script offered by Netdata Cloud to a `docker exec ...` command, replacing
207
`netdata` with the name of your running container:
208
209
```bash
210
docker exec -it netdata netdata-claim.sh -token=TOKEN -rooms=ROOM1,ROOM2 -url=https://app.netdata.cloud
211
```
212
141
-The script should return `Agent was successfully claimed.`. If the claiming script returns errors, or if
213
+The script should return `Agent was successfully claimed.`. If the connection process returns errors, or if
214
you don't see the node in your Space after 60 seconds, see the [troubleshooting information](#troubleshooting).
215
216
+### Connect an agent running in macOS
217
+
218
+To connect a node that is running on a macOS environment the script that will be provided to you by Netdata Cloud is the [kickstart](/packaging/installer/methods/macos#install-netdata-with-kickstart) which will install the Netdata Agent on your node, if it isn't already installed, and connect the node to Netdata Cloud. It should be similar to:
219
+
220
+```bash
221
+bash <(curl -Ss https://my-netdata.io/kickstart.sh) --install /usr/local/ --claim-token TOKEN --claim-rooms ROOM1,ROOM2 --claim-url https://app.netdata.cloud
222
+```
223
+The script should return `Agent was successfully claimed.`. If the connecting to Netdata Cloud process returns errors, or if you don't see
224
+the node in your Space after 60 seconds, see the [troubleshooting information](#troubleshooting).
225
+
226
### Connect a Kubernetes cluster's parent Netdata pod
227
228
Read our [Kubernetes installation](/packaging/installer/methods/kubernetes.md#connect-a-kubernetes-clusters-parent-pod)
@@ -173,14 +255,14 @@ For example, a SOCKS5 proxy setting may look like the following:
255
proxy = socks5h://proxy.example.com:1080 # With a URL
256
```
257
176
-You can now move on to connecting. When you connect with the `netdata-claim.sh` script, add the `-proxy=` parameter and
258
+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
259
append the same proxy setting you added to `netdata.conf`.
260
261
```bash
180
-sudo netdata-claim.sh -token=MYTOKEN1234567 -rooms=room1,room2 -url=https://app.netdata.cloud -proxy=socks5h://203.0.113.0:1080
262
+bash <(curl -Ss https://my-netdata.io/kickstart.sh) --claim-token TOKEN --claim-rooms ROOM1,ROOM2 --claim-url https://app.netdata.cloud --claim-proxy socks5h://203.0.113.0:1080
263
```
264
183
-Hit **Enter**. The script should return `Agent was successfully claimed.`. If the claiming script returns errors, or if
265
+Hit **Enter**. The script should return `Agent was successfully claimed.`. If the connecting to Netdata Cloud process returns errors, or if
266
you don't see the node in your Space after 60 seconds, see the [troubleshooting information](#troubleshooting).
267
268
### Troubleshooting
@@ -200,6 +282,23 @@ might be having with the ACLK or connection process.
282
283
Use these keys and the information below to troubleshoot the ACLK.
284
285
+#### kickstart: unsupported Netdata installation
286
+
287
+If you run the kickstart script and get the following error `Existing install appears to be handled manually or through the system package manager.` you most probably installed Netdata using an unsupported package.
288
+
289
+If you are using an unsupported package, such as a third-party `.deb`/`.rpm` package provided by your distribution,
290
+please remove that package and reinstall using our [recommended kickstart
291
+script](/docs/get-started.mdx#install-on-linux-with-one-line-installer-recommended).
292
+
293
+#### kickstart: Failed to write new machine GUID
294
+
295
+If you run the kickstart script but don't have privileges required for the actions done on the connecting to Netdata Cloud process you will get the following error:
296
+
297
+```bash
298
+Failed to write new machine GUID. Please make sure you have rights to write to /var/lib/netdata/registry/netdata.public.unique.id.
299
+```
300
+For a successful execution you will need to run the script with root privileges or run it with the user that is running the agent, more details on the [Connect an agent without root privileges](#connect-an-agent-without-root-privileges) section.
301
+
302
#### bash: netdata-claim.sh: command not found
303
304
If you run the claiming script and see a `command not found` error, you either installed Netdata in a non-standard
@@ -313,7 +412,9 @@ This node no longer has access to the credentials it was used when connecting to
412
You will still be able to see this node in your War Rooms in an **unreachable** state.
413
414
If you want to reconnect this node into a different Space, you need to create a new identity by adding `-id=$(uuidgen)` to
316
-the claiming script parameters. Make sure that you have the `uuidgen-runtime` package installed, as it is used to run the command `uuidgen`. For example, using the default claiming script:
415
+the claiming script parameters (not yet supported on the kickstart script). Make sure that you have the `uuidgen-runtime` package installed, as it is used to run the command `uuidgen`. For example:
416
+
417
+**Claiming script**
418
419
```bash
420
sudo netdata-claim.sh -token=TOKEN -rooms=ROOM1,ROOM2 -url=https://app.netdata.cloud -id=$(uuidgen)
@@ -322,8 +423,7 @@ sudo netdata-claim.sh -token=TOKEN -rooms=ROOM1,ROOM2 -url=https://app.netdata.c
423
The agent _must be restarted_ after this change.
424
425
## Connecting reference
325
-
326
-In the sections below, you can find reference material for the claiming script, connecting via the Agent's command line
426
+In the sections below, you can find reference material for the kickstart script, claiming script, connecting via the Agent's command line
427
tool, and details about the files found in `cloud.d`.
428
429
### The `cloud.conf` file
@@ -336,9 +436,35 @@ using the [ACLK](/aclk/README.md).
436
| cloud base url | https://app.netdata.cloud | The URL for the Netdata Cloud web application. You should not change this. If you want to disable Cloud, change the `enabled` setting. |
437
| enabled | yes | The runtime option to disable the [Agent-Cloud link](/aclk/README.md) and prevent your Agent from connecting to Netdata Cloud. |
438
439
+### kickstart script
440
+
441
+The best way to install Netdata and connect your nodes to Netdata Cloud is with our automatic one-line installation script, [kickstart](/packaging/installer/#automatic-one-line-installation-script). This script will install the Netdata Agent, in case it isn't already installed, and connect your node to Netdata Cloud.
442
+
443
+This works with:
444
+* all Linux distributions, see [Netdata distribution support matrix](https://learn.netdata.cloud/docs/agent/packaging/distributions)
445
+* macOS
446
+
447
+For details on how to run this script please check [How to connect a node](#how-to-connect-a-node) and choose your environment.
448
+
449
+In case Netdata Agent is already installed and you run this script to connect a node to Netdata Cloud it will not upgrade your agent automatically. If you also want to upgrade the Agent installation you'll need to run the script again without the connection options.
450
+
451
+Our suggestion is to first run kickstart to upgrade your agent by running the command below and the run the [How to connect a node]
452
+(#how-to-connect-a-node).
453
+
454
+**Linux**
455
+
456
+```bash
457
+bash <(curl -Ss https://my-netdata.io/kickstart.sh)
458
+```
459
+
460
+**macOS**
461
+
462
+```bash
463
+bash <(curl -Ss https://my-netdata.io/kickstart.sh) --install /usr/local/
464
+```
465
### Claiming script
466
341
-A Space's administrator can connect an Agent by directly calling the `netdata-claim.sh` script either with root privileges
467
+A Space's administrator can also connect an Agent by directly calling the `netdata-claim.sh` script either with root privileges
468
using `sudo`, or as the user running the Agent (typically `netdata`), and passing the following arguments:
469
470
```sh
@@ -370,6 +496,8 @@ netdatacli reload-claiming-state
496
497
This reloads the Agent connection state from disk.
498
499
+Our recommendation is to trigger the connection process using the [kickstart](/packaging/installer/#automatic-one-line-installation-script) whenever possible.
500
+
501
### Netdata Agent command line
502
503
If a Netdata Agent is running, the Space's administrator can connect a node using the `netdata` service binary with
@@ -400,4 +528,4 @@ Rooms you added that node to.
528
The user can also put the Cloud endpoint's full certificate chain in `cloud.d/cloud_fullchain.pem` so that the Agent
529
can trust the endpoint if necessary.
530
403
-[](<>)
531
+[](<>)
\ No newline at end of file
packaging/installer/README.md
+10
-2
@@ -11,7 +11,7 @@ Netdata is a monitoring agent designed to run on all your systems: physical and
11
IoT/edge devices. Netdata runs on Linux, FreeBSD, macOS, Kubernetes, Docker, and all their derivatives.
12
13
The best way to install Netdata is with our [**automatic one-line installation
14
-script**](#automatic-one-line-installation-script), which works with all Linux distributions, or our [**.deb/rpm
14
+script**](#automatic-one-line-installation-script), which works with all Linux distributions and macOS environments, or our [**.deb/rpm
15
packages**](/packaging/installer/methods/packages.md), which seamlessly install with your distribution's package
16
manager.
17
@@ -34,15 +34,23 @@ _actively_ contributing to Netdata's future.
34
35
 
36
37
-This method is fully automatic on all Linux distributions, including Ubuntu, Debian, Fedora, CentOS, and others.
37
+This method is fully automatic on all Linux distributions, including Ubuntu, Debian, Fedora, CentOS, and others, as well as on mac OS environments.
38
39
To install Netdata from source, including all dependencies required to connect to Netdata Cloud, and get _automatic
40
nightly updates_, run the following as your normal user:
41
42
+**Linux**
43
+
44
```bash
45
bash <(curl -Ss https://my-netdata.io/kickstart.sh)
46
```
47
48
+**macOS**
49
+
50
+```bash
51
+bash <(curl -Ss https://my-netdata.io/kickstart.sh) --install /usr/local/
52
+```
53
+
54
To see more information about this installation script, including how to disable automatic updates, get nightly vs.
55
stable releases, or disable anonymous statistics, see the [`kickstart.sh` method
56
page](/packaging/installer/methods/kickstart.md).
packaging/installer/methods/kickstart.md
+11
-1
@@ -11,13 +11,21 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/instal
11
This page covers detailed instructions on using and configuring the automatic one-line installation script named
12
`kickstart.sh`.
13
14
-This method is fully automatic on all Linux distributions. To install Netdata from source, including all dependencies
14
+This method is fully automatic on all Linux distributions and macOS environments. To install Netdata from source, including all dependencies
15
required to connect to Netdata Cloud, and get _automatic nightly updates_, run the following as your normal user:
16
17
+**Linux**
18
+
19
```bash
20
bash <(curl -Ss https://my-netdata.io/kickstart.sh)
21
```
22
23
+**macOS**
24
+
25
+```bash
26
+bash <(curl -Ss https://my-netdata.io/kickstart.sh) --install /usr/local/
27
+```
28
+
29
> See our [installation guide](../README.md) for details about [automatic updates](../README.md#automatic-updates) or
30
> [nightly vs. stable releases](../README.md#nightly-vs-stable-releases).
31
@@ -74,6 +82,8 @@ For example:
82
bash <(curl -Ss https://my-netdata.io/kickstart.sh) --claim-token=TOKEN --claim-rooms=ROOM1,ROOM2
83
```
84
85
+Please note that to run it you will either need to have root privileges or run it with the user that is running the agent, more details on the [Connect an agent without root privileges](#connect-an-agent-without-root-privileges) section.
86
+
87
## Verify script integrity
88
89
To use `md5sum` to verify the integrity of the `kickstart.sh` script you will download using the one-line command above,
packaging/installer/methods/kubernetes.md
+14
-5
@@ -46,18 +46,27 @@ To start [Kubernetes monitoring](https://learn.netdata.cloud/docs/cloud/visualiz
46
connects your Kubernetes cluster to stream metrics data to Netdata Cloud, enabling Kubernetes-specific visualizations
47
like the health map and time-series composite charts.
48
49
-First, find your claiming script in Netdata Cloud by clicking on your Space's dropdown, then **Manage your Space**.
50
-Click the **Nodes** tab to reveal the `netdata-claim.sh` script for your Space in Netdata Cloud. You need the `TOKEN`
49
+### New installations
50
+
51
+First, find the script to run an `helm install` command. You can get it by clicking on your Space's dropdown, then **Manage your Space**.
52
+Click the **Nodes** tab and select the environment your node is running, in this case **kubernetes**, to reveal the script for your Space in Netdata Cloud. You need the `TOKEN`
53
and `ROOM` values.
54
53
-Next, create a file called `override.yml`.
55
+The script should be similar to:
56
+
57
+```bash
58
+helm install netdata netdata/netdata --set parent.claiming.enabled="true" --set parent.claiming.token="TOKEN" --set parent.claiming.rooms="ROOM" --set child.claiming.enabled=true --set child.claiming.token="TOKEN" --set child.claiming.rooms="ROOM"
59
+```
60
+
61
+### Existing installations
62
+
63
+On an existing installation, you will need to override the configuration values by running the `helm upgrade` command and provide a file with the values to override. You can start with creating a file called `override.yml`.
64
65
```bash
66
touch override.yml
67
```
68
59
-Paste the following into your `override.yml` file, replacing instances of `ROOM` and `TOKEN` with those from the
60
-claiming script from Netdata Cloud. These settings connect your `parent`/`child` nodes to Netdata Cloud and store more
69
+Paste the following into your `override.yml` file, replacing instances of `ROOM` and `TOKEN` with those from the script from Netdata Cloud. These settings connect your `parent`/`child` nodes to Netdata Cloud and store more
70
metrics in the nodes' time-series databases.
71
72
```yaml
packaging/installer/methods/macos.md
+16
-1
@@ -10,12 +10,27 @@ can use any of Netdata's [external plugins](../../../collectors/plugins.d/README
10
have installed on your macOS system. You could also use a macOS system as the parent node in a [streaming
11
configuration](/streaming/README.md).
12
13
-We recommend installing Netdata with the community-created and -maintained [**Homebrew
13
+We recommend you to **[install Netdata with the our automatic one-line installation script](#install-netdata-with-the-automatic-one-line-installation-script)**,
14
+
15
+
16
+As an alternative you also have community-created and -maintained [**Homebrew
17
package**](#install-netdata-with-the-homebrew-package).
18
19
- [Install Netdata via the Homebrew package](#install-netdata-with-the-homebrew-package)
20
- [Install Netdata from source](#install-netdata-from-source)
21
22
+Being community-created and -maintained we don't guarantee that the features made available on our installation script will also be available or give support to it.
23
+
24
+## Install Netdata with our automatic one-line installation script
25
+
26
+To install Netdata using our automatic [kickstart](/packaging/installer/#automatic-one-line-installation-script) script you will just need to run:
27
+
28
+```bash
29
+bash <(curl -Ss https://my-netdata.io/kickstart.sh) --install /usr/local/
30
+```
31
+
32
+With this script, you are also able to connect your nodes directly to Netdata Cloud if you wish, see more details on [Connect an agent running in macOS](/claim/README.md#connect-an-agent-running-in-macos)
33
+
34
## Install Netdata with the Homebrew package
35
36
If you don't have [Homebrew](https://brew.sh/) installed already, begin with their installation script: