-
Notifications
You must be signed in to change notification settings - Fork 692
TiDB Cloud Cli v1.0.0-beta.4 #20838
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
shiyuhang0
wants to merge
3
commits into
pingcap:release-8.1
Choose a base branch
from
shiyuhang0:cli_beta.4
base: release-8.1
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
TiDB Cloud Cli v1.0.0-beta.4 #20838
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
50 changes: 50 additions & 0 deletions
50
tidb-cloud/ticloud-serverless-authorized-network-create.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| --- | ||
| title: ticloud serverless authorized-network create | ||
| summary: The reference of `ticloud serverless authorized-network create`. | ||
| --- | ||
|
|
||
| # ticloud serverless authorized-network create | ||
|
|
||
| Create an authorized network: | ||
|
|
||
| ```shell | ||
| ticloud serverless authorized-network create [flags] | ||
| ``` | ||
|
|
||
| ## Examples | ||
|
|
||
| Create an authorized network in interactive mode: | ||
|
|
||
| ```shell | ||
| ticloud serverless authorized-network create | ||
| ``` | ||
|
|
||
| Create an authorized network in non-interactive mode: | ||
|
|
||
| ```shell | ||
| ticloud serverless authorized-network create -c <cluster-id> --display-name <display-name> --start-ip-address <start-ip-address> --end-ip-address <end-ip-address> | ||
| ``` | ||
|
|
||
| ## Flags | ||
|
|
||
| In non-interactive mode, you need to manually enter the required flags. In interactive mode, you can just follow CLI prompts to fill them in. | ||
|
|
||
| | Flag | Description | Required | Note | | ||
| |-------------------------|------------------------------------------|----------|------------------------------------------------------| | ||
| | -c, --cluster-id string | Specifies the ID of the cluster. | Yes | Only works in non-interactive mode. | | ||
| | --display-name string | Specifies the name of the authorized network. | Yes | Only works in non-interactive mode. | | ||
| | --start-ip-address string | Specifies the start IP address of the authorized network. | Yes | Only works in non-interactive mode. | | ||
| | --end-ip-address string | Specifies the end IP address of the authorized network. | Yes | Only works in non-interactive mode. | | ||
| | -h, --help | Shows help information for this command. | No | Works in both non-interactive and interactive modes. | | ||
|
|
||
| ## Inherited flags | ||
|
|
||
| | Flag | Description | Required | Note | | ||
| |----------------------|------------------------------------------------------------------------------------------------------|----------|------------------------------------------------------------------------------------------------------------------| | ||
| | --no-color | Disables color in output. | No | Only works in non-interactive mode. In interactive mode, disabling color might not work with some UI components. | | ||
| | -P, --profile string | Specifies the active [user profile](/tidb-cloud/cli-reference.md#user-profile) used in this command. | No | Works in both non-interactive and interactive modes. | | ||
| | -D, --debug | Enables debug mode. | No | Works in both non-interactive and interactive modes. | | ||
|
|
||
| ## Feedback | ||
|
|
||
| If you have any questions or suggestions on the TiDB Cloud CLI, feel free to create an [issue](https://github.com/tidbcloud/tidbcloud-cli/issues/new/choose). Also, we welcome any contributions. | ||
50 changes: 50 additions & 0 deletions
50
tidb-cloud/ticloud-serverless-authorized-network-delete.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| --- | ||
| title: ticloud serverless authorized-network delete | ||
| summary: The reference of `ticloud serverless authorized-network delete`. | ||
| --- | ||
|
|
||
| # ticloud serverless authorized-network delete | ||
|
|
||
| Delete an authorized network: | ||
|
|
||
| ```shell | ||
| ticloud serverless authorized-network delete [flags] | ||
| ``` | ||
|
|
||
| ## Examples | ||
|
|
||
| Delete an authorized network in interactive mode: | ||
|
|
||
| ```shell | ||
| ticloud serverless authorized-network delete | ||
| ``` | ||
|
|
||
| Delete an authorized network in non-interactive mode: | ||
|
|
||
| ```shell | ||
| ticloud serverless authorized-network delete -c <cluster-id> --start-ip-address <start-ip-address> --end-ip-address <end-ip-address> | ||
| ``` | ||
|
|
||
| ## Flags | ||
|
|
||
| In non-interactive mode, you need to manually enter the required flags. In interactive mode, you can just follow CLI prompts to fill them in. | ||
|
|
||
| | Flag | Description | Required | Note | | ||
| |-------------------------|------------------------------------------|----------|------------------------------------------------------| | ||
| | -c, --cluster-id string | Specifies the ID of the cluster. | Yes | Only works in non-interactive mode. | | ||
| | --force string | Delete an authorized network without confirmation. | No | Only works in non-interactive mode. | | ||
| | --start-ip-address string | Specifies the start IP address of the authorized network. | Yes | Only works in non-interactive mode. | | ||
| | --end-ip-address string | Specifies the end IP address of the authorized network. | Yes | Only works in non-interactive mode. | | ||
| | -h, --help | Shows help information for this command. | No | Works in both non-interactive and interactive modes. | | ||
|
|
||
| ## Inherited flags | ||
|
|
||
| | Flag | Description | Required | Note | | ||
| |----------------------|------------------------------------------------------------------------------------------------------|----------|------------------------------------------------------------------------------------------------------------------| | ||
| | --no-color | Disables color in output. | No | Only works in non-interactive mode. In interactive mode, disabling color might not work with some UI components. | | ||
| | -P, --profile string | Specifies the active [user profile](/tidb-cloud/cli-reference.md#user-profile) used in this command. | No | Works in both non-interactive and interactive modes. | | ||
| | -D, --debug | Enables debug mode. | No | Works in both non-interactive and interactive modes. | | ||
|
|
||
| ## Feedback | ||
|
|
||
| If you have any questions or suggestions on the TiDB Cloud CLI, feel free to create an [issue](https://github.com/tidbcloud/tidbcloud-cli/issues/new/choose). Also, we welcome any contributions. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| --- | ||
| title: ticloud serverless authorized-network list | ||
| summary: The reference of `ticloud serverless authorized-network list`. | ||
| --- | ||
|
|
||
| # ticloud serverless authorized-network list | ||
|
|
||
| List all authorized networks: | ||
|
|
||
| ```shell | ||
| ticloud serverless authorized-network list [flags] | ||
| ``` | ||
|
|
||
| ## Examples | ||
|
|
||
| List all authorized networks in interactive mode: | ||
|
|
||
| ```shell | ||
| ticloud serverless authorized-network list | ||
| ``` | ||
|
|
||
| List all authorized networks in non-interactive mode: | ||
|
|
||
| ```shell | ||
| ticloud serverless authorized-network list -c <cluster-id> | ||
| ``` | ||
|
|
||
| ## Flags | ||
|
|
||
| In non-interactive mode, you need to manually enter the required flags. In interactive mode, you can just follow CLI prompts to fill them in. | ||
|
|
||
| | Flag | Description | Required | Note | | ||
| |-------------------------|------------------------------------------|----------|------------------------------------------------------| | ||
| | -c, --cluster-id string | Specifies the ID of the cluster. | Yes | Only works in non-interactive mode. | | ||
| | --output string | Specifies the output format (`human` by default). Valid values are `human` or `json`. To get a complete result, use the `json` format. | No | Works in both non-interactive and interactive modes. | | ||
| | -h, --help | Shows help information for this command. | No | Works in both non-interactive and interactive modes. | | ||
|
|
||
| ## Inherited flags | ||
|
|
||
| | Flag | Description | Required | Note | | ||
| |----------------------|------------------------------------------------------------------------------------------------------|----------|------------------------------------------------------------------------------------------------------------------| | ||
| | --no-color | Disables color in output. | No | Only works in non-interactive mode. In interactive mode, disabling color might not work with some UI components. | | ||
| | -P, --profile string | Specifies the active [user profile](/tidb-cloud/cli-reference.md#user-profile) used in this command. | No | Works in both non-interactive and interactive modes. | | ||
| | -D, --debug | Enables debug mode. | No | Works in both non-interactive and interactive modes. | | ||
|
|
||
| ## Feedback | ||
|
|
||
| If you have any questions or suggestions on the TiDB Cloud CLI, feel free to create an [issue](https://github.com/tidbcloud/tidbcloud-cli/issues/new/choose). Also, we welcome any contributions. |
52 changes: 52 additions & 0 deletions
52
tidb-cloud/ticloud-serverless-authorized-network-update.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| --- | ||
| title: ticloud serverless authorized-network update | ||
| summary: The reference of `ticloud serverless authorized-network update`. | ||
| --- | ||
|
|
||
| # ticloud serverless authorized-network update | ||
|
|
||
| Update an authorized network: | ||
|
|
||
| ```shell | ||
| ticloud serverless authorized-network update [flags] | ||
| ``` | ||
|
|
||
| ## Examples | ||
|
|
||
| Update an authorized network in interactive mode: | ||
|
|
||
| ```shell | ||
| ticloud serverless authorized-network update | ||
| ``` | ||
|
|
||
| Update an authorized network in non-interactive mode: | ||
|
|
||
| ```shell | ||
| ticloud serverless authorized-network update -c <cluster-id> --start-ip-address <start-ip-address> --end-ip-address <end-ip-address> --new-start-ip-address <new-start-ip-address> --new-end-ip-address <new-end-ip-address> | ||
| ``` | ||
|
|
||
| ## Flags | ||
|
|
||
| In non-interactive mode, you need to manually enter the required flags. In interactive mode, you can just follow CLI prompts to fill them in. | ||
|
|
||
| | Flag | Description | Required | Note | | ||
| |-------------------------|------------------------------------------|----------|------------------------------------------------------| | ||
| | -c, --cluster-id string | Specifies the ID of the cluster. | Yes | Only works in non-interactive mode. | | ||
| | --start-ip-address string | Specifies the starting IP address of the authorized network. | Yes | Only works in non-interactive mode. | | ||
| | --end-ip-address string | Specifies the ending IP address of the authorized network. | Yes | Only works in non-interactive mode. | | ||
| | --new-display-name string | Specifies the new name of the authorized network. | No | Only works in non-interactive mode. | | ||
| | --new-start-ip-address string | Specifies the new starting IP address of the authorized network. | No | Only works in non-interactive mode. | | ||
| | --new-end-ip-address string | Specifies the new ending IP address of the authorized network. | No | Only works in non-interactive mode. | | ||
| | -h, --help | Shows help information for this command. | No | Works in both non-interactive and interactive modes. | | ||
|
|
||
| ## Inherited flags | ||
|
|
||
| | Flag | Description | Required | Note | | ||
| |----------------------|------------------------------------------------------------------------------------------------------|----------|------------------------------------------------------------------------------------------------------------------| | ||
| | --no-color | Disables color in output. | No | Only works in non-interactive mode. In interactive mode, disabling color might not work with some UI components. | | ||
| | -P, --profile string | Specifies the active [user profile](/tidb-cloud/cli-reference.md#user-profile) used in this command. | No | Works in both non-interactive and interactive modes. | | ||
| | -D, --debug | Enables debug mode. | No | Works in both non-interactive and interactive modes. | | ||
|
|
||
| ## Feedback | ||
|
|
||
| If you have any questions or suggestions on the TiDB Cloud CLI, feel free to create an [issue](https://github.com/tidbcloud/tidbcloud-cli/issues/new/choose). Also, we welcome any contributions. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could we add an intro paragraph here to tell users what authorized network is?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we need not. It is just a reference of CLI, other cli doc also does not contains feature intro
The introduction of the feature located here: https://docs.pingcap.com/tidbcloud/configure-serverless-firewall-rules-for-public-endpoints/#allow-aws-access
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The name is diffierent, we will unify the name to
authorized networkin the future