diff options
Diffstat (limited to 'packaging/installer')
| -rw-r--r-- | packaging/installer/README.md | 101 | ||||
| -rwxr-xr-x | packaging/installer/install-required-packages.sh | 2 | ||||
| -rw-r--r-- | packaging/installer/methods/alpine.md | 24 | ||||
| -rw-r--r-- | packaging/installer/methods/cloud-providers.md | 2 | ||||
| -rw-r--r-- | packaging/installer/methods/freebsd.md | 2 | ||||
| -rw-r--r-- | packaging/installer/methods/kickstart-64.md | 20 | ||||
| -rw-r--r-- | packaging/installer/methods/kickstart.md | 20 | ||||
| -rw-r--r-- | packaging/installer/methods/macos.md | 2 | ||||
| -rw-r--r-- | packaging/installer/methods/manual.md | 32 |
9 files changed, 124 insertions, 81 deletions
diff --git a/packaging/installer/README.md b/packaging/installer/README.md index d5a69aa6a..5b16585fe 100644 --- a/packaging/installer/README.md +++ b/packaging/installer/README.md @@ -3,6 +3,8 @@ title: "Installation guide" custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/README.md --> +import { Install, InstallBox } from '../../../src/components/Install/' + # Installation guide Netdata is a monitoring agent designed to run on all your systems: physical and virtual servers, containers, even @@ -21,7 +23,7 @@ Some third parties, such as the packaging teams at various Linux distributions, packages. We recommend you install Netdata using one of the methods listed below to guarantee you get the latest checksum-verified packages. -Starting with v1.12, Netdata collects anonymous usage information by default and sends it to Google Analytics. Read +Netdata collects anonymous usage information by default and sends it to our self hosted [PostHog](https://github.com/PostHog/posthog) installation. PostHog is an open source product analytics platform, you can read about the information collected, and learn how to-opt, on our [anonymous statistics](/docs/anonymous-statistics.md) page. @@ -70,65 +72,44 @@ operating systems. ### Alternative methods -<div class="installer-grid" markdown="1"> - -[ Install -with .deb or .rpm packages](/packaging/installer/methods/packages.md) - -[ Install -with a pre-built static binary for 64-bit systems](/packaging/installer/methods/kickstart-64.md) - -[ Install -Netdata on Docker](/packaging/docker/README.md) - -[ Install -Netdata on a Kubernetes cluster](/packaging/installer/methods/kubernetes.md) - -[ -Install Netdata on cloud providers (GCP/AWS/Azure)](/packaging/installer/methods/cloud-providers.md) - -[ Install -Netdata on macOS](/packaging/installer/methods/macos.md) - -[ Install -Netdata on FreeBSD](/packaging/installer/methods/freebsd.md) - -[ Install -from a Git checkout](/packaging/installer/methods/manual.md) - -[ Install on -offline/air-gapped systems](/packaging/installer/methods/offline.md) - -[ -Installation on PFSense](/packaging/installer/methods/pfsense.md) - -[ Install -Netdata on Synology](/packaging/installer/methods/synology.md) - -[ Manual -installation on FreeNAS](/packaging/installer/methods/freenas.md) - -[ Manual -installation on Alpine](/packaging/installer/methods/alpine.md) - -[ -Build manually from source](/packaging/installer/methods/source.md) - -</div> +<Install> + <InstallBox + to="/docs/agent/packaging/installer/methods/kickstart" + os="General Linux with one-line installer (recommended)" + svg="linux" /> + <InstallBox + to="/docs/agent/packaging/docker" + os="Run with Docker" + svg="docker" /> + <InstallBox + to="/docs/agent/packaging/installer/methods/kubernetes" + os="Deploy on Kubernetes" + svg="kubernetes" /> + <InstallBox + to="/docs/agent/packaging/installer/methods/macos" + os="Install on macOS" + svg="macos" /> + <InstallBox + to="/docs/agent/packaging/installer/methods/packages" + os="Linux with .deb/.rpm packages" + svg="linux" /> + <InstallBox + to="/docs/agent/packaging/installer/methods/kickstart-64" + os="Linux with static 64-bit binary" + svg="linux" /> + <InstallBox + to="/docs/agent/packaging/installer/methods/manual" + os="Linux from Git" + svg="linux" /> + <InstallBox + to="/docs/agent/packaging/installer/methods/source" + os="Linux from source" + svg="linux" /> + <InstallBox + to="/docs/agent/packaging/installer/methods/offline" + os="Linux for offline nodes" + svg="linux" /> +</Install> ## Automatic updates diff --git a/packaging/installer/install-required-packages.sh b/packaging/installer/install-required-packages.sh index 203f7c6cb..f65535dd0 100755 --- a/packaging/installer/install-required-packages.sh +++ b/packaging/installer/install-required-packages.sh @@ -1558,7 +1558,7 @@ validate_tree_centos() { echo >&2 " > Checking for Okay ..." if ! rpm -qa | grep okay > /dev/null; then if prompt "okay not found, shall I install it?"; then - run ${sudo} yum ${opts} install http://repo.okay.com.mx/centos/8/x86_64/release/okay-release-1-3.el8.noarch.rpm + run ${sudo} yum ${opts} install http://repo.okay.com.mx/centos/8/x86_64/release/okay-release-1-5.el8.noarch.rpm fi fi diff --git a/packaging/installer/methods/alpine.md b/packaging/installer/methods/alpine.md index fb448959a..51c4b0ccd 100644 --- a/packaging/installer/methods/alpine.md +++ b/packaging/installer/methods/alpine.md @@ -9,28 +9,32 @@ Execute these commands to install Netdata in Alpine Linux 3.x: ```sh # install required packages -apk add alpine-sdk bash curl libuv-dev zlib-dev util-linux-dev libmnl-dev gcc make git autoconf automake pkgconfig python logrotate +apk add alpine-sdk bash curl libuv-dev zlib-dev util-linux-dev libmnl-dev gcc make git autoconf automake pkgconfig python3 logrotate # if you plan to run node.js Netdata plugins apk add nodejs # download Netdata - the directory 'netdata' will be created -git clone https://github.com/netdata/netdata.git --depth=100 +git clone https://github.com/netdata/netdata.git --depth=100 --recursive cd netdata # build it, install it, start it ./netdata-installer.sh -# make Netdata start at boot -echo -e "#!/usr/bin/env bash\n/usr/sbin/netdata" >/etc/local.d/netdata.start -chmod 755 /etc/local.d/netdata.start +# make Netdata start at boot and stop at shutdown +cat > /etc/init.d/netdata << EOF +#!/sbin/openrc-run -# make Netdata stop at shutdown -echo -e "#!/usr/bin/env bash\nkillall netdata" >/etc/local.d/netdata.stop -chmod 755 /etc/local.d/netdata.stop +name="netdata" +command="/usr/sbin/$SVCNAME" -# enable the local service to start automatically -rc-update add local +depend() { + need net localmount + after firewall +} +EOF ``` +If you have installed Netdata in another directory, you have to change the content of the `command` variable in that script. + [](<>) diff --git a/packaging/installer/methods/cloud-providers.md b/packaging/installer/methods/cloud-providers.md index 943a649b6..7b232f322 100644 --- a/packaging/installer/methods/cloud-providers.md +++ b/packaging/installer/methods/cloud-providers.md @@ -118,7 +118,7 @@ Add a new rule with the following options: Source: Any Source port ranges: 19999 Destination: Any -Destination port randes: 19999 +Destination port ranges: 19999 Protocol: TCP Action: Allow Priority: 310 diff --git a/packaging/installer/methods/freebsd.md b/packaging/installer/methods/freebsd.md index e2af41754..9c3db900f 100644 --- a/packaging/installer/methods/freebsd.md +++ b/packaging/installer/methods/freebsd.md @@ -64,7 +64,7 @@ You can now access the Netdata dashboard by navigating to `http://NODE:19999`, r  -From Netdata v1.12 and above, anonymous usage information is collected by default and sent to Google Analytics. To read +Starting with v1.30, Netdata collects anonymous usage information by default and sends it to a self hosted PostHog instance within the Netdata infrastructure. To read more about the information collected and how to opt-out, check the [anonymous statistics page](/docs/anonymous-statistics.md). diff --git a/packaging/installer/methods/kickstart-64.md b/packaging/installer/methods/kickstart-64.md index ea6cf32ea..c390b873a 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 0fc09ae83..e874d637d 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/macos.md b/packaging/installer/methods/macos.md index 05883a7fe..3fa21d0cd 100644 --- a/packaging/installer/methods/macos.md +++ b/packaging/installer/methods/macos.md @@ -61,7 +61,7 @@ and install the [Judy library](https://sourceforge.net/projects/judy/) before pr Next, download Netdata from our GitHub repository: ```bash -git clone https://github.com/netdata/netdata.git +git clone https://github.com/netdata/netdata.git --recursive ``` Finally, `cd` into the newly-created directory and then start the installer script: diff --git a/packaging/installer/methods/manual.md b/packaging/installer/methods/manual.md index 6ece95240..aa49c81ac 100644 --- a/packaging/installer/methods/manual.md +++ b/packaging/installer/methods/manual.md @@ -178,15 +178,13 @@ 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: ```sh # download it - the directory 'netdata' will be created -git clone https://github.com/netdata/netdata.git --depth=100 +git clone https://github.com/netdata/netdata.git --depth=100 --recursive cd netdata # run script with root privileges to build, install, start 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 |