Skip to content

Commit 5416809

Browse files
committed
fix(pgw): correct links
1 parent 318fc8d commit 5416809

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ 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 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.
22+
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/v1/), either explicitly via the API itself, or implicitly behind the scenes of the Scaleway console or other developer tools.
2323

2424
**We are now deprecating v1 of the API and transitioning to v2.**
2525

@@ -40,7 +40,7 @@ After a deprecation period ending on 1 Oct 2025, the Public Gateways API v1 and
4040

4141
- Put any non-IPAM mode ([legacy](/network/public-gateways/concepts/#ipam)) Public Gateways in IPAM mode. You can do this in several ways:
4242
- Use the **Move to IPAM mode** button in the console
43-
- Use the [dedicated API call](https://www.scaleway.com/en/developers/api/public-gateway/#path-gateways-put-a-public-gateway-in-ipam-mode).
43+
- Use the [dedicated API call](https://www.scaleway.com/en/developers/api/public-gateway/v1/#path-gateways-put-a-public-gateway-in-ipam-mode).
4444
- Use the `move_to_ipam` flag in [Terraform](https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md)
4545

4646
- 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).
@@ -63,7 +63,7 @@ Whether you choose a custom or default CIDR block, automatic address assignment
6363

6464
## Introducing Public Gateways API v2
6565

66-
Since the assignment and management of IP addresses on Private Networks is now managed by IPAM and the Private Networks themselves, we must complete the removal of the DHCP functionality from Public Gateways. This means releasing a new version (v2) of the [Public Gateways API](https://www.scaleway.com/en/developers/api/public-gateway/), which has until now retained a number of legacy DHCP functions. From this new version, you can expect:
66+
Since the assignment and management of IP addresses on Private Networks is now managed by IPAM and the Private Networks themselves, we must complete the removal of the DHCP functionality from Public Gateways. This means releasing a new version (v2) of the [Public Gateways API](https://www.scaleway.com/en/developers/api/public-gateway/), which has until now retained a number of legacy DHCP functions. From this new version, you can observe:
6767

6868
- IPAM mode becomes default
6969
- Removal of the DHCP object
@@ -104,7 +104,7 @@ Remember that you can define a [custom CIDR block](/vpc/how-to/create-private-ne
104104

105105
For some time now, this functionality has been available via the API and developer tools only (not the Scaleway console).
106106

107-
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.
107+
When attaching a Public Gateway to a Private Network (creating a [Gateway Network](https://www.scaleway.com/en/developers/api/public-gateway/v1/#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.
108108

109109
**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 a Public Gateway on a Private Network, if you wish. On the Scaleway console, you can select a [reserved IP](/ipam/how-to/reserve-ip/) to use when attaching a Public Gateway to a Private Network. Otherwise, use the default behaviour where IPAM auto-assigns an IP address from the Private Network's CIDR block to the Public Gateway at the moment of attachment.
110110

@@ -114,7 +114,7 @@ When you [use a dedicated method](#how-do-i-move-my-legacy-public-gateway-to-ipa
114114

115115
For some time now, this functionality has been available via the API and developer tools only (not the Scaleway console).
116116

117-
[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.
117+
[DHCP entries](https://www.scaleway.com/en/developers/api/public-gateway/v1/#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.
118118

119119
**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.
120120

@@ -138,7 +138,7 @@ Allowed IPs is a new functionality of the Public Gateways API v2, that will also
138138
- **8 March 2025 - 1 Oct 2025: Migration period**: You have a six month migration period to complete the following actions
139139

140140
- Ensure that your Public Gateway is in [IPAM mode](/network/public-gateways/concepts/#ipam). Only IPAM mode gateways are compatible with v2.
141-
- 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, the [dedicated API call](https://www.scaleway.com/en/developers/api/public-gateway/#path-gateways-put-a-public-gateway-in-ipam-mode), or the `move_to_ipam` flag in [Terraform](https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md).
141+
- 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, the [dedicated API call](https://www.scaleway.com/en/developers/api/public-gateway/v1/#path-gateways-put-a-public-gateway-in-ipam-mode), or the `move_to_ipam` flag in [Terraform](https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md).
142142
- Ensure that [DHCP is activated](/vpc/how-to/activate-dhcp/) on all Private Networks attached to your IPAM-mode Public Gateways.
143143
- Update any code or scripts you have that call version 1 of the Public Gateways API, so that they call version 2 instead. This includes removing any use of the DHCP entries, DHCP objects or address fields as mentioned above.
144144

@@ -158,7 +158,7 @@ Allowed IPs is a new functionality of the Public Gateways API v2, that will also
158158

159159
- Check in the [Scaleway console](https://console.scaleway.com/public-gateway/public-gateways) whether your Public Gateway is in IPAM mode or legacy mode:
160160

161-
- **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, the [dedicated API call](https://www.scaleway.com/en/developers/api/public-gateway/#path-gateways-put-a-public-gateway-in-ipam-mode), or the `move_to_ipam` flag in [Terraform](https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md).
161+
- **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, the [dedicated API call](https://www.scaleway.com/en/developers/api/public-gateway/v1/#path-gateways-put-a-public-gateway-in-ipam-mode), or the `move_to_ipam` flag in [Terraform](https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md).
162162

163163
- **IPAM mode**: you do not have any action to take, except updating any code and scripts that you have (see above).
164164

@@ -167,7 +167,7 @@ Allowed IPs is a new functionality of the Public Gateways API v2, that will also
167167
You can do this in several ways:
168168

169169
- Use the **Move to IPAM mode** button in the console
170-
- Use the [dedicated API call](https://www.scaleway.com/en/developers/api/public-gateway/#path-gateways-put-a-public-gateway-in-ipam-mode).
170+
- Use the [dedicated API call](https://www.scaleway.com/en/developers/api/public-gateway/v1/#path-gateways-put-a-public-gateway-in-ipam-mode).
171171
- Use the `move_to_ipam` flag in [Terraform](https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md)
172172

173173
### What happens when I move my legacy Public Gateway to IPAM mode?

0 commit comments

Comments
 (0)