Skip to content

Commit 4b3ba7b

Browse files
scaleway-botdevtools-ci-cd
scaleway-bot
and
devtools-ci-cd
authored
feat(interlink): enable CLI generation (#4608)
Co-authored-by: devtools-ci-cd <[email protected]>
1 parent 26c7db8 commit 4b3ba7b

30 files changed

+1601
-0
lines changed

‎cmd/scw/testdata/test-all-usage-interlink-link-attach-policy-usage.golden

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
2+
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3+
Attach a routing policy to an existing link. As all routes across the link are blocked by default, you must attach a routing policy to set IP prefix filters for allowed routes, facilitating traffic flow.
4+
5+
USAGE:
6+
scw interlink link attach_policy <link-id ...> [arg=value ...]
7+
8+
ARGS:
9+
link-id ID of the link to attach a routing policy to
10+
routing-policy-id ID of the routing policy to be attached
11+
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
12+
13+
FLAGS:
14+
-h, --help help for attach_policy
15+
16+
GLOBAL FLAGS:
17+
-c, --config string The path to the config file
18+
-D, --debug Enable debug mode
19+
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
20+
-p, --profile string The config profile to use

‎cmd/scw/testdata/test-all-usage-interlink-link-attach-vpc-usage.golden

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
2+
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3+
Attach a VPC to an existing link. This facilitates communication between the resources in your Scaleway VPC, and your on-premises infrastructure.
4+
5+
USAGE:
6+
scw interlink link attach_vpc <link-id ...> [arg=value ...]
7+
8+
ARGS:
9+
link-id ID of the link to attach VPC to
10+
vpc-id ID of the VPC to attach
11+
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
12+
13+
FLAGS:
14+
-h, --help help for attach_vpc
15+
16+
GLOBAL FLAGS:
17+
-c, --config string The path to the config file
18+
-D, --debug Enable debug mode
19+
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
20+
-p, --profile string The config profile to use

‎cmd/scw/testdata/test-all-usage-interlink-link-create-usage.golden

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
2+
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3+
Create a link (InterLink connection) in a given PoP, specifying its various configuration details. For the moment only hosted links (faciliated by partners) are available, though in the future dedicated and shared links will also be possible.
4+
5+
USAGE:
6+
scw interlink link create [arg=value ...]
7+
8+
ARGS:
9+
[project-id] Project ID to use. If none is passed the default project ID will be used
10+
name Name of the link
11+
[tags.{index}] List of tags to apply to the link
12+
pop-id PoP (location) where the link will be created
13+
bandwidth-mbps Desired bandwidth for the link. Must be compatible with available link bandwidths and remaining bandwidth capacity of the port
14+
[dedicated] If true, a dedicated link (1 link per port, dedicated to one customer) will be crated. It is not necessary to specify a `port_id` or `partner_id`. A new port will created and assigned to the link. Note that Scaleway has not yet enabled the creation of dedicated links, this field is reserved for future use.
15+
[port-id] If set, a shared link (N links per port, one of which is this customer's port) will be created. As the customer, specify the ID of the port you already have for this link. Note that shared links are not currently available. Note that Scaleway has not yet enabled the creation of shared links, this field is reserved for future use.
16+
[partner-id] If set, a hosted link (N links per port on a partner port) will be created. Specify the ID of the chosen partner, who already has a shareable port with available bandwidth. Note that this is currently the only type of link offered by Scaleway, and therefore this field must be set when creating a link.
17+
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
18+
19+
FLAGS:
20+
-h, --help help for create
21+
22+
GLOBAL FLAGS:
23+
-c, --config string The path to the config file
24+
-D, --debug Enable debug mode
25+
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
26+
-p, --profile string The config profile to use

‎cmd/scw/testdata/test-all-usage-interlink-link-delete-usage.golden

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
2+
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3+
Delete an existing link, specified by its link ID. Note that as well as deleting the link here on the Scaleway side, it is also necessary to request deletion from the partner on their side. Only when this action has been carried out on both sides will the resource be completely deleted.
4+
5+
USAGE:
6+
scw interlink link delete <link-id ...> [arg=value ...]
7+
8+
ARGS:
9+
link-id ID of the link to delete
10+
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
11+
12+
FLAGS:
13+
-h, --help help for delete
14+
15+
GLOBAL FLAGS:
16+
-c, --config string The path to the config file
17+
-D, --debug Enable debug mode
18+
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
19+
-p, --profile string The config profile to use

‎cmd/scw/testdata/test-all-usage-interlink-link-detach-policy-usage.golden

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
2+
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3+
Detach a routing policy from an existing link. Without a routing policy, all routes across the link are blocked by default.
4+
5+
USAGE:
6+
scw interlink link detach_policy <link-id ...> [arg=value ...]
7+
8+
ARGS:
9+
link-id ID of the link to detach a routing policy from
10+
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
11+
12+
FLAGS:
13+
-h, --help help for detach_policy
14+
15+
GLOBAL FLAGS:
16+
-c, --config string The path to the config file
17+
-D, --debug Enable debug mode
18+
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
19+
-p, --profile string The config profile to use

‎cmd/scw/testdata/test-all-usage-interlink-link-detach-vpc-usage.golden

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
2+
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3+
Detach a VPC from an existing link.
4+
5+
USAGE:
6+
scw interlink link detach_vpc <link-id ...> [arg=value ...]
7+
8+
ARGS:
9+
link-id ID of the link to detach the VPC from
10+
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
11+
12+
FLAGS:
13+
-h, --help help for detach_vpc
14+
15+
GLOBAL FLAGS:
16+
-c, --config string The path to the config file
17+
-D, --debug Enable debug mode
18+
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
19+
-p, --profile string The config profile to use

‎cmd/scw/testdata/test-all-usage-interlink-link-disable-propagation-usage.golden

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
2+
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3+
Prevent any prefixes from being announced in the BGP session. Traffic will not be able to flow over the InterLink until route propagation is re-enabled.
4+
5+
USAGE:
6+
scw interlink link disable_propagation <link-id ...> [arg=value ...]
7+
8+
ARGS:
9+
link-id ID of the link on which to disable route propagation
10+
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
11+
12+
FLAGS:
13+
-h, --help help for disable_propagation
14+
15+
GLOBAL FLAGS:
16+
-c, --config string The path to the config file
17+
-D, --debug Enable debug mode
18+
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
19+
-p, --profile string The config profile to use

‎cmd/scw/testdata/test-all-usage-interlink-link-enable-propagation-usage.golden

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
2+
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3+
Enable all allowed prefixes (defined in a routing policy) to be announced in the BGP session. This allows traffic to flow between the attached VPC and the on-premises infrastructure along the announced routes. Note that by default, even when route propagation is enabled, all routes are blocked. It is essential to attach a routing policy to define the ranges of routes to announce.
4+
5+
USAGE:
6+
scw interlink link enable_propagation <link-id ...> [arg=value ...]
7+
8+
ARGS:
9+
link-id ID of the link on which to enable route propagation
10+
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
11+
12+
FLAGS:
13+
-h, --help help for enable_propagation
14+
15+
GLOBAL FLAGS:
16+
-c, --config string The path to the config file
17+
-D, --debug Enable debug mode
18+
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
19+
-p, --profile string The config profile to use

‎cmd/scw/testdata/test-all-usage-interlink-link-get-usage.golden

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
2+
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3+
Get a link (InterLink connection) for the given link ID. The response object includes information about the link's various configuration details.
4+
5+
USAGE:
6+
scw interlink link get <link-id ...> [arg=value ...]
7+
8+
ARGS:
9+
link-id ID of the link to get
10+
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
11+
12+
FLAGS:
13+
-h, --help help for get
14+
15+
GLOBAL FLAGS:
16+
-c, --config string The path to the config file
17+
-D, --debug Enable debug mode
18+
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
19+
-p, --profile string The config profile to use

‎cmd/scw/testdata/test-all-usage-interlink-link-list-usage.golden

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
2+
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3+
List all your links (InterLink connections). A number of filters are available, including Project ID, name, tags and status.
4+
5+
USAGE:
6+
scw interlink link list [arg=value ...]
7+
8+
ARGS:
9+
[order-by] Order in which to return results (created_at_asc | created_at_desc | name_asc | name_desc | status_asc | status_desc)
10+
[project-id] Project ID to filter for
11+
[name] Link name to filter for
12+
[tags.{index}] Tags to filter for
13+
[status] Link status to filter for (unknown_link_status | configuring | failed | requested | refused | expired | provisioning | active | limited_connectivity | all_down | deprovisioning | deleted | locked)
14+
[bgp-v4-status] BGP IPv4 status to filter for (unknown_bgp_status | up | down)
15+
[bgp-v6-status] BGP IPv6 status to filter for (unknown_bgp_status | up | down)
16+
[pop-id] Filter for links attached to this PoP (via ports)
17+
[bandwidth-mbps] Filter for link bandwidth (in Mbps)
18+
[partner-id] Filter for links hosted by this partner
19+
[vpc-id] Filter for links attached to this VPC
20+
[routing-policy-id] Filter for links using this routing policy
21+
[pairing-key] Filter for the link with this pairing_key
22+
[organization-id] Organization ID to filter for
23+
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw | all)
24+
25+
FLAGS:
26+
-h, --help help for list
27+
28+
GLOBAL FLAGS:
29+
-c, --config string The path to the config file
30+
-D, --debug Enable debug mode
31+
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
32+
-p, --profile string The config profile to use

‎cmd/scw/testdata/test-all-usage-interlink-link-update-usage.golden

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
2+
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3+
Update an existing link, specified by its link ID. Only its name and tags can be updated.
4+
5+
USAGE:
6+
scw interlink link update <link-id ...> [arg=value ...]
7+
8+
ARGS:
9+
link-id ID of the link to update
10+
[name] Name of the link
11+
[tags.{index}] List of tags to apply to the link
12+
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
13+
14+
FLAGS:
15+
-h, --help help for update
16+
17+
GLOBAL FLAGS:
18+
-c, --config string The path to the config file
19+
-D, --debug Enable debug mode
20+
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
21+
-p, --profile string The config profile to use

‎cmd/scw/testdata/test-all-usage-interlink-link-usage.golden

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
2+
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3+
Links commands.
4+
5+
USAGE:
6+
scw interlink link <command>
7+
8+
AVAILABLE COMMANDS:
9+
attach_policy Attach a routing policy
10+
attach_vpc Attach a VPC
11+
create Create a link
12+
delete Delete a link
13+
detach_policy Detach a routing policy
14+
detach_vpc Detach a VPC
15+
disable_propagation Disable route propagation
16+
enable_propagation Enable route propagation
17+
get Get a link
18+
list List links
19+
update Update a link
20+
21+
FLAGS:
22+
-h, --help help for link
23+
24+
GLOBAL FLAGS:
25+
-c, --config string The path to the config file
26+
-D, --debug Enable debug mode
27+
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
28+
-p, --profile string The config profile to use
29+
30+
Use "scw interlink link [command] --help" for more information about a command.

‎cmd/scw/testdata/test-all-usage-interlink-partner-get-usage.golden

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
2+
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3+
Get a partner for the given partner IP. The response object includes information such as the partner's name, email address and portal URL.
4+
5+
USAGE:
6+
scw interlink partner get <partner-id ...> [arg=value ...]
7+
8+
ARGS:
9+
partner-id ID of partner to get
10+
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
11+
12+
FLAGS:
13+
-h, --help help for get
14+
15+
GLOBAL FLAGS:
16+
-c, --config string The path to the config file
17+
-D, --debug Enable debug mode
18+
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
19+
-p, --profile string The config profile to use

‎cmd/scw/testdata/test-all-usage-interlink-partner-list-usage.golden

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
2+
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3+
List all available partners. By default, the partners returned in the list are ordered by name in ascending order, though this can be modified via the `order_by` field.
4+
5+
USAGE:
6+
scw interlink partner list [arg=value ...]
7+
8+
ARGS:
9+
[order-by] Order in which to return results (name_asc | name_desc)
10+
[pop-ids.{index}] Filter for partners present (offering a port) in one of these PoPs
11+
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw | all)
12+
13+
FLAGS:
14+
-h, --help help for list
15+
16+
GLOBAL FLAGS:
17+
-c, --config string The path to the config file
18+
-D, --debug Enable debug mode
19+
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
20+
-p, --profile string The config profile to use

‎cmd/scw/testdata/test-all-usage-interlink-partner-usage.golden

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
2+
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3+
Partners commands.
4+
5+
USAGE:
6+
scw interlink partner <command>
7+
8+
AVAILABLE COMMANDS:
9+
get Get a partner
10+
list List available partners
11+
12+
FLAGS:
13+
-h, --help help for partner
14+
15+
GLOBAL FLAGS:
16+
-c, --config string The path to the config file
17+
-D, --debug Enable debug mode
18+
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
19+
-p, --profile string The config profile to use
20+
21+
Use "scw interlink partner [command] --help" for more information about a command.

‎cmd/scw/testdata/test-all-usage-interlink-pop-get-usage.golden

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
2+
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3+
Get a PoP for the given PoP ID. The response object includes the PoP's name and information about its physical location.
4+
5+
USAGE:
6+
scw interlink pop get <pop-id ...> [arg=value ...]
7+
8+
ARGS:
9+
pop-id ID of PoP to get
10+
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
11+
12+
FLAGS:
13+
-h, --help help for get
14+
15+
GLOBAL FLAGS:
16+
-c, --config string The path to the config file
17+
-D, --debug Enable debug mode
18+
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
19+
-p, --profile string The config profile to use

‎cmd/scw/testdata/test-all-usage-interlink-pop-list-usage.golden

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
2+
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3+
List all available PoPs (locations) for a given region. By default, the results are returned in ascending alphabetical order by name.
4+
5+
USAGE:
6+
scw interlink pop list [arg=value ...]
7+
8+
ARGS:
9+
[order-by] Order in which to return results (name_asc | name_desc)
10+
[name] PoP name to filter for
11+
[hosting-provider-name] Hosting provider name to filter for
12+
[partner-id] Filter for PoPs hosting an available shared port from this partner
13+
[link-bandwidth-mbps] Filter for PoPs with a shared port allowing this bandwidth size. Note that we cannot guarantee that PoPs returned will have available capacity.
14+
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw | all)
15+
16+
FLAGS:
17+
-h, --help help for list
18+
19+
GLOBAL FLAGS:
20+
-c, --config string The path to the config file
21+
-D, --debug Enable debug mode
22+
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
23+
-p, --profile string The config profile to use

0 commit comments

Comments
 (0)