Skip to content

Commit a23b760

Browse files
authored
update doc (#272)
1 parent 74819f7 commit a23b760

File tree

4 files changed

+47
-2
lines changed

4 files changed

+47
-2
lines changed

docs/generate_doc/ticloud_serverless.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ Manage TiDB Cloud Serverless clusters
2020

2121
* [ticloud](ticloud.md) - CLI tool to manage TiDB Cloud
2222
* [ticloud serverless branch](ticloud_serverless_branch.md) - Manage TiDB Cloud Serverless branches
23+
* [ticloud serverless capacity](ticloud_serverless_capacity.md) - Set capacity for a TiDB Cloud Serverless cluster
2324
* [ticloud serverless create](ticloud_serverless_create.md) - Create a TiDB Cloud Serverless cluster
2425
* [ticloud serverless delete](ticloud_serverless_delete.md) - Delete a TiDB Cloud Serverless cluster
2526
* [ticloud serverless describe](ticloud_serverless_describe.md) - Describe a TiDB Cloud Serverless cluster
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
## ticloud serverless capacity
2+
3+
Set capacity for a TiDB Cloud Serverless cluster
4+
5+
```
6+
ticloud serverless capacity [flags]
7+
```
8+
9+
### Examples
10+
11+
```
12+
Set capacity for a TiDB Cloud Serverless cluster in interactive mode:
13+
$ ticloud serverless capacity
14+
15+
Set capacity for a TiDB Cloud Serverless cluster in non-interactive mode:
16+
$ ticloud serverless capacity -c <cluster-id> --max-rcu <maximum-rcu> --min-rcu <minimum-rcu>
17+
```
18+
19+
### Options
20+
21+
```
22+
-c, --cluster-id string The ID of the cluster.
23+
-h, --help help for capacity
24+
--max-rcu int32 Maximum RCU for the cluster, at most 100000.
25+
--min-rcu int32 Minimum RCU for the cluster, at least 2000.
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](ticloud_serverless.md) - Manage TiDB Cloud Serverless clusters
39+

docs/generate_doc/ticloud_serverless_create.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,11 @@ ticloud serverless create [flags]
2626
-n, --display-name string Display name of the cluster to de created.
2727
--encryption Whether Enhanced Encryption at Rest is enabled.
2828
-h, --help help for create
29+
--max-rcu int32 Maximum RCU for the cluster, at most 100000.
30+
--min-rcu int32 Minimum RCU for the cluster, at least 2000.
2931
-p, --project-id string The ID of the project, in which the cluster will be created. (default "default project")
3032
-r, --region string The name of cloud region. You can use "ticloud serverless region" to see all regions.
31-
--spending-limit-monthly int32 Maximum monthly spending limit in USD cents. (optional)
33+
--spending-limit-monthly int32 Maximum monthly spending limit in USD cents.
3234
```
3335

3436
### Options inherited from parent commands

docs/generate_doc/ticloud_serverless_import_start.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,11 +53,14 @@ ticloud serverless import start [flags]
5353
--local.file-path string The local file path to import.
5454
--local.target-database string Target database to which import data.
5555
--local.target-table string Target table to which import data.
56+
--oss.access-key-id string The AccessKey ID of the Alibaba Cloud OSS.
57+
--oss.access-key-secret string The AccessKey Secret of the Alibaba Cloud OSS.
58+
--oss.uri string The OSS URI in oss://<bucket>/<path> format. Required when source type is Alibaba Cloud OSS.
5659
--s3.access-key-id string The access key ID of the S3. You only need to set one of the s3.role-arn and [s3.access-key-id, s3.secret-access-key].
5760
--s3.role-arn string The role arn of the S3. You only need to set one of the s3.role-arn and [s3.access-key-id, s3.secret-access-key].
5861
--s3.secret-access-key string The secret access key of the S3. You only need to set one of the s3.role-arn and [s3.access-key-id, s3.secret-access-key].
5962
--s3.uri string The S3 URI in s3://<bucket>/<path> format. Required when source type is S3.
60-
--source-type string The import source type, one of ["LOCAL" "S3" "GCS" "AZURE_BLOB"]. (default "LOCAL")
63+
--source-type string The import source type, one of ["LOCAL" "S3" "GCS" "AZURE_BLOB" "OSS"]. (default "LOCAL")
6164
```
6265

6366
### Options inherited from parent commands

0 commit comments

Comments
 (0)