Update the "Install Netdata with kickstart.sh" doc (#14338)
* update kickstart.md, make sure all links are absolute, claiming info and tabs on curl and wget * format the file * Apply suggestions from code review Co-authored-by: Chris Akritidis <43294513+cakrit@users.noreply.github.com> * remove a section, preserve the valuable info and change 'claim' to 'connect' * make the file GitHub friendly * add the title back so it can render on GitHub too --------- Co-authored-by: Chris Akritidis <43294513+cakrit@users.noreply.github.com>
Fotis Voutsas committed
Feb 7, 2023 at 20:18 UTC
12d92fe308f4107f67149ec9105b69ce2610a4f2
1 file changed
+36
-38
packaging/installer/methods/kickstart.md
+36
-38
@@ -7,7 +7,11 @@ learn_status: "Published"
7
learn_topic_type: "Tasks"
8
learn_rel_path: "Installation"
9
-->
10
+
11
import { OneLineInstallWget, OneLineInstallCurl } from '@site/src/components/OneLineInstall/'
12
+import { Install, InstallBox } from '@site/src/components/Install/'
13
+import Tabs from '@theme/Tabs';
14
+import TabItem from '@theme/TabItem';
15
16
# Install Netdata with kickstart.sh
17
@@ -18,17 +22,32 @@ This page covers detailed instructions on using and configuring the automatic on
22
23
The kickstart script works on all Linux distributions and macOS environments. By default, automatic nightly updates are enabled. If you are installing on macOS, make sure to check the [install documentation for macOS](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/macos.md) before continuing.
24
21
-> If you are unsure whether you want nightly or stable releases, read the [installation guide](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#nightly-vs-stable-releases).
25
+
26
+> :bulb: Tip
27
+>
28
+> If you are unsure whether you want nightly or stable releases, read the [installation guide](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#nightly-vs-stable-releases).
29
+
30
> If you want to turn off [automatic updates](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#automatic-updates), use the `--no-updates` option. You can find more installation options below.
31
32
To install Netdata, run the following as your normal user:
33
26
-<OneLineInstallWget/>
34
+<Tabs>
35
+ <TabItem value="wget" label="wget">
36
+
37
+ <OneLineInstallWget/>
38
28
-Or, if you have cURL but not wget (such as on macOS):
39
+ </TabItem>
40
+ <TabItem value="curl" label="curl">
41
30
-<OneLineInstallCurl/>
42
+ <OneLineInstallCurl/>
43
44
+ </TabItem>
45
+</Tabs>
46
+
47
+> :bookmark_tabs: Note
48
+>
49
+> If you plan to also connect the node to Netdata Cloud, make sure to replace `YOUR_CLAIM_TOKEN` with the claim token of your space,
50
+> and `YOUR_ROOM_ID` with the ID of the room you are willing to connect the node to.
51
52
## What does `kickstart.sh` do?
53
@@ -39,7 +58,7 @@ The `kickstart.sh` script does the following after being downloaded and run usin
58
- Attempts to install Netdata using our [official native binary packages](#native-packages).
59
- If there are no official native binary packages for your system (or installing that way failed), tries to install
60
using a [static build of Netdata](#static-builds) if one is available.
42
-- If no static build is available, installs required dependencies and then attempts to install by
61
+- If no static build is available, installs required dependencies and then attempts to install by
62
[building Netdata locally](#local-builds) (by downloading the sources and building them directly).
63
- Installs `netdata-updater.sh` to `cron.daily`, so your Netdata installation will be updated with new nightly
64
versions, unless you override that with an [optional parameter](#optional-parameters-to-alter-your-installation).
@@ -55,9 +74,9 @@ The `kickstart.sh` script accepts a number of optional parameters to control how
74
- `--dry-run`: Show what the installer would do, but don’t actually do any of it.
75
- `--dont-start-it`: Don’t auto-start the daemon after installing. This parameter is not guaranteed to work.
76
- `--release-channel`: Specify a particular release channel to install from. Currently supported release channels are:
58
- - `nightly`: Installs a nightly build (this is currently the default).
59
- - `stable`: Installs a stable release.
60
- - `default`: Explicitly request whatever the current default is.
77
+ - `nightly`: Installs a nightly build (this is currently the default).
78
+ - `stable`: Installs a stable release.
79
+ - `default`: Explicitly request whatever the current default is.
80
- `--nightly-channel`: Synonym for `--release-channel nightly`.
81
- `--stable-channel`: Synonym for `--release-channel stable`.
82
- `--auto-update`: Enable automatic updates (this is the default).
@@ -79,7 +98,14 @@ The `kickstart.sh` script accepts a number of optional parameters to control how
98
- `--reinstall-clean`: Performs an uninstall of Netdata and clean installation.
99
- `--local-build-options`: Specify additional options to pass to the installer code when building locally. Only valid if `--build-only` is also specified.
100
- `--static-install-options`: Specify additional options to pass to the static installer code. Only valid if --static-only is also specified.
82
-- `--prepare-offline-install-source`: Instead of insallling the agent, prepare a directory that can be used to install on another system without needing to download anything. See our [offline installation documentation](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/offline.md) for more info.
101
+- `--prepare-offline-install-source`: Instead of installing the agent, prepare a directory that can be used to install on another system without needing to download anything. See our [offline installation documentation](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/offline.md) for more info.
102
+- `--claim-token`: Specify a unique claiming token associated with your Space in Netdata Cloud to be used to connect to the node
103
+ after the install.
104
+- `--claim-rooms`: Specify a comma-separated list of tokens for each War Room this node should appear in.
105
+- `--claim-proxy`: Specify a proxy to use when connecting to the cloud in the form of `http://[user:pass@]host:ip` for an HTTP(S) proxy.
106
+ See [connecting through a proxy](https://github.com/netdata/netdata/blob/master/claim/README.md#connect-through-a-proxy) for details.
107
+- `--claim-url`: Specify a URL to use when connecting to the cloud. Defaults to `https://api.netdata.cloud`.
108
+
109
110
Additionally, the following environment variables may be used to further customize how the script runs (most users
111
should not need to use special values for any of these):
@@ -92,31 +118,6 @@ should not need to use special values for any of these):
118
those to work, or have a different tool to do the same thing on your system, you can specify it here.
119
- `DISABLE_TELEMETRY`: If set to a value other than 0, behave as if `--disable-telemetry` was specified.
120
95
-### Connect node to Netdata Cloud during installation
96
-
97
-The `kickstart.sh` script accepts additional parameters to automatically [connect](https://github.com/netdata/netdata/blob/master/claim/README.md) your node to Netdata Cloud immediately after installation.
98
-
99
-> Note: You either need to run the command with root privileges or run it with the user that is running the agent. More details: [Connect an agent without root privileges](https://github.com/netdata/netdata/blob/master/claim/README.md#connect-an-agent-without-root-privileges) section.
100
-
101
-To automatically claim nodes after installation:
102
-
103
-1. Sign in to [Netdata Cloud](https://app.netdata.cloud/sign-in?cloudRoute=/spaces)
104
-2. Go to the [Spaces management area](https://learn.netdata.cloud/docs/cloud/spaces#manage-spaces)
105
-3. Click on **Connect Nodes**
106
-4. Find the `token` and `rooms` strings and specify your nodes:
107
-
108
-- `--claim-token`: Specify a unique claiming token associated with your Space in Netdata Cloud to be used to connect to the node
109
- after the install.
110
-- `--claim-rooms`: Specify a comma-separated list of tokens for each War Room this node should appear in.
111
-- `--claim-proxy`: Specify a proxy to use when connecting to the cloud in the form of `http://[user:pass@]host:ip` for an HTTP(S) proxy.
112
- See [connecting through a proxy](https://github.com/netdata/netdata/blob/master/claim/README.md#connect-through-a-proxy) for details.
113
-- `--claim-url`: Specify a URL to use when connecting to the cloud. Defaults to `https://api.netdata.cloud`.
114
-
115
-For example:
116
-
117
-```bash
118
-wget -O /tmp/netdata-kickstart.sh https://my-netdata.io/kickstart.sh && sh /tmp/netdata-kickstart.sh --claim-token TOKEN --claim-rooms ROOM1,ROOM2
119
-```
121
122
### Native packages
123
@@ -149,7 +150,6 @@ If you want to enforce the usage of a local build (perhaps because you require a
150
which is not supported with native packages or static builds), you can do so by adding `--build-only` to the
151
options you pass to the installer.
152
152
-
153
## Verify script integrity
154
155
To use `md5sum` to verify the integrity of the `kickstart.sh` script you will download using the one-line command above,
@@ -168,8 +168,6 @@ When you're finished with installation, check out our [single-node](https://gith
168
169
Or, skip straight to [configuring the Netdata Agent](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md).
170
171
-Read through Netdata's [documentation](https://learn.netdata.cloud/docs), which is structured based on actions and
171
+Read through Netdata's [documentation](https://learn.netdata.cloud/), which is structured based on actions and
172
solutions, to enable features like health monitoring, alarm notifications, long-term metrics storage, exporting to
173
external databases, and more.
174
-
175
-