Skip to content

Commit d3be8da

Browse files
[MWAN] Changed hardcoded names to vars (#25934)
* connector to var * changed params * added vars * changed to vars * vars * vars * vars * vars * vars * vars
1 parent 3e590e7 commit d3be8da

File tree

13 files changed

+45
-38
lines changed

13 files changed

+45
-38
lines changed

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ import { Render } from "~/components";
1515
params={{
1616
greIpsecTunnelsURL: "/magic-wan/configuration/manually/how-to/configure-tunnel-endpoints/",
1717
connectorURL: "/magic-wan/configuration/connector/",
18-
cniURL: "/magic-wan/network-interconnect/"
18+
cniURL: "/magic-wan/network-interconnect/",
19+
connectorName: "Magic WAN Connector"
1920
}}
2021
/>

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,6 @@ import { Render } from "~/components";
1515
productName: "Magic WAN Connector",
1616
featureName: "Breakout traffic",
1717
trafficSteeringURL: "/magic-wan/reference/traffic-steering/",
18-
whatHappensApp: "will now go directly to the Internet and bypass Cloudflare's filtering"
18+
whatHappensApp: "will now go directly to the Internet and bypass Cloudflare's filtering",
19+
mwanName: "Magic WAN"
1920
}} />

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,6 @@ import { Render } from "~/components";
1414
magicWord: "prioritized",
1515
productName: "Magic WAN Connector",
1616
featureName: "Prioritized traffic",
17-
whatHappensApp: "is now processed first by Connector"
17+
whatHappensApp: "is now processed first by Connector",
18+
mwanName: "Magic WAN"
1819
}} />

src/content/partials/networking-services/magic-wan/get-started.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Setting up {props.productNameManual} manually is done through a combination of t
3838
## Prerequisites
3939

4040
:::note
41-
The list of prerequisites below is only for customers planning to connect manually to Cloudflare with a third-party device. If you plan on using Magic WAN Connector, skip this section and refer to <a href={props.configureConnectorUrl}>Configure with Connector</a>.
41+
The list of prerequisites below is only for customers planning to connect manually to Cloudflare with a third-party device. If you plan on using {props.productNameConnector}, skip this section and refer to <a href={props.configureConnectorUrl}>Configure with Connector</a>.
4242
:::
4343

4444
### Use compatible tunnel endpoint routers
@@ -54,7 +54,7 @@ Magic WAN relies on <a href={props.greReferenceURL}>GRE</a> and <a href={props.i
5454
<Render
5555
file="prerequisites/maximum-segment-size"
5656
product="networking-services"
57-
params={{ productName: "Magic WAN" }}
57+
params={{ productName: props.productNameManual }}
5858
/>
5959

6060
#### MSS clamping recommendations

src/content/partials/networking-services/magic-wan/zero-trust/warp.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,8 +97,8 @@ To learn which IP addresses and UDP ports you should exclude to accomplish this,
9797
file="mconn/network-options/app-aware-policies/warp-traffic"
9898
product="networking-services"
9999
params={{
100-
connectorName: "Magic WAN Connector",
101-
mwanName: "Magic WAN",
100+
connectorName: props.mwanConnectorName,
101+
mwanName: props.productName,
102102
warpFirewallURL: "/cloudflare-one/connections/connect-devices/warp/deployment/firewall/"
103103
}}
104104
/>

src/content/partials/networking-services/mconn/configure-connectors.mdx

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,7 @@ You cannot enable high availability for an existing { props.magicWord === "virtu
206206
inline={false}
207207
/>
208208

209-
<Render file="mconn/vlan-tagging" product="networking-services" params={{ url: "[VMware's documentation](https://kb.vmware.com/s/article/1003825)" }}/>
209+
<Render file="mconn/vlan-tagging" product="networking-services" params={{ url: "[VMware's documentation](https://kb.vmware.com/s/article/1003825)", virtualConnectorName: props.productNameVirtual }}/>
210210

211211
<Markdown
212212
text={`
@@ -250,7 +250,7 @@ You cannot enable high availability for an existing { props.magicWord === "virtu
250250
inline={false}
251251
/>
252252

253-
<Render file="mconn/licence-keys" product="networking-services" />
253+
<Render file="mconn/licence-keys" product="networking-services" params={{ virtualConnectorName: props.productNameVirtual }} />
254254

255255
<Markdown
256256
text={`
@@ -282,7 +282,7 @@ You cannot enable high availability for an existing { props.magicWord === "virtu
282282
inline={false}
283283
/>
284284

285-
<Render file="mconn/licence-keys" product="networking-services" />
285+
<Render file="mconn/licence-keys" product="networking-services" params={{ virtualConnectorName: props.productNameVirtual }} />
286286

287287
<Markdown
288288
text={`
@@ -293,7 +293,7 @@ You cannot enable high availability for an existing { props.magicWord === "virtu
293293
inline={false}
294294
/>
295295

296-
<Render file="mconn/vlan-tagging" product="networking-services" params={{ url: "[Proxmox documentation](https://www.proxmox.com/en/products/proxmox-virtual-environment/get-started)" }}/>
296+
<Render file="mconn/vlan-tagging" product="networking-services" params={{ url: "[Proxmox documentation](https://www.proxmox.com/en/products/proxmox-virtual-environment/get-started)", virtualConnectorName: props.productNameVirtual }}/>
297297

298298
<Markdown
299299
text={`
@@ -349,7 +349,7 @@ To add a { props.magicWord === "virtual" ? props.productNameVirtual : props.prod
349349

350350
<Tabs syncKey="dashPlusAPI"> <TabItem label="Dashboard">
351351

352-
<Render file="mconn/wan-two-tunnels" product="networking-services" params={{ productName: "Magic WAN Connector" }} />
352+
<Render file="mconn/wan-two-tunnels" product="networking-services" params={{ productName: props.productName }} />
353353

354354
1. In **WAN configuration**, select **Create**. You can create one or more [wide area networks (WANs)](https://www.cloudflare.com/learning/network-layer/what-is-a-wan/). Configuring multiple WANs will create multiple <GlossaryTooltip term="IPsec tunnel">IPsec</GlossaryTooltip> tunnels (one IPsec tunnel per WAN port). This allows { props.magicWord === "virtual" ? props.productNameVirtual : props.productName } to load balance traffic over WANs of equal priority. It also allows Connector to failover between circuits according to their <GlossaryTooltip term="tunnel health-check" link="/magic-wan/reference/tunnel-health-checks/">health</GlossaryTooltip>. Refer to [WAN settings](/magic-wan/configuration/connector/reference/#wan-settings) for more details.
355355
:::note
@@ -407,7 +407,7 @@ curl https://api.cloudflare.com/client/v4/accounts/{account_id}/magic/sites/{sit
407407
- **Next hop**: The address of the L3 router to which the Connector should forward packets for this subnet.
408408
- **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**. <br /> Refer to [Routed subnets](/magic-wan/configuration/connector/network-options/routed-subnets/) for more information.
409409
8. Select **Save**.
410-
9. Select **Done** to finish your configuration. Tunnels and <GlossaryTooltip term="static route">static routes</GlossaryTooltip> will be automatically created for your Magic WAN Connector, once it boots up.
410+
9. Select **Done** to finish your configuration. Tunnels and <GlossaryTooltip term="static route">static routes</GlossaryTooltip> will be automatically created for your { props.magicWord === "virtual" ? props.productNameVirtual : props.productName }, once it boots up.
411411

412412
</TabItem> <TabItem label="API">
413413

@@ -440,11 +440,11 @@ After setting up your LANs, you can configure your { props.magicWord === "virtua
440440

441441
#### DHCP options
442442

443-
Magic WAN Connector supports different types of DHCP configurations. Connector can:
443+
{ props.magicWord === "virtual" ? props.productNameVirtual : props.productName } supports different types of DHCP configurations. Connector can:
444444

445445
- Connect to a DHCP server or use a static IP address instead of connecting to a DHCP server.
446446
- Act as a <a href={props.dhcpServerURL}>DHCP server</a>.
447-
- Use <a href={props.dhcpRelayURL}>DHCP relay</a> to connect to a DHCP server outside the location your Magic WAN Connector is in.
447+
- Use <a href={props.dhcpRelayURL}>DHCP relay</a> to connect to a DHCP server outside the location your { props.magicWord === "virtual" ? props.productNameVirtual : props.productName } is in.
448448
- <a href={props.reserveIpAddressesURL}>Reserve IP addresses</a> for specific devices on your network.
449449

450450
### Add your Connector to a site
@@ -453,16 +453,16 @@ After finishing your { props.magicWord === "virtual" ? props.productNameVirtual
453453

454454
{ props.magicWord === "hardware" && (
455455
<>
456-
<AnchorHeading title="Set up your Magic WAN Connector" depth={2} />
456+
<AnchorHeading title={`Set up your ${props.productName}`} depth={2} />
457457

458458
<AnchorHeading title="Device installation" depth={3} />
459459
<p>There are several deployment options for {props.productName}. {props.productName} can act like a DHCP server for your local network, or integrate with your local setup and have static IP addresses assigned to it.</p>
460460
<p>When {props.productName} acts like the WAN router for your site, deployment will be something like this:</p>
461461

462462
<pre class="mermaid">
463463
{`flowchart LR
464-
accTitle: Magic WAN Connector set up as a DHCP server, and connecting to the Internet.
465-
a(Magic WAN Connector)--> b(Internet) --> c(Cloudflare)
464+
accTitle: ${props.productName} set up as a DHCP server, and connecting to the Internet.
465+
a(${props.productName})--> b(Internet) --> c(Cloudflare)
466466
467467
subgraph Customer site
468468
d[LAN 1] --> a
@@ -477,8 +477,8 @@ After finishing your { props.magicWord === "virtual" ? props.productNameVirtual
477477

478478
<pre class="mermaid">
479479
{`flowchart LR
480-
accTitle: Magic WAN Connector connects to the router in the site, and only some of the LANs connect to Connector.
481-
a(Magic WAN Connector)--> b((Site's router)) --> c(Internet) --> i(Cloudflare)
480+
accTitle: ${props.productName} connects to the router in the site, and only some of the LANs connect to Connector.
481+
a(${props.productName})--> b((Site's router)) --> c(Internet) --> i(Cloudflare)
482482
483483
subgraph Customer site
484484
d[LAN 1] --> a
@@ -491,7 +491,7 @@ After finishing your { props.magicWord === "virtual" ? props.productNameVirtual
491491
class a,i orange`}
492492
</pre>
493493

494-
<p>Refer to <a href="/reference-architecture/diagrams/sase/magic-wan-connector-deployment/">Magic WAN Connector deployment options</a> for a high-level explanation of the deployment options that make sense to most environments, as well as a few advanced use cases.</p>
494+
<p>Refer to <a href="/reference-architecture/diagrams/sase/magic-wan-connector-deployment/">{props.productName} deployment options</a> for a high-level explanation of the deployment options that make sense to most environments, as well as a few advanced use cases.</p>
495495

496496
<AnchorHeading title="Firewall settings required" depth={4} />
497497
<p>If there is a firewall deployed upstream of the {props.productName}, configure the firewall to allow the following traffic:</p>
@@ -547,7 +547,7 @@ When you are ready to connect your { props.magicWord === "virtual" ? props.produ
547547
2. Go to **Connectors**.
548548
3. Find the Connector you want to activate, select the three dots next to it > **Edit**. Make sure you verify the serial number to choose the right connector you want to activate.
549549
4. In the new window, the **Status** dropdown will show as **Deactivated**. Select it to change the status to **Activated**.
550-
5. The **Interrupt window** is the time period when the Magic WAN Connector software can update, which may result in interruption to existing connections. Choose a time period to minimize disruption to your sites. Refer to [Interrupt window](/magic-wan/configuration/connector/maintenance/interrupt-service-window/) for more details on how to define when the Connector can update its systems.
550+
5. The **Interrupt window** is the time period when the { props.magicWord === "virtual" ? props.productNameVirtual : props.productName } software can update, which may result in interruption to existing connections. Choose a time period to minimize disruption to your sites. Refer to [Interrupt window](/magic-wan/configuration/connector/maintenance/interrupt-service-window/) for more details on how to define when the Connector can update its systems.
551551
6. Select **Update**.
552552

553553
{ props.magicWord === "virtual" && (
@@ -795,9 +795,9 @@ To set up a high availability configuration:
795795

796796
## IPsec tunnels and static routes
797797

798-
Magic WAN Connector automatically creates <a href={props.ipsecTunnelsRefURL}>IPsec tunnels</a> and <a href={props.staticRoutesRefURL}>static routes</a> for you. You cannot configure these manually.
798+
{ props.magicWord === "virtual" ? props.productNameVirtual : props.productName } automatically creates <a href={props.ipsecTunnelsRefURL}>IPsec tunnels</a> and <a href={props.staticRoutesRefURL}>static routes</a> for you. You cannot configure these manually.
799799

800-
To check the IPsec tunnels and static routes created by your Magic WAN Connector:
800+
To check the IPsec tunnels and static routes created by your { props.magicWord === "virtual" ? props.productNameVirtual : props.productName }:
801801

802802
1. In the Cloudflare dashboard, go to the **Sites** page.
803803

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
---
2-
{}
2+
params:
3+
- virtualConnectorName
34
---
45

56

67

78
:::note
8-
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.
9+
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 {props.virtualConnectorName}.
910
:::

src/content/partials/networking-services/mconn/maintenance/default-password.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,6 @@ Your Connector's default password is the serial number (also known as a Service
1313

1414
## Default password to access {props.virtualConnectorName}
1515

16-
Your Virtual Connector's default password is the last seven characters of your license key, all uppercase, plus an `!` (exclamation mark).
16+
Your {props.virtualConnectorName}'s default password is the last seven characters of your license key, all uppercase, plus an `!` (exclamation mark).
1717

1818
For example, if your license key is `mconn-abcdefghijklmnopqrstuvwxyz`, your default password will be `TUVWXYZ!`.

src/content/partials/networking-services/mconn/mconn-reference.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ When a failover occurs, traffic is moved to the new active node. It could take u
9494

9595
This is where you add and configure your WAN connections. Each configured WAN will create one IPsec tunnel, unless you have more than one anycast IP configured in your account.
9696

97-
<Render file="mconn/wan-two-tunnels" product="networking-services" params={{ productName: "Magic WAN Connector" }} />
97+
<Render file="mconn/wan-two-tunnels" product="networking-services" params={{ productName: props.productName }} />
9898

9999
When you have multiple WANs you can attribute different priorities to each one. Lower values mean a higher priority. This translates in {props.productName} routing traffic through the higher priority WANs or, more precisely, over the IPsec tunnels established over that interface. On the other hand, if you configure multiple WANs of equal priority, traffic will be distributed over those links through <a href={props.ecmpRoutingURL}>Equal-Cost Multi-Path (ECMP routing)</a>.
100100

@@ -112,15 +112,15 @@ If you do not have more than one anycast IP configured in your account, and you
112112
### WAN settings
113113

114114
- **Interface number:** When using the hardware version of {props.productName}, this refers to the Ethernet port that you are using for your WAN. If you need a throughput higher than 1 Gbps, you can use one of the SFP+ ports. Refer to <a href={props.sfpURL}>SFP+ port information</a> for more information on the hardware supported. <br /> If you are using {props.virtualProductName}, this needs to correspond to the virtual network interface on the {props.virtualProductName} instance you have set up in VMware.
115-
- **VLAN ID**: Allows you to have multiple virtual WANs configured over the same port on your Magic WAN Connector. Refer to <a href={props.vlanIdURL}>VLAN ID</a> for more information.
115+
- **VLAN ID**: Allows you to have multiple virtual WANs configured over the same port on your {props.productName}. Refer to <a href={props.vlanIdURL}>VLAN ID</a> for more information.
116116
- **Priority**: Assigns a priority to the WAN interface. Lower numbers have higher priority. Refer to <a href={props.trafficSteeringURL}>Traffic steering</a> to learn more about how Cloudflare calculates priorities.
117117
- **Health check rate:** Configures the health check frequency for your WAN. Options are low, mid, and high. Refer to <a href={props.hcFrequencyURL}>Update tunnel health checks frequency</a> for more information.
118118
- **Addressing:** Configures the {props.productName} to work in a DHCP or static IP environment.
119119

120120
## LAN settings
121121

122122
- **Interface number:** When using the hardware version of {props.productName}, this refers to the Ethernet port that you are using for your LAN. If you need a throughput higher than 1 Gbps, you can use one of the SFP+ ports. Refer to <a href={props.sfpURL}>SFP+ port information</a> for more information on the hardware supported. <br /> If you are using the {props.virtualProductName}, this needs to correspond to the virtual LAN interface on the {props.virtualProductName} instance you have set up in VMware.
123-
- **VLAN ID**: Allows you to have multiple virtual LANs configured over the same port on your Magic WAN Connector. Refer to <a href={props.vlanIdURL}>VLAN ID</a> for more information.
123+
- **VLAN ID**: Allows you to have multiple virtual LANs configured over the same port on your {props.productName}. Refer to <a href={props.vlanIdURL}>VLAN ID</a> for more information.
124124
- **Static addressing:** Configures the type of IP addressing for your Connector. Depending on your use case, this is where you configure your LAN interface IP address, or enable DHCP server or DHCP relay. Refer to <a href={props.dhcpURL}>DHCP options</a> to learn more.
125125
- **Static NAT prefix**: Enable NAT (network address translation). This is an optional setting.
126126
- **Routed subnets:** Configures additional subnets behind a layer 3 router. Refer to <a href={props.routedSubnetsURL}>Routed subnets</a> for more information.

src/content/partials/networking-services/mconn/network-options/app-aware-policies/breakout-prioritized.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ params:
55
- featureName
66
- trafficSteeringURL?
77
- whatHappensApp
8+
- mwanName
89
---
910

1011
import { APIRequest, Aside, AnchorHeading, CURL, Markdown, Render, TabItem, Tabs } from "~/components";
@@ -228,8 +229,8 @@ You need to delete {props.featureName} applications for each of your existing si
228229
file="mconn/network-options/app-aware-policies/warp-traffic"
229230
product="networking-services"
230231
params={{
231-
connectorName: "Magic WAN Connector",
232-
mwanName: "Magic WAN",
232+
connectorName: props.productName,
233+
mwanName: props.mwanName,
233234
warpFirewallURL: "/cloudflare-one/connections/connect-devices/warp/deployment/firewall/"
234235
}}
235236
/>

0 commit comments

Comments
 (0)