Added more robust doucmentation around updates. (#10100)
* Added more robust doucmentation around updates. This adds additional documentation about how to update installs with our installer scripts to help users deal with failed updates. * Update packaging/installer/UPDATE.md Co-authored-by: Joel Hans <joel.g.hans@gmail.com> * Update packaging/installer/UPDATE.md Co-authored-by: Joel Hans <joel.g.hans@gmail.com> * Update packaging/installer/UPDATE.md Co-authored-by: Joel Hans <joel.g.hans@gmail.com> * Update packaging/installer/UPDATE.md Co-authored-by: Joel Hans <joel.g.hans@gmail.com> * Reference info about configuration directory. This makes the section about determining your installation type shorter and more concise and avoids duplication of documentation. Co-authored-by: Joel Hans <joel.g.hans@gmail.com>
Austin S. Hemmelgarn committed
Oct 19, 2020 at 12:03 UTC
c6476bb5a167988885b97eeba54e911cacb3229d
1 file changed
+45
-14
packaging/installer/UPDATE.md
+45
-14
@@ -24,28 +24,50 @@ you installed it.** Choose from the following list to see the appropriate update
24
25
- [One-line installer script (`kickstart.sh`)](#one-line-installer-script-kickstartsh)
26
- [`.deb` or `.rpm` packages](#deb-or-rpm-packages)
27
-- [Pre-built static binary for 64-bit systems
28
- (`kickstart-static64.sh`)](#pre-built-static-binary-for-64-bit-systems-kickstart-static64sh)
27
+- [Pre-built static binary for 64-bit systems (`kickstart-static64.sh`)](#pre-built-static-binary-for-64-bit-systems-kickstart-static64sh)
28
- [Docker](#docker)
29
- [macOS](#macos)
30
- [Manual installation from Git](#manual-installation-from-git)
31
32
+#### How to determine which install method you used
33
+
34
+First, see [here](https://learn.netdata.cloud/docs/configure/nodes#the-netdata-config-directory) to figure out
35
+where your user configuration files for Netdata are.
36
+
37
+Once you have figured this out, look for a file called `.environment` in this directory (you will need to use
38
+`ls -a` to see it, as it will not be listed by default by a regular `ls` command). If it is not there, you used
39
+package manager to install netdata and need to update it through that package manager. If the `environment` file
40
+is present, check the contents of the file. If `IS_NETDATA_STATIC_BINARY` is `"yes"`, then you installed using
41
+`kickstart-static64.sh`. Otherwise you installed using `kickstart.sh`.
42
+
43
## One-line installer script (`kickstart.sh`)
44
45
If you installed Netdata using our one-line automatic installation script, run it again to update Netdata. Any custom
46
settings present in your Netdata configuration directory (typically at `/etc/netdata`) persists during this process.
47
38
-This script downloads the latest Netdata source (either the nightly or stable version), compiles Netdata, and updates it
39
-via reinstallation.
48
+This script will automatically run the update script that was installed as part of the initial install (even if
49
+you disabled automatic updates) and preserve the existing install options you specified.
50
+
51
+If you installed Netdata using an installation prefix, you will need to add an `--install` option specifying
52
+that prefix to this command to make sure it finds Netdata.
53
54
```bash
55
bash <(curl -Ss https://my-netdata.io/kickstart.sh)
56
```
57
45
-> ⚠️ If you installed Netdata with any optional parameters, such as `--no-updates` to disable automatic updates, and
46
-> want to retain those settings, you need to set them again during this process. See the [`kickstart.sh`
47
-> documentation](methods/kickstart.md#optional-parameters-to-alter-your-installation) for more information on these
48
-> parameters and what they do.
58
+In the event that this command fails, there may be an issue with the installed update script. In such cases, you
59
+can instead use the following command to run an update as if it were a clean install (this will still preserve
60
+any user configuration).
61
+
62
+```bash
63
+bash <(curl -Ss https://my-netdata.io/kickstart.sh) --reinstall
64
+```
65
+
66
+If using this method, you will need to pass any options you passed during the original installation process. To
67
+determine what options you passed, start by finding the `.environment` file for your install as described above in
68
+[How to determine which install method you used](#how-to-determine-which-install-method-you-used). Once you have
69
+found this file, look at the value of the `REINSTALL_OPTIONS` line. This is the list of additional options you
70
+need to pass to the above command.
71
72
## `.deb` or `.rpm` packages
73
@@ -70,17 +92,26 @@ If you installed Netdata using the pre-built static binary, run the `kickstart-s
92
Netdata. Any custom settings present in your Netdata configuration directory (typically at `/etc/netdata`) persists
93
during this process.
94
73
-This script downloads the latest Netdata source (either the nightly or stable version), compiles Netdata, and updates it
74
-via reinstallation.
95
+This script will automatically run the update script that was installed as part of the initial install (even if
96
+you disabled automatic updates) and preserve the existing install options you specified.
97
98
```bash
99
bash <(curl -Ss https://my-netdata.io/kickstart-static64.sh)
100
```
101
80
-> ⚠️ If you installed Netdata with any optional parameters, such as `--no-updates` to disable automatic updates, and
81
-> want to retain those settings, you need to set them again during this process. See the [`kickstart-static64.sh`
82
-> documentation](methods/kickstart-64.md#optional-parameters-to-alter-your-installation) for more information on these
83
-> parameters and what they do.
102
+In the event that this command fails, there may be an issue with the installed update script. In such cases, you
103
+can instead use the following command to run an update as if it were a clean install (this will still preserve
104
+any user configuration).
105
+
106
+```bash
107
+bash <(curl -Ss https://my-netdata.io/kickstart-static64.sh) --reinstall
108
+```
109
+
110
+If using this method, you will need to pass any options you passed during the original installation process. To
111
+determine what options you passed, start by finding the `.environment` file for your install as described above in
112
+[How to determine which install method you used](#how-to-determine-which-install-method-you-used). Once you have
113
+found this file, look at the value of the `REINSTALL_OPTIONS` line. This is the list of additional options you
114
+need to pass to the above command.
115
116
## Docker
117