Skip to content

Commit 438a357

Browse files
committed
feat(interlink): continue doc
1 parent 19a77dd commit 438a357

File tree

9 files changed

+183
-26
lines changed

9 files changed

+183
-26
lines changed
19.8 KB
Loading

network/interlink/how-to/complete-provisioning.mdx

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,14 +37,17 @@ After ordering the InterLink from Scaleway, you **must** contact your chosen par
3737

3838
4. Click **Contact partner**. You are directed either to the partner's online portal, or else to the email address for contacting the partner. Use the relevant method to contact your partner, provide the pairing key, and request that they provision your InterLink from their side.
3939

40+
<Message type="tip">
41+
You can also use the [Get a partner](https://www.scaleway.com/en/developers/api/interlink/#path-partners-get-a-partner) endpoint in the API to get contact details and other information about your selected partner.
42+
</Message>
43+
4044
Your InterLink will remain in `Requested` status until the partner responds to your request.
4145

4246
## Wait for partner to accept InterLink request
4347

4448
Once you have requested the InterLink from your partner, you must wait for them to respond to your request. There is no further action for you to take at this point.
4549

4650
TODO EXPLAIN HOW TO FOLLOW THE STATUSES/WHERE CAN THEY SEE IT
47-
TODO MACRO?
4851

4952
When the partner approves your request, the InterLink moves to `Provisioning` status. This means that the partner has agreed to facilitate your InterLink, and is now preparing the resources and configuration necessary to establish the physical connection.
5053

@@ -59,8 +62,13 @@ If your InterLink does not move to `Provisioning` status, you may see one of the
5962

6063
## Partner provisions InterLink
6164

62-
TODO MACRO?
63-
6465
When the partner has finished provisioning your InterLink, it moves to `Active` status. This indicates that the physical link and necessary accompanying configuration has been completed on the partner's side, and your InterLink is ready for use. TODO WHERE CAN USER SEE STATUS?
6566

66-
You must still configure your InterLink by attaching it to a VPC, attaching an allowed routes list, and activating route propagation, before traffic can flow over the InterLink. For help with these steps, see our documentation on [How to configure your InterLink](/network/interlink/reference-content/configuring/).
67+
You must still configure your InterLink by attaching it to a VPC, attaching an allowed routes list, and activating route propagation, before traffic can flow over the InterLink. For help with these steps, see our documentation on [How to configure your InterLink](/network/interlink/reference-content/configuring/).
68+
69+
<Message type="important">
70+
If you see a `Limited connectivity` status, this indicates that the partner provisioned your InterLink, but either IPv4 or IPv6 connectivity is down. Similarly, a `Down` status indicates the InterLink is provisioned, but both IPv4 **and** IPv6 connectivity are down. Open a Scaleway support ticket, or contact your partner for assistance.
71+
72+
A `Locked` status indicates, again, that the InterLink was provisioned, but Scaleway Trust and Safety have locked the resource. No actions are possible from you as a user: you should open a support ticket for help and information.
73+
</Message>
74+

network/interlink/how-to/configure-interlink.mdx

Lines changed: 62 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,13 +57,29 @@ Attaching an InterLink to a VPC allows you to complete the connection from your
5757

5858
To enable traffic to flow across the InterLink, you must still create and attach an Allowed Routes list, and activate route propagation.
5959

60-
## How to create and attach an Allowed Routes list
60+
## How to attach an Allowed Routes list
6161

6262
After attaching a VPC, the next step in configuring your InterLink is to create and attach an Allowed Routes list.
6363

64-
The VPC and the external infrastructure's routers both announce their routes to each other when route propagation is activated, but all of these routes are blocked by default. Allowed Routes lists let you whitelist ranges of route announcements to allow, so that traffic can flow along these routes across the InterLink.
64+
The VPC and the external infrastructure's routers both announce their routes to each other via BGP TODO ADD TO CONCEPTS when route propagation is activated, but all of these routes are blocked by default. Allowed Routes lists let you whitelist ranges of route announcements to allow, so that traffic can flow along these routes across the InterLink.
6565

66-
See the dedicated documentation on [creating and attaching an Allowed Routes list](/network/interlink/how-to/create-allowed-routes-list/) for a step by step guide.
66+
Each InterLink can have one allowed routes list attached to it, but a single allowed routes list can be attached to multiple InterLinks, if desired.
67+
68+
See the dedicated documentation on [creating an Allowed Routes list](/network/interlink/how-to/create-allowed-routes-list/) to create a list, then follow these instructions to attach it:
69+
70+
1. Click **InterLink** in the **Network** section of the [Scaleway console](https://console.scaleway.com) side menu. A listing of your InterLinks displays.
71+
72+
2. Click on the InterLink that you want to configure. The InterLink's **Overview** page displays.
73+
74+
3. In the **Route propagation** section, click **Attach allowed routes list**. A pop-up displays.
75+
76+
4. Select an allowed routes list from the drop-down menu, and click **Attach list**.
77+
78+
<Message type="tip">
79+
Make sure that the allowed routes list is suitable for the incoming routes (announced by the Scaleway VPC) and outgoing routes (announced by the external infrastructure) that should be propagated on this InterLink.
80+
</Message>
81+
82+
The list is attached, ad you are returned to the InterLink's **Overview** page.
6783

6884
## How to activate route propagation
6985

@@ -133,12 +149,55 @@ It is not possible to modify settings that were defined at the time of creating
133149

134150
### How to change the attached Allowed Routes list
135151

152+
1. Click **InterLink** in the **Network** section of the [Scaleway console](https://console.scaleway.com) side menu. A listing of your InterLinks displays.
153+
154+
2. Click on the InterLink that you want to configure. The InterLink's **Overview** page displays.
155+
156+
3. In the **Route propagation** section, click the three dot icon <Icon name="more" /> next to the Allowed routes list you want to detach. Then click **Detach list** in the menu that displays.
157+
158+
A pop-up confirms that this action will detach the current list from your InterLink. If route propagation was active, it will be automatically deactivated because with no attached Allowed Routes list, the default rule will block the propagation of any new or updated routes.
159+
160+
4. Click **Detach list**.
161+
162+
The list is detached, and you are returned to your InterLink's Overview page.
163+
164+
5. In the **Route propagation** section, under **Allowed routes list** click **+** to add a new list. See the dedicated documentation on [creating and attaching an Allowed Routes list](/network/interlink/how-to/create-allowed-routes-list/) for a step by step guide.
165+
136166
### How to edit an existing Allowed Routes list
137167

168+
1. Click **InterLink** in the **Network** section of the [Scaleway console](https://console.scaleway.com) side menu. A listing of your InterLinks displays.
169+
170+
2. Click on the InterLink that you want to configure. The InterLink's **Overview** page displays.
171+
172+
3. In the **Route propagation** section, click the three dot icon <Icon name="more" /> next to the Allowed routes list. Then click **Edit list** in the menu that displays.
173+
174+
<Message type="tip">
175+
You can also edit Allowed Routes lists from their [dedicated tab in the console](TODO-link), including lists that aren't currently attached to an InterLink.
176+
</Message>
177+
178+
The **Edit Allowed Routes List** wizard displays. See the dedicated documentation on [creating and attaching an Allowed Routes list](/network/interlink/how-to/create-allowed-routes-list/) for help with Allowed Routes lists.
179+
180+
4. Make the required edits, and click **Edit allowed routes list**
181+
182+
A warning displays, to remind you that modifications will immediately be propagated on InterLinks using this list.
183+
184+
5. Click **Save**.
185+
186+
The list is modified and modifications are immediately applied.
187+
138188
### How to deactivate route propagation
139189

190+
1. Click **InterLink** in the **Network** section of the [Scaleway console](https://console.scaleway.com) side menu. A listing of your InterLinks displays.
191+
192+
2. Click on the InterLink that you want to configure. The InterLink's **Overview** page displays.
193+
194+
3. In the **Route propagation** section, use the toggle <Icon name="toggle" /> to turn route propagation **OFF**.
195+
196+
A pop-up displays, confirming that this action will turn off route propagation. All existing InterLink routes will be removed from the VPC route table. Traffic will not be able to flow over the InterLink until route propagation is reactivated.
140197

198+
4. Click **Deactivate**.
141199

200+
Route propagation is deactivated, and you are returned to your InterLink's overview page.
142201

143202

144203

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
meta:
3+
title: How to create an Allowed Routes list
4+
description: Find out how to create an Allowed Routes list for your Scaleway InterLink. Whitelist incoming and outgoing route announcements, so that traffic can flow securely over your InterLink.
5+
content:
6+
h1: How to create an Allowed Routes list
7+
paragraph: Find out how to create an Allowed Routes list for your Scaleway InterLink. Whitelist incoming and outgoing route announcements, so that traffic can flow securely over your InterLink.
8+
dates:
9+
validation: 2024-12-09
10+
posted: 2024-12-09
11+
tags: interlink direct-connect allowed-routes route-propagation whitelist range IP announcements BGP
12+
categories:
13+
- network
14+
---
15+
16+
InterLink uses [**B**order **G**ateway **P**rotocol](https://en.wikipedia.org/wiki/Border_Gateway_Protocol) to exchange routing information between the customer’s infrastructure and the Scaleway VPC. Each side advertises IP prefixes for its own internal subnets and resources, to allow the other side to dynamically learn and update its internal routes, facilitating efficient traffic flow. However, by default, **all routes across an InterLink are blocked**. You must create and attach an [allowed routes list](/network/interlink/concepts/#allowed-routes-list) aka routing policy, to set IP prefix filters for the route advertisements you want to whitelist. This facilitates traffic flow across the InterLink.
17+
18+
When creating an allowed routes list, you specify one or many IP ranges representing the outgoing routes to announce from the Scaleway VPC, and one or many IP ranges representing the incoming route announcements to accept from the external infrastructure. When [route propagation](#route-propagation) is activated, the route ranges defined in the allowed routes list are whitelisted, and traffic can flow across the InterLink along these routes. [Learn more about routing across an InterLink](/network/interlink/reference-content/overview/#routing-across-an-interLink)
19+
20+
You may also know allowed routes lists under the terms "routing policy", or "route filters".
21+
22+
## How to create an allowed routes list
23+
24+
1. Click **InterLink** in the **Network** section of the [Scaleway console](https://console.scaleway.com) side menu. A listing of your InterLinks displays.
25+
26+
2. Click the **Allowed routes** tab. A listing of your allowed routes list displays.
27+
28+
3. Click **+Create allowed routes list**. The **Create an Allowed Routes List** wizard displays.
29+
30+
<Lightbox src="scaleway-create-allowed-routes.webp" alt="In the Scaleway console, the Create an Allowed Routes List wizard is displayed. There are 3 steps: 1. Choose a name and region, 2. Whitelist outgoing routes and 3. Whitelist incoming routes" />
31+
32+
4. Enter a name for the list, or leave the randomly-generated name in place.
33+
34+
5. Choose a region for the list. It can only be attached to InterLinks within the same region.
35+
36+
6. Whitelist the outgoing routes to allow. For each entry you want to add:
37+
- Select whether it is of type IPv4 or IPv6.
38+
- Enter an IP prefix to define a range of route announcements to whitelist, e.g. `172.16.4.0/22`.
39+
- Click **Add** after each entry.
40+
41+
<Message type="tip">
42+
Routes within these destinations will be propagated, allowing traffic from your external infrastructure to be routed via InterLink to your VPC. For example, adding `172.16.4.0/22` whitelists all 1,024 IPs in this block, from `172.16.4.0` to `172.16.7.255`.
43+
44+
You can add up to TODO entries in the list. IPv4 and IPv6 routes must be defined separately. The order of the entries in the list has no material impact TODO check.
45+
</Message>
46+
47+
7. Whitelist the incoming routes to allow, in the same way you did for outgoing routes. Outgoing routes concern announcements to accept from the external infrastructure. Traffic can be routed via InterLink from your Scaleway VPC to your external infrastructure along these routes.
48+
49+
8. Click **Create allowed routes list**.
50+
The list is created, and you are returned to the listing of your allowed routes lists.
51+
52+
Remember to [attach the list to an InterLink](/network/interlink/how-to/configure-interlink/#how-to-attach-an-allowed-routes-list) for it to take effect. Each InterLink can have one allowed routes list attached to it, but a single allowed routes list can be attached to multiple InterLinks, if desired.
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
meta:
3+
title: How to delete an InterLink
4+
description: Learn how to delete a Scaleway InterLink so that it is correctly deprovisioned on both the Scaleway side and the partner side. Follow our step by step guide.
5+
content:
6+
h1: How to delete an InterLink
7+
paragraph: Learn how to delete a Scaleway InterLink so that it is correctly deprovisioned on both the Scaleway side and the partner side. Follow our step by step guide.
8+
dates:
9+
validation: 2024-12-09
10+
posted: 2024-12-09
11+
tags: interlink direct-connect allowed-routes route-propagation whitelist range IP announcements BGP
12+
categories:
13+
- network
14+
---
15+
16+
You can delete your InterLink at any time. Action is required on both the Scaleway side and the partner side to completely deprovision the InterLink. Follow the steps below.
17+
18+
## How to delete an InterLink
19+
20+
1. Click **InterLink** in the **Network** section of the [Scaleway console](https://console.scaleway.com) side menu. A listing of your InterLinks displays.
21+
22+
2. Click on the InterLink that you want to DELETE. The InterLink's **Overview** page displays.
23+
24+
3. [Deactivate route propagation](/network/interlink/how-to/configure-interlink/#how-to-deactivate-route-propagation).
25+
26+
4. In the **Delete InterLink** panel, click **Delete InterLink**.
27+
28+
A pop-up displays, confirming that this action will permanently delete your InterLink on the Scaleway side.
29+
30+
5. Type **DELETE** in the box, and click **Delete InterLink**.
31+
32+
You are returned to the InterLink's **Overview** page, where it's status now shows as **Deprovisioning**. Scaleway stops billing you for your InterLink at this point, and it can no longer be configured, un-deleted, or used to route traffic.
33+
34+
6. Contact your partner to request that they delete the InterLink resource on their side. They may continue to bill you until you do so, and they deprovision the resource on their side. To get in touch with the partner, you can use the same contact information that you used when [requesting the InterLink from the partner](/network/interlink/how-to/complete-provisioning/).
35+
36+
<Message type="note">
37+
If the provisioning of your InterLink by the partner was never completed, e.g. you a) never contacted the partner to request provisioning of the InterLink, or b) the partner refused to provision your InterLink, you do not need to contact the partner again to request that they deprovision the resource. Deleting it on the Scaleway side is sufficient.
38+
</Message>
39+
40+
When the InterLink is fully deprovisioned on both sides, it will be deleted from the list of your InterLinks, and its Overview page will no longer be accessible.

network/interlink/how-to/order-interlink.mdx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,13 @@ This guide takes you through the process of ordering an InterLink via the Scalew
5252

5353
10. Click **Order InterLink**.
5454

55-
Your InterLink is ordered. **You must now contact your chosen partner to request they provision your InterLink from their end.**
55+
Your InterLink is ordered, and its status briefly shows as `Configuring`, then `Requested`. **You must now contact your chosen partner to request they provision your InterLink from their end.**
5656

5757
<Lightbox src="scaleway-interlink-ordering.webp" alt="A four step flow chart shows the following steps: 1. User orders InterLink via Scaleway, 2. User requests InterLink from partner, 3. Partner accepts InterLink request, 4. Partner provisions InterLink." />
5858

5959
For full details of the provisioning process, including how to contact your partner and what other steps you need to take, see the page [How to complete InterLink provisioning](/network/interlink/how-to/complete-provisioning/).
6060

61+
<Message type="important">
62+
If you see a `Failed` status, it means there was a configuration error on the Scaleway side as we attempted to create the InterLink. Our technical team is automatically made aware of such a problem, and will intervene to resolve it. When the problem is resolved, the InterLink should automatically move to `Requested` status, and you can proceed to [completing provisioning](/network/interlink/how-to/complete-provisioning/).. If you have any concerns, open a support ticket.
63+
</Message>
64+

0 commit comments

Comments
 (0)