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>
Austin S. Hemmelgarn committed
Sep 5, 2023 at 06:25 UTC
3685fd774acdd96bf931d2cf4752ab8e23c62372
2 files changed
+27
packaging/installer/README.md
+21
@@ -202,6 +202,27 @@ _actively_ contributing to Netdata's future.
202
203
We are tracking a few issues related to installation and packaging.
204
205
+#### Installs on hosts without IPv4 connectivity
206
+
207
+Our regular installation process requires access to a number of GitHub services that do not have IPv6 connectivity. As
208
+such, using the kickstart install script on such hosts generally does not work, and will typically fail with an
209
+error from cURL or wget about connection timeouts. You can check if your system is affected by this by attempting
210
+to connect to (or ping) `https://api.github.com/`. Failing to connect indicates that you are affected by this issue.
211
+
212
+There are three potential workarounds for this:
213
+
214
+1. You can configure your system with a proper IPv6 transition mechanism, such as NAT64. GitHub’s anachronisms
215
+ affect many projects other than just Netdata, and there are unfortunately a number of other services out there
216
+ that do not provide IPv6 connectivity, so taking this route is likely to save you time in the future as well.
217
+2. If you are using a system that we publish native packages for (see our [platform support
218
+ policy](https://github.com/netdata/netdata/blob/master/packaging/PLATFORM_SUPPORT.md) for more details),
219
+ you can manually set up our native package repositories as outlined in our [native package install
220
+ documentation](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/packages.md). Our official
221
+ package repositories do provide service over IPv6, so they work without issue on hosts without IPv4 connectivity.
222
+3. If neither of the above options work for you, you can still install using our [offline installation
223
+ instructions](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/offline.md), though
224
+ do note that the offline install source must be prepared from a system with IPv4 connectivity.
225
+
226
#### Older distributions (Ubuntu 14.04, Debian 8, CentOS 6) and OpenSSL
227
228
If you're running an older Linux distribution or one that has reached EOL, such as Ubuntu 14.04 LTS, Debian 8, or CentOS
packaging/installer/UPDATE.md
+6
@@ -71,6 +71,12 @@ find the updater script.
71
72
On such installs, you can update Netdata using your distribution package manager.
73
74
+### Updates on hosts without IPv4 connectivity
75
+
76
+The update process outlined above suffers from the same issues that installing on hosts without IPv4
77
+connectivity does, and requires similar workarounds. For more details check [the explanation in our install
78
+documentation](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#installs-on-hosts-without-ipv4-connectivity).
79
+
80
### If the kickstart script does not work
81
82
If the above command fails, you can [reinstall