Skip to content

Commit 87c5526

Browse files
[BYOIP] Revised get-started (#22388)
* Placeholder page for new get-started and temp hide old one * Switch order between delegation and mapping steps * List API endpoints for LOA upload and prefix creation * Add footnotes on service bindings and address maps * Link ROA and IRRs to previous section for context * Review BGP step and link to most recent API * Delete temp version and update get-started * Remove section on Cloudflare IPs * Apply suggestions from code review Co-authored-by: Pedro Sousa <[email protected]> * Keep LOA capitalization consistent with target page --------- Co-authored-by: Pedro Sousa <[email protected]>
1 parent 5fe3d39 commit 87c5526

File tree

1 file changed

+19
-27
lines changed

1 file changed

+19
-27
lines changed

src/content/docs/byoip/get-started.mdx

Lines changed: 19 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -3,46 +3,38 @@ title: Get started
33
pcx_content_type: get-started
44
sidebar:
55
order: 2
6-
76
---
87

9-
import { GlossaryTooltip } from "~/components"
8+
import { GlossaryTooltip } from "~/components";
9+
10+
Work with your account team to understand everything you need to ensure a smooth transition during the onboarding process.
1011

11-
To bring your own IPs, you must work with your account team to understand everything you need to ensure a smooth transition during the onboarding process.
12+
Cloudflare requires a service-specific configuration for your prefixes, as well as some requirements common to all BYOIP customers regardless of service type.
1213

13-
Cloudflare requires a service-specific configuration for your prefixes, as well as some requirements common to all BYOIP customers regardless of service type. These requirements are common to all products compatible with BYOIP, such as [Magic Transit](/magic-transit/), [Spectrum](/spectrum/), and [CDN services](/cache/).
14+
## Requirements
1415

15-
## Prerequisites
16+
The following requirements are common to all products compatible with BYOIP.
1617

17-
There are two major prerequisites before Cloudflare can begin onboarding your IP space.
18+
You must verify that your [Internet Routing Registry (IRR)](/byoip/concepts/irr-entries/) records are up to date and contain:
1819

19-
1. Cloudflare must receive a [Letter of Agency (LOA)](/byoip/concepts/loa/) to announce your prefixes, which we will share with our transit partners as evidence that we are allowed to announce the route.
20-
2. You must verify that your [Internet Routing Registry (IRR)](/byoip/concepts/irr-entries/) records are up to date and contain:
2120
- `route` or `route6` objects matching the exact prefixes you want to onboard
2221
- `origin` matching the correct ASN you want to onboard
2322

2423
:::caution[RPKI validation]
25-
You are not required to use <GlossaryTooltip term="Resource Public Key Infrastructure (RPKI)">Resource Public Key Infrastructure (RPKI)</GlossaryTooltip>. However, if you do, make sure your <GlossaryTooltip term="Route Origin Authorization (ROA)">ROAs</GlossaryTooltip> are accurate. You can use [Cloudflare's RPKI Portal](https://rpki.cloudflare.com/?view=validator) and a second source such as [Routinator](https://rpki-validator.ripe.net/ui/) to double check your prefixes.
24+
You are not required to use <GlossaryTooltip term="Resource Public Key Infrastructure (RPKI)">Resource Public Key Infrastructure (RPKI)</GlossaryTooltip>. However, if you do, make sure your <GlossaryTooltip term="Route Origin Authorization (ROA)">ROAs</GlossaryTooltip> are accurate. You can use [Cloudflare's RPKI Portal](https://rpki.cloudflare.com/?view=validator) and a second source such as [Routinator](https://rpki-validator.ripe.net/ui/) to double-check your prefixes.
2625
:::
2726

28-
After onboarding, [Border Gateway Protocol (BGP)](https://www.cloudflare.com/learning/security/glossary/what-is-bgp/) announcements for customer prefixes can be controlled with the [Dynamic Advertisement](/byoip/concepts/dynamic-advertisement/) API or via the Cloudflare dashboard.
29-
30-
## Cloudflare IPs
31-
32-
If you are unable to bring your own IP to Cloudflare, you can use an IP address issued by Cloudflare.
27+
## Process overview
3328

34-
Using a Cloudflare IP may be a good option if you:
29+
Overall, the steps can be summarized as follows:
3530

36-
* Have one or a few IPs allocated from home or business class ISPs.
37-
* Are an online streamer who could be the target of a DoS attack if your IP is leaked.
38-
* Are a business owner with a small number of locations with broadband Internet connections.
39-
* Do not own an IP space with a /24 prefix length.
40-
* Maintain a large number of locations with a combination of connectivity methods.
41-
* Own an IP space with a /24 prefix length but do not advertise prefixes from every location.
31+
1. You revise your [IRRs and ROAs](#requirements) (if applicable) to make sure they are correct.
32+
2. You prepare a [Letter of Agency (LOA)](/byoip/concepts/loa/) containing both the prefix you are authorizing Cloudflare to announce and which ASN they will be announced under. Cloudflare will present this to our transit partners as evidence that we are allowed to announce the route.
33+
3. You use the [Upload LOA Document](/api/resources/addressing/subresources/loa_documents/methods/create/) API endpoint to submit the letter under your account and the [Add Prefix](/api/resources/addressing/subresources/prefixes/methods/create/) endpoint to create the prefix in your account with the associated `loa_document_id`.
34+
4. After receiving the LOA, Cloudflare validates the [requirements](#requirements) and provisions the IPs.
35+
5. (Optional) You can use [prefix delegations](/byoip/concepts/prefix-delegations/) to share all or part of your prefix with another Cloudflare account.
36+
6. You use [service bindings](/byoip/service-bindings/)[^1] and [address maps](/byoip/address-maps/)[^2] to control how your IPs are used.
37+
7. You advertise or withdraw the BGP route for a prefix via the [BGP Prefixes API](/api/resources/addressing/subresources/prefixes/subresources/bgp_prefixes/).
4238

43-
To protect your network using a Cloudflare IP address, contact your account manager.
44-
45-
:::note
46-
47-
When you use a Cloudflare-managed IP space, you do not need to provide a Letter of Agency (LOA) and advertise your prefixes that are associated with bringing your own IP.
48-
:::
39+
[^1]: Mappings that control through which pipeline traffic destined for a given IP address will be routed.
40+
[^2]: Mappings that specify which IP addresses should be used when Cloudflare responds to DNS queries for proxied hostnames.

0 commit comments

Comments
 (0)