Skip to content
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(pgw): migration doc for v2 #4443

Merged
merged 22 commits into from
Apr 8, 2025
Merged
Show file tree
Hide file tree
Changes from 19 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions pages/public-gateways/concepts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -73,14 +73,15 @@ Private Networks attached to legacy Public Gateways must stay in the gateway's a

**IPAM** Public Gateways are fully and natively integrated with the Scaleway IPAM without any workaround. Your gateway is in IPAM mode if:
- You created it via the Scaleway console on or after 17 October 2023
- 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`.

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.
- 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`.
- You moved it from legacy mode to IPAM mode using the dedicated button in the console, or the dedicated API call.

<Message type="note">
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.
</Message>

See also our dedicated documentation on [moving Public Gateways to IPAM-mode](/public-gateways/reference-content/understanding-v2/) to ensure compatibility with our new API v2.

## Legacy gateway

See [IPAM](#ipam).
Expand Down
8 changes: 5 additions & 3 deletions pages/public-gateways/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,15 @@ Moreover, the Public Gateway supports [static NAT](/public-gateways/how-to/confi

On 12 July 2023, DHCP functionality moved from Public Gateways to Private Networks. See our [dedicated migration documentation](/vpc/reference-content/vpc-migration/) for full details.

Pre-existing static leases created via the Public Gateway were fully migrated and still work for your attached resources on a Private Network. Manual static lease configuration is still available via the API and other developer tools, but is no longer available via the Scaleway console. We recommend that you use [Scaleway IPAM](/ipam/) to reserve private IP addresses on specific Private Networks, which you can then use when attaching resources.
Pre-existing static leases created via the Public Gateway were fully migrated and still work for your attached resources on a Private Network. Manual static lease configuration is still available via the API v1 and other developer tools, but this functionality is now deprecated, and does not exist in v2 of the API.

Read our [dedicated documentation](/public-gateways/reference-content/understanding-v2/) to learn how to put your gateway into IPAM-mode and replicate static DHCP reservation functionality with Scaleway IPAM.

## Why is my Public Gateway labelled as Legacy?

**Legacy** Public Gateways use a [workaround](/vpc/reference-content/vpc-migration/#public-gateways-and-vpc) to ensure compatiblity with Scaleway's IPAM (**I** **P** **A**ddress **M**anagement) tool. IPAM acts as a single source of truth for the IP addresses of Scaleway resources
**Legacy** Public Gateways use a [workaround](/vpc/reference-content/vpc-migration/#public-gateways-and-vpc) to ensure compatibility with Scaleway's IPAM (**I** **P** **A**ddress **M**anagement) tool. IPAM acts as a single source of truth for the IP addresses of Scaleway resources

Your gateway is probably a legacy gateway if you created it prior to 17 October 2023. These gateways will continue to function, but are not natively integrated with IPAM, and you cannot take advantage of features such as IP management via Scaleway [IPAM](/ipam/), or fully-isolated Kubernetes Kapsules. You should create a new gateway if you want to benefit from such features.
Your gateway is a legacy gateway if you created it prior to 17 October 2023 and you never recreated it in IPAM mode. Legacy gateways are now deprecated, as they are incompatible with v2 of the Public Gateways API. Such gateways must be [moved to IPAM mode](/public-gateways/reference-content/understanding-v2/) before October 2025 to ensure ongoing functionality.

## Do I need a Public Gateway for each Availability Zone (AZ)?

Expand Down
Binary file not shown.
8 changes: 8 additions & 0 deletions pages/public-gateways/reference-content/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
meta:
title: Public Gateways - Additional Content
description: Explore detailed Scaleway configurations, best practices and troubleshooting for Scaleway Public Gateways. Optimize configuration of your gateway with our comprehensive reference guides.
content:
h1: Public Gateways - Additional Content
paragraph: Explore detailed Scaleway configurations, best practices and troubleshooting for Scaleway Public Gateways. Optimize configuration of your gateway with our comprehensive reference guides.
---
Loading
Loading