73f52709c · cryptotaxi247/netdata-1

@@ -1,31 +1,15 @@

1 # Update Netdata

2

3 -By default, the Netdata Agent automatically updates with the latest nightly or stable version depending on which

4 -you installed. If you opted out of automatic updates, you need to update your Netdata Agent to the latest nightly

5 -or stable version. You can also [enable or disable automatic updates on an existing install](#control-automatic-updates).

6 -

7 -> 💡 Looking to reinstall the Netdata Agent to enable a feature, update an Agent that cannot update automatically, or

8 -> troubleshoot an error during the installation process? See our [reinstallation doc](/packaging/installer/REINSTALL.md)

9 -> for reinstallation steps.

10 -

11 -Before you update the Netdata Agent, check to see if your Netdata Agent is already up-to-date by clicking on the update

12 -icon in the local Agent dashboard's top navigation. This modal informs you whether your Agent needs an update or not.

13 -

14 -The exact update method to use depends on the install type:

15 -

16 -- Installs with an install type of 'custom' usually indicate installing a third-party package through the system

17 - package manager. To update these installs, you should update the package just like you would any other package

18 - on your system.

19 -- Installs with an install type starting with `binpkg` or ending with `build` or `static` can be updated using

20 - our [regular update method](#updates-for-most-systems).

21 -- Installs with an install type of 'oci' were created from our official Docker images, and should be updated

22 - using our [Docker](#docker) update procedure.

3 +The update process can differ based on the install type:

4 +

5 +- Install types starting with `binpkg` or ending with `build` or `static` can be updated using our [kickstart script update method](#unix).

6 +- Installs with an install type of `custom` usually indicate installing a third-party package through the system package manager. To update these installs, you should update the package just like you would any other package on your system.

7 - macOS users should check [our update instructions for macOS](#macos).

8 - Manually built installs should check [our update instructions for manual builds](#manual-installation-from-git).

9

10 ## Determine which installation method you used

11

28 -Starting with netdata v1.33.0, you can use Netdata itself to determine the installation type by running:

12 +You can run the following to determine your installation type:

13

14 ```bash

15 netdata -W buildinfo | grep -E 'Installation Type|Install type:'

@@ -46,81 +30,38 @@ The following table contains all possible installation types:

30 | custom | Anything not covered by the other identifiers, including manual builds, manually running netdata-installer.sh, and third-party packages (community). |

31 | Unknown | Same as custom. |

32

49 -If you are using an older version of Netdata, or the above command produces no output, you can run our one-line

50 -installation script in dry-run mode to attempt to determine what method to use to update by running the following

51 -command:

33 +If you're using an older Netdata version or the above command doesn't output anything, try our one-line installation script in dry-run mode. Run the following command to determine the appropriate update method:

34

35 ```bash

36 wget -O /tmp/netdata-kickstart.sh https://get.netdata.cloud/kickstart.sh && sh /tmp/netdata-kickstart.sh --dry-run

37 ```

38

57 -Note that if you installed Netdata using an installation prefix, you will need to add an `--install-prefix` option

58 -specifying that prefix to make sure it finds the existing install.

39 +> **Note**

40 +>

41 +> if you installed Netdata using an installation prefix, you will need to add an `--install-prefix` option specifying that prefix to make sure it finds the existing install.

42

60 -If you see a line starting with `--- Would attempt to update existing installation by running the updater script

61 -located at:`, then our [regular update method](#updates-for-most-systems) will work for you.

43 +If you see a line starting with `--- Would attempt to update existing installation by running the updater script located at:`, then our [kickstart script update method](#unix) will work for you.

44

63 -Otherwise, it should either indicate that the installation type is not supported (which probably means you either

64 -have a `custom` install or built Netdata manually) or indicate that it would create a new install (which means that

65 -you either used a non-standard install path, or that you don’t actually have Netdata installed).

45 +Otherwise, it should either indicate that the installation type is not supported (which probably means you either have a `custom` install or built Netdata manually) or indicate that it would create a new install (which means that you either used a non-standard install path, or that you don’t actually have Netdata installed).

46

67 -## Updates for most systems

47 +## UNIX

48

69 -In most cases, you can update netdata using our one-line installation script. This script will automatically

70 -run the update script that was installed as part of the initial install (even if you disabled automatic updates)

71 -and preserve the existing install options you specified.

49 +In most cases, you can update Netdata using our one-line kickstart script. This script will automatically

50 +run the update script installed as part of the initial install and preserve the existing install options you specified.

51

73 -If you installed Netdata using an installation prefix, you will need to add an `--install-prefix` option specifying

74 -that prefix to this command to make sure it finds Netdata.

52 +If you installed Netdata using an installation prefix, you will need to add an `--install-prefix` option specifying that prefix to this command to make sure it finds Netdata.

53

54 ```bash

55 wget -O /tmp/netdata-kickstart.sh https://get.netdata.cloud/kickstart.sh && sh /tmp/netdata-kickstart.sh

56 ```

57

80 -### Issues with older binpkg installs

81 -

82 -The above command is known not to work with binpkg type installs for stable releases with a version number of

83 -v1.33.1 or earlier, and nightly builds with a version number of v1.33.1-93 or earlier. If you have such a system,

84 -the above command will report that it found an existing install, and then issue a warning about not being able to

85 -find the updater script.

86 -

87 -On such installs, you can update Netdata using your distribution package manager.

88 -

89 -### Updates on hosts without IPv4 connectivity

90 -

91 -The update process outlined above suffers from the same issues that installing on hosts without IPv4

92 -connectivity does, and requires similar workarounds. For more details check [the explanation in our install

93 -documentation](/packaging/installer/README.md#installs-on-hosts-without-ipv4-connectivity).

94 -

95 -### If the kickstart script does not work

96 -

97 -If the above command fails, you can [reinstall

98 -Netdata](/packaging/installer/REINSTALL.md#one-line-installer-script-kickstartsh) to get the latest version. This

99 -also preserves your [configuration](/docs/netdata-agent/configuration/README.md) in `netdata.conf` or other files just like updating

100 -normally would, though you will need to specify any installation options you used originally again.

101 -

102 -## Docker

103 -

104 -Docker-based installations do not update automatically. To update an Netdata Agent running in a Docker container, you

105 -must pull the [latest image from Docker Hub](https://hub.docker.com/r/netdata/netdata), stop and remove the container,

106 -and re-create it using the latest image.

107 -

108 -First, pull the latest version of the image.

109 -

110 -```bash

111 -docker pull netdata/netdata:latest

112 -```

113 -

114 -Next, to stop and remove any containers using the `netdata/netdata` image. Replace `netdata` if you changed it from the

115 -default.

58 +## Windows

59

117 -```bash

118 -docker stop netdata

119 -docker rm netdata

120 -```

60 +To update a Windows Netdata installation, download the executable and proceed to reinstall the Agent. This will update the installation.

61

122 -You can now re-create your Netdata container using the `docker` command or a `docker-compose.yml` file. See our [Docker

123 -installation instructions](/packaging/docker/README.md#create-a-new-netdata-agent-container) for details.

62 +> **Note**

63 +>

64 +> The Windows Agent is currently under beta and only available for Nightly releases, and the installer can be found in our [nightlies repo](https://github.com/netdata/netdata-nightlies). A stable version will be released soon.

65

66 ## macOS

67

@@ -130,25 +71,17 @@ If you installed Netdata on your macOS system using Homebrew, you can explicitly

71 brew upgrade netdata

72 ```

73

133 -Homebrew downloads the latest Netdata via the

134 -[formulae](https://github.com/Homebrew/homebrew-core/blob/master/Formula/n/netdata.rb), ensures all dependencies are met,

135 -and updates Netdata via reinstallation.

136 -

137 -If you instead installed Netdata using our one-line installation script, you can use our [regular update

138 -instructions](#updates-for-most-systems) to update Netdata.

74 +Homebrew downloads the latest Netdata via the [formula](https://github.com/Homebrew/homebrew-core/blob/master/Formula/n/netdata.rb), ensures all dependencies are met, and updates Netdata via reinstallation.

75

76 ## Manual installation from Git

77

142 -If you installed [Netdata manually from Git](/packaging/installer/methods/manual.md), you can run that installer again

143 -to update your agent. First, run our automatic requirements installer, which works on many Linux distributions, to

144 -ensure your system has the dependencies necessary for new features.

78 +If you installed [Netdata manually from Git](/packaging/installer/methods/manual.md) run our automatic requirements installer, which works on many Linux distributions, to ensure your system has the dependencies necessary for new features.

79

80 ```bash

81 bash <(curl -sSL https://raw.githubusercontent.com/netdata/netdata/master/packaging/installer/install-required-packages.sh)

82 ```

83

150 -Navigate to the directory where you first cloned the Netdata repository, pull the latest source code, and run

151 -`netdata-install.sh` again. This process compiles Netdata with the latest source code and updates it via reinstallation.

84 +Navigate to the directory where you first cloned the Netdata repository, pull the latest source code, and run `netdata-install.sh` again. This process compiles Netdata with the latest source code and updates it via reinstallation.

85

86 ```bash

87 cd /path/to/netdata/git

@@ -156,55 +89,25 @@ git pull origin master

89 sudo ./netdata-installer.sh

90 ```

91

159 -> ⚠️ If you installed Netdata with any optional parameters, such as `--no-updates` to disable automatic updates, and

160 -> want to retain those settings, you need to set them again during this process.

92 +> **Note**

93 +>

94 +> If you installed Netdata with any optional parameters, such as `--install-prefix` to install under a specific directory, you need to set them again during this process.

95

162 -## Control automatic updates

96 +## Additional info

97

164 -Starting with Netdata v1.34.0, you can easily enable or disable automatic updates on an existing installation

165 -using the updater script.

98 +### Control runtime behavior of the updater script

99

167 -For most installs on Linux, you can enable auto-updates with:

100 +Starting with v1.40.0, the `netdata-updater.sh` script supports a config file called `netdata-updater.conf`, located in the same directory as the main `netdata.conf` file. This file uses POSIX shell script syntax to define variables that are used by the updater.

101

169 -```bash

170 -/usr/libexec/netdata/netdata-updater.sh --enable-auto-updates

171 -```

172 -

173 -and disable them with:

174 -

175 -```bash

176 -/usr/libexec/netdata/netdata-updater.sh --disable-auto-updates

177 -```

178 -

179 -For static installs, instead use:

180 -

181 -```bash

182 -/opt/netdata/usr/libexec/netdata/netdata-updater.sh --enable-auto-updates

183 -```

184 -

185 -and:

186 -

187 -```bash

188 -/opt/netdata/usr/libexec/netdata/netdata-updater.sh --disable-auto-updates

189 -```

102 +This configuration file can be edited using our [`edit-config` script](/docs/netdata-agent/configuration/README.md).

103

191 -## Control runtime behavior of the updater script

192 -

193 -Starting with v1.40.0, the `netdata-updater.sh` script supports a config file called `netdata-updater.conf`,

194 -located in the same directory as the main `netdata.conf` file. This file uses POSIX shell script syntax to define

195 -variables that are used by the updater.

104 +The following configuration options are currently supported:

105

197 -This configuration file can be edited [using our `edit-config`

198 -script](/docs/netdata-agent/configuration/README.md).

106 +- `NETDATA_UPDATER_JITTER`: Sets an upper limit in seconds on the random delay in the updater script when running as a scheduled task. This random delay helps avoid issues resulting from too many nodes trying to reconnect to the Cloud at the same time. The default value is 3600, which corresponds to one hour. Most users shouldn’t ever need to change this.

107 +- `NETDATA_MAJOR_VERSION_UPDATES`: If set to a value other than 0, then new major versions will be installed without user confirmation. Must be set to a non-zero value for automated updates to install new major versions.

108 +- `NETDATA_NO_SYSTEMD_JOURNAL`: If set to a value other than 0, skip attempting to install the `netdata-plugin-systemd-journal` package on supported systems on update. The updater will install this optional package by default on supported systems if this option is not set. It only affects systems using native packages.

109

200 -The following configuration options are currently supported:

110 +### Updates on hosts without IPv4 connectivity

111

202 -- `NETDATA_UPDATER_JITTER`: Sets an upper limit in seconds on the random delay in the updater script when running

203 - as a scheduled task. This random delay helps avoid issues resulting from too many nodes trying to reconnect to

204 - the Cloud at the same time. The default value is 3600, which corresponds to one hour. Most users should not ever

205 - need to change this.

206 -- `NETDATA_MAJOR_VERSION_UPDATES`: If set to a value other than 0, then new major versions will be installed

207 - without user confirmation. Must be set to a non-zero value for automated updates to install new major versions.

208 -- `NETDATA_NO_SYSTEMD_JOURNAL`: If set to a value other than 0, skip attempting to install the

209 - `netdata-plugin-systemd-journal` package on supported systems on update. This optional package will be installed

210 - by default on supported systems by the updater if this option is not set. Only affects systems using native packages.

112 +The update process outlined above suffers from the same issues that installing on hosts without IPv4 connectivity does, and requires similar workarounds.

113 +For more details, check [the explanation in our install documentation](/packaging/installer/README.md#installs-on-hosts-without-ipv4-connectivity).

Updating Netdata docs (#18898)