Skip to content

Commit 3202c63

Browse files
committed
fix(vpc): revamp quickstart
1 parent 4bbc984 commit 3202c63

File tree

3 files changed

+74
-16
lines changed

3 files changed

+74
-16
lines changed
28.9 KB
Loading
144 KB
Loading

pages/vpc/quickstart.mdx

Lines changed: 74 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,29 @@ content:
77
paragraph: This page shows you how to get started with Scaleway Virtual Private Cloud (VPC).
88
tags: vpc virtual-private-cloud regional private network dhcp private-ip
99
dates:
10-
validation: 2025-02-20
10+
validation: 2025-04-24
1111
posted: 2022-02-06
1212
categories:
1313
- network
1414
---
1515

16-
VPC allows you to build your own **V**irtual **P**rivate **C**loud on top of Scaleway's shared public cloud. One default VPC per region is automatically created per Scaleway [Project](/organizations-and-projects/concepts/#project), and you can create more if you wish. Within each VPC, you can create **Private Networks** and attach Scaleway resources (Instances, Elastic Metal servers, Load Balancers etc.) to them, as long as the resources are within the network's region.
16+
VPC allows you to build your own **V**irtual **P**rivate **C**loud on top of Scaleway's shared public cloud.
1717

18-
<Lightbox src="scaleway-vpc-pn-diag.webp" alt="A diagram shows that several Private Networks exist within a single VPC" size="small"/>
18+
One **default VPC** per region is automatically created per Scaleway [Project](/organizations-and-projects/concepts/#project), and you can create more VPCs if you wish.
1919

20-
Attached resources can then communicate between themselves in an isolated and secure virtual layer 2 network, away from the public internet. More features and resources will be coming to the VPC product in the future.
20+
Within each VPC, you can create **Private Networks** and attach Scaleway resources (Instances, Elastic Metal servers, Load Balancers etc.) to them, as long as the resources are within the network's region. Resources attached to a Private Network can communicate between themselves in an isolated and secure virtual layer 2 network, away from the public internet.
21+
22+
**VPC routing** facilitates the automatic routing of traffic between the Private Networks of a VPC, as well as the ability to define custom routes between resources. Finely control and limit routing between resources in a VPC via the Network Access Control List (currently available only via the VPC API).
23+
24+
Attach a **Public Gateway** to your VPC to give your resources controlled access to the public internet via the Private Network.
25+
26+
<Lightbox src="scaleway-vpc-basics.webp" alt="Three diagrams show 1. Many VPCs existing within a Scaleway Project, 2. Many Private Networks existing within a VPC and 3. A Public Gateway attached to a Private Network giving Internet access." size="large"/>
27+
28+
This quickstart walks you through the process of getting started with Scaleway VPC.
29+
30+
<Message type="tip">
31+
If you are looking for detailed guidance on constructing your private infrastructure according to best practices, see our [basic VPC use case](/vpc/reference-content/use-case-basic/) and [Getting the most from Private Networks](/vpc/reference-content/getting-most-private-networks/) documentation.
32+
</Message>
2133

2234
<Macro id="requirements" />
2335

@@ -37,13 +49,35 @@ You see three default VPCs, one for each of the following regions:
3749
- Amsterdam `AMS`
3850
- Warsaw `WAW`
3951

40-
Any new Private Networks that you create will be added to the default VPC for their region, unless you override this by specifying a different VPC.
52+
Any new Private Networks that you create will be added to the default VPC for their region, unless you override this by [creating](#how-to-create-a-vpc) and specifying a different VPC.
53+
54+
## How to create a VPC
55+
56+
If you want to create more VPCs beyond the default ones created for you, you can do so via the following steps:
57+
58+
1. Click **VPC** in the **Network** section of the Scaleway console side menu.
59+
60+
2. Click <Icon name="plus" /> **Create a VPC**. The VPC creation wizard displays.
61+
62+
<Lightbox src="scaleway-create-vpc.webp" alt="" />
63+
64+
3. Choose a **region** in which to create your VPC.
65+
66+
4. Enter a **name** for your VPC (or use the wand icon to generate a random name). Optionally, you can also add **tags** to help organize your VPCs. Each tag should be separated by a space.
67+
68+
<Macro id="network-resource-naming"/>
69+
70+
You can create Private Networks in this VPC after you have created the VPC itself. However, you can not move an existing Private Network from one VPC to another.
71+
72+
5. Click **Create VPC** to finish.
73+
74+
Your VPC is created, and you are redirected to its **Overview** page.
4175

4276
## How to create a Private Network
4377

44-
1. Click **VPC** in the **Network** section of the side menu. The list of your VPCs displays:
78+
You can create multiple Private Networks within each VPC. Resources attached to each Private Network will be able to communicate between themselves via their private IP addresses or private hostnames, away from the public internet.
4579

46-
Each Private Network must be created within a VPC.
80+
1. Click **VPC** in the **Network** section of the side menu. The list of your VPCs displays.
4781

4882
2. Click the VPC you wish to create your Private Network in.
4983

@@ -61,11 +95,11 @@ Any new Private Networks that you create will be added to the default VPC for th
6195

6296
5. Click **Create Private Network** to finish. Your Private Network is created.
6397

64-
1. Click **VPC** in the **Network** section of the side menu. Your VPC [dashboard](https://console.scaleway.com/vpc/vpc) displays:
98+
## How to attach resources to a Private Network
6599

66-
2. Click the VPC containing the Private Network to which you want to attach a resource.
100+
1. Click **VPC** in the **Network** section of the side menu. Your VPC [dashboard](https://console.scaleway.com/vpc/vpc) displays:
67101

68-
A list of Private Networks in this VPC displays:
102+
2. Click the VPC containing the Private Network to which you want to attach a resource. A list of Private Networks in this VPC displays.
69103

70104
3. Click the Private Network to which you want to attach a resource.
71105

@@ -119,9 +153,25 @@ Any new Private Networks that you create will be added to the default VPC for th
119153

120154
You are returned to the list of attached resources, where the newly-attached resource now displays.
121155

122-
<Message type="tip">
123-
**Viewing the resource's private IP**: 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/). You can view a resource's IPv4 or v6 address in the **Attached Resources** tab of the Private Network itself (follow steps 1 - 5 above). It can also be viewed via the **Private Networks** tab of the resource's own dashboard.
124-
</Message>
156+
## How to address resources on a Private Network
157+
158+
Resources on a Private Network can be addressed via their **private IP address** or their **hostname**.
159+
160+
### Private IP address
161+
162+
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).
163+
164+
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/).
165+
166+
You can view a resource's IPv4 or v6 address in the **Attached Resources** tab of the Private Network itself (follow steps 1 - 5 above). It can also be viewed via the **Private Networks** tab of the resource's own dashboard.
167+
168+
### Hostname
169+
170+
In addition to using its private IP address, you can also access a resource on a Private Network via its hostname, thanks to VPC’s inbuilt private DNS.
171+
172+
A resource’s hostname is equivalent to the name you gave the resource when creating it. For example, if you have an Instance with the name `instance123` attached to a Private Network named `prodpn`, its address on that network is `instance123.prodpn.internal`. The `.internal` is important to allow Scaleway DNS to distinguish public and private hostnames.
173+
174+
For full information on Scaleway internal DNS and hostname formats, including troubleshooting advice, see our [dedicated DNS documentation](/vpc/reference-content/dns/).
125175

126176
## How to manage routing
127177

@@ -143,11 +193,15 @@ When your route table starts to populate, it will look something like this:
143193

144194
<Lightbox src="scaleway-route-table.webp" alt="" />
145195

146-
For help with understanding the route table and how to read it, refer to our documentation about route tables.
196+
<Message type="tip">
197+
For help with understanding the route table, refer to our full [routing documentation](/vpc/reference-content/understanding-routing/). For guidance on creating custom routes, see the [routing how-to](/vpc/how-to/manage-routing/#how-to-create-a-custom-route).
198+
</Message>
199+
200+
You can use the VPC's **N**etwork **A**ccess **C**ontrol **L**ist to limit and restrict certain routes within a VPC, but this feature is currently available via the [VPC API only](/vpc/reference-content/understanding-nacls/) only.
147201

148202
## How to delete a Private Network
149203

150-
You must [detach](/vpc/how-to/attach-resources-to-pn/#how-to-detach-a-resource-from-a-private-network) all resources from the Private Network before you can delete it.
204+
You must [detach](/vpc/how-to/attach-resources-to-pn/#how-to-detach-a-resource-from-a-private-network) all resources and release all reserved IPs from the Private Network before you can delete it.
151205

152206
1. Click **VPC** in the **Network** section of the side menu.
153207

@@ -169,4 +223,8 @@ You must [detach](/vpc/how-to/attach-resources-to-pn/#how-to-detach-a-resource-f
169223

170224
4. Type **DELETE** and click **Delete Private Network**.
171225

172-
Your Private Network is deleted.
226+
Your Private Network is deleted.
227+
228+
<Message type="tip">
229+
If you encounter errors when attempting to delete a Private Network, see our [troubleshooting guide](/vpc/troubleshooting/cant-delete-vpc-pn/).
230+
</Message>

0 commit comments

Comments
 (0)