Skip to content

Commit c8348c2

Browse files
shiyuhang0shiyuhang0
committed
opt with review
1 parent 219b77c commit c8348c2

6 files changed

Lines changed: 93 additions & 14 deletions

File tree

‎docs/generate_doc/ticloud_serverless_private-link-connection.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@ Manage private link connections for dataflow
1919
### SEE ALSO
2020

2121
* [ticloud serverless](ticloud_serverless.md) - Manage TiDB Cloud Serverless clusters
22-
* [ticloud serverless private-link-connection attach](ticloud_serverless_private-link-connection_attach.md) - Attach domains to a private link connection
22+
* [ticloud serverless private-link-connection attach-domains](ticloud_serverless_private-link-connection_attach-domains.md) - Attach domains to a private link connection
2323
* [ticloud serverless private-link-connection create](ticloud_serverless_private-link-connection_create.md) - Create a private link connection for dataflow
2424
* [ticloud serverless private-link-connection delete](ticloud_serverless_private-link-connection_delete.md) - Delete a private link connection for dataflow
2525
* [ticloud serverless private-link-connection describe](ticloud_serverless_private-link-connection_describe.md) - Describe a private link connection for dataflow
26-
* [ticloud serverless private-link-connection detach](ticloud_serverless_private-link-connection_detach.md) - Detach domains from a private link connection
26+
* [ticloud serverless private-link-connection detach-domains](ticloud_serverless_private-link-connection_detach-domains.md) - Detach domains from a private link connection
2727
* [ticloud serverless private-link-connection list](ticloud_serverless_private-link-connection_list.md) - List private link connections for dataflow
2828
* [ticloud serverless private-link-connection zones](ticloud_serverless_private-link-connection_zones.md) - Get account and availability zones
2929

‎docs/generate_doc/ticloud_serverless_private-link-connection_attach-domains.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
## ticloud serverless private-link-connection attach-domains
2+
3+
Attach domains to a private link connection
4+
5+
```
6+
ticloud serverless private-link-connection attach-domains [flags]
7+
```
8+
9+
### Examples
10+
11+
```
12+
Attach domain (interactive):
13+
$ ticloud serverless private-link-connection attach-domains
14+
15+
Attach domain (non-interactive):
16+
$ ticloud serverless private-link-connection attach-domains -c <cluster-id> --private-link-connection-id <plc-id> --type <type> --unique-name <unique-name>
17+
```
18+
19+
### Options
20+
21+
```
22+
-c, --cluster-id string The cluster ID.
23+
--dry-run Set dry run mode to only show generated domains without attaching them.
24+
-h, --help help for attach-domains
25+
--private-link-connection-id string The private link connection ID.
26+
--type string The type of domain to attach, one of: [TIDBCLOUD_MANAGED CONFLUENT]
27+
--unique-name string The unique name of the domain to attach, you can use --dry-run to generate the unique name when attaching a TiDB Cloud managed domain.
28+
```
29+
30+
### Options inherited from parent commands
31+
32+
```
33+
-D, --debug Enable debug mode
34+
--no-color Disable color output
35+
-P, --profile string Profile to use from your configuration file
36+
```
37+
38+
### SEE ALSO
39+
40+
* [ticloud serverless private-link-connection](ticloud_serverless_private-link-connection.md) - Manage private link connections for dataflow
41+

‎docs/generate_doc/ticloud_serverless_private-link-connection_detach-domains.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
## ticloud serverless private-link-connection detach-domains
2+
3+
Detach domains from a private link connection
4+
5+
```
6+
ticloud serverless private-link-connection detach-domains [flags]
7+
```
8+
9+
### Examples
10+
11+
```
12+
Detach domains (interactive):
13+
$ ticloud serverless private-link-connection detach
14+
15+
Detach domains (non-interactive):
16+
$ ticloud serverless private-link-connection detach-domains -c <cluster-id> --private-link-connection-id <plc-id> --attach-domain-id <attach-id>
17+
```
18+
19+
### Options
20+
21+
```
22+
--attach-domain-id string The private link connection attach domain ID.
23+
-c, --cluster-id string The cluster ID.
24+
-h, --help help for detach-domains
25+
--private-link-connection-id string The private link connection ID.
26+
```
27+
28+
### Options inherited from parent commands
29+
30+
```
31+
-D, --debug Enable debug mode
32+
--no-color Disable color output
33+
-P, --profile string Profile to use from your configuration file
34+
```
35+
36+
### SEE ALSO
37+
38+
* [ticloud serverless private-link-connection](ticloud_serverless_private-link-connection.md) - Manage private link connections for dataflow
39+

‎internal/cli/serverless/privatelink/attach.go‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -72,14 +72,14 @@ func (o *AttachDomainOpts) MarkInteractive(cmd *cobra.Command) error {
7272
func AttachDomainCmd(h *internal.Helper) *cobra.Command {
7373
opts := &AttachDomainOpts{interactive: true}
7474
cmd := &cobra.Command{
75-
Use: "attach",
75+
Use: "attach-domains",
7676
Short: "Attach domains to a private link connection",
7777
Args: cobra.NoArgs,
7878
Example: fmt.Sprintf(` Attach domain (interactive):
79-
$ %[1]s serverless private-link-connection attach
79+
$ %[1]s serverless private-link-connection attach-domains
8080
8181
Attach domain (non-interactive):
82-
$ %[1]s serverless private-link-connection attach -c <cluster-id> --private-link-connection-id <plc-id> --type <type> --unique-name <unique-name>`, config.CliName),
82+
$ %[1]s serverless private-link-connection attach-domains -c <cluster-id> --private-link-connection-id <plc-id> --type <type> --unique-name <unique-name>`, config.CliName),
8383
PreRunE: func(cmd *cobra.Command, args []string) error {
8484
return opts.MarkInteractive(cmd)
8585
},
@@ -94,7 +94,7 @@ func AttachDomainCmd(h *internal.Helper) *cobra.Command {
9494
var domainType plapi.PrivateLinkConnectionDomainTypeEnum
9595
var uniqueName string
9696
var dryRun bool
97-
dryRun, err = cmd.Flags().GetBool(flag.PLCAttachDomainDryRun)
97+
dryRun, err = cmd.Flags().GetBool(flag.DryRun)
9898
if err != nil {
9999
return errors.Trace(err)
100100
}
@@ -157,10 +157,10 @@ func AttachDomainCmd(h *internal.Helper) *cobra.Command {
157157
if err != nil {
158158
return errors.Trace(err)
159159
}
160-
}
161160

162-
if domainType == "" {
163-
return errors.New("domain type is required")
161+
if domainType == "" {
162+
return errors.New("domain type is required")
163+
}
164164
}
165165

166166
body := &plapi.PrivateLinkConnectionServiceAttachDomainsBody{
@@ -193,7 +193,7 @@ func AttachDomainCmd(h *internal.Helper) *cobra.Command {
193193
cmd.Flags().String(flag.PrivateLinkConnectionID, "", "The private link connection ID.")
194194
cmd.Flags().String(flag.PLCAttachDomainType, "", fmt.Sprintf("The type of domain to attach, one of: %v", plapi.AllowedPrivateLinkConnectionDomainTypeEnumEnumValues))
195195
cmd.Flags().String(flag.PLCAttachDomainUniqueName, "", "The unique name of the domain to attach, you can use --dry-run to generate the unique name when attaching a TiDB Cloud managed domain.")
196-
cmd.Flags().Bool(flag.PLCAttachDomainDryRun, false, "set dry run mode to only show generated domains without attaching them.")
196+
cmd.Flags().Bool(flag.DryRun, false, "Set dry run mode to only show generated domains without attaching them.")
197197

198198
return cmd
199199
}

‎internal/cli/serverless/privatelink/detach.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,14 +62,14 @@ func DetachDomainCmd(h *internal.Helper) *cobra.Command {
6262
opts := &DetachDomainOpts{interactive: true}
6363

6464
cmd := &cobra.Command{
65-
Use: "detach",
65+
Use: "detach-domains",
6666
Short: "Detach domains from a private link connection",
6767
Args: cobra.NoArgs,
6868
Example: fmt.Sprintf(` Detach domains (interactive):
6969
$ %[1]s serverless private-link-connection detach
7070
7171
Detach domains (non-interactive):
72-
$ %[1]s serverless private-link-connection detach -c <cluster-id> --private-link-connection-id <plc-id> --plc-attach-domain-id <attach-id>`, config.CliName),
72+
$ %[1]s serverless private-link-connection detach-domains -c <cluster-id> --private-link-connection-id <plc-id> --attach-domain-id <attach-id>`, config.CliName),
7373
PreRunE: func(cmd *cobra.Command, args []string) error {
7474
return opts.MarkInteractive(cmd)
7575
},

‎internal/flag/flag.go‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -126,8 +126,7 @@ const (
126126
AlicloudEndpointServiceName string = "alicloud.endpoint-service-name"
127127
PLCAttachDomainType string = "type"
128128
PLCAttachDomainUniqueName string = "unique-name"
129-
PLCAttachDomainID string = "plc-attach-domain-id"
130-
PLCAttachDomainDryRun string = "dry-run"
129+
PLCAttachDomainID string = "attach-domain-id"
131130

132131
MigrationID string = "migration-id"
133132
MigrationIDShort string = "m"

0 commit comments

Comments
 (0)