diff --git a/network/interlink/assets/scaleway-interlink-diag-simple.webp b/network/interlink/assets/scaleway-interlink-diag-simple.webp new file mode 100644 index 0000000000..ac3bf704c3 Binary files /dev/null and b/network/interlink/assets/scaleway-interlink-diag-simple.webp differ diff --git a/network/interlink/concepts.mdx b/network/interlink/concepts.mdx new file mode 100644 index 0000000000..b5b18c2a82 --- /dev/null +++ b/network/interlink/concepts.mdx @@ -0,0 +1,78 @@ +--- +meta: + title: InterLink - Concepts + description: Understand Scaleway InterLink terminology with our glossary of the core concepts underpinning this product. Learn about key features, architecture, and workflows. + noindex: true +content: + h1: InterLink - Concepts + paragraph: Understand Scaleway InterLink terminology with our glossary of the core concepts underpinning this product. Learn about key features, architecture, and workflows. +tags: interlink direct-connect dedicated connection +dates: + creation: 2024-10-31 + validation: 2024-10-31 +categories: + - networks +--- + + +InterLink is currently in [Private Beta](https://www.scaleway.com/en/betas/), and only available to selected testers. + + +## 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. + +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. 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) + +You may also know allowed routes lists under the terms "routing policy", or "route filters". + +## Attached VPC + +Each InterLink can be attached to one Scaleway VPC. The InterLink and the VPC must be in the same [region](#region). You can detach the InterLink from the VPC at any time, and attach it to a different VPC in the same region, if you wish. When an InterLink is not attached to any VPC, no traffic can flow. + +## Bandwidth + +Every InterLink has a defined bandwidth, representing the maximum data transfer rate possible over the connection. Measured in megabits per second (Mbps) or gigabits per second (Gbps), it shows how much data can be transmitted over InterLink per second. + +## InterLink + +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. + + + +For more information on how InterLink works, see our [detailed overview](/network/ipam/reference-content/overview/). + +## Location + +A location, aka a **P**oint **o**f **P**resence (PoP), is a physical location where you can establish an InterLink connection between your on-premises infrastructure and the Scaleway network. Locations are facilitated by partners. + +## Pairing key + +A pairing key is a unique identifier used to establish and authenticate an InterLink connection. It is provided by Scaleway once an InterLink order is made. You must then share this key with your selected partner to facilitate the setup of the physical link. The pairing ley ensures that the correct endpoints are securely connected. + +## Partner + +A partner is a third party service provider that facilitates a hosted InterLink connection between a client's on-premises infrastructure, and their Scaleway infrastructure. Current partners include [Free Pro](https://pro.free.fr/), with more coming soon. + +Partners are generally companies specialized in data transit, with their own fibers at data connection points. To establish an InterLink connection via a partner, generally you must be client of that partner, e.g. with your infrastructure in their datacenter, or on your own premises using the partner as a network provider. See our information on [hosted InterLinks](/network/interlink/reference-content/overview/#hosted-interlinks) for more information. + +## PoP + +See [Location](#location) + +## Region + +When creating an InterLink, you must specify a [region](/network/vpc/concepts/#region-and-availability-zone) for the resource. The region sets the scope for the Scaleway infrastructure that can be connected via the InterLink: it must correspond to the region of the VPC to attach to the InterLink. + +## Route propagation + +Route propagation can be activated or deactivated at any given time on an InterLink. When activated, the Scaleway VPC and external infrastructure dynamically exchange and update information about their routes. Route propagation must be activated to allow traffic to flow over the InterLink. When deactivated, all pre-learned/announced routes are removed from the VPC's route table, and traffic cannot flow. Note that even with route propagation activated, the default rule blocks all route announcements: you must use an [allowed routes list](#allowed-routes-list) to specify the route ranges to whitelist. [Learn more about routing across an InterLink](/network/interlink/reference-content/overview/#routing-across-an-interLink) + +## Routing policy + +See [Allowed routes list](#allowed-routes-list). + + + diff --git a/network/interlink/index.mdx b/network/interlink/index.mdx new file mode 100644 index 0000000000..b52b540cc3 --- /dev/null +++ b/network/interlink/index.mdx @@ -0,0 +1,55 @@ +--- +meta: + title: InterLink Documentation + description: Dive into Scaleway InterLink with our quickstart guides, how-tos, tutorials and more. + noindex: true +--- + + + InterLink is currently available in [Private Beta](https://www.scaleway.com/en/betas/) only, for selected testers. Watch this space for more information on public availability. + + + + +## Getting Started + + + + + + + + +## Changelog + + \ No newline at end of file diff --git a/network/interlink/reference-content/assets/scaleway-interlink-config.webp b/network/interlink/reference-content/assets/scaleway-interlink-config.webp new file mode 100644 index 0000000000..e226b9b417 Binary files /dev/null and b/network/interlink/reference-content/assets/scaleway-interlink-config.webp differ diff --git a/network/interlink/reference-content/assets/scaleway-interlink-diag-simple.webp b/network/interlink/reference-content/assets/scaleway-interlink-diag-simple.webp new file mode 100644 index 0000000000..ac3bf704c3 Binary files /dev/null and b/network/interlink/reference-content/assets/scaleway-interlink-diag-simple.webp differ diff --git a/network/interlink/reference-content/assets/scaleway-interlink-diag-tech.webp b/network/interlink/reference-content/assets/scaleway-interlink-diag-tech.webp new file mode 100644 index 0000000000..5b59f89159 Binary files /dev/null and b/network/interlink/reference-content/assets/scaleway-interlink-diag-tech.webp differ diff --git a/network/interlink/reference-content/assets/scaleway-interlink-ordering.webp b/network/interlink/reference-content/assets/scaleway-interlink-ordering.webp new file mode 100644 index 0000000000..6d06561261 Binary files /dev/null and b/network/interlink/reference-content/assets/scaleway-interlink-ordering.webp differ diff --git a/network/interlink/reference-content/configuring.mdx b/network/interlink/reference-content/configuring.mdx new file mode 100644 index 0000000000..f22f305d84 --- /dev/null +++ b/network/interlink/reference-content/configuring.mdx @@ -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 +--- + + +InterLink is currently in [Private Beta](https://www.scaleway.com/en/betas/), and only available to selected testers. + + +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 + + + +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. + +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/#path-links-attach-a-vpc) endpoint to attach a VPC to a given InterLink. + +### 3. Attach allowed routes list (routing policy) + +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. + +You can [create](https://www.scaleway.com/en/developers/api/interlink/#path-routing-policies-create-a-routing-policy) and [attach](https://www.scaleway.com/en/developers/api/interlink/#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/#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. + + +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. + + +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. diff --git a/network/interlink/reference-content/index.mdx b/network/interlink/reference-content/index.mdx new file mode 100644 index 0000000000..121452b0d8 --- /dev/null +++ b/network/interlink/reference-content/index.mdx @@ -0,0 +1,8 @@ +--- +meta: + title: InterLink - Additional content + description: InterLink additional content +content: + h1: InterLink - Additional content + paragraph: InterLink additional content +--- diff --git a/network/interlink/reference-content/overview.mdx b/network/interlink/reference-content/overview.mdx new file mode 100644 index 0000000000..afec228b8b --- /dev/null +++ b/network/interlink/reference-content/overview.mdx @@ -0,0 +1,83 @@ +--- +meta: + title: InterLink - technical overview + description: Dive deeper into understanding Scaleway's InterLink product, with technical diagrams, explanations and more. + noindex: true +content: + h1: InterLink - technical overview + paragraph: Dive deeper into understanding Scaleway's InterLink product, with technical diagrams, explanations and more. + noindex: true +tags: interlink pop infrastructure diagram technical overview +categories: + - interlink + - network +dates: + validation: 2024-10-24 + posted: 2024-10-24 +--- + + +InterLink is currently in [Private Beta](https://www.scaleway.com/en/betas/), and only available to selected testers. + + +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. Compared to a typical internet-based VPN, an InterLink is more reliable, more secure and offers lower latency. + +At its simplest level, InterLink can be understood as a configurable connection between your own infrastructure, and your Scaleway VPC. You can configure details such as available bandwidth, and the routes allowed between the two peers: + + + +## Types of InterLink + +Scaleway plans to offer three types of InterLink, though currently only the **hosted** type is available. + +### Hosted InterLinks + +A hosted InterLink is provisioned via a [partner](/network/interlink/concepts/#partner). Partners are telcos or network providers that have been pre-selected by Scaleway. They provide a shareable port on their router, with a certain amount of bandwidth, at a [PoP](/network/interlink/concepts/#location) (location) where both Scaleway and the partner's networks are present. The available bandwidth is shared between multiple customers: each gets a specified amount when creating their InterLink. + +By choosing a hosted InterLink, you can re-use existing connectivity between a PoP where both you and the partner are present, and the Scaleway network. Layer 2 isolation to your Scaleway VPC is preserved, with guaranteed bandwidth (100Mbps - 25Gbps) across the InterLink. + +The diagram below shows the architecture of a hosted InterLink. Note that three possibilities are available on the customer side: +- The partner's router connects to the customer's router (itself connected to the customer's on-premises infrastructure) via a **M**eet **M**e **R**oom at a PoP where both networks are present. +- The partner's router connects directly to the customer's on-premises infrastructure via a last-mile connection facilitated by the partner. +- The customer's infrastructure is hosted in the partner's datacenter, and connects to the partner's router directly. + + + +### Dedicated InterLink + +A dedicated InterLink is provisioned, where the customer gets sole use of a single InterLink port on Scaleway's router, with the entire bandwidth of that port. This type of InterLink is not yet available at Scaleway - [contact a sales representative](https://www.scaleway.com/en/contact-sales/) to register your interest. + +### Shared InterLink + +A shared InterLink is provisioned, where the customer's port is one of multiple InterLinks using a certain port on Scaleway's router, sharing its bandwidth. This type of InterLink is not yet available at Scaleway - [contact a sales representative](https://www.scaleway.com/en/contact-sales/) to register your interest. + +## Provisioning an InterLink + +Provisioning an InterLink is a multi-step process. As only hosted InterLinks (via partners) are currently available, specific action is required from both from Scaleway, the customer, and from the selected partner in order to successfully complete the provisioning process. See our dedicated page on [provisioning an InterLink](/network/interlink/reference-content/provisioning/) for full details. + +## Attaching a VPC + +When you initially create the InterLink, it is not associated with a specific VPC, only with given a Scaleway region. Attaching it to a VPC within the specified region is essential to complete the connection on the Scaleway side. You can only attach a VPC once the provisioning process is complete, and the InterLink has `Active` status. See the [configuration](/network/interlink/reference-content/configuring/) page for more information. + +## Routing across an InterLink + +InterLink uses [**B**order **G**ateway **P**rotocol](https://en.wikipedia.org/wiki/Border_Gateway_Protocol) to exchange routing information between the customer’s network 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. This facilitates efficient traffic flow across the link towards these destinations, providing that [allowed routes](#allowed-routes-list) and [route propagation](#route-propagation) have been correctly set up. + +In fact, each InterLink has two BGP sessions: one for IPv4 and one for IPv6. Each session handles the exchange of IP prefixes for its respective IP version. The separation of these sessions ensures that IPv4 and IPv6 traffic can be managed independently, and provides compatibility with networks that may only support one of the IP versions. + +When both BGP sessions are up, the InterLink has `Active` status. If one BGP session is up, and the other down, the status moves to `Limited Connectivity`. If both BGP sessions are down, the status is marked as `Down`. See the page on [InterLink statuses](/network/interlink/reference-content/statuses) for full information. + +### Allowed routes list + +By default, **all route announcements from both sides are blocked** by InterLink. This is part of a safety-net mechanism to allow customers to efficiently and safely control traffic flow across the link. You must create and attach an [allowed routes list](/network/interlink/concepts/#allowed-routes-list) (aka routing policy), to specify the IP prefix announcements to whitelist from each side. This is step one of two in allowing traffic to flow across the InterLink. See the [configuration](/network/interlink/reference-content/configuring/) page for more information on allowed routes lists. + +### Route propagation + +Even after attaching an allowed route list, traffic cannot flow across your InterLink until you **activate route propagation**. This is the second part of the safety-net mechanism enabling you to fine-tune the traffic that flows across your InterLink. Route propagation can be activated or deactivated whenever you want. See the [configuration](/network/interlink/reference-content/configuring/) page for more information on route propagation. + + + + + diff --git a/network/interlink/reference-content/provisioning.mdx b/network/interlink/reference-content/provisioning.mdx new file mode 100644 index 0000000000..b8a0b43ac0 --- /dev/null +++ b/network/interlink/reference-content/provisioning.mdx @@ -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 +--- + + +InterLink is currently in [Private Beta](https://www.scaleway.com/en/betas/), and only available to selected testers. + + +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). When preparing your InterLink order, you must choose appropriate location (aka **P**oint **o**f **P**resence), partner and region settings to ensure compatibility with your external and Scaleway infrastructure. + + + +This document explains the provisioning 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 + + + +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/#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/#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. + + +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. + + +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/#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. + + +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. + + +### 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/#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. + +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. + + +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. + + +### 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/). + + +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. + + +## 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/#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. + + +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. + + + + + diff --git a/network/interlink/reference-content/statuses.mdx b/network/interlink/reference-content/statuses.mdx new file mode 100644 index 0000000000..14587e9ea0 --- /dev/null +++ b/network/interlink/reference-content/statuses.mdx @@ -0,0 +1,39 @@ +--- +meta: + title: Understanding InterLink statuses + description: Find out what the different possible statuses of your InterLink mean, and how to take action based on these statuses when necessary. + noindex: true +content: + h1: Understanding InterLink statuses + paragraph: Find out what the different possible statuses of your InterLink mean, and how to take action based on these statuses when necessary. +tags: interlink status +categories: + - interlink + - network +dates: + validation: 2024-10-24 + posted: 2024-10-24 +--- + + +InterLink is currently in [Private Beta](https://www.scaleway.com/en/betas/), and only available to selected testers. + + +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/#path-links-get-a-link) call. + +This document explains the different statuses possible for an InterLink, and how to understand them. + +| **Status** | **Description** | +|-------------------|-----------------------------------------| +| **Configuring** | InterLink is configuring and is in a transient state. No user actions can be carried out.

This status could occur immediately after creating your InterLink order, while Scaleway processes the order and configures the InterLink, or at any time when a new configuration is being applied. | +| **Requesting** | InterLink has been created successfully on the Scaleway side, provisioning must now be requested from the chosen partner.

You must contact your partner to request that they provision your InterLink. Either a contact email address, or a link to the partner’s portal is provided via the Scaleway API. Scaleway does not make the request to the partner, this is the responsibility of the user.

The InterLink will remain in `Requesting` status until the partner accepts the request, at which point it moves into `Provisioning` status. Alternatively, the partner may refuse the request, or the the request may time out. | +| **Failed** | Scaleway was unable to create the InterLink.

This usually occurs when there is a configuration error on the Scaleway side while attempting 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 move to `Requesting` status. Wait for technical intervention, or open a support ticket if you require further help. +| **Provisioning** | The partner has accepted the InterLink request, and is now provisioning the connection at their end.

The InterLink is not yet operational: traffic cannot yet flow. You must wait for the partner to finish provisioning the connection. When provisioning is complete, the InterLink should move to `Active` status. | +| **Expired** | No response was received from the selected partner in the 10 working days following the creation of the InterLink on the Scaleway side.

If Scaleway does not receive a response from the selected partner after 10 working days, the InterLink moves to `Expired` status. It is not possible to take action to move this InterLink to a different status: you must delete the InterLink, and create a new order if you wish to try again. | +| **Refused** | The partner refused the request to provision the InterLink.

It is not possible to take action to move this InterLink to a different status: you must delete the InterLink, and create a new order if you wish to try again with a different partner or configuration. | +| **Active** | The InterLink is in a ready state, and traffic can flow.

The InterLink has been provisioned on both the Scaleway side and the partner side, and is now in an active state. Traffic can flow across the InterLink (presuming that allowed routes lists, route propagation, and an attached VPC are correctly configured). | +| **Limited Connectivity** | The InterLink is provisioned, but IP connectivity is limited.

This may be the case if either, but not both of, the BGP IPv4 or IPv6 sessions are down. | +| **Down / All down** | The InterLink is provisioned, but there is no IP connectivity.

The InterLink has been provisioned successfully on both sides, but both BGP sessions (IPv4 and IPv6) are down and traffic cannot flow. Open a support ticket with Scaleway, or contact your partner. | +| **Locked** | The InterLink has been locked by the Trust and Safety team

You cannot carry out any actions on the InterLink. Open a support ticket.| +| **Deprovisioning** | Deletion of the InterLink has been initiated on either the partner side or the Scaleway side, but has not been finalized.

An InterLink must be deleted by both Scaleway and the partner in order to move to `Deleted` status. If you have deleted an InterLink on the Scaleway side, ensure you contact the partner separately to request that they delete the resource on their side. If you have deleted an InterLink on the partner side, ensure that you delete the resource on the Scaleway side. | +| **Deleted** | The InterLink has been deprovisioned by both Scaleway and the partner, and is now deleted. | \ No newline at end of file