Skip to content

Commit 02e78bb

Browse files
RoRoJRoRoJ
committed
feat(S2S): first doc
1 parent 952db0f commit 02e78bb

File tree

10 files changed

+331
-0
lines changed

10 files changed

+331
-0
lines changed

‎pages/site-to-site-vpn/index.mdx‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
meta:
3+
title: Site-to-Site VPN Documentation
4+
description: Explore Scaleway Site-to-Site VPN. Connect your Scaleway VPC to your remote infrastructure, via an encrypted, private VPN tunnel.
5+
---
6+
7+
<Alert
8+
sentiment="info"
9+
title="Site-to-Site VPN is in Private Beta"
10+
>
11+
Site-to-Site VPN is currently in Private Beta, and available to selected testers only via the Scaleway API. [Request an invitation](https://www.scaleway.com/en/betas/#site-to-site-vpn).
12+
</Alert>
13+
14+
15+
<ProductHeader
16+
productName="Site-to-Site VPN"
17+
productLogo="sns"
18+
description="Securely connect your Scaleway VPC to your remote infrastructure, enabling encrypted data exchange over a private tunnel."
19+
url="/site-to-site-vpn/reference-content/understanding-s2svpn/"
20+
label="Understanding Site-to-Site VPN"
21+
/>
22+
23+
## Getting Started
24+
25+
<Grid>
26+
<SummaryCard
27+
title="Understanding Site-to-Site VPN"
28+
icon="rocket"
29+
description="Learn how to start using Site-to-Site VPN"
30+
label="View Doc"
31+
url="/site-to-site-vpn/reference-content/understanding-s2svpn/"
32+
/>
33+
<SummaryCard
34+
title="Concepts"
35+
icon="info"
36+
description="Core concepts that give you a better understanding of Site-to-Site VPN."
37+
label="View Concepts"
38+
url="/site-to-site-vpn/concepts/"
39+
/>
40+
<SummaryCard
41+
title="TODO"
42+
icon="book-open-outline"
43+
description="TODO"
44+
label="TODO"
45+
url="TODO"
46+
/>
47+
</Grid>
48+
49+
50+
<ClickableBanner
51+
productLogo="cli"
52+
title="Site-to-Site VPN APIs"
53+
description="Manage Site-to-Site VPN using the Scaleway API."
54+
url="https://www.scaleway.com/en/developers/api/s2s-vpn/"
55+
label="Go to Scaleway Site-to-Site VPN API"
56+
/>
57+
58+
## Changelog
59+
60+
<ChangelogList
61+
productName="site-to-site-vpn"
62+
numberOfChanges={3}
63+
/>

‎pages/site-to-site-vpn/reference-content/assets/scaleway-s2svpn-conceptual.webp‎

53.9 KB
Loading

‎pages/site-to-site-vpn/reference-content/assets/scaleway-vpn-one-tunnel-both.webp‎

18.6 KB
Loading

‎pages/site-to-site-vpn/reference-content/assets/scaleway-vpn-one-tunnel-one-type.webp‎

18.3 KB
Loading

‎pages/site-to-site-vpn/reference-content/assets/scaleway-vpn-tunnel-detail.webp‎

25.2 KB
Loading

‎pages/site-to-site-vpn/reference-content/assets/scaleway-vpn-two-tunnels.webp‎

20.5 KB
Loading

‎pages/site-to-site-vpn/reference-content/index.mdx‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
meta:
3+
title: InterLink - Additional content
4+
description: InterLink additional content
5+
content:
6+
h1: InterLink - Additional content
7+
paragraph: InterLink additional content
8+
---

‎pages/site-to-site-vpn/reference-content/security-proposals.mdx‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
meta:
3+
title: Site-to-Site VPN security proposals
4+
description: Find out what the different encryption and authentication ciphers available with Scaleway Site-to-Site VPN, and how to to choose the best algorithm for your use case.
5+
content:
6+
h1: Site-to-Site VPN security proposals
7+
paragraph: Find out what the different encryption and authentication ciphers available with Scaleway Site-to-Site VPN, and how to to choose the best algorithm for your use case.
8+
tags: vpn connection encryption authentication security cipher security-proposal
9+
categories:
10+
- site-to-site-vpn
11+
- network
12+
dates:
13+
validation: 2025-06-03
14+
posted: 2025-06-03
15+
---
16+
17+
<Message type="note">
18+
Site-to-Site VPN is currently in Private Beta, and available to selected testers only via the Scaleway API. [Request an invitation](https://www.scaleway.com/en/betas/#site-to-site-vpn).
19+
</Message>
20+
21+
When creating a VPN [connection](/site-to-site-vpn/reference-content/understanding-s2svpn/#connection), you must define a security proposal (aka IPSec proposal). The security proposal defines the encryption and authentication methods used to secure the IPSec VPN tunnel.
22+
23+
There are two parts to a security proposal:
24+
25+
- **IKEv2** (Internet Key Exchange): Establishes a secure connection between the VPN gateway and the customer gateway
26+
- **ESP** (Encapsulating Security Payload): Encrypts and authenticates the payload of the IP data packets traveling through the tunnel.
27+
28+
When defining your Site-to-Site VPN security proposal, you need to define the options to be used for the following elements:
29+
30+
| Protocol | Element | Description | Options |
31+
|-----------------|-----------------|----------------------------------------------------|--------------------|
32+
| **IKEv2** | **Encryption** | Algorithm to encrypt IKE negotiation messages | `aes` (AEAD and non-AEAD) |
33+
| **IKEv2** | **Integrity** | HMAC-based algorithm to verify IKE negotiation messages have not been tampered with | `sha` |
34+
| **IKEv2** | **Key Exchange Method** | DH group to define strength of key exchange | `ecp`, `curve`, `modp` |
35+
| **ESP** | **Encryption** | Algorithm to encrypt traffic's data payloads | `aes` (AEAD and non-AEAD) |
36+
| **ESP** | **Integrity** | Only set an HMAC-based algorithm to verify integrity of data payloads if **not** using an AEAD algorithm for ESP encryption. Otherwise, integrity is built-in, and this option does not need to be set. | `sha` |
37+
38+
?? Pseudorandom function ??

‎pages/site-to-site-vpn/reference-content/statuses.mdx‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
meta:
3+
title: Understanding Site-to-Site VPN statuses
4+
description: Find out what the different possible statuses of your Site-to-Site VPN gateways and connections mean, and how to take action based on these statuses when necessary.
5+
content:
6+
h1: Understanding Site-to-Site VPN statuses
7+
paragraph: Find out what the different possible statuses of your Site-to-Site VPN gateways and connections mean, and how to take action based on these statuses when necessary.
8+
tags: vpn gateway customer remote connection status
9+
categories:
10+
- site-to-site-vpn
11+
- network
12+
dates:
13+
validation: 2025-06-03
14+
posted: 2025-06-03
15+
---
16+
17+
<Message type="note">
18+
Site-to-Site VPN is currently in Private Beta, and available to selected testers only via the Scaleway API. [Request an invitation](https://www.scaleway.com/en/betas/#site-to-site-vpn).
19+
</Message>
20+
21+
## VPN gateway statuses
22+
23+
An VPN gateway always has a **status**, which can be retrieved via the API using the **Get a VPN gateway** call.
24+
25+
This section explains the different statuses possible for a VPN gateway, and how to understand them.
26+
27+
| **Status** | **Description** |
28+
|------------------------|-----------------------------------------|
29+
| **Provisioning** | The **create** action has been triggered, and Scaleway is provisioning the gateway. This status should be momentary: if it persists, contact support. |
30+
| **Active** | The VPN gateway has been created successfully, and is now operational. |
31+
| **Failed** | Scaleway was unable to create the VPN gateway. Wait a few seconds and refresh to check the status does not change. If the problem persists, contact support. |
32+
| **Configuring** | The gateway is configuring and is in a transient state. No user actions can be carried out. This status generally occurs while a new configuration is being applied, e.g. you have modified its settings. This status should be momentary: if it persists, contact support. |
33+
| **Locked** | The gateway has been locked by the Trust and Safety team. You cannot carry out any actions on the gateway. Open a support ticket. |
34+
| **Deprovisioning** |The **delete** action has been triggered, and Scaleway is deprovisioning the gateway. This status should be momentary: if it persists, contact support. |
35+
36+
## Connection statuses
37+
38+
A Site-to-Site VPN connection also always has a **status**, separate to that of the VPN gateway which can be retrieved via the API using the **Get a connection** call.
39+
40+
This section explains the different statuses possible for a connection, and how to understand them.
41+
42+
| **Status** | **Description** |
43+
|------------------------|-----------------------------------------|
44+
| **Active** | The connection has been created, and the BGP session(s) between the two gateways are both up. Traffic can flow through the connection's tunnel(s). |
45+
| **Limited connectivity** | The connection has been created, but IP connectivity is limited. This may be the case if the connection is configured to route both IPv4 and IPv6 traffic, but only one of the two associated BGP sessions is up. |
46+
| **Down** | The connection has been created, but either a) the customer gateway device is not yet successfully configured and the tunnel(s) cannot be established, or b) no BGP sessions (neither IPv4 not IPv6) are up, and without route announcements no traffic can flow through the tunnel.|
47+
| **Locked** | The connection has been locked by the Trust and Safety team. You cannot carry out any actions on the connection. Open a support ticket. |

0 commit comments

Comments
 (0)