-
Notifications
You must be signed in to change notification settings - Fork 219
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(interlink): private beta doc #3942
Open
RoRoJ
wants to merge
9
commits into
main
Choose a base branch
from
MTA-5155
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
58e6761
feat(interlink): start concepts
RoRoJ f57b3e6
feat(interlink): continue
RoRoJ bf499e5
fix(interlink): modifications
RoRoJ 0960af7
feat(interlink): continue
RoRoJ b96746f
fix(interlink): add links
RoRoJ 80da3ec
fix(interlink): fixed links
RoRoJ 2453c47
fix(interlink): add more content
RoRoJ a8a8269
feat(interlink): doc
RoRoJ 95a729f
feat(interlink): private beta doc
RoRoJ File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
--- | ||
|
||
<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. | ||
|
||
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. | ||
|
||
<Lightbox src="scaleway-interlink-diag-simple.webp" alt="A diagram shows how a Scaleway VPC, to the left, can be attached to an InterLink, which then connects to external customer infrastructure." /> | ||
|
||
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). | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
--- | ||
meta: | ||
title: InterLink Documentation | ||
description: Dive into Scaleway InterLink with our quickstart guides, how-tos, tutorials and more. | ||
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. Watch this space for more information on public availability. | ||
</Alert> | ||
|
||
<ProductHeader | ||
productName="InterLink" | ||
productLogo="interlink" | ||
description="InterLink lets you create a secure, private connection between your external infrastructure, and your Scaleway VPC." | ||
url="/network/interlink/reference-content/overview/" | ||
label="InterLink Overview" | ||
/> | ||
|
||
## Getting Started | ||
|
||
<Grid> | ||
<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="Additional Content" | ||
icon="book-open-outline" | ||
description="Read our in-depth guides to provisioning and configuring your InterLink." | ||
label="Read more" | ||
url="/network/interlink/reference-content/" | ||
/> | ||
</Grid> | ||
|
||
<ClickableBanner | ||
productLogo="cli" | ||
title="InterLink API" | ||
description="Manage InterLink using the Scaleway API." | ||
url="https://www.scaleway.com/en/developers/api/interlink/" | ||
label="Go to InterLink API" | ||
/> | ||
|
||
## Changelog | ||
|
||
<ChangelogList | ||
productName="interlink" | ||
numberOfChanges={3} | ||
/> |
Binary file added
BIN
+35.5 KB
network/interlink/reference-content/assets/scaleway-interlink-config.webp
Binary file not shown.
Binary file added
BIN
+37.1 KB
network/interlink/reference-content/assets/scaleway-interlink-diag-simple.webp
Binary file not shown.
Binary file added
BIN
+94 KB
network/interlink/reference-content/assets/scaleway-interlink-diag-tech.webp
Binary file not shown.
Binary file added
BIN
+33.7 KB
network/interlink/reference-content/assets/scaleway-interlink-ordering.webp
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|
||
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. | ||
|
||
<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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
--- | ||
meta: | ||
title: InterLink - Additional content | ||
description: InterLink additional content | ||
content: | ||
h1: InterLink - Additional content | ||
paragraph: InterLink additional content | ||
--- |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.