Skip to content

Commit 27b7883

Browse files
committed
fix(pgw): update
1 parent 88fb4ee commit 27b7883

File tree

3 files changed

+28
-12
lines changed

3 files changed

+28
-12
lines changed

pages/public-gateways/concepts.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,9 +73,8 @@ Private Networks attached to legacy Public Gateways must stay in the gateway's a
7373

7474
**IPAM** Public Gateways are fully and natively integrated with the Scaleway IPAM without any workaround. Your gateway is in IPAM mode if:
7575
- You created it via the Scaleway console on or after 17 October 2023
76-
- You created it via the Scaleway API or developer tools using the `ipam_config` object, and the auto-calculated `is_legacy` [Gateway parameter](https://www.scaleway.com/en/developers/api/public-gateway/#path-gateways-create-a-public-gateway) has a value of `false`.
77-
78-
You cannot "migrate" a legacy Public Gateway to become an IPAM-mode gateway. While legacy Public Gateways continue to function thanks to our [workaround](/vpc/reference-content/vpc-migration/#public-gateways-and-vpc), you cannot modify them to become natively integrated IPAM networks. If you wish to have an IPAM-mode Public Gateway, for example to benefit from IP management via Scaleway's [IPAM](https://www.scaleway.com/en/developers/api/vpc/) API as more features become available, or to use Kapsule with full isolation, you must create a new gateway.
76+
- You created it via the Scaleway API or devtools using the `ipam_config` object, and the auto-calculated `is_legacy` [Gateway parameter](https://www.scaleway.com/en/developers/api/public-gateway/#path-gateways-create-a-public-gateway) has a value of `false`.
77+
- You moved it from legacy mode to IPAM mode using the dedicated button in the console, or the dedicated API call.
7978

8079
<Message type="note">
8180
When creating a Kubernetes Kapsule cluster with [full isolation](/kubernetes/reference-content/secure-cluster-with-private-network/#can-i-use-a-public-gateway-with-my-private-network-to-exit-all-outgoing-traffic-from-the-nodes) you are required to attach a Public Gateway to the cluster's Private Network, and this **cannot** be a legacy Public Gateway - it must be an IPAM-mode gateway.
Binary file not shown.

pages/public-gateways/reference-content/understanding-v2.mdx

Lines changed: 26 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,22 +13,37 @@ categories:
1313
- network
1414
---
1515

16+
TODO CHECK CONSOLE MENTIONS
17+
TODO CHECK DATE - NOT JUNE
18+
1619
Scaleway's VPC offering is evolving, and with this comes changes for the Public Gateway product.
1720

1821
This document explains what to expect and how to prepare for the upcoming changes.
1922

2023
## Summary (TL;DR)
2124

22-
<Lightbox src="scaleway-pgw-table.webp" alt="A visual graphic shows in table form what is explained in text below" />
23-
24-
All Scaleway Public Gateways until now have been created and managed with the version 1 of the [Public Gateways API](https://www.scaleway.com/en/developers/api/public-gateway/), either explicitly via the API itself, or implicitly behind the scenes of the Scaleway console / devtools.
25+
All Scaleway Public Gateways until now have been created and managed with the version 1 of the [Public Gateways API](https://www.scaleway.com/en/developers/api/public-gateway/), either explicitly via the API itself, or implicitly behind the scenes of the Scaleway console or other developer tools.
2526

2627
**We are now deprecating v1 of the API and transitioning to v2.**
2728

28-
After a six month deprecation period ending on 2 June 2025, the Public Gateways API v1 and associated developer tools will be removed. Before this time, you must:
29+
| | **PGW API v1** | **PGW API v2** |
30+
|---|---|---|
31+
| Supports [legacy-mode PGWs](/public-gateways/concepts/#ipam) | Yes ✅ | No ❌|
32+
| Supports [IPAM-mode PGWs](/public-gateways/concepts/#ipam) | Yes ✅ | Yes ✅|
33+
| Supports custom DHCP via PGW | Yes ✅ | No ❌|
34+
| Supports SSH bastion allowed IPs, and future new features | No ❌| Yes ✅ |
35+
| Deprecated? | Yes ✅ | No ❌|
36+
| Removal date | 2 June 2025 | --- |
37+
| Compatible with PGW management via Scaleway console? | Only until 2 June 2025 | Yes ✅ |
38+
39+
After a deprecation period ending on 2 June 2025, the Public Gateways API v1 and associated developer tools will be removed.
40+
41+
**What you need to do before 2 June 2025:**
2942

3043
- Ensure that your Public Gateway is in [IPAM mode](#ipam-mode-becomes-default). Only IPAM-mode gateways are compatible with v2.
44+
3145
- Put any non-IPAM mode ([legacy](/network/public-gateways/concepts/#ipam)) Public Gateways in IPAM mode, by using the **Move to IPAM mode** button in the console, or the [dedicated API call](TODO).
46+
3247
- Update any code or scripts you have that call version 1 of the Public Gateways API, so that they call version 2 instead, and do not refer to [removed functionalities](#introducing-public-gateways-api-v2).
3348

3449
If your Public Gateway is already in IPAM mode, and you only manage it via the console, you will not be affected by these changes and you do not need to take any action.
@@ -72,9 +87,7 @@ Legacy Public Gateways use a [workaround](/network/vpc/reference-content/vpc-mig
7287

7388
Legacy mode will be deprecated going forward, and will not be compatible with v2 of the Public Gateway API. It will no longer be possible to create legacy-mode Public Gateways, all gateways will necessarily be in IPAM mode.
7489

75-
If you still have a legacy gateway, you must transition it to IPAM mode so that it is compatible with v2 of the API. Do this by using the **Move to IPAM mode** button in the console, or the [dedicated API call](TODO).
76-
77-
This will update the auto-calculated `is_legacy` field and put your gateway in IPAM mode.
90+
If you still have a legacy gateway, you must transition it to IPAM mode so that it is compatible with v2 of the API. Do this by using the **Move to IPAM mode** button in the console, or the [dedicated API call](TODO). This will update the auto-calculated `is_legacy` field and put your gateway in IPAM mode.
7891

7992
### Removal of the DHCP object
8093

@@ -86,7 +99,7 @@ When attaching a Public Gateway to a Private Network (creating a [Gateway Networ
8699

87100
**The DHCP object does not exist in v2 of the API**. After v1 is removed, it will no longer be possible to create or attach DHCP objects to Gateway Networks. Instead, IPAM configuration, where auto-configuration of `GatewayNetwork` is managed by IPAM, will become default, and replace any need for DHCP configuration via the Public Gateway.
88101

89-
Going forward, we expect users who were previously using a custom DHCP object to move to the standard set-up of IPAM and Private Networks' inbuilt DHCP for private IP assignment. Remember that you can define a [custom CIDR block](/vpc/how-to/create-private-network/#how-to-configure-cidr) for a Private Network at the time of creation, and use [reserved IP addresses](/ipam/how-to/reserve-ip/#how-to-reserve-a-private-ip-address) with IPAM when attaching both standard and custom resources.
102+
When you move your gateway to IPAM mode, any existing custom DHCP objects will become defunct. Going forward, we expect users who were previously using a custom DHCP object to move to the standard set-up of IPAM and Private Networks' inbuilt DHCP for private IP assignment. Remember that you can define a [custom CIDR block](/vpc/how-to/create-private-network/#how-to-configure-cidr) for a Private Network at the time of creation, and use [reserved IP addresses](/ipam/how-to/reserve-ip/#how-to-reserve-a-private-ip-address) with IPAM when attaching both standard and custom resources.
90103

91104
### Removal of the address field
92105

@@ -141,11 +154,15 @@ TODO CHECK DATES
141154
### How do I know if I have to take action?
142155

143156
- Consider whether you mange your Public Gateway uniquely via the Scaleway console, or via calls to the API/devtools in code and scripts:
157+
144158
- **Code and scripts**: If you have any code or scripts that call v1 of the API, or use devtool functionality that is removed from v2 such as DHCP object or entries, **you must take action before 2 June 2025**. Update your code and scripts so they point to v2 of the API. [Follow the examples provided for tools such as Terraform](TODO) to rewrite your devtool templates so they do not refer to removed functionalities. Do this in synchronization with moving your gateway to IPAM mode (if necessary).
159+
145160
- **Console-only**: You do not need to take any action, except ensuring that your gateway is in IPAM mode.
146161

147-
- Check in the [Scaleway console](https://console.scaleway.com/public-gateway/public-gateways) whether your Public Gateway is in IPAM mode or legacy mode.
162+
- Check in the [Scaleway console](https://console.scaleway.com/public-gateway/public-gateways) whether your Public Gateway is in IPAM mode or legacy mode:
163+
148164
- **Legacy mode**: you must move the gateway to IPAM mode. Only IPAM mode gateways are compatible with v2. Use the **Move to IPAM mode** button in the console, or the [dedicated API call](TODO).
165+
149166
- **IPAM mode**: you do not have any action to take, except updating any code and scripts that you have (see above).
150167

151168
### How do I move my legacy Public Gateway to IPAM mode?

0 commit comments

Comments
 (0)