Skip to content

Commit 8069292

Browse files
committed
fix(pgw): add screenshot
1 parent 6b77b31 commit 8069292

File tree

2 files changed

+26
-18
lines changed

2 files changed

+26
-18
lines changed
120 KB
Loading

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

Lines changed: 26 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,14 @@ This document explains what to expect and how to prepare for the upcoming change
1919

2020
## Summary (TL;DR)
2121

22-
All Scaleway Public Gateways until now have been created and managed with the [v1 version](TODO-LINK) of the Public Gateways API, either explicitly via the API itself or other devtools, or implicitly behind the scenes of the Scaleway console.
22+
All Scaleway Public Gateways until now have been created and managed with the v1 version of the [Public Gateways API](https://www.scaleway.com/en/developers/api/public-gateway/), either explicitly via the API itself or other devtools, or implicitly behind the scenes of the Scaleway console.
2323

24-
**We are now deprecating v1 of the API and transitioning to [v2](TODO-LINK).**
24+
**We are now deprecating v1 of the API and transitioning to v2.**
2525

2626
After a six month deprecation period, the Public Gateways API v1 and associated developer tools will be removed. Before this time, you must:
2727

28-
- Ensure that your Public Gateway is in [IPAM mode](/network/public-gateways/concepts/#ipam). Only IPAM mode gateways are compatible with v2.
29-
- Put any non-IPAM mode ([legacy](/network/public-gateways/concepts/#ipam)) Public Gateways in IPAM mode, by detaching them and reattaching them to their Private Networks.
28+
- Ensure that your Public Gateway is in [IPAM mode](/network/public-gateways/concepts/#ipam). Only IPAM-mode gateways are compatible with v2.
29+
- Put any non-IPAM mode ([legacy](/network/public-gateways/concepts/#ipam)) Public Gateways in IPAM mode, by detaching them and reattaching them to their Private Networks, or using the dedicated button in the console.
3030
- Update any code or scripts you have that call version 1 of the Public Gateways API, so that they call version 2 instead.
3131

3232
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.
@@ -57,9 +57,11 @@ Read on to find out more.
5757

5858
Scaleway Public Gateways are either in **Legacy mode** or **IPAM mode**. You can see the mode of a given gateway by:
5959

60-
- Checking its badge in the gateway listing page of the [Scaleway console](https://console.scaleway.com/public-gateway/public-gateways)
60+
- Checking its badge in the gateway listing page of the [Scaleway console](https://console.scaleway.com/public-gateway/public-gateways) (see screenshot below).
6161
- Checking the value of the `is_legacy` field via the [Public Gateways API](https://www.scaleway.com/en/developers/api/public-gateway/#path-gateways-get-a-public-gateway).
6262

63+
<Lightbox src="scaleway-pgw-listing.webp" alt="A screen in the Scaleway console shows a listing of two Public Gateways, one of which has a badge saying IPAM, the other a badge saying Legacy." />
64+
6365
<Message type="tip">
6466
All Public Gateways created via the Scaleway console since 17 October 2023 are necessarily in IPAM mode.
6567
</Message>
@@ -68,37 +70,41 @@ Legacy Public Gateways use a [workaround](/network/vpc/reference-content/vpc-mig
6870

6971
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.
7072

71-
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 **detaching and reattaching the Public Gateway from its Private Network**. This will update the auto-calculated `is_legacy` field and put your gateway in IPAM mode.
73+
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 either:
74+
- Detaching and reattaching the Public Gateway from its Private Network, or
75+
- Using the dedicated button in the Scaleway console.
76+
77+
This will update the auto-calculated `is_legacy` field and put your gateway in IPAM mode.
7278

7379
### Deprecation of the DHCP object
7480

75-
This functionality was available via the API and developer tools only (not the Scaleway console).
81+
For some time now, this functionality has been available via the API and developer tools only (not the Scaleway console).
7682

77-
The [DHCP object](https://www.scaleway.com/en/developers/api/public-gateway/#path-dhcp-list-dhcp-configurations) has, until now, allowed users to define a DHCP configuration, which specified how the gateway should assign IP addresses to devices on attached Private Networks (parameters including the subnet of the DHCP server, entry validity period and more).
83+
The [DHCP object](https://www.scaleway.com/en/developers/api/public-gateway/#path-dhcp-list-dhcp-configurations) has allowed users to define a DHCP configuration, which specified how the gateway should assign IP addresses to devices on attached Private Networks (parameters including the subnet of the DHCP server, entry validity period and more).
7884

7985
When attaching a Public Gateway to a Private Network (creating a [Gateway Network](https://www.scaleway.com/en/developers/api/public-gateway/#path-gateway-networks-attach-a-public-gateway-to-a-private-network)) via the API, you can pass a DHCP object, or the ID of an existing DHCP object.
8086

81-
**The DHCP object will not exist in v2 of the API**. 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.
87+
**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.
8288

8389
For legacy gateways using the DHCP object for custom DHCP configuration, **no automatic migration of this DHCP functionality** will take place when the gateway moves into IPAM-mode. We expect users to move to the standard set-up of IPAM and Private Networks for DHCP and private IP assignment.
8490

8591
### Deprecation of the address field
8692

87-
This functionality was available via the API and developer tools only (not the Scaleway console).
93+
For some time now, this functionality has been available via the API and developer tools only (not the Scaleway console).
8894

89-
When attaching a Public Gateway to a Private Network (creating a [Gateway Network](https://www.scaleway.com/en/developers/api/public-gateway/#path-gateway-networks-attach-a-public-gateway-to-a-private-network)) via the API, you can use the `address` field to define a single static IP address to assign to the Public Gateway on that Private Network.
95+
When attaching a Public Gateway to a Private Network (creating a [Gateway Network](https://www.scaleway.com/en/developers/api/public-gateway/#path-gateway-networks-attach-a-public-gateway-to-a-private-network)) via the API, you could use the `address` field to define a single static IP address to assign to the Public Gateway on that Private Network.
9096

91-
**The `address` field will not exist in v2 of the API**. Instead, you can pass an `ipam_ip_id` to specify a reserved IP address to use for the Public Gateway on this Private Network, if you wish. Otherwise, IPAM will auto-assign an IP address from the Private Network's CIDR block to the Public Gateway.
97+
**The `address` field does not exist in v2 of the API**. Instead, you can pass an `ipam_ip_id` to specify a reserved IP address to use for the Public Gateway on this Private Network, if you wish. Otherwise, IPAM will auto-assign an IP address from the Private Network's CIDR block to the Public Gateway.
9298

9399
TODO: will we automatically take care of this when legacy gateways transition to IPAM mode?
94100

95101
### Deprecation of DHCP entries
96102

97-
This functionality was available via the API and developer tools only (not the Scaleway console).
103+
For some time now, this functionality has been available via the API and developer tools only (not the Scaleway console).
98104

99-
[DHCP entries](https://www.scaleway.com/en/developers/api/public-gateway/#path-dhcp-entries-list-dhcp-entries) belong to a specified `GatewayNetwork` (Public Gateway / Private Network attachment) and can hold dynamic DHCP leases or static, user-created DHCP reservations. They effectively allow the Public Gateway to assign certain IP addresses to certain resources on the Private Network.
105+
[DHCP entries](https://www.scaleway.com/en/developers/api/public-gateway/#path-dhcp-entries-list-dhcp-entries) could be created, belonging to a specified `GatewayNetwork` (Public Gateway / Private Network attachment), holding dynamic DHCP leases or static, user-created DHCP reservations. They have effectively allowed the Public Gateway to assign certain IP addresses to certain resources on the Private Network.
100106

101-
**DHCP entries will not exist in v2 of the API**. Instead, you can rely on the default IPAM/DHCP functionality as described [above](#background-dhcp-and-ipam). The default behavior will auto-assign IP addresses to resources on the Private Network from the network's CIDR block, or you can use the IP reservation functionality to specify the IP address(es) to assign to each resource.
107+
**DHCP entries do not exist in v2 of the API**. Instead, you can rely on the default IPAM/DHCP functionality as described [above](#background-dhcp-and-ipam). The default behavior will auto-assign IP addresses to resources on the Private Network from the network's CIDR block, or you can use the IP reservation functionality to specify the IP address(es) to assign to each resource.
102108

103109
For custom resources, such as VMs hosted on Elastic Metal servers, you can use the IPAM API's [Attach IP to custom resource](https://www.scaleway.com/en/developers/api/ipam/#path-ips-attach-ip-to-custom-resource) method to assign IP addresses on Private Networks. This lets you associate a [reserved IP](https://www.scaleway.com/en/developers/api/ipam/#path-ips-reserve-a-new-ip) address with a resource name and MAC address.
104110

@@ -110,14 +116,16 @@ TODO
110116

111117
## Deprecation and removal timeline
112118

113-
1. [TODO-DATE] **21 February 2025 - V1 deprecation**: The Public Gateway v1 API will be deprecated. Deprecation means that the API will still function, but it is slated for removal and we do not recommended that you keep using it.
119+
TODO CHECK DATES
120+
121+
1. **21 February 2025 - V1 deprecation**: The Public Gateway v1 API will be deprecated. Deprecation means that the API will still function, but it is slated for removal and we do not recommended that you keep using it.
114122
2. [TODO-DATE] **V2 release**: The Public Gateway v2 API will be released, co-existing with v1.
115123

116124
<Message type="note">
117125
You will be able to list and manage all gateways with the **Scaleway console**, which will adapt to use v1 or v2 of the API as necessary. However, all new Public Gateways created via the console after [TODO-DATE] will necessarily be v2 gateways.
118126
</Message>
119127

120-
3. [TODO-DATE - TODO-DATE] **Migration period**: You have a six month migration period to complete the following actions
128+
3. **21 February 2025 - 2 June 2025: Migration period**: You have a six month migration period to complete the following actions
121129

122130
- Ensure that your Public Gateway is in [IPAM-mode](/network/public-gateways/concepts/#ipam). Only IPAM-mode gateways are compatible with v2.
123131
- Put any non-IPAM mode ([legacy](/network/public-gateways/concepts/#ipam)) Public Gateways in IPAM-mode, by **detaching them and reattaching them to their Private Networks**.
@@ -126,7 +134,7 @@ TODO
126134

127135
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.
128136

129-
4. [TODO-DATE] **2 June 2025 - V1 removal**: The Public Gateway v1 API will be removed. Any code or scripts still pointing to v1 will cease to function. We will automatically put any existing legacy Public Gateways into IPAM mode.
137+
4. **2 June 2025 - V1 removal**: The Public Gateway v1 API will be removed. Any code or scripts still pointing to v1 will cease to function. We will automatically put any existing legacy Public Gateways into IPAM mode.
130138

131139
## FAQ
132140

0 commit comments

Comments
 (0)