summaryrefslogtreecommitdiffstats
path: root/packaging/installer/methods
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2021-12-01 06:15:11 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2021-12-01 06:15:11 +0000
commit483926a283e118590da3f9ecfa75a8a4d62143ce (patch)
treecb77052778df9a128a8cd3ff5bf7645322a13bc5 /packaging/installer/methods
parentReleasing debian version 1.31.0-4. (diff)
downloadnetdata-483926a283e118590da3f9ecfa75a8a4d62143ce.tar.xz
netdata-483926a283e118590da3f9ecfa75a8a4d62143ce.zip
Merging upstream version 1.32.0.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'packaging/installer/methods')
-rw-r--r--packaging/installer/methods/kickstart-64.md12
-rw-r--r--packaging/installer/methods/kickstart.md64
-rw-r--r--packaging/installer/methods/kubernetes.md27
-rw-r--r--packaging/installer/methods/macos.md17
-rw-r--r--packaging/installer/methods/manual.md6
-rw-r--r--packaging/installer/methods/packages.md2
-rw-r--r--packaging/installer/methods/pfsense.md28
-rw-r--r--packaging/installer/methods/source.md4
-rw-r--r--packaging/installer/methods/synology.md10
9 files changed, 108 insertions, 62 deletions
diff --git a/packaging/installer/methods/kickstart-64.md b/packaging/installer/methods/kickstart-64.md
index c390b873a..176d63ad4 100644
--- a/packaging/installer/methods/kickstart-64.md
+++ b/packaging/installer/methods/kickstart-64.md
@@ -71,18 +71,18 @@ 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
+### Connect node to Netdata Cloud during installation
-The `kickstart.sh` script accepts additional parameters to automatically [claim](/claim/README.md) your node to Netdata
+The `kickstart.sh` script accepts additional parameters to automatically [connect](/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
+Cloud](https://app.netdata.cloud/sign-in?cloudRoute=/spaces), then clicking on **Connect 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.
+ `http://[user:pass@]host:ip` for an HTTP(S) proxy.See [connecting through a
+ proxy](/claim/README.md#connect-through-a-proxy) for details.
- `--claim-url`: Defaults to `https://app.netdata.cloud`.
For example:
@@ -97,7 +97,7 @@ To use `md5sum` to verify the integrity of the `kickstart-static64.sh` script yo
command above, run the following:
```bash
-[ "c735fd724be5726c8a1850deed2793b8" = "$(curl -Ss https://my-netdata.io/kickstart-static64.sh | md5sum | cut -d ' ' -f 1)" ] && echo "OK, VALID" || echo "FAILED, INVALID"
+[ "78461a3055aee03011a577a716e2dee5" = "$(curl -Ss https://my-netdata.io/kickstart-static64.sh | md5sum | cut -d ' ' -f 1)" ] && echo "OK, VALID" || echo "FAILED, INVALID"
```
If the script is valid, this command will return `OK, VALID`.
diff --git a/packaging/installer/methods/kickstart.md b/packaging/installer/methods/kickstart.md
index e874d637d..7792989ee 100644
--- a/packaging/installer/methods/kickstart.md
+++ b/packaging/installer/methods/kickstart.md
@@ -11,15 +11,23 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/instal
This page covers detailed instructions on using and configuring the automatic one-line installation script named
`kickstart.sh`.
-This method is fully automatic on all Linux distributions. To install Netdata from source, including all dependencies
+This method is fully automatic on all Linux distributions and macOS environments. To install Netdata from source, including all dependencies
required to connect to Netdata Cloud, and get _automatic nightly updates_, run the following as your normal user:
+**Linux**
+
```bash
bash <(curl -Ss https://my-netdata.io/kickstart.sh)
```
-> See our [installation guide](../README.md) for details about [automatic updates](../README.md#automatic-updates) or
-> [nightly vs. stable releases](../README.md#nightly-vs-stable-releases).
+**macOS**
+
+```bash
+bash <(curl -Ss https://my-netdata.io/kickstart.sh) --install /usr/local/
+```
+
+> See our [installation guide](/packaging/installer/README.md) for details about [automatic updates](/packaging/installer/README.md#automatic-updates) or
+> [nightly vs. stable releases](/packaging/installer/README.md#nightly-vs-stable-releases).
## What does `kickstart.sh` do?
@@ -40,33 +48,39 @@ The `kickstart.sh` script does the following after being downloaded and run usin
The `kickstart.sh` script passes all its parameters to `netdata-installer.sh`, which you can use to customize your
installation. Here are a few important parameters:
-- `--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
+- `--dont-wait`: Synonym for `--non-interactive`
+- `--non-interactive`: Don’t prompt for anything and assume yes whenever possible.
+- `--no-updates`: Disable automatic updates.
+- `--stable-channel`: Use a stable build instead of a nightly build.
+- `--reinstall`: If an existing install is found, reinstall instead of trying to update it in place.
+- `--dont-start-it`: Don’t auto-start the daemon after installing. This parameter is not guaranteed to work.
+- `--install`: Specify an alternative install prefix.
+- `--disable-cloud`: For local builds, don’t build any of the cloud code at all. For native packages and static builds,
+ use runtime configuration to disable cloud support.
+- `--auto-update-type`: Specify how auto-updates are to be scheduled, overriding auto-detection.
+- `--disable-telemetry`: Disable anonymous statistics.
+- `--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.
+- `all`: Ask for all dependencies in the dependency handling script.
+
+ > Note: The `all` and `--local-files` parameters are scheduled to be removed in a forthcoming update.
+
+### Connect node to Netdata Cloud during installation
-### Claim node to Netdata Cloud during installation
-
-The `kickstart.sh` script accepts additional parameters to automatically [claim](/claim/README.md) your node to Netdata
+The `kickstart.sh` script accepts additional parameters to automatically [connect](/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
+Cloud](https://app.netdata.cloud/sign-in?cloudRoute=/spaces), then clicking on **Connect 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`.
+- `--claim-token`: Specify a unique claiming token associated with your Space in Netdata Cloud to be used to connect to the node
+ after the install.
+- `--claim-rooms`: Specify a comma-separated list of tokens for each War Room this node should appear in.
+- `--claim-proxy`: Specify a proxy to use when connecting to the cloud in 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 [connecting through a proxy](/claim/README.md#connect-through-a-proxy) for details.
+- `--claim-url`: Specify a URL to use when connecting to the cloud. Defaults to `https://app.netdata.cloud`.
For example:
@@ -74,13 +88,15 @@ For example:
bash <(curl -Ss https://my-netdata.io/kickstart.sh) --claim-token=TOKEN --claim-rooms=ROOM1,ROOM2
```
+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.
+
## Verify script integrity
To use `md5sum` to verify the integrity of the `kickstart.sh` script you will download using the one-line command above,
run the following:
```bash
-[ "a708de3790fa39188babe71eb1639c66" = "$(curl -Ss https://my-netdata.io/kickstart.sh | md5sum | cut -d ' ' -f 1)" ] && echo "OK, VALID" || echo "FAILED, INVALID"
+[ "7e8b449ca44e49b7074b5b9d6022cbcc" = "$(curl -Ss https://my-netdata.io/kickstart.sh | md5sum | cut -d ' ' -f 1)" ] && echo "OK, VALID" || echo "FAILED, INVALID"
```
If the script is valid, this command will return `OK, VALID`.
diff --git a/packaging/installer/methods/kubernetes.md b/packaging/installer/methods/kubernetes.md
index f593765fc..f12850665 100644
--- a/packaging/installer/methods/kubernetes.md
+++ b/packaging/installer/methods/kubernetes.md
@@ -39,25 +39,34 @@ parent pod, and multiple child pods.
You've now installed Netdata on your Kubernetes cluster. Next, it's time to opt-in and enable the powerful Kubernetes
dashboards available in Netdata Cloud.
-## Claim your Kubernetes cluster to Netdata Cloud
+## Connect your Kubernetes cluster to Netdata Cloud
To start [Kubernetes monitoring](https://learn.netdata.cloud/docs/cloud/visualize/kubernetes/), you must first
-[claim](/claim/README.md) your Kubernetes cluster to [Netdata Cloud](https://app.netdata.cloud). Claiming securely
+[connect](/claim/README.md) your Kubernetes cluster to [Netdata Cloud](https://app.netdata.cloud). The connection process securely
connects your Kubernetes cluster to stream metrics data to Netdata Cloud, enabling Kubernetes-specific visualizations
like the health map and time-series composite charts.
-First, find your claiming script in Netdata Cloud by clicking on your Space's dropdown, then **Manage your Space**.
-Click the **Nodes** tab to reveal the `netdata-claim.sh` script for your Space in Netdata Cloud. You need the `TOKEN`
+### New installations
+
+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**.
+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`
and `ROOM` values.
-Next, create a file called `override.yml`.
+The script should be similar to:
+
+```bash
+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"
+```
+
+### Existing installations
+
+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`.
```bash
touch override.yml
```
-Paste the following into your `override.yml` file, replacing instances of `ROOM` and `TOKEN` with those from the
-claiming script from Netdata Cloud. These settings claim your `parent`/`child` nodes to Netdata Cloud and store more
+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
metrics in the nodes' time-series databases.
```yaml
@@ -92,7 +101,7 @@ Apply these new settings:
helm upgrade -f override.yml netdata netdata/netdata
```
-The cluster terminates the old pods and creates new ones with the proper persistence and claiming configuration. You'll
+The cluster terminates the old pods and creates new ones with the proper persistence and connection configuration. You'll
see your nodes, containers, and pods appear in Netdata Cloud in a few seconds.
![Netdata's Kubernetes monitoring
@@ -107,7 +116,7 @@ Read up on the various configuration options in the [Helm chart
documentation](https://github.com/netdata/helmchart#configuration) if you need to tweak your Kubernetes monitoring.
Your first option is to create an `override.yml` file, if you haven't created one already for
-[claiming](#claim-your-kubernetes-cluster-to-netdata-cloud), then apply the new configuration to your cluster with `helm
+[connect](#connect-your-kubernetes-cluster-to-netdata-cloud), then apply the new configuration to your cluster with `helm
upgrade`.
```bash
diff --git a/packaging/installer/methods/macos.md b/packaging/installer/methods/macos.md
index 3fa21d0cd..48d53fd08 100644
--- a/packaging/installer/methods/macos.md
+++ b/packaging/installer/methods/macos.md
@@ -10,12 +10,27 @@ can use any of Netdata's [external plugins](../../../collectors/plugins.d/README
have installed on your macOS system. You could also use a macOS system as the parent node in a [streaming
configuration](/streaming/README.md).
-We recommend installing Netdata with the community-created and -maintained [**Homebrew
+We recommend you to **[install Netdata with the our automatic one-line installation script](#install-netdata-with-the-automatic-one-line-installation-script)**,
+
+
+As an alternative you also have community-created and -maintained [**Homebrew
package**](#install-netdata-with-the-homebrew-package).
- [Install Netdata via the Homebrew package](#install-netdata-with-the-homebrew-package)
- [Install Netdata from source](#install-netdata-from-source)
+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.
+
+## Install Netdata with our automatic one-line installation script
+
+To install Netdata using our automatic [kickstart](/packaging/installer/#automatic-one-line-installation-script) script you will just need to run:
+
+```bash
+bash <(curl -Ss https://my-netdata.io/kickstart.sh) --install /usr/local/
+```
+
+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)
+
## Install Netdata with the Homebrew package
If you don't have [Homebrew](https://brew.sh/) installed already, begin with their installation script:
diff --git a/packaging/installer/methods/manual.md b/packaging/installer/methods/manual.md
index aa49c81ac..ae96dd954 100644
--- a/packaging/installer/methods/manual.md
+++ b/packaging/installer/methods/manual.md
@@ -217,13 +217,13 @@ cd netdata
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
+### Connect node to Netdata Cloud during installation
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.
+not allow you to automatically [connect](/claim/README.md) your node to Netdata Cloud immediately after installation.
-See the [claiming](/claim/README.md) doc for details on claiming a node with a manual installation of Netdata.
+See the [connect to cloud](/claim/README.md) doc for details on connecting a node with a manual installation of Netdata.
### 'nonrepresentable section on output' errors
diff --git a/packaging/installer/methods/packages.md b/packaging/installer/methods/packages.md
index cf1e33591..20dbaf060 100644
--- a/packaging/installer/methods/packages.md
+++ b/packaging/installer/methods/packages.md
@@ -6,8 +6,6 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/instal
# Install Netdata with .deb/.rpm packages
-![](https://raw.githubusercontent.com/netdata/netdata/master/web/gui/images/packaging-beta-tag.svg?sanitize=true)
-
Netdata provides our own flavour of binary packages for the most common operating systems that use with `.deb` and
`.rpm` packaging formats.
diff --git a/packaging/installer/methods/pfsense.md b/packaging/installer/methods/pfsense.md
index ee1a453db..6d9de7606 100644
--- a/packaging/installer/methods/pfsense.md
+++ b/packaging/installer/methods/pfsense.md
@@ -25,19 +25,19 @@ pkg install -y pkgconf bash e2fsprogs-libuuid libuv nano
Then run the following commands to download various dependencies from the FreeBSD repository.
```sh
-pkg add http://pkg.freebsd.org/FreeBSD:11:amd64/latest/All/Judy-1.0.5_2.txz
-pkg add http://pkg.freebsd.org/FreeBSD:11:amd64/latest/All/json-c-0.15_1.txz
-pkg add http://pkg.freebsd.org/FreeBSD:11:amd64/latest/All/py37-certifi-2020.6.20.txz
-pkg add http://pkg.freebsd.org/FreeBSD:11:amd64/latest/All/py37-asn1crypto-1.3.0.txz
-pkg add http://pkg.freebsd.org/FreeBSD:11:amd64/latest/All/py37-pycparser-2.20.txz
-pkg add http://pkg.freebsd.org/FreeBSD:11:amd64/latest/All/py37-cffi-1.14.3.txz
-pkg add http://pkg.freebsd.org/FreeBSD:11:amd64/latest/All/py37-six-1.15.0.txz
-pkg add http://pkg.freebsd.org/FreeBSD:11:amd64/latest/All/py37-cryptography-2.6.1.txz
-pkg add http://pkg.freebsd.org/FreeBSD:11:amd64/latest/All/py37-idna-2.10.txz
-pkg add http://pkg.freebsd.org/FreeBSD:11:amd64/latest/All/py37-openssl-19.0.0.txz
-pkg add http://pkg.freebsd.org/FreeBSD:11:amd64/latest/All/py37-pysocks-1.7.1.txz
-pkg add http://pkg.freebsd.org/FreeBSD:11:amd64/latest/All/py37-urllib3-1.25.11,1.txz
-pkg add http://pkg.freebsd.org/FreeBSD:11:amd64/latest/All/py37-yaml-5.3.1.txz
+pkg add http://pkg.freebsd.org/FreeBSD:12:amd64/latest/All/Judy-1.0.5_3.txz
+pkg add http://pkg.freebsd.org/FreeBSD:12:amd64/latest/All/json-c-0.15_1.txz
+pkg add http://pkg.freebsd.org/FreeBSD:12:amd64/latest/All/py38-certifi-2021.10.8.txz
+pkg add http://pkg.freebsd.org/FreeBSD:12:amd64/latest/All/py38-asn1crypto-1.4.0.txz
+pkg add http://pkg.freebsd.org/FreeBSD:12:amd64/latest/All/py38-pycparser-2.20.txz
+pkg add http://pkg.freebsd.org/FreeBSD:12:amd64/latest/All/py38-cffi-1.14.6.txz
+pkg add http://pkg.freebsd.org/FreeBSD:12:amd64/latest/All/py38-six-1.16.0.txz
+pkg add http://pkg.freebsd.org/FreeBSD:12:amd64/latest/All/py38-cryptography-3.3.2.txz
+pkg add http://pkg.freebsd.org/FreeBSD:12:amd64/latest/All/py38-idna-2.10.txz
+pkg add http://pkg.freebsd.org/FreeBSD:12:amd64/latest/All/py38-openssl-20.0.1.txz
+pkg add http://pkg.freebsd.org/FreeBSD:12:amd64/latest/All/py38-pysocks-1.7.1.txz
+pkg add http://pkg.freebsd.org/FreeBSD:12:amd64/latest/All/py38-urllib3-1.26.7,1.txz
+pkg add http://pkg.freebsd.org/FreeBSD:12:amd64/latest/All/py38-yaml-5.4.1.txz
```
> ⚠️ If any of the above commands return a `Not Found` error, you need to manually search for the latest package in the
@@ -56,7 +56,7 @@ pkg add http://pkg.freebsd.org/FreeBSD:11:amd64/latest/All/py37-yaml-5.3.1.txz
You can now install Netdata from the FreeBSD repository.
```bash
-pkg add http://pkg.freebsd.org/FreeBSD:11:amd64/latest/All/netdata-1.28.0.txz
+pkg add http://pkg.freebsd.org/FreeBSD:12:amd64/latest/All/netdata-1.31.0_1.txz
```
> ⚠️ If the above command returns a `Not Found` error, you need to manually search for the latest version of Netdata in
diff --git a/packaging/installer/methods/source.md b/packaging/installer/methods/source.md
index e0827fc17..ba29a188d 100644
--- a/packaging/installer/methods/source.md
+++ b/packaging/installer/methods/source.md
@@ -99,7 +99,7 @@ library for the build system:
`externaldeps/libwebsockets`.
6. Copy `lib/libwebsockets.a` from the libwebsockets source directory to
`externaldeps/libwebsockets/libwebsockets.a` in the Netdata source tree.
-7. Copy the entire contents of `lib/include` from the libwebsockets source
+7. Copy the entire contents of `include/` from the libwebsockets source
directory to `externaldeps/libwebsockets/include` in the Netdata source tree.
#### JSON-C
@@ -120,7 +120,7 @@ you can do the following to prepare a copy for the build system:
4. Build JSON-C by running `make` in the JSON-C source directory.
5. In the Netdata source directory, create a directory called
`externaldeps/jsonc`.
-6. Copy `libjson-c.a` fro the JSON-C source directory to
+6. Copy `libjson-c.a` from the JSON-C source directory to
`externaldeps/jsonc/libjson-c.a` in the Netdata source tree.
7. Copy all of the header files (`*.h`) from the JSON-C source directory
to `externaldeps/jsonc/json-c` in the Netdata source tree.
diff --git a/packaging/installer/methods/synology.md b/packaging/installer/methods/synology.md
index 4a0ae3551..07b1596fd 100644
--- a/packaging/installer/methods/synology.md
+++ b/packaging/installer/methods/synology.md
@@ -21,7 +21,7 @@ will install the content into `/opt/netdata`, making future removal safe and sim
When Netdata is first installed, it will run as _root_. This may or may not be acceptable for you, and since other
installations run it as the `netdata` user, you might wish to do the same. This requires some extra work:
-1. Creat a group `netdata` via the Synology group interface. Give it no access to anything.
+1. Create a group `netdata` via the Synology group interface. Give it no access to anything.
2. Create a user `netdata` via the Synology user interface. Give it no access to anything and a random password. Assign
the user to the `netdata` group. Netdata will chuid to this user when running.
3. Change ownership of the following directories, as defined in [Netdata
@@ -33,6 +33,14 @@ chown -R netdata:netdata /opt/netdata/var/lib/netdata /opt/netdata/var/cache/net
chown -R netdata:root /opt/netdata/var/log/netdata
```
+4. Uncomment and set `web files owner` to `root`, and `web files group` to `netdata` in
+ the `/opt/netdata/etc/netdata/netdata.conf`.
+5. Restart Netdata
+
+```sh
+/etc/rc.netdata restart
+```
+
## Create startup script
Additionally, as of 2018/06/24, the Netdata installer doesn't recognize DSM as an operating system, so no init script is