Add documentation for claiming during kickstart installation (#11052)
* Add section to kickstart doc * Add to kickstart64 * Add section to manual, add examples * Update manual install per Austin
Joel Hans committed
Apr 29, 2021 at 08:53 UTC
0277deeb1cc4576c83c872c043b89a01b09d339f
4 files changed
+66
-8
claim/README.md
+2
-2
@@ -30,8 +30,8 @@ data is encrypted by TLS while it is in transit. We use the RSA keypair created
30
identity of the Agent when it connects to the Cloud. While the data does flow through Netdata Cloud servers on its way
31
from Agents to the browser, we do not store or log it.
32
33
-You can claim a node during the Cloud onboarding process, or after you created a Space by clicking on the **USER's
34
-Space** dropdown, then **Manage claimed nodes**.
33
+You can claim a node during the Netdata Cloud onboarding process, or after you created a Space by clicking on **Claim
34
+Nodes** in the [Spaces management area](https://learn.netdata.cloud/docs/cloud/spaces#manage-spaces).
35
36
There are two important notes regarding claiming:
37
packaging/installer/methods/kickstart-64.md
+20
@@ -71,6 +71,26 @@ your installation. Here are a few important parameters:
71
kickstart run the process using those files. This option conflicts with the `--stable-channel` option. If you set
72
this _and_ `--stable-channel`, Netdata will use the local files.
73
74
+### Claim node to Netdata Cloud during installation
75
+
76
+The `kickstart.sh` script accepts additional parameters to automatically [claim](/claim/README.md) your node to Netdata
77
+Cloud immediately after installation. Find the `token` and `rooms` strings by [signing in to Netdata
78
+Cloud](https://app.netdata.cloud/sign-in?cloudRoute=/spaces), then clicking on **Claim Nodes** in the [Spaces management
79
+area](https://learn.netdata.cloud/docs/cloud/spaces#manage-spaces).
80
+
81
+- `--claim-token`: The unique token associated with your Space in Netdata Cloud.
82
+- `--claim-rooms`: A comma-separated list of tokens for each War Room this node should appear in.
83
+- `--claim-proxy`: Should take the form of `socks5[h]://[user:pass@]host:ip` for a SOCKS5 proxy, or
84
+ `http://[user:pass@]host:ip` for an HTTP(S) proxy.See [claiming through a
85
+ proxy](/claim/README.md#claim-through-a-proxy) for details.
86
+- `--claim-url`: Defaults to `https://app.netdata.cloud`.
87
+
88
+For example:
89
+
90
+```bash
91
+bash <(curl -Ss https://my-netdata.io/kickstart-static64.sh) --claim-token=TOKEN --claim-rooms=ROOM1,ROOM2
92
+```
93
+
94
## Verify script integrity
95
96
To use `md5sum` to verify the integrity of the `kickstart-static64.sh` script you will download using the one-line
packaging/installer/methods/kickstart.md
+20
@@ -54,6 +54,26 @@ installation. Here are a few important parameters:
54
process using those files. This option conflicts with the `--stable-channel` option. If you set this _and_
55
`--stable-channel`, Netdata will use the local files.
56
57
+### Claim node to Netdata Cloud during installation
58
+
59
+The `kickstart.sh` script accepts additional parameters to automatically [claim](/claim/README.md) your node to Netdata
60
+Cloud immediately after installation. Find the `token` and `rooms` strings by [signing in to Netdata
61
+Cloud](https://app.netdata.cloud/sign-in?cloudRoute=/spaces), then clicking on **Claim Nodes** in the [Spaces management
62
+area](https://learn.netdata.cloud/docs/cloud/spaces#manage-spaces).
63
+
64
+- `--claim-token`: The unique token associated with your Space in Netdata Cloud.
65
+- `--claim-rooms`: A comma-separated list of tokens for each War Room this node should appear in.
66
+- `--claim-proxy`: Should take the form of `socks5[h]://[user:pass@]host:ip` for a SOCKS5 proxy, or
67
+ `http://[user:pass@]host:ip` for an HTTP(S) proxy.See [claiming through a
68
+ proxy](/claim/README.md#claim-through-a-proxy) for details.
69
+- `--claim-url`: Defaults to `https://app.netdata.cloud`.
70
+
71
+For example:
72
+
73
+```bash
74
+bash <(curl -Ss https://my-netdata.io/kickstart.sh) --claim-token=TOKEN --claim-rooms=ROOM1,ROOM2
75
+```
76
+
77
## Verify script integrity
78
79
To use `md5sum` to verify the integrity of the `kickstart.sh` script you will download using the one-line command above,
packaging/installer/methods/manual.md
+24
-6
@@ -178,9 +178,7 @@ yum install autoconf automake curl gcc git cmake libuuid-devel openssl-devel lib
178
yum install -y http://mirror.centos.org/centos/8/PowerTools/x86_64/os/Packages/Judy-devel-1.0.5-18.module_el8.1.0+217+4d875839.x86_64.rpm
179
```
180
181
----
182
-
183
-### Install Netdata
181
+## Install Netdata
182
183
Do this to install and run Netdata:
184
@@ -201,11 +199,31 @@ cd netdata
199
200
- If your server does not have access to the internet and you have manually put the installation directory on your server, you will need to pass the option `--disable-go` to the installer. The option will prevent the installer from attempting to download and install `go.d.plugin`.
201
204
-Once the installer completes, the file `/etc/netdata/netdata.conf` will be created (if you changed the installation directory, the configuration will appear in that directory too).
202
+## Optional parameters to alter your installation
203
+
204
+`netdata-installer.sh` accepts a few parameters to customize your installation:
205
+
206
+- `--dont-wait`: Enable automated installs by not prompting for permission to install any required packages.
207
+- `--dont-start-it`: Prevent the installer from starting Netdata automatically.
208
+- `--stable-channel`: Automatically update only on the release of new major versions.
209
+- `--nightly-channel`: Automatically update on every new nightly build.
210
+- `--disable-telemetry`: Opt-out of [anonymous statistics](/docs/anonymous-statistics.md) we use to make
211
+ Netdata better.
212
+- `--no-updates`: Prevent automatic updates of any kind.
213
+- `--reinstall`: If an existing install is detected, reinstall instead of trying to update it. Note that this
214
+ cannot be used to change installation types.
215
+- `--local-files`: Used for [offline installations](offline.md). Pass four file paths: the Netdata
216
+ tarball, the checksum file, the go.d plugin tarball, and the go.d plugin config tarball, to force kickstart run the
217
+ process using those files. This option conflicts with the `--stable-channel` option. If you set this _and_
218
+ `--stable-channel`, Netdata will use the local files.
219
+
220
+### Claim node to Netdata Cloud during installation
221
206
-You can edit this file to set options. One common option to tweak is `history`, which controls the size of the memory database Netdata will use. By default is `3600` seconds (an hour of data at the charts) which makes Netdata use about 10-15MB of RAM (depending on the number of charts detected on your system). Check **\[[Memory Requirements]]**.
222
+Unlike the [`kickstart.sh`](/packaging/installer/methods/kickstart.md) or
223
+[`kickstart-static64.sh`](/packaging/installer/methods/kickstart-64.md) methods, the `netdata-installer.sh` script does
224
+not allow you to automatically [claim](/claim/README.md) your node to Netdata Cloud immediately after installation.
225
208
-To apply the changes you made, you have to restart Netdata.
226
+See the [claiming](/claim/README.md) doc for details on claiming a node with a manual installation of Netdata.
227
228
### 'nonrepresentable section on output' errors
229