Skip to content

Commit f453c97

Browse files
committed
chore: remove dashboard and connect from command descript and update docs
1 parent 129bddf commit f453c97

14 files changed

Lines changed: 523 additions & 52 deletions

README.md

Lines changed: 2 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -41,14 +41,14 @@ curl -fsSL https://kubeblocks.io/installer/install_cli.sh | bash
4141
sudo apt-get update
4242
sudo apt-get install kbcli
4343
```
44-
44+
4545
***For Debian-based distributions, in addition to the installation method above, you can also install it through the following methods:***
4646
```bash
4747
echo "deb [trusted=yes] https://apt.fury.io/kubeblocks/ /" | sudo tee /etc/apt/sources.list.d/kbcli.list
4848
sudo apt update
4949
sudo apt install kbcli
5050
```
51-
51+
5252
**Red Hat-based distributions**
5353

5454
1. Installs the package yum-utils using the package manager yum.
@@ -179,22 +179,6 @@ View the details of a specified database cluster, such as `STATUS`, `Endpoints`,
179179
kbcli cluster describe mycluster
180180
```
181181

182-
Wait until the status of this cluster is `Running`, run `kbcli cluster connect` to access a specified database cluster. For example,
183-
184-
```bash
185-
kbcli cluster connect mycluster
186-
```
187-
188-
List and open the grafana dashboard.
189-
190-
```bash
191-
# list all dashboards
192-
kbcli dashboard list
193-
194-
# open grafana dashboard
195-
kbcli dashboard open kubeblocks-grafana
196-
```
197-
198182
### Destroy Playground
199183

200184
```bash

docs/user_docs/cli/kbcli_cluster_custom-ops.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,15 @@ kbcli cluster custom-ops OpsDef --cluster <clusterName> <your custom params> [fl
5757
### SEE ALSO
5858

5959
* [kbcli cluster](kbcli_cluster.md) - Cluster command.
60+
* [kbcli cluster custom-ops kafka-quota](kbcli_cluster_custom-ops_kafka-quota.md) - Create a custom ops with opsDef kafka-quota
61+
* [kbcli cluster custom-ops kafka-topic](kbcli_cluster_custom-ops_kafka-topic.md) - Create a custom ops with opsDef kafka-topic
62+
* [kbcli cluster custom-ops kafka-user-acl](kbcli_cluster_custom-ops_kafka-user-acl.md) - Create a custom ops with opsDef kafka-user-acl
63+
* [kbcli cluster custom-ops pg-update-standby-config](kbcli_cluster_custom-ops_pg-update-standby-config.md) - Create a custom ops with opsDef pg-update-standby-config
64+
* [kbcli cluster custom-ops redis-cluster-rebalance](kbcli_cluster_custom-ops_redis-cluster-rebalance.md) - Create a custom ops with opsDef redis-cluster-rebalance
65+
* [kbcli cluster custom-ops redis-master-account-ops](kbcli_cluster_custom-ops_redis-master-account-ops.md) - Create a custom ops with opsDef redis-master-account-ops
66+
* [kbcli cluster custom-ops redis-reset-master](kbcli_cluster_custom-ops_redis-reset-master.md) - Create a custom ops with opsDef redis-reset-master
67+
* [kbcli cluster custom-ops redis-sentinel-account-ops](kbcli_cluster_custom-ops_redis-sentinel-account-ops.md) - Create a custom ops with opsDef redis-sentinel-account-ops
68+
* [kbcli cluster custom-ops redis-shard-account-ops](kbcli_cluster_custom-ops_redis-shard-account-ops.md) - Create a custom ops with opsDef redis-shard-account-ops
6069

6170
#### Go Back to [CLI Overview](cli.md) Homepage.
6271

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
---
2+
title: kbcli cluster custom-ops kafka-quota
3+
---
4+
5+
Create a custom ops with opsDef kafka-quota
6+
7+
```
8+
kbcli cluster custom-ops kafka-quota <ClusterName> [flags]
9+
```
10+
11+
### Examples
12+
13+
```
14+
# Create a kafka-quota ops
15+
kbcli cluster custom-ops kafka-quota <clusterName> --component <componentName>
16+
```
17+
18+
### Options
19+
20+
```
21+
--auto-approve Skip interactive approval before promote the instance
22+
--client string client id.
23+
--component string Specify the component name of the cluster. if not specified, using the first component which referenced the defined componentDefinition.
24+
--consumer-byte-rate int the maximum number of messages that can be consumed per second, measured in bytes/sec
25+
--controller-mutation-rate int partition mutation quota to control the rate at which mutations are accepted for user requests.
26+
--delete-quotas stringArray
27+
--dry-run string[="unchanged"] Must be "client", or "server". If with client strategy, only print the object that would be sent, and no data is actually sent. If with server strategy, submit the server-side request, but no data is persistent. (default "none")
28+
--edit Edit the API resource before creating
29+
--force skip the pre-checks of the opsRequest to run the opsRequest forcibly
30+
-h, --help help for kafka-quota
31+
--name string OpsRequest name. if not specified, it will be randomly generated
32+
-o, --output format Prints the output in the specified format. Allowed values: JSON and YAML (default yaml)
33+
--producer-byte-rate int the maximum number of messages that can be produced per second, measured in bytes/sec
34+
--request-percentage int request percentage.
35+
--ttlSecondsAfterSucceed int Time to live after the OpsRequest succeed
36+
--user string user name
37+
```
38+
39+
### Options inherited from parent commands
40+
41+
```
42+
--as string Username to impersonate for the operation. User could be a regular user or a service account in a namespace.
43+
--as-group stringArray Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
44+
--as-uid string UID to impersonate for the operation.
45+
--cache-dir string Default cache directory (default "$HOME/.kube/cache")
46+
--certificate-authority string Path to a cert file for the certificate authority
47+
--client-certificate string Path to a client certificate file for TLS
48+
--client-key string Path to a client key file for TLS
49+
--cluster string The name of the kubeconfig cluster to use
50+
--context string The name of the kubeconfig context to use
51+
--disable-compression If true, opt-out of response compression for all requests to the server
52+
--insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
53+
--kubeconfig string Path to the kubeconfig file to use for CLI requests.
54+
--match-server-version Require server version to match client version
55+
-n, --namespace string If present, the namespace scope for this CLI request
56+
--request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
57+
-s, --server string The address and port of the Kubernetes API server
58+
--tls-server-name string Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used
59+
--token string Bearer token for authentication to the API server
60+
```
61+
62+
### SEE ALSO
63+
64+
* [kbcli cluster custom-ops](kbcli_cluster_custom-ops.md) -
65+
66+
#### Go Back to [CLI Overview](cli.md) Homepage.
67+
Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
---
2+
title: kbcli cluster custom-ops kafka-topic
3+
---
4+
5+
Create a custom ops with opsDef kafka-topic
6+
7+
```
8+
kbcli cluster custom-ops kafka-topic <ClusterName> [flags]
9+
```
10+
11+
### Examples
12+
13+
```
14+
# Create a kafka-topic ops
15+
kbcli cluster custom-ops kafka-topic <clusterName> --component <componentName> --topic=<topic> --type=<type>
16+
```
17+
18+
### Options
19+
20+
```
21+
--auto-approve Skip interactive approval before promote the instance
22+
--component string Specify the component name of the cluster. if not specified, using the first component which referenced the defined componentDefinition.
23+
--config string A topic configuration override for the topic being created or altered.
24+
--dry-run string[="unchanged"] Must be "client", or "server". If with client strategy, only print the object that would be sent, and no data is actually sent. If with server strategy, submit the server-side request, but no data is persistent. (default "none")
25+
--edit Edit the API resource before creating
26+
--force skip the pre-checks of the opsRequest to run the opsRequest forcibly
27+
-h, --help help for kafka-topic
28+
--name string OpsRequest name. if not specified, it will be randomly generated
29+
-o, --output format Prints the output in the specified format. Allowed values: JSON and YAML (default yaml)
30+
--partitions int The number of partitions for the topic being created or altered (WARNING:
31+
If partitions are increased for a topic that has a key, the partition logic or ordering
32+
of the messages will be affected). If not supplied for create, defaults to the cluster default.
33+
Value range [1, 10000].
34+
--replicas int The replication factor for each partition in the topic being
35+
created. If not supplied, defaults to the cluster default.
36+
Value range [1, 10].
37+
--topic string The topic to create, alter or delete. It also accepts a regular
38+
expression, except for --create option. Put topic name in double quotes and
39+
use the '\' prefix to escape regular expression symbols; e.g. "test\.topic".
40+
41+
--ttlSecondsAfterSucceed int Time to live after the OpsRequest succeed
42+
--type string operation type, supports value: [create, alter, delete]. Legal values [create, alter, delete].
43+
```
44+
45+
### Options inherited from parent commands
46+
47+
```
48+
--as string Username to impersonate for the operation. User could be a regular user or a service account in a namespace.
49+
--as-group stringArray Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
50+
--as-uid string UID to impersonate for the operation.
51+
--cache-dir string Default cache directory (default "$HOME/.kube/cache")
52+
--certificate-authority string Path to a cert file for the certificate authority
53+
--client-certificate string Path to a client certificate file for TLS
54+
--client-key string Path to a client key file for TLS
55+
--cluster string The name of the kubeconfig cluster to use
56+
--context string The name of the kubeconfig context to use
57+
--disable-compression If true, opt-out of response compression for all requests to the server
58+
--insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
59+
--kubeconfig string Path to the kubeconfig file to use for CLI requests.
60+
--match-server-version Require server version to match client version
61+
-n, --namespace string If present, the namespace scope for this CLI request
62+
--request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
63+
-s, --server string The address and port of the Kubernetes API server
64+
--tls-server-name string Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used
65+
--token string Bearer token for authentication to the API server
66+
--user string The name of the kubeconfig user to use
67+
```
68+
69+
### SEE ALSO
70+
71+
* [kbcli cluster custom-ops](kbcli_cluster_custom-ops.md) -
72+
73+
#### Go Back to [CLI Overview](cli.md) Homepage.
74+
Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
---
2+
title: kbcli cluster custom-ops kafka-user-acl
3+
---
4+
5+
Create a custom ops with opsDef kafka-user-acl
6+
7+
```
8+
kbcli cluster custom-ops kafka-user-acl <ClusterName> [flags]
9+
```
10+
11+
### Examples
12+
13+
```
14+
# Create a kafka-user-acl ops
15+
kbcli cluster custom-ops kafka-user-acl <clusterName> --component <componentName> --operations=<operations> --type=<type>
16+
```
17+
18+
### Options
19+
20+
```
21+
--allow-hosts stringArray
22+
--allow-users stringArray
23+
--auto-approve Skip interactive approval before promote the instance
24+
--cluster string Indicates to the script that the user is trying to interact with acls on the singular cluster resource.
25+
--component string Specify the component name of the cluster. if not specified, using the first component which referenced the defined componentDefinition.
26+
--consumer indicate to add or remove the acl of consumer.
27+
--deny-hosts stringArray
28+
--deny-users stringArray
29+
--dry-run string[="unchanged"] Must be "client", or "server". If with client strategy, only print the object that would be sent, and no data is actually sent. If with server strategy, submit the server-side request, but no data is persistent. (default "none")
30+
--edit Edit the API resource before creating
31+
--force skip the pre-checks of the opsRequest to run the opsRequest forcibly
32+
--group string consumer-group.
33+
-h, --help help for kafka-user-acl
34+
--name string OpsRequest name. if not specified, it will be randomly generated
35+
--operations stringArray
36+
-o, --output format Prints the output in the specified format. Allowed values: JSON and YAML (default yaml)
37+
--pattern-type string Resource pattern type.
38+
--producer indicate to add or remove the acl of producer.
39+
--topic string topic name.
40+
--transactional-id string The transactionalId to which ACLs should be added or removed. A value of * indicates the ACLs should apply to all transactionalIds.
41+
--ttlSecondsAfterSucceed int Time to live after the OpsRequest succeed
42+
--type string user name
43+
```
44+
45+
### Options inherited from parent commands
46+
47+
```
48+
--as string Username to impersonate for the operation. User could be a regular user or a service account in a namespace.
49+
--as-group stringArray Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
50+
--as-uid string UID to impersonate for the operation.
51+
--cache-dir string Default cache directory (default "$HOME/.kube/cache")
52+
--certificate-authority string Path to a cert file for the certificate authority
53+
--client-certificate string Path to a client certificate file for TLS
54+
--client-key string Path to a client key file for TLS
55+
--context string The name of the kubeconfig context to use
56+
--disable-compression If true, opt-out of response compression for all requests to the server
57+
--insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
58+
--kubeconfig string Path to the kubeconfig file to use for CLI requests.
59+
--match-server-version Require server version to match client version
60+
-n, --namespace string If present, the namespace scope for this CLI request
61+
--request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
62+
-s, --server string The address and port of the Kubernetes API server
63+
--tls-server-name string Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used
64+
--token string Bearer token for authentication to the API server
65+
--user string The name of the kubeconfig user to use
66+
```
67+
68+
### SEE ALSO
69+
70+
* [kbcli cluster custom-ops](kbcli_cluster_custom-ops.md) -
71+
72+
#### Go Back to [CLI Overview](cli.md) Homepage.
73+

0 commit comments

Comments
 (0)