diff --git a/docs/platform/network-helper-new-manager/index.md b/docs/platform/network-helper-new-manager/index.md new file mode 100644 index 00000000000..de3a2a2ab7c --- /dev/null +++ b/docs/platform/network-helper-new-manager/index.md @@ -0,0 +1,173 @@ +--- +author: + name: Linode + email: docs@linode.com +description: 'What is Network Helper and how to use it.' +keywords: ["network helper", "static"] +license: '[CC BY-ND 4.0](https://creativecommons.org/licenses/by-nd/4.0)' +modified: 2019-01-07 +published: 2014-12-08 +modified_by: + name: Linode +title: Network Helper +hiddenguide: true +--- + +![Network Helper](network-helper-title-graphic.jpg "Network Helper") + +## What is Network Helper? + +Network Helper is a host-side service which automatically sets a static IPv4 address and gateway for your Linode. This means you do not need to manually reconfigure your Linode's network addressing when you: + + - Deploy a Linode + - Add a public or private IPv4 address + - Restore from a backup + - Migrate your Linode to a new data center + - Clone from another Linode + +Network Helper is enabled by default, and works by detecting which distribution is booting and then modifying the appropriate network configuration files. If Network Helper is unable to determine the operating system during boot, or if you boot an unsupported operating system, Network Helper will not attempt to write any new configuration files. Be aware that Network Helper configures only IPv4 addressing; your Linode's IPv6 address is assigned by SLAAC. + +{{< caution >}} +If you instead choose to manually configure your Linode's network interface settings, be the IPv4 or IPv6, you must disable Network Helper for that Linode or your configuration will overwritten during the next boot. +{{< /caution >}} + + +## Network Helper Settings + + Network Helper can be enabled or disabled globally for your account, or on a per-Linode basis. Network Helper can still be toggled on and off for specific Linodes, regardless of whether enabled or disabled globally. + +### Global + +When Network Helper is enabled globally, all new Linodes created on your account will have Network Helper enabled by default. + +1. Click on **Account** in the left sidebar of the Linode Cloud Manager. + +1. Click on the **Global Settings** tab. Set the toggle slider under the **Network Helper** section to the desired setting. Blue is enabled, gray is disabled. + + [![The Network Helper Default Behavior option](network-helper-linode-account-settings-small.png)](network-helper-linode-account-settings.png) + +1. Click the **Save** button. + +### Single (Per-Linode) + +1. Click on **Linodes** in the left sidebar of the Linode Cloud Manager. + +1. Expand the overflow menu (the three dots at the far right) of the Linode which you want to enable Network Helper for. Then click **Settings**. + + ![Navigate to the Linode's Settings page](network-helper-linode-settings-link.png) + +1. Under **Advanced Configurations**, expand the overflow menu for your configuration profile and click **Edit**: + + [![Select the configuration profile Edit Menu](network-helper-linode-settings-page-small.png)](network-helper-linode-settings-page.png) + +1. A menu will appear with that configuration profile's settings. Under the **Filesystem/Boot Helpers** section, toggle **Auto-configure networking** to the desired setting. Blue is enabled, gray is disabled. + + [![Toggle the 'auto-configure networking' box](network-helper-linode-config-profile-settings-small.png)](network-helper-linode-config-profile-settings.png) + +1. Click **Submit**. + + +## What Files are Modified + +The specific files Network Helper modifies varies by distribution. + +### Arch + +Network Helper configures `/etc/systemd/network/05-eth0.network`. + +### CentOS & Fedora + +Network Helper configures `/etc/sysconfig/network-scripts/ifcfg-eth0`. + +### Debian & Ubuntu + +Network helper configures `/etc/network/interfaces` and `/etc/resolv.conf`. + +### Gentoo + +Network Helper configures `/etc/conf.d/net` and `/etc/resolv.conf`. + +### OpenSUSE + +Network Helper configures `/etc/sysconfig/network/ifcfg-eth0`, `/etc/sysconfig/network/routes` and `/etc/resolv.conf`. + +### Slackware + +Network Helper configures `/etc/rc.d/rc.inet1.conf` and `/etc/resolv.conf`. + + +## What is Modified in Those Files + +Below are example network configuration files for a Debian 9 Linode with Network Helper enabled: + +{{< file "/etc/network/interfaces" >}} +# Generated by Linode Network Helper +# Wed Jan 9 21:30:02 2019 UTC +# +# This file is automatically generated on each boot with your Linode's +# current network configuration. If you need to modify this file, please +# first disable the 'Auto-configure Networking' setting within your Linode's +# configuration profile: +# - https://manager.linode.com/linodes/config/lin1?id=13561415 +# +# For more information on Network Helper: +# - https://www.linode.com/docs/platform/network-helper +# +# A backup of the previous config is at /etc/network/.interfaces.linode-last +# A backup of the original config is at /etc/network/.interfaces.linode-orig +# +# /etc/network/interfaces + +auto lo +iface lo inet loopback + +auto eth0 +allow-hotplug eth0 + +iface eth0 inet6 auto + +iface eth0 inet static + address 203.0.113.5/24 + gateway 203.0.113.1 +{{< /file >}} + +{{< file "/etc/resolv.conf" >}} +# Generated by Linode Network Helper +# Wed Jan 9 21:30:02 2019 UTC +# +# This file is automatically generated on each boot with your Linode's +# current network configuration. If you need to modify this file, please +# first disable the 'Auto-configure Networking' setting within your Linode's +# configuration profile: +# - https://manager.linode.com/linodes/config/lin1?id=13561415 +# +# For more information on Network Helper: +# - https://www.linode.com/docs/platform/network-helper +# +# A backup of the previous config is at /etc/.resolv.conf.linode-last +# A backup of the original config is at /etc/.resolv.conf.linode-orig +# +domain members.linode.com +search members.linode.com +nameserver 66.228.53.5 +nameserver 96.126.122.5 +nameserver 96.126.124.5 +nameserver 96.126.127.5 +nameserver 198.58.107.5 +nameserver 198.58.111.5 +nameserver 23.239.24.5 +nameserver 173.255.199.5 +nameserver 72.14.179.5 +nameserver 72.14.188.5 +{{< /file >}} + + +In addition to network interface file file (again, specific to this Debian example), Network Helper will create: + +- A copy of the interface and resolver file as the distribution provided it: `.interfaces.linode-orig` and `/etc/.resolv.conf.linode-orig`. Note that Network Helper does not modify `/etc/resolv.conf` on all of our distributions. + +- A copy of the interface and resolver files from the previous boot: `.interfaces.linode-last` and `/etc/.resolv.conf.linode-last`. If you manually changed either of these file before the previous boot, you'll find them saved there. + +Use the following command to restore manual changes made before the previous reboot. Be sure to replace `/etc/network/interfaces` with the network interface file for your distribution from [above](#what-files-are-modified). + + mv /etc/network/.interfaces.linode-last /etc/network/interfaces diff --git a/docs/platform/network-helper-new-manager/network-helper-linode-account-settings-small.png b/docs/platform/network-helper-new-manager/network-helper-linode-account-settings-small.png new file mode 100644 index 00000000000..39bc01a5f16 Binary files /dev/null and b/docs/platform/network-helper-new-manager/network-helper-linode-account-settings-small.png differ diff --git a/docs/platform/network-helper-new-manager/network-helper-linode-account-settings.png b/docs/platform/network-helper-new-manager/network-helper-linode-account-settings.png new file mode 100644 index 00000000000..97b9aee83ce Binary files /dev/null and b/docs/platform/network-helper-new-manager/network-helper-linode-account-settings.png differ diff --git a/docs/platform/network-helper-new-manager/network-helper-linode-config-profile-settings-small.png b/docs/platform/network-helper-new-manager/network-helper-linode-config-profile-settings-small.png new file mode 100644 index 00000000000..f8faaab35b0 Binary files /dev/null and b/docs/platform/network-helper-new-manager/network-helper-linode-config-profile-settings-small.png differ diff --git a/docs/platform/network-helper-new-manager/network-helper-linode-config-profile-settings.png b/docs/platform/network-helper-new-manager/network-helper-linode-config-profile-settings.png new file mode 100644 index 00000000000..88df06786ad Binary files /dev/null and b/docs/platform/network-helper-new-manager/network-helper-linode-config-profile-settings.png differ diff --git a/docs/platform/network-helper-new-manager/network-helper-linode-settings-link.png b/docs/platform/network-helper-new-manager/network-helper-linode-settings-link.png new file mode 100644 index 00000000000..dbc7ff24615 Binary files /dev/null and b/docs/platform/network-helper-new-manager/network-helper-linode-settings-link.png differ diff --git a/docs/platform/network-helper-new-manager/network-helper-linode-settings-page-small.png b/docs/platform/network-helper-new-manager/network-helper-linode-settings-page-small.png new file mode 100644 index 00000000000..036ee1c328b Binary files /dev/null and b/docs/platform/network-helper-new-manager/network-helper-linode-settings-page-small.png differ diff --git a/docs/platform/network-helper-new-manager/network-helper-linode-settings-page.png b/docs/platform/network-helper-new-manager/network-helper-linode-settings-page.png new file mode 100644 index 00000000000..aaa7d5203dc Binary files /dev/null and b/docs/platform/network-helper-new-manager/network-helper-linode-settings-page.png differ diff --git a/docs/platform/network-helper-new-manager/network-helper-title-graphic.jpg b/docs/platform/network-helper-new-manager/network-helper-title-graphic.jpg new file mode 100644 index 00000000000..b349e8d2d73 Binary files /dev/null and b/docs/platform/network-helper-new-manager/network-helper-title-graphic.jpg differ diff --git a/docs/platform/network-helper/index.md b/docs/platform/network-helper/index.md index 1e5a442ffe6..9357e66de8f 100644 --- a/docs/platform/network-helper/index.md +++ b/docs/platform/network-helper/index.md @@ -5,11 +5,12 @@ author: description: 'Information on the Network Helper option.' keywords: ["network", " networking", " network helper", " ip", " ip address", " static ip", ""] license: '[CC BY-ND 4.0](https://creativecommons.org/licenses/by-nd/4.0)' -modified: 2017-04-28 +modified: 2018-12-10 published: 2014-12-08 modified_by: name: Linode title: Network Helper +cloud_manager_link: platform/network-helper-new-manager/ --- ![Network Helper](network-helper-title-graphic.jpg "Network Helper")