Update uninstallation docs and remove reinstallation page (#18907)
Co-authored-by: ilyam8 <ilya@netdata.cloud>
Fotis Voutsas committed
Oct 31, 2024 at 10:50 UTC
55aaa2e8564c5993f320215005055926c286f62f
3 files changed
+43
-112
docs/category-overview-pages/maintenance-operations-on-netdata-agents.md
+5
-6
@@ -1,8 +1,7 @@
1
-# Maintenance operations on Netdata Agents Overview
1
+# Netdata Agent Maintenance Operations Overview
2
3
-This section provides information on various actions you can take while maintaining a Netdata Agent.
3
+This section provides information on various actions to maintain a Netdata Agent:
4
5
-- [Starting and Stopping Netdata Agents](/docs/netdata-agent/start-stop-restart.md)
6
-- [Update Netdata Agents](/packaging/installer/UPDATE.md)
7
-- [Reinstall Netdata Agents](/packaging/installer/REINSTALL.md)
8
-- [Uninstall Netdata Agents](/packaging/installer/UNINSTALL.md)
5
+- [Service Control](/docs/netdata-agent/start-stop-restart.md)
6
+- [Update](/packaging/installer/UPDATE.md)
7
+- [Uninstall](/packaging/installer/UNINSTALL.md)
packaging/installer/REINSTALL.md
deleted
-65
@@ -1,65 +0,0 @@
1
-# Reinstall Netdata
2
-
3
-In certain situations, such as needing to enable a feature or troubleshoot an issue, you may need to reinstall the
4
-Netdata Agent on your node.
5
-
6
-## One-line installer script (`kickstart.sh`)
7
-
8
-### Reinstalling with the same install type
9
-
10
-Run the one-line installer script with the `--reinstall` parameter to reinstall the Netdata Agent. This will preserve
11
-any [user configuration](/docs/netdata-agent/configuration/README.md) in `netdata.conf` or other files, and will keep the same install
12
-type that was used for the original install.
13
-
14
-If you used any [optional
15
-parameters](/packaging/installer/methods/kickstart.md#optional-parameters-to-alter-your-installation) during initial
16
-installation, you need to pass them to the script again during reinstallation. If you cannot remember which options you
17
-used, read the contents of the `.environment` file and look for a `REINSTALL_OPTIONS` line. This line contains a list of
18
-optional parameters.
19
-
20
-```bash
21
-wget -O /tmp/netdata-kickstart.sh https://get.netdata.cloud/kickstart.sh && sh /tmp/netdata-kickstart.sh --reinstall
22
-```
23
-
24
-### Performing a clean reinstall
25
-
26
-Run the one-line installer script with the `--reinstall-clean` parameter to perform a clean reinstall of the
27
-Netdata Agent. This will wipe all existing configuration and historical data, but can be useful sometimes for
28
-getting a badly broken installation working again. Unlike the regular `--reinstall` parameter, this may use a
29
-different install type than the original install used.
30
-
31
-If you used any [optional
32
-parameters](/packaging/installer/methods/kickstart.md#optional-parameters-to-alter-your-installation) during initial
33
-installation, you need to pass them to the script again during reinstallation. If you cannot remember which options you
34
-used, read the contents of the `.environment` file and look for a `REINSTALL_OPTIONS` line. This line contains a list of
35
-optional parameters.
36
-
37
-```bash
38
-wget -O /tmp/netdata-kickstart.sh https://get.netdata.cloud/kickstart.sh && sh /tmp/netdata-kickstart.sh --reinstall-clean
39
-```
40
-
41
-### Changing the install type of an existing installation
42
-
43
-The clean reinstall procedure outlined above can also be used to manually change the install type for an existing
44
-installation. Without any extra parameters, it will automatically pick the preferred installation type for your
45
-system, even if that has changed since the original install. If you want to force use of a specific install type,
46
-you can use the `--native-only`, `--static-only`, or `--build-only` parameter to control which install type gets
47
-used, just like with a new install.
48
-
49
-When using the `--reinstall-clean` option to change the install type, you will need to manually preserve any
50
-configuration or historical data you want to keep. The following directories may need to be preserved:
51
-
52
-- `/etc/netdata` (`/opt/netdata/etc/netdata` for static installs): For agent configuration.
53
-- `/var/lib/netdata` (`/opt/netdata/var/lib/netdata` for static installs): For claiming configuration.
54
-- `/var/cache/netdata` (`/opt/netdata/var/cache/netdata` for static installs): For historical data.
55
-
56
-When copying these directories back after the reinstall, you may need to update file ownership by running `chown
57
--R netdata:netdata` on them.
58
-
59
-## Troubleshooting
60
-
61
-If you still experience problems with your Netdata Agent installation after following one of these processes, the next
62
-best route is to [uninstall](/packaging/installer/UNINSTALL.md) and then try a fresh installation using the [one-line
63
-installer](/packaging/installer/methods/kickstart.md).
64
-
65
-You can also post to our [community forums](https://community.netdata.cloud) or create a new [bug report](https://github.com/netdata/netdata/issues/new?assignees=&labels=bug%2Cneeds+triage&template=BUG_REPORT.yml).
packaging/installer/UNINSTALL.md
+38
-41
@@ -1,47 +1,44 @@
1
# Uninstall Netdata
2
3
+## UNIX
4
+
5
> **Note**
6
>
5
-> If you're having trouble updating Netdata, moving from one installation method to another, or generally having
6
-> issues with your Netdata Agent installation, consider our [reinstalling Netdata](/packaging/installer/REINSTALL.md) instead of removing the Netdata Agent entirely.
7
+> This method assumes you installed Netdata using the `kickstart.sh` or `netdata-installer.sh` script.
8
+> If you used a different method, it might not work and could complicate the removal process.
9
8
-The recommended method to uninstall Netdata on a system is to use our kickstart installer script with the `--uninstall` option like so:
10
+The recommended way to uninstall Netdata is to use the same script you used for installation. Just add the `--uninstall` flag:
11
10
-```sh
12
+```bash
13
wget -O /tmp/netdata-kickstart.sh https://get.netdata.cloud/kickstart.sh && sh /tmp/netdata-kickstart.sh --uninstall
14
```
15
14
-Or (if you have curl but not wget):
16
+<details>
17
+<summary>if you have curl but not wget</summary>
18
19
```sh
20
curl https://get.netdata.cloud/kickstart.sh > /tmp/netdata-kickstart.sh && sh /tmp/netdata-kickstart.sh --uninstall
21
```
22
20
-This will work in most cases without you needing to do anything more other than accepting removal of configuration
21
-and data files.
23
+</details>
24
23
-If you used a non-standard installation prefix, you may need to specify that prefix using the `--old-install-prefix`
24
-option when uninstalling this way.
25
26
-## Unofficial installs
26
+**What to Expect**:
27
28
-If you used a third-party package to install Netdata, then the above method will usually not work, and you will
29
-need to use whatever mechanism you used to originally install Netdata to uninstall it.
28
+In most cases, these commands will guide you through the uninstallation process and remove configuration and data files automatically.
29
31
-## Uninstalling manually
30
+**Non-Standard Installations**:
31
33
-Most official installs of Netdata include an uninstaller script that can be manually invoked instead of using the
34
-kickstart script (internally, the kickstart script also uses this uninstaller script, it just handles the process
35
-outlined below for you).
32
+If you installed Netdata with a custom prefix (different directory location), you may need to specify the original prefix during uninstallation with the `--old-install-prefix` option.
33
37
-This uninstaller script is self-contained other than requiring a `.environment` file that was generated during
38
-installation. In most cases, this will be found in `/etc/netdata/.environment`, though if you used a non-standard
39
-installation prefix it will usually be located in a similar place under that prefix.
34
+## Uninstalling manually
35
+
36
+Most official installations of Netdata include an uninstaller script that can be manually invoked instead of using the kickstart script (internally, the kickstart script also uses this uninstaller script, it just handles the process outlined below for you).
37
41
-A workflow for uninstallation looks like this:
38
+This uninstaller script is self-contained, other than requiring a `.environment` file that was generated during installation. In most cases, this will be found in `/etc/netdata/.environment`, though if you used a custom installation prefix it be located under that directory.
39
43
-1. Find your `.environment` file, which is usually `/etc/netdata/.environment` in a default installation.
44
-2. If you cannot find that file and would like to uninstall Netdata, then create a new file with the following content:
40
+1. Find your `.environment` file
41
+2. If you can’t find that file and would like to uninstall Netdata, then create a new file with the following content:
42
43
```sh
44
NETDATA_PREFIX="<installation prefix>" # put what you used as a parameter to shell installed `--install-prefix` flag. Otherwise it should be empty
@@ -50,28 +47,26 @@ A workflow for uninstallation looks like this:
47
48
3. Run `netdata-uninstaller.sh` as follows
49
53
- 3.1 **Interactive mode (Default)**
50
+ - **Interactive mode (Default)**
51
55
- The default mode in the uninstaller script is **interactive**. This means that the script provides you
56
- the option to reply with "yes" (`y`/`Y`) or "no" (`n`/`N`) to control the removal of each Netdata asset in
57
- the filesystem.
52
+ The default mode in the uninstaller script is **interactive**. This means that the script provides you the option to reply with "yes" (`y`/`Y`) or "no" (`n`/`N`) to control the removal of each Netdata asset in the filesystem.
53
59
- ```sh
60
- ${NETDATA_PREFIX}/usr/libexec/netdata/netdata-uninstaller.sh --yes --env <environment_file>
61
- ```
54
+ ```sh
55
+ ${NETDATA_PREFIX}/usr/libexec/netdata/netdata-uninstaller.sh --yes --env <environment_file>
56
+ ```
57
63
- 3.2 **Non-interactive mode**
58
+ - **Non-interactive mode**
59
65
- If you are sure and you know what you are doing, you can speed up the removal of the Netdata assets from the
66
- filesystem without any questions by using the force option (`-f`/`--force`). This option will remove all the
67
- Netdata assets in a **non-interactive** mode.
60
+ If you’re sure, and you know what you’re doing, you can speed up the removal of the Netdata assets from the filesystem without any questions by using the force option (`-f`/`--force`). This option will remove all the
61
+ Netdata assets in a **non-interactive** mode.
62
69
- ```sh
70
- ${NETDATA_PREFIX}/usr/libexec/netdata/netdata-uninstaller.sh --yes --force --env <environment_file>
71
- ```
63
+ ```sh
64
+ ${NETDATA_PREFIX}/usr/libexec/netdata/netdata-uninstaller.sh --yes --force --env <environment_file>
65
+ ```
66
73
-Note: Existing installations may still need to download the file if it's not present. To execute uninstall in that case,
74
-run the following commands:
67
+> **Note**
68
+>
69
+> Existing installations may still need to download the file if it's not present. To execute the uninstaller in that case, run the following commands:
70
71
```sh
72
wget https://raw.githubusercontent.com/netdata/netdata/master/packaging/installer/netdata-uninstaller.sh
@@ -79,7 +74,9 @@ chmod +x ./netdata-uninstaller.sh
74
./netdata-uninstaller.sh --yes --env <environment_file>
75
```
76
82
-The default `environment_file` is `/etc/netdata/.environment`.
77
+## Windows
78
+
79
+Currently, the Windows version of Netdata is in beta. To uninstall Netdata on Windows:
80
84
-> Note: This uninstallation method assumes previous installation with `netdata-installer.sh` or the kickstart script.
85
-> Using it when Netdata was installed in some other way will usually not work correctly, and may make it harder to uninstall Netdata.
81
+1. Locate the `Uninstall.exe` file in your Netdata installation directory.
82
+2. Double-click the `Uninstall.exe` file and follow the on-screen instructions.