Home Explore Help
Sign In
SMusatov
/
netdata
mirror of https://github.com/netdata/netdata.git
1
0
Fork 0
Files Wiki
Tree: 4a7c780743
Branches Tags
netdata
/
packaging
/
installer
/
methods
/
kickstart.md

kickstart.md 11 KB
History Raw

import { OneLineInstallWget, OneLineInstallCurl } from '@site/src/components/OneLineInstall/' import { Install, InstallBox } from '@site/src/components/Install/' import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

Install Netdata with kickstart.sh

This page covers detailed instructions on using and configuring the automatic one-line installation script named kickstart.sh.

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 before continuing.

:bulb: Tip

If you are unsure whether you want nightly or stable releases, read the installation guide.

If you want to turn off automatic updates, use the --no-updates option. You can find more installation options below.

To install Netdata, run the following as your normal user:

:bookmark_tabs: Note

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, and YOUR_ROOM_ID with the ID of the room you are willing to connect the node to.

What does kickstart.sh do?

The kickstart.sh script does the following after being downloaded and run using sh:

  • Determines what platform you are running on.
  • Checks for an existing installation, and if found updates that instead of creating a new install.
  • Attempts to install Netdata using our official native binary packages.
  • If there are no official native binary packages for your system (or installing that way failed), tries to install using a static build of Netdata if one is available.
  • If no static build is available, installs required dependencies and then attempts to install by building Netdata locally (by downloading the sources and building them directly).
  • Installs netdata-updater.sh to cron.daily, so your Netdata installation will be updated with new nightly versions, unless you override that with an optional parameter.
  • Prints a message whether installation succeeded or failed for QA purposes.

Optional parameters to alter your installation

The kickstart.sh script accepts a number of optional parameters to control how the installation process works:

  • --non-interactive: Don’t prompt for anything and assume yes whenever possible, overriding any automatic detection of an interactive run.
  • --interactive: Act as if running interactively, even if automatic detection indicates a run is non-interactive.
  • --dont-wait: Synonym for --non-interactive
  • --dry-run: Show what the installer would do, but don’t actually do any of it.
  • --dont-start-it: Don’t auto-start the daemon after installing. This parameter is not guaranteed to work.
  • --release-channel: Specify a particular release channel to install from. Currently supported release channels are:
    • nightly: Installs a nightly build (this is currently the default).
    • stable: Installs a stable release.
    • default: Explicitly request whatever the current default is.
  • --nightly-channel: Synonym for --release-channel nightly.
  • --stable-channel: Synonym for --release-channel stable.
  • --auto-update: Enable automatic updates (this is the default).
  • --no-updates: Disable automatic updates.
  • --disable-telemetry: Disable anonymous statistics.
  • --native-only: Only install if native binary packages are available.
  • --static-only: Only install if a static build is available.
  • --build-only: Only install using a local build.
  • --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.
  • --require-cloud: Only install if Netdata Cloud can be enabled. Overrides --disable-cloud.
  • --install-prefix: Specify an installation prefix for local builds (by default, we use a sane prefix based on the type of system).
  • --install-version: Specify the version of Netdata to install.
  • --old-install-prefix: Specify the custom local build's installation prefix that should be removed.
  • --local-build-options: Specify additional options to pass to the installer code when building locally. Only valid if --build-only is also specified.
  • --static-install-options: Specify additional options to pass to the static installer code. Only valid if --static-only is also specified.
  • --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 http://[user:pass@]host:ip for an HTTP(S) proxy. See connecting through a proxy for details.
  • --claim-url: Specify a URL to use when connecting to the cloud. Defaults to https://app.netdata.cloud.
  • --override-distro: Override the distro detection logic and assume the system is using a specific Linux distribution and release. Takes a single argument consisting of the values of the ID, VERSION_ID, and VERSION_CODENAME fields from /etc/os-release for the desired distribution.

The following options are mutually exclusive and specifiy special operations other than trying to install Netdata normally or update an existing install:

  • --reinstall: If there is an existing install, reinstall it instead of trying to update it. If there is not an existing install, install netdata normally.
  • --reinstall-even-if-unsafe: If there is an existing install, reinstall it instead of trying to update it, even if doing so is known to potentially break things (for example, if we cannot detect what type of installation it is). If there is not an existing install, install Netdata normally.
  • --reinstall-clean: If there is an existing install, uninstall it before trying to install Netdata. Fails if there is no existing install.
  • --uninstall: Uninstall an existing installation of Netdata. Fails if there is no existing install.
  • --claim-only: If there is an existing install, only try to claim it without attempting to update it. If there is no existing install, install and claim Netdata normally.
  • --repositories-only: Only install repository configuration packages instead of doing a full install of Netdata. Automatically sets --native-only.
  • --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 for more info.

Additionally, the following environment variables may be used to further customize how the script runs (most users should not need to use special values for any of these):

  • TMPDIR: Used to specify where to put temporary files. On most systems, the default we select automatically should be fine. The user running the script needs to both be able to write files to the temporary directory, and run files from that location.
  • ROOTCMD: Used to specify a command to use to run another command with root privileges if needed. By default we try to use sudo, doas, or pkexec (in that order of preference), but if you need special options for one of those to work, or have a different tool to do the same thing on your system, you can specify it here.
  • DISABLE_TELEMETRY: If set to a value other than 0, behave as if --disable-telemetry was specified.

Native packages

We publish official DEB/RPM packages for a number of common Linux distributions as part of our releases and nightly builds. These packages are available for 64-bit x86 systems. Depending on the distribution and release they may also be available for 32-bit x86, ARMv7, and AArch64 systems. If a native package is available, it will be used as the default installation method. This allows you to handle Netdata updates as part of your usual system update procedure.

If you want to enforce the usage of native packages and have the installer return a failure if they are not available, you can do so by adding --native-only to the options you pass to the installer.

Static builds

We publish pre-built static builds of Netdata for Linux systems. Currently, these are published for 64-bit x86, ARMv7, AArch64, and POWER8+ hardware. These static builds are able to operate in a mostly self-contained manner and only require a POSIX compliant shell and a supported init system. These static builds install under /opt/netdata. If you are on a platform which we provide static builds for but do not provide native packages for, a static build will be used by default for installation.

If you want to enforce the usage of a static build and have the installer return a failure if one is not available, you can do so by adding --static-only to the options you pass to the installer.

Local builds

For systems which do not have available native packages or static builds, we support building Netdata locally on the system it will be installed on. When using this approach, the installer will attempt to install any required dependencies for building Netdata, though this may not always work correctly.

If you want to enforce the usage of a local build (perhaps because you require a custom installation prefix, which is not supported with native packages or static builds), you can do so by adding --build-only to the options you pass to the installer.

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:

[ "<checksum-will-be-added-in-documentation-processing>" = "$(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.