Update optional parameters for upcoming installer. (#11604)
* Update optional parameters for upcoming installer. Listed the parameters that are shared between the old and new, removed reference to the new installer (until it's available), and made notations of optional parameters being removed. * Update kickstart.md
David Shreve, Jr committed
Oct 13, 2021 at 07:49 UTC
fad2ee09e50a119e083af4cb5c4711d04bccf9fe
1 file changed
+23
-17
packaging/installer/methods/kickstart.md
+23
-17
@@ -48,20 +48,25 @@ The `kickstart.sh` script does the following after being downloaded and run usin
48
The `kickstart.sh` script passes all its parameters to `netdata-installer.sh`, which you can use to customize your
49
installation. Here are a few important parameters:
50
51
-- `--dont-wait`: Enable automated installs by not prompting for permission to install any required packages.
52
-- `--dont-start-it`: Prevent the installer from starting Netdata automatically.
53
-- `--stable-channel`: Automatically update only on the release of new major versions.
54
-- `--nightly-channel`: Automatically update on every new nightly build.
55
-- `--disable-telemetry`: Opt-out of [anonymous statistics](/docs/anonymous-statistics.md) we use to make
56
- Netdata better.
57
-- `--no-updates`: Prevent automatic updates of any kind.
58
-- `--reinstall`: If an existing install is detected, reinstall instead of trying to update it. Note that this
59
- cannot be used to change installation types.
60
-- `--local-files`: Used for [offline installations](offline.md). Pass four file paths: the Netdata
51
+- `--dont-wait`: Synonym for `--non-interactive`
52
+- `--non-interactive`: Don’t prompt for anything and assume yes whenever possible.
53
+- `--no-updates`: Disable automatic updates.
54
+- `--stable-channel`: Use a stable build instead of a nightly build.
55
+- `--reinstall`: If an existing install is found, reinstall instead of trying to update it in place.
56
+- `--dont-start-it`: Don’t auto-start the daemon after installing. This parameter is not gauranteed to work.
57
+- `--install`: Specify an alternative install prefix.
58
+- `--disable-cloud`: For local builds, don’t build any of the cloud code at all. For native packages and static builds,
59
+ use runtime configuration to disable cloud support.
60
+- `--auto-update-type`: Specify how auto-updates are to be scheduled, overriding auto-detection.
61
+- `--disable-telemetry`: Disable anonymous statistics.
62
+- `--local-files`: Used for [offline installations](offline.md). Pass four file paths: the Netdata
63
tarball, the checksum file, the go.d plugin tarball, and the go.d plugin config tarball, to force kickstart run the
64
process using those files. This option conflicts with the `--stable-channel` option. If you set this _and_
65
`--stable-channel`, Netdata will use the local files.
64
-
66
+- `all`: Ask for all dependencies in the dependency handling script.
67
+
68
+ > Note: The `all` and `--local-files` parameters are scheduled to be removed in a forthcoming update.
69
+
70
### Connect node to Netdata Cloud during installation
71
72
The `kickstart.sh` script accepts additional parameters to automatically [connect](/claim/README.md) your node to Netdata
@@ -69,12 +74,13 @@ Cloud immediately after installation. Find the `token` and `rooms` strings by [s
74
Cloud](https://app.netdata.cloud/sign-in?cloudRoute=/spaces), then clicking on **Connect Nodes** in the [Spaces management
75
area](https://learn.netdata.cloud/docs/cloud/spaces#manage-spaces).
76
72
-- `--claim-token`: The unique token associated with your Space in Netdata Cloud.
73
-- `--claim-rooms`: A comma-separated list of tokens for each War Room this node should appear in.
74
-- `--claim-proxy`: Should take the form of `socks5[h]://[user:pass@]host:ip` for a SOCKS5 proxy, or
75
- `http://[user:pass@]host:ip` for an HTTP(S) proxy.See [connecting through a
76
- proxy](/claim/README.md#connect-through-a-proxy) for details.
77
-- `--claim-url`: Defaults to `https://app.netdata.cloud`.
77
+- `--claim-token`: Specify a unique claiming token associated with your Space in Netdata Cloud to be used to connect to the node
78
+ after the install.
79
+- `--claim-rooms`: Specify a comma-separated list of tokens for each War Room this node should appear in.
80
+- `--claim-proxy`: Specify a proxy to use when connecting to the cloud in the form of
81
+ `socks5[h]://[user:pass@]host:ip` for a SOCKS5 proxy, or `http://[user:pass@]host:ip` for an HTTP(S) proxy.
82
+ See [connecting through a proxy](/claim/README.md#connect-through-a-proxy) for details.
83
+- `--claim-url`: Specify a URL to use when connecting to the cloud. Defaults to `https://app.netdata.cloud`.
84
85
For example:
86