Skip to content
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

chore: auto update kbcli embed chart changes #549

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
edabe28
fix: fix specifying namespace is not working (#489)
yipeng1030 Nov 18, 2024
a8b97a0
chore: auto update kbcli embed chart changes
apecloud-bot Nov 18, 2024
1c85bad
fix: specifying namespace on ops cmds. (#490)
yipeng1030 Nov 19, 2024
b27729b
chore: fix check upgrade release status (#492)
yipeng1030 Nov 21, 2024
f39ff7c
chore: cluster stop and start support components (#495)
yipeng1030 Nov 22, 2024
660cd3f
chore: support to upgrade addon to 1.0 version (#494)
wangyelei Nov 21, 2024
749f096
feat: support etcd Add-on and tidy up docs
wangyelei Nov 25, 2024
b0f3f46
chore: pick etcd to release-1.0 (#497)
loomts Nov 25, 2024
8f1efde
fix: upgrade kb failed because no KB deployment was found. (#498)
wangyelei Nov 25, 2024
1f1646d
feat: Support Reconciliation Tracing (#454)
free6om Nov 26, 2024
8157ef2
chore: playground init support specifying k3s and k3d-proxy images. (…
yipeng1030 Nov 29, 2024
d446375
chore: remove standard chart schema (#504)
yipeng1030 Nov 29, 2024
c924d0d
fix: addon enable only register the chart when addon type is engine (…
yipeng1030 Dec 2, 2024
fb98a27
fix: improve typo of list cmd in dataprotection (#511)
yipeng1030 Dec 5, 2024
1bd9e2c
chore: support to create cluster with object flags (#513)
wangyelei Dec 6, 2024
357646d
chore: cluster restore support valid backup name (#509)
yipeng1030 Dec 6, 2024
33c5be9
feat: improve cluster list (#516)
yipeng1030 Dec 13, 2024
84d7493
feat: addon support clean sub-resource of multi-versions (#512)
yipeng1030 Dec 13, 2024
56bc9b6
fix: make static bug (#520)
wangyelei Dec 16, 2024
bf4c7a3
chore: addon install and search support auto complete (#518)
yipeng1030 Dec 16, 2024
c921569
chore: fix typo of cluster dp cmd (#522)
yipeng1030 Dec 18, 2024
e7e6418
chore: support to upgrade addon to 1.0 when existing 0.9 addon (#524)
wangyelei Dec 19, 2024
32533f7
chore: add _category_.yml for user docs
1aal Dec 28, 2023
a03b5e3
feat: support to convert cluster to v1 api version (#526)
wangyelei Dec 27, 2024
f0c1321
fix: edit-config subcommand does not take effect (#530)
sophon-zt Jan 2, 2025
a2dadcf
chore: update go.mod w.r.t trivy Severity (#536)
shanshanying Jan 6, 2025
267dc72
fix: add enum check of flags of create cmd (#534)
yipeng1030 Jan 8, 2025
8361d79
fix: fix explain-config cmd (#532)
yipeng1030 Jan 8, 2025
4a3dbeb
chore: tidy up promote and rebuild instance cmd with new api (#539)
wangyelei Jan 15, 2025
b2a8e0b
chore: remove rbac args (#506)
cjc7373 Jan 23, 2025
4d5471f
chore: deprecated reconfigure api field for kb-1.0 (#541)
sophon-zt Jan 24, 2025
f147a40
fix: switchover failed (#546)
wangyelei Feb 6, 2025
294213c
chore: release-kbcli.yml runs-on ubuntu-22.04 (#548)
JashBook Feb 6, 2025
1e248aa
chore: auto update kbcli embed chart changes
apecloud-bot Feb 6, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/workflows/release-kbcli.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ jobs:
gorelease-assert:
needs: [ create-release-jihulab ]
name: Upload and release kbcli
runs-on: ubuntu-latest
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
- name: install lib
Expand Down Expand Up @@ -106,7 +106,7 @@ jobs:

upload-release-assert:
needs: gorelease-assert
runs-on: ubuntu-latest
runs-on: ubuntu-22.04
strategy:
fail-fast: false
matrix:
Expand Down Expand Up @@ -137,7 +137,7 @@ jobs:

remove-artifact:
needs: upload-release-assert
runs-on: ubuntu-latest
runs-on: ubuntu-22.04
steps:
- name: Remove kbcli Artifact
uses: geekyeggo/delete-artifact@v2
Expand Down
3 changes: 2 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,8 @@ build-kbcli-embed-chart: helmtool fetch-addons create-kbcli-embed-charts-dir \
build-single-kbcli-embed-chart.kafka \
build-single-kbcli-embed-chart.mongodb \
build-single-kbcli-embed-chart.elasticsearch \
build-single-kbcli-embed-chart.qdrant
build-single-kbcli-embed-chart.qdrant \
build-single-kbcli-embed-chart.etcd

.PHONY: kbcli
kbcli: build-checks kbcli-fast ## Build bin/kbcli.
Expand Down
2 changes: 1 addition & 1 deletion addons
Submodule addons updated 1568 files
5 changes: 5 additions & 0 deletions docs/user_docs/cli/_category_.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
position: 30
label: Command Line
collapsible: true
collapsed: true
className: hide-children
29 changes: 21 additions & 8 deletions docs/user_docs/cli/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ sidebar_position: 1

Addon command.

* [kbcli addon delete-resources-with-version](kbcli_addon_delete-resources-with-version.md) - Delete the sub-resources of specified addon and versions
* [kbcli addon describe](kbcli_addon_describe.md) - Describe an addon specification.
* [kbcli addon disable](kbcli_addon_disable.md) - Disable an addon.
* [kbcli addon enable](kbcli_addon_enable.md) - Enable an addon.
Expand Down Expand Up @@ -39,6 +40,7 @@ Cluster command.
* [kbcli cluster cancel-ops](kbcli_cluster_cancel-ops.md) - Cancel the pending/creating/running OpsRequest which type is vscale or hscale.
* [kbcli cluster configure](kbcli_cluster_configure.md) - Configure parameters with the specified components in the cluster.
* [kbcli cluster connect](kbcli_cluster_connect.md) - Connect to a cluster or instance.
* [kbcli cluster convert-to-v1](kbcli_cluster_convert-to-v1.md) - convert cluster api version.
* [kbcli cluster create](kbcli_cluster_create.md) - Create a cluster.
* [kbcli cluster custom-ops](kbcli_cluster_custom-ops.md) -
* [kbcli cluster delete](kbcli_cluster_delete.md) - Delete clusters.
Expand All @@ -57,14 +59,14 @@ Cluster command.
* [kbcli cluster expose](kbcli_cluster_expose.md) - Expose a cluster with a new endpoint, the new endpoint can be found by executing 'kbcli cluster describe NAME'.
* [kbcli cluster label](kbcli_cluster_label.md) - Update the labels on cluster
* [kbcli cluster list](kbcli_cluster_list.md) - List clusters.
* [kbcli cluster list-backup](kbcli_cluster_list-backup.md) - List backups.
* [kbcli cluster list-backup-policy](kbcli_cluster_list-backup-policy.md) - List backups policies.
* [kbcli cluster list-backup-policies](kbcli_cluster_list-backup-policies.md) - List backups policies.
* [kbcli cluster list-backups](kbcli_cluster_list-backups.md) - List backups.
* [kbcli cluster list-components](kbcli_cluster_list-components.md) - List cluster components.
* [kbcli cluster list-events](kbcli_cluster_list-events.md) - List cluster events.
* [kbcli cluster list-instances](kbcli_cluster_list-instances.md) - List cluster instances.
* [kbcli cluster list-logs](kbcli_cluster_list-logs.md) - List supported log files in cluster.
* [kbcli cluster list-ops](kbcli_cluster_list-ops.md) - List all opsRequests.
* [kbcli cluster list-restore](kbcli_cluster_list-restore.md) - List restores.
* [kbcli cluster list-restores](kbcli_cluster_list-restores.md) - List restores.
* [kbcli cluster logs](kbcli_cluster_logs.md) - Access cluster log file.
* [kbcli cluster promote](kbcli_cluster_promote.md) - Promote a non-primary or non-leader instance as the new primary or leader of the cluster
* [kbcli cluster rebuild-instance](kbcli_cluster_rebuild-instance.md) - Rebuild the specified instances in the cluster.
Expand Down Expand Up @@ -123,11 +125,11 @@ Data protection command.
* [kbcli dataprotection describe-backup-policy](kbcli_dataprotection_describe-backup-policy.md) - Describe a backup policy
* [kbcli dataprotection describe-restore](kbcli_dataprotection_describe-restore.md) - Describe a restore
* [kbcli dataprotection edit-backup-policy](kbcli_dataprotection_edit-backup-policy.md) - Edit backup policy
* [kbcli dataprotection list-action-set](kbcli_dataprotection_list-action-set.md) - List actionsets
* [kbcli dataprotection list-backup](kbcli_dataprotection_list-backup.md) - List backups.
* [kbcli dataprotection list-backup-policy](kbcli_dataprotection_list-backup-policy.md) - List backup policies
* [kbcli dataprotection list-backup-policy-template](kbcli_dataprotection_list-backup-policy-template.md) - List backup policy template
* [kbcli dataprotection list-restore](kbcli_dataprotection_list-restore.md) - List restores.
* [kbcli dataprotection list-action-sets](kbcli_dataprotection_list-action-sets.md) - List actionsets
* [kbcli dataprotection list-backup-policies](kbcli_dataprotection_list-backup-policies.md) - List backup policies
* [kbcli dataprotection list-backup-policy-templates](kbcli_dataprotection_list-backup-policy-templates.md) - List backup policy templates
* [kbcli dataprotection list-backups](kbcli_dataprotection_list-backups.md) - List backups.
* [kbcli dataprotection list-restores](kbcli_dataprotection_list-restores.md) - List restores.
* [kbcli dataprotection restore](kbcli_dataprotection_restore.md) - Restore a new cluster from backup


Expand Down Expand Up @@ -191,6 +193,17 @@ Report kubeblocks or cluster info.
* [kbcli report kubeblocks](kbcli_report_kubeblocks.md) - Report KubeBlocks information, including deployments, events, logs, etc.


## [trace](kbcli_trace.md)

trace management command

* [kbcli trace create](kbcli_trace_create.md) - create a trace.
* [kbcli trace delete](kbcli_trace_delete.md) - Delete a trace.
* [kbcli trace list](kbcli_trace_list.md) - list all traces.
* [kbcli trace update](kbcli_trace_update.md) - update a trace.
* [kbcli trace watch](kbcli_trace_watch.md) - watch a trace.


## [version](kbcli_version.md)

Print the version information, include kubernetes, KubeBlocks and kbcli version.
Expand Down
1 change: 1 addition & 0 deletions docs/user_docs/cli/kbcli.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ kbcli [flags]
* [kbcli playground](kbcli_playground.md) - Bootstrap or destroy a playground KubeBlocks in local host or cloud.
* [kbcli plugin](kbcli_plugin.md) - Provides utilities for interacting with plugins.
* [kbcli report](kbcli_report.md) - Report kubeblocks or cluster info.
* [kbcli trace](kbcli_trace.md) - trace management command
* [kbcli version](kbcli_version.md) - Print the version information, include kubernetes, KubeBlocks and kbcli version.

#### Go Back to [CLI Overview](cli.md) Homepage.
Expand Down
1 change: 1 addition & 0 deletions docs/user_docs/cli/kbcli_addon.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ Addon command.
### SEE ALSO


* [kbcli addon delete-resources-with-version](kbcli_addon_delete-resources-with-version.md) - Delete the sub-resources of specified addon and versions
* [kbcli addon describe](kbcli_addon_describe.md) - Describe an addon specification.
* [kbcli addon disable](kbcli_addon_disable.md) - Disable an addon.
* [kbcli addon enable](kbcli_addon_enable.md) - Enable an addon.
Expand Down
2 changes: 1 addition & 1 deletion docs/user_docs/cli/kbcli_addon_search.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: kbcli addon search
Search the addon from index

```
kbcli addon search [flags]
kbcli addon search [ADDON_NAME] [flags]
```

### Examples
Expand Down
56 changes: 56 additions & 0 deletions docs/user_docs/cli/kbcli_backuprepo_list-storage-provider.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
title: kbcli backuprepo list-storage-provider
---

List storage providers.

```
kbcli backuprepo list-storage-provider [flags]
```

### Examples

```
# List all storage provider
kbcli backuprepo list-sp
```

### Options

```
-h, --help help for list-storage-provider
-o, --output format prints the output in the specified format. Allowed values: table, json, yaml, wide (default table)
-l, --selector string Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2). Matching objects must satisfy all of the specified label constraints.
--show-labels When printing, show all labels as the last column (default hide labels column)
```

### Options inherited from parent commands

```
--as string Username to impersonate for the operation. User could be a regular user or a service account in a namespace.
--as-group stringArray Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
--as-uid string UID to impersonate for the operation.
--cache-dir string Default cache directory (default "$HOME/.kube/cache")
--certificate-authority string Path to a cert file for the certificate authority
--client-certificate string Path to a client certificate file for TLS
--client-key string Path to a client key file for TLS
--cluster string The name of the kubeconfig cluster to use
--context string The name of the kubeconfig context to use
--disable-compression If true, opt-out of response compression for all requests to the server
--insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
--kubeconfig string Path to the kubeconfig file to use for CLI requests.
--match-server-version Require server version to match client version
-n, --namespace string If present, the namespace scope for this CLI request
--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")
-s, --server string The address and port of the Kubernetes API server
--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
--token string Bearer token for authentication to the API server
--user string The name of the kubeconfig user to use
```

### SEE ALSO

* [kbcli backuprepo](kbcli_backuprepo.md) - BackupRepo command.

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

7 changes: 4 additions & 3 deletions docs/user_docs/cli/kbcli_cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ Cluster command.
* [kbcli cluster cancel-ops](kbcli_cluster_cancel-ops.md) - Cancel the pending/creating/running OpsRequest which type is vscale or hscale.
* [kbcli cluster configure](kbcli_cluster_configure.md) - Configure parameters with the specified components in the cluster.
* [kbcli cluster connect](kbcli_cluster_connect.md) - Connect to a cluster or instance.
* [kbcli cluster convert-to-v1](kbcli_cluster_convert-to-v1.md) - convert cluster api version.
* [kbcli cluster create](kbcli_cluster_create.md) - Create a cluster.
* [kbcli cluster custom-ops](kbcli_cluster_custom-ops.md) -
* [kbcli cluster delete](kbcli_cluster_delete.md) - Delete clusters.
Expand All @@ -59,14 +60,14 @@ Cluster command.
* [kbcli cluster expose](kbcli_cluster_expose.md) - Expose a cluster with a new endpoint, the new endpoint can be found by executing 'kbcli cluster describe NAME'.
* [kbcli cluster label](kbcli_cluster_label.md) - Update the labels on cluster
* [kbcli cluster list](kbcli_cluster_list.md) - List clusters.
* [kbcli cluster list-backup](kbcli_cluster_list-backup.md) - List backups.
* [kbcli cluster list-backup-policy](kbcli_cluster_list-backup-policy.md) - List backups policies.
* [kbcli cluster list-backup-policies](kbcli_cluster_list-backup-policies.md) - List backups policies.
* [kbcli cluster list-backups](kbcli_cluster_list-backups.md) - List backups.
* [kbcli cluster list-components](kbcli_cluster_list-components.md) - List cluster components.
* [kbcli cluster list-events](kbcli_cluster_list-events.md) - List cluster events.
* [kbcli cluster list-instances](kbcli_cluster_list-instances.md) - List cluster instances.
* [kbcli cluster list-logs](kbcli_cluster_list-logs.md) - List supported log files in cluster.
* [kbcli cluster list-ops](kbcli_cluster_list-ops.md) - List all opsRequests.
* [kbcli cluster list-restore](kbcli_cluster_list-restore.md) - List restores.
* [kbcli cluster list-restores](kbcli_cluster_list-restores.md) - List restores.
* [kbcli cluster logs](kbcli_cluster_logs.md) - Access cluster log file.
* [kbcli cluster promote](kbcli_cluster_promote.md) - Promote a non-primary or non-leader instance as the new primary or leader of the cluster
* [kbcli cluster rebuild-instance](kbcli_cluster_rebuild-instance.md) - Rebuild the specified instances in the cluster.
Expand Down
2 changes: 1 addition & 1 deletion docs/user_docs/cli/kbcli_cluster_backup.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ kbcli cluster backup NAME [flags]
# create a backup with a specified method, run "kbcli cluster desc-backup-policy mycluster" to show supported backup methods
kbcli cluster backup mycluster --method volume-snapshot

# create a backup with specified backup policy, run "kbcli cluster list-backup-policy mycluster" to show the cluster supported backup policies
# create a backup with specified backup policy, run "kbcli cluster list-backup-policies mycluster" to show the cluster supported backup policies
kbcli cluster backup mycluster --method volume-snapshot --policy <backup-policy-name>

# create a backup from a parent backup
Expand Down
1 change: 1 addition & 0 deletions docs/user_docs/cli/kbcli_cluster_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ kbcli cluster create [NAME] [flags]
* [kbcli cluster](kbcli_cluster.md) - Cluster command.
* [kbcli cluster create apecloud-mysql](kbcli_cluster_create_apecloud-mysql.md) - Create a apecloud-mysql cluster.
* [kbcli cluster create elasticsearch](kbcli_cluster_create_elasticsearch.md) - Create a elasticsearch cluster.
* [kbcli cluster create etcd](kbcli_cluster_create_etcd.md) - Create a etcd cluster.
* [kbcli cluster create kafka](kbcli_cluster_create_kafka.md) - Create a kafka cluster.
* [kbcli cluster create llm](kbcli_cluster_create_llm.md) - Create a llm cluster.
* [kbcli cluster create mongodb](kbcli_cluster_create_mongodb.md) - Create a mongodb cluster.
Expand Down
5 changes: 1 addition & 4 deletions docs/user_docs/cli/kbcli_cluster_create_apecloud-mysql.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,25 +21,22 @@ kbcli cluster create apecloud-mysql NAME [flags]
### Options

```
--availability-policy string The availability policy of cluster. Legal values [none, node, zone]. (default "node")
--cpu float CPU cores. Value range [0.5, 64]. (default 0.5)
--disable-exporter Enable or disable monitor. (default true)
--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")
--edit Edit the API resource before creating
-h, --help help for apecloud-mysql
--host-network-accessible Specify whether the cluster can be accessed from within the VPC.
--memory float Memory, the unit is Gi. Value range [0.5, 1000]. (default 0.5)
--mode string Cluster topology mode. Legal values [standalone, raftGroup]. (default "standalone")
--node-labels stringToString Node label selector (default [])
-o, --output format Prints the output in the specified format. Allowed values: JSON and YAML (default yaml)
--pod-anti-affinity string Pod anti-affinity type, one of: (Preferred, Required) (default "Preferred")
--proxy-enabled Enable proxy or not.
--publicly-accessible Specify whether the cluster can be accessed from the public internet.
--rbac-enabled Specify whether rbac resources will be created by client, otherwise KubeBlocks server will try to create rbac resources.
--replicas int The number of replicas, for standalone mode, the replicas is 1, for raftGroup mode, the default replicas is 3. Value range [1, 5]. (default 1)
--storage float Storage size, the unit is Gi. Value range [1, 10000]. (default 20)
--storage-class-name string Storage class name of the data volume
--tenancy string The tenancy of cluster. Legal values [SharedNode, DedicatedNode]. (default "SharedNode")
--tenancy string Tenancy options, one of: (SharedNode, DedicatedNode) (default "SharedNode")
--termination-policy string The termination policy of cluster. Legal values [DoNotTerminate, Halt, Delete, WipeOut]. (default "Delete")
--tolerations strings Tolerations for cluster, such as "key=value:effect,key:effect", for example '"engineType=mongo:NoSchedule", "diskType:NoSchedule"'
--topology-keys stringArray Topology keys for affinity
Expand Down
7 changes: 2 additions & 5 deletions docs/user_docs/cli/kbcli_cluster_create_elasticsearch.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,23 +21,20 @@ kbcli cluster create elasticsearch NAME [flags]
### Options

```
--availability-policy string The availability policy of cluster. Legal values [none, node, zone]. (default "node")
--cpu float CPU cores. Value range [0.5, 64]. (default 1)
--disable-exporter Enable or disable monitor. (default true)
--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")
--edit Edit the API resource before creating
-h, --help help for elasticsearch
--host-network-accessible Specify whether the cluster can be accessed from within the VPC.
--memory float Memory, the unit is Gi. Value range [1, 1000]. (default 2)
--mode string Mode for ElasticSearch Legal values [single-node, multi-node]. (default "multi-node")
--node-labels stringToString Node label selector (default [])
-o, --output format Prints the output in the specified format. Allowed values: JSON and YAML (default yaml)
--pod-anti-affinity string Pod anti-affinity type, one of: (Preferred, Required) (default "Preferred")
--publicly-accessible Specify whether the cluster can be accessed from the public internet.
--rbac-enabled Specify whether rbac resources will be created by client, otherwise KubeBlocks server will try to create rbac resources. (default true)
--rbac-enabled Specify whether rbac resources will be created by client, otherwise KubeBlocks server will try to create rbac resources.
--replicas int The number of replicas, for single-node mode, the replicas is 1, for multi-node mode, the default replicas is 3. Value range [1, 5]. (default 1)
--storage float Storage size, the unit is Gi. Value range [1, 10000]. (default 20)
--tenancy string The tenancy of cluster. Legal values [SharedNode, DedicatedNode]. (default "SharedNode")
--tenancy string Tenancy options, one of: (SharedNode, DedicatedNode) (default "SharedNode")
--termination-policy string The termination policy of cluster. Legal values [DoNotTerminate, Halt, Delete, WipeOut]. (default "Delete")
--tolerations strings Tolerations for cluster, such as "key=value:effect,key:effect", for example '"engineType=mongo:NoSchedule", "diskType:NoSchedule"'
--topology-keys stringArray Topology keys for affinity
Expand Down
Loading
Loading