486ee8a1a3
* Replace existing kickstart scripts with kickstart-ng. This change looks more complicated than it actually is due to git not sanely recognizing the rename. * Fix CI for new kickstart script. * Initial revision of install documentation. * Further documentation updates. * Even more documentation updates. * Fix telemetry event handling if neither curl nor wget are installed. * Remove dependence on `pgrep` for claiming. * Fix fatal error message handling. * Formally outline our support policy. * Updates to platform support doc. * Platform support doc updates. * Minor documentation updates. * Remove accidentally commited file from rebase process. * Apply suggestions from code review, part 1. Co-authored-by: Tina Luedtke <kickoke@users.noreply.github.com> * Made one-line installer consistent. * Apply suggestions from code review, part 2. * Update architecture list for static builds. * Restructure platform support doc so that things are clearer. Especially for cases of linking directly to the section on a specific support category. * Apply suggestions from code review, part 3. Co-authored-by: Tina Luedtke <kickoke@users.noreply.github.com> * Apply suggestions from code review, part 4 Co-authored-by: Tina Luedtke <kickoke@users.noreply.github.com> * Further updates to platform support document. * Further documentation updates. * Rework update documentation. Co-authored-by: Tina Luedtke <kickoke@users.noreply.github.com>
5.7 KiB
Install Netdata on cloud providers
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 multiple instances in a parent-child streaming 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 with your process and instructions on using the provider's interface to complete the workaround.
Recommended installation methods for cloud providers
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.
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
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
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:
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 and click Create firewall rule.
The following configuration has previously worked for Netdata running on GCP instances (see #7786):
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 for specific instructions on how to create a new firewall rule.
Amazon Web Services (AWS) / EC2
Sign in to the AWS console 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 inbound rules.
Add a new rule with the following options:
Type: Custom TCP
Protocol: TCP
Port Range: 19999
Source: Anywhere
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 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:
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.