KubeBlocks
BlogsKubeBlocks Cloud
kbcli
kbcli addon
kbcli addon describe
kbcli addon disable
kbcli addon enable
kbcli addon index
kbcli addon index add
kbcli addon index delete
kbcli addon index list
kbcli addon index update
kbcli addon install
kbcli addon list
kbcli addon search
kbcli addon uninstall
kbcli addon upgrade
kbcli alert
kbcli alert add-receiver
kbcli alert config-smtpserver
kbcli alert delete-receiver
kbcli alert list-receivers
kbcli alert list-smtpserver
kbcli backuprepo
kbcli backuprepo create
kbcli backuprepo delete
kbcli backuprepo describe
kbcli backuprepo list
kbcli backuprepo update
kbcli bench
kbcli bench delete
kbcli bench describe
kbcli bench list
kbcli bench pgbench
kbcli bench redis-benchmark
kbcli bench sysbench
kbcli bench tpcc
kbcli bench tpcds
kbcli bench tpch
kbcli bench ycsb
kbcli cluster
kbcli cluster backup
kbcli cluster cancel-ops
kbcli cluster configure
kbcli cluster connect
kbcli cluster create-account
kbcli cluster create
kbcli cluster create elasticsearch
kbcli cluster create kafka
kbcli cluster create llm
kbcli cluster create mongodb
kbcli cluster create mysql
kbcli cluster create oriol
kbcli cluster create orioledb
kbcli cluster create postgresql
kbcli cluster create qdrant
kbcli cluster create redis
kbcli cluster create tidb
kbcli cluster create xinference
kbcli cluster custom-ops
kbcli cluster delete-account
kbcli cluster delete-backup
kbcli cluster delete-ops
kbcli cluster delete
kbcli cluster describe-account
kbcli cluster describe-backup-policy
kbcli cluster describe-backup
kbcli cluster describe-config
kbcli cluster describe-ops
kbcli cluster describe
kbcli cluster diff-config
kbcli cluster edit-backup-policy
kbcli cluster edit-config
kbcli cluster explain-config
kbcli cluster expose
kbcli cluster grant-role
kbcli cluster hscale
kbcli cluster label
kbcli cluster list-accounts
kbcli cluster list-backup-policy
kbcli cluster list-backups
kbcli cluster list-components
kbcli cluster list-events
kbcli cluster list-instances
kbcli cluster list-logs
kbcli cluster list-ops
kbcli cluster list
kbcli cluster logs
kbcli cluster promote
kbcli cluster rebuild-instance
kbcli cluster register
kbcli cluster restart
kbcli cluster restore
kbcli cluster revoke-role
kbcli cluster start
kbcli cluster stop
kbcli cluster update
kbcli cluster upgrade
kbcli cluster volume-expand
kbcli cluster vscale
kbcli clusterdefinition
kbcli clusterdefinition describe
kbcli clusterdefinition list-components
kbcli clusterdefinition list-service-reference
kbcli clusterdefinition list
kbcli clusterversion
kbcli clusterversion list
kbcli clusterversion set-default
kbcli clusterversion unset-default
kbcli dashboard
kbcli dashboard list
kbcli dashboard open
kbcli dataprotection
kbcli dataprotection backup
kbcli dataprotection delete-backup
kbcli dataprotection describe-backup-policy
kbcli dataprotection describe-backup
kbcli dataprotection list-backup-policy
kbcli dataprotection list-backups
kbcli dataprotection restore
kbcli kubeblocks
kbcli kubeblocks compare
kbcli kubeblocks config
kbcli kubeblocks describe-config
kbcli kubeblocks install
kbcli kubeblocks list-versions
kbcli kubeblocks preflight
kbcli kubeblocks status
kbcli kubeblocks uninstall
kbcli kubeblocks upgrade
kbcli options
kbcli playground
kbcli playground destroy
kbcli playground init
kbcli plugin
kbcli plugin describe
kbcli plugin index
kbcli plugin index add
kbcli plugin index delete
kbcli plugin index list
kbcli plugin index update
kbcli plugin install
kbcli plugin list
kbcli plugin search
kbcli plugin uninstall
kbcli plugin upgrade
kbcli report
kbcli report cluster
kbcli report kubeblocks
kbcli version
KubeBlocks CLI Overview
  1. Examples
  2. Options
  3. Options inherited from parent commands
  4. SEE ALSO
    1. Go Back to CLI Overview Homepage.

Run YCSB benchmark on a cluster

kbcli bench ycsb [Step] [BenchmarkName] [flags]

Examples

  # ycsb on a cluster,  that will exec for all steps, cleanup, prepare and run
  kbcli bench ycsb mytest --cluster mycluster --user xxx --password xxx --database mydb
  
  # ycsb on a cluster, but with cpu and memory limits set
  kbcli bench ycsb mytest --cluster mycluster --user xxx --password xxx --database mydb --limit-cpu 1 --limit-memory 1Gi
  
  # ycsb on a cluster with cleanup, only cleanup by deleting the testdata
  kbcli bench ycsb cleanup mytest --cluster mycluster --user xxx --password xxx --database mydb
  
  # ycsb on a cluster with prepare, just prepare by creating the testdata
  kbcli bench ycsb prepare mytest --cluster mycluster --user xxx --password xxx --database mydb
  
  # ycsb on a cluster with run, just run by running the test
  kbcli bench ycsb run mytest --cluster mycluster --user xxx --password xxx --database mydb
  
  # ycsb on a cluster with thread counts
  kbcli bench ycsb mytest --cluster mycluster --user xxx --password xxx --database mydb --threads 4,8
  
  # ycsb on a cluster with record number and operation number
  kbcli bench ycsb mytest --cluster mycluster --user xxx --password xxx --database mydb --record-count 10000 --operation-count 10000
  
  # ycsb on a cluster mixed read/write
  kbcli bench ycsb mytest --cluster mycluster --user xxx --password xxx --database mydb --read-proportion 50 --update-proportion 50

Options

      --cluster string                     the cluster of database
      --database string                    database name
      --driver string                      the driver of database
      --extra-args strings                 extra arguments for benchmark
  -h, --help                               help for ycsb
      --host string                        the host of database
      --insert-proportion int              the percentage of insert operations in benchmark
      --limit-cpu string                   the limit cpu of benchmark
      --limit-memory string                the limit memory of benchmark
      --operation-count int                the number of operations to use during the run phase (default 1000)
      --password string                    the password of database
      --port int                           the port of database
      --read-modify-write-proportion int   the percentage of read-modify-write operations in benchmark, which read a record, modify it, and write it back
      --read-proportion int                the percentage of read operations in benchmark
      --record-count int                   the number of records to use (default 1000)
      --request-cpu string                 the request cpu of benchmark
      --request-memory string              the request memory of benchmark
      --scan-proportion int                the percentage of scan operations in benchmark
      --threads ints                       the number of threads to use (default [1])
      --tolerations strings                Tolerations for benchmark, such as '"dev=true:NoSchedule,large=true:NoSchedule"'
      --update-proportion int              the percentage of update operations in benchmark
      --user string                        the user of database

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
      --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

SEE ALSO

  • kbcli bench - Run a benchmark.

Go Back to CLI Overview Homepage.

© 2025 ApeCloud PTE. Ltd.