Update the Get started doc (#14336)
* update get-started.mdx * links should not break in two lines * links should not break in two lines * add a link format in the InstallBox elements that the ingest script can parse * change the install component to InstallRegexLink * Apply suggestions from code review Co-authored-by: Chris Akritidis <43294513+cakrit@users.noreply.github.com> * Changes from code review * Minor improvement on link CTAs --------- Co-authored-by: Chris Akritidis <43294513+cakrit@users.noreply.github.com>
Fotis Voutsas committed
Jan 30, 2023 at 19:03 UTC
3af2f511c8c8bfff3e322a973ca5a12d89ae5e9d
1 file changed
+61
-42
docs/get-started.mdx
+61
-42
@@ -1,4 +1,4 @@
1
----
1
+<!--
2
title: "Install Netdata"
3
description: "Download and install the open-source Netdata monitoring agent on physical/virtual servers, Linux (Ubuntu/Debian/CentOS/etc), Docker, Kubernetes, and many others, often with one command."
4
sidebar_label: "Install Netdata"
@@ -6,12 +6,12 @@ custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/get-starte
6
learn_status: "Published"
7
learn_topic_type: "Tasks"
8
learn_rel_path: "Getting started"
9
----
9
+-->
10
11
-import { OneLineInstallWget } from '@site/src/components/OneLineInstall/'
12
-import { Install, InstallBox } from '@site/src/components/Install/'
13
-
14
-# Get started with Netdata
11
+import { OneLineInstallWget, OneLineInstallCurl } from '@site/src/components/OneLineInstall/'
12
+import { InstallRegexLink, InstallBoxRegexLink } from '@site/src/components/InstallRegexLink/'
13
+import Tabs from '@theme/Tabs';
14
+import TabItem from '@theme/TabItem';
15
16
Netdata is a free and open-source (FOSS) monitoring agent that collects thousands of hardware and software metrics from
17
any physical or virtual system (we call them _nodes_). These metrics are organized in an easy-to-use and -navigate interface.
@@ -23,47 +23,74 @@ Netdata runs permanently on all your physical/virtual servers, containers, cloud
23
runs on Linux distributions (Ubuntu, Debian, CentOS, and more), container/microservice platforms (Kubernetes clusters,
24
Docker), and many other operating systems (FreeBSD, macOS), with no `sudo` required.
25
26
+To install Netdata in minutes on your platform:
27
+
28
+1. Sign up to https://app.netdata.cloud/
29
+2. You will be presented with an empty space, and a prompt to "Connect Nodes" with the install command for each platform
30
+3. Select the platform you want to install Netdata to, copy and paste the script into your node's terminal, and run it
31
+
32
+Upon installation completing successfully, you should be able to see the node live in your Netdata Space!
33
+
34
+Continue reading for more advanced instructions and installation options.
35
+
36
## Install on Linux with one-line installer
37
38
The **recommended** way to install Netdata on a Linux node (physical, virtual, container, IoT) is our one-line
29
-[kickstart script](/packaging/installer/methods/kickstart.md). This script automatically installs dependencies and
30
-builds Netdata from its source code.
39
+[kickstart script](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/kickstart.md).
40
+This script automatically installs dependencies and builds Netdata from its source code.
41
+
42
+To install, copy the script, paste it into your node's terminal, and hit `Enter` to begin the installation process.
43
32
-Copy the script, paste it into your node's terminal, and hit `Enter` to begin the installation process.
44
+ <Tabs>
45
+ <TabItem value="wget" label=<code>wget</code>>
46
34
-<OneLineInstallWget />
47
+ <OneLineInstallWget/>
48
+
49
+ </TabItem>
50
+ <TabItem value="curl" label=<code>curl</code>>
51
+
52
+ <OneLineInstallCurl/>
53
+
54
+ </TabItem>
55
+</Tabs>
56
+
57
+:::note
58
+If you plan to also Claim the node to Netdata Cloud,
59
+make sure to replace `YOUR_CLAIM_TOKEN` with the claim token of your space,
60
+and `YOUR_ROOM_ID` with the ID of the room you are willing to claim to.
61
+:::
62
63
Jump down to [what's next](#whats-next) to learn how to view your new dashboard and take your next steps monitoring and
64
troubleshooting with Netdata.
65
66
## Other installation options
67
41
-<Install>
42
- <InstallBox
43
- to="/docs/agent/packaging/docker"
68
+<InstallRegexLink>
69
+ <InstallBoxRegexLink
70
+ to="[](https://github.com/netdata/netdata/blob/master/packaging/docker/README.md)"
71
os="Run with Docker"
72
svg="docker" />
46
- <InstallBox
47
- to="/docs/agent/packaging/installer/methods/kubernetes"
73
+ <InstallBoxRegexLink
74
+ to="[](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/kubernetes.md)"
75
os="Deploy on Kubernetes"
76
svg="kubernetes" />
50
- <InstallBox
51
- to="/docs/agent/packaging/installer/methods/macos"
77
+ <InstallBoxRegexLink
78
+ to="[](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/macos.md)"
79
os="Install on macOS"
80
svg="macos" />
54
- <InstallBox
55
- to="/docs/agent/packaging/installer/methods/manual"
81
+ <InstallBoxRegexLink
82
+ to="[](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/manual.md)"
83
os="Linux from Git"
84
svg="linux" />
58
- <InstallBox
59
- to="/docs/agent/packaging/installer/methods/source"
85
+ <InstallBoxRegexLink
86
+ to="[](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/source.md)"
87
os="Linux from source"
88
svg="linux" />
62
- <InstallBox
63
- to="/docs/agent/packaging/installer/methods/offline"
89
+ <InstallBoxRegexLink
90
+ to="[](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/offline.md)"
91
os="Linux for offline nodes"
92
svg="linux" />
66
-</Install>
93
+</InstallRegexLink>
94
95
96
## What's next?
@@ -75,35 +102,27 @@ Where you go from here is based on your use case, immediate needs, and experienc
102
103
### Dashboard
104
78
-Learn more about [how the dashboard works](/docs/dashboard/how-dashboard-works.mdx), or dive directly into the many ways
79
-to [interact with charts](/docs/dashboard/interact-charts.mdx).
105
+Learn more about [how the dashboard works](https://github.com/netdata/netdata/blob/master/docs/dashboard/how-dashboard-works.mdx), or dive directly into the many ways
106
+to [interact with charts](https://github.com/netdata/netdata/blob/master/docs/dashboard/interact-charts.mdx).
107
108
### Configuration
109
83
-Discover the recommended way to [configure Netdata's settings or behavior](/docs/configure/nodes.md) using our built-in
84
-`edit-config` script, then apply that knowledge to mission-critical tweaks, such as [changing how long Netdata stores
85
-metrics](/docs/store/change-metrics-storage.md).
110
+Discover the recommended way to [configure Netdata's settings or behavior](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md) using our built-in
111
+`edit-config` script, then apply that knowledge to mission-critical tweaks, such as [changing how long Netdata stores metrics](https://github.com/netdata/netdata/blob/master/docs/store/change-metrics-storage.md).
112
113
### Data collection
114
115
If Netdata didn't autodetect all the hardware, containers, services, or applications running on your node, you should
90
-learn more about [how data collectors work](/docs/collect/how-collectors-work.md). If there's a [supported
91
-collector](/collectors/COLLECTORS.md) for metrics you need, [configure the collector](/docs/collect/enable-configure.md)
116
+learn more about [how data collectors work](https://github.com/netdata/netdata/blob/master/docs/collect/how-collectors-work.md).
117
+If there's a [supported collector](https://github.com/netdata/netdata/blob/master/collectors/COLLECTORS.md) for metrics you need, [configure the collector](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md)
118
or read about its requirements to configure your endpoint to publish metrics in the correct format and endpoint.
119
120
### Alarms & notifications
121
122
Netdata comes with hundreds of preconfigured alarms, designed by our monitoring gurus in parallel with our open-source
97
-community, but you may want to [edit alarms](/docs/monitor/configure-alarms.md) or [enable
98
-notifications](/docs/monitor/enable-notifications.md) to customize your Netdata experience.
99
-
100
-### Need to monitor multiple nodes in one place?
123
+community, but you may want to [edit alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) or
124
+[enable notifications](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md) to customize your Netdata experience.
125
102
-For robust multi-node monitoring from a single interface, consider [Netdata
103
-Cloud](https://learn.netdata.cloud/docs/cloud), which streams, aggregates, and visualizes metrics from any number of
104
-nodes. It's all the same out-of-the-box, zero-configuration functionality of the open-source monitoring agent, but for
105
-any number of distributed nodes, _entirely for free_.
126
+### Make your deployment production ready
127
107
-There is an alternative for those who aren't interested in using Netdata Cloud, albeit with some required configuration.
108
-Each node can [stream](/streaming/README.md) its metrics to any other node, and the default
109
-[registry](/registry/README.md) is configurable to create a private "network" of Netdata dashboards.
128
+Both [securing Netdata](https://github.com/netdata/netdata/blob/master/docs/configure/secure-nodes.md) and [setting up replication](https://github.com/netdata/netdata/blob/master/streaming/README.md) are strongly recommended.