Skip to content

Commit e0164a8

Browse files
Use h3s and horizontal lines for better skimmability
1 parent 3522e53 commit e0164a8

File tree

1 file changed

+25
-8
lines changed

1 file changed

+25
-8
lines changed

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

Lines changed: 25 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sidebar:
55
order: 2
66
---
77

8-
import { APIRequest, Tabs, TabItem } from "~/components";
8+
import { APIRequest, Tabs, TabItem, GlossaryDefinition } from "~/components";
99

1010
Work with your account team to make sure your contract covers everything you need to onboard your prefix. Cloudflare requires service-specific configurations, as well as some requirements common to all BYOIP customers.
1111

@@ -34,9 +34,13 @@ Once your account configurations are in place, consider the sections below to le
3434

3535
- If you are not familiar with how Cloudflare API works, refer to [Fundamentals](/fundamentals/api/). Make sure you have the necessary permissions and that you have your account ID.
3636

37+
---
38+
3739
## 1. Set up your prefixes
3840

39-
1. Use the [Add Prefix endpoint](/api/resources/addressing/subresources/prefixes/methods/create/) to create a prefix in the Cloudflare account that should own the BYOIP prefix.
41+
### Add your prefix
42+
43+
Use the [Add Prefix endpoint](/api/resources/addressing/subresources/prefixes/methods/create/) to create a prefix in the Cloudflare account that should own the BYOIP prefix.
4044

4145
```bash
4246
curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/addressing/prefixes \
@@ -76,7 +80,10 @@ curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/addressing/prefix
7680
```
7781
7882
2. Take note of the `id` assigned to the prefix you added. It will be used in future steps.
79-
3. Validate prefix ownership using one of the following methods:
83+
84+
### Validate prefix ownership
85+
86+
Validate prefix ownership using one of the following methods:
8087
8188
<Tabs> <TabItem label="Modify IRR record">
8289
@@ -116,7 +123,7 @@ Once the ownership validation is successful, you can remove the token.
116123
117124
When all validations pass - RPKI, IRR, and ownership - the `approved` field in your prefix will return `"V"`. This means you can proceed to create IP address service bindings[^1].
118125
119-
3. (Optional) Use the [Prefix Details endpoint](/api/resources/addressing/subresources/prefixes/methods/get/) to check if any issues were found during validation. If so, proceed with the necessary changes and make a request to restart validation.
126+
If needed, you can use the [Prefix Details endpoint](/api/resources/addressing/subresources/prefixes/methods/get/) to check if any issues were found during validation. If so, proceed with the necessary changes and make a request to restart validation.
120127
<APIRequest path= "/accounts/{account_id}/addressing/prefixes/{prefix_id}" method="GET" />
121128
122129
(WIP - Add response example (collapsable))
@@ -125,7 +132,9 @@ When all validations pass - RPKI, IRR, and ownership - the `approved` field in y
125132
126133
(WIP - Clarify criteria for IRR check + further info like schedule and limits?)
127134
128-
4. (Optional) You can allow other accounts to use part or all of your BYOIP prefix. Refer to [Prefix delegations](/byoip/concepts/prefix-delegations/) for details.
135+
### (Optional) Delegate your BYOIP prefixes
136+
137+
You can allow other accounts to use part or all of your BYOIP prefix. Refer to [Prefix delegations](/byoip/concepts/prefix-delegations/) for details.
129138
130139
<APIRequest
131140
path="/accounts/{account_id}/addressing/prefixes/{prefix_id}/delegations"
@@ -140,7 +149,13 @@ json={{
140149
Although you can delegate IPs to other accounts, the IP address service bindings are still created and managed on the parent account - meaning the Cloudflare account where you added the prefix in step 1.
141150
:::
142151
143-
## 2. Create a default service binding
152+
---
153+
154+
## 2. Create service bindings
155+
156+
In IP address management, service bindings map the traffic destined for a given IP address to the Cloudflare service that it should be routed through.
157+
158+
### Default service binding
144159
145160
When you onboard your IP prefixes to Cloudflare, there must be one service binding that spans across your entire prefix. Traffic destined for a given IP address will be routed to this service by default. You can also configure [additional service bindings](#optional-additional-bindings) as described in the next step.
146161
@@ -169,10 +184,10 @@ For Magic Transit customers, the BGP prefix will be created in a `locked` state.
169184
170185
### (Optional) Additional bindings
171186
172-
If you want to selectively route traffic on a per-IP address basis to CDN or Spectrum, you can create additional service bindings.
187+
If you want to selectively route traffic on a per-IP address basis to CDN or Spectrum, you can create additional service bindings. Magic Transit can only be used as default binding, spanning across your entire prefix.
173188
174189
:::note
175-
The steps below only cover assigning specific IPs to additional services. For guidance that includes CDN or Spectrum setup steps, refer to [Service bindings](https://developers.cloudflare.com/byoip/service-bindings/).
190+
The steps below only cover assigning specific IPs to additional services. For guidance that includes CDN or Spectrum setup steps, refer to [Service bindings](/byoip/service-bindings/).
176191
:::
177192
178193
1. Plan for what IP(s) will get the additional binding. Cloudflare **strongly** recommends implementing service bindings through an **aggregated** CIDR block, as it is more efficient than adding discrete bindings for non-contiguous CIDR blocks.
@@ -206,6 +221,8 @@ In the response body, the initial provisioning state should be `provisioning`.
206221
207222
Once a service binding is created (or deleted), it will take **four to six hours** to propagate across Cloudflare's global network.
208223

224+
---
225+
209226
## 3. Advertise the BGP prefix
210227

211228
Once created, BGP prefixes are initially withdrawn. After all your configurations are in place - including address maps[^2] if you will use CDN service -, proceed to advertise the BGP route for your prefix.

0 commit comments

Comments
 (0)