simplify installation page (#17759)
Co-authored-by: Ilya Mashchenko <ilya@netdata.cloud>
Fotis Voutsas committed
May 27, 2024 at 15:08 UTC
543d2b6096c4dd83362b22cc0d5ac05e8168d8b5
1 file changed
+17
-44
packaging/installer/README.md
+17
-44
@@ -1,44 +1,34 @@
1
-import { OneLineInstallWget, OneLineInstallCurl } from '@site/src/components/OneLineInstall/'
2
-import { InstallRegexLink, InstallBoxRegexLink } from '@site/src/components/InstallRegexLink/'
3
-import Tabs from '@theme/Tabs';
4
-import TabItem from '@theme/TabItem';
5
-
1
# Netdata Agent Installation
2
3
Netdata is very flexible and can be used to monitor all kinds of infrastructure. Read more about possible [Deployment guides](/docs/deployment-guides/README.md) to understand what better suites your needs.
4
5
## Install through Netdata Cloud
6
12
-Netdata is a free and open-source (FOSS) monitoring agent that collects thousands of hardware and software metrics from any physical or virtual system (we call them _nodes_). These metrics are organized in an easy-to-use and -navigate interface.
13
-
14
-Netdata runs permanently on all your physical/virtual servers, containers, cloud deployments, and edge/IoT devices.
15
-It runs on Linux distributions (Ubuntu, Debian, CentOS, and more), container/microservice platforms (Kubernetes clusters, Docker), and many other operating systems (FreeBSD, macOS), with no `sudo` required.
7
+The easiest way to install Netdata on your system is via Netdata Cloud, to do so:
8
17
-To install Netdata in minutes on your platform:
9
+1. Sign up to <https://app.netdata.cloud/>.
10
+2. You will be presented with an empty space, and a prompt to "Connect Nodes" with the install command for each platform.
11
+3. Select the platform you want to install Netdata to, copy and paste the script into your node's terminal, and run it.
12
19
-1. Sign up to <https://app.netdata.cloud/>
20
-2. You will be presented with an empty space, and a prompt to "Connect Nodes" with the install command for each platform
21
-3. Select the platform you want to install Netdata to, copy and paste the script into your node's terminal, and run it
13
+Once Netdata is installed, you can see the node live in your Netdata Space and charts in the [Metrics tab](/docs/dashboards-and-charts/metrics-tab-and-single-node-tabs.md).
14
23
-Upon installation completing successfully, you should be able to see the node live in your Netdata Space and live charts in the Overview tab. [Take a look at our Dashboards and Charts](/docs/dashboards-and-charts/README.md) section to read more about Netdata's features.
15
+Take a look at our [Dashboards and Charts](/docs/dashboards-and-charts/README.md) section to read more about Netdata's features.
16
25
-## Maintaining a Netdata Agent installation
17
+## Post-install
18
27
-For actions like starting, stopping, restarting, updating and uninstalling the Netdata Agent take a look at your specific installation platform in the current section of our Documentation.
28
-
29
-## Configuration
19
+### Configuration
20
21
If you are looking to configure your Netdata Agent installation, refer to the [respective section in our Documentation](/docs/netdata-agent/configuration/README.md).
22
33
-## Data collection
23
+### Data collection
24
35
-If Netdata didn't autodetect all the hardware, containers, services, or applications running on your node, you should learn more about [how data collectors work](/src/collectors/README.md). If there's a [supported collector](/src/collectors/COLLECTORS.md) for metrics you need, [configure the collector](/src/collectors/REFERENCE.md) or read about its requirements to configure your endpoint to publish metrics in the correct format and endpoint.
25
+If Netdata didn't autodetect all the hardware, containers, services, or applications running on your node, you should learn more about [how data collectors work](/src/collectors/README.md). If there's a [supported integration](/src/collectors/COLLECTORS.md) for metrics you need, refer to its respective page and read about its requirements to configure your endpoint to publish metrics in the correct format and endpoint.
26
37
-## Alerts & notifications
27
+### Alerts & notifications
28
29
Netdata comes with hundreds of pre-configured alerts, designed by our monitoring gurus in parallel with our open-source community, but you may want to [edit alerts](/src/health/REFERENCE.md) or [enable notifications](/docs/alerts-and-notifications/notifications/README.md) to customize your Netdata experience.
30
41
-## Make your deployment production ready
31
+### Make your deployment production ready
32
33
Go through our [deployment guides](/docs/deployment-guides/README.md), for suggested configuration changes for production deployments.
34
@@ -48,32 +38,16 @@ Go through our [deployment guides](/docs/deployment-guides/README.md), for sugge
38
39
By default, Netdata's installation scripts enable automatic updates for both nightly and stable release channels.
40
51
-If you preferred to update your Netdata agent manually, you can disable automatic updates by using the `--no-updates`
52
-option when you install or update Netdata using the [automatic one-line installation
53
-script](/packaging/installer/methods/kickstart.md).
41
+If you preferred to update your Netdata Agent manually, you can disable automatic updates by using the `--no-updates`
42
+option when you install or update Netdata using the [automatic one-line installation script](/packaging/installer/methods/kickstart.md).
43
44
```bash
45
wget -O /tmp/netdata-kickstart.sh https://get.netdata.cloud/kickstart.sh && sh /tmp/netdata-kickstart.sh --no-updates
46
```
47
59
-With automatic updates disabled, you can choose exactly when and how you [update
60
-Netdata](/packaging/installer/UPDATE.md).
61
-
62
-#### Network usage of Netdata’s automatic updater
63
-
64
-The auto-update functionality set up by the installation scripts requires working internet access to function
65
-correctly. In particular, it currently requires access to GitHub (to check if a newer version of the updater script
66
-is available or not, as well as potentially fetching build-time dependencies that are bundled as part of the install),
67
-and Google Cloud Storage (to check for newer versions of Netdata and download the sources if there is a newer version).
68
-
69
-Note that the auto-update functionality will check for updates to itself independently of updates to Netdata,
70
-and will try to use the latest version of the updater script whenever possible. This is intended to reduce the
71
-amount of effort required by users to get updates working again in the event of a bug in the updater code.
72
-
73
-### Nightly vs. stable releases
48
+With automatic updates disabled, you can choose exactly when and how you [update Netdata](/packaging/installer/UPDATE.md).
49
75
-The Netdata team maintains two releases of the Netdata agent: **nightly** and **stable**. By default, Netdata's
76
-installation scripts will give you **automatic, nightly** updates, as that is our recommended configuration.
50
+### Nightly vs. Stable Releases
51
52
**Nightly**: We create nightly builds every 24 hours. They contain fully-tested code that fixes bugs or security flaws,
53
or introduces new features to Netdata. Every nightly release is a candidate for then becoming a stable release—when
@@ -94,8 +68,7 @@ the community helps fix any bugs that might have been introduced in previous rel
68
69
**Pros of using stable releases:**
70
97
-- Protect yourself from the rare instance when major bugs slip through our testing and negatively affect a Netdata
98
- installation
71
+- Protect yourself from the rare instance when major bugs slip through our testing and negatively affect a Netdata installation
72
- Retain more control over the Netdata version you use
73
74
### Anonymous statistics