Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,13 @@ This tutorial starts by documenting the steps to create a Legacy Tunnel with Clo

In both modes, the first step is to create a load balancer and endpoint pool.

1. Go to **Traffic** > **Load Balancing**.
1. Go to **Load Balancing** and select **Create load balancer**.

2. Select **Create Load Balancer**.
2. On the **Load Balancer Setup**, select **Public load balancer**

3. On the **Hostname** page:
3. Choose the website to which you want to add this load balancer.

4. On the **Hostname** page:
- Enter a **Hostname**, which is the DNS name at which the load balancer is available. For more details on record priority, refer to [DNS records for load balancing](/load-balancing/load-balancers/dns-records/).
- Toggle the orange cloud icon to update the [proxy mode](/load-balancing/understand-basics/proxy-modes/), which affects how traffic is routed and which IP addresses are advertised.
- If you want [session-based load balancing](/load-balancing/understand-basics/session-affinity/), toggle the **Session Affinity** switch.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ Create and manage [Load Balancing rules](/load-balancing/additional-options/load

## Example Workflow

1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com) and select an account and application.
2. Go to **Traffic** > **Load Balancing**.
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com) and select an account.
2. Go to **Load Balancing**.
3. Edit an existing load balancer or [create a new load balancer](/load-balancing/load-balancers/create-load-balancer/).
4. From the Load Balancer workflow, select **Custom Rules**.
5. Select **Create Custom Rule**.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import { Render } from "~/components"

As with [WAF custom rules](/waf/custom-rules/), each load balancing custom rule is a combination of two elements: an [expression](/load-balancing/additional-options/load-balancing-rules/expressions/) and an [action](/load-balancing/additional-options/load-balancing-rules/actions/). Expressions define the criteria for an HTTP request to trigger an action. The action tells Cloudflare how to handle the request.

You can [create Load Balancing rules](/load-balancing/additional-options/load-balancing-rules/create-rules/) whenever you create or edit a load balancer in **Traffic** > **Load Balancing**.
You can [create Load Balancing rules](/load-balancing/additional-options/load-balancing-rules/create-rules/) whenever you create or edit a load balancer in **Load Balancing**.

When building expressions for Load Balancing rules, refer to [Supported fields and operators](/load-balancing/additional-options/load-balancing-rules/reference/) for definitions and usage.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,10 @@ Configure load shedding via the [dashboard](#configure-via-dashboard) or the [AP

To enable load shedding for a specific pool via the dashboard:

1. Go to **Traffic** > **Load Balancing**.
2. Click **Manage Pools**.
3. On a pool, click **Edit**.
4. Click the **Configure Load Shedding** dropdown.
1. Go to **Load Balancing**.
2. Select the **Pools** tab.
3. On a pool, select **Edit**.
4. Open the **Configure Load Shedding** dropdown.
5. For **Default traffic**, select a **Policy** and a **Shed %**:


Expand Down
18 changes: 10 additions & 8 deletions src/content/docs/load-balancing/additional-options/spectrum.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,13 @@ The exact settings will vary depending on your use case. Refer to the following

1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login) and select an account where the Load Balancing add-on is [enabled](/load-balancing/get-started/enable-load-balancing/).

2. Go to **Traffic** > **Load Balancing**.
2. Go to **Load Balancing** and select **Create load balancer**.

3. Select **Create Load Balancer**.
3. On the **Load Balancer Setup**, select **Public load balancer**

4. On the **Hostname** page, define the settings presented and select **Next**.
4. Choose the website to which you want to add this load balancer.

5. On the **Hostname** page, define the settings presented and select **Next**.
* Enter a **Hostname**, which is the DNS name at which the load balancer is available. For more details on record priority, refer to [DNS records for load balancing](/load-balancing/load-balancers/dns-records/).
:::caution

Expand All @@ -38,19 +40,19 @@ The exact settings will vary depending on your use case. Refer to the following
* Keep the orange cloud icon enabled, meaning the load balancer is proxied. This refers to the [proxy mode](/load-balancing/understand-basics/proxy-modes/) and, with Spectrum, traffic is always proxied.
* Keep **Session Affinity** and **Failover across pools** disabled as these features are not supported with Spectrum.

5. On the **Add a Pool** page, define the settings presented and select **Next**.
6. On the **Add a Pool** page, define the settings presented and select **Next**.
* Select one or more existing pools or [create a new pool](/load-balancing/pools/create-pool/#create-a-pool) [^1].
* If needed, update the [fallback pool](/load-balancing/understand-basics/health-details/#fallback-pools) [^2].

6. On the **Monitors** page, define the settings presented and select **Next**.
7. On the **Monitors** page, define the settings presented and select **Next**.
* Review the monitors attached to your pools.
* If needed, you can attach an existing monitor or [create a new monitor](/load-balancing/monitors/create-monitor/#create-a-monitor).

7. On the **Traffic Steering** page, choose an option for [Traffic steering](/load-balancing/understand-basics/traffic-steering/steering-policies/) and select **Next**.
8. On the **Traffic Steering** page, choose an option for [Traffic steering](/load-balancing/understand-basics/traffic-steering/steering-policies/) and select **Next**.

8. Keep **Custom Rules** page empty as this feature is not supported with Spectrum.
9. Keep **Custom Rules** page empty as this feature is not supported with Spectrum.

9. On the **Review** page:
10. On the **Review** page:
* Review your configuration and make any changes.
* If you set traffic steering to **Off**, re-order the pools in your load balancer to adjust the fallback order.
* If you chose to set traffic steering to Random, you can [set weights to your pools](/load-balancing/understand-basics/traffic-steering/steering-policies/standard-options/#random-steering) (via the [API](/api/resources/load_balancers/methods/create/)) to determine the percentage of traffic sent to each pool.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ Load balancing is an add-on for your account, meaning your account needs a [bill

To enable [Load Balancing](https://dash.cloudflare.com/?to=/:account/:zone/traffic/load-balancing):

1. Log in to your [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account and domain.
2. Go to **Traffic** > **Load Balancing**.
3. Select **Enable Load Balancing**.
1. Log in to your [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account.
2. Go to **Load Balancing**.
3. Select **Enable Load Balancing** in the **Status** column.
4. Choose your plan options and confirm payment.

<Render file="non-contract-enablement" product="fundamentals" />
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,10 @@ Sharing load balancers across sites is only supported if the target zone is on a

To edit a load balancer in the dashboard:

1. Go to **Traffic** > **Load Balancing**.
2. On a specific load balancer, click **Edit**.
1. Go to **Load Balancing**.
2. On a specific load balancer, select **Edit**.
3. While going through the [creation workflow](#create-a-load-balancer), update settings as needed.
4. On the **Review** step, click **Save**.
4. On the **Review** step, select **Save**.

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

Expand All @@ -68,7 +68,7 @@ If you delete or disable a load balancer, your endpoint's response to requests w

To delete a load balancer in the dashboard:

1. Go to **Traffic** > **Load Balancing**.
1. Go to **Load Balancing**.
2. On a specific load balancer, click **Delete**.

</TabItem> <TabItem label="API">
Expand Down
12 changes: 6 additions & 6 deletions src/content/docs/load-balancing/monitors/create-monitor.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@ For more details about monitors, refer to [Monitors](/load-balancing/monitors/).

Once your monitor is created, you need to attach it to a pool:

1. Go to **Traffic** > **Load Balancing**.
1. Go to **Load Balancing**.

2. Select **Manage Pools**.
2. Select the **Pools** tab.

3. On a specific pool, select **Edit**.

Expand Down Expand Up @@ -69,8 +69,8 @@ Once your monitor is created, save its `id` property. Include this value in the

To edit a monitor in the dashboard:

1. Go to **Traffic** > **Load Balancing**.
2. Select **Manage Monitors**.
1. Go to **Load Balancing**.
2. Select **Monitors**.
3. On a specific monitor, select **Edit**.
4. Update settings as needed.
5. Select **Save**.
Expand All @@ -91,8 +91,8 @@ To update specific settings without having to resubmit the entire configuration,

To delete a monitor in the dashboard:

1. Go to **Traffic** > **Load Balancing**.
2. Select **Manage Monitors**.
1. Go to **Load Balancing**.
2. Select the **Monitors** tab.
3. On a specific monitor, select **Delete**.

</TabItem> <TabItem label="API">
Expand Down
20 changes: 10 additions & 10 deletions src/content/docs/load-balancing/pools/cloudflare-pages-origin.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,9 @@ Although you can create all the components in the **Create Load Balancer** workf

Monitors define the criteria based on which an endpoint will be considered healthy or not. Start by setting up a monitor as follows.

1. Log in to your Cloudflare account and select your domain.
2. Go to **Traffic** > **Load Balancing**.
3. Select **Manage Monitors** and then **Create**.
1. Log in to your Cloudflare account.
2. Go to **Load Balancing**.
3. Select the **Monitors** tab and then **Create monitor**.
4. Give the monitor a descriptive name and confirm the other fields are filled in as the following:


Expand Down Expand Up @@ -84,9 +84,9 @@ The endpoint pointing to [Cloudflare Pages](/pages/) must have **host header** f
Failing to add the host header will result in [response code mismatch error](/load-balancing/troubleshooting/common-error-codes/#response-code-mismatch-error) for the monitor, and [Error 1000: DNS points to prohibited IP](/support/troubleshooting/http-status-codes/cloudflare-1xxx-errors/error-1000/) for visitors (if the load balancer is enabled despite the unhealthy monitor status).
:::

1. Go to **Traffic** > **Load Balancing**.
1. Go to **Load Balancing**.

2. Select **Manage Pools** and then **Create**.
2. Select the **Pools** tab and then **Create monitor**.

3. For the first pool, start by filling out the fields:

Expand Down Expand Up @@ -145,7 +145,7 @@ Failing to add the host header will result in [response code mismatch error](/lo

Before setting up the load balancer:

1. Go to **Traffic** > **Load Balancing** > **Manage Pools**.
1. Go to **Load Balancing** > **Pools** tab.
2. Find the pools you created in the list and check if their status is `Healthy`. You might have to refresh the page.
3. Expand each pool entry to confirm that the health status for endpoints within them is also `Healthy`.

Expand All @@ -159,7 +159,7 @@ Revise your pools and monitor configurations to confirm they followed the instru

After confirming the endpoints and monitors are set up correctly and return the expected health status, create the load balancer:

1. Go to **Traffic** > **Load Balancing** > **Create Load Balancer**.
1. Go to **Load Balancing** > **Create load balancer**.

2. On the **Hostname** page, configure the following and select **Next**.
* Enter a **Hostname**, which is the DNS name at which the load balancer is available. Suggestion: for now, you can just add a temporary hostname such as `lb` (so the complete field value would look like `lb.<your_domain>`).
Expand All @@ -179,16 +179,16 @@ After confirming the endpoints and monitors are set up correctly and return the

7. On the **Review** page, review your configuration and select **Save as Draft**.

A DNS record of the type `LB` will be created under [**DNS** > **Records**](https://dash.cloudflare.com/?to=/:account/:zone/dns/records) with the hostname you have defined, and a corresponding load balancer will be added to [**Traffic** > **Load Balancing** > **Manage Load Balancers**](https://dash.cloudflare.com/?to=/:account/:zone/traffic/load-balancing)
A DNS record of the type `LB` will be created under [**DNS** > **Records**](https://dash.cloudflare.com/?to=/:account/:zone/dns/records) with the hostname you have defined, and a corresponding load balancer will be added to [**Load Balancing**](https://dash.cloudflare.com/?to=/:account/load-balancing)

## Optional - Deploy on a test hostname



If you have used a temporary hostname for your load balancer, follow the steps below to deploy and test it.

1. Go to **Traffic** > **Load Balancing**.
2. In the **Manage Load Balancers** list, locate the load balancer you created under a test hostname (such as `lb`) and enable it.
1. Go to **Load Balancing**.
2. In the **Load Balancers** list, locate the load balancer you created under a test hostname (such as `lb`) and enable it.
3. On your browser, request the temporary hostname (`lb.example.com`). You should see the website or application hosted at your primary origin server.
4. Go back to the **Manage Load Balancers** list, select to expand the test load balancer, and disable the primary pool.
5. On a new incognito window of your browser, request the temporary hostname once again. You should see the website or application hosted at your secondary origin server this time.
Expand Down
14 changes: 7 additions & 7 deletions src/content/docs/load-balancing/pools/create-pool.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,11 +50,11 @@ For more background information on pools, refer to [Pools](/load-balancing/pools

To edit a pool in the dashboard:

1. Go to **Traffic** > **Load Balancing**.
2. Click **Manage Pools**.
3. On a specific pool, click **Edit**.
1. Go to **Load Balancing**.
2. Select the **Pools** tab.
3. On a specific pool, select **Edit**.
4. Update settings as needed.
5. Click **Save**.
5. Select **Save**.

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

Expand All @@ -81,9 +81,9 @@ If the pool is referenced by geo steering, the configuration is **not** automati

To delete a pool in the dashboard:

1. Go to **Traffic** > **Load Balancing**.
2. Click **Manage Pools**.
3. On a specific pool, click **Delete**.
1. Go to **Load Balancing**.
2. Select the **Pools** tab.
3. On a specific pool, select **Delete**.

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,10 +65,10 @@ curl "https://api.cloudflare.com/client/v4/accounts/{account_id}/load_balancers/
To find pools with existing notifications in the dashboard:

1. Log into the [Cloudflare dashboard](https://dash.cloudflare.com) and select your account and domain.
2. Go to **Traffic** > **Load Balancing**.
3. Click **Manage Pools**.
4. On a pool, click **Edit**.
5. For **Health Monitor Notifications**, check the value is toggled to **On** and an email address is present in the **Notification email address** field.
2. Go to **Load Balancing**.
3. Select the **Pools** tab.
4. On a pool, select **Edit**.
5. For **Health Check Notifications**, check the value is toggled to **On** and an email address is present in the **Notification email address** field.


</Details>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ When there are no healthy endpoints in the same pool, failover across pools exte

### Enable failover across pools

1. Log in to [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account and domain.
2. Select **Traffic** > **Load Balancing**.
1. Log in to [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account.
2. Select **Load Balancing**.
3. Navigate to your Load Balancers and select **Edit**.
4. From **Adaptive Routing**, enable **Failover across pools**.
4 changes: 2 additions & 2 deletions src/content/partials/load-balancing/confirm-pool-health.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ Before directing any traffic to your pools, make sure that your pools and monito

To confirm pool health using the dashboard:

1. Go to **Traffic** > **Load Balancing**.
2. Select **Manage Pools**.
1. Go to **Load Balancing**.
2. Select the **Pools** tab.
3. For pools and individual endpoints, review the values in the **Health** and **Endpoint Health** columns.

For more information on pool and endpoint health statuses, refer to [How a pool becomes unhealthy](/load-balancing/understand-basics/health-details/#how-a-pool-becomes-unhealthy).
Expand Down
8 changes: 4 additions & 4 deletions src/content/partials/load-balancing/monitor-create.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@

import { Render } from "~/components"

You can create a monitor within the [load balancer workflow](/load-balancing/load-balancers/create-load-balancer/) or in the **Monitors** section of the dashboard:
You can create a monitor within the [load balancer workflow](/load-balancing/load-balancers/create-load-balancer/) or in the **Monitors** tab:

1. Go to **Traffic** > **Load Balancing**.
1. Go to **Load Balancing**.

2. Select **Manage Monitors**.
2. Select the **Monitors** tab.

3. Select **Create**.
3. Select **Create monitor**.

4. Add the following information: <Render file="monitor-settings-basic" product="load-balancing" />

Expand Down
6 changes: 3 additions & 3 deletions src/content/partials/load-balancing/pool-create.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@

import { Render } from "~/components"

You can create a pool within the [load balancer workflow](/load-balancing/load-balancers/create-load-balancer/) or in the **Pools** section of the dashboard:
You can create a pool within the [load balancer workflow](/load-balancing/load-balancers/create-load-balancer/) or in the **Pools** tab:

1. Go to **Traffic** > **Load Balancing**.
1. Go to **Load Balancing**.

2. Select **Manage Pools** and then **Create**.
2. Select the **Pools** tab and then **Create pool**.

3. For your pool, enter the following information:
* A name (must be unique)
Expand Down