From 0bf037d0e7a1d7355e0de232d23bee414430fc5b Mon Sep 17 00:00:00 2001 From: niusmallnan Date: Sun, 20 Jan 2019 11:02:35 +0800 Subject: [PATCH 1/3] The wifi and 4g-lte support in RancherOS --- .../networking/interfaces/_index.md | 100 ++++++++++++++++++ 1 file changed, 100 insertions(+) diff --git a/content/os/v1.x/en/installation/networking/interfaces/_index.md b/content/os/v1.x/en/installation/networking/interfaces/_index.md index e3563a5d1a8..38d2b02c4c9 100644 --- a/content/os/v1.x/en/installation/networking/interfaces/_index.md +++ b/content/os/v1.x/en/installation/networking/interfaces/_index.md @@ -164,3 +164,103 @@ rancher: post_up: - /var/lib/iptables/rules.sh post_up eth2 ``` + +### WiFi + +_Available as of v1.5_ + +RancherOS can support the following cloud-config to enable WiFi access, we introduced some new items. You can use DHCP or STATIC mode. + +Case 1, one wireless adapter with DHCP: + +```yaml +#cloud-config +rancher: + network: + interfaces: + wlan0: + wifi_network: network1 + wifi_networks: + network1: + ssid: "Your wifi ssid" + psk: "Your wifi password" + scan_ssid: 1 +``` + +Case 2, one wireless adapter with STATIC: + +```yaml +rancher: + network: + dns: + nameservers: + - 8.8.8.8 + - 8.8.4.4 + interfaces: + wlan0: + wifi_network: network1 + wifi_networks: + network1: + ssid: "Your wifi ssid" + psk: "Your wifi password" + scan_ssid: 1 + address: 192.168.1.78/24 + gateway: 192.168.1.1 +``` + +Case 3, two wireless adapters with DHCP: + +```yaml +rancher: + network: + interfaces: + wlan0: + wifi_network: network1 + wlan1: + wifi_network: network2 + wifi_networks: + network1: + ssid: "Your wifi ssid" + psk: "Your wifi password" + scan_ssid: 1 + network2: + ssid: "Your wifi ssid" + psk: "Your wifi password" + scan_ssid: 1 +``` + +You can apply these configurations without a reboot, just restart the network service: + +``` +$ sudo system-docker restart network +``` + +> **Note:** For Intel wireless adapters, we have built in some firmware and modules, usually you don't need to install a new module or firmware. For other adapters, you may need to install os kernel-extras. + +### 4G-LTE + +_Available as of v1.5_ + +You need a 4G/LTE module and it can be easily connected to any motherboard. In order to get a good signal, you also need an external antenna. You can assemble such a device, it can support USB interface, and SIM cards slot: + +![](https://ws1.sinaimg.cn/bmiddle/006tNc79ly1fzcuvhu6zpj30k80qwag1.jpg) + +Here you should use a special ISO for 4G/LTE, unlike the standard version, it has built-in modem-manager service. You can download from [here](https://releases.rancher.com/os/latest/4glte/rancheros.iso). + +After booting the ISO, you can see a 4G NIC, such as wwan0. You can use the following cloud-config, usually setting the APN parameter is enough: + +```yaml +rancher: + network: + modem_networks: + wwan0: + apn: xxx +``` + +Any configuration changes, just only need to restart modem-manager to take effect: + +``` +$ sudo system-docker restart modem-manager +``` + +> **Note:** We have built in some udev rules to allow the OS to recognize 4G devices. But there are still some vendors that may be missing. If some 4G devices cannot be recognized, please let us know. From 15399835b745bb8974bf96fc18ae169fc9660407 Mon Sep 17 00:00:00 2001 From: Denise Date: Fri, 15 Feb 2019 22:16:35 -0800 Subject: [PATCH 2/3] Update _index.md --- .../networking/interfaces/_index.md | 27 ++++++++++--------- 1 file changed, 14 insertions(+), 13 deletions(-) diff --git a/content/os/v1.x/en/installation/networking/interfaces/_index.md b/content/os/v1.x/en/installation/networking/interfaces/_index.md index 38d2b02c4c9..565d88431ad 100644 --- a/content/os/v1.x/en/installation/networking/interfaces/_index.md +++ b/content/os/v1.x/en/installation/networking/interfaces/_index.md @@ -167,11 +167,11 @@ rancher: ### WiFi -_Available as of v1.5_ +_Available as of v1.5+_ -RancherOS can support the following cloud-config to enable WiFi access, we introduced some new items. You can use DHCP or STATIC mode. +In order to enable wifi access, you can update the cloud-config with the wifi network information. You can use DHCP or STATIC mode. -Case 1, one wireless adapter with DHCP: +#### Example of a wireless adapter using DHCP ```yaml #cloud-config @@ -187,7 +187,8 @@ rancher: scan_ssid: 1 ``` -Case 2, one wireless adapter with STATIC: +#### Example of a wireless adapter using STATIC + ```yaml rancher: @@ -208,7 +209,7 @@ rancher: gateway: 192.168.1.1 ``` -Case 3, two wireless adapters with DHCP: +#### Example using two wireless adapters with DHCP ```yaml rancher: @@ -229,25 +230,25 @@ rancher: scan_ssid: 1 ``` -You can apply these configurations without a reboot, just restart the network service: +Adding in wifi access can be done with a system reboot, you only need to restart the `network` service. ``` $ sudo system-docker restart network ``` -> **Note:** For Intel wireless adapters, we have built in some firmware and modules, usually you don't need to install a new module or firmware. For other adapters, you may need to install os kernel-extras. +> **Note:** For Intel wireless adapters, there are some built-in firmware and modules, which prevents you have requiring to install any new modules or firmware. For other adapters, you may need to install additional os kernel-extras. ### 4G-LTE -_Available as of v1.5_ +_Available as of v1.5+_ -You need a 4G/LTE module and it can be easily connected to any motherboard. In order to get a good signal, you also need an external antenna. You can assemble such a device, it can support USB interface, and SIM cards slot: +In order to support 4G-LTE, you will need a 4G-LTE module, which can be easily connected to the motherboard. In order to get a good signal, you will also need an external antenna. You can assemble such a device, which can support USB interface and SIM cards slot: ![](https://ws1.sinaimg.cn/bmiddle/006tNc79ly1fzcuvhu6zpj30k80qwag1.jpg) -Here you should use a special ISO for 4G/LTE, unlike the standard version, it has built-in modem-manager service. You can download from [here](https://releases.rancher.com/os/latest/4glte/rancheros.iso). +In order to use RancherOS, you will need to use a special ISO built for 4G-LTE support. This ISO has a built-in `modem-manager` service. This special ISO can be downloaded from [here](https://releases.rancher.com/os/latest/4glte/rancheros.iso). -After booting the ISO, you can see a 4G NIC, such as wwan0. You can use the following cloud-config, usually setting the APN parameter is enough: +After booting the ISO, you can see a 4G NIC, such as `wwan0`. You can use the following cloud-config to set the APN parameter to get it working. ```yaml rancher: @@ -257,10 +258,10 @@ rancher: apn: xxx ``` -Any configuration changes, just only need to restart modem-manager to take effect: +If there are any configuration changes, you will only need to restart the `modem-manager` service to apply these changes. ``` $ sudo system-docker restart modem-manager ``` -> **Note:** We have built in some udev rules to allow the OS to recognize 4G devices. But there are still some vendors that may be missing. If some 4G devices cannot be recognized, please let us know. +> **Note:** There are some built-in `udev` rules to allow RancherOS to recognize specific 4G devices. There are still some vendors that may be missing and if you need support for these, please file an issue. From a2036320dfda8ec753faeda7aa922133f2115509 Mon Sep 17 00:00:00 2001 From: Denise Date: Tue, 5 Mar 2019 11:12:05 -0800 Subject: [PATCH 3/3] Update _index.md --- .../networking/interfaces/_index.md | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/content/os/v1.x/en/installation/networking/interfaces/_index.md b/content/os/v1.x/en/installation/networking/interfaces/_index.md index 565d88431ad..dc2d7b6fd0b 100644 --- a/content/os/v1.x/en/installation/networking/interfaces/_index.md +++ b/content/os/v1.x/en/installation/networking/interfaces/_index.md @@ -167,9 +167,9 @@ rancher: ### WiFi -_Available as of v1.5+_ +_Available as of v1.5_ -In order to enable wifi access, you can update the cloud-config with the wifi network information. You can use DHCP or STATIC mode. +In order to enable WiFi access, update the `cloud-config` with the WiFi network information. You can use `DHCP` or `STATIC` mode. #### Example of a wireless adapter using DHCP @@ -230,25 +230,25 @@ rancher: scan_ssid: 1 ``` -Adding in wifi access can be done with a system reboot, you only need to restart the `network` service. +When adding in WiFi access, you do not need a system reboot, you only need to restart the `network` service in System Docker. ``` $ sudo system-docker restart network ``` -> **Note:** For Intel wireless adapters, there are some built-in firmware and modules, which prevents you have requiring to install any new modules or firmware. For other adapters, you may need to install additional os kernel-extras. +> **Note:** For Intel wireless adapters, there are some built-in firmware and modules, which prevents requiring to install any new modules or firmware. For other adapters, you may need to install additional os kernel-extras. ### 4G-LTE -_Available as of v1.5+_ +_Available as of v1.5_ -In order to support 4G-LTE, you will need a 4G-LTE module, which can be easily connected to the motherboard. In order to get a good signal, you will also need an external antenna. You can assemble such a device, which can support USB interface and SIM cards slot: +In order to support 4G-LTE, 4G-LTE module will need to be connected to the motherboard and to get a good signal, an external atenna will need to be added. You can assemble such a device, which supports USB interface and SIM cards slot: ![](https://ws1.sinaimg.cn/bmiddle/006tNc79ly1fzcuvhu6zpj30k80qwag1.jpg) -In order to use RancherOS, you will need to use a special ISO built for 4G-LTE support. This ISO has a built-in `modem-manager` service. This special ISO can be downloaded from [here](https://releases.rancher.com/os/latest/4glte/rancheros.iso). +In order to use RancherOS, you will need to use the ISO built for 4G-LTE support. This ISO has a built-in `modem-manager` service and is available with each release. -After booting the ISO, you can see a 4G NIC, such as `wwan0`. You can use the following cloud-config to set the APN parameter to get it working. +After booting the ISO, there will be a 4G NIC, such as `wwan0`. Use the following `cloud-config` to set the APN parameter. ```yaml rancher: @@ -258,10 +258,10 @@ rancher: apn: xxx ``` -If there are any configuration changes, you will only need to restart the `modem-manager` service to apply these changes. +After any configuration changes, restart the `modem-manager` service to apply these changes. ``` $ sudo system-docker restart modem-manager ``` -> **Note:** There are some built-in `udev` rules to allow RancherOS to recognize specific 4G devices. There are still some vendors that may be missing and if you need support for these, please file an issue. +> **Note:** Currently, RancherOS has some built-in rules in `udev` rules to allow RancherOS to recognize specific 4G devices, but there are additional vendors that may be missing. If you need to add these in, please file an issue.