Skip to content

Commit c5f011e

Browse files
RoRoJnerda-codes
andcommitted
fix(ipam): modify attach mode for custom resources (#4677)
* fix(vpc): new custom resource attachment * fix(vpc): remove unwanted file * fix(vpc): fix faq * Apply suggestions from code review Co-authored-by: Néda <[email protected]> --------- Co-authored-by: Néda <[email protected]>
1 parent d97db06 commit c5f011e

File tree

15 files changed

+127
-77
lines changed

15 files changed

+127
-77
lines changed

pages/elastic-metal/how-to/use-private-networks.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ You can choose to enable the Private Networks feature during the [creation of yo
5252

5353
You can attach/detach Elastic Metal servers to a Private Network from either the Elastic Metal section of the console, or the VPC section.
5454

55-
You can also reserve IP addresses with IPAM and attach them to specific MAC addresses, to facilitate the attachment of virtual machines hosted on your server, to Private Networks. See the IPAM documentation on [reserving a private IP with an attached MAC address](/ipam/how-to/reserve-ip/#how-to-reserve-a-private-ip-address-with-an-attached-mac-address) for more information.
55+
You can also attach custom resources, such as virtual machines hosted on your Elastic Metal server, to Private Networks, by specifying their MAC addresses upon attachment. Follow the instructions for attaching such a resource in the [Private Networks documentation](/vpc/how-to/attach-resources-to-pn/).
5656

5757
### From the Elastic Metal section of the console
5858

pages/ipam/faq.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,4 @@ Currently, the Scaleway console only supports attachment with a reserved IP for
2626

2727
## Can I use a reserved private IP with a virtual machine hosted on my Elastic Metal server?
2828

29-
Yes, this functionality is now available via the Scaleway console and API. See [how to reserve a private IP address with an attached MAC address](/ipam/how-to/reserve-ip/#how-to-reserve-a-private-ip-address-with-an-attached-mac-address).
29+
Yes, this functionality is now available via the Scaleway console and API. Simply reserve an IP with IPAM, then select it when [attaching a custom resource to a Private Network](/vpc/how-to/attach-resources-to-pn/).

pages/ipam/how-to/reserve-ip.mdx

Lines changed: 10 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ This page sets out the steps necessary to reserve an IP address with IPAM.
3131

3232
## How to reserve a private IP address
3333

34+
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).
35+
3436
1. Click **IPAM** in the **Network** section of the [Scaleway console](https://console.scaleway.com) side menu.
3537

3638
2. Click **Reserve private IP**. The following screen displays:
@@ -50,37 +52,11 @@ This page sets out the steps necessary to reserve an IP address with IPAM.
5052
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`.
5153
</Message>
5254

53-
5. Define whether you want to attach a MAC address to the reserved IP. **Only do this for custom resources** e.g. virtual machines hosted on a Proxmox cluster on an Elastic Metal server.
54-
55-
<Message type="important">
56-
Do **not** attach a MAC address for reserved IPs you want to use with standard Scaleway resources such as Instances, Load Balancers or Elastic Metal servers themselves.
57-
</Message>
58-
59-
For more help with attaching MAC addresses, [see below](#how-to-reserve-a-private-ip-address-with-an-attached-mac-address).
60-
61-
6. Click **Reserve** to reserve the IP.
55+
5. Click **Reserve** to reserve the IP.
6256

6357
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.
6458

65-
## How to reserve a private IP address with an attached MAC address
66-
67-
When you reserve a private IP, you have the option to attach a MAC address to it. This allows you to use the IP with a custom resource e.g. virtual machines hosted on a Proxmox cluster on an Elastic Metal server. This functionality marks the final stage of replacing the now-deprecated static DHCP reservations via the Public Gateway.
68-
69-
It is only possible to attach a MAC address during the IP reservation. You cannot edit an existing reserved IP to attach a MAC address.
70-
71-
1. Follow the steps above to [reserve a private IP](#how-to-reserve-a-private-ip-address), and at step 5, check the box to attach a MAC address.
72-
73-
2. Enter the MAC address of the custom resource you want to attach, e.g. `00:1B:44:11:3A:B7`.
74-
75-
3. Enter the name of the resource. This will be used for DNS resolution on the Private Network.
76-
77-
4. Click **Reserve**.
78-
79-
The IP address is reserved, and you are returned to the list of your private IP addresses, where the reserved address now displays.
80-
81-
If you later attach this reserved IP address to a standard Scaleway resource e.g. an Instance, the attached MAC address and resource name will be erased.
82-
83-
## How to attach a resource to a Private Network using a reserved IP address
59+
## How to attach a managed resource to a Private Network using a reserved IP address
8460

8561
You can currently attach **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.
8662

@@ -92,6 +68,12 @@ The option to use a reserved IP displays when you attach the resource to a Priva
9268
- Attach a Load Balancer to a Private Network from the [Load Balancer](/load-balancer/how-to/use-with-private-network/) product dashboard
9369
- 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
9470

71+
## How to attach a custom resource to a Private Network using a reserved IP address
72+
73+
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.
74+
75+
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/).
76+
9577
## How to release a reserved private IP address
9678

9779
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.

pages/ipam/quickstart.mdx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,8 @@ You can currently use IPAM in the Scaleway console to list the [private IP addre
6161

6262
## How to reserve a private IP address
6363

64+
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).
65+
6466
1. Click **IPAM** in the **Network** section of the [Scaleway console](https://console.scaleway.com) side menu.
6567

6668
2. Click **Reserve private IP**. The following screen displays:
@@ -80,4 +82,6 @@ You can currently use IPAM in the Scaleway console to list the [private IP addre
8082
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`.
8183
</Message>
8284

83-
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/how-to/reserve-ip/#how-to-release-a-reserved-private-ip-address) it.
85+
5. Click **Reserve** to reserve the IP.
86+
87+
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.

pages/ipam/reference-content/ipv6.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ In addition to the possibility of attaching and detaching flexible IP addresses,
7171

7272
When you attach an Elastic Metal server to a Private Network, it gets both an IPv4 and an IPv6 address on that network. You can either let IPAM auto-allocate any available address, or specify a [reserved IP address](/ipam/how-to/reserve-ip/) to use.
7373

74-
You can also use IPAM's [reserve a private IP](https://www.scaleway.com/en/developers/api/ipam/#path-ips-reserve-a-new-ip) and [attach IP to custom resource](https://www.scaleway.com/en/developers/api/ipam/#path-ips-attach-ip-to-custom-resource) feature to attach an IPv6 address to a named resource via its MAC address. This is suitable for ensuring virtual machines on your Elastic Metal server get private IPv6 addresses.
74+
To attach resources such as virtual machines hosted Elastic Metal servers to Private Networks, use the [attach custom resource](/vpc/how-to/attach-resources-to-pn/) feature, specifying the MAC address of the custom resource. This is suitable for ensuring virtual machines on your Elastic Metal server get private IPv6 addresses.
7575

7676
#### Going further
7777

7.6 KB
Loading
13.2 KB
Loading

pages/vpc/faq.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,4 +119,6 @@ Nonetheless, you can also reserve specific IPs from a Private Network's CIDR blo
119119

120120
### How can I attach my VMs on a Proxmox cluster on Elastic Metal to a Private Network?
121121

122-
We recommend that you use our IPAM product for this purpose. See [how to reserve a private IP address with an attached MAC address](/ipam/how-to/reserve-ip/#how-to-reserve-a-private-ip-address-with-an-attached-mac-address).
122+
For this purpose use the option of attaching a **custom resource** to a Private Network, specifying its MAC address. Full instructions for attaching custom resources are in the [Private Networks documentation](/vpc/how-to/attach-resources-to-pn#how-can-i-manage-ip-addresses-for-my-proxmox-virtual-machines-vms-on-elastic-metal-servers).
123+
124+
You can also [reserve a private IP address](/ipam/how-to/reserve-ip/) with IPAM, and use this reserved address to attach a custom resource.
7.6 KB
Loading
13.2 KB
Loading

0 commit comments

Comments
 (0)