Skip to content

Commit ad667ca

Browse files
RoRoJnerda-codesjcirinosclwy
authored
feat(ipam): add doc for new IPAM product (#3287)
* feat(ipam): add ipam doc * feat(ipam): start to add content * feat(ipam): finished first part of content * fix(ipam): fix faq * fix(ipam): small corrections * fix(ipam): add icons and illu * fix(ipam): resolve menu conflicts * Apply suggestions from code review Co-authored-by: nerda-codes <[email protected]> * Apply suggestions from code review Co-authored-by: nerda-codes <[email protected]> * Apply suggestions from code review Co-authored-by: nerda-codes <[email protected]> * Apply suggestions from code review Co-authored-by: Jessica <[email protected]> --------- Co-authored-by: nerda-codes <[email protected]> Co-authored-by: Jessica <[email protected]>
1 parent e4924f4 commit ad667ca

14 files changed

+370
-14
lines changed

‎faq/assets/ipam.webp

3.74 KB
Binary file not shown.

‎faq/ipam.mdx

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
meta:
3+
title: IPAM
4+
description: Discover Scaleway IPAM.
5+
content:
6+
h1: IPAM
7+
hero: assets/ipam.webp
8+
dates:
9+
validation: 2024-05-30
10+
category: network
11+
---
12+
13+
## What is IPAM?
14+
15+
**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, and has a number of associated functionalities to help manage your Scaleway IPs.
16+
17+
## What can I do with IPAM?
18+
19+
IPAM is currently in [public beta](https://www.scaleway.com/en/betas/), and rollout of IPAM functionality is being done gradually. For now, the following features are available:
20+
21+
- In the [console](https://console.scaleway.com/ipam/), you can currently use IPAM to view, tag and filter all your [private IP addresses](#private-ip-address)
22+
- With the [API](https://www.scaleway.com/en/developers/api/ipam/), you can additionally [reserve](https://www.scaleway.com/en/developers/api/ipam/#path-ips-book-a-new-ip) an available IP from a Private Network's CIDR block, or [release](https://www.scaleway.com/en/developers/api/ipam/#path-ips-release-an-ip) a previously-reserved address that you no longer want.
23+
24+
More functionality is planned for the future, including:
25+
26+
- Reserve/release private IP addresses in the console
27+
- Select a reserved private IP address to use when attaching a resource to a Private Network
28+
- Management of public IP addresses

‎menu/changelogs.json

+4
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,10 @@
173173
"category": "vpc",
174174
"label": "VPC"
175175
},
176+
{
177+
"category": "ipam",
178+
"label": "IPAM"
179+
},
176180
{
177181
"category": "public-gateways",
178182
"label": "Public Gateways"

‎menu/navigation.json

+36
Original file line numberDiff line numberDiff line change
@@ -2513,6 +2513,42 @@
25132513
"label": "VPC",
25142514
"slug": "vpc"
25152515
},
2516+
{
2517+
"items": [
2518+
{
2519+
"label": "IPAM Overview",
2520+
"slug": "../ipam"
2521+
},
2522+
{
2523+
"label": "Concepts",
2524+
"slug": "concepts"
2525+
},
2526+
{
2527+
"label": "Quickstart",
2528+
"slug": "quickstart"
2529+
},
2530+
{
2531+
"label": "FAQ",
2532+
"slug": "../../faq/ipam"
2533+
},
2534+
{
2535+
"items": [
2536+
{
2537+
"label": "List your private IP addresses",
2538+
"slug": "list-ips"
2539+
},
2540+
{
2541+
"label": "Manage your private IP addresses",
2542+
"slug": "manage-ips"
2543+
}
2544+
],
2545+
"label": "How to",
2546+
"slug": "how-to"
2547+
}
2548+
],
2549+
"label": "IPAM",
2550+
"slug": "ipam"
2551+
},
25162552
{
25172553
"items": [
25182554
{

‎network/ipam/assets/scaleway-ipam-moreinfo.webp

12.1 KB
Binary file not shown.

‎network/ipam/concepts.mdx

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
meta:
3+
title: IPAM - Concepts
4+
description: This page explains all the concepts related to IPAM
5+
content:
6+
h1: IPAM - Concepts
7+
paragraph: This page explains all the concepts related to IPAM
8+
tags: ipam ip-address-management internet-protocol private-ip public-ip flexible-ip list-ips book-ip
9+
dates:
10+
validation: 2024-05-30
11+
categories:
12+
- networks
13+
---
14+
15+
## IPAM
16+
17+
**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. Managed products, such as Databases and Load Balancer, are fully integrated into IPAM, and Private Networks' [DHCP server](/network/vpc/concepts/#dhcp) uses IPAM to assign private, static IP addresses to attached resources.
18+
19+
The public rollout of IPAM functionality is being carried out gradually: IPAM is currently in [public beta](https://www.scaleway.com/en/betas/).
20+
21+
- In the [console](https://console.scaleway.com/ipam/), you can currently use IPAM to view, tag and filter all your [private IP addresses](#private-ip-address)
22+
- With the [API](https://www.scaleway.com/en/developers/api/ipam/), you can additionally [reserve](https://www.scaleway.com/en/developers/api/ipam/#path-ips-book-a-new-ip) an available IP from a Private Network's CIDR block, or [release](https://www.scaleway.com/en/developers/api/ipam/#path-ips-release-an-ip) a previously-reserved address that you no longer want.
23+
24+
More functionality is planned for the future, including:
25+
26+
- Reserve/release private IP addresses in the console
27+
- Select a reserved private IP address to use when attaching a resource to a Private Network
28+
- Management of public IP addresses
29+
30+
## IPv4
31+
32+
Internet Protocol Version 4 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`.
33+
34+
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.
35+
36+
## IPv6
37+
38+
Internet Protocol Version 6 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`.
39+
40+
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.
41+
42+
## Private IP address
43+
44+
Private IP addresses identify devices on Private Networks. They are not routed on the public internet, and can be used to route traffic privately between resources attached to the Private Network, as well as to [other Private Networks in the same VPC](/network/vpc/concepts/#routing).
45+
46+
When a resource joins a Private Network, the Private Network's [DHCP](/network/vpc/concepts/#dhcp) assigns it a private [IPv4](#ipv4) address (and an additional [IPv6](#ipv6) address for IPv6-compatible resources) for identification on that network. This IP is selected from the Private Network's [CIDR](/network/vpc/concepts/#cidr-block) block. The IP address will then not change unless you detach the resource from the Private Network, or delete the resource.
47+
48+
## Public (flexible) IP address
49+
50+
Public IP addresses identify devices on the public internet. You can enter the public IP address of an Instance into any browser connected to the Internet, and access content being served from that Instance.
51+
52+
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](/compute/instances/) one or more public IP addresses ([IPv4](#ipv4) and/or IPv6), or alternatively, no public IP address at all.
53+
54+
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.

‎network/ipam/how-to/assets/scaleway-ipam-moreinfo.webp

12.1 KB
Binary file not shown.

‎network/ipam/how-to/index.mdx

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
meta:
3+
title: IPAM - How Tos
4+
description: IPAM How Tos
5+
content:
6+
h1: IPAM - How Tos
7+
paragraph: IPAM How Tos
8+
---

‎network/ipam/how-to/list-ips.mdx

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
meta:
3+
title: How to list your private IP addresses
4+
description: This page explains how to list your private IP addresses with Scaleway's IPAM
5+
content:
6+
h1: How to list your private IP addresses
7+
paragraph: This page explains how to list your private IP addresses with Scaleway's IPAM
8+
tags: ipam ip-address-manager private-ip-address ip-address ip filter reserve-ip-address
9+
dates:
10+
validation: 2024-05-30
11+
posted: 2024-05-30
12+
categories:
13+
- network
14+
---
15+
16+
**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.
17+
18+
[Read more about IPAM and future planned functionality](/network/ipam/concepts/#ipam).
19+
20+
You can currently use IPAM in the Scaleway console to list the [private IP addresses](/network/ipam/concepts/#private-ip-address) of all your Scaleway resources attached to Private Networks.
21+
22+
<Macro id="requirements" />
23+
24+
- A Scaleway account logged into the [console](https://console.scaleway.com)
25+
- [Owner](/identity-and-access-management/iam/concepts/#owner) status or [IAM permissions](/identity-and-access-management/iam/concepts/#permission) allowing you to perform actions in the intended Organization
26+
- At least one resource [attached to a Private Network](/network/vpc/how-to/attach-resources-to-pn/).
27+
28+
## How to list and filter your private IP addresses
29+
30+
1. Click **IPAM** in the **Network** section of the [Scaleway console](https://console.scaleway.com) side menu.
31+
32+
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:
33+
34+
- 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
35+
- You [attached a resource to a Private Network](/network/vpc/how-to/attach-resources-to-pn/): this triggers IPAM to reserve and attach an IP address for the resource on the network.
36+
37+
The full range of IP addresses which are available but unreserved in each of your Private Network's [CIDR blocks](/network/vpc/concepts/#cidr-block) do not display in the list.
38+
39+
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](/network/ipam/concepts/#ipv4) or [IPv6](/network/ipam/concepts/#ipv6) addresses:
40+
41+
3. Click **Apply filters** to activate the filters you chose, or **Reset** to reset all filters.

‎network/ipam/how-to/manage-ips.mdx

+61
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
meta:
3+
title: How to manage your private IP addresses
4+
description: This page explains how to manage your private IP addresses with Scaleway's IPAM
5+
content:
6+
h1: How to manage your private IP addresses
7+
paragraph: This page explains how to manage your private IP addresses with Scaleway's IPAM
8+
tags: ipam ip-address-manager private-ip-address ip-address ip tags manage edit
9+
dates:
10+
validation: 2024-05-30
11+
posted: 2024-05-30
12+
categories:
13+
- network
14+
---
15+
16+
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](/network/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).
17+
18+
The management actions currently available include:
19+
- Viewing the details of a private IP address, including its ID, tags, creation date and to which resource (if any) it is attached
20+
- Editing the tags of a private IP address
21+
22+
<Macro id="requirements" />
23+
24+
- A Scaleway account logged into the [console](https://console.scaleway.com)
25+
- [Owner](/identity-and-access-management/iam/concepts/#owner) status or [IAM permissions](/identity-and-access-management/iam/concepts/#permission) allowing you to perform actions in the intended Organization
26+
- At least one resource [attached to a Private Network](/network/vpc/how-to/attach-resources-to-pn/).
27+
28+
## How to view the details of a private IP address
29+
30+
1. Click **IPAM** in the **Network** section of the [Scaleway console](https://console.scaleway.com) side menu.
31+
32+
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](/network/vpc/how-to/attach-resources-to-pn/).
33+
34+
2. Modify the filters of the list using the drop-down menus at the top if necessary to display the required IP address.
35+
36+
3. Click the <Icon name="more" /> icon next to the IP address whose details you want to view, then click **More info**.
37+
38+
A screen similar to the following displays:
39+
40+
<Lightbox src="scaleway-ipam-moreinfo.webp" alt=""/>
41+
42+
You can view the following information:
43+
- The IP address
44+
- The **region** of the IP address
45+
- Which **resource** (if any) it is attached to
46+
- The **ID** of the IP address
47+
- 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.
48+
- The date on which the IP was last **updated**
49+
- The **tags** associated with the IP address.
50+
51+
4. Click **OK** to exit the screen.
52+
53+
## How to edit the tags of a private IP address
54+
55+
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.
56+
57+
1. Follow steps 1 to 3 [above](#how-to-view-the-details-of-a-private-ip-address).
58+
59+
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.
60+
61+
3. Click **OK** to exit the screen.

‎network/ipam/index.mdx

+61
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
meta:
3+
title: IPAM Documentation
4+
description: Dive into Scaleway IPAM with our quickstart guides, how-tos, tutorials and more.
5+
---
6+
7+
<ProductHeader
8+
productName="IPAM"
9+
productLogo="ipam"
10+
description="IP Address Management (IPAM) lets you easily list and manage your Scaleway IP addresses."
11+
url="/network/ipam/quickstart/"
12+
label="IPAM Quickstart"
13+
/>
14+
15+
## Getting Started
16+
17+
<Grid>
18+
<SummaryCard
19+
title="Quickstart"
20+
icon="rocket"
21+
description="Learn how to get started using IPAM."
22+
label="View Quickstart"
23+
url="/network/ipam/quickstart/"
24+
/>
25+
<SummaryCard
26+
title="Concepts"
27+
icon="info"
28+
description="Core concepts that give you a better understanding of IPAM."
29+
label="View Concepts"
30+
url="/network/ipam/concepts/"
31+
/>
32+
<SummaryCard
33+
title="How-tos"
34+
icon="help-circle-outline"
35+
description="Check out our guides to using IPAM."
36+
label="View How-tos"
37+
url="/network/ipam/how-to/"
38+
/>
39+
<SummaryCard
40+
title="Additional Content"
41+
icon="book-open-outline"
42+
description="Go beyond the basics with detailed, in-depth guides to understanding IPAM."
43+
label="Read more"
44+
url="/network/ipam/reference-content/"
45+
/>
46+
</Grid>
47+
48+
<ClickableBanner
49+
productLogo="console"
50+
title="IPAM API"
51+
description="Use IPAM via the Scaleway API."
52+
url="https://www.scaleway.com/en/developers/api/ipam/"
53+
label="Go to IPAM API"
54+
/>
55+
56+
## Changelog
57+
58+
<ChangelogList
59+
productName="ipam"
60+
numberOfChanges={3}
61+
/>

‎network/ipam/quickstart.mdx

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
meta:
3+
title: IPAM - Quickstart
4+
description: This page shows you how to get started with Scaleway IPAM.
5+
content:
6+
h1: IPAM - Quickstart
7+
paragraph: This page shows you how to get started with Scaleway IPAM.
8+
tags: ipam ip-address-management internet-protocol private-ip public-ip flexible-ip list-ips book-ip
9+
dates:
10+
validation: 2024-05-30
11+
posted: 2021-05-30
12+
categories:
13+
- network
14+
---
15+
16+
**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.
17+
18+
[Read more about IPAM and future planned functionality](/network/ipam/concepts/#ipam).
19+
20+
You can currently use IPAM in the Scaleway console to list the [private IP addresses](/network/ipam/concepts/#private-ip-address) of all your Scaleway resources attached to Private Networks, and view/edit their additional information.
21+
22+
## How to list and filter your private IP addresses
23+
24+
1. Click **IPAM** in the **Network** section of the [Scaleway console](https://console.scaleway.com) side menu.
25+
26+
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:
27+
28+
- 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
29+
- You [attached a resource to a Private Network](/network/vpc/how-to/attach-resources-to-pn/): this triggers IPAM to reserve and attach an IP address for the resource on the network.
30+
31+
The full range of IP addresses which are available but unreserved in each of your Private Network's [CIDR blocks](/network/vpc/concepts/#cidr-block) do not display in the list.
32+
33+
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](/network/ipam/concepts/#ipv4) or [IPv6](/network/ipam/concepts/#ipv6) addresses:
34+
35+
3. Click **Apply filters** to activate the filters you chose, or **Reset** to reset all filters.
36+
37+
## How to view and edit the details of a private IP address
38+
39+
1. Click **IPAM** in the **Network** section of the [Scaleway console](https://console.scaleway.com) side menu.
40+
41+
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](/network/vpc/how-to/attach-resources-to-pn/).
42+
43+
2. Modify the filters of the list using the drop-down menus at the top if necessary to display the required IP address.
44+
45+
3. Click the <Icon name="more" /> icon next to the IP address whose details you want to view, then click **More info**.
46+
47+
A screen similar to the following displays:
48+
49+
<Lightbox src="scaleway-ipam-moreinfo.webp" alt=""/>
50+
51+
You can view the following information:
52+
- The IP address
53+
- The **region** of the IP address
54+
- Which **resource** (if any) it is attached to
55+
- The **ID** of the IP address
56+
- 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.
57+
- The date on which the IP was last **updated**
58+
- The **tags** associated with the IP address. You can edit these tags if you wish.
59+
60+
4. Click **OK** to exit the screen.

‎network/public-gateways/concepts.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Scaleway is implementing [IP mobility](https://www.scaleway.com/en/blog/ip-mobil
4545

4646
## IPAM
4747

48-
IPAM is Scaleway's **IP** **A**ddress **M**anagement tool. Read more about it in our [VPC documentation](/network/vpc/concepts/#ipam).
48+
IPAM is Scaleway's **IP** **A**ddress **M**anager tool. Read more about it in our [dedicated IPAM documentation](/network/ipam/).
4949

5050
Scaleway Public Gateways are either in **Legacy mode** or **IPAM mode**. The mode of each of your gateways is displayed via a badge in the [gateway listing](https://console.scaleway.com/public-gateway/public-gateways) page of the Scaleway console.
5151

0 commit comments

Comments
 (0)