diff --git a/pages/instances/how-to/configure-reverse-dns.mdx b/pages/instances/how-to/configure-reverse-dns.mdx index b9f65b8631..47e1d7ee88 100644 --- a/pages/instances/how-to/configure-reverse-dns.mdx +++ b/pages/instances/how-to/configure-reverse-dns.mdx @@ -35,5 +35,5 @@ Reverse DNS is the opposite of classic "forward" DNS and maps an IP address to a -You cannot set reverse DNS for individual addresses within a flexible IPv6 /64 block via the Scaleway console. See our dedicated documentation on [how to use the IPAM API](/ipam/api-cli/set-ip-reverse/) for this purpose. +To set reverse DNS for individual addresses within a flexible IPv6 /64 block, use [IPAM](/ipam/how-to/set-ip-reverse/). diff --git a/pages/ipam/api-cli/set-ip-reverse.mdx b/pages/ipam/api-cli/set-ip-reverse.mdx deleted file mode 100644 index 61ff8f2072..0000000000 --- a/pages/ipam/api-cli/set-ip-reverse.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: Setting a reverse IPv6 DNS record via the IPAM API -description: This page explains how to set a reverse DNS record for an IPv6 address via the IPAM API -tags: ipv6 reverse dns instance eui-64 -dates: - validation: 2025-09-22 - posted: 2025-03-19 ---- -import Requirements from '@macros/iam/requirements.mdx' - - -The Scaleway console allows you to [configure reverse DNS](/instances/how-to/configure-reverse-dns/) for flexible IP addresses. - -For IPv4 addresses, the console functionality is convenient. However, for IPv6 addresses the console only allows you to configure a single reverse DNS record for the entire /64 block, and not individual addresses within the block. - -You can solve this problem by using the IPAM API to set reverse DNS for individual addresses within your IPv6 block. IPAM is Scaleway's IP Address Manager tool, which acts as a single source of truth for all Scaleway IP addresses. - - - -- A Scaleway account logged into the [console](https://console.scaleway.com) -- [Owner](/iam/concepts/glossary/#owner) status or [IAM permissions](/iam/concepts/glossary/#permission) allowing you to perform actions in the intended Organization -- A public IPv6 address for an IPAM-compatible Scaleway resource (e.g an Instance) - -Use the [update an IP](https://www.scaleway.com/en/developers/api/ipam/#path-ips-update-an-ip) call to set the reverse of the desired IPv6 addresses. An example call is shown below. Replace `` with your flexible IPv6 address's IP ID, and modify the payload according to the domains and addresses you want to configure. - - -To find the IP ID for your address, use the [IPAM: List IPs](https://www.scaleway.com/en/developers/api/ipam/#path-ips-list-existing-ips) call. - - -``` -curl -X PATCH \ - -H "X-Auth-Token: $SCW_SECRET_KEY" \ - -H "Content-Type: application/json" \ - "https://api.scaleway.com/ipam/v1/regions/fr-par/ips/{ip_id}" \ - -d '{ - "reverses":[ - { - "hostname":"reverse1.example.com", - "address":"2001:db8::1" - }, - { - "hostname":"reverse2.example.com", - "address":"2001:db8::2" - }, - { - "hostname":"reverse3.example.com", - "address":"2001:db8::3" - } - ] - }' -``` \ No newline at end of file diff --git a/pages/ipam/assets/scaleway-ipam-moreinfo.webp b/pages/ipam/assets/scaleway-ipam-moreinfo.webp deleted file mode 100644 index 2b88ae87f4..0000000000 Binary files a/pages/ipam/assets/scaleway-ipam-moreinfo.webp and /dev/null differ diff --git a/pages/ipam/assets/scaleway-reserve-ip.webp b/pages/ipam/assets/scaleway-reserve-ip.webp deleted file mode 100644 index c83b443fab..0000000000 Binary files a/pages/ipam/assets/scaleway-reserve-ip.webp and /dev/null differ diff --git a/pages/ipam/concepts.mdx b/pages/ipam/concepts.mdx index f9ce694440..26f3fa95c5 100644 --- a/pages/ipam/concepts.mdx +++ b/pages/ipam/concepts.mdx @@ -14,24 +14,17 @@ When viewing a private IP address in IPAM, it is shown in [CIDR notation](https: IP Address Manager (IPAM) is the Scaleway tool for planning, tracking, and managing the IP address space of Scaleway products. It acts as a single source of truth for the IP addresses of Scaleway resources. Managed products, such as Databases and Load Balancer, are fully integrated into IPAM, and the [DHCP server](/vpc/concepts/#dhcp) of Private Networks uses IPAM to assign private, static IP addresses to attached resources. -The public rollout of IPAM functionality is being carried out gradually. IPAM is now in General Availability, offering several different functionalities in the [Scaleway console](https://console.scaleway.com/ipam/), including viewing, tagging, and filtering all your [private IP addresses](#private-ip-address). You can also [reserve](/ipam/how-to/reserve-ip/) a private IP on one of your Private Networks and use it to attach an Instance, Load Balancer, Public Gateway, or Elastic Metal server to the network. - -More functionality is planned for the future, including: - -- Support for attaching Managed Databases and other resources to a Private Network using a reserved IP address -- Management of public (flexible) IP addresses - ## IPv4 Internet Protocol Version 4 (IPv4) is the standard protocol used for IP addresses, and routes most internet traffic as of today. Each IPv4 address has 32 bits. Written in human-readable form, an IPv4 address is generally shown as four octets separated by periods, e.g., `151.115.59.87`. -Scaleway resources may have a [public](#public-flexible-ip-address) IPv4 address (flexible IP) for accessibility from the public internet, and will have a [private](#private-ip-address) IPv4 address for each Private Network they are attached to. +Scaleway resources may have a [public](#public-flexible-ip-address) IPv4 address for accessibility from the public internet, and will have a [private](#private-ip-address) IPv4 address for each Private Network they are attached to. ## IPv6 Internet Protocol Version 6 (IPv6) is the most recent version of the IP protocol used for IP addresses. Each IPv6 address has 128 bits. Written in human-readable form, an IPv6 address can be shown as eight groups of four hexadecimal digits, each group representing 16 bits and separated by a colon, e.g., `2001:0DB8:0000:0003:0000:01FF:0000:002E`. This can also be notated as `2001:DB8::3:0:1FF:0:2E`. -IPv6-compatible Scaleway resources may have a [public](#public-flexible-ip-address) IPv6 address (flexible IP) for accessibility from the public internet, and will have a [private](#private-ip-address) IPv6 address for each Private Network they are attached to. For more details, see [IPv6 and the Scaleway ecosystem](/ipam/reference-content/ipv6/). +IPv6-compatible Scaleway resources may have a [public](#public-flexible-ip-address) IPv6 address for accessibility from the public internet, and will have a [private](#private-ip-address) IPv6 address for each Private Network they are attached to. For more details, see [IPv6 and the Scaleway ecosystem](/ipam/reference-content/ipv6/). ## Private IP address @@ -52,8 +45,20 @@ Public IP addresses identify devices on the public internet. You can enter the p Depending on the type of resource and its configuration, it may or may not have a public IP address. For example, you can choose to give an [Instance](/instances/) one or more public IP addresses ([IPv4](#ipv4) and/or IPv6), or alternatively, no public IP address at all. To find out more about managing public connectivity, see the [public connectivity best practices](/ipam/reference-content/public-connectivity-best-practices/). -Public IP addresses at Scaleway are often called flexible IP addresses, because you can move them between different resources. However, flexible IP addresses are scoped to a single product and to a single Availability Zone. If you create a flexible IP address for an Instance in `PAR-2`, you can move it to a different Instance in `PAR-2`, but not to an Instance in `PAR-1`, nor to an Elastic Metal server in any AZ. +Public IP addresses at Scaleway used to be referred to as "flexible IP addresses", because you can move them between different resources. Each public IP address is either [zonal](#zonal-ip-address) or [regional](#regional-ip-address), and this scope determines the resources you can move it to. + +## Regional IP address + +Regional IP addresses are scoped to a single Scaleway region (such as `FR-PAR`, or `NL-AMS`). If you reserve a public regional IP address for an Instance in `PAR-2`, you can move it to a resource in a different Availability Zone within this Region, such as `PAR-1`. Regional IPs can be used as failover IPs, by switching from a resource in one AZ to a backup resource in a different AZ in case of failure, ensuring high availability for this resource. ## Reserved IP address -A reserved IP address is a private IP address from the [CIDR block](/vpc/concepts/#cidr-block) of a given Private Network, that you have [reserved via IPAM](/ipam/how-to/reserve-ip/). Reserving an IP means that it can no longer be auto-allocated by DHCP to resources that join the network. You can then use the reserved IP to attach a specified resource of your choice to the Private Network. After you detach the resource, the IP remains reserved, and you can either use it to attach a different resource, or release it back into the pool of generally available IPs. \ No newline at end of file +A reserved IP address is an address that you have [reserved via IPAM](/ipam/how-to/reserve-ip/), and that is held in your Organization until you [release](/ipam/how-to/release-ip/) it. You can reserve a [private](#private-ip-address) IP address, a [public zonal](#zonal-ip-address) IP address, or a [public regional](#regional-ip-address) IP address. + +Reserving a private IP from the [CIDR block](/vpc/concepts/#cidr-block) of a Private Network means that it can no longer be auto-allocated by DHCP to resources that join the network. You can then use it to attach a specified resource of your choice to the Private Network. + +Whatever its source, a reserved IP address remains reserved after you detach or delete the resource it was attached to. You can either use it to attach a different resource, or release it back into the pool of generally available IPs. + +## Zonal IP address + +Zonal IP addresses are scoped to a single Availability Zone. If you reserve a public zonal IP address for an Instance in `PAR-2`, you can move it to a different Instance or VPN gateway in `PAR-2`, but not to a resource in `PAR-1`. \ No newline at end of file diff --git a/pages/ipam/faq.mdx b/pages/ipam/faq.mdx index 67dafa458a..2e55b1924a 100644 --- a/pages/ipam/faq.mdx +++ b/pages/ipam/faq.mdx @@ -14,15 +14,13 @@ productIcon: IpamProductIcon ### What can I do with IPAM? -The public rollout of IPAM functionality is being carried out gradually. IPAM is now in General Availability, offering several different functionalities in the [Scaleway console](https://console.scaleway.com/ipam/), including viewing, tagging, and filtering all your [private IP addresses](/ipam/concepts/#private-ip-address). You can also [reserve](/ipam/how-to/reserve-ip/) a private IP on one of your Private Networks and use it to attach a specified resource to the network. - -Management of public (flexible) IP addresses with IPAM is planned for the future. +IPAM is in General Availability, and covers all your IP addresses in the [Scaleway console](https://console.scaleway.com/ipam/): [private IP addresses](/ipam/concepts/#private-ip-address) on your Private Networks, [public zonal](/ipam/concepts/#zonal-ip-address) IP addresses, and [public regional](/ipam/concepts/#regional-ip-address) IP addresses. You can view, tag, and filter them, [reserve](/ipam/how-to/reserve-ip/) an address of any type (private, public zonal, public regional), and [release](/ipam/how-to/release-ip/) it when you no longer need it. ## Compatibility and integration ### Can I use a reserved private IP to attach any kind of managed resource to a Private Network? -Currently, the Scaleway console only supports attachment with a reserved IP for Instances, Load Balancers, Public Gateways, and Elastic Metal servers. Support for Managed Databases will be coming soon. +Currently, the Scaleway console only supports attachment with a reserved IP for Instances, Load Balancers, Public Gateways, and Elastic Metal servers. ### Can I use a reserved private IP with a virtual machine hosted on my Elastic Metal server? @@ -32,6 +30,6 @@ Yes, this functionality is now available via the Scaleway console and API. Simpl BYOIP is not currently available at Scaleway, but we are aware that there is a demand for this service. We recommend that you add or upvote a [feature request](https://feature-request.scaleway.com/) to register your interest. -## Can I request that I get a specific IP address when creating a flexible IP? +## Can I request that I get a specific IP address when reserving a public IP? -No, this is not possible. Flexible (public) IP addresses are allocated from a pool of addresses, and you cannot specify an address when creating one. \ No newline at end of file +No, this is not possible. Public IP addresses are allocated from a pool of addresses, and you cannot specify an address when creating one. \ No newline at end of file diff --git a/pages/ipam/how-to/assets/scaleway-ipam-moreinfo.webp b/pages/ipam/how-to/assets/scaleway-ipam-moreinfo.webp deleted file mode 100644 index 2b88ae87f4..0000000000 Binary files a/pages/ipam/how-to/assets/scaleway-ipam-moreinfo.webp and /dev/null differ diff --git a/pages/ipam/how-to/assets/scaleway-reserve-ip.webp b/pages/ipam/how-to/assets/scaleway-reserve-ip.webp deleted file mode 100644 index c83b443fab..0000000000 Binary files a/pages/ipam/how-to/assets/scaleway-reserve-ip.webp and /dev/null differ diff --git a/pages/ipam/how-to/attach-resource.mdx b/pages/ipam/how-to/attach-resource.mdx new file mode 100644 index 0000000000..b1bd341b8d --- /dev/null +++ b/pages/ipam/how-to/attach-resource.mdx @@ -0,0 +1,38 @@ +--- +title: How to attach a resource using a reserved private IP +description: Learn how to attach managed and custom resources to a Scaleway Private Network using an IP address reserved with IPAM. +tags: ipam ip-address-manager private-ip-address reserved-ip attach private-network custom-resource +dates: + validation: 2026-08-27 + posted: 2026-08-27 +--- +import Requirements from '@macros/iam/requirements.mdx' + + +Once you have [reserved a private IP address](/ipam/how-to/reserve-ip/) with IPAM, you can use it to attach a resource of your choice to the Private Network the address belongs to. The resource keeps this address for as long as it is attached, and the address stays reserved even after you detach or delete the resource. + +This page shows you how to attach both Scaleway-managed resources and custom resources to a Private Network using a reserved IP address. + + + +- A Scaleway account logged in to the [console](https://console.scaleway.com) +- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization +- A [reserved private IP address](/ipam/how-to/reserve-ip/) on one of your Private Networks + +## Attach a managed resource to a Private Network using a reserved IP address + +You can currently attach **CPU & GPU Instances**, **Elastic Metal servers**, **Load Balancers**, and **Public Gateways** to Private Networks using a reserved IP address. + +The option to use a reserved IP is displayed when you attach the resource to a Private Network in the console. Follow the instructions that match your use case: + +- Attach a resource to a Private Network from the [Private Networks](/vpc/how-to/attach-resources-to-pn/) product dashboard +- Attach an Instance to a Private Network from the [Instances](/instances/how-to/use-private-networks/#how-to-attach-instances-to-an-existing-private-network) product dashboard +- Attach an Elastic Metal server to a Private Network from the [Elastic Metal](/elastic-metal/how-to/use-private-networks/) product dashboard +- Attach a Load Balancer to a Private Network from the [Load Balancer](/load-balancer/how-to/use-with-private-network/) product dashboard +- Attach a Public Gateway to a Private Network from the [Public Gateways](/public-gateways/how-to/configure-a-public-gateway/#how-to-attach-a-public-gateway-to-a-private-network) product dashboard + +## Attach a custom resource to a Private Network using a reserved IP address + +You can use reserved private IP addresses to attach custom resources, such as VMs hosted on Elastic Metal servers, to Scaleway Private Networks. In doing so, you are prompted to specify the MAC address of the custom resource. + +Attach the custom resource from the Private Network dashboard in the Scaleway console by following the [How to attach resources to a Private Network](/vpc/how-to/attach-resources-to-pn/) procedure. diff --git a/pages/ipam/how-to/list-ips.mdx b/pages/ipam/how-to/list-ips.mdx index 99ab8f0b37..7b6d15234c 100644 --- a/pages/ipam/how-to/list-ips.mdx +++ b/pages/ipam/how-to/list-ips.mdx @@ -1,19 +1,17 @@ --- -title: How to list your private IP addresses -description: This page explains how to list your private IP addresses with Scaleway's IPAM -tags: ipam ip-address-manager private-ip-address ip-address ip filter reserve-ip-address +title: How to list your IP addresses +description: This page explains how to list and filter your public and private IP addresses with Scaleway's IPAM +tags: ipam ip-address-manager private-ip-address public-ip-address ip-address ip filter zonal regional dates: - validation: 2025-09-22 + validation: 2026-08-27 posted: 2024-05-30 --- import Requirements from '@macros/iam/requirements.mdx' -**IP** **A**ddress **M**anager (IPAM) is Scaleway's tool for planning, tracking and managing the IP address space of Scaleway products. It acts as a single source of truth for the IP addresses of Scaleway resources. +IP Address Manager (IPAM) is the Scaleway tool for planning, tracking, and managing the IP address space of Scaleway products. It acts as a single source of truth for the IP addresses of Scaleway resources. -[Read more about IPAM and future planned functionality](/ipam/concepts/#ipam). - -You can currently use IPAM in the Scaleway console to manage the IP address space of your Scaleway Private Networks. This document shows you how to list the [private IP addresses](/ipam/concepts/#private-ip-address) of all your Scaleway resources attached to Private Networks. +This page shows you how to list and filter your [public](/ipam/concepts/#public-flexible-ip-address) and [private IP addresses](/ipam/concepts/#private-ip-address) using the Scaleway console. @@ -21,21 +19,16 @@ You can currently use IPAM in the Scaleway console to manage the IP address spac - [Owner](/iam/concepts/glossary/#owner) status or [IAM permissions](/iam/concepts/glossary/#permission) allowing you to perform actions in the intended Organization - At least one resource [attached to a Private Network](/vpc/how-to/attach-resources-to-pn/). -## How to list and filter your private IP addresses - -1. Click **IPAM** in the **Network** section of the [Scaleway console](https://console.scaleway.com) side menu. - - A list of your **private IP addresses** for the **region** and **VPC** pre-selected in the filters displays. Addresses are displayed here if they are reserved in IPAM. This means either: +## List and filter your IP addresses - - You [reserved an address via IPAM](/ipam/how-to/reserve-ip/), or - - You [attached a resource to a Private Network](/vpc/how-to/attach-resources-to-pn/): this triggers IPAM to reserve and attach an IP address for the resource on the network. +1. In the [Scaleway console](https://console.scaleway.com) side menu, go to **Network** > **IPAM**. - The full range of IP addresses which are available but unreserved in each of your Private Network's [CIDR blocks](/vpc/concepts/#cidr-block) do not display in the list. +2. Select the desired region using the dropdown at the top of the page. - - When viewing a private IP address in IPAM, it is shown in [CIDR notation](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation). For example, the address `172.16.12.2/22` represents the IPv4 address `172.16.12.2`and its associated CIDR block `172.16.12.0/22`, defined on the [Private Network](/vpc/how-to/create-private-network/#how-to-configure-cidr) and containing 1024 addresses. - +3. Select the **source** of the addresses to display: -2. Modify the filters of the list using the drop-down menus at the top. You can filter for IP addresses within a given **region**, **VPC** and/or **Private Network**. You can also opt to filter for only [IPv4](/ipam/concepts/#ipv4) or [IPv6](/ipam/concepts/#ipv6) addresses: + - **Private IPs**: private addresses on your Private Networks. Select a **VPC**, and optionally a **Private Network**, to display them. + - **Public zonal IPs**: public addresses scoped to a single Availability Zone. Select a **zone** to display them. + - **Public regional IPs**: public addresses scoped to the whole selected region. -3. Click **Apply filters** to activate the filters you chose, or **Reset** to reset all filters. +4. Use the other filters for each source to refine your search, or click **All filters** to display the full set of filters available for the selected source. diff --git a/pages/ipam/how-to/manage-ips.mdx b/pages/ipam/how-to/manage-ips.mdx index 1da7919180..9ddd8a684d 100644 --- a/pages/ipam/how-to/manage-ips.mdx +++ b/pages/ipam/how-to/manage-ips.mdx @@ -1,60 +1,59 @@ --- -title: How to manage your private IP addresses -description: This page explains how to manage your private IP addresses with Scaleway's IPAM -tags: ipam ip-address-manager private-ip-address ip-address ip tags manage edit +title: How to manage your IP addresses +description: This page explains how to manage your public and private IP addresses with Scaleway's IPAM +tags: ipam ip-address-manager private-ip-address public-ip-address ip-address ip tags manage edit zonal regional dates: - validation: 2025-09-22 + validation: 2026-10-20 posted: 2024-05-30 --- import Requirements from '@macros/iam/requirements.mdx' -import image from './assets/scaleway-ipam-moreinfo.webp' +IPAM acts as a single source of truth for the IP addresses of your Scaleway resources. You can use IPAM in the Scaleway console to manage any address held in your Organization, whatever its source: +- [Private IP addresses](/ipam/concepts/#private-ip-address) on your Private Networks +- Public zonal IP addresses, scoped to a single Availability Zone such as `fr-par-1` +- Public regional IP addresses, scoped to a whole region such as `fr-par` -IPAM acts as a single source of truth for the IP addresses of your Scaleway resources. You can use IPAM in the console Scaleway console to manage [private IP addresses](/ipam/concepts/#private-ip-address) that are either attached to one of your resources on a Private Network, or [reserved via the IPAM API](https://www.scaleway.com/en/developers/api/ipam/#path-ips-book-a-new-ip). +Addresses are managed here whether you [reserved them with IPAM](/ipam/how-to/reserve-ip/) or they were attached to one of your resources. The management actions currently available include: -- Viewing the details of a private IP address, including its ID, tags, creation date and to which resource (if any) it is attached -- Editing the tags of a private IP address - -Learn [how to reserve a private IP address](/ipam/how-to/reserve-ip/). +- Viewing the details of an IP address, including its ID, source, tags, creation date, and to which resource (if any) it is attached +- Editing the tags of an IP address - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/glossary/#owner) status or [IAM permissions](/iam/concepts/glossary/#permission) allowing you to perform actions in the intended Organization -- At least one resource [attached to a Private Network](/vpc/how-to/attach-resources-to-pn/). +- At least one [reserved IP address](/ipam/how-to/reserve-ip/), or at least one resource [attached to a Private Network](/vpc/how-to/attach-resources-to-pn/) -## How to view the details of a private IP address +## View the details of an IP address 1. Click **IPAM** in the **Network** section of the [Scaleway console](https://console.scaleway.com) side menu. - A list of your **private IP addresses** for the **region** and **VPC** pre-selected in the filters displays. Addresses are displayed here if they are reserved in IPAM (either manually reserved via the [IPAM API](https://www.scaleway.com/en/developers/api/ipam/#path-ips-book-a-new-ip)), or attached to a resource [on a Private Network](/vpc/how-to/attach-resources-to-pn/). - -2. Modify the filters of the list using the drop-down menus at the top if necessary to display the required IP address. +2. Select the region of the IP address you want to manage, using the dropdown at the top of the page. -3. Click the icon next to the IP address whose details you want to view, then click **More info**. +3. Select the **source** of the address: **Private IPs**, **Public zonal IPs**, or **Public regional IPs**. Use the other filters that are displayed alongside it to narrow the list down to the required address, as described in [how to list your IP addresses](/ipam/how-to/list-ips/). - A screen similar to the following displays: +4. Click the icon next to the IP address whose details you want to view, then click **More info**. - + A dialog box appears. You can view the following information: - The IP address - - The **region** of the IP address + - The **source** of the IP address, and its scope: the Private Network for a private IP, the Availability Zone for a public zonal IP, or the region for a public regional IP - Which **resource** (if any) it is attached to - The **ID** of the IP address - - The date on which the IP was **created**. This corresponds to the date it was reserved in IPAM, either via a manual [API reservation](https://www.scaleway.com/en/developers/api/ipam/#path-ips-book-a-new-ip) or when it was attached to a resource on a Private Network. + - The date on which the IP was **created**. This corresponds to the date it was reserved in IPAM, either through a manual reservation or when it was attached to a resource. - The date on which the IP was last **updated** - The **tags** associated with the IP address. -4. Click **OK** to exit the screen. +5. Click **OK** to exit the screen. -## How to edit the tags of a private IP address +## Edit the tags of an IP address -Tags help you organize your IPAM IP addresses. You can assign as many tags as you want to each reserved IP, and use them for identification and sorting purposes. +Tags help you organize your IPAM IP addresses. You can assign as many tags as you want to each address, whatever its source, and use them for identification and sorting purposes. -1. Follow steps 1 to 3 [above](#how-to-view-the-details-of-a-private-ip-address). +1. Follow steps 1 to 4 in section [View the details of an IP address](#view-the-details-of-an-ip-address) above. 2. Click into the **Tags** box, and type the tag(s) you want to add. Alternatively, click the **x** symbol to remove any existing tags. diff --git a/pages/ipam/how-to/release-ip.mdx b/pages/ipam/how-to/release-ip.mdx new file mode 100644 index 0000000000..856298a043 --- /dev/null +++ b/pages/ipam/how-to/release-ip.mdx @@ -0,0 +1,37 @@ +--- +title: How to release a reserved IP address +description: Learn how to release a reserved public or private IP address with Scaleway's IPAM, and return it to the pool of available addresses. +tags: ipam ip-address-manager reserved-ip release private-ip-address public-ip-address +dates: + validation: 2026-08-27 + posted: 2026-08-27 +--- +import Requirements from '@macros/iam/requirements.mdx' + + +You can release an IP address that you [reserved with IPAM](/ipam/how-to/reserve-ip/), as long as it is not attached to a resource. + +- Releasing a public IP means it goes back into the general Scaleway pool, and billing for the address stops. +- Releasing a private IP means it goes back into the general pool of available addresses for that Private Network, and could potentially be auto-allocated to a new resource joining the network. + + + +- A Scaleway account logged in to the [console](https://console.scaleway.com) +- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization +- A [reserved IP address](/ipam/how-to/reserve-ip/) that is not attached to a resource + +## Release a reserved IP address + + +Only reserved IPs that are not attached to a resource can be released. + + +1. In the [Scaleway console](https://console.scaleway.com) side menu, click **Network** > **IPAM**. + +2. Use the **Source** filter, and the other filters that are displayed alongside it, to find the IP address you want to release. + +3. Click the icon next to the IP you want to release, and then click **Release IP**. A confirmation dialog appears. + +4. Click **Confirm**. + +The IP address is released. diff --git a/pages/ipam/how-to/reserve-ip.mdx b/pages/ipam/how-to/reserve-ip.mdx index 4a7609a622..b0956fee31 100644 --- a/pages/ipam/how-to/reserve-ip.mdx +++ b/pages/ipam/how-to/reserve-ip.mdx @@ -1,91 +1,58 @@ --- title: How to reserve an IP address -description: Learn how to reserve IP addresses with Scaleway's IPAM. This step-by-step guide helps you easily manage and allocate IPs for future use when attaching resources to your Private Network, ensuring efficient network configuration. -tags: ipam ip-address-manager private-ip-address ip-address reserve static +description: Learn how to reserve public and private IP addresses with Scaleway's IPAM. This step-by-step guide helps you allocate IPs in advance, for later use with your Scaleway resources. +tags: ipam ip-address-manager private-ip-address public-ip-address ip-address reserve static dates: - validation: 2025-09-22 + validation: 2026-08-27 posted: 2024-09-05 --- import Requirements from '@macros/iam/requirements.mdx' -import image from './assets/scaleway-reserve-ip.webp' - **IP** **A**ddress **M**anager (IPAM) is Scaleway's tool for planning, tracking and managing the IP address space of Scaleway products. It acts as a single source of truth for the IP addresses of Scaleway resources. - -You can use IPAM to reserve a private IP address from a given Private Network's [CIDR block](/vpc/concepts/#cidr-block). When you reserve an IP in this way, it stops it from being potentially auto-allocated to new resources being attached to the Private Network. You can then use the reserved address to attach the specific resource of your choice to the Private Network. If you later detach the resource from the network, the reserved IP will stay reserved, until you either release it back into the general pool, or use it to attach a different resource. + +You can use IPAM to reserve an IP address from any of the following sources: + +- **Private IPs**: addresses from the [CIDR block](/vpc/concepts/#cidr-block) of one of your Private Networks. Reserving such an address prevents it from being auto-allocated to new resources attached to the Private Network, and lets you use it to attach the specific resource of your choice. +- **Public regional IPs**: public addresses scoped to a whole region, such as `fr-par`. +- **Public zonal IPs**: public addresses scoped to a single Availability Zone, such as `fr-par-1`. + +A reserved IP address has a lifecycle of its own, separate from the resource it is attached to. If you detach or delete the resource, the address stays reserved, until you either release it or use it to attach a different resource. -Currently, only **CPU & GPU Instances**, **Elastic Metal servers**, **Load Balancers**, and **Public Gateways** are compatible with reserved private IPs. Support for Managed Databases will be coming soon. +Currently, only CPU & GPU Instances, Elastic Metal servers, Load Balancers, and Public Gateways are compatible with reserved private IPs. -This page sets out the steps necessary to reserve an IP address with IPAM. - - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/glossary/#owner) status or [IAM permissions](/iam/concepts/glossary/#permission) allowing you to perform actions in the intended Organization - At least one [Private Network](/vpc/how-to/create-private-network/) -## How to reserve a private IP address - -The procedure is the same, whether you want to use the IP to attach a Scaleway-managed resource (Instance, Elastic Metal server etc.), or a custom resource (such as a VM hosted on an Elastic Metal server). +## Reserve an IP address 1. Click **IPAM** in the **Network** section of the [Scaleway console](https://console.scaleway.com) side menu. -2. Click **Reserve private IP**. The following screen displays: - - - -3. Define the parameters for the private IP address you want to reserve: - - **IP type**: IPv4 or IPv6 - - **Tags**: Tags to help you filter and manage your reserved IPs later - - **Region**: The region in which you want to reserve a private IP address - - **VPC**: The VPC in which you want to reserve a private IP address - - **Private Network**: The Private Network in which you want to reserve a private IP address. The reserved IP will be from this network's [CIDR block](/vpc/concepts/), and available to attach resources to this network. - -4. Define whether you want to specify the IP address to reserve, or reserve any available IP on the Private Network (the IP selected will be displayed after reservation). If specifying the IP address yourself, do **not** include the network prefix (e.g. `/22`). - - - Four IP addresses from each CIDR block are unavailable for reservation: the first two and last two in the block. For example, for the subnet `172.16.12.0/22` the following addresses cannot be reserved or assigned to any resource: `172.16.12.0`, `172.16.12.1`, `172.16.15.254` and `172.16.15.255`. - - -5. Click **Reserve** to reserve the IP. - - The IP address is reserved, and you are returned to the list of your private IP addresses, where the reserved address now displays. You can use this address to attach a resource to the Private Network you reserved it from. If and when you no longer need the reserved IP, you can [release](/ipam/quickstart/#how-to-release-a-reserved-private-ip-address) it. - -## How to attach a managed resource to a Private Network using a reserved IP address - -You can currently attach **CPU & GPU Instances**, **Elastic Metal servers**, **Load Balancers**, and **Public Gateways** to Private Networks using a reserved IP address. Support for Managed Databases will be coming soon. - -The option to use a reserved IP displays when you attach the resource to a Private Network in the console. Follow the instructions below: +2. Select the region in which you want to reserve an IP address, using the dropdown at the top of the page. -- Attach a resource to a Private Network from the [Private Networks](/vpc/how-to/attach-resources-to-pn/) product dashboard -- Attach an Instance to a Private Network from the [Instances](/instances/how-to/use-private-networks/#how-to-attach-instances-to-an-existing-private-network) product dashboard -- Attach an Elastic Metal server to a Private Network from the [Elastic Metal](/elastic-metal/how-to/use-private-networks/) product dashboard -- Attach a Load Balancer to a Private Network from the [Load Balancer](/load-balancer/how-to/use-with-private-network/) product dashboard -- Attach a Public Gateway to a Private Network from the [Public Gateways](/public-gateways/how-to/configure-a-public-gateway/#how-to-attach-a-public-gateway-to-a-private-network) product dashboard +3. Click **Reserve IP**. -## How to attach a custom resource to a Private Network using a reserved IP address +4. Select the **source** of the IP address to reserve: **Private IPs**, **Public zonal IPs**, or **Public regional IPs**. -You can use reserved IP addresses to attach custom resources, such as VMs hosted on Elastic Metal servers, to Scaleway Private Networks. In doing so, you are prompted to specify the MAC address of the custom resource. +5. Define the remaining parameters, which depend on the source you selected: -Attach the custom resource from the Private Network's dashboard in the Scaleway console, by following the procedure detailed in the [Private Networks documentation](/vpc/how-to/attach-resources-to-pn/). + - For a private IP: the **VPC** and the **Private Network** to reserve the address from. The reserved IP comes from the [CIDR block](/vpc/concepts/#cidr-block) of this network, and is available to attach resources to it. + - For a public zonal IP: the **Availability Zone** to reserve the address in. + - For a public regional IP: no further scope is required, as the address is available across the whole selected region. -## How to release a reserved private IP address +6. Select the **IP type**: **IPv4** or **IPv6**. -You can release a reserved IP address, as long as it is not attached to a resource. Releasing the IP means it goes back into the general pool of available IP addresses for that Private Network, and could potentially be auto-allocated to a new resource joining the network. +7. Optionally, add **tags** to help you filter and manage your reserved IPs later. -1. Click **IPAM** in the **Network** section of the [Scaleway console](https://console.scaleway.com) side menu. - -2. Click the three dot menu next to the IP you want to release, and then click **Release IP**. - - - Only reserved IPs that are not attached to a resource can be released. + + Four IP addresses from each Private Network CIDR block are unavailable for reservation: the first two and last two in the block. For example, for the subnet `172.16.12.0/22`, the following addresses cannot be reserved or assigned to any resource: `172.16.12.0`, `172.16.12.1`, `172.16.15.254`, and `172.16.15.255`. - A message displays asking you to confirm you want to release the IP address. - -3. Click **Confirm**. +8. Check the **Summary**, then click **Reserve** to reserve the IP. - The IP address is released. \ No newline at end of file +Your new IP address appears in the list of IP addresses, with the **Reserved** status. diff --git a/pages/ipam/how-to/set-ip-reverse.mdx b/pages/ipam/how-to/set-ip-reverse.mdx new file mode 100644 index 0000000000..6e9afaca31 --- /dev/null +++ b/pages/ipam/how-to/set-ip-reverse.mdx @@ -0,0 +1,95 @@ +--- +title: How to manage reverse DNS for public IP addresses +description: Learn how to set and reset the reverse DNS record of a public IPv4 or IPv6 address with Scaleway's IPAM, via the console or the API. +tags: ipam reverse-dns dns ipv4 ipv6 public-ip-address +dates: + validation: 2026-10-13 + posted: 2025-03-19 +--- +import Requirements from '@macros/iam/requirements.mdx' + + +Reverse DNS is the opposite of classic forward DNS, and maps an IP address to a hostname. Setting a custom reverse DNS record is useful, for example, to improve the deliverability of emails sent from your server. + +Scaleway IPAM allows you to set the reverse DNS of your public IP addresses: + +- For an IPv4 address, you set one hostname for the address. +- For an IPv6 block, you set a hostname for each individual address within the block. + + + +- A Scaleway account logged in to the [console](https://console.scaleway.com) +- [Owner](/iam/concepts/glossary/#owner) status or [IAM permissions](/iam/concepts/glossary/#permission) allowing you to perform actions in the intended Organization +- A public IPv4 address or IPv6 block, [reserved with IPAM](/ipam/how-to/reserve-ip/) or attached to a Scaleway resource +- A domain with an `A` record (for IPv4) or `AAAA` record (for IPv6) pointing to the IP address you want to configure + +## Set the reverse DNS of an IPv4 address + +1. In the [Scaleway console](https://console.scaleway.com) side menu, go to **Network** > **IPAM**. + +2. Select **Public zonal IPs** or **Public regional IPs** in the **Source** filter, and use the other filters displayed alongside it to find the IPv4 address you want to configure. + +3. Click the icon next to the IP address, and then click **Manage reverse**. A dialog box appears. + +4. Enter the fully qualified domain name (FQDN) to associate with the IP address in the **Hostname** field, without any protocol (e.g., `mail.example.com.`, not `http://mail.example.com`). + +5. Click **Save**. + +## Set the reverse DNS of IPv6 addresses + +1. In the [Scaleway console](https://console.scaleway.com) side menu, go to **Network** > **IPAM**. + +2. Select **Public zonal IPs** or **Public regional IPs** in the **Source** filter, and use the other filters displayed alongside it to find the IPv6 block you want to configure. + +3. Click the icon next to the IPv6 block, and then click **Manage reverse**. A dialog box appears. + +4. Enter an address within the block in the **IP address** field, and the FQDN to associate with it in the **Hostname** field. + +5. Optionally, click **Add another IP** to set the reverse DNS of other addresses within the same block, and repeat the previous step for each address. + +6. Click **Save**. + +## Reset the reverse DNS of an IP address + +Resetting the reverse DNS of an IP address sets it back to its default Scaleway value (e.g., `35-58-232-78.rev.scw.cloud.`). For IPv6 blocks, the reset applies to all the reverse DNS records configured within the block. + +1. In the [Scaleway console](https://console.scaleway.com) side menu, go to **Network** > **IPAM**. + +2. Select **Public zonal IPs** or **Public regional IPs** in the **Source** filter, and use the other filters displayed alongside it to find the IP address you want to reset. + +3. Click the icon next to the IP address, and then click **Reset reverse**. A confirmation dialog appears. + +4. Click **Confirm**. + +## Set reverse DNS via the IPAM API + +You can also set the reverse DNS of your IP addresses with the [update an IP](https://www.scaleway.com/en/developers/api/ipam/#path-ips-update-an-ip) call of the IPAM API, for example to automate the configuration of multiple IPv6 addresses. + +Replace `` with the ID of your IP address, and modify the payload according to the hostnames and addresses you want to configure. + + +To find the ID of your IP address, use the [list IPs](https://www.scaleway.com/en/developers/api/ipam/#path-ips-list-existing-ips) call. + + +```bash +curl -X PATCH \ + -H "X-Auth-Token: $SCW_SECRET_KEY" \ + -H "Content-Type: application/json" \ + "https://api.scaleway.com/ipam/v1/regions/fr-par/ips/" \ + -d '{ + "reverses":[ + { + "hostname":"reverse1.example.com", + "address":"2001:db8::1" + }, + { + "hostname":"reverse2.example.com", + "address":"2001:db8::2" + }, + { + "hostname":"reverse3.example.com", + "address":"2001:db8::3" + } + ] + }' +``` diff --git a/pages/ipam/menu.ts b/pages/ipam/menu.ts index 3269d121a3..2276f14b59 100644 --- a/pages/ipam/menu.ts +++ b/pages/ipam/menu.ts @@ -19,17 +19,29 @@ export const ipamMenu = { { items: [ { - label: 'List your private IP addresses', + label: 'List your IP addresses', slug: 'list-ips', }, { - label: 'Manage your private IP addresses', + label: 'Manage your IP addresses', slug: 'manage-ips', }, { label: 'Reserve an IP address', slug: 'reserve-ip', }, + { + label: 'Attach a resource using a reserved IP', + slug: 'attach-resource', + }, + { + label: 'Release a reserved IP address', + slug: 'release-ip', + }, + { + label: 'Manage reverse DNS', + slug: 'set-ip-reverse', + }, ], label: 'How to', slug: 'how-to', @@ -40,16 +52,16 @@ export const ipamMenu = { label: 'IPAM API Reference', slug: 'https://www.scaleway.com/en/developers/api/ipam/', }, - { - label: 'Set a reverse IPv6 DNS record', - slug: 'set-ip-reverse', - }, ], label: 'API/CLI', slug: 'api-cli', }, { items: [ + { + label: 'Understanding IPAM', + slug: 'understanding-ipam', + }, { label: 'Public connectivity: best practices', slug: 'public-connectivity-best-practices', diff --git a/pages/ipam/quickstart.mdx b/pages/ipam/quickstart.mdx index 3864f94080..8023b55512 100644 --- a/pages/ipam/quickstart.mdx +++ b/pages/ipam/quickstart.mdx @@ -1,84 +1,84 @@ --- title: IPAM - Quickstart description: This page shows you how to get started with Scaleway IPAM. -tags: ipam ip-address-management internet-protocol private-ip public-ip flexible-ip list-ips book-ip +tags: ipam ip-address-management internet-protocol private-ip public-ip flexible-ip zonal regional list-ips book-ip dates: - validation: 2025-09-22 + validation: 2026-10-20 posted: 2021-05-30 --- -import image from './assets/scaleway-ipam-moreinfo.webp' -import image2 from './assets/scaleway-reserve-ip.webp' - **IP** **A**ddress **M**anager (IPAM) is Scaleway's tool for planning, tracking and managing the IP address space of Scaleway products. It acts as a single source of truth for the IP addresses of Scaleway resources. -[Read more about IPAM and its current and future planned functionality](/ipam/concepts/#ipam). +You can use IPAM in the Scaleway console to list the [public](/ipam/concepts/#public-flexible-ip-address) and [private IP addresses](/ipam/concepts/#private-ip-address) of all your Scaleway resources, and view and edit their additional information. You can also [reserve](/ipam/how-to/reserve-ip/) an address in advance, and release it when you no longer need it. -You can currently use IPAM in the Scaleway console to list the [private IP addresses](/ipam/concepts/#private-ip-address) of all your Scaleway resources attached to Private Networks, and view/edit their additional information. You can also [reserve](/ipam/how-to/reserve-ip/) a private IP on one of your Private Networks and use it to attach a managed or custom resource to the network. +Every address in IPAM belongs to one of the following **sources**: -## How to list and filter your private IP addresses +- **Private IPs**: addresses on your Private Networks +- **Public zonal IPs**: public addresses scoped to a single Availability Zone, such as `fr-par-1` +- **Public regional IPs**: public addresses scoped to a whole region, such as `fr-par` -1. Click **IPAM** in the **Network** section of the [Scaleway console](https://console.scaleway.com) side menu. +## How to list and filter your IP addresses - A list of your **private IP addresses** for the **region** and **VPC** pre-selected in the filters displays. Addresses are displayed here if they are reserved in IPAM. This means either: +1. In the [Scaleway console](https://console.scaleway.com) side menu, go to **Network** > **IPAM**. - - You manually reserved an address via IPAM (currently only possible via the [IPAM API](https://www.scaleway.com/en/developers/api/ipam/#path-ips-book-a-new-ip)), or - - You [attached a resource to a Private Network](/vpc/how-to/attach-resources-to-pn/): this triggers IPAM to reserve and attach an IP address for the resource on the network. +2. Select the region whose IP addresses you want to list, using the dropdown at the top of the page. - The full range of IP addresses which are available but unreserved in each of your Private Network's [CIDR blocks](/vpc/concepts/#cidr-block) do not display in the list. +3. To display IP addresses, select their **source**. For private IPs, select a **VPC** to display them. For public zonal IPs, select a **zone**. Public regional IPs appear immediately. -2. Modify the filters of the list using the drop-down menus at the top. You can filter for IP addresses within a given **region**, **VPC** and/or **Private Network**. You can also opt to filter for only [IPv4](/ipam/concepts/#ipv4) or [IPv6](/ipam/concepts/#ipv6) addresses: + Addresses are listed here if they are reserved in IPAM. This means either: -3. Click **Apply filters** to activate the filters you chose, or **Reset** to reset all filters. + - You [reserved an address via IPAM](/ipam/how-to/reserve-ip/), or + - You [attached a resource to a Private Network](/vpc/how-to/attach-resources-to-pn/): this triggers IPAM to reserve and attach a private IP address for the resource on the network. -## How to view and edit the details of a private IP address + Addresses which are available but unreserved do not appear in the list. For Private Networks, this means the full range of addresses in each [CIDR block](/vpc/concepts/#cidr-block) is not shown. -1. Click **IPAM** in the **Network** section of the [Scaleway console](https://console.scaleway.com) side menu. +4. Refine the list using the other filters displayed alongside the **Source** filter, such as **Private Network**, **IP type** ([IPv4](/ipam/concepts/#ipv4) or [IPv6](/ipam/concepts/#ipv6)), and whether the address is attached to a resource or simply reserved. - A list of your **private IP addresses** for the **region** and **VPC** pre-selected in the filters displays. Addresses are displayed here if they are reserved in IPAM (either manually reserved via the [IPAM API](https://www.scaleway.com/en/developers/api/ipam/#path-ips-book-a-new-ip)), or attached to a resource [on a Private Network](/vpc/how-to/attach-resources-to-pn/). + Click **All filters** to display the full set of filters available for the selected source, or **Clear All** to reset them. -2. Modify the filters of the list using the drop-down menus at the top if necessary to display the required IP address. +## How to view and edit the details of an IP address -3. Click the icon next to the IP address whose details you want to view, then click **More info**. +1. In the [Scaleway console](https://console.scaleway.com) side menu, go to **Network** > **IPAM**. - A screen similar to the following displays: +2. Use the **Source** filter, and the other filters displayed alongside it, to find the IP address you want to view. - +3. Click the icon next to the IP address whose details you want to view, then click **More info**. - You can view the following information: + The details of your IP address appear: - The IP address - - The **region** of the IP address + - The **source** of the IP address, and its scope: the Private Network for a private IP, the Availability Zone for a public zonal IP, or the region for a public regional IP - Which **resource** (if any) it is attached to - The **ID** of the IP address - - The date on which the IP was **created**. This corresponds to the date it was reserved in IPAM, either via a manual [API reservation](https://www.scaleway.com/en/developers/api/ipam/#path-ips-book-a-new-ip) or when it was attached to a resource on a Private Network. + - The date on which the IP was **created**. This corresponds to the date it was reserved in IPAM, either through a manual reservation or when it was attached to a resource. - The date on which the IP was last **updated** - The **tags** associated with the IP address. You can edit these tags if you wish. 4. Click **OK** to exit the screen. -## How to reserve a private IP address +## How to reserve an IP address -The procedure is the same, whether you want to use the IP to attach a Scaleway-managed resource (Instance, Elastic Metal server etc.), or a custom resource (such as a VM hosted on an Elastic Metal server). +1. In the [Scaleway console](https://console.scaleway.com) side menu, go to **Network** > **IPAM**. -1. Click **IPAM** in the **Network** section of the [Scaleway console](https://console.scaleway.com) side menu. +2. Select the region in which you want to reserve an IP address, using the dropdown at the top of the page. -2. Click **Reserve private IP**. The following screen displays: +3. Click **Reserve IP**. The IP reservation menu appears. - +4. Select the **source** of the IP address to reserve: **Private IPs**, **Public zonal IPs**, or **Public regional IPs**. -3. Define the parameters for the private IP address you want to reserve: - - **IP type**: IPv4 or IPv6 - - **Tags**: Tags to help you filter and manage your reserved IPs later - - **Region**: The region in which you want to reserve a private IP address - - **VPC**: The VPC in which you want to reserve a private IP address - - **Private Network**: The Private Network in which you want to reserve a private IP address. The reserved IP will be from this network's [CIDR block](/vpc/concepts/), and available to attach resources to this network. +5. Define the remaining parameters, which depend on the source you selected: -4. Define whether you want to specify the IP address to reserve, or reserve any available IP on the Private Network (the IP selected will be displayed after reservation). If specifying the IP address yourself, do **not** include the network prefix (e.g. `/22`). + - For a private IP: the **VPC** and the **Private Network** to reserve the address from. The reserved IP comes from the [CIDR block](/vpc/concepts/#cidr-block) of this network, and is available to attach resources to it. + - For a public zonal IP: the **Availability Zone** to reserve the address in. + - For a public regional IP: no further scope is required, as the address is available across the whole selected region. + +6. Select the **IP type**: **IPv4** or **IPv6**, and optionally add **tags** to help you filter and manage your reserved IPs later. - Four IP addresses from each CIDR block are unavailable for reservation: the first two and last two in the block. For example, for the subnet `172.16.12.0/22` the following addresses cannot be reserved or assigned to any resource: `172.16.12.0`, `172.16.12.1`, `172.16.15.254` and `172.16.15.255`. + Four IP addresses from each Private Network CIDR block are unavailable for reservation: the first two and last two in the block. For example, for the subnet `172.16.12.0/22`, the following addresses cannot be reserved or assigned to any resource: `172.16.12.0`, `172.16.12.1`, `172.16.15.254`, and `172.16.15.255`. -5. Click **Reserve** to reserve the IP. +7. Check the **estimated cost**, then click **Reserve** to reserve the IP. + + The IP address is reserved, and appears in the list with the **Reserved** status. - The IP address is reserved, and you are returned to the list of your private IP addresses, where the reserved address now displays. You can use this address to attach a resource to the Private Network you reserved it from. If and when you no longer need the reserved IP, you can [release](#how-to-release-a-reserved-private-ip-address) it. \ No newline at end of file +You can now [attach a resource using this address](/ipam/how-to/attach-resource/), or, if and when you no longer need it, [release it](/ipam/how-to/release-ip/). diff --git a/pages/ipam/reference-content/ipv6.mdx b/pages/ipam/reference-content/ipv6.mdx index aac514f30e..e1d358d9ea 100644 --- a/pages/ipam/reference-content/ipv6.mdx +++ b/pages/ipam/reference-content/ipv6.mdx @@ -45,7 +45,7 @@ Go further with Instances and IPv6 in the following documentation: - [Compatibility between OS images and different flexible IP type combinations](/instances/reference-content/compatibility-scw-os-images-flexible-ip/) - Fix lost IPv6 connectivity when migrating to routed IP for old [Debian Buster images](/instances/troubleshooting/fix-lost-ip-connectivity-on-debian-buster/) or [RHEL images](/instances/troubleshooting/fix-unreachable-ipv6-rhel-based-instance/) - [Fix DNS resolution with a routed IPv6-only setup on Debian Bullseye](/instances/troubleshooting/fix-dns-routed-ipv6-only-debian-bullseye/) -- [Setting a reverse IPv6 DNS record via the IPAM API](/ipam/api-cli/set-ip-reverse/) +- [How to manage reverse DNS for public IP addresses](/ipam/how-to/set-ip-reverse/) ### Elastic Metal and IPv6 diff --git a/pages/ipam/reference-content/public-connectivity-best-practices.mdx b/pages/ipam/reference-content/public-connectivity-best-practices.mdx index e3195121b7..9f3793ce72 100644 --- a/pages/ipam/reference-content/public-connectivity-best-practices.mdx +++ b/pages/ipam/reference-content/public-connectivity-best-practices.mdx @@ -26,7 +26,7 @@ Public connectivity for **CPU & GPU Instances**, **Elastic Metal**, **Load Balan - A flexible IP address is a public IP address that you can attach and detach from the resource at will. - If you detach it, it returns to the pool of flexible IP addresses kept in your account for that product, and you can attach it to a different resource (or reattach it to the same one as before). -- Flexible IP addresses are scoped to a single product and a single Availability Zone (AZ). If you create a flexible IP address for an Instance in PAR-2, you can move it to a different Instance in PAR-2, but not to an Instance in PAR-1, nor to an Elastic Metal server in any AZ. +- Flexible IP addresses are either [zonal](/ipam/concepts/#zonal-ip-address) or [regional](/ipam/concepts/#regional-ip-address). A zonal address can only be attached to a resource in the same Availability Zone, whereas a regional address can be attached to a resource in any Availability Zone within its region. Other resource types generally facilitate public connectivity in other ways, e.g. via public endpoints that cannot be modified by the user. Public connectivity may be mandatory with no option to deactivate (e.g. for Apple silicon), or optional (e.g. for Managed Database). See the specific documentation for the product in question to find out more. @@ -34,11 +34,11 @@ Other resource types generally facilitate public connectivity in other ways, e.g As flexible IP addresses can be moved between resources, they provide the following advantages: -- **Seamless failover and disaster recovery**: If your Instance, for example, goes down, you can move its public IP to a different Instance in the same AZ to ensure the service remains available. +- **Seamless failover and disaster recovery**: If your Instance, for example, goes down, you can move its public IP to a different Instance to ensure the service remains available. With a regional IP address, the backup Instance can be in a different Availability Zone. - **Zero downtime during maintenance and migration**: When you need to carry out updates, migrations or maintenance on a resource, you can temporarily move its public IP to a backup resource to avoid disruption for users. - **IP retention and consistent endpoints**: Maintaining the same IP avoids the need for frequent DNS or firewall rule updates, and makes it easier to manage your dynamic cloud environments. -In the future, look out for even more improvements to our flexible IP offering, such as the ability to move flexible IPs between different types of products, and to manage all your public flexible IPs from your [IPAM](/ipam/) dashboard. +You can view, tag, reserve, and release all your public IP addresses from your [IPAM](/ipam/) dashboard. See [how to list your IP addresses](/ipam/how-to/list-ips/) to get started. ### Limiting public connectivity, prioritizing Private Networks diff --git a/pages/ipam/reference-content/understanding-ipam.mdx b/pages/ipam/reference-content/understanding-ipam.mdx new file mode 100644 index 0000000000..0672fdd68e --- /dev/null +++ b/pages/ipam/reference-content/understanding-ipam.mdx @@ -0,0 +1,46 @@ +--- +title: Understanding IPAM +description: Get detailed information on the features and behavior of Scaleway IP Address Manager (IPAM), including its support for public zonal, public regional, and private IP addresses +tags: ip address manager ipam public private ip zonal regional source +dates: + validation: 2026-10-20 + posted: 2026-09-28 +--- + +This page explains the scope, features, and behavior of Scaleway IP Address Manager (IPAM), including its support for public IP addresses. + +## Overview + +IP Address Manager (IPAM) is the Scaleway tool for planning, tracking, and managing the IP address space of Scaleway products. It acts as a single source of truth for the IP addresses of your Scaleway resources. + +IPAM holds every IP address you reserve, along with the resource it is attached to, its scope, and its tags. Managed products such as Managed Databases and Load Balancers are fully integrated into IPAM, and the [DHCP server](/vpc/concepts/#dhcp) of Private Networks uses IPAM to assign private, static IP addresses to attached resources. + +The key principle of IPAM is that an IP address has a lifecycle of its own, separate from the resource it serves. When you reserve an address, it belongs to your Organization until you release it. Detaching or deleting the resource does not release the address, so you keep it for the next resource you attach. + +## Supported IP sources + +An IPAM address belongs to one of the following **sources**: private IPs, public zonal IPs, public regional IPs. The source determines the scope of the address, the resources it can be attached to, and the filters available when you list it in the console. + +| Source | Scope | Example | Used for | +| --- | --- | --- | --- | +| Private IPs | A single Private Network | `172.16.12.2/22` | Attaching resources to a Private Network, inside a VPC | +| Public zonal IPs | A single Availability Zone | `fr-par-1` | Exposing a zonal resource, such as an Instance, to the public internet | +| Public regional IPs | A whole region | `fr-par` | Exposing a resource to the public internet, with no attachment to a single Availability Zone | + +### Private IPs + +A private IP address comes from the [CIDR block](/vpc/concepts/#cidr-block) of one of your Private Networks. It identifies a resource on that network, and is not routed on the public internet. Resources attached to Private Networks in the same VPC reach each other over these addresses. + +You can let the DHCP server of the Private Network auto-allocate an address when you attach a resource, or [reserve a specific address in advance](/ipam/how-to/reserve-ip/) and use it to attach the resource of your choice. Reserving an address stops it from being auto-allocated to any other resource joining the network. + +Private IP addresses are shown in [CIDR notation](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation). For example, `172.16.12.2/22` represents the address `172.16.12.2` and its associated block `172.16.12.0/22`. + +### Public zonal IPs + +A public zonal IP address is scoped to a single Availability Zone, such as `fr-par-1`. It is the address type used by resources that live in one Availability Zone, such as Instances, Elastic Metal servers, Load Balancers, and Public Gateways. + +A zonal address can only be attached to a resource in the same Availability Zone. If you reserve an address in `fr-par-1`, you can move it between resources in `fr-par-1`, but not to a resource in `fr-par-2`. + +### Public regional IPs + +A public regional IP address is scoped to a whole region, such as `fr-par`, rather than to one Availability Zone within it. The address is not tied to a single Availability Zone, which makes it suitable for regional resources and for setups that need to survive the loss of an Availability Zone. diff --git a/pages/ipam/troubleshooting/cant-delete-pn-reserved-ip.mdx b/pages/ipam/troubleshooting/cant-delete-pn-reserved-ip.mdx index 8514298585..59548a1af7 100644 --- a/pages/ipam/troubleshooting/cant-delete-pn-reserved-ip.mdx +++ b/pages/ipam/troubleshooting/cant-delete-pn-reserved-ip.mdx @@ -6,8 +6,6 @@ dates: validation: 2025-11-19 posted: 2025-05-15 --- -import image from './assets/scaleway-ipam-release-ip.webp' - You may be attempting to delete a Private Network VPC via the Scaleway console, API, or other developer tool, and see one of the following error messages: @@ -24,9 +22,7 @@ If your Private Network has no attached resources (Instances, Elastic Metal serv You must release the reserved private IPs from IPAM in order to delete the Private Network. -In the [IPAM section](https://console.scaleway.com/ipam/) of the Scaleway console, use the filters to select the region and VPC of your Private Network. If there are any private IPs reserved for the Private Network, [release them](/ipam/how-to/reserve-ip/#how-to-release-a-reserved-private-ip-address). - - +In the [IPAM section](https://console.scaleway.com/ipam/) of the Scaleway console, use the filters to select the region and VPC of your Private Network. If there are any private IPs reserved for the Private Network, [release them](/ipam/how-to/release-ip/). If you cannot see any reserved IPs in IPAM, check again that you have correctly used the **filters** to display reserved IPs for a given region / VPC / Private Network. In the console, IPAM shows **only** reserved IPs for the selected filters. There is no overview of all reserved IPs across all your Private Networks. diff --git a/pages/public-gateways/reference-content/understanding-v2.mdx b/pages/public-gateways/reference-content/understanding-v2.mdx index a9638790bb..5d89ef1367 100644 --- a/pages/public-gateways/reference-content/understanding-v2.mdx +++ b/pages/public-gateways/reference-content/understanding-v2.mdx @@ -51,7 +51,7 @@ When Scaleway originally introduced Public Gateways, they provided DHCP function Scaleway also introduced [IPAM](/ipam/concepts/#ipam) to act as a single source of truth for the IP addressing of all Scaleway resources. DHCP uses IPAM to ensure consistent and reliable addressing across all Private Networks. -When you [create a Private Network](/vpc/how-to/create-private-network/), you can either automatically generate a default IPv4 CIDR block, or define a custom block. A default IPv6 block is automatically created. When you attach resources to the Private Network, they automatically receive an IPv4 address (and, if compatible, an IPv6 address) from this block. Alternatively, you can [reserve a specific IP address](/ipam/how-to/reserve-ip/) from the block, and [specify this address](/ipam/how-to/reserve-ip/#how-to-attach-a-resource-to-a-private-network-using-a-reserved-ip-address) when attaching the resource. +When you [create a Private Network](/vpc/how-to/create-private-network/), you can either automatically generate a default IPv4 CIDR block, or define a custom block. A default IPv6 block is automatically created. When you attach resources to the Private Network, they automatically receive an IPv4 address (and, if compatible, an IPv6 address) from this block. Alternatively, you can [reserve a specific IP address](/ipam/how-to/reserve-ip/) from the block, and [specify this address](/ipam/how-to/attach-resource/#how-to-attach-a-managed-resource-to-a-private-network-using-a-reserved-ip-address) when attaching the resource. Whether you choose a custom or default CIDR block, automatic address assignment or use a reserved address, **the resource's private IP address does not risk changing** unless you detach the resource from the Private Network. To ensure that you can keep the same address for a resource even after detaching it, use the [reserve IP](/ipam/how-to/reserve-ip/) functionality. @@ -92,7 +92,7 @@ The DHCP object remained present in v1 of the API, despite the [migration of DHC **The DHCP object does not exist in v2 of the API**. Instead, IPAM configuration, where auto-configuration of `GatewayNetwork` is managed by IPAM and DHCP is managed by Private Networks, replaces any need for DHCP configuration via the Public Gateway. -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. +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-an-ip-address) with IPAM when attaching both standard and custom resources. ### Removal of the address field @@ -166,7 +166,7 @@ If you have any code or scripts that still call v1 of the Scaleway Public Gatewa These functionalities are no longer available. -Going forward, we expect users who were previously using custom DHCP with a Public Gateway 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. +Going forward, Scaleway recommends that users previously using custom DHCP with a Public Gateway move to the standard setup of IPAM and the built-in DHCP of Private Networks 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-an-ip-address) with IPAM when attaching both standard and custom resources. ### I use Terraform to manage my Public Gateway, what should I do? diff --git a/pages/site-to-site-vpn/how-to/create-manage-vpn-gateway.mdx b/pages/site-to-site-vpn/how-to/create-manage-vpn-gateway.mdx index c6e7e53ca5..d411564cec 100644 --- a/pages/site-to-site-vpn/how-to/create-manage-vpn-gateway.mdx +++ b/pages/site-to-site-vpn/how-to/create-manage-vpn-gateway.mdx @@ -3,7 +3,7 @@ title: How to create and manage a VPN gateway description: Learn how to create, configure, and manage VPN gateways on Scaleway to establish secure Site-to-Site VPN connections with your remote networks. tags: s2svpn vpn gateway vpn-gateway remote-access dates: - validation: 2025-12-31 + validation: 2026-10-13 posted: 2025-12-31 --- import Requirements from '@macros/iam/requirements.mdx' @@ -42,7 +42,10 @@ For a working VPN, in addition to creating a VPN gateway, you must also create: 6. **Configure network connectivity** for the VPN gateway. - **Attach to Private Network**: You must select a Private Network which the VPN gateway will connect to. This is not currently modifiable after gateway creation. You can choose either to auto-allocate the gateway's private IPv4 and IPv6 addresses on the Private Network, or select specific private IPs. You must have already [reserved these IPs via IPAM](/ipam/how-to/reserve-ip/). - - **Set up public connectivity**: Assign a public IPv4 or IPv6 address to your gateway. This will be used to establish the VPN tunnel. If you want to be able to create two connections between this gateway and a single customer gateway (for dual tunnels), you must also assign a second IP address, of the IP type not used for the first address. + - **Allow public connections**: Assign a public IPv4 and/or IPv6 address to your gateway, used to establish the VPN tunnel. If you want to be able to create 2 connections between this gateway and a single customer gateway (for dual tunnels), you must assign one address of each type. + For each IP type you check, select a **Source** (**Zonal** or **Regional**), then either: + - Select **Allocate a new public IP** to create a new address for the gateway, or + - Select an address from the **Reserved IPs** list. You must have already [reserved this IP via IPAM](/ipam/how-to/reserve-ip/), in the source matching your selection. 7. **Enter a name and (optionally) tags** for the VPN gateway. @@ -105,7 +108,7 @@ You must [deactivate route propagation](/site-to-site-vpn/how-to/create-manage-v You must manually delete any other objects associated with the gateway, such as customer gateways or routing policies, if you do not need them any more. - Any reserved private IPs that were used for the VPN gateway on its Private Network will remain reserved, and accessible from your IPAM management interface. + Any reserved IPs that were used for the VPN gateway will remain reserved in IPAM. 6. Type **DELETE** to confirm you want to proceed, then click the **Delete* button. diff --git a/pages/vpc/how-to/attach-resources-to-pn.mdx b/pages/vpc/how-to/attach-resources-to-pn.mdx index c6c597e43c..1f30db3dad 100644 --- a/pages/vpc/how-to/attach-resources-to-pn.mdx +++ b/pages/vpc/how-to/attach-resources-to-pn.mdx @@ -121,7 +121,7 @@ For Elastic Metal servers and Apple silicon Mac minis, manual configuration of t When you attach a resource to a Private Network, it gets a private IPv4 address on that network (and also an IPv6 address, if supported by the resource). Private IPs are assigned from the CIDR block defined at the time of the Private Network's creation, either via auto-assignment or specification of a particular [reserved IP](/ipam/how-to/reserve-ip/). -No matter whether it is auto-allocated or pre-reserved, the IP remains stable for as long as the resource is attached to the Private Network, and does not risk changing even across reboots and long poweroffs. An auto-allocated IP is lost only when you delete the resource or detach it from the Private Network. Reserved IPs remain reserved even after you delete the resource or detach it from the Private Network, until you [release the address](/ipam/how-to/reserve-ip/#how-to-release-a-reserved-private-ip-address). +No matter whether it is auto-allocated or pre-reserved, the IP remains stable for as long as the resource is attached to the Private Network, and does not risk changing even across reboots and long poweroffs. An auto-allocated IP is lost only when you delete the resource or detach it from the Private Network. Reserved IPs remain reserved even after you delete the resource or detach it from the Private Network, until you [release the address](/ipam/how-to/release-ip/). You can view a resource's IPv4 or v6 address in the **Attached Resources** tab of the Private Network itself (follow steps 1 - 3 above). diff --git a/pages/vpc/how-to/delete-private-network.mdx b/pages/vpc/how-to/delete-private-network.mdx index 88c58169af..09eb012245 100644 --- a/pages/vpc/how-to/delete-private-network.mdx +++ b/pages/vpc/how-to/delete-private-network.mdx @@ -16,7 +16,7 @@ import image from './assets/scaleway-delete-pn.webp' - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/glossary/#owner) status or [IAM permissions](/iam/concepts/glossary/#permission) allowing you to perform actions in the intended Organization - [Created a Private Network](/vpc/how-to/create-private-network/) -- [Detached all resources](/vpc/how-to/attach-resources-to-pn/#how-to-detach-a-resource-from-a-private-network) and [released all reserved IP addresses](/ipam/how-to/reserve-ip/#how-to-release-a-reserved-private-ip-address) from the Private Network you want to delete +- [Detached all resources](/vpc/how-to/attach-resources-to-pn/#how-to-detach-a-resource-from-a-private-network) and [released all reserved IP addresses](/ipam/how-to/release-ip/) from the Private Network you want to delete ## How to delete a Private Network diff --git a/pages/vpc/reference-content/getting-most-private-networks.mdx b/pages/vpc/reference-content/getting-most-private-networks.mdx index 6d986efc33..daf1ba5cf8 100644 --- a/pages/vpc/reference-content/getting-most-private-networks.mdx +++ b/pages/vpc/reference-content/getting-most-private-networks.mdx @@ -102,7 +102,7 @@ Different types of Scaleway resources may have different requirements and possib * **Max attached PNs**: The maximum number of Private Networks that a resource can be attached to * **Mandatory PN**: Whether or not a Private Network must necessarily be attached to this resource * **Compatible with private IPv6**: Whether or not the resource is compatible with private IPv6 addressing. Compatible resources generally acquire both an IPv4 and an IPv6 address when attached to a Private Network. -* **Compatible with reserved IPs**: Whether or not you can use a [reserved IP](/ipam/how-to/reserve-ip/#how-to-attach-a-managed-resource-to-a-private-network-using-a-reserved-ip-address) to attach the resource to a Private Network +* **Compatible with reserved IPs**: Whether or not you can use a [reserved IP](/ipam/how-to/attach-resource/#how-to-attach-a-managed-resource-to-a-private-network-using-a-reserved-ip-address) to attach the resource to a Private Network | | Instance | Elastic Metal | Apple silicon | Kubernetes | Generative APIs - Dedicated Deployment | |------------------------------|----------|---------------|---------------|------------|-------------------|