Skip to content

Commit bccb252

Browse files
scaleway-botremyleone
scaleway-bot
and
remyleone
authored
docs(vpc): reworked vpc documentation (#3027)
Co-authored-by: Rémy Léone <[email protected]>
1 parent 3488baf commit bccb252

8 files changed

+95
-104
lines changed

‎cmd/scw/testdata/test-all-usage-vpc-private-network-create-usage.golden

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Create a private network.
3+
Create a new Private Network. Once created, you can attach Scaleway resources in the same Availability Zone.
44

55
USAGE:
66
scw vpc private-network create [arg=value ...]
77

88
ARGS:
9-
name=<generated> The name of the private network
9+
name=<generated> Name for the Private Network
1010
[project-id] Project ID to use. If none is passed the default project ID will be used
11-
[tags.{index}] The private networks tags
12-
[subnets.{index}] Private network subnets CIDR
11+
[tags.{index}] Tags for the Private Network
12+
[subnets.{index}] Private Network subnets CIDR
1313
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2)
1414

1515
FLAGS:

‎cmd/scw/testdata/test-all-usage-vpc-private-network-delete-usage.golden

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Delete a private network.
3+
Delete an existing Private Network. Note that you must first detach all resources from the network, in order to delete it.
44

55
USAGE:
66
scw vpc private-network delete <private-network-id ...> [arg=value ...]
77

88
ARGS:
9-
private-network-id The private network ID
9+
private-network-id Private Network ID
1010
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2)
1111

1212
FLAGS:

‎cmd/scw/testdata/test-all-usage-vpc-private-network-get-usage.golden

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Get a private network.
3+
Retrieve information about an existing Private Network, specified by its Private Network ID. Its full details are returned in the response object.
44

55
USAGE:
66
scw vpc private-network get <private-network-id ...> [arg=value ...]
77

88
ARGS:
9-
private-network-id The private network id
9+
private-network-id Private Network ID
1010
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2)
1111

1212
FLAGS:

‎cmd/scw/testdata/test-all-usage-vpc-private-network-list-usage.golden

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
List private networks.
3+
List existing Private Networks in a specified Availability Zone. By default, the Private Networks returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.
44

55
USAGE:
66
scw vpc private-network list [arg=value ...]
77

88
ARGS:
9-
[order-by] The sort order of the returned private networks (created_at_asc | created_at_desc | name_asc | name_desc)
10-
[name] Filter private networks with names containing this string
11-
[tags.{index}] Filter private networks with one or more matching tags
12-
[project-id] The project ID on which to filter the returned private networks
13-
[private-network-ids.{index}] The PrivateNetwork IDs on which to filter the returned private networks
14-
[include-regional] Include regional Private Networks
15-
[organization-id] The organization ID on which to filter the returned private networks
9+
[order-by] Sort order of the returned Private Networks (created_at_asc | created_at_desc | name_asc | name_desc)
10+
[name] Name to filter for. Only Private Networks with names containing this string will be returned
11+
[tags.{index}] Tags to filter for. Only Private Networks with one or more matching tags will be returned
12+
[project-id] Project ID to filter for. Only Private Networks belonging to this Project will be returned
13+
[private-network-ids.{index}] Private Network IDs to filter for. Only Private Networks with one of these IDs will be returned
14+
[include-regional] Defines whether to include regional Private Networks in the response
15+
[organization-id] Organization ID to filter for. Only Private Networks belonging to this Organization will be returned
1616
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2 | all)
1717

1818
FLAGS:

‎cmd/scw/testdata/test-all-usage-vpc-private-network-update-usage.golden

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Update private network.
3+
Update parameters (such as name or tags) of an existing Private Network, specified by its Private Network ID.
44

55
USAGE:
66
scw vpc private-network update <private-network-id ...> [arg=value ...]
77

88
ARGS:
9-
private-network-id The private network ID
10-
[name] The name of the private network
11-
[tags.{index}] The private networks tags
9+
private-network-id Private Network ID
10+
[name] Name of the private network
11+
[tags.{index}] Tags for the Private Network
1212
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2)
1313

1414
DEPRECATED ARGS:
15-
[subnets.{index}] Private network subnets CIDR (deprecated)
15+
[subnets.{index}] Private Network subnets CIDR (deprecated)
1616

1717
FLAGS:
1818
-h, --help help for update

‎cmd/scw/testdata/test-all-usage-vpc-private-network-usage.golden

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,19 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
A private network allows interconnecting your instances in an
4-
isolated and private network. The network reachability is limited
5-
to the instances that are on the same private network. Network
6-
Interface Controllers (NICs) are available on the instance and can
7-
be freely managed (adding IP addresses, shutdown interface...)
8-
9-
Note that an instance can be a part of multiple private networks.
3+
A Private Network allows you to interconnect your Scaleway resources in an
4+
isolated and private network. Network reachability is limited
5+
to resources that are on the same Private Network. Note that a resource can
6+
be part of multiple Private Networks.
107

118
USAGE:
129
scw vpc private-network <command>
1310

1411
AVAILABLE COMMANDS:
15-
create Create a private network
16-
delete Delete a private network
17-
get Get a private network
18-
list List private networks
19-
update Update private network
12+
create Create a Private Network
13+
delete Delete a Private Network
14+
get Get a Private Network
15+
list List Private Networks
16+
update Update Private Network
2017

2118
FLAGS:
2219
-h, --help help for private-network

‎docs/commands/vpc.md

Lines changed: 35 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -3,28 +3,25 @@
33
VPC API.
44

55
- [Private network management command](#private-network-management-command)
6-
- [Create a private network](#create-a-private-network)
7-
- [Delete a private network](#delete-a-private-network)
8-
- [Get a private network](#get-a-private-network)
9-
- [List private networks](#list-private-networks)
10-
- [Update private network](#update-private-network)
6+
- [Create a Private Network](#create-a-private-network)
7+
- [Delete a Private Network](#delete-a-private-network)
8+
- [Get a Private Network](#get-a-private-network)
9+
- [List Private Networks](#list-private-networks)
10+
- [Update Private Network](#update-private-network)
1111

1212

1313
## Private network management command
1414

15-
A private network allows interconnecting your instances in an
16-
isolated and private network. The network reachability is limited
17-
to the instances that are on the same private network. Network
18-
Interface Controllers (NICs) are available on the instance and can
19-
be freely managed (adding IP addresses, shutdown interface...)
15+
A Private Network allows you to interconnect your Scaleway resources in an
16+
isolated and private network. Network reachability is limited
17+
to resources that are on the same Private Network. Note that a resource can
18+
be part of multiple Private Networks.
2019

21-
Note that an instance can be a part of multiple private networks.
2220

2321

22+
### Create a Private Network
2423

25-
### Create a private network
26-
27-
Create a private network.
24+
Create a new Private Network. Once created, you can attach Scaleway resources in the same Availability Zone.
2825

2926
**Usage:**
3027

@@ -37,17 +34,17 @@ scw vpc private-network create [arg=value ...]
3734

3835
| Name | | Description |
3936
|------|---|-------------|
40-
| name | Required<br />Default: `<generated>` | The name of the private network |
37+
| name | Required<br />Default: `<generated>` | Name for the Private Network |
4138
| project-id | | Project ID to use. If none is passed the default project ID will be used |
42-
| tags.{index} | | The private networks tags |
43-
| subnets.{index} | | Private network subnets CIDR |
39+
| tags.{index} | | Tags for the Private Network |
40+
| subnets.{index} | | Private Network subnets CIDR |
4441
| zone | Default: `fr-par-1`<br />One of: `fr-par-1`, `fr-par-2`, `fr-par-3`, `nl-ams-1`, `nl-ams-2`, `pl-waw-1`, `pl-waw-2` | Zone to target. If none is passed will use default zone from the config |
4542

4643

4744

48-
### Delete a private network
45+
### Delete a Private Network
4946

50-
Delete a private network.
47+
Delete an existing Private Network. Note that you must first detach all resources from the network, in order to delete it.
5148

5249
**Usage:**
5350

@@ -60,14 +57,14 @@ scw vpc private-network delete <private-network-id ...> [arg=value ...]
6057

6158
| Name | | Description |
6259
|------|---|-------------|
63-
| private-network-id | Required | The private network ID |
60+
| private-network-id | Required | Private Network ID |
6461
| zone | Default: `fr-par-1`<br />One of: `fr-par-1`, `fr-par-2`, `fr-par-3`, `nl-ams-1`, `nl-ams-2`, `pl-waw-1`, `pl-waw-2` | Zone to target. If none is passed will use default zone from the config |
6562

6663

6764

68-
### Get a private network
65+
### Get a Private Network
6966

70-
Get a private network.
67+
Retrieve information about an existing Private Network, specified by its Private Network ID. Its full details are returned in the response object.
7168

7269
**Usage:**
7370

@@ -80,14 +77,14 @@ scw vpc private-network get <private-network-id ...> [arg=value ...]
8077

8178
| Name | | Description |
8279
|------|---|-------------|
83-
| private-network-id | Required | The private network id |
80+
| private-network-id | Required | Private Network ID |
8481
| zone | Default: `fr-par-1`<br />One of: `fr-par-1`, `fr-par-2`, `fr-par-3`, `nl-ams-1`, `nl-ams-2`, `pl-waw-1`, `pl-waw-2` | Zone to target. If none is passed will use default zone from the config |
8582

8683

8784

88-
### List private networks
85+
### List Private Networks
8986

90-
List private networks.
87+
List existing Private Networks in a specified Availability Zone. By default, the Private Networks returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.
9188

9289
**Usage:**
9390

@@ -100,20 +97,20 @@ scw vpc private-network list [arg=value ...]
10097

10198
| Name | | Description |
10299
|------|---|-------------|
103-
| order-by | One of: `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc` | The sort order of the returned private networks |
104-
| name | | Filter private networks with names containing this string |
105-
| tags.{index} | | Filter private networks with one or more matching tags |
106-
| project-id | | The project ID on which to filter the returned private networks |
107-
| private-network-ids.{index} | | The PrivateNetwork IDs on which to filter the returned private networks |
108-
| include-regional | | Include regional Private Networks |
109-
| organization-id | | The organization ID on which to filter the returned private networks |
100+
| order-by | One of: `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc` | Sort order of the returned Private Networks |
101+
| name | | Name to filter for. Only Private Networks with names containing this string will be returned |
102+
| tags.{index} | | Tags to filter for. Only Private Networks with one or more matching tags will be returned |
103+
| project-id | | Project ID to filter for. Only Private Networks belonging to this Project will be returned |
104+
| private-network-ids.{index} | | Private Network IDs to filter for. Only Private Networks with one of these IDs will be returned |
105+
| include-regional | | Defines whether to include regional Private Networks in the response |
106+
| organization-id | | Organization ID to filter for. Only Private Networks belonging to this Organization will be returned |
110107
| zone | Default: `fr-par-1`<br />One of: `fr-par-1`, `fr-par-2`, `fr-par-3`, `nl-ams-1`, `nl-ams-2`, `pl-waw-1`, `pl-waw-2`, `all` | Zone to target. If none is passed will use default zone from the config |
111108

112109

113110

114-
### Update private network
111+
### Update Private Network
115112

116-
Update private network.
113+
Update parameters (such as name or tags) of an existing Private Network, specified by its Private Network ID.
117114

118115
**Usage:**
119116

@@ -126,10 +123,10 @@ scw vpc private-network update <private-network-id ...> [arg=value ...]
126123

127124
| Name | | Description |
128125
|------|---|-------------|
129-
| private-network-id | Required | The private network ID |
130-
| name | | The name of the private network |
131-
| tags.{index} | | The private networks tags |
132-
| ~~subnets.{index}~~ | Deprecated | Private network subnets CIDR (deprecated) |
126+
| private-network-id | Required | Private Network ID |
127+
| name | | Name of the private network |
128+
| tags.{index} | | Tags for the Private Network |
129+
| ~~subnets.{index}~~ | Deprecated | Private Network subnets CIDR (deprecated) |
133130
| zone | Default: `fr-par-1`<br />One of: `fr-par-1`, `fr-par-2`, `fr-par-3`, `nl-ams-1`, `nl-ams-2`, `pl-waw-1`, `pl-waw-2` | Zone to target. If none is passed will use default zone from the config |
134131

135132

0 commit comments

Comments
 (0)