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
24 changes: 0 additions & 24 deletions products/byoip/src/content/about/index.md

This file was deleted.

26 changes: 0 additions & 26 deletions products/byoip/src/content/api/index.md

This file was deleted.

53 changes: 53 additions & 0 deletions products/byoip/src/content/dynamic-advertisement/best-practices.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
order: 2
---

# Best practices

--------

## Verify User Roles & Obtain Prefix IDs

To ensure smooth operation in general and simplify the advertisement process during an attack scenario, complete the following tasks:

* **Assign appropriate user roles.** Ensure that users assigned to manage the status of IP prefix advertisement have the Administrator or Super Administrator role in your Cloudflare account. For instructions, see [_Setting up Multi-user accounts on Cloudflare_](https://support.cloudflare.com/hc/en-us/articles/205065067-Setting-up-Multi-User-accounts-on-Cloudflare#12345682).

* **Get a list of the Prefix IDs you want to manage.** Maintaining a list of Cloudflare IDs for each prefix simplifies management via the Cloudflare API, since most dynamic advertisement operations require them.

To obtain Prefix IDs, go your Cloudflare account home page and review [_Get Prefix IDs_](/api/configure-prefixes#get-prefix-ids), or use the [List Prefixes](https://api.cloudflare.com/#ip-address-management-prefixes-list-prefixes) operation in the Cloudflare API. Refer to these Prefix IDs when managing prefix advertisement.

--------

## Enable prefix advertisement

<Aside>

Be sure to enable prefix advertisement with Cloudflare before you withdraw the advertisement from your data center.

Withdrawing the advertisement from your data center without first enabling it with Cloudflare can result in dropped traffic, since that traffic will not have access to a valid route.

</Aside>

To avoid latency and the possibility of dropped routes, enable prefix advertisement from Cloudflare **before** you withdraw the advertisement from your data center, as outlined in these steps:

1. To enable prefix advertisement, [use the IP Prefixes page](/api/configure-prefixes#use-the-ip-prefixes-page-to-configure-dynamic-advertisement) in your Cloudflare account home or use the [Update Prefix Dynamic Advertisement Status](https://api.cloudflare.com/#ip-address-management-dynamic-advertisement-get-advertisement-status) operation in the Cloudflare API. This operation requires your Account ID, Prefix IDs, and API key. (For instructions, see [_Get Prefix IDs_](/api/configure-prefixes#get-prefix-ids).)

Enablement takes 2–7 minutes.

2. Verify the advertisement using looking glass of your choice—[Hurricane Electric Internet Services](https://lg.he.net/), for example. Use the Cloudflare ASN (13335) to track the advertisement route.

3. Remove the prefix advertisement that originates from your data center.

--------

## Disable prefix advertisement

To disable (withdraw) prefix advertisement, reverse the steps you used to enable it:

1. Add the prefix advertisement to your data center.

2. [Optional] Verify the advertisement using a looking glass of your choice—[Hurricane Electric Internet Services](https://lg.he.net/), for example.

3. To disable prefix advertisement at Cloudflare’s edge, see the [IP Prefixes page](/api/configure-prefixes#use-the-ip-prefixes-page-to-configure-dynamic-advertisement) in your Cloudflare account home or use the [Update Prefix Dynamic Advertisement Status](https://api.cloudflare.com/#ip-address-management-dynamic-advertisement-get-advertisement-status) operation in the Cloudflare API. This operation requires your Account ID, Prefix IDs, and API key. (For instructions, see [_Get Prefix IDs_](/api/configure-prefixes#get-prefix-ids)

Disablement takes approximately 15 minutes.
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
---
order: 3
---

# Configure dynamic advertisement

<Aside>

To ensure smooth operation in general and simplify the advertisement process during an attack scenario, refer to [_Best practices_](/api/best-practices) when managing dynamic advertisement.

</Aside>

--------

## Use the IP Prefixes page to configure dynamic advertisement

To configure IP prefix assignment from your Cloudflare account home, use the **Status** drop-down list in the **IP Prefixes** dialog, as outlined in these steps:

1. Log in to your Cloudflare accounts **Home** page and click **IP Prefixes**.

![account home](../static/dashboard-home-ip-prefixes.png)

The **IP Prefixes** page displays.

2. To edit a prefix, click the **Edit** link associated with the entry.

![ip-prefixes-list](../static/ip-prefixes-page.png)

The **Edit IP Prefixes** dialog displays.

![ip prefixes dialog](../static/dashboard-dynamic-advertisement.png)

1. To configure prefix advertisement, select the _Advertised_ or _Withdrawn_ option from the **Status** drop-down list.

![status drop-down list](../static/dynamic-advertisement-status-drop-down.png)

4. Click **Save** to commit your changes.

Once you have committed your changes, it takes 2–7 minutes to enable advertisement and approximately 15 minutes to disable (withdraw) advertisement.

--------

## Use the Cloudflare API to configure dynamic advertisement

To configure prefix advertisement with the Cloudflare API, use the [IP Address Management and Dynamic Advertisement](https://api.cloudflare.com/#ip-address-management-dynamic-advertisement-properties) API.

Most dynamic advertisement operations require that you supply the Cloudflare ID for any prefix you want to access with the Cloudflare API. The following section outlines how to obtain Prefix IDs.

--------

## Get Prefix IDs

You can obtain Prefix IDs from the **IP Prefixes** page in your Cloudflare account home or via the [List Prefixes](https://api.cloudflare.com/#ip-address-management-prefixes-list-prefixes) operation in the Cloudflare API.

To obtain Prefix IDs from the **IP Prefixes** page, follow these steps:

1. Click the expander widget associated with the entry for which you want to obtain the Prefix ID.

![prefix-detail-expander](../static/ip-prefixes-expander.png)

The prefix details display.

2. To obtain the Prefix ID, refer to the **API Tag** value. To add the value to your clipboard, click **Copy**.

![prefix details view](../static/ip-prefix-details-view.png)
19 changes: 19 additions & 0 deletions products/byoip/src/content/dynamic-advertisement/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
order: 2
---

# Dynamic Advertisement

To configure BGP advertisement at the Cloudflare edge, [use the Cloudflare API](/api/configure-prefixes#use-the-cloudflare-api-to-configure-dynamic-advertisement) or [use the IP Prefixes page](/api/configure-prefixes#use-the-ip-prefixes-page-to-configure-dynamic-advertisement) in your Cloudflare account home.

When using the API, you can authorize a call with your email and API key, or create a [service token](https://support.cloudflare.com/hc/en-us/articles/200167836-Managing-API-Tokens-and-Keys) for this purpose.

A successful API response indicates the service registered the request. It typically takes 2–7 minutes to enable advertising and approximately 15 minutes to disable it.

Both the API and Cloudflare UI support prefix delegations, which allow other Cloudflare accounts to interact with your prefix. The effect of a delegation is service specific. For details, see [Prefix Delegations](/delegations).

<Aside>

To ensure smooth operation in general and simplify the advertisement process during an attack scenario, refer to [_Best practices_](/api/best-practices) when managing dynamic advertisement.

</Aside>
27 changes: 27 additions & 0 deletions products/byoip/src/content/getting-started/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
order: 1
---

# Getting Started

--------

## Bringing Your Own IPs to Cloudflare

BYOIP is compatible with Magic Transit, Spectrum, and CDN services.

To bring your own IPs (BYOIP) with Cloudflare, you must go through an onboarding process. Work with your account team to understand everything you need to ensure a smooth transition.

At a high level, Cloudflare requires a service-specific configuration for your prefixes, as well as some requirements that are common to all BYOIP customers, regardless of service type. This documentation covers the requirements common to all products that are compatible with BYOIP (i.e. Magic Transit, CDN, and Spectrum).

There are two major prerequisites before Cloudflare can begin the work of onboarding your IP space.

First, all customers must ensure their [Internet Routing Registry (IRR)](/irr) records are up to date with the correct prefix/ASN information.

Secondly, Cloudflare must receive a [Letter of Authorization](/loa) to announce your prefixes, which we will share with our transit partners as evidence that we are allowed to announce the route.

Optionally, if you use the RPKI protocol to sign your routes, Cloudflare can support you there as well. Just let your account team know if you’re interested in using RPKI!

Please see the subsequent sections to learn more.

Once onboarded, BGP announcements for customer prefixes can be controlled with the [Dynamic Advertisement API](/api). This API has other useful features and can also be used via the Cloudflare dashboard.
7 changes: 5 additions & 2 deletions products/byoip/src/content/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
---
title: Welcome
order: 0
---

# Welcome
# Cloudflare BYOIP documentation

TODO...
With BYOIP, Cloudflare announces your IPs in all our locations. Use your IPs with Magic Transit, Spectrum, or CDN services.

<p><Link to="/getting-started" className="Button Button-is-docs-primary">Get started</Link></p>
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
order: 6
---

# Best practices for IRR entry updates

To add or update an IRR entry, use one of the routing registries listed in the [Internet Routing Registry](http://www.irr.net/index.html).

Suggested registries are AFRINIC, APNIC, ARIN, NTT, RADB, and RIPE.

--------

## Best practices

When updating IRR entries, use these best practices:

* If you own your own subnet, use the RIPE and APNIC routing registries. These registries allow you to verify subnet ownership.
* If you lease your subnet, follow these guidelines:
* When you do not need ownership verification, use the AFRINIC or NTT routing registry.
* When you submit a route object via email, use the ARIN registry. Note that address blocks owned by others do not appear in the ARIN interface.

### IRR Entry instructions

Each routing registry has its own set of IRR entry instructions. This table provides links to those instructions:

<table>
<thead>
<tr>
<th>Route registry</th>
<th>URL</th>
</tr>
</thead>
<tbody style="vertical-align:top">
<tr>
<td>AFRINIC</td>
<td><a href="https://afrinic.net/internet-routing-registry#guide">https://afrinic.net/internet-routing-registry#guide</a></td>
</tr>
<tr>
<td>APNIC</td>
<td><a href="https://www.apnic.net/manage-ip/apnic-services/routing-registry/">https://www.apnic.net/manage-ip/apnic-services/routing-registry/</a></td>
</tr>
<tr>
<td>ARIN</td>
<td><a href="https://www.arin.net/resources/manage/irr/quickstart/">https://www.arin.net/resources/manage/irr/quickstart/</a></td>
</tr>
<tr>
<td>NTT</td>
<td><a href="https://www.gin.ntt.net/support-center/policies-procedures/routing-registry/">https://www.gin.ntt.net/support-center/policies-procedures/routing-registry/</a></td>
</tr>
<tr>
<td>RADB</td>
<td><a href="https://www.radb.net/faq">https://www.radb.net/faq</a></td>
</tr>
<tr>
<td>RIPE</td>
<td><a href="https://www.ripe.net/manage-ips-and-asns/db/support/managing-route-objects-in-the-irr">https://www.ripe.net/manage-ips-and-asns/db/support/managing-route-objects-in-the-irr</a></td>
</tr>
</tbody>
</table>
15 changes: 15 additions & 0 deletions products/byoip/src/content/irr-records/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
order: 1
---

# IRR Records

The [Internet Routing Registry (IRR)](http://www.irr.net/index.html) is a globally distributed database of routing information. The IRR contains announced routes and routing policy in a common format. Network operators use this information to configure their backbone routers.

The IRR consists of many individual [routing registries](http://www.irr.net/docs/list.html), some managed by regional entities, such as APNIC, ARIN, and RIPE. Each routing registry contains IRR entries that provide information about IP prefixes and the [autonomous systems](https://www.cloudflare.com/learning/network-layer/what-is-an-autonomous-system/) that are authorized to announce them.

To announce your subnet prefixes, Cloudflare requires accurate IRR entries for your prefixes and autonomous system numbers (ASNs).

When you configure network infrastructure for services such as [Magic Transit](https://developers.cloudflare.com/magic-transit/about), [verify your IRR entries](/irr/verify-irr-entries).

When you add missing IRR entries or update inaccurate ones, use these [best practices](/irr/best-practices-for-irr-entry-updates).
Loading