Skip to content

Commit 54deb32

Browse files
marciocloudflarepedrosousa
authored and
jonesphillip
committed
[MWAN] Sites feature (#19893)
* changed name to config connector * refactored connector partial * corrected links * updated steps numbers and ha configs * corrected numbers * changed partial name * refined text * refined text * corrected link * added sites info to pages * created sites brief partial * removed next step * changed where add sites appear in the flow * created sites page * reordered pages * moved site title * added intro * added content * corrected dash path * corrected dash path * corrected path * removed spaces * corrected dash path * corrected dash path * corrected interface address name tunnels * refined text * steps to add a site * deleted old content * added site analytics info * link to sites * link to sites * added beta to network overview * added beta to connector on-ramps * added sites to flow * refined text * removed site from workflow * refined step number * Apply suggestions from code review Co-authored-by: Pedro Sousa <[email protected]> * Update src/content/docs/magic-wan/configuration/common-settings/sites.mdx Co-authored-by: Pedro Sousa <[email protected]> * step consistent with network segmentation * added beta --------- Co-authored-by: Pedro Sousa <[email protected]>
1 parent dbf6bb9 commit 54deb32

File tree

21 files changed

+233
-212
lines changed

21 files changed

+233
-212
lines changed

‎src/content/docs/magic-wan/analytics/site-analytics.mdx‎

Lines changed: 4 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -1,98 +1,15 @@
11
---
2-
title: Site Analytics
2+
title: Site analytics
33
pcx_content_type: how-to
44
sidebar:
55
order: 1
66
head:
77
- tag: title
8-
content: Magic WAN Site Analytics
8+
content: Magic WAN site analytics
99

1010
---
1111

12-
import { Details } from "~/components"
12+
After adding sites to your Magic WAN, the Network overview (beta) section of the dashboard provides you a summary of the connectivity status and traffic analytics for all your sites. This is a great place to start if you receive a Magic WAN alert, need to begin the troubleshooting process, or are performing routine monitoring.
1313

14-
Magic WAN Site Analytics provides an overview of the connectivity status and traffic analytics of all Magic WAN Connector sites. Magic WAN Site Analytics is a great place to start if you receive a Magic WAN alert, need to begin the Magic WAN Connector troubleshooting process, or are performing routine monitoring.
14+
Refer to [Set up a site](/magic-wan/configuration/common-settings/sites/) for more information.
1515

16-
Magic WAN Site Analytics has the following data types available:
17-
18-
<Details header="Geographic map summary">
19-
- [Aggregate Magic WAN site health](#site-health)
20-
- [Magic WAN availability status for sites](#no-status-available)
21-
- [Magic WAN site geographic location](#no-location-available)
22-
</Details>
23-
24-
<Details header="Magic WAN site data table">
25-
- Site Name
26-
- Site Health
27-
- Site Tunnel Names
28-
- Site Tunnel Statuses
29-
- Site Traffic Sent
30-
- Site Traffic Received
31-
</Details>
32-
33-
<Details header="Magic WAN site data">
34-
- Traffic Sent by Tunnel
35-
- Traffic Received by Tunnel
36-
</Details>
37-
38-
To start using Magic WAN Site Analytics:
39-
40-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account.
41-
2. Select **Magic WAN** > **Overview**.
42-
43-
You will have access to an overview map with all your active sites, and any alerts for sites that are unhealthy or have no status available to them.
44-
45-
Review the topics below to learn more about the options available to you.
46-
47-
### All sites
48-
49-
This section shows all the sites you configured with Magic WAN. At a glance, you can check:
50-
51-
- How many active sites you have
52-
- Sites that are healthy or unhealthy
53-
- Sites that have no status available
54-
- Sites that have no location set
55-
56-
#### Site health
57-
58-
Sites can be healthy or unhealthy, and Magic WAN uses this information to route traffic. Refer to [Set thresholds for Magic WAN site health](#set-thresholds-for-magic-wan-site-health) to learn more about this topic.
59-
60-
#### No status available
61-
62-
The status of a site refers to its health. If your sites show a **No status available** message, this means you did not configure your [Tunnel health check alerts](/magic-wan/configuration/common-settings/configure-magic-tunnel-alerts/).
63-
64-
#### No location available
65-
66-
The dashboard shows you the number of sites with no location set, meaning sites for which you did not set up a geographic location. To add a location to a site, find the site you want to add location to, and select **no location set** to edit its location settings. Refer to [Set geographic coordinates](#set-geographic-coordinates) for more information.
67-
68-
69-
### Traffic overview
70-
71-
Traffic overview aggregates all Magic WAN sites configured in your account. Here, you can check at-a-glance information about each site like:
72-
73-
- Site status
74-
- Traffic sent and received
75-
76-
Select one of your sites to have access to a more detailed view of its traffic, including traffic by tunnel.
77-
78-
---
79-
80-
## Configure Magic WAN Site Analytics
81-
82-
### Set geographic coordinates
83-
84-
When you create a site, you can set geographic coordinates in order for it to show on the Overview map. You can also add this information to sites you have already created. To add a Magic WAN site to the geographic map in the Overview page:
85-
86-
1. Go to **Magic WAN** > **Sites**.
87-
2. Select a specific site > **Edit**.
88-
3. Scroll to **Site Location**.
89-
4. Set the **latitude** and **longitude** coordinates of the Magic WAN Site.
90-
5. Scroll down and select **Save**.
91-
6. The Magic WAN Site will now appear on the geographic map in the Overview page.
92-
93-
### Set thresholds for Magic WAN site health
94-
95-
You can set Magic Tunnel health alerts to receive alerts when the percentage of successful health checks for a Magic Tunnel drops below the selected service-level objective (SLO). Setting health alerts will also show unhealthy tunnels in the Overview map:
96-
97-
1. Configure [Magic Tunnel health alerts](/magic-wan/configuration/common-settings/configure-magic-tunnel-alerts/) across all of the Magic Tunnels associated with each Magic WAN Site.
98-
2. After configuring Magic Tunnel health alerts, any Magic WAN Site with a Magic Tunnel that is outside of its SLO threshold will be labeled unhealthy in the Overview map.

‎src/content/docs/magic-wan/configuration/common-settings/check-tunnel-health-dashboard.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
pcx_content_type: how-to
33
title: Check tunnel health in the dashboard
44
sidebar:
5-
order: 2
5+
order: 3
66
---
77

88
import { Render } from "~/components";
@@ -12,7 +12,7 @@ import { Render } from "~/components";
1212
params={{
1313
dashInfo:
1414
"The dashboard shows the view of tunnel health as measured from each Cloudflare location where your traffic is likely to land.",
15-
productPath: "**Magic WAN** > **Tunnel health check**",
15+
productPath: "**Magic WAN** > **Tunnel health**",
1616
}}
1717
/>
1818

‎src/content/docs/magic-wan/configuration/common-settings/sites.mdx‎

Lines changed: 131 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
---
2+
title: Set up a site
3+
pcx_content_type: how-to
4+
sidebar:
5+
order: 2
6+
---
7+
8+
import { Details } from "~/components"
9+
10+
Sites represent the local network of a data center, office, or other physical location, and combine all on-ramps available there. Sites also allow you to check, at a glance, the state of your on-ramps and set up health alert settings so that you get notified when there are issues with the site's on-ramps.
11+
12+
To use a site, start by setting up your on-ramps. These can be [GRE or IPsec tunnels](/magic-wan/configuration/manually/how-to/configure-tunnels/), a [Magic WAN Connector](/magic-wan/configuration/connector/), or a direct [CNI link](/magic-wan/network-interconnect/). When you are finished setting these up, refer to the steps below to learn how to set up a site.
13+
14+
## Add a site
15+
16+
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account.
17+
2. Go to **Magic WAN** > **Network overview (beta)**.
18+
3. Select **Create site**. If this is not the first time you are adding a site, you will have the option **Add site** instead.
19+
4. Add a name and description for your new site. Optionally, you can also add the geographical coordinates for your site in **Latitude** and **Longitude**. If you add geographical coordinates, once created your site's location will show in the map.
20+
5. Select **Create and continue**.
21+
6. Choose one or more on-ramps for your site from the list. Remember to only choose the on-ramps available to that particular site, as the list might show on-ramps available on other locations.
22+
7. Select **Continue**.
23+
8. In **Define alert settings** you set up alerts to notify you when there are issues with your site's on-ramps. If you want to set up alerts later, select **Skip this for now** to complete your setup. Otherwise, continue reading.
24+
9. In **Magic WAN Health Check Alert** > **Notification name**, enter a name for the site's alert.
25+
9. Under **Alert settings**, choose how you want to be notified when there is an issue. You can add webhooks as well as email addresses.
26+
10. In **Alert sensitivity level** define the threshold for Magic Tunnel health alerts to be fired. Available options are _Low_, _Medium_, and _High_. Refer to [Magic Tunnels background information](/magic-wan/reference/magic-tunnels/) for more information.
27+
11. Select **Complete setup** to finish setting up your site.
28+
29+
Your site is now set up. If you have other sites you need to set up, repeat the steps above. If you did not set up alerts, we strongly recommend that you do it. Otherwise you will not be notified when there is a problem with one of your on-ramps.
30+
31+
---
32+
33+
## Site analytics
34+
35+
After adding your sites, the Network overview (beta) section of the dashboard provides a summary of the connectivity status and traffic analytics for all your sites. This is a great place to start if you receive a Magic WAN alert, need to begin the troubleshooting process, or are performing routine monitoring.
36+
37+
Network overview (beta) has the following data types available:
38+
39+
<Details header="Geographic map summary">
40+
- [Aggregate Magic WAN site health](#site-health)
41+
- [Magic WAN availability status for sites](#no-status-available)
42+
- [Magic WAN site geographic location](#no-location-set)
43+
</Details>
44+
45+
<Details header="Magic WAN site data table">
46+
- Site Name
47+
- Site Health
48+
- Site Tunnel Names
49+
- Site Tunnel Statuses
50+
- Site Traffic Sent
51+
- Site Traffic Received
52+
</Details>
53+
54+
<Details header="Magic WAN site data">
55+
- Traffic Sent by Tunnel
56+
- Traffic Received by Tunnel
57+
</Details>
58+
59+
To start using Magic WAN site analytics:
60+
61+
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account.
62+
2. Select **Magic WAN** > **Network overview (beta)**.
63+
64+
You will have access to an overview map with all your active sites, and any alerts for sites that are unhealthy or have no status available to them.
65+
66+
Review the topics below to learn more about the options available to you.
67+
68+
### Network map and traffic overview
69+
70+
The network map section shows all the sites configured with Magic WAN. At a glance, you can check:
71+
72+
- How many active sites you have
73+
- Location for sites in a map (if you set up their geographic location)
74+
- Sites that are healthy or unhealthy
75+
- Sites that have no status available
76+
- Sites that have no location set
77+
78+
Just below the map, Traffic overview shows a more granular list of your sites and their status.
79+
80+
#### Site health
81+
82+
Sites can be healthy or unhealthy, and Magic WAN uses this information to route traffic. Refer to [Set thresholds for Magic WAN site health](#set-thresholds-for-magic-wan-site-health) to learn more about this topic.
83+
84+
#### No status available
85+
86+
The status of a site refers to its health. If your sites show a **No status available** message, this means you did not configure your alert settings when creating your site. Refer to [Configure Magic Tunnel health alerts](/magic-wan/configuration/common-settings/configure-magic-tunnel-alerts/) to learn how to create an alert for your site.
87+
88+
#### No location set
89+
90+
The dashboard shows you the number of sites with no location set, meaning sites for which you did not set up a geographic location. To add a location to a site, find the site you want to add location to, and select **no location set** to edit its location settings. Refer to [Set geographic coordinates](#set-geographic-coordinates) for more information.
91+
92+
93+
### Traffic overview
94+
95+
Traffic overview aggregates all Magic WAN sites configured in your account. Here, you can check at-a-glance information about each site like:
96+
97+
- Site status
98+
- Traffic sent and received
99+
100+
Select one of your sites to have access to a more detailed view of its traffic, including traffic by tunnel.
101+
102+
---
103+
104+
## Edit a site
105+
106+
### Add or remove on-ramps
107+
108+
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account.
109+
2. Go to **Magic WAN** > **Network overview (beta)**.
110+
3. Find your site in **Traffic overview** > select the three dots in front of it > **Edit**.
111+
4. Select **On-ramps**.
112+
5. Select **Add** to add a new on-ramp.
113+
6. If you want to remove an on-ramp, select the three dots in front of your on-ramp > **Remove**.
114+
115+
### Set geographic coordinates
116+
117+
If you add geographic coordinates to your site, it will show up in the Network map. To set up or edit geographic coordinates to an existing site:
118+
119+
1. Go to **Magic WAN** > **Network overview (beta)**.
120+
2. Find your site in **Traffic overview** > select the three dots in front of it > **Edit**.
121+
3. In **Basic information**, edit your site's **Latitude** and **Longitude** coordinates.
122+
4. Select **Save**.
123+
124+
### Set thresholds for Magic WAN site health
125+
126+
When you set up an alert for your site, you will be notified when there is an issue with one or more on-ramps. These alerts are sent when the percentage of successful health checks for a Magic WAN on-ramp drops below the selected service-level objective (SLO). Setting health alerts will also show unhealthy tunnels in the Network map and in the Traffic overview sections.
127+
128+
To set up health alerts:
129+
130+
1. Configure [Magic Tunnel health alerts](/magic-wan/configuration/common-settings/configure-magic-tunnel-alerts/) across all of the Magic Tunnels associated with each Magic WAN site.
131+
2. After configuring Magic Tunnel health alerts, any Magic WAN site with a Magic Tunnel (on-ramp) that is outside of its SLO threshold will be labeled unhealthy in Network map and Traffic overview.

‎src/content/docs/magic-wan/configuration/common-settings/tunnel-health-checks.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
pcx_content_type: how-to
33
title: Update tunnel health checks frequency
44
sidebar:
5-
order: 3
5+
order: 4
66
---
77

88
import { Render } from "~/components";

‎src/content/docs/magic-wan/configuration/connector/configure-hardware-connector/index.mdx‎

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Refer to [SFP+ port information](/magic-wan/configuration/connector/configure-ha
4444
## Set up Cloudflare dashboard
4545

4646
<Render
47-
file="connector/create-site"
47+
file="connector/connector-onramps"
4848
params={{
4949
wan: "refers to the physical Magic WAN Connector Ethernet port that you are using for your WAN. The ports are labeled `GE1`, `GE2`, `GE3`, `GE4`, `GE5`, and `GE6`. Choose the number corresponding to the port that you are using in Connector. <br> If you need a throughput higher than 1 Gbps, you can use one of the SFP+ ports. Refer to [SFP+ port information](/magic-wan/configuration/connector/configure-hardware-connector/sfp-port-information/) for more information on the hardware supported.",
5050
lan: "refers to the physical Magic WAN Connector Ethernet port that you are using for your LAN. The ports are labeled `GE1`, `GE2`, `GE3`, `GE4`, `GE5`, and `GE6`. Choose a number corresponding to the port that you are using in Connector. <br> If you need a throughput higher than 1 Gbps, you can use one of the SFP+ ports. Refer to [SFP+ port information](/magic-wan/configuration/connector/configure-hardware-connector/sfp-port-information/) for more information on the hardware supported.",
@@ -133,16 +133,15 @@ Make sure you complete the setup workflow and activate your Magic WAN Connector
133133
:::
134134

135135
1. Connect Magic WAN Connector to a DHCP port with access to the Internet.
136-
2. [Create a site](#1-create-a-site) in the Cloudflare dashboard.
137-
3. Associate a Connector to it.
138-
4. Create a [DHCP WAN](#2-create-a-wan).
139-
5. [Active](#activate-connector) and power on your Connector.
140-
6. Wait 60 seconds.
141-
7. Make changes to the [WAN settings](#2-create-a-wan) in the Cloudflare dashboard to a static IP set up.
142-
8. Wait 60 seconds again.
143-
9. Magic WAN Connector will go offline. This is normal and expected behavior.
144-
10. Adjust your physical connections as required to match the static configuration.
145-
11. Magic WAN Connector comes back online.
136+
2. [Add a Connector on-ramp](#1-add-a-connector-on-ramp) in the Cloudflare dashboard.
137+
3. Create a [DHCP WAN](#2-create-a-wan).
138+
4. [Activate](#activate-connector) and power on your Connector.
139+
5. Wait 60 seconds.
140+
6. Make changes to the [WAN settings](#2-create-a-wan) in the Cloudflare dashboard to a static IP set up.
141+
7. Wait 60 seconds again.
142+
8. Magic WAN Connector will go offline. This is normal and expected behavior.
143+
9. Adjust your physical connections as required to match the static configuration.
144+
10. Magic WAN Connector comes back online.
146145

147146
---
148147

‎src/content/docs/magic-wan/configuration/connector/configure-virtual-connector.mdx‎

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ You cannot use the same license key twice, or reuse a key once the virtual machi
104104
## Set up Cloudflare dashboard
105105

106106
<Render
107-
file="connector/create-site"
107+
file="connector/connector-onramps"
108108
params={{
109109
wan: "needs to correspond to the virtual network interface on the Virtual Connector instance you have set up in VMware. Following our example from the previous steps, you need to choose port `1` since that is what corresponds to the `eno1` port we set up in VMware.",
110110
lan: "needs to correspond to the virtual LAN interface on the Virtual Connector instance you have set up in VMware. Following our example from the previous steps, you need to choose port `2` since that is what corresponds to the `eno2` port we set up in VMware.",
@@ -126,7 +126,7 @@ You cannot use the same license key twice, or reuse a key once the virtual machi
126126
## Boot your Virtual Connector
127127

128128
1. Go to **Virtual Machines** in VMware, and boot up Virtual Connector's VM.
129-
2. The Virtual Connector will make a request to Cloudflare. This is the step where Virtual Connector registers your provided license key and [downloads the site configuration](#1-create-a-site) for its connected site.
129+
2. The Virtual Connector will make a request to Cloudflare. This is the step where Virtual Connector registers your provided license key and downloads the [configuration you provided](#1-add-a-connector-on-ramp).
130130
3. The Virtual Connector will set up the LAN and WAN connections according to the configuration downloaded from the site you created on the Cloudflare dashboard. The Virtual Connector will also establish IPsec tunnels.
131131
4. If successful, the [tunnel health checks](/magic-wan/configuration/common-settings/check-tunnel-health-dashboard/) will show as healthy.
132132
5. If you do not see a [healthy heartbeat](/magic-wan/configuration/connector/maintenance/heartbeat/) the Cloudflare dashboard, reboot the Virtual Connector's VM in VMware.
@@ -142,15 +142,14 @@ Make sure you complete the setup workflow and activate your Virtual Connector be
142142
:::
143143

144144
1. Connect the machine where you installed the VM with Virtual Connector to a DHCP port with access to the Internet.
145-
2. [Create a site](#1-create-a-site) in the Cloudflare dashboard.
146-
3. Associate a Connector to it.
147-
4. Create a [DHCP WAN](#2-create-a-wan).
148-
5. [Active](#activate-connector) and boot your Virtual Connector.
149-
6. Wait 60 seconds.
150-
7. Make changes to the [WAN settings](#2-create-a-wan) in the Cloudflare dashboard to a static IP set up.
151-
8. Wait 60 seconds again.
152-
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.
153-
10. Reboot your virtual machine.
145+
2. [Add a Connector on-ramp](#1-add-a-connector-on-ramp) in the Cloudflare dashboard.
146+
3. Create a [DHCP WAN](#2-create-a-wan).
147+
4. [Activate](#activate-connector) and boot your Virtual Connector.
148+
5. Wait 60 seconds.
149+
6. Make changes to the [WAN settings](#2-create-a-wan) in the Cloudflare dashboard to a static IP set up.
150+
7. Wait 60 seconds again.
151+
8. 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.
152+
9. Reboot your virtual machine.
154153

155154
---
156155

‎src/content/docs/magic-wan/configuration/connector/network-options/application-based-policies/breakout-traffic.mdx‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,6 @@ You need to configure Breakout traffic for each of your existing sites, as it is
4545
file="connector/app-aware-policies/add-app"
4646
params={{ featureName: "Breakout traffic" }}
4747
/>
48-
4948
6. Select one or more applications that should bypass Cloudflare filtering from the list. You can also use the search box.
5049
7. Select **Add applications**.
5150

‎src/content/docs/magic-wan/configuration/connector/network-options/dhcp/dhcp-relay.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ To configure DHCP relay:
2929
<Tabs syncKey="dashPlusAPI"> <TabItem label="Dashboard">
3030

3131
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account.
32-
2. Go to **Magic WAN** > **Sites**.
33-
3. Select your site > **Edit**.
34-
4. Select **Network**.
32+
2. Go to **Magic WAN** > **Connector on-ramps (beta)**.
33+
3. Select your Connector > **Edit**.
34+
4. Select **Network Configuration**.
3535
5. In **LAN configuration**, select the LAN where you need to configure DHCP relay.
3636
6. Select **Edit**.
3737
7. Select **This is a DHCP Relay**.

0 commit comments

Comments
 (0)