Reorg learn 2102 1 (#14577)
* rm references overview * Restructure installation methods * Add systems.md
Chris Akritidis committed
Feb 21, 2023 at 06:06 UTC
75174359c5af15f26eb17f2ff04145b1b6c0cde9
16 files changed
+212
-118
docs/category-overview-pages/references-overview.md
deleted
-10
@@ -1,10 +0,0 @@
1
-<!--
2
-title: "References"
3
-sidebar_label: "References"
4
-custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/category-overview-pages/references-overview.md"
5
-learn_status: "Published"
6
-learn_rel_path: "References"
7
-sidebar_position: 70
8
--->
9
-
10
-In this category you will find reference documentation about Netdata's components and structural blocks.
packaging/installer/methods/ansible.md
+2
-3
@@ -3,10 +3,9 @@ title: "Deploy Netdata with Ansible"
3
description: "Deploy an infrastructure monitoring solution in minutes with the Netdata Agent and Ansible. Use and customize a simple playbook for monitoring as code."
4
image: /img/seo/guides/deploy/ansible.png
5
custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/ansible.md
6
-sidebar_label: "Install Netdata with Ansible"
6
+sidebar_label: "Ansible"
7
learn_status: "Published"
8
-learn_topic_type: "Tasks"
9
-learn_rel_path: "Installation"
8
+learn_rel_path: "Installation/Install on specific environments"
9
-->
10
11
# Deploy Netdata with Ansible
packaging/installer/methods/aws.md
renamed
+8
-75
@@ -1,36 +1,19 @@
1
<!--
2
-title: "Install Netdata on cloud providers"
2
+title: "Install Netdata on AWS"
3
description: "The Netdata Agent runs on all popular cloud providers, but often requires additional steps and configuration for full functionality."
4
-custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/cloud-providers.md
5
-sidebar_label: "Install Netdata on cloud providers"
4
+custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/aws.md
5
+sidebar_label: "AWS"
6
learn_status: "Published"
7
-learn_topic_type: "Tasks"
8
-learn_rel_path: "Installation"
7
+learn_rel_path: "Installation/Install on specific environments"
8
-->
9
11
-# Install Netdata on cloud providers
10
+# Install Netdata on AWS
11
13
-Netdata is fully compatible with popular cloud providers like Google Cloud Platform (GCP), Amazon Web Services (AWS),
14
-Azure, and others. You can install Netdata on cloud instances to monitor the apps/services running there, or use
12
+Netdata is fully compatible with Amazon Web Services (AWS).
13
+You can install Netdata on cloud instances to monitor the apps/services running there, or use
14
multiple instances in a [parent-child streaming](https://github.com/netdata/netdata/blob/master/streaming/README.md) configuration.
15
17
-In some cases, using Netdata on these cloud providers requires unique installation or configuration steps. This page
18
-aims to document some of those steps for popular cloud providers.
19
-
20
-> This document is a work-in-progress! If you find new issues specific to a cloud provider, or would like to help
21
-> clarify the correct workaround, please [create an
22
-> issue](https://github.com/netdata/netdata/issues/new?labels=feature+request,+needs+triage&template=feature_request)
23
-> with your process and instructions on using the provider's interface to complete the workaround.
24
-
25
-- [Install Netdata on cloud providers](#install-netdata-on-cloud-providers)
26
- - [Recommended installation methods for cloud providers](#recommended-installation-methods-for-cloud-providers)
27
- - [Post-installation configuration](#post-installation-configuration)
28
- - [Add a firewall rule to access Netdata's dashboard](#add-a-firewall-rule-to-access-netdatas-dashboard)
29
- - [Google Cloud Platform (GCP)](#google-cloud-platform-gcp)
30
- - [Amazon Web Services (AWS) / EC2](#amazon-web-services-aws--ec2)
31
- - [Azure](#azure)
32
-
33
-## Recommended installation methods for cloud providers
16
+## Recommended installation method
17
18
The best installation method depends on the instance's operating system, distribution, and version. For Linux instances,
19
we recommend the [`kickstart.sh` automatic installation script](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/kickstart.md).
@@ -40,9 +23,6 @@ followed by the solution for your provider.
23
24
## Post-installation configuration
25
43
-Some cloud providers require you take additional steps to properly configure your instance or its networking to access
44
-all of Netdata's features.
45
-
26
### Add a firewall rule to access Netdata's dashboard
27
28
If you cannot access Netdata's dashboard on your cloud instance via `http://HOST:19999`, and instead get an error page
@@ -67,31 +47,6 @@ Another option is to put Netdata behind web server, which will proxy requests th
47
- [HAProxy](https://github.com/netdata/netdata/blob/master/docs/Running-behind-haproxy.md)
48
- [lighttpd](https://github.com/netdata/netdata/blob/master/docs/Running-behind-lighttpd.md)
49
70
-The next few sections outline how to add firewall rules to GCP, AWS, and Azure instances.
71
-
72
-#### Google Cloud Platform (GCP)
73
-
74
-To add a firewall rule, go to the [Firewall rules page](https://console.cloud.google.com/networking/firewalls/list) and
75
-click **Create firewall rule**.
76
-
77
-The following configuration has previously worked for Netdata running on GCP instances
78
-([see #7786](https://github.com/netdata/netdata/issues/7786)):
79
-
80
-```conf
81
-Name: <name>
82
-Type: Ingress
83
-Targets: <name-tag>
84
-Filters: 0.0.0.0/0
85
-Protocols/ports: 19999
86
-Action: allow
87
-Priority: 1000
88
-```
89
-
90
-Read GCP's [firewall documentation](https://cloud.google.com/vpc/docs/using-firewalls) for specific instructions on how
91
-to create a new firewall rule.
92
-
93
-#### Amazon Web Services (AWS) / EC2
94
-
50
Sign in to the [AWS console](https://console.aws.amazon.com/) and navigate to the EC2 dashboard. Click on the **Security
51
Groups** link in the navigation, beneath the **Network & Security** heading. Find the Security Group your instance
52
belongs to, and either right-click on it or click the **Actions** button above to see a dropdown menu with **Edit
@@ -110,25 +65,3 @@ Description: Netdata
65
You can also choose **My IP** as the source if you prefer.
66
67
Click **Save** to apply your new inbound firewall rule.
113
-
114
-#### Azure
115
-
116
-Sign in to the [Azure portal](https://portal.azure.com) and open the virtual machine running Netdata. Click on the
117
-**Networking** link beneath the **Settings** header, then click on the **Add inbound security rule** button.
118
-
119
-Add a new rule with the following options:
120
-
121
-```conf
122
-Source: Any
123
-Source port ranges: 19999
124
-Destination: Any
125
-Destination port ranges: 19999
126
-Protocol: TCP
127
-Action: Allow
128
-Priority: 310
129
-Name: Netdata
130
-```
131
-
132
-Click **Add** to apply your new inbound security rule.
133
-
134
-
packaging/installer/methods/azure.md
new
+68
@@ -0,0 +1,68 @@
1
+<!--
2
+title: "Install Netdata on Azure"
3
+description: "The Netdata Agent runs on all popular cloud providers, but often requires additional steps and configuration for full functionality."
4
+custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/azure.md
5
+sidebar_label: "Azure"
6
+learn_status: "Published"
7
+learn_rel_path: "Installation/Install on specific environments"
8
+-->
9
+
10
+# Install Netdata on Azure
11
+
12
+Netdata is fully compatible with Azure.
13
+You can install Netdata on cloud instances to monitor the apps/services running there, or use
14
+multiple instances in a [parent-child streaming](https://github.com/netdata/netdata/blob/master/streaming/README.md) configuration.
15
+
16
+## Recommended installation method
17
+
18
+The best installation method depends on the instance's operating system, distribution, and version. For Linux instances,
19
+we recommend the [`kickstart.sh` automatic installation script](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/kickstart.md).
20
+
21
+If you have issues with Netdata after installation, look to the sections below to find the issue you're experiencing,
22
+followed by the solution for your provider.
23
+
24
+## Post-installation configuration
25
+
26
+### Add a firewall rule to access Netdata's dashboard
27
+
28
+If you cannot access Netdata's dashboard on your cloud instance via `http://HOST:19999`, and instead get an error page
29
+from your browser that says, "This site can't be reached" (Chrome) or "Unable to connect" (Firefox), you may need to
30
+configure your cloud provider's firewall.
31
+
32
+Cloud providers often create network-level firewalls that run separately from the instance itself. Both AWS and Google
33
+Cloud Platform calls them Virtual Private Cloud (VPC) networks. These firewalls can apply even if you've disabled
34
+firewalls on the instance itself. Because you can modify these firewalls only via the cloud provider's web interface,
35
+it's easy to overlook them when trying to configure and access Netdata's dashboard.
36
+
37
+You can often confirm a firewall issue by querying the dashboard while connected to the instance via SSH: `curl
38
+http://localhost:19999/api/v1/info`. If you see JSON output, Netdata is running properly. If you try the same `curl`
39
+command from a remote system, and it fails, it's likely that a firewall is blocking your requests.
40
+
41
+Another option is to put Netdata behind web server, which will proxy requests through standard HTTP/HTTPS ports
42
+(80/443), which are likely already open on your instance. We have a number of guides available:
43
+
44
+- [Apache](https://github.com/netdata/netdata/blob/master/docs/Running-behind-apache.md)
45
+- [Nginx](https://github.com/netdata/netdata/blob/master/docs/Running-behind-nginx.md)
46
+- [Caddy](https://github.com/netdata/netdata/blob/master/docs/Running-behind-caddy.md)
47
+- [HAProxy](https://github.com/netdata/netdata/blob/master/docs/Running-behind-haproxy.md)
48
+- [lighttpd](https://github.com/netdata/netdata/blob/master/docs/Running-behind-lighttpd.md)
49
+
50
+Sign in to the [Azure portal](https://portal.azure.com) and open the virtual machine running Netdata. Click on the
51
+**Networking** link beneath the **Settings** header, then click on the **Add inbound security rule** button.
52
+
53
+Add a new rule with the following options:
54
+
55
+```conf
56
+Source: Any
57
+Source port ranges: 19999
58
+Destination: Any
59
+Destination port ranges: 19999
60
+Protocol: TCP
61
+Action: Allow
62
+Priority: 310
63
+Name: Netdata
64
+```
65
+
66
+Click **Add** to apply your new inbound security rule.
67
+
68
+
packaging/installer/methods/freebsd.md
+2
-3
@@ -2,10 +2,9 @@
2
title: "Install Netdata on FreeBSD"
3
description: "Install Netdata on FreeBSD to monitor the health and performance of bare metal or VMs with thousands of real-time, per-second metrics."
4
custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/freebsd.md
5
-sidebar_label: "Install Netdata on FreeBSD"
5
+sidebar_label: "FreeBSD"
6
learn_status: "Published"
7
-learn_topic_type: "Tasks"
8
-learn_rel_path: "Installation"
7
+learn_rel_path: "Installation/Install on specific environments"
8
-->
9
10
# Install Netdata on FreeBSD
packaging/installer/methods/freenas.md
+2
-3
@@ -1,10 +1,9 @@
1
<!--
2
title: "Install Netdata on FreeNAS"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/freenas.md
4
-sidebar_label: "Install Netdata on FreeNAS"
4
+sidebar_label: "FreeNAS"
5
learn_status: "Published"
6
-learn_topic_type: "Tasks"
7
-learn_rel_path: "Installation"
6
+learn_rel_path: "Installation/Install on specific environments"
7
-->
8
9
# Install Netdata on FreeNAS
packaging/installer/methods/gcp.md
new
+70
@@ -0,0 +1,70 @@
1
+<!--
2
+title: "Install Netdata on GCP"
3
+description: "The Netdata Agent runs on all popular cloud providers, but often requires additional steps and configuration for full functionality."
4
+custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/gcp.md
5
+sidebar_label: "GCP"
6
+learn_status: "Published"
7
+learn_topic_type: "Tasks"
8
+learn_rel_path: "Installation/Install on specific environments"
9
+-->
10
+
11
+# Install Netdata on GCP
12
+
13
+Netdata is fully compatible with the Google Cloud Platform (GCP).
14
+You can install Netdata on cloud instances to monitor the apps/services running there, or use
15
+multiple instances in a [parent-child streaming](https://github.com/netdata/netdata/blob/master/streaming/README.md) configuration.
16
+
17
+## Recommended installation method
18
+
19
+The best installation method depends on the instance's operating system, distribution, and version. For Linux instances,
20
+we recommend the [`kickstart.sh` automatic installation script](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/kickstart.md).
21
+
22
+If you have issues with Netdata after installation, look to the sections below to find the issue you're experiencing,
23
+followed by the solution for your provider.
24
+
25
+## Post-installation configuration
26
+
27
+### Add a firewall rule to access Netdata's dashboard
28
+
29
+If you cannot access Netdata's dashboard on your cloud instance via `http://HOST:19999`, and instead get an error page
30
+from your browser that says, "This site can't be reached" (Chrome) or "Unable to connect" (Firefox), you may need to
31
+configure your cloud provider's firewall.
32
+
33
+Cloud providers often create network-level firewalls that run separately from the instance itself. Both AWS and Google
34
+Cloud Platform calls them Virtual Private Cloud (VPC) networks. These firewalls can apply even if you've disabled
35
+firewalls on the instance itself. Because you can modify these firewalls only via the cloud provider's web interface,
36
+it's easy to overlook them when trying to configure and access Netdata's dashboard.
37
+
38
+You can often confirm a firewall issue by querying the dashboard while connected to the instance via SSH: `curl
39
+http://localhost:19999/api/v1/info`. If you see JSON output, Netdata is running properly. If you try the same `curl`
40
+command from a remote system, and it fails, it's likely that a firewall is blocking your requests.
41
+
42
+Another option is to put Netdata behind web server, which will proxy requests through standard HTTP/HTTPS ports
43
+(80/443), which are likely already open on your instance. We have a number of guides available:
44
+
45
+- [Apache](https://github.com/netdata/netdata/blob/master/docs/Running-behind-apache.md)
46
+- [Nginx](https://github.com/netdata/netdata/blob/master/docs/Running-behind-nginx.md)
47
+- [Caddy](https://github.com/netdata/netdata/blob/master/docs/Running-behind-caddy.md)
48
+- [HAProxy](https://github.com/netdata/netdata/blob/master/docs/Running-behind-haproxy.md)
49
+- [lighttpd](https://github.com/netdata/netdata/blob/master/docs/Running-behind-lighttpd.md)
50
+
51
+
52
+To add a firewall rule, go to the [Firewall rules page](https://console.cloud.google.com/networking/firewalls/list) and
53
+click **Create firewall rule**.
54
+
55
+The following configuration has previously worked for Netdata running on GCP instances
56
+([see #7786](https://github.com/netdata/netdata/issues/7786)):
57
+
58
+```conf
59
+Name: <name>
60
+Type: Ingress
61
+Targets: <name-tag>
62
+Filters: 0.0.0.0/0
63
+Protocols/ports: 19999
64
+Action: allow
65
+Priority: 1000
66
+```
67
+
68
+Read GCP's [firewall documentation](https://cloud.google.com/vpc/docs/using-firewalls) for specific instructions on how
69
+to create a new firewall rule.
70
+
packaging/installer/methods/kickstart.md
+2
-3
@@ -2,10 +2,9 @@
2
title: "Install Netdata with kickstart.sh"
3
description: "The kickstart.sh script installs Netdata from source, including all dependencies required to connect to Netdata Cloud, with a single command."
4
custom_edit_url: "https://github.com/netdata/netdata/edit/master/packaging/installer/methods/kickstart.md"
5
-sidebar_label: "Install Netdata with kickstart.sh"
5
+sidebar_label: "One line installer (kickstart.sh)"
6
learn_status: "Published"
7
-learn_topic_type: "Tasks"
8
-learn_rel_path: "Installation"
7
+learn_rel_path: "Installation/Installation methods"
8
sidebar_position: 10
9
-->
10
packaging/installer/methods/kubernetes.md
+3
-5
@@ -2,17 +2,15 @@
2
title: "Install Netdata on Kubernetes"
3
description: "Deploy Netdata to monitor a Kubernetes cluster to monitor the health, performance, resource utilization, and application metrics of a Kubernetes cluster in real time."
4
custom_edit_url: "https://github.com/netdata/netdata/edit/master/packaging/installer/methods/kubernetes.md"
5
-sidebar_label: "Install Netdata on Kubernetes"
5
+sidebar_label: "Kubernetes"
6
learn_status: "Published"
7
-learn_topic_type: "Tasks"
8
-learn_rel_path: "Installation"
9
-sidebar_position: 60
7
+learn_rel_path: "Installation/Install on specific environments"
8
-->
9
10
import Tabs from '@theme/Tabs';
11
import TabItem from '@theme/TabItem';
12
15
-# Deploy Kubernetes monitoring with Netdata
13
+# Install Netdata on Kubernetes
14
15
This document details how to install Netdata on an existing Kubernetes (k8s) cluster, and connect it to Netdata Cloud. Read our [Kubernetes visualizations](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/kubernetes.md) documentation, to see what you will get.
16
packaging/installer/methods/macos.md
+2
-3
@@ -1,10 +1,9 @@
1
<!--
2
title: "Install Netdata on macOS"
3
custom_edit_url: "https://github.com/netdata/netdata/edit/master/packaging/installer/methods/macos.md"
4
-sidebar_label: "Install Netdata on macOS"
4
+sidebar_label: "macOS"
5
learn_status: "Published"
6
-learn_topic_type: "Tasks"
7
-learn_rel_path: "Installation"
6
+learn_rel_path: "Installation/Install on specific environments"
7
-->
8
9
# Install Netdata on macOS
packaging/installer/methods/methods.md
new
+25
@@ -0,0 +1,25 @@
1
+<!--
2
+title: "Installation methods"
3
+description: "Netdata can be installed as a DEB/RPM package, a static binary, a docker container or from source"
4
+custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/methods.md
5
+sidebar_label: "Installation methods"
6
+learn_status: "Published"
7
+learn_rel_path: "Installation/Installation methods"
8
+-->
9
+
10
+# Installation methods
11
+
12
+Netdata can be installed:
13
+
14
+- [As a DEB/RPM package](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/packages.md)
15
+- [As a static binary](https://github.com/netdata/netdata/blob/master/packaging/makeself/README.md)
16
+- [From source](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/source.md)
17
+- [As a docker container](https://github.com/netdata/netdata/blob/master/packaging/docker/README.md)
18
+
19
+The [one line installer kickstart.sh](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/kickstart.md)
20
+picks the most appropriate method out of the first three for any system
21
+and is the recommended installation method, if you don't use containers.
22
+
23
+`kickstart.sh` can also be used for
24
+[offline installation](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/offline.md),
25
+suitable for air-gapped systems.
packaging/installer/methods/offline.md
+4
-4
@@ -2,15 +2,15 @@
2
title: "Install Netdata on offline systems"
3
description: "Install the Netdata Agent on offline/air gapped systems to benefit from real-time, per-second monitoring without connecting to the internet."
4
custom_edit_url: "https://github.com/netdata/netdata/edit/master/packaging/installer/methods/offline.md"
5
-sidebar_label: "Install Netdata on offline systems"
5
+sidebar_label: "Offline systems"
6
learn_status: "Published"
7
-learn_topic_type: "Tasks"
8
-learn_rel_path: "Installation"
7
+learn_rel_path: "Installation/Installation methods"
8
+sidebar_position: 50
9
-->
10
11
# Install Netdata on offline systems
12
13
-Our kickstart install script provides support for installing the Netdata Agent on systems which do not have a
13
+Our kickstart install script provides support for installing the Netdata Agent on air-gapped systems which do not have a
14
usable internet connection by prefetching all of the required files so that they can be copied to the target system.
15
Currently, we only support using static installs with this method. There are tentative plans to support building
16
locally on offline systems as well, but there is currently no estimate of when this functionality may be implemented.
packaging/installer/methods/packages.md
+2
-3
@@ -2,10 +2,9 @@
2
title: "Install Netdata using native DEB/RPM packages."
3
description: "Instructions for how to install Netdata using native DEB or RPM packages."
4
custom_edit_url: "https://github.com/netdata/netdata/edit/master/packaging/installer/methods/packages.md"
5
-sidebar_label: "Install Netdata using native DEB/RPM packages."
5
+sidebar_label: "Native DEB/RPM packages"
6
learn_status: "Published"
7
-learn_topic_type: "Tasks"
8
-learn_rel_path: "Installation"
7
+learn_rel_path: "Installation/Installation methods"
8
sidebar_position: 20
9
-->
10
packaging/installer/methods/pfsense.md
+2
-3
@@ -2,10 +2,9 @@
2
title: "Install Netdata on pfSense"
3
description: "Install Netdata on pfSense to monitor the health and performance of firewalls with thousands of real-time, per-second metrics."
4
custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/pfsense.md
5
-sidebar_label: "Install Netdata on pfSense"
5
+sidebar_label: "pfSense"
6
learn_status: "Published"
7
-learn_topic_type: "Tasks"
8
-learn_rel_path: "Installation"
7
+learn_rel_path: "Installation/Install on specific environments"
8
-->
9
10
# Install Netdata on pfSense
packaging/installer/methods/synology.md
+2
-3
@@ -2,10 +2,9 @@
2
title: "Install Netdata on Synology"
3
description: "The Netdata Agent can be installed on AMD64-compatible NAS systems using the 64-bit pre-compiled static binary."
4
custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/synology.md
5
-sidebar_label: "Install Netdata on Synology"
5
+sidebar_label: "Synology"
6
learn_status: "Published"
7
-learn_topic_type: "Tasks"
8
-learn_rel_path: "Installation"
7
+learn_rel_path: "Installation/Install on specific environments"
8
-->
9
10
# Install Netdata on Synology
packaging/installer/methods/systems.md
new
+18
@@ -0,0 +1,18 @@
1
+<!--
2
+title: "Install on specific environments"
3
+description: "Netdata can be installed as a DEB/RPM package, a static binary, a docker container or from source"
4
+custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/systems.md
5
+sidebar_label: "Install on specific environments"
6
+learn_status: "Published"
7
+learn_rel_path: "Installation/Install on specific environments"
8
+-->
9
+
10
+# Install on specific environments
11
+
12
+This category contains specific instructions for some popular environments.
13
+If you have a standard environment that is not yet listed here, just use the
14
+[one line installer kickstart.sh](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/kickstart.md)
15
+
16
+If your environment is somewhat old or unusual, check our
17
+[platform support policy](https://github.com/netdata/netdata/blob/master/packaging/PLATFORM_SUPPORT.md).
18
+