summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAustin S. Hemmelgarn <austin@netdata.cloud>2023-09-05 06:25:01 -0400
committerGitHub <noreply@github.com>2023-09-05 13:25:01 +0300
commit3685fd774acdd96bf931d2cf4752ab8e23c62372 (patch)
tree73052d64edaf2123eebf222795dae6e23bafae0a
parent6efd6b7fe1737eaead41b5659c003bfe6f248774 (diff)
Properly document issues with installing on hosts without IPv4. (#15882)
* Properly document issues with installing on hosts without IPv4. * Update packaging/installer/README.md Co-authored-by: Dimitris P. <Dim-P@users.noreply.github.com>
-rw-r--r--packaging/installer/README.md21
-rw-r--r--packaging/installer/UPDATE.md6
2 files changed, 27 insertions, 0 deletions
diff --git a/packaging/installer/README.md b/packaging/installer/README.md
index 7f255be043..a99e869b81 100644
--- a/packaging/installer/README.md
+++ b/packaging/installer/README.md
@@ -202,6 +202,27 @@ _actively_ contributing to Netdata's future.
We are tracking a few issues related to installation and packaging.
+#### Installs on hosts without IPv4 connectivity
+
+Our regular installation process requires access to a number of GitHub services that do not have IPv6 connectivity. As
+such, using the kickstart install script on such hosts generally does not work, and will typically fail with an
+error from cURL or wget about connection timeouts. You can check if your system is affected by this by attempting
+to connect to (or ping) `https://api.github.com/`. Failing to connect indicates that you are affected by this issue.
+
+There are three potential workarounds for this:
+
+1. You can configure your system with a proper IPv6 transition mechanism, such as NAT64. GitHub’s anachronisms
+ affect many projects other than just Netdata, and there are unfortunately a number of other services out there
+ that do not provide IPv6 connectivity, so taking this route is likely to save you time in the future as well.
+2. If you are using a system that we publish native packages for (see our [platform support
+ policy](https://github.com/netdata/netdata/blob/master/packaging/PLATFORM_SUPPORT.md) for more details),
+ you can manually set up our native package repositories as outlined in our [native package install
+ documentation](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/packages.md). Our official
+ package repositories do provide service over IPv6, so they work without issue on hosts without IPv4 connectivity.
+3. If neither of the above options work for you, you can still install using our [offline installation
+ instructions](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/offline.md), though
+ do note that the offline install source must be prepared from a system with IPv4 connectivity.
+
#### Older distributions (Ubuntu 14.04, Debian 8, CentOS 6) and OpenSSL
If you're running an older Linux distribution or one that has reached EOL, such as Ubuntu 14.04 LTS, Debian 8, or CentOS
diff --git a/packaging/installer/UPDATE.md b/packaging/installer/UPDATE.md
index b1f779162c..f685ea3513 100644
--- a/packaging/installer/UPDATE.md
+++ b/packaging/installer/UPDATE.md
@@ -71,6 +71,12 @@ find the updater script.
On such installs, you can update Netdata using your distribution package manager.
+### Updates on hosts without IPv4 connectivity
+
+The update process outlined above suffers from the same issues that installing on hosts without IPv4
+connectivity does, and requires similar workarounds. For more details check [the explanation in our install
+documentation](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#installs-on-hosts-without-ipv4-connectivity).
+
### If the kickstart script does not work
If the above command fails, you can [reinstall