summaryrefslogtreecommitdiffstats
path: root/docs/get
diff options
context:
space:
mode:
authorJoel Hans <joel@netdata.cloud>2020-10-01 07:49:39 -0700
committerGitHub <noreply@github.com>2020-10-01 07:49:39 -0700
commit82ccdfd45eccf420ab11f4ffbdaf4eb3565c9f31 (patch)
treedca0121966c21927ecc25be3f8b92be810c416ca /docs/get
parentb9bc990af36ce8917fc037f681d0b1987b78eb81 (diff)
Clean up and better cross-link new docsv2 documents (#10015)
* Finish cleanup pass * Fixes for Amy
Diffstat (limited to 'docs/get')
-rw-r--r--docs/get/README.md39
1 files changed, 24 insertions, 15 deletions
diff --git a/docs/get/README.md b/docs/get/README.md
index 69a0b00089..bd2580dba3 100644
--- a/docs/get/README.md
+++ b/docs/get/README.md
@@ -9,10 +9,10 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/get/README.
import { OneLineInstall } from '../src/components/OneLineInstall/'
import { Install, InstallBox } from '../src/components/InstallBox/'
-Netdata uses an open-source monitoring Agent and web application [together](/docs/overview/what-is-netdata.md) to help
-you collect every metric, visualize the health of your systems, and troubleshoot complex performance problems. Once
-you've signed in to Netdata Cloud and installed the Netdata Agent on all your nodes, you can claim these nodes and see
-their real-time metrics on a single interface.
+Netdata uses the open-source Netdata Agent and Netdata Cloud web application
+[together](/docs/overview/what-is-netdata.md) to help you collect every metric, visualize the health of your nodes, and
+troubleshoot complex performance problems. Once you've signed in to Netdata Cloud and installed the Netdata Agent on all
+your nodes, you can claim your nodes and see their real-time metrics on a single interface.
## Sign in to Netdata Cloud
@@ -28,7 +28,7 @@ devices. It runs on Linux distributions (**Ubuntu**, **Debian**, **CentOS**, and
required.
> ⚠️ Many distributions ship with third-party packages of Netdata, which we cannot maintain or keep up-to-date. For the
-> best experience, use one of the methods described or link to below.
+> best experience, use one of the methods described or linked to below.
The **recommended** way to install the Netdata Agent on a Linux system is our one-line [kickstart
script](/packaging/installer/methods/kickstart.md). This script automatically installs dependencies and builds Netdata
@@ -62,18 +62,22 @@ platform to see specific instructions.
<InstallBox
to="/docs/agent/packaging/installer/methods/cloud-providers"
img="/img/index/methods/cloud.svg"
+ imgDark="/img/index/methods/cloud-dark.svg"
os="Cloud providers (GCP, AWS, Azure)" />
<InstallBox
to="/docs/agent/packaging/installer/methods/packages"
img="/img/index/methods/package.svg"
+ imgDark="/img/index/methods/package-dark.svg"
os="Linux with .deb/.rpm" />
<InstallBox
to="/docs/agent/packaging/installer/methods/kickstart-64"
img="/img/index/methods/static.svg"
+ imgDark="/img/index/methods/static-dark.svg"
os="Linux with static 64-bit binary" />
<InstallBox
to="/docs/agent/packaging/installer/methods/manual"
img="/img/index/methods/git.svg"
+ imgDark="/img/index/methods/git-dark.svg"
os="Linux from Git" />
<InstallBox
to="/docs/agent/packaging/installer/methods/freebsd"
@@ -94,33 +98,38 @@ connection to Netdata Cloud using the [Agent-Cloud link](/aclk/README.md), and p
access to that node.
When you view a node in Netdata Cloud, the Agent running on that node streams metrics, metadata, and alarm status to
-Netdata Cloud, which in turn streams those metrics to your web browser. Netdata Cloud does not store or log metrics or
-alarm status.
+Netdata Cloud, which in turn streams those metrics to your web browser. Netdata Cloud [does not
+store](/docs/store/distributed-data-architecture.md#does-netdata-cloud-store-my-metrics) or log metrics values.
To claim a node, you need to run the claiming script. In Netdata Cloud, click on your Space's name, then **Manage your
Space** in the dropdown. Click **Nodes** in the panel that appears. Copy the script and run it in your node's terminal.
-For example:
+The script looks like the following, with long strings instead of `TOKEN` and `ROOM1,ROOM2`:
```bash
sudo netdata-claim.sh -token=TOKEN -rooms=ROOM1,ROOM2 -url=https://app.netdata.cloud
```
-The script should return `Agent was successfully claimed.` after creating a new RSA pair and establishing the link to
-Netdata Cloud.
+The script returns `Agent was successfully claimed.` after creating a new RSA pair and establishing the link to Netdata
+Cloud. If the script returns an error, try our [troubleshooting tips](/claim/README.md#troubleshooting).
-For more information on the claiming process, why we implemented it, and how it works, see the [claim](/claim/README.md)
-and [Agent-Cloud link](/aclk/README.md) reference docs.
+> 💡 Our claiming reference guide also contains instructions for claiming [Docker
+> containers](/claim/README.md#claim-an-agent-running-in-docker), [Kubernetes cluster parent
+> pods](/claim/README.md#claim-an-agent-running-in-docker), via a [proxy](/claim/README.md#claim-through-a-proxy), and
+> more.
<details>
<summary>Watch how claiming nodes works</summary>
<iframe width="820" height="460" src="https://www.youtube.com/embed/UAzVvhMab8g" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</details>
+For more information on the claiming process, why we implemented it, and how it works, see the [claim](/claim/README.md)
+and [Agent-Cloud link](/aclk/README.md) reference docs.
+
## What's next?
-At this point, you have set up your free Netdata Cloud account, installed the Agent, and claimed one or more nodes to
-your Space. You're ready to start monitoring, visualizing, and troubleshooting with Netdata. We have two quickstart
-guides based on the scope of what you need to monitor:
+At this point, you have set up your free Netdata Cloud account, installed the Netdata Agent on your node(s), and claimed
+one or more nodes to your Space. You're ready to start monitoring, visualizing, and troubleshooting with Netdata. We
+have two quickstart guides based on the scope of what you need to monitor.
Interested in monitoring a single node? Check out our [single-node monitoring
quickstart](/docs/quickstart/single-node.md).