Skip to content

Commit 374b8be

Browse files
authored
feat(vpc_gw.v1): document behavior of non-ipam_config flags (#3364)
1 parent b096eca commit 374b8be

File tree

4 files changed

+12
-12
lines changed

4 files changed

+12
-12
lines changed

cmd/scw/testdata/test-all-usage-vpc-gw-gateway-network-create-usage.golden

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ USAGE:
88
ARGS:
99
[gateway-id] Public Gateway to connect
1010
[private-network-id] Private Network to connect
11-
[enable-masquerade] Defines whether to enable masquerade (dynamic NAT) on this network
12-
[enable-dhcp] Defines whether to enable DHCP on this Private Network. Defaults to `true` if either `dhcp_id` or `dhcp` are present. If set to `true`, either `dhcp_id` or `dhcp` must be present
11+
[enable-masquerade] Defines whether to enable masquerade (dynamic NAT) on the GatewayNetwork.
12+
[enable-dhcp] Defines whether to enable DHCP on this Private Network.
1313
[dhcp-id] ID of an existing DHCP configuration object to use for this GatewayNetwork
1414
[address] Static IP address in CIDR format to to use without DHCP
1515
[ipam-config.push-default-route] Defines whether the default route is enabled on that Gateway Network.

cmd/scw/testdata/test-all-usage-vpc-gw-gateway-network-update-usage.golden

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ USAGE:
77

88
ARGS:
99
gateway-network-id ID of the GatewayNetwork to update
10-
[enable-masquerade] Defines whether to enable masquerade (dynamic NAT) on the GatewayNetwork
11-
[enable-dhcp] Defines whether to enable DHCP on the connected Private Network
10+
[enable-masquerade] Defines whether to enable masquerade (dynamic NAT) on the GatewayNetwork.
11+
[enable-dhcp] Defines whether to enable DHCP on this Private Network.
1212
[dhcp-id] ID of the new DHCP configuration object to use with this GatewayNetwork
1313
[address] New static IP address
1414
[ipam-config.push-default-route] Defines whether the default route is enabled on that Gateway Network.

docs/commands/vpc-gw.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -515,8 +515,8 @@ scw vpc-gw gateway-network create [arg=value ...]
515515
|------|---|-------------|
516516
| gateway-id | | Public Gateway to connect |
517517
| private-network-id | | Private Network to connect |
518-
| enable-masquerade | | Defines whether to enable masquerade (dynamic NAT) on this network |
519-
| enable-dhcp | | Defines whether to enable DHCP on this Private Network. Defaults to `true` if either `dhcp_id` or `dhcp` are present. If set to `true`, either `dhcp_id` or `dhcp` must be present |
518+
| enable-masquerade | | Defines whether to enable masquerade (dynamic NAT) on the GatewayNetwork. |
519+
| enable-dhcp | | Defines whether to enable DHCP on this Private Network. |
520520
| dhcp-id | | ID of an existing DHCP configuration object to use for this GatewayNetwork |
521521
| address | | Static IP address in CIDR format to to use without DHCP |
522522
| ipam-config.push-default-route | | Defines whether the default route is enabled on that Gateway Network. |
@@ -606,8 +606,8 @@ scw vpc-gw gateway-network update <gateway-network-id ...> [arg=value ...]
606606
| Name | | Description |
607607
|------|---|-------------|
608608
| gateway-network-id | Required | ID of the GatewayNetwork to update |
609-
| enable-masquerade | | Defines whether to enable masquerade (dynamic NAT) on the GatewayNetwork |
610-
| enable-dhcp | | Defines whether to enable DHCP on the connected Private Network |
609+
| enable-masquerade | | Defines whether to enable masquerade (dynamic NAT) on the GatewayNetwork. |
610+
| enable-dhcp | | Defines whether to enable DHCP on this Private Network. |
611611
| dhcp-id | | ID of the new DHCP configuration object to use with this GatewayNetwork |
612612
| address | | New static IP address |
613613
| ipam-config.push-default-route | | Defines whether the default route is enabled on that Gateway Network. |

internal/namespaces/vpcgw/v1/vpcgw_cli.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -691,14 +691,14 @@ func vpcGwGatewayNetworkCreate() *core.Command {
691691
},
692692
{
693693
Name: "enable-masquerade",
694-
Short: `Defines whether to enable masquerade (dynamic NAT) on this network`,
694+
Short: `Defines whether to enable masquerade (dynamic NAT) on the GatewayNetwork.`,
695695
Required: false,
696696
Deprecated: false,
697697
Positional: false,
698698
},
699699
{
700700
Name: "enable-dhcp",
701-
Short: `Defines whether to enable DHCP on this Private Network. Defaults to ` + "`" + `true` + "`" + ` if either ` + "`" + `dhcp_id` + "`" + ` or ` + "`" + `dhcp` + "`" + ` are present. If set to ` + "`" + `true` + "`" + `, either ` + "`" + `dhcp_id` + "`" + ` or ` + "`" + `dhcp` + "`" + ` must be present`,
701+
Short: `Defines whether to enable DHCP on this Private Network.`,
702702
Required: false,
703703
Deprecated: false,
704704
Positional: false,
@@ -756,14 +756,14 @@ func vpcGwGatewayNetworkUpdate() *core.Command {
756756
},
757757
{
758758
Name: "enable-masquerade",
759-
Short: `Defines whether to enable masquerade (dynamic NAT) on the GatewayNetwork`,
759+
Short: `Defines whether to enable masquerade (dynamic NAT) on the GatewayNetwork.`,
760760
Required: false,
761761
Deprecated: false,
762762
Positional: false,
763763
},
764764
{
765765
Name: "enable-dhcp",
766-
Short: `Defines whether to enable DHCP on the connected Private Network`,
766+
Short: `Defines whether to enable DHCP on this Private Network.`,
767767
Required: false,
768768
Deprecated: false,
769769
Positional: false,

0 commit comments

Comments
 (0)