Skip to content

Commit

Permalink
fix(interlink): add links
Browse files Browse the repository at this point in the history
  • Loading branch information
RoRoJ committed Oct 30, 2024
1 parent 0960af7 commit b96746f
Show file tree
Hide file tree
Showing 12 changed files with 192 additions and 57 deletions.
6 changes: 5 additions & 1 deletion network/interlink/concepts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ categories:
- networks
---

<Message type="important">
InterLink is currently in [Private Beta](https://www.scaleway.com/en/betas/), and only available to selected testers.
</Message>

## Allowed routes list

The default rule blocks any and all routes from being propagated over InterLink. Attaching an allowed routes list (aka **routing policy**) allows you to define the ranges of routes that should be whitelisted. 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.
Expand All @@ -34,7 +38,7 @@ Every InterLink has a defined bandwidth, representing the maximum data transfer

## InterLink

InterLink is Scaleway's product to let you create a secure, private connection between your external infrastructure, and your Scaleway VPC. This allows you to direct your traffic safely from your Scaleway infrastructure to your on-premises infrastructure, away from the public internet.
InterLink, currently in Private Beta, is Scaleway's product to let you create a secure, private connection between your external infrastructure, and your Scaleway VPC. This allows you to direct your traffic safely from your Scaleway infrastructure to your on-premises infrastructure, away from the public internet.

Currently, InterLink is available in **hosted** version only. This means that you must choose a compatible [partner](#partner) to facilitate the physical connection between the external infrastructure and the Scaleway VPC. The physical connection may be shared between several clients, each allocated a specific amount of bandwidth for their InterLink.

Expand Down
9 changes: 0 additions & 9 deletions network/interlink/how-to/index.mdx

This file was deleted.

15 changes: 0 additions & 15 deletions network/interlink/how-to/order-interlink.mdx

This file was deleted.

23 changes: 8 additions & 15 deletions network/interlink/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,13 @@ meta:
noindex: true
---

<Alert
sentiment="info"
title="InterLink is now in Private Beta"
>
InterLink is currently available in [Private Beta](https://www.scaleway.com/en/betas/) only, for selected testers.
</Alert>

<ProductHeader
productName="InterLink"
productLogo="interlink"
Expand All @@ -16,31 +23,17 @@ meta:
## Getting Started

<Grid>
<SummaryCard
title="Quickstart"
icon="rocket"
description="Learn how to get started with InterLink."
label="View Quickstart"
url="/network/interlink/quickstart/"
/>
<SummaryCard
title="Concepts"
icon="info"
description="Core concepts that give you a better understanding of InterLink."
label="View Concepts"
url="/network/interlink/concepts/"
/>
<SummaryCard
title="How-tos"
icon="help-circle-outline"
description="Check our guides to creating and configuring an InterLink."
label="View How-tos"
url="/network/interlink/how-to/"
/>
<SummaryCard
title="Additional Content"
icon="book-open-outline"
description="Go beyond the basics with detailed, in-depth guides to configuring InterLink."
description="Read our in-depth guides to provisioning and configuring your InterLink."
label="Read more"
url="/network/interlink/reference-content/"
/>
Expand Down
17 changes: 0 additions & 17 deletions network/interlink/quickstart.mdx

This file was deleted.

Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
66 changes: 66 additions & 0 deletions network/interlink/reference-content/configuring.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
---
meta:
title: Configuring an InterLink
description: Find out how to set up your Scaleway InterLink so that traffic can flow between your external infrastructure and your Scaleway resources. Understand how to attach a VPC, create an allowed routes list to whitelist route announcements, and activate route propagation across the connection.
noindex: true
content:
h1: Configuring an InterLink
paragraph: Find out how to set up your Scaleway InterLink so that traffic can flow between your external infrastructure and your Scaleway resources. Understand how to attach a VPC, create an allowed routes list to whitelist route announcements, and activate route propagation across the connection.
tags: interlink configuration attach-vpc whitelist route-range ip-prefix route-propagation
categories:
- interlink
- network
dates:
validation: 2024-10-24
posted: 2024-10-24
---

<Message type="important">
InterLink is currently in [Private Beta](https://www.scaleway.com/en/betas/), and only available to selected testers.
</Message>

Once your InterLink has been created and the [provisioning process](/network/interlink/reference-content/provisioning/) is complete, you must complete a number of configuration steps to enable traffic to flow across the InterLink.

This document explains the process in full, and gives tips for troubleshooting any potential issues.

## Configuration overview

<Lightbox src="scaleway-interlink-config.webp" alt="A four step flow chart shows the following steps: 1. Create InterLink, 2. Attach VPC, 3. Attach allowed routes list, 4. Activate route propagation. After these steps are complete, traffic can flow across the InterLink" />

The diagram above shows the four configuration steps necessary for an InterLink. Only when all steps have been completed can traffic flow across the InterLink, connecting the Scaleway VPC to the external (on-premises) infrastructure.

Read more about each step, and possible errors at each stage, in the following sections.

### 1. Create the InterLink

Creating an InterLink is itself a multi-step process, that requires action on both the Scaleway side, and on the partner side. This process is explained in full in [Provisioning an InterLink](/network/interlink/reference-content/provisioning/).

You must wait until the InterLink has reached `Active` [status](/network/interlink/reference-content/statuses/) before you can continue with the following configuration steps.

### 2. Attach VPC

Attaching an InterLink to a VPC allows you to complete the connection from your external infrastructure, across the InterLink, to the Scaleway resources in the selected VPC.
z
The VPC must be in the same region region as the InterLink. An InterLink can only be attached to one VPC at a time, but you are free to detach the VPC and attach a different one whenever you like.

You can use the [Attach a VPC](https://www.scaleway.com/en/developers/api/interlink/v1beta1/#path-links-attach-a-vpc) endpoint to attach a VPC to a given InterLink.

### 3. Attach allowed routes list (routing policy)

By default, all routes across an InterLink are blocked by default. 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 routes you want to whitelist. This facilitates traffic flow across the InterLink.

You can [create](https://www.scaleway.com/en/developers/api/interlink/v1beta1/#path-routing-policies-create-a-routing-policy) and [attach](https://www.scaleway.com/en/developers/api/interlink/v1beta1/#path-links-attach-a-routing-policy) allowed routes lists via the API.

When setting the route ranges to whitelist, you must separately define the IP prefixes to accept from the external infrastructure (incoming ranges of route announcements to accept), and the IP prefix filters to advertise from the Scaleway VPC to the peer (outgoing ranges of routes to advertise). 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`.

Only one allowed routes list (routing policy) can be attached to an InterLink at a given time. However, you can reuse the same list by attaching it to multiple InterLinks, for example if you have a second InterLink attached to the same VPC/external infrastructure for redundance purposes. You can update, delete or reattach a list at any time.

### 4. Activate route propagation.

Once you have attached a VPC and defined the routing policy/allowed routes, you must [activate route propagation](https://www.scaleway.com/en/developers/api/interlink/v1beta1/#path-links-enable-route-propagation) to allow traffic to flow over the InterLink. This enables all prefixes whitelisted in your allowed routes list / routing policy to be announced in the BGP session, so that traffic can flow along these routes.

<Message type="important">
Even when route propagation is activated, remember that all routes are blocked by default. It is essential to attach a routing policy (aka allowed routes list) to the InterLink to allow traffic to flow.
</Message>

You can deactivate route propagation via the dedicated endpoint at any time. When you do this, all routes are blocked and removed from the VPC's route table. No traffic can flow across the InterLink until route propagation is reactivated.
109 changes: 109 additions & 0 deletions network/interlink/reference-content/provisioning.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
---
meta:
title: Provisioning an InterLink
description: Get help with understanding all the different stages of ordering and provisioning a Scaleway InterLink, from placing the initial order, to dealing with error messages, and deleting the resource if no longer needed.
noindex: true
content:
h1: Provisioning an InterLink
paragraph: Get help with understanding all the different stages of ordering and provisioning a Scaleway InterLink, from placing the initial order, to dealing with error messages, and deleting the resource if no longer needed.
tags: interlink provision order steps partner process error
categories:
- interlink
- network
dates:
validation: 2024-10-24
posted: 2024-10-24
---

<Message type="important">
InterLink is currently in [Private Beta](https://www.scaleway.com/en/betas/), and only available to selected testers.
</Message>

The process of ordering an InterLink has multiple stages: action is required both from Scaleway, the user, and from the selected [partner](/network/interlink/concepts/#partner).

This document explains the process in full, so you know what to expect when ordering an InterLink, what action is required from all parties, and how to deal with any potential errors.

## Provisioning overview

<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." />

The diagram above shows the four steps necessary to provision an InterLink. Only when all steps have been completed will the InterLink move to an **Active** status, ready for traffic to flow. Read more about each step, and possible errors at each stage, in the following sections.

For full information about different statuses an InterLink might flow through, see our [dedicated documentation on InterLink statuses](/network/interlink/reference-content/statuses/).

### 1. User orders InterLink via Scaleway

The order process begins when you order an InterLink via the Scaleway [InterLink API](https://www.scaleway.com/en/developers/api/interlink/) (or, coming soon, via the [Scaleway console](https://console.scaleway.com/) or one of our other [developer tools](https://www.scaleway.com/en/developers/)). To order via the API, use the [Create a link](https://www.scaleway.com/en/developers/api/interlink/v1beta1/#path-links-create-a-link) call. You need to set the following parameters when ordering:

- **Connection type**: In the long term, dedicated, shared and hosted InterLinks will be available. For now, only **hosted** connections (facilitated via a partner) are available.
- **Partner**: The third-party service provider to facilitate the InterLink. Use the [List available partners](https://www.scaleway.com/en/developers/api/interlink/v1beta1/#path-partners-list-available-partners) call to find available partners.
- **Region**: The region in which to create the InterLink. It must correspond to the region of the Scaleway VPC you want to later attach to the InterLink.
- **Location**: The physical **P**oint **o**f **P**resence (PoP) where the connection to Scaleway's network will be established, via the partner.
- **Bandwidth**: The maximum bandwidth which you want to be available over the InterLink.
- **Name**: A name (and, optionally, tags) for the InterLink.

<Message type="tip">
Scaleway starts charging for the InterLink as soon as your order is placed. You must then wait for the partner to provision the connection, and they may charge you additional fees.
</Message>

After placing the order via the API, the ID of the InterLink is returned in the response. You can use this ID to [check the status of your InterLink](https://www.scaleway.com/en/developers/api/interlink/v1beta1/#path-links-get-a-link) at any time.

Immediately after ordering, it is expected that your InterLInk will briefly be in `Configuring` status, before moving to `Requested` status.

<Message type="important">
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. If you have any concerns, open a support ticket.
</Message>

### 2. User requests InterLink from partner

After ordering the InterLink from Scaleway, you **must** contact your chosen partner to request that they provision the connection on their side. Scaleway is not able to automatically do this step for you.

Use the [Get a partner](https://www.scaleway.com/en/developers/api/interlink/v1beta1/#path-partners-get-a-partner) endpoint to get information about your selected partner. Each partner provides either a contact email address, and/or the URL of their online portal. You should make contact with your partner via one of these channels.

TODO INFO ABOUT PAIRING KEY

Your InterLink will remain in `Requested` status until the partner responds to your request.

### 3. Partner accepts InterLink request

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.

Your InterLink will remain in `Provisioning` status until this process has been completed.

<Message type="important">
If your InterLink does not move to `Provisioning` status, you may see one of the following statuses:

- `Refused`: The partner did not agree to provision your InterLink. Delete this InterLink resource, and contact your partner for more information. Consider re-ordering with a different partner.
- `Expired`: Your InterLink order timed out: after 10 working days, no response was received from the selected partner. Delete the InterLink resource, and create a new order if you wish to try again.
</Message>

### 4. Partner provisions InterLink

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.

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 [configuring your InterLink](/network/interlink/reference-content/configuring/).

<Message type="important">
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.

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.
</Message>

## Deprovisioning overview

When you no longer want your InterLink connection, you can delete it. The process is as follows:

1. Deactivate route propagation.
2. [Delete your InterLink on the Scaleway side](https://www.scaleway.com/en/developers/api/interlink/v1beta1/#path-links-delete-a-link). InterLink status moves to `Deprovisioning`.
3. Contact your partner to request they provision the InterLink resource on their side.
4. InterLink moves to `Deleted` status once the partner has completed deprovisioning.

Scaleway stops billing you for your InterLink immediately after step 2. Your partner may continue to bill you until they deprovision the resource on their side.

<Message type="note">
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.
</Message>




4 changes: 4 additions & 0 deletions network/interlink/reference-content/statuses.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ dates:
posted: 2024-10-24
---

<Message type="important">
InterLink is currently in [Private Beta](https://www.scaleway.com/en/betas/), and only available to selected testers.
</Message>

An InterLink always has a **status**, which can be retrieved via the API using the [Get a link](https://scaleway-developers-production-internal.s3-website.fr-par.internal.scaleway.com/en/developers/api/interlink/v1beta1/#path-links-get-a-link) call.

This document explains the different statuses possible for an InterLink, and how to understand them.
Expand Down

0 comments on commit b96746f

Please sign in to comment.