summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJoel Hans <joel@netdata.cloud>2021-04-29 08:53:25 -0700
committerGitHub <noreply@github.com>2021-04-29 08:53:25 -0700
commit0277deeb1cc4576c83c872c043b89a01b09d339f (patch)
treead0e16293639bbf364acbe5e86928d5b3df0e498
parentbb91989024f8e34056e82be79c02193a6ad94c7f (diff)
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
-rw-r--r--claim/README.md4
-rw-r--r--packaging/installer/methods/kickstart-64.md20
-rw-r--r--packaging/installer/methods/kickstart.md20
-rw-r--r--packaging/installer/methods/manual.md30
4 files changed, 66 insertions, 8 deletions
diff --git a/claim/README.md b/claim/README.md
index 9ecd0a563f..b3ebb82217 100644
--- a/claim/README.md
+++ b/claim/README.md
@@ -30,8 +30,8 @@ data is encrypted by TLS while it is in transit. We use the RSA keypair created
identity of the Agent when it connects to the Cloud. While the data does flow through Netdata Cloud servers on its way
from Agents to the browser, we do not store or log it.
-You can claim a node during the Cloud onboarding process, or after you created a Space by clicking on the **USER's
-Space** dropdown, then **Manage claimed nodes**.
+You can claim a node during the Netdata Cloud onboarding process, or after you created a Space by clicking on **Claim
+Nodes** in the [Spaces management area](https://learn.netdata.cloud/docs/cloud/spaces#manage-spaces).
There are two important notes regarding claiming:
diff --git a/packaging/installer/methods/kickstart-64.md b/packaging/installer/methods/kickstart-64.md
index ea6cf32eaa..c390b873a2 100644
--- a/packaging/installer/methods/kickstart-64.md
+++ b/packaging/installer/methods/kickstart-64.md
@@ -71,6 +71,26 @@ your installation. Here are a few important parameters:
kickstart run the process using those files. This option conflicts with the `--stable-channel` option. If you set
this _and_ `--stable-channel`, Netdata will use the local files.
+### Claim node to Netdata Cloud during installation
+
+The `kickstart.sh` script accepts additional parameters to automatically [claim](/claim/README.md) your node to Netdata
+Cloud immediately after installation. Find the `token` and `rooms` strings by [signing in to Netdata
+Cloud](https://app.netdata.cloud/sign-in?cloudRoute=/spaces), then clicking on **Claim Nodes** in the [Spaces management
+area](https://learn.netdata.cloud/docs/cloud/spaces#manage-spaces).
+
+- `--claim-token`: The unique token associated with your Space in Netdata Cloud.
+- `--claim-rooms`: A comma-separated list of tokens for each War Room this node should appear in.
+- `--claim-proxy`: Should take the form of `socks5[h]://[user:pass@]host:ip` for a SOCKS5 proxy, or
+ `http://[user:pass@]host:ip` for an HTTP(S) proxy.See [claiming through a
+ proxy](/claim/README.md#claim-through-a-proxy) for details.
+- `--claim-url`: Defaults to `https://app.netdata.cloud`.
+
+For example:
+
+```bash
+bash <(curl -Ss https://my-netdata.io/kickstart-static64.sh) --claim-token=TOKEN --claim-rooms=ROOM1,ROOM2
+```
+
## Verify script integrity
To use `md5sum` to verify the integrity of the `kickstart-static64.sh` script you will download using the one-line
diff --git a/packaging/installer/methods/kickstart.md b/packaging/installer/methods/kickstart.md
index 0fc09ae837..e874d637df 100644
--- a/packaging/installer/methods/kickstart.md
+++ b/packaging/installer/methods/kickstart.md
@@ -54,6 +54,26 @@ installation. Here are a few important parameters:
process using those files. This option conflicts with the `--stable-channel` option. If you set this _and_
`--stable-channel`, Netdata will use the local files.
+### Claim node to Netdata Cloud during installation
+
+The `kickstart.sh` script accepts additional parameters to automatically [claim](/claim/README.md) your node to Netdata
+Cloud immediately after installation. Find the `token` and `rooms` strings by [signing in to Netdata
+Cloud](https://app.netdata.cloud/sign-in?cloudRoute=/spaces), then clicking on **Claim Nodes** in the [Spaces management
+area](https://learn.netdata.cloud/docs/cloud/spaces#manage-spaces).
+
+- `--claim-token`: The unique token associated with your Space in Netdata Cloud.
+- `--claim-rooms`: A comma-separated list of tokens for each War Room this node should appear in.
+- `--claim-proxy`: Should take the form of `socks5[h]://[user:pass@]host:ip` for a SOCKS5 proxy, or
+ `http://[user:pass@]host:ip` for an HTTP(S) proxy.See [claiming through a
+ proxy](/claim/README.md#claim-through-a-proxy) for details.
+- `--claim-url`: Defaults to `https://app.netdata.cloud`.
+
+For example:
+
+```bash
+bash <(curl -Ss https://my-netdata.io/kickstart.sh) --claim-token=TOKEN --claim-rooms=ROOM1,ROOM2
+```
+
## Verify script integrity
To use `md5sum` to verify the integrity of the `kickstart.sh` script you will download using the one-line command above,
diff --git a/packaging/installer/methods/manual.md b/packaging/installer/methods/manual.md
index 1b2cd11d42..aa49c81ac8 100644
--- a/packaging/installer/methods/manual.md
+++ b/packaging/installer/methods/manual.md
@@ -178,9 +178,7 @@ yum install autoconf automake curl gcc git cmake libuuid-devel openssl-devel lib
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
```
----
-
-### Install Netdata
+## Install Netdata
Do this to install and run Netdata:
@@ -201,11 +199,31 @@ cd netdata
- 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`.
-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).
+## Optional parameters to alter your installation
+
+`netdata-installer.sh` accepts a few parameters to customize your installation:
+
+- `--dont-wait`: Enable automated installs by not prompting for permission to install any required packages.
+- `--dont-start-it`: Prevent the installer from starting Netdata automatically.
+- `--stable-channel`: Automatically update only on the release of new major versions.
+- `--nightly-channel`: Automatically update on every new nightly build.
+- `--disable-telemetry`: Opt-out of [anonymous statistics](/docs/anonymous-statistics.md) we use to make
+ Netdata better.
+- `--no-updates`: Prevent automatic updates of any kind.
+- `--reinstall`: If an existing install is detected, reinstall instead of trying to update it. Note that this
+ cannot be used to change installation types.
+- `--local-files`: Used for [offline installations](offline.md). Pass four file paths: the Netdata
+ tarball, the checksum file, the go.d plugin tarball, and the go.d plugin config tarball, to force kickstart run the
+ process using those files. This option conflicts with the `--stable-channel` option. If you set this _and_
+ `--stable-channel`, Netdata will use the local files.
+
+### Claim node to Netdata Cloud during installation
-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]]**.
+Unlike the [`kickstart.sh`](/packaging/installer/methods/kickstart.md) or
+[`kickstart-static64.sh`](/packaging/installer/methods/kickstart-64.md) methods, the `netdata-installer.sh` script does
+not allow you to automatically [claim](/claim/README.md) your node to Netdata Cloud immediately after installation.
-To apply the changes you made, you have to restart Netdata.
+See the [claiming](/claim/README.md) doc for details on claiming a node with a manual installation of Netdata.
### 'nonrepresentable section on output' errors