Browse Source

Reorg learn 2102 1 (#14577)

* rm references overview

* Restructure installation methods

* Add systems.md
Chris Akritidis 2 years ago
parent
commit
75174359c5

+ 0 - 10
docs/category-overview-pages/references-overview.md

@@ -1,10 +0,0 @@
-<!--
-title: "References"
-sidebar_label: "References"
-custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/category-overview-pages/references-overview.md"
-learn_status: "Published"
-learn_rel_path: "References"
-sidebar_position: 70
--->
-
-In this category you will find reference documentation about Netdata's components and structural blocks.

+ 2 - 3
packaging/installer/methods/ansible.md

@@ -3,10 +3,9 @@ title: "Deploy Netdata with Ansible"
 description: "Deploy an infrastructure monitoring solution in minutes with the Netdata Agent and Ansible. Use and customize a simple playbook for monitoring as code."
 image: /img/seo/guides/deploy/ansible.png
 custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/ansible.md
-sidebar_label: "Install Netdata with Ansible"
+sidebar_label: "Ansible"
 learn_status: "Published"
-learn_topic_type: "Tasks"
-learn_rel_path: "Installation"
+learn_rel_path: "Installation/Install on specific environments"
 -->
 
 # Deploy Netdata with Ansible

+ 8 - 75
packaging/installer/methods/cloud-providers.md → packaging/installer/methods/aws.md

@@ -1,36 +1,19 @@
 <!--
-title: "Install Netdata on cloud providers"
+title: "Install Netdata on AWS"
 description: "The Netdata Agent runs on all popular cloud providers, but often requires additional steps and configuration for full functionality."
-custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/cloud-providers.md
-sidebar_label: "Install Netdata on cloud providers"
+custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/aws.md
+sidebar_label: "AWS"
 learn_status: "Published"
-learn_topic_type: "Tasks"
-learn_rel_path: "Installation"
+learn_rel_path: "Installation/Install on specific environments"
 -->
 
-# Install Netdata on cloud providers
+# Install Netdata on AWS
 
-Netdata is fully compatible with popular cloud providers like Google Cloud Platform (GCP), Amazon Web Services (AWS),
-Azure, and others. You can install Netdata on cloud instances to monitor the apps/services running there, or use
+Netdata is fully compatible with Amazon Web Services (AWS).
+You can install Netdata on cloud instances to monitor the apps/services running there, or use
 multiple instances in a [parent-child streaming](https://github.com/netdata/netdata/blob/master/streaming/README.md) configuration.
 
-In some cases, using Netdata on these cloud providers requires unique installation or configuration steps. This page
-aims to document some of those steps for popular cloud providers.
-
-> This document is a work-in-progress! If you find new issues specific to a cloud provider, or would like to help
-> clarify the correct workaround, please [create an
-> issue](https://github.com/netdata/netdata/issues/new?labels=feature+request,+needs+triage&template=feature_request)
-> with your process and instructions on using the provider's interface to complete the workaround.
-
-- [Install Netdata on cloud providers](#install-netdata-on-cloud-providers)
-  - [Recommended installation methods for cloud providers](#recommended-installation-methods-for-cloud-providers)
-  - [Post-installation configuration](#post-installation-configuration)
-    - [Add a firewall rule to access Netdata's dashboard](#add-a-firewall-rule-to-access-netdatas-dashboard)
-      - [Google Cloud Platform (GCP)](#google-cloud-platform-gcp)
-      - [Amazon Web Services (AWS) / EC2](#amazon-web-services-aws--ec2)
-      - [Azure](#azure)
-
-## Recommended installation methods for cloud providers
+## Recommended installation method
 
 The best installation method depends on the instance's operating system, distribution, and version. For Linux instances,
 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.
 
 ## Post-installation configuration
 
-Some cloud providers require you take additional steps to properly configure your instance or its networking to access
-all of Netdata's features.
-
 ### Add a firewall rule to access Netdata's dashboard
 
 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
 -   [HAProxy](https://github.com/netdata/netdata/blob/master/docs/Running-behind-haproxy.md)
 -   [lighttpd](https://github.com/netdata/netdata/blob/master/docs/Running-behind-lighttpd.md)
 
-The next few sections outline how to add firewall rules to GCP, AWS, and Azure instances.
-
-#### Google Cloud Platform (GCP)
-
-To add a firewall rule, go to the [Firewall rules page](https://console.cloud.google.com/networking/firewalls/list) and
-click **Create firewall rule**.
-
-The following configuration has previously worked for Netdata running on GCP instances
-([see #7786](https://github.com/netdata/netdata/issues/7786)):
-
-```conf
-Name: <name>
-Type: Ingress
-Targets: <name-tag>
-Filters: 0.0.0.0/0
-Protocols/ports: 19999
-Action: allow
-Priority: 1000
-```
-
-Read GCP's [firewall documentation](https://cloud.google.com/vpc/docs/using-firewalls) for specific instructions on how
-to create a new firewall rule.
-
-#### Amazon Web Services (AWS) / EC2
-
 Sign in to the [AWS console](https://console.aws.amazon.com/) and navigate to the EC2 dashboard. Click on the **Security
 Groups** link in the navigation, beneath the **Network & Security** heading. Find the Security Group your instance
 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
 You can also choose **My IP** as the source if you prefer.
 
 Click **Save** to apply your new inbound firewall rule.
-
-#### Azure
-
-Sign in to the [Azure portal](https://portal.azure.com) and open the virtual machine running Netdata. Click on the
-**Networking** link beneath the **Settings** header, then click on the **Add inbound security rule** button.
-
-Add a new rule with the following options:
-
-```conf
-Source: Any
-Source port ranges: 19999
-Destination: Any
-Destination port ranges: 19999
-Protocol: TCP
-Action: Allow
-Priority: 310
-Name: Netdata
-```
-
-Click **Add** to apply your new inbound security rule.
-
-

+ 68 - 0
packaging/installer/methods/azure.md

@@ -0,0 +1,68 @@
+<!--
+title: "Install Netdata on Azure"
+description: "The Netdata Agent runs on all popular cloud providers, but often requires additional steps and configuration for full functionality."
+custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/azure.md
+sidebar_label: "Azure"
+learn_status: "Published"
+learn_rel_path: "Installation/Install on specific environments"
+-->
+
+# Install Netdata on Azure
+
+Netdata is fully compatible with Azure. 
+You can install Netdata on cloud instances to monitor the apps/services running there, or use
+multiple instances in a [parent-child streaming](https://github.com/netdata/netdata/blob/master/streaming/README.md) configuration.
+
+## Recommended installation method
+
+The best installation method depends on the instance's operating system, distribution, and version. For Linux instances,
+we recommend the [`kickstart.sh` automatic installation script](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/kickstart.md).
+
+If you have issues with Netdata after installation, look to the sections below to find the issue you're experiencing,
+followed by the solution for your provider.
+
+## Post-installation configuration
+
+### Add a firewall rule to access Netdata's dashboard
+
+If you cannot access Netdata's dashboard on your cloud instance via `http://HOST:19999`, and instead get an error page
+from your browser that says, "This site can't be reached" (Chrome) or "Unable to connect" (Firefox), you may need to
+configure your cloud provider's firewall.
+
+Cloud providers often create network-level firewalls that run separately from the instance itself. Both AWS and Google
+Cloud Platform calls them Virtual Private Cloud (VPC) networks. These firewalls can apply even if you've disabled
+firewalls on the instance itself. Because you can modify these firewalls only via the cloud provider's web interface,
+it's easy to overlook them when trying to configure and access Netdata's dashboard.
+
+You can often confirm a firewall issue by querying the dashboard while connected to the instance via SSH: `curl
+http://localhost:19999/api/v1/info`. If you see JSON output, Netdata is running properly. If you try the same `curl`
+command from a remote system, and it fails, it's likely that a firewall is blocking your requests.
+
+Another option is to put Netdata behind web server, which will proxy requests through standard HTTP/HTTPS ports
+(80/443), which are likely already open on your instance. We have a number of guides available:
+
+-   [Apache](https://github.com/netdata/netdata/blob/master/docs/Running-behind-apache.md)
+-   [Nginx](https://github.com/netdata/netdata/blob/master/docs/Running-behind-nginx.md)
+-   [Caddy](https://github.com/netdata/netdata/blob/master/docs/Running-behind-caddy.md)
+-   [HAProxy](https://github.com/netdata/netdata/blob/master/docs/Running-behind-haproxy.md)
+-   [lighttpd](https://github.com/netdata/netdata/blob/master/docs/Running-behind-lighttpd.md)
+
+Sign in to the [Azure portal](https://portal.azure.com) and open the virtual machine running Netdata. Click on the
+**Networking** link beneath the **Settings** header, then click on the **Add inbound security rule** button.
+
+Add a new rule with the following options:
+
+```conf
+Source: Any
+Source port ranges: 19999
+Destination: Any
+Destination port ranges: 19999
+Protocol: TCP
+Action: Allow
+Priority: 310
+Name: Netdata
+```
+
+Click **Add** to apply your new inbound security rule.
+
+

+ 2 - 3
packaging/installer/methods/freebsd.md

@@ -2,10 +2,9 @@
 title: "Install Netdata on FreeBSD"
 description: "Install Netdata on FreeBSD to monitor the health and performance of bare metal or VMs with thousands of real-time, per-second metrics."
 custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/freebsd.md
-sidebar_label: "Install Netdata on FreeBSD"
+sidebar_label: "FreeBSD"
 learn_status: "Published"
-learn_topic_type: "Tasks"
-learn_rel_path: "Installation"
+learn_rel_path: "Installation/Install on specific environments"
 -->
 
 # Install Netdata on FreeBSD

+ 2 - 3
packaging/installer/methods/freenas.md

@@ -1,10 +1,9 @@
 <!--
 title: "Install Netdata on FreeNAS"
 custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/freenas.md
-sidebar_label: "Install Netdata on FreeNAS"
+sidebar_label: "FreeNAS"
 learn_status: "Published"
-learn_topic_type: "Tasks"
-learn_rel_path: "Installation"
+learn_rel_path: "Installation/Install on specific environments"
 -->
 
 # Install Netdata on FreeNAS

+ 70 - 0
packaging/installer/methods/gcp.md

@@ -0,0 +1,70 @@
+<!--
+title: "Install Netdata on GCP"
+description: "The Netdata Agent runs on all popular cloud providers, but often requires additional steps and configuration for full functionality."
+custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/gcp.md
+sidebar_label: "GCP"
+learn_status: "Published"
+learn_topic_type: "Tasks"
+learn_rel_path: "Installation/Install on specific environments"
+-->
+
+# Install Netdata on GCP
+
+Netdata is fully compatible with the Google Cloud Platform (GCP).
+You can install Netdata on cloud instances to monitor the apps/services running there, or use
+multiple instances in a [parent-child streaming](https://github.com/netdata/netdata/blob/master/streaming/README.md) configuration.
+
+## Recommended installation method
+
+The best installation method depends on the instance's operating system, distribution, and version. For Linux instances,
+we recommend the [`kickstart.sh` automatic installation script](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/kickstart.md).
+
+If you have issues with Netdata after installation, look to the sections below to find the issue you're experiencing,
+followed by the solution for your provider.
+
+## Post-installation configuration
+
+### Add a firewall rule to access Netdata's dashboard
+
+If you cannot access Netdata's dashboard on your cloud instance via `http://HOST:19999`, and instead get an error page
+from your browser that says, "This site can't be reached" (Chrome) or "Unable to connect" (Firefox), you may need to
+configure your cloud provider's firewall.
+
+Cloud providers often create network-level firewalls that run separately from the instance itself. Both AWS and Google
+Cloud Platform calls them Virtual Private Cloud (VPC) networks. These firewalls can apply even if you've disabled
+firewalls on the instance itself. Because you can modify these firewalls only via the cloud provider's web interface,
+it's easy to overlook them when trying to configure and access Netdata's dashboard.
+
+You can often confirm a firewall issue by querying the dashboard while connected to the instance via SSH: `curl
+http://localhost:19999/api/v1/info`. If you see JSON output, Netdata is running properly. If you try the same `curl`
+command from a remote system, and it fails, it's likely that a firewall is blocking your requests.
+
+Another option is to put Netdata behind web server, which will proxy requests through standard HTTP/HTTPS ports
+(80/443), which are likely already open on your instance. We have a number of guides available:
+
+-   [Apache](https://github.com/netdata/netdata/blob/master/docs/Running-behind-apache.md)
+-   [Nginx](https://github.com/netdata/netdata/blob/master/docs/Running-behind-nginx.md)
+-   [Caddy](https://github.com/netdata/netdata/blob/master/docs/Running-behind-caddy.md)
+-   [HAProxy](https://github.com/netdata/netdata/blob/master/docs/Running-behind-haproxy.md)
+-   [lighttpd](https://github.com/netdata/netdata/blob/master/docs/Running-behind-lighttpd.md)
+
+
+To add a firewall rule, go to the [Firewall rules page](https://console.cloud.google.com/networking/firewalls/list) and
+click **Create firewall rule**.
+
+The following configuration has previously worked for Netdata running on GCP instances
+([see #7786](https://github.com/netdata/netdata/issues/7786)):
+
+```conf
+Name: <name>
+Type: Ingress
+Targets: <name-tag>
+Filters: 0.0.0.0/0
+Protocols/ports: 19999
+Action: allow
+Priority: 1000
+```
+
+Read GCP's [firewall documentation](https://cloud.google.com/vpc/docs/using-firewalls) for specific instructions on how
+to create a new firewall rule.
+

+ 2 - 3
packaging/installer/methods/kickstart.md

@@ -2,10 +2,9 @@
 title: "Install Netdata with kickstart.sh"
 description: "The kickstart.sh script installs Netdata from source, including all dependencies required to connect to Netdata Cloud, with a single command."
 custom_edit_url: "https://github.com/netdata/netdata/edit/master/packaging/installer/methods/kickstart.md"
-sidebar_label: "Install Netdata with kickstart.sh"
+sidebar_label: "One line installer (kickstart.sh)"
 learn_status: "Published"
-learn_topic_type: "Tasks"
-learn_rel_path: "Installation"
+learn_rel_path: "Installation/Installation methods"
 sidebar_position: 10
 -->
 

+ 3 - 5
packaging/installer/methods/kubernetes.md

@@ -2,17 +2,15 @@
 title: "Install Netdata on Kubernetes"
 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."
 custom_edit_url: "https://github.com/netdata/netdata/edit/master/packaging/installer/methods/kubernetes.md"
-sidebar_label: "Install Netdata on Kubernetes"
+sidebar_label: "Kubernetes"
 learn_status: "Published"
-learn_topic_type: "Tasks"
-learn_rel_path: "Installation"
-sidebar_position: 60
+learn_rel_path: "Installation/Install on specific environments"
 -->
 
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 
-# Deploy Kubernetes monitoring with Netdata
+# Install Netdata on Kubernetes
 
 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.
 

+ 2 - 3
packaging/installer/methods/macos.md

@@ -1,10 +1,9 @@
 <!--
 title: "Install Netdata on macOS"
 custom_edit_url: "https://github.com/netdata/netdata/edit/master/packaging/installer/methods/macos.md"
-sidebar_label: "Install Netdata on macOS"
+sidebar_label: "macOS"
 learn_status: "Published"
-learn_topic_type: "Tasks"
-learn_rel_path: "Installation"
+learn_rel_path: "Installation/Install on specific environments"
 -->
 
 # Install Netdata on macOS

Some files were not shown because too many files changed in this diff