@cryptotaxi247 / netdata-1 / commits / 890ddf503

Maintenance: update restart, backup, uninstall, and restore docs (#20398)

Co-authored-by: ilyam8 <ilya@netdata.cloud>

Kanela committed Jun 3, 2025 at 12:24 UTC 890ddf5034ea028302f3855378546c136a6010ca
4 files changed +333 -96
docs/netdata-agent/backup-and-restore-an-agent.md
+98 -25
@@ -1,8 +1,20 @@
1 # Backing up a Netdata Agent
2
3 -> **Note**
4 ->
5 -> Users are responsible for backing up, recovering, and ensuring their data's availability because Netdata stores data locally on each system due to its decentralized architecture.
3 +:::tip
4 +
5 +**What You'll Learn**
6 +
7 +How to back up and restore Netdata Agent data including configuration, metrics, and identity files for disaster recovery scenarios.
8 +
9 +:::
10 +
11 +:::important
12 +
13 +**User Responsibility**
14 +
15 +Users are responsible for backing up, recovering, and ensuring their data's availability because Netdata stores data locally on each system due to its decentralized architecture.
16 +
17 +:::
18
19 ## Introduction
20
@@ -14,21 +26,62 @@ When planning a Netdata Agent backup, it's essential to recognize the types of d
26 | Metrics | Database files | /var/cache/netdata |
27 | Identity | Claim token, API key and some other files | /var/lib/netdata |
28
17 -## Scenarios
29 +## Backup and Restore Scenarios
30 +
31 +<details>
32 +<summary><strong>Backing up to restore data in case of a node failure</strong></summary><br/>
33 +
34 +In this standard scenario, you're backing up your Netdata Agent in case of a node failure or data corruption so that the metrics and the configuration can be recovered. The purpose is not to back up/restore the application itself.
35 +
36 +### Backup Process
37 +
38 +```mermaid
39 +graph TB
40 + Start("**Start Backup Process**")
41 +
42 + Verify("**Verify Directory Paths**<br/><br/>Check that paths contain<br/>expected information<br/><br/>/etc/netdata/<br/>/var/cache/netdata<br/>/var/lib/netdata")
43 +
44 + Stop("**Stop Netdata Agent**<br/><br/>Recommended for<br/>Metrics/database files")
45 +
46 + Backup("**Create Backup Archive**<br/><br/>tar -cvpzf netdata_backup.tar.gz<br/>/etc/netdata/ /var/cache/netdata<br/>/var/lib/netdata")
47 +
48 + Restart("**Restart Netdata Agent**<br/><br/>Resume monitoring")
49 +
50 + Start --> Verify
51 + Verify --> Stop
52 + Stop --> Backup
53 + Backup --> Restart
54 +
55 + %% Style definitions
56 + classDef startEnd fill:#f9f9f9,stroke:#000000,stroke-width:3px,color:#000000,font-size:16px
57 + classDef process fill:#ffeb3b,stroke:#000000,stroke-width:3px,color:#000000,font-size:16px
58 + classDef complete fill:#4caf50,stroke:#000000,stroke-width:3px,color:#000000,font-size:16px
59 +
60 + %% Apply styles
61 + class Start startEnd
62 + class Verify,Stop,Backup process
63 + class Restart complete
64 +```
65 +
66 +1. **Verify directory paths**
67 +
68 + Verify that the directory paths in the table above contain the information you expect.
69 +
70 + :::note
71
19 -### Backing up to restore data in case of a node failure
72 + **Path Variations**
73
21 -In this standard scenario, you’re backing up your Netdata Agent in case of a node failure or data corruption so that the metrics and the configuration can be recovered. The purpose is not to backup/restore the application itself.
74 + The specific paths may vary depending on the installation method, Operating System, and whether it is a Docker/Kubernetes deployment.
75
23 -1. Verify that the directory paths in the table above contain the information you expect.
76 + :::
77
25 - > **Note**
26 - > The specific paths may vary depending on installation method, Operating System, and whether it is a Docker/Kubernetes deployment.
78 +2. **Stop the Netdata Agent**
79
28 -2. It is recommended that you [stop the Netdata Agent](/docs/netdata-agent/start-stop-restart.md) when backing up the Metrics/database files.
29 - Backing up the Agent configuration and Identity folders is straightforward as they shouldn’t be changing very frequently.
80 + It is recommended that you [stop the Netdata Agent](/docs/netdata-agent/start-stop-restart.md) when backing up the Metrics/database files. Backing up the Agent configuration and Identity folders is straightforward as they shouldn't be changing very frequently.
81
31 -3. Using a backup tool such as `tar` you will need to run the backup as _root_ or as the _netdata_ user to access all the files in the directories.
82 +3. **Create a backup archive**
83 +
84 + Using a backup tool such as `tar` you will need to run the backup as _root_ or as the _netdata_ user to access all the files in the directories.
85
86 ```bash
87 sudo tar -cvpzf netdata_backup.tar.gz /etc/netdata/ /var/cache/netdata /var/lib/netdata
@@ -36,34 +89,54 @@ In this standard scenario, you’re backing up your Netdata Agent in case of a n
89
90 Stopping the Netdata Agent is typically necessary to back up the database files of the Netdata Agent.
91
92 +### Minimizing Service Interruption
93 +
94 If you want to minimize the gap in metrics caused by stopping the Netdata Agent, consider implementing a backup job or script that follows this sequence:
95
41 -- Backup the Agent configuration Identity directories
96 +- Back up the Agent configuration Identity directories
97 - Stop the Netdata service
43 -- Backup up the database files
98 +- Back up the database files
99 - Restart the Netdata Agent.
100
46 -### Restoring Netdata
101 +<br/>
102 +</details>
103 +
104 +<details>
105 +<summary><strong>Restoring Netdata</strong></summary><br/>
106 +
107 +### Restoration Process
108
48 -1. Ensure that the Netdata Agent is installed and is [stopped](/docs/netdata-agent/start-stop-restart.md)
109 +1. **Prepare for restoration**
110
50 - If you plan to deploy the Agent and restore a backup on top of it, then you might find it helpful to use the [`--dont-start-it`](/packaging/installer/methods/kickstart.md#other-options) option upon installation.
111 + Ensure that the Netdata Agent is installed and is [stopped](/docs/netdata-agent/start-stop-restart.md)
112 +
113 + If you plan to deploy the Agent and restore a backup on top of it, then you might find it helpful to use the [`--dont-start-it`](/packaging/installer/methods/kickstart.md#optional-parameters-for-kickstartsh) option upon installation.
114
115 ```bash
116 wget -O /tmp/netdata-kickstart.sh https://get.netdata.cloud/kickstart.sh && sh /tmp/netdata-kickstart.sh --dont-start-it
117 ```
118
56 - > **Note**
57 - > If you are going to restore the database files, then you should first ensure that the Metrics directory is empty.
58 - >
59 - > ```bash
60 - > sudo rm -Rf /var/cache/netdata
61 - > ```
119 + :::warning
120 +
121 + **Database File Restoration**
122
63 -2. Restore the backup from the archive
123 + If you’re going to restore the database files, then you should first ensure that the Metrics directory is empty.
124 +
125 + ```bash
126 + sudo rm -Rf /var/cache/netdata
127 + ```
128 +
129 + :::
130 +
131 +2. **Restore from backup archive**
132
133 ```bash
134 sudo tar -xvpzf /path/to/netdata_backup.tar.gz -C /
135 ```
136
69 -3. [Start the Netdata Agent](/docs/netdata-agent/start-stop-restart.md)
137 +3. **Start the Netdata Agent**
138 +
139 + [Start the Netdata Agent](/docs/netdata-agent/start-stop-restart.md)
140 +
141 +<br/>
142 +</details>
docs/netdata-agent/start-stop-restart.md
+66 -12
@@ -1,20 +1,40 @@
1 # Service Control
2
3 +:::tip
4 +
5 +**What You'll Learn**
6 +
7 +How to start, stop, restart, and reload the Netdata Agent across different operating systems and service management systems.
8 +
9 +:::
10 +
11 The Netdata Agent automatically starts at boot after installation.
12
5 -> In most cases, you need to **restart the Netdata service** to apply changes to configuration files. Health configuration files, which define alerts, are an exception. They can be [reloaded](#reload-health) **without restarting**.
6 ->
7 -> Restarting the Netdata Agent will cause temporary gaps in your collected metrics. This occurs while the netdata process reinitializes its data collectors and database engine.
13 +:::important
14 +
15 +**Important**
16 +
17 +In most cases, you need to **restart the Netdata service** to apply changes to configuration files. Health configuration files, which define alerts, are an exception. They can be [reloaded](#reload-health) **without restarting**.
18 +
19 +:::
20 +
21 +:::warning
22 +
23 +**Service Restart Impact**
24 +
25 +Restarting the Netdata Agent will cause temporary gaps in your collected metrics. This occurs while the netdata process reinitializes its data collectors and database engine.
26 +
27 +:::
28
29 ## UNIX
30
31 ### Using `systemctl`, `service`, or `init.d`
32
13 -| Action | Systemd | Non-systemd |
14 -|---------|---------------------------------|--------------------------------|
15 -| start | `sudo systemctl start netdata` | `sudo service netdata start` |
16 -| stop | `sudo systemctl stop netdata` | `sudo service netdata stop` |
17 -| restart | `sudo systemctl restart netdata`| `sudo service netdata restart` |
33 +| Action | Systemd | Non-systemd |
34 +|---------|----------------------------------|--------------------------------|
35 +| start | `sudo systemctl start netdata` | `sudo service netdata start` |
36 +| stop | `sudo systemctl stop netdata` | `sudo service netdata stop` |
37 +| restart | `sudo systemctl restart netdata` | `sudo service netdata restart` |
38
39 ### Using `netdata`
40
@@ -44,12 +64,46 @@ sudo netdatacli reload-health
64
65 ## Windows
66
47 -> **Note**
48 ->
49 -> You will need to run PowerShell as administrator.
67 +:::note
68 +
69 +**Administrator Access Required**
70 +
71 +You will need to run PowerShell as administrator.
72 +
73 +:::
74 +
75 +### Using Windows Services GUI
76 +
77 +<details>
78 +<summary><strong>Manage Through Task Manager</strong></summary><br/>
79 +
80 +If you prefer to manage the Agent through the GUI, you can start-stop and restart the `Netdata` service from the "Services" tab of Task Manager.
81 +
82 +<br/>
83 +</details>
84 +
85 +### Using PowerShell Commands
86
87 - To **start** Netdata, run `Start-Service Netdata`.
88 - To **stop** Netdata, run `Stop-Service Netdata`.
89 - To **restart** Netdata, run `Restart-Service Netdata`.
90
55 -If you prefer to manage the Agent through the GUI, you can start-stop and restart the `Netdata` service from the "Services" tab of Task Manager.
91 +## Quick Reference
92 +
93 +### UNIX Commands Summary
94 +
95 +| Task | Systemd | Non-systemd | Direct Command |
96 +|-------------------|----------------------------------|----------------------------------|----------------------------------|
97 +| **Start** | `sudo systemctl start netdata` | `sudo service netdata start` | `sudo netdata` |
98 +| **Stop** | `sudo systemctl stop netdata` | `sudo service netdata stop` | `sudo killall netdata` |
99 +| **Restart** | `sudo systemctl restart netdata` | `sudo service netdata restart` | Stop + Start |
100 +| **Reload Health** | `sudo netdatacli reload-health` | `sudo netdatacli reload-health` | `sudo netdatacli reload-health` |
101 +| **Shutdown** | `sudo netdatacli shutdown-agent` | `sudo netdatacli shutdown-agent` | `sudo netdatacli shutdown-agent` |
102 +
103 +### Windows Commands Summary
104 +
105 +| Task | PowerShell Command | GUI Location |
106 +|-------------|---------------------------|-----------------------------------|
107 +| **Start** | `Start-Service Netdata` | Task Manager > Services > Netdata |
108 +| **Stop** | `Stop-Service Netdata` | Task Manager > Services > Netdata |
109 +| **Restart** | `Restart-Service Netdata` | Task Manager > Services > Netdata |
packaging/installer/UNINSTALL.md
+72 -28
@@ -1,29 +1,52 @@
1 # Uninstall Netdata
2
3 -## UNIX
3 +:::tip
4
5 -> **Note**
6 ->
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.
5 +**What You'll Learn**
6
10 -Similarly with our documentation on updating Netdata, you need to [determine your installation type](/packaging/installer/UPDATE.md).
7 +How to uninstall Netdata from UNIX and Windows systems using automated scripts or manual methods based on your installation type.
8
12 -**If your installation type indicates a native package, then proceed to uninstall Netdata using your package manager.**
9 +:::
10
14 -The recommended way to uninstall Netdata is to use the same script you used for installation. Just add the `--uninstall` flag:
11 +## Uninstall Methods by Platform
12 +
13 +<details>
14 +<summary><strong>UNIX</strong></summary><br/>
15 +
16 +:::note
17 +
18 +**Installation Method Note**
19 +
20 +This method assumes you installed Netdata using the `kickstart.sh` or `netdata-installer.sh` script. If you used a different method, it might not work and could complicate the removal process.
21 +
22 +:::
23 +
24 +Similarly, with our documentation on updating Netdata, you need to [determine your installation type](/packaging/installer/UPDATE.md).
25 +
26 +:::important
27 +
28 +**Native Package Users**
29 +
30 +If your installation type indicates a [native package](https://learn.netdata.cloud/docs/netdata-agent/installation/linux/native-linux-distribution-packages), then proceed to uninstall Netdata using your package manager.
31 +
32 +:::
33 +
34 +### Automated Uninstallation
35 +
36 +The recommended way to uninstall Netdata is to use the same script you used for installation. Add the `--uninstall` flag:
37
38 ```bash
39 wget -O /tmp/netdata-kickstart.sh https://get.netdata.cloud/kickstart.sh && sh /tmp/netdata-kickstart.sh --uninstall
40 ```
41
42 <details>
21 -<summary>if you have curl but not wget</summary>
43 +<summary><strong>if you have curl but not wget</strong></summary><br/>
44
45 ```sh
46 curl https://get.netdata.cloud/kickstart.sh > /tmp/netdata-kickstart.sh && sh /tmp/netdata-kickstart.sh --uninstall
47 ```
48
49 +<br/>
50 </details>
51
52 **What to Expect**:
@@ -38,38 +61,50 @@ If you installed Netdata with a custom prefix (different directory location), yo
61
62 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).
63
41 -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.
64 +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 will be located under that directory.
65 +
66 +#### Manual Uninstallation Steps
67 +
68 +1. **Find your `.environment` file**
69
43 -1. Find your `.environment` file
44 -2. If you can’t find that file and would like to uninstall Netdata, then create a new file with the following content:
70 +2. **If you can't find that file and would like to uninstall Netdata, then create a new file with the following content:**
71
72 ```sh
73 NETDATA_PREFIX="<installation prefix>" # put what you used as a parameter to shell installed `--install-prefix` flag. Otherwise it should be empty
74 NETDATA_ADDED_TO_GROUPS="<additional groups>" # Additional groups for a user running the Netdata process
75 ```
76
51 -3. Run `netdata-uninstaller.sh` as follows
77 +3. **Run `netdata-uninstaller.sh` as follows**
78
53 - - **Interactive mode (Default)**
79 + <details>
80 + <summary><strong>Interactive mode (Default)</strong></summary><br/>
81
55 - 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.
82 + 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.
83
57 - ```sh
58 - ${NETDATA_PREFIX}/usr/libexec/netdata/netdata-uninstaller.sh --yes --env <environment_file>
59 - ```
84 + ```sh
85 + ${NETDATA_PREFIX}/usr/libexec/netdata/netdata-uninstaller.sh --yes --env <environment_file>
86 + ```
87 +
88 + <br/>
89 + </details>
90 +
91 + <details>
92 + <summary><strong>Non-interactive mode</strong></summary><br/>
93 +
94 + 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 Netdata assets in a **non-interactive** mode.
95 +
96 + ```sh
97 + ${NETDATA_PREFIX}/usr/libexec/netdata/netdata-uninstaller.sh --yes --force --env <environment_file>
98 + ```
99
61 - - **Non-interactive mode**
100 + <br/>
101 + </details>
102
63 - 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
64 - Netdata assets in a **non-interactive** mode.
103 +:::note
104
66 - ```sh
67 - ${NETDATA_PREFIX}/usr/libexec/netdata/netdata-uninstaller.sh --yes --force --env <environment_file>
68 - ```
105 +**Missing Uninstaller File**
106
70 -> **Note**
71 ->
72 -> 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:
107 +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:
108
109 ```sh
110 wget https://raw.githubusercontent.com/netdata/netdata/master/packaging/installer/netdata-uninstaller.sh
@@ -77,7 +112,13 @@ chmod +x ./netdata-uninstaller.sh
112 ./netdata-uninstaller.sh --yes --env <environment_file>
113 ```
114
80 -## Windows
115 +:::
116 +
117 +<br/>
118 +</details>
119 +
120 +<details>
121 +<summary><strong>Windows</strong></summary><br/>
122
123 To uninstall Netdata on Windows, use the standard application uninstaller in your **Settings** app or **Control Panel**.
124
@@ -86,3 +127,6 @@ You can also use PowerShell:
127 ```powershell
128 msiexec /qn /x netdata-x64.msi
129 ```
130 +
131 +<br/>
132 +</details>
packaging/installer/UPDATE.md
+97 -31
@@ -1,20 +1,60 @@
1 # Update Netdata
2
3 +:::tip
4 +
5 +**What You'll Learn**
6 +
7 +How to update Netdata based on your installation method, determine your installation type, and configure the updater behavior.
8 +
9 +:::
10 +
11 The update process can differ based on the installation type:
12
5 -- Install types starting with `binpkg` or ending with `build` or `static` can be updated using our [kickstart script update method](#unix).
13 +- Install types starting with `binpkg` or ending with `build` or `static` can be updated using our [kickstart script update method](#update-methods-by-platform).
14 - Installs with an installation type of `custom` usually indicate installing a third-party package through the system package manager. To update these installations, 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).
15 +- macOS users should check [our update instructions for macOS](#update-methods-by-platform).
16 +- Manually built installs should check [our update instructions for manual builds](#update-methods-by-platform).
17
18 ## Determine which installation method you used
19
20 +:::important
21 +
22 +**First Step**
23 +
24 +Before updating, you need to identify your installation type to choose the correct update method.
25 +
26 +:::
27 +
28 You can run the following to determine your installation type:
29
30 ```bash
31 netdata -W buildinfo | grep -E 'Installation Type|Install type:'
32 ```
33
34 +:::tip
35 +
36 +**If the above command doesn't work**
37 +
38 +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:
39 +
40 +```bash
41 +wget -O /tmp/netdata-kickstart.sh https://get.netdata.cloud/kickstart.sh && sh /tmp/netdata-kickstart.sh --dry-run
42 +```
43 +
44 +:::note
45 +
46 +**Installation Prefix**
47 +
48 +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 installation.
49 +
50 +:::
51 +
52 +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](#update-methods-by-platform) will work for you.
53 +
54 +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 installation path, or that you don't have Netdata installed).
55 +
56 +:::
57 +
58 The following table contains all possible installation types:
59
60 | Installation-type | Description |
@@ -30,24 +70,12 @@ The following table contains all possible installation types:
70 | custom | Anything not covered by the other identifiers, including manual builds, manually running netdata-installer.sh, and third-party packages (community). |
71 | Unknown | Same as custom. |
72
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:
73 +## Update Methods by Platform
74
35 -```bash
36 -wget -O /tmp/netdata-kickstart.sh https://get.netdata.cloud/kickstart.sh && sh /tmp/netdata-kickstart.sh --dry-run
37 -```
75 +<details>
76 +<summary><strong>UNIX</strong></summary><br/>
77
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 installation.
42 -
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 -
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 -
47 -## UNIX
48 -
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 installation options you specified.
78 +In most cases, you can update Netdata using our one-line kickstart script. This script will automatically run the update script installed as part of the initial install and preserve the existing installation options you specified.
79
80 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.
81
@@ -55,11 +83,21 @@ If you installed Netdata using an installation prefix, you will need to add an `
83 wget -O /tmp/netdata-kickstart.sh https://get.netdata.cloud/kickstart.sh && sh /tmp/netdata-kickstart.sh
84 ```
85
58 -## Windows
86 +<br/>
87 +</details>
88 +
89 +<details>
90 +<summary><strong>Windows</strong></summary><br/>
91
60 -To update Netdata, [download](/packaging/windows/WINDOWS_INSTALLER.md#download-the-msi-installer) the latest installer and reinstall the Agent.
92 +To update Netdata, [download](/packaging/windows/WINDOWS_INSTALLER.md#download-the-windows-installer-msi) the latest installer and reinstall the Agent.
93
62 -## macOS
94 +For automatic updates, see our [Windows automatic updates guide](https://learn.netdata.cloud/docs/netdata-agent/installation/windows#automatic-updates).
95 +
96 +<br/>
97 +</details>
98 +
99 +<details>
100 +<summary><strong>macOS</strong></summary><br/>
101
102 If you installed Netdata on your macOS system using Homebrew, you can explicitly request an update:
103
@@ -69,7 +107,11 @@ brew upgrade netdata
107
108 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.
109
72 -## Manual installation from Git
110 +<br/>
111 +</details>
112 +
113 +<details>
114 +<summary><strong>Manual installation from Git</strong></summary><br/>
115
116 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.
117
@@ -85,11 +127,18 @@ git pull origin master
127 sudo ./netdata-installer.sh
128 ```
129
88 -> **Note**
89 ->
90 -> 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.
130 +:::note
131 +
132 +**Optional Parameters**
133 +
134 +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.
135
92 -## Additional info
136 +:::
137 +
138 +<br/>
139 +</details>
140 +
141 +## Additional Configuration
142
143 ### Control runtime behavior of the updater script
144
@@ -97,8 +146,25 @@ Starting with v1.40.0, the `netdata-updater.sh` script supports a config file ca
146
147 This configuration file can be edited using our [`edit-config` script](/docs/netdata-agent/configuration/README.md).
148
100 -The following configuration options are currently supported:
149 +**Available Configuration Options:**
150 +
151 +| Option | Description | Default |
152 +|---------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|
153 +| `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. Most users shouldn't ever need to change this. | 3600 (one hour) |
154 +| `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. | 0 |
155 +| `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. | 0 |
156 +
157 +## Quick Reference
158 +
159 +### Update Commands by Installation Type
160
102 -- `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.
103 -- `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.
104 -- `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.
\ No newline at end of file
161 +| Installation Type | Update Method | Command |
162 +|----------------------------|------------------------|------------------------------------------------------------------------------------------------------------|
163 +| **binpkg-rpm/deb** | Kickstart script | `wget -O /tmp/netdata-kickstart.sh https://get.netdata.cloud/kickstart.sh && sh /tmp/netdata-kickstart.sh` |
164 +| **kickstart-build/static** | Kickstart script | `wget -O /tmp/netdata-kickstart.sh https://get.netdata.cloud/kickstart.sh && sh /tmp/netdata-kickstart.sh` |
165 +| **legacy-build/static** | Kickstart script | `wget -O /tmp/netdata-kickstart.sh https://get.netdata.cloud/kickstart.sh && sh /tmp/netdata-kickstart.sh` |
166 +| **manual-static-ARCH** | Kickstart script | `wget -O /tmp/netdata-kickstart.sh https://get.netdata.cloud/kickstart.sh && sh /tmp/netdata-kickstart.sh` |
167 +| **custom** | System package manager | Use your system's package manager |
168 +| **macOS (Homebrew)** | Homebrew | `brew upgrade netdata` |
169 +| **Manual Git** | Git + installer | See [manual installation steps](#update-methods-by-platform) |
170 +| **Windows** | MSI installer | Download and run latest installer |