diff --git a/src/content/docs/magic-wan/configuration/connector/configure-hardware-connector/index.mdx b/src/content/docs/magic-wan/configuration/connector/configure-hardware-connector/index.mdx index 6084dadae15f3e..ca381c414dbb59 100644 --- a/src/content/docs/magic-wan/configuration/connector/configure-hardware-connector/index.mdx +++ b/src/content/docs/magic-wan/configuration/connector/configure-hardware-connector/index.mdx @@ -8,12 +8,6 @@ sidebar: import { GlossaryTooltip, Render, Card } from "~/components"; -## Before you begin - - - ---- - ## Prerequisites You need to purchase [Magic WAN](https://www.cloudflare.com/magic-wan/) before you can purchase and use the Magic WAN Connector. The Magic WAN Connector can function as your primary edge device for your network, or be deployed in-line with existing network gear. @@ -24,6 +18,21 @@ Contact your account representative to learn more about purchasing options for t --- +## Before you begin + + + +--- + +## DHCP vs static IP connections + +Magic WAN Connector uses a DHCP connection at first boot to download your settings and go through the activation process. However, if you need to use a static IP in your Connector, and this is a fresh install: +1. Connect Magic WAN Connector to a DHCP port with access to the Internet. +2. Go through the [setup flow](#set-up-cloudflare-dashboard) below and activate your Connector. +3. Refer to [WAN with a static IP address](#wan-with-a-static-ip-address). + +--- + ## Port speeds The hardware version of the Magic WAN connector includes two [SFP+ ports](https://en.wikipedia.org/wiki/Small_Form-factor_Pluggable) that support 10G throughput, as well as six RJ45 ports that support 1G throughput. @@ -113,16 +122,27 @@ If there is a firewall deployed upstream of the Magic WAN Connector, configure t }} /> -### WAN with a static IP address - -After activating your Connector, you can use it in a network configuration with the WAN interface set to a static IP address - that is, an Internet configuration that is not automatically set by DHCP. - -To use your Connector on a network configuration with a static IP: +--- -1. Wait 60 seconds after activating your Connector. -2. Unplug the physical connection to the Internet-connected device which provides DHCP. -3. Adjust your physical connections as required to match the static configuration, and make changes to the [WAN settings](#2-create-a-wan) in the Cloudflare dashboard to reflect the static IP address configuration. -4. Power cycle the Connector. +## WAN with a static IP address + +After activating your Connector, you can use it in a network configuration with the WAN interface set to a static IP address — that is, an Internet configuration that is not automatically set by DHCP. To use your Connector on a network configuration with a static IP, follow the steps below. + +:::caution +Before proceeding, make sure that you went through the setup workflow and activated your Magic WAN Connector. +::: + +1. Connect Magic WAN Connector to a DHCP port with access to the Internet. +2. [Create a site](#1-create-a-site) in the Cloudflare dashboard. +3. Associate a Connector to it. +4. Create a [DHCP WAN](#2-create-a-wan). +5. [Active](#activate-connector) and power on your Connector. +6. Wait 60 seconds. +7. Make changes to the [WAN settings](#2-create-a-wan) in the Cloudflare dashboard to a static IP set up. +8. Wait 60 seconds again. +9. Magic WAN Connector will go offline. This is normal and expected behavior. +10. Adjust your physical connections as required to match the static configuration. +11. Magic WAN Connector comes back online. --- diff --git a/src/content/docs/magic-wan/configuration/connector/configure-virtual-connector.mdx b/src/content/docs/magic-wan/configuration/connector/configure-virtual-connector.mdx index 0f8f35add75b9a..5b3d6c4c4c09fb 100644 --- a/src/content/docs/magic-wan/configuration/connector/configure-virtual-connector.mdx +++ b/src/content/docs/magic-wan/configuration/connector/configure-virtual-connector.mdx @@ -9,10 +9,6 @@ import { Render } from "~/components"; Virtual Magic WAN Connector (Virtual Connector) is a virtual appliance alternative to the hardware based Magic WAN Connector appliance. These two versions of Connector are identical otherwise. -## Before you begin - - - ## Prerequisites Before you can install Virtual Connector, you need an Enterprise account with Magic WAN enabled. Additionally, you need to have a VMware host with sufficient compute, memory, and storage to run the virtual machine with Virtual Connector. This includes: @@ -27,6 +23,21 @@ Before you can install Virtual Connector, you need an Enterprise account with Ma Refer to [VMware's documentation](https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.esxi.install.doc/GUID-B2F01BF5-078A-4C7E-B505-5DFFED0B8C38.html) for more information on how to install ESXi and configure a virtual machine. +--- + +## Before you begin + + + +--- + +## DHCP vs static IP connections + +Virtual Connector uses a DHCP connection at first boot to download your settings and go through the activation process. However, if you need to use a static IP in your Virtual Connector, and this is a fresh install: +1. Connect the machine with your Virtual Connector VM to a DHCP port with access to the Internet. +2. Go through the [setup flow](#set-up-cloudflare-dashboard) below and activate your Connector. +3. Refer to [WAN with a static IP address](#wan-with-a-static-ip-address). + ## Obtain the Virtual Connector image Contact your account team at Cloudflare to obtain the Virtual Connector [OVA package](https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vm_admin.doc/GUID-AE61948B-C2EE-436E-BAFB-3C7209088552.html) and license keys. The OVA image includes the files required to install and configure the virtual machine (VM) for Virtual Connector with the appropriate settings. @@ -40,9 +51,9 @@ You will consume one license key for each instance created. For example, if you The following instructions assume you already have VMware ESXi hypervisor installed with sufficient resources. Refer to [Prerequisites](#prerequisites) for more information. 1. When setting up your VMware ESXi, you need to create port groups for Virtual Connector. Go to **Networking** > **Port groups**, and prepare your vSwitch port groups and/or VLANs for your desired network topology. For example, a simple deployment typically has: - - A WAN port group where the Virtual Connector will get an IP address (static or DHCP) that has access to the Internet. - - A LAN port group, where the Virtual Connector will act as default router, and possibly DHCP server. - - A null, or unused, port group for allocating unused virtual interfaces in the Virtual Connector. You can, for example, create a null port group with the name of `Null port group`, and a **VLAN ID** of `999`. + - A WAN port group where the Virtual Connector will get an IP address (static or DHCP) that has access to the Internet. + - A LAN port group, where the Virtual Connector will act as default router, and possibly DHCP server. + - A null, or unused, port group for allocating unused virtual interfaces in the Virtual Connector. You can, for example, create a null port group with the name of `Null port group`, and a **VLAN ID** of `999`. :::note[VLAN tagging] Virtual Connector supports creating subinterfaces through the use of [802.1Q VLAN tagging](https://en.wikipedia.org/wiki/IEEE_802.1Q). @@ -59,38 +70,29 @@ Refer to [VMWare's documentation](https://kb.vmware.com/s/article/1003825) for m 2. Extract the files in the OVA image provided by your Cloudflare account team. For example: - ```txt - tar -xvf mconn-2024-1-3.ova - ``` + ```txt + tar -xvf mconn-2024-1-3.ova + ``` - Take note of the folder where you are extracting the files to, as you will need to refer to that folder when creating the VM. + Take note of the folder where you are extracting the files to, as you will need to refer to that folder when creating the VM. 3. Go to **Virtual Machines** > **Create/Register VM** wizard to start deploying the Virtual Connector. - 4. Select **Deploy a virtual machine from an OVF or OVA file** > **Next**. - 5. Choose a descriptive name for your virtual machine. - 6. Upload the files you have extracted from the OVA image. These include `mconn.ovf`, `mconn.nvram`, and `mconn.vmdk`. - 7. Select where you want to save the files extracted from the OVA image > **Next**. - 8. In **Networking mappings**, select assignments for your desired topology according to the port groups you set up previously: - - 1. For example, map `eno1` port to `VM Network` to create your WAN, and `eno2` to `LAN0` to act as your LAN port. - 2. Allocate any unused ports to the `null` port group. - 3. Take note of your configuration. You will need this information to configure your network in the Cloudflare dashboard. - + 1. For example, map `eno1` port to `VM Network` to create your WAN, and `eno2` to `LAN0` to act as your LAN port. + 2. Allocate any unused ports to the `null` port group. + 3. Take note of your configuration. You will need this information to configure your network in the Cloudflare dashboard. 9. In **Disk provisioning**, select **Thin**. - 10. Before completing the deployment wizard, disable **Power on automatically**. This is important so that you can configure the license key prior to boot. - 11. Configure the virtual machine with the license key your account team provided you: - 1. Select the Virtual Connector's VM > **Settings**. - 2. Go to **VM Options** > **Advanced** > **Edit Configuration**. - 3. Select **Add parameter** to add your license key. Scroll down to the last entry (this is where VMware adds the new parameter), and add the following two new entries: - - **Key**: `guestinfo.cloudflare.identity` - - **Value**: `` + 1. Select the Virtual Connector's VM > **Settings**. + 2. Go to **VM Options** > **Advanced** > **Edit Configuration**. + 3. Select **Add parameter** to add your license key. Scroll down to the last entry (this is where VMware adds the new parameter), and add the following two new entries: + - **Key**: `guestinfo.cloudflare.identity` + - **Value**: `` :::note You cannot use the same license key twice, or reuse a key once the virtual machine has been registered with Cloudflare. You need a new key from your account team for every new Virtual Connector. @@ -121,17 +123,6 @@ You cannot use the same license key twice, or reuse a key once the virtual machi }} /> -### WAN with a static IP address - -After activating your Virtual Connector, you can use it in a network configuration with the WAN interface set to a static IP address - that is, an Internet configuration that is not automatically set by DHCP. - -To use your Virtual Connector on a network configuration with a static IP: - -1. Wait 60 seconds after activating your Connector. -2. Modify your Port Groups as needed to change the source from which the WAN port obtains its IP address. -3. [Adjust the WAN settings](#2-create-a-wan) in the Cloudflare dashboard to reflect the new static IP address configuration. -4. Reboot your virtual machine. - ## Boot your Virtual Connector 1. Go to **Virtual Machines** in VMware, and boot up Virtual Connector's VM. @@ -142,6 +133,27 @@ To use your Virtual Connector on a network configuration with a static IP: --- +## WAN with a static IP address + +After activating your Virtual Connector, you can use it in a network configuration with the WAN interface set to a static IP address - that is, an Internet configuration that is not automatically set by DHCP. To use your Virtual Connector on a network configuration with a static IP, follow the steps below. + +:::caution +Before proceeding, make sure that you went through the setup workflow and activated your Virtual Connector. +::: + +1. Connect the machine where you installed the VM with Virtual Connector to a DHCP port with access to the Internet. +2. [Create a site](#1-create-a-site) in the Cloudflare dashboard. +3. Associate a Connector to it. +4. Create a [DHCP WAN](#2-create-a-wan). +5. [Active](#activate-connector) and boot your Virtual Connector. +6. Wait 60 seconds. +7. Make changes to the [WAN settings](#2-create-a-wan) in the Cloudflare dashboard to a static IP set up. +8. Wait 60 seconds again. +9. Modify your [Port Groups](#deploy-the-virtual-connector-on-vmware) as needed to change the source from which the WAN port obtains its IP address. +10. Reboot your virtual machine. + +--- + 4. In **VLAN ID**, enter a number between `0` and `4094` to specify a [VLAN ID](/magic-wan/configuration/connector/reference/#vlan-id). 5. In **Priority**, choose the priority for your WAN. Lower numbers have higher priority. Refer to Traffic steering to learn more about how Cloudflare calculates priorities. -6. **Addressing**: If this is the first time you are setting up your Magic WAN Connector, select **DHCP**. After you activate your Connector, you can then choose to continue fetching the WAN IP address from a DHCP server, or change it to a static IP. If you choose a static IP, you also need to specify the static IP and gateway addresses. +6. **Addressing**: Select **DHCP**. This is needed the first time you set up your Connector to successfully download all settings to the machine and activate it. If you need a static IP address in your network environment: + 1. Continue the set up flow below to activate your Connector. + 2. Refer to [WAN with a static IP address](#wan-with-a-static-ip-address). If you choose a static IP, you also need to specify the static IP and gateway addresses.
@@ -117,30 +119,18 @@ curl https://api.cloudflare.com/client/v4/accounts/{account_id}/magic/sites/{sit 1. In **LAN configuration**, select **Create**. - 2. Enter a descriptive name for your LAN in **Interface name**. - 3. **Interface number** - 4. In **VLAN ID**, specify a [VLAN ID](/magic-wan/configuration/connector/reference/#vlan-id) to create virtual LANs. - 5. In **Static addressing** > **Static address** give your Connector's LAN interface its IP address. You can also enable the following options if they suit your use case: - - **This is a DHCP server**: If your Connector is a [DHCP server](/magic-wan/configuration/connector/network-options/dhcp/dhcp-server/). - **This is a DHCP relay**: If your Connector is a [DHCP relay](/magic-wan/configuration/connector/network-options/dhcp/dhcp-relay/). - 6. (Optional) In **Directly attached subnet** > **Static NAT prefix**, enter a CIDR prefix to enable NAT (network address translation). The prefix you enter here should be the same size as the prefix entered in **Static addressing**. For example, both networks have a subnet mask of `/24`: `192.168.100.0/24` and `10.10.100.0/24`. - 7. (Optional) If your LAN contains additional subnets behind a layer 3 router, select **Add routed subnet** under **Routed subnets** to add them: - - **Prefix**: The CIDR prefix for the subnet behind the L3 router. - **Next hop**: The address of the L3 router to which the Connector should forward packets for this subnet. - - **Static NAT prefix**: Optional setting. If you want to enable NAT for a routed subnet, supply an "external" prefix for the overlay-facing side of the NAT to use. It must be the same size as **Prefix**. - - Refer to [Routed subnets](/magic-wan/configuration/connector/network-options/routed-subnets/) for more information. - + - **Static NAT prefix**: Optional setting. If you want to enable NAT for a routed subnet, supply an "external" prefix for the overlay-facing side of the NAT to use. It must be the same size as **Prefix**.
Refer to [Routed subnets](/magic-wan/configuration/connector/network-options/routed-subnets/) for more information. 8. Select **Save**. - 9. Select **Save and exit** to finish your configuration. Tunnels and static routes will be automatically created and associated with your site once the Magic WAN Connector boots up (refer to the next step).