From ca51dea647728c318071aef605eafcc1fc682a46 Mon Sep 17 00:00:00 2001 From: JashBook Date: Mon, 23 Dec 2024 12:16:01 +0000 Subject: [PATCH] chore: auto update kbcli user docs --- docs/user_docs/cli/_category_.yml | 5 - docs/user_docs/cli/kbcli_backup.md | 46 ------- docs/user_docs/cli/kbcli_backup_create.md | 61 --------- docs/user_docs/cli/kbcli_backup_delete.md | 59 -------- docs/user_docs/cli/kbcli_backup_describe.md | 53 -------- docs/user_docs/cli/kbcli_backup_list.md | 59 -------- .../cli/kbcli_bench_pgbench_cleanup.md | 57 -------- .../cli/kbcli_bench_pgbench_prepare.md | 58 -------- docs/user_docs/cli/kbcli_bench_pgbench_run.md | 74 ---------- .../cli/kbcli_bench_sysbench_cleanup.md | 68 ---------- .../cli/kbcli_bench_sysbench_prepare.md | 68 ---------- .../user_docs/cli/kbcli_bench_sysbench_run.md | 77 ----------- .../user_docs/cli/kbcli_bench_tpcc_cleanup.md | 63 --------- .../user_docs/cli/kbcli_bench_tpcc_prepare.md | 69 ---------- docs/user_docs/cli/kbcli_bench_tpcc_run.md | 66 --------- docs/user_docs/cli/kbcli_builder.md | 44 ------ .../cli/kbcli_builder_migrate-scripts.md | 57 -------- docs/user_docs/cli/kbcli_builder_template.md | 68 ---------- docs/user_docs/cli/kbcli_class.md | 45 ------- docs/user_docs/cli/kbcli_class_create.md | 61 --------- docs/user_docs/cli/kbcli_class_list.md | 54 -------- docs/user_docs/cli/kbcli_class_template.md | 47 ------- docs/user_docs/cli/kbcli_fault.md | 50 ------- docs/user_docs/cli/kbcli_fault_delete.md | 56 -------- docs/user_docs/cli/kbcli_fault_io.md | 46 ------- .../user_docs/cli/kbcli_fault_io_attribute.md | 94 ------------- docs/user_docs/cli/kbcli_fault_io_errno.md | 88 ------------ docs/user_docs/cli/kbcli_fault_io_latency.md | 88 ------------ docs/user_docs/cli/kbcli_fault_io_mistake.md | 90 ------------- docs/user_docs/cli/kbcli_fault_list.md | 60 --------- docs/user_docs/cli/kbcli_fault_network.md | 50 ------- .../cli/kbcli_fault_network_bandwidth.md | 107 --------------- .../cli/kbcli_fault_network_corrupt.md | 104 -------------- .../cli/kbcli_fault_network_delay.md | 105 --------------- docs/user_docs/cli/kbcli_fault_network_dns.md | 44 ------ .../cli/kbcli_fault_network_dns_error.md | 68 ---------- .../cli/kbcli_fault_network_dns_random.md | 68 ---------- .../cli/kbcli_fault_network_duplicate.md | 104 -------------- .../user_docs/cli/kbcli_fault_network_http.md | 46 ------- .../cli/kbcli_fault_network_http_abort.md | 91 ------------- .../cli/kbcli_fault_network_http_delay.md | 91 ------------- .../cli/kbcli_fault_network_http_patch.md | 92 ------------- .../cli/kbcli_fault_network_http_replace.md | 93 ------------- .../user_docs/cli/kbcli_fault_network_loss.md | 104 -------------- .../cli/kbcli_fault_network_partition.md | 102 -------------- docs/user_docs/cli/kbcli_fault_node.md | 45 ------- .../cli/kbcli_fault_node_detach-volume.md | 81 ----------- .../user_docs/cli/kbcli_fault_node_restart.md | 79 ----------- docs/user_docs/cli/kbcli_fault_node_stop.md | 79 ----------- docs/user_docs/cli/kbcli_fault_pod.md | 45 ------- docs/user_docs/cli/kbcli_fault_pod_failure.md | 94 ------------- .../cli/kbcli_fault_pod_kill-container.md | 95 ------------- docs/user_docs/cli/kbcli_fault_pod_kill.md | 95 ------------- docs/user_docs/cli/kbcli_fault_stress.md | 75 ----------- docs/user_docs/cli/kbcli_fault_time.md | 79 ----------- docs/user_docs/cli/kbcli_infra.md | 44 ------ docs/user_docs/cli/kbcli_infra_create.md | 127 ------------------ docs/user_docs/cli/kbcli_infra_delete.md | 65 --------- docs/user_docs/cli/kbcli_login.md | 49 ------- docs/user_docs/cli/kbcli_logout.md | 47 ------- docs/user_docs/cli/kbcli_migration.md | 48 ------- docs/user_docs/cli/kbcli_migration_create.md | 90 ------------- .../user_docs/cli/kbcli_migration_describe.md | 53 -------- docs/user_docs/cli/kbcli_migration_list.md | 69 ---------- docs/user_docs/cli/kbcli_migration_logs.md | 72 ---------- .../cli/kbcli_migration_templates.md | 69 ---------- .../cli/kbcli_migration_terminate.md | 59 -------- 67 files changed, 4659 deletions(-) delete mode 100644 docs/user_docs/cli/_category_.yml delete mode 100644 docs/user_docs/cli/kbcli_backup.md delete mode 100644 docs/user_docs/cli/kbcli_backup_create.md delete mode 100644 docs/user_docs/cli/kbcli_backup_delete.md delete mode 100644 docs/user_docs/cli/kbcli_backup_describe.md delete mode 100644 docs/user_docs/cli/kbcli_backup_list.md delete mode 100644 docs/user_docs/cli/kbcli_bench_pgbench_cleanup.md delete mode 100644 docs/user_docs/cli/kbcli_bench_pgbench_prepare.md delete mode 100644 docs/user_docs/cli/kbcli_bench_pgbench_run.md delete mode 100644 docs/user_docs/cli/kbcli_bench_sysbench_cleanup.md delete mode 100644 docs/user_docs/cli/kbcli_bench_sysbench_prepare.md delete mode 100644 docs/user_docs/cli/kbcli_bench_sysbench_run.md delete mode 100644 docs/user_docs/cli/kbcli_bench_tpcc_cleanup.md delete mode 100644 docs/user_docs/cli/kbcli_bench_tpcc_prepare.md delete mode 100644 docs/user_docs/cli/kbcli_bench_tpcc_run.md delete mode 100644 docs/user_docs/cli/kbcli_builder.md delete mode 100644 docs/user_docs/cli/kbcli_builder_migrate-scripts.md delete mode 100644 docs/user_docs/cli/kbcli_builder_template.md delete mode 100644 docs/user_docs/cli/kbcli_class.md delete mode 100644 docs/user_docs/cli/kbcli_class_create.md delete mode 100644 docs/user_docs/cli/kbcli_class_list.md delete mode 100644 docs/user_docs/cli/kbcli_class_template.md delete mode 100644 docs/user_docs/cli/kbcli_fault.md delete mode 100644 docs/user_docs/cli/kbcli_fault_delete.md delete mode 100644 docs/user_docs/cli/kbcli_fault_io.md delete mode 100644 docs/user_docs/cli/kbcli_fault_io_attribute.md delete mode 100644 docs/user_docs/cli/kbcli_fault_io_errno.md delete mode 100644 docs/user_docs/cli/kbcli_fault_io_latency.md delete mode 100644 docs/user_docs/cli/kbcli_fault_io_mistake.md delete mode 100644 docs/user_docs/cli/kbcli_fault_list.md delete mode 100644 docs/user_docs/cli/kbcli_fault_network.md delete mode 100644 docs/user_docs/cli/kbcli_fault_network_bandwidth.md delete mode 100644 docs/user_docs/cli/kbcli_fault_network_corrupt.md delete mode 100644 docs/user_docs/cli/kbcli_fault_network_delay.md delete mode 100644 docs/user_docs/cli/kbcli_fault_network_dns.md delete mode 100644 docs/user_docs/cli/kbcli_fault_network_dns_error.md delete mode 100644 docs/user_docs/cli/kbcli_fault_network_dns_random.md delete mode 100644 docs/user_docs/cli/kbcli_fault_network_duplicate.md delete mode 100644 docs/user_docs/cli/kbcli_fault_network_http.md delete mode 100644 docs/user_docs/cli/kbcli_fault_network_http_abort.md delete mode 100644 docs/user_docs/cli/kbcli_fault_network_http_delay.md delete mode 100644 docs/user_docs/cli/kbcli_fault_network_http_patch.md delete mode 100644 docs/user_docs/cli/kbcli_fault_network_http_replace.md delete mode 100644 docs/user_docs/cli/kbcli_fault_network_loss.md delete mode 100644 docs/user_docs/cli/kbcli_fault_network_partition.md delete mode 100644 docs/user_docs/cli/kbcli_fault_node.md delete mode 100644 docs/user_docs/cli/kbcli_fault_node_detach-volume.md delete mode 100644 docs/user_docs/cli/kbcli_fault_node_restart.md delete mode 100644 docs/user_docs/cli/kbcli_fault_node_stop.md delete mode 100644 docs/user_docs/cli/kbcli_fault_pod.md delete mode 100644 docs/user_docs/cli/kbcli_fault_pod_failure.md delete mode 100644 docs/user_docs/cli/kbcli_fault_pod_kill-container.md delete mode 100644 docs/user_docs/cli/kbcli_fault_pod_kill.md delete mode 100644 docs/user_docs/cli/kbcli_fault_stress.md delete mode 100644 docs/user_docs/cli/kbcli_fault_time.md delete mode 100644 docs/user_docs/cli/kbcli_infra.md delete mode 100644 docs/user_docs/cli/kbcli_infra_create.md delete mode 100644 docs/user_docs/cli/kbcli_infra_delete.md delete mode 100644 docs/user_docs/cli/kbcli_login.md delete mode 100644 docs/user_docs/cli/kbcli_logout.md delete mode 100644 docs/user_docs/cli/kbcli_migration.md delete mode 100644 docs/user_docs/cli/kbcli_migration_create.md delete mode 100644 docs/user_docs/cli/kbcli_migration_describe.md delete mode 100644 docs/user_docs/cli/kbcli_migration_list.md delete mode 100644 docs/user_docs/cli/kbcli_migration_logs.md delete mode 100644 docs/user_docs/cli/kbcli_migration_templates.md delete mode 100644 docs/user_docs/cli/kbcli_migration_terminate.md diff --git a/docs/user_docs/cli/_category_.yml b/docs/user_docs/cli/_category_.yml deleted file mode 100644 index dff53aca862..00000000000 --- a/docs/user_docs/cli/_category_.yml +++ /dev/null @@ -1,5 +0,0 @@ -position: 30 -label: Command Line -collapsible: true -collapsed: true -className: hide-children \ No newline at end of file diff --git a/docs/user_docs/cli/kbcli_backup.md b/docs/user_docs/cli/kbcli_backup.md deleted file mode 100644 index bc583df17cf..00000000000 --- a/docs/user_docs/cli/kbcli_backup.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: kbcli backup ---- - -Backup command. - -### Options - -``` - -h, --help help for backup -``` - -### 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 backup create](kbcli_backup_create.md) - Create a backup for the cluster. -* [kbcli backup delete](kbcli_backup_delete.md) - Delete a backup. -* [kbcli backup describe](kbcli_backup_describe.md) - Describe a backup -* [kbcli backup list](kbcli_backup_list.md) - List backups. - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_backup_create.md b/docs/user_docs/cli/kbcli_backup_create.md deleted file mode 100644 index 5dbced23bc3..00000000000 --- a/docs/user_docs/cli/kbcli_backup_create.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: kbcli backup create ---- - -Create a backup for the cluster. - -``` -kbcli backup create NAME [flags] -``` - -### Examples - -``` - # Create a backup for the cluster - kbcli backup create mybackup --cluster mycluster - - # create a snapshot backup - kbcli backup create mybackup --cluster mycluster --type snapshot - - # create a backup with specified policy - kbcli backup create mybackup --cluster mycluster --policy mypolicy -``` - -### Options - -``` - --cluster string Cluster name - -h, --help help for create - --method string Backup type (default "snapshot") - --policy string Backup policy name, this flag will be ignored when backup-type is snapshot -``` - -### 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 - --user string The name of the kubeconfig user to use -``` - -### SEE ALSO - -* [kbcli backup](kbcli_backup.md) - Backup command. - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_backup_delete.md b/docs/user_docs/cli/kbcli_backup_delete.md deleted file mode 100644 index 8e89addf67f..00000000000 --- a/docs/user_docs/cli/kbcli_backup_delete.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: kbcli backup delete ---- - -Delete a backup. - -``` -kbcli backup delete [flags] -``` - -### Examples - -``` - # delete a backup - kbcli backup delete mybackup -``` - -### Options - -``` - -A, --all-namespaces If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace. - --auto-approve Skip interactive approval before deleting - --cluster string The cluster name. - --force If true, immediately remove resources from API and bypass graceful deletion. Note that immediate deletion of some resources may result in inconsistency or data loss and requires confirmation. - --grace-period int Period of time in seconds given to the resource to terminate gracefully. Ignored if negative. Set to 1 for immediate shutdown. Can only be set to 0 when --force is true (force deletion). (default -1) - -h, --help help for delete - --now If true, resources are signaled for immediate shutdown (same as --grace-period=1). - -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. -``` - -### 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 - --user string The name of the kubeconfig user to use -``` - -### SEE ALSO - -* [kbcli backup](kbcli_backup.md) - Backup command. - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_backup_describe.md b/docs/user_docs/cli/kbcli_backup_describe.md deleted file mode 100644 index 2f05774cdee..00000000000 --- a/docs/user_docs/cli/kbcli_backup_describe.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: kbcli backup describe ---- - -Describe a backup - -``` -kbcli backup describe [flags] -``` - -### Examples - -``` - # describe a backup - kbcli backup describe mybackup -``` - -### Options - -``` - -h, --help help for describe -``` - -### 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 backup](kbcli_backup.md) - Backup command. - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_backup_list.md b/docs/user_docs/cli/kbcli_backup_list.md deleted file mode 100644 index 6bf9364e122..00000000000 --- a/docs/user_docs/cli/kbcli_backup_list.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: kbcli backup list ---- - -List backups. - -``` -kbcli backup list [flags] -``` - -### Examples - -``` - # list all backups - kbcli backup list - - # list all backups of specified cluster - kbcli backup list --cluster mycluster -``` - -### Options - -``` - --cluster string List backups in the specified cluster - -h, --help help for list - -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 - --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 backup](kbcli_backup.md) - Backup command. - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_bench_pgbench_cleanup.md b/docs/user_docs/cli/kbcli_bench_pgbench_cleanup.md deleted file mode 100644 index 060ab432220..00000000000 --- a/docs/user_docs/cli/kbcli_bench_pgbench_cleanup.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: kbcli bench pgbench cleanup ---- - -Cleanup pgbench test data for a PostgreSQL cluster - -``` -kbcli bench pgbench cleanup [flags] -``` - -### Examples - -``` - # pgbench cleanup data on a cluster - kbcli bench pgbench cleanup pgcluster --database postgres --user xxx --password xxx -``` - -### Options - -``` - -h, --help help for cleanup -``` - -### 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 - --database string database name - --disable-compression If true, opt-out of response compression for all requests to the server - --host string the host of database - --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 - --password string the password of database - --port int the port of database - --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 user of database -``` - -### SEE ALSO - -* [kbcli bench pgbench](kbcli_bench_pgbench.md) - Run pgbench against a PostgreSQL cluster - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_bench_pgbench_prepare.md b/docs/user_docs/cli/kbcli_bench_pgbench_prepare.md deleted file mode 100644 index 0a773750b74..00000000000 --- a/docs/user_docs/cli/kbcli_bench_pgbench_prepare.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: kbcli bench pgbench prepare ---- - -Prepare pgbench test data for a PostgreSQL cluster - -``` -kbcli bench pgbench prepare [ClusterName] [flags] -``` - -### Examples - -``` - # pgbench prepare data on a cluster - kbcli bench pgbench prepare pgcluster --database postgres --user xxx --password xxx --scale 100 -``` - -### Options - -``` - -h, --help help for prepare - --scale int The scale factor to use for pgbench (default 1) -``` - -### 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 - --database string database name - --disable-compression If true, opt-out of response compression for all requests to the server - --host string the host of database - --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 - --password string the password of database - --port int the port of database - --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 user of database -``` - -### SEE ALSO - -* [kbcli bench pgbench](kbcli_bench_pgbench.md) - Run pgbench against a PostgreSQL cluster - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_bench_pgbench_run.md b/docs/user_docs/cli/kbcli_bench_pgbench_run.md deleted file mode 100644 index 76f0bbdd59a..00000000000 --- a/docs/user_docs/cli/kbcli_bench_pgbench_run.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -title: kbcli bench pgbench run ---- - -Run pgbench against a PostgreSQL cluster - -``` -kbcli bench pgbench run [flags] -``` - -### Examples - -``` - # pgbench run on a cluster - kbcli bench pgbench run pgcluster --database postgres --user xxx --password xxx - - # pgbench run on a cluster with different threads and different client - kbcli bench sysbench run pgcluster --user xxx --password xxx --database xxx --clients 5 --threads 5 - - # pgbench run on a cluster with specified transactions - kbcli bench pgbench run pgcluster --database postgres --user xxx --password xxx --transactions 1000 - - # pgbench run on a cluster with specified times - kbcli bench pgbench run pgcluster --database postgres --user xxx --password xxx --times 1000 - - # pgbench run on a cluster with select only - kbcli bench pgbench run pgcluster --database postgres --user xxx --password xxx --select -``` - -### Options - -``` - --clients int The number of clients to use for pgbench (default 1) - -h, --help help for run - --select Run pgbench with select only - --threads int The number of threads to use for pgbench (default 1) - --time int The duration to run pgbench for - --transactions int The number of transactions to run for pgbench -``` - -### 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 - --database string database name - --disable-compression If true, opt-out of response compression for all requests to the server - --host string the host of database - --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 - --password string the password of database - --port int the port of database - --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 user of database -``` - -### SEE ALSO - -* [kbcli bench pgbench](kbcli_bench_pgbench.md) - Run pgbench against a PostgreSQL cluster - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_bench_sysbench_cleanup.md b/docs/user_docs/cli/kbcli_bench_sysbench_cleanup.md deleted file mode 100644 index eb8e60f5c18..00000000000 --- a/docs/user_docs/cli/kbcli_bench_sysbench_cleanup.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: kbcli bench sysbench cleanup ---- - -Cleanup the data of SysBench for cluster - -``` -kbcli bench sysbench cleanup [ClusterName] [flags] -``` - -### Examples - -``` - # sysbench cleanup data on a cluster - kbcli bench sysbench cleanup mycluster --user xxx --password xxx --database mydb - - # sysbench cleanup data on a cluster with specified tables and size - kbcli bench sysbench cleanup mycluster --user xxx --password xxx --database mydb --tables 10 --size 25000 -``` - -### Options - -``` - -h, --help help for cleanup -``` - -### 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 - --database string database name - --disable-compression If true, opt-out of response compression for all requests to the server - --flag int the flag of sysbench, 0(normal), 1(long), 2(three nodes) - --host string the host of database - --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 - --password string the password of database - --port int the port of database - --read-percent int the percent of read, only useful when type is oltp_read_write_pct - --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 - --size int the data size of per table (default 25000) - --tables int the number of tables (default 10) - --threads ints the number of threads, you can set multiple values, like 4,8 (default [4]) - --times int the number of test times (default 60) - --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 - --type strings sysbench type, you can set multiple values (default [oltp_read_write]) - --user string the user of database - --write-percent int the percent of write, only useful when type is oltp_read_write_pct -``` - -### SEE ALSO - -* [kbcli bench sysbench](kbcli_bench_sysbench.md) - run a SysBench benchmark - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_bench_sysbench_prepare.md b/docs/user_docs/cli/kbcli_bench_sysbench_prepare.md deleted file mode 100644 index 2ca7a968b9b..00000000000 --- a/docs/user_docs/cli/kbcli_bench_sysbench_prepare.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: kbcli bench sysbench prepare ---- - -Prepare the data of SysBench for a cluster - -``` -kbcli bench sysbench prepare [ClusterName] [flags] -``` - -### Examples - -``` - # sysbench prepare data on a cluster - kbcli bench sysbench prepare mycluster --user xxx --password xxx --database mydb - - # sysbench prepare data on a cluster with specified tables and size - kbcli bench sysbench prepare mycluster --user xxx --password xxx --database mydb --tables 10 --size 25000 -``` - -### Options - -``` - -h, --help help for prepare -``` - -### 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 - --database string database name - --disable-compression If true, opt-out of response compression for all requests to the server - --flag int the flag of sysbench, 0(normal), 1(long), 2(three nodes) - --host string the host of database - --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 - --password string the password of database - --port int the port of database - --read-percent int the percent of read, only useful when type is oltp_read_write_pct - --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 - --size int the data size of per table (default 25000) - --tables int the number of tables (default 10) - --threads ints the number of threads, you can set multiple values, like 4,8 (default [4]) - --times int the number of test times (default 60) - --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 - --type strings sysbench type, you can set multiple values (default [oltp_read_write]) - --user string the user of database - --write-percent int the percent of write, only useful when type is oltp_read_write_pct -``` - -### SEE ALSO - -* [kbcli bench sysbench](kbcli_bench_sysbench.md) - run a SysBench benchmark - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_bench_sysbench_run.md b/docs/user_docs/cli/kbcli_bench_sysbench_run.md deleted file mode 100644 index c3d3456010f..00000000000 --- a/docs/user_docs/cli/kbcli_bench_sysbench_run.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -title: kbcli bench sysbench run ---- - -Run SysBench on cluster - -``` -kbcli bench sysbench run [ClusterName] [flags] -``` - -### Examples - -``` - # sysbench run on a cluster - kbcli bench sysbench run mycluster --user xxx --password xxx --database mydb - - # sysbench run on a cluster with different threads - kbcli bench sysbench run mycluster --user xxx --password xxx --database mydb --threads 4,8 - - # sysbench run on a cluster with different type - kbcli bench sysbench run mycluster --user xxx --password xxx --database mydb --type oltp_read_only,oltp_read_write - - # sysbench run on a cluster with specified read/write ratio - kbcli bench sysbench run mycluster --user xxx --password xxx --database mydb --type oltp_read_write_pct --read-percent 80 --write-percent 80 - - # sysbench run on a cluster with specified tables and size - kbcli bench sysbench run mycluster --user xxx --password xxx --database mydb --tables 10 --size 25000 -``` - -### Options - -``` - -h, --help help for run -``` - -### 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 - --database string database name - --disable-compression If true, opt-out of response compression for all requests to the server - --flag int the flag of sysbench, 0(normal), 1(long), 2(three nodes) - --host string the host of database - --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 - --password string the password of database - --port int the port of database - --read-percent int the percent of read, only useful when type is oltp_read_write_pct - --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 - --size int the data size of per table (default 25000) - --tables int the number of tables (default 10) - --threads ints the number of threads, you can set multiple values, like 4,8 (default [4]) - --times int the number of test times (default 60) - --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 - --type strings sysbench type, you can set multiple values (default [oltp_read_write]) - --user string the user of database - --write-percent int the percent of write, only useful when type is oltp_read_write_pct -``` - -### SEE ALSO - -* [kbcli bench sysbench](kbcli_bench_sysbench.md) - run a SysBench benchmark - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_bench_tpcc_cleanup.md b/docs/user_docs/cli/kbcli_bench_tpcc_cleanup.md deleted file mode 100644 index 4208c8c2e32..00000000000 --- a/docs/user_docs/cli/kbcli_bench_tpcc_cleanup.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: kbcli bench tpcc cleanup ---- - -Cleanup data for TPCC. - -``` -kbcli bench tpcc cleanup [flags] -``` - -### Options - -``` - -h, --help help for cleanup -``` - -### 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 - --check-all Run all consistency checks - --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 - --count int Total execution count, 0 means infinite - -D, --db string Database name (default "kb_test") - --disable-compression If true, opt-out of response compression for all requests to the server - -d, --driver string Database driver: mysql (default "mysql") - --dropdata Cleanup data before prepare - -H, --host string Database host (default "127.0.0.1") - --ignore-error Ignore error when running workload - --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure - --interval duration Output interval time (default 5s) - --kubeconfig string Path to the kubeconfig file to use for CLI requests. - --match-server-version Require server version to match client version - --max-procs int runtime.GOMAXPROCS - -n, --namespace string If present, the namespace scope for this CLI request - --partition-type int Partition type (1 - HASH, 2 - RANGE, 3 - LIST (like HASH), 4 - LIST (like RANGE) (default 1) - --parts int Number to partition warehouses (default 1) - -p, --password string Database password (default "sakila") - -P, --port int Database port (default 3306) - --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 - --silence Don't print error when running workload - -T, --threads int Thread concurrency (default 1) - --time duration Total execution time (default 2562047h47m16.854775807s) - --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 - -U, --user string Database user (default "root") - --warehouses int Number of warehouses (default 4) -``` - -### SEE ALSO - -* [kbcli bench tpcc](kbcli_bench_tpcc.md) - Run a TPCC benchmark. - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_bench_tpcc_prepare.md b/docs/user_docs/cli/kbcli_bench_tpcc_prepare.md deleted file mode 100644 index 0aa5b756f22..00000000000 --- a/docs/user_docs/cli/kbcli_bench_tpcc_prepare.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: kbcli bench tpcc prepare ---- - -Prepare data for TPCC. - -``` -kbcli bench tpcc prepare [flags] -``` - -### Options - -``` - -h, --help help for prepare - --no-check TPCC prepare check, default false - --output-dir string Output directory for generating file if specified - --output-type string Output file type. If not set, database generates the data itself. Current only support csv - --retry-count int Retry count when errors occur (default 50) - --retry-interval duration The interval for each retry (default 5s) - --tables string Specified tables for generating file, separated by ','. Valid only if output is set. If not set, generate all tables by default -``` - -### 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 - --check-all Run all consistency checks - --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 - --count int Total execution count, 0 means infinite - -D, --db string Database name (default "kb_test") - --disable-compression If true, opt-out of response compression for all requests to the server - -d, --driver string Database driver: mysql (default "mysql") - --dropdata Cleanup data before prepare - -H, --host string Database host (default "127.0.0.1") - --ignore-error Ignore error when running workload - --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure - --interval duration Output interval time (default 5s) - --kubeconfig string Path to the kubeconfig file to use for CLI requests. - --match-server-version Require server version to match client version - --max-procs int runtime.GOMAXPROCS - -n, --namespace string If present, the namespace scope for this CLI request - --partition-type int Partition type (1 - HASH, 2 - RANGE, 3 - LIST (like HASH), 4 - LIST (like RANGE) (default 1) - --parts int Number to partition warehouses (default 1) - -p, --password string Database password (default "sakila") - -P, --port int Database port (default 3306) - --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 - --silence Don't print error when running workload - -T, --threads int Thread concurrency (default 1) - --time duration Total execution time (default 2562047h47m16.854775807s) - --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 - -U, --user string Database user (default "root") - --warehouses int Number of warehouses (default 4) -``` - -### SEE ALSO - -* [kbcli bench tpcc](kbcli_bench_tpcc.md) - Run a TPCC benchmark. - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_bench_tpcc_run.md b/docs/user_docs/cli/kbcli_bench_tpcc_run.md deleted file mode 100644 index 19f2302f12a..00000000000 --- a/docs/user_docs/cli/kbcli_bench_tpcc_run.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: kbcli bench tpcc run ---- - -Run workload. - -``` -kbcli bench tpcc run [flags] -``` - -### Options - -``` - -h, --help help for run - --max-measure-latency duration max measure latency in milliseconds (default 16s) - --wait including keying & thinking time described on TPC-C Standard Specification - --weight ints Weight for NewOrder, Payment, OrderStatus, Delivery, StockLevel (default [45,43,4,4,4]) -``` - -### 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 - --check-all Run all consistency checks - --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 - --count int Total execution count, 0 means infinite - -D, --db string Database name (default "kb_test") - --disable-compression If true, opt-out of response compression for all requests to the server - -d, --driver string Database driver: mysql (default "mysql") - --dropdata Cleanup data before prepare - -H, --host string Database host (default "127.0.0.1") - --ignore-error Ignore error when running workload - --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure - --interval duration Output interval time (default 5s) - --kubeconfig string Path to the kubeconfig file to use for CLI requests. - --match-server-version Require server version to match client version - --max-procs int runtime.GOMAXPROCS - -n, --namespace string If present, the namespace scope for this CLI request - --partition-type int Partition type (1 - HASH, 2 - RANGE, 3 - LIST (like HASH), 4 - LIST (like RANGE) (default 1) - --parts int Number to partition warehouses (default 1) - -p, --password string Database password (default "sakila") - -P, --port int Database port (default 3306) - --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 - --silence Don't print error when running workload - -T, --threads int Thread concurrency (default 1) - --time duration Total execution time (default 2562047h47m16.854775807s) - --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 - -U, --user string Database user (default "root") - --warehouses int Number of warehouses (default 4) -``` - -### SEE ALSO - -* [kbcli bench tpcc](kbcli_bench_tpcc.md) - Run a TPCC benchmark. - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_builder.md b/docs/user_docs/cli/kbcli_builder.md deleted file mode 100644 index c7eed2340a8..00000000000 --- a/docs/user_docs/cli/kbcli_builder.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: kbcli builder ---- - -builder command. - -### Options - -``` - -h, --help help for builder -``` - -### 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 builder migrate-scripts](kbcli_builder_migrate-scripts.md) - migrate - a developer tool. -* [kbcli builder template](kbcli_builder_template.md) - tpl - a developer tool integrated with KubeBlocks that can help developers quickly generate rendered configurations or scripts based on Helm templates, and discover errors in the template before creating the database cluster. - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_builder_migrate-scripts.md b/docs/user_docs/cli/kbcli_builder_migrate-scripts.md deleted file mode 100644 index cb080ff3493..00000000000 --- a/docs/user_docs/cli/kbcli_builder_migrate-scripts.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: kbcli builder migrate-scripts ---- - -migrate - a developer tool. - -``` -kbcli builder migrate-scripts [flags] -``` - -### Examples - -``` - -``` - -### Options - -``` - --configmap string specify the configmap name - --force whether overwrite the exists file - --helm string specify the helm template dir - -h, --help help for migrate-scripts - --output string specify the scripts output path - --regex string specify the regex for configmap -``` - -### 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 builder](kbcli_builder.md) - builder command. - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_builder_template.md b/docs/user_docs/cli/kbcli_builder_template.md deleted file mode 100644 index 621a3c0ec2d..00000000000 --- a/docs/user_docs/cli/kbcli_builder_template.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: kbcli builder template ---- - -tpl - a developer tool integrated with KubeBlocks that can help developers quickly generate rendered configurations or scripts based on Helm templates, and discover errors in the template before creating the database cluster. - -``` -kbcli builder template [flags] -``` - -### Examples - -``` - # builder template: Provides a mechanism to rendered template for ComponentConfigSpec and ComponentScriptSpec in the ClusterComponentDefinition. - # builder template --helm deploy/redis --memory=64Gi --cpu=16 --replicas=3 --component-name=redis --config-spec=redis-replication-config - - # build all configspec - kbcli builder template --helm deploy/redis -a -``` - -### Options - -``` - --clean specify whether to clear the output dir - --cluster string the cluster yaml file - --cluster-definition string specify the cluster definition name - --cluster-version string specify the cluster version name - --component-name string specify the component name of the clusterdefinition - --config-spec string specify the config spec to be rendered - --cpu string specify the cpu of the component - --helm string specify the helm template dir - --helm-output string specify the helm template output dir - -h, --help help for template - --memory string specify the memory of the component - -o, --output-dir string specify the output directory - -r, --replicas int32 specify the replicas of the component (default 1) - --volume-name string specify the data volume name of the component -``` - -### 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 - --user string The name of the kubeconfig user to use -``` - -### SEE ALSO - -* [kbcli builder](kbcli_builder.md) - builder command. - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_class.md b/docs/user_docs/cli/kbcli_class.md deleted file mode 100644 index fc5536db4a7..00000000000 --- a/docs/user_docs/cli/kbcli_class.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: kbcli class ---- - -Manage classes - -### Options - -``` - -h, --help help for class -``` - -### 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 class create](kbcli_class_create.md) - Create a class -* [kbcli class list](kbcli_class_list.md) - List classes -* [kbcli class template](kbcli_class_template.md) - Generate class definition template - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_class_create.md b/docs/user_docs/cli/kbcli_class_create.md deleted file mode 100644 index c45743c2a4b..00000000000 --- a/docs/user_docs/cli/kbcli_class_create.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: kbcli class create ---- - -Create a class - -``` -kbcli class create [NAME] [flags] -``` - -### Examples - -``` - # Create a class for component mysql in cluster definition apecloud-mysql, which has 1 CPU core and 1Gi memory - kbcli class create custom-1c1g --cluster-definition apecloud-mysql --type mysql --cpu 1 --memory 1Gi - - # Create classes for component mysql in cluster definition apecloud-mysql, with classes defined in file - kbcli class create --cluster-definition apecloud-mysql --type mysql --file ./classes.yaml -``` - -### Options - -``` - --cluster-definition string Specify cluster definition, run "kbcli clusterdefinition list" to show all available cluster definitions - --cpu string Specify component CPU cores - --file string Specify file path of class definition YAML - -h, --help help for create - --memory string Specify component memory size - --type string Specify component type -``` - -### 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 class](kbcli_class.md) - Manage classes - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_class_list.md b/docs/user_docs/cli/kbcli_class_list.md deleted file mode 100644 index c44de63f001..00000000000 --- a/docs/user_docs/cli/kbcli_class_list.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: kbcli class list ---- - -List classes - -``` -kbcli class list [flags] -``` - -### Examples - -``` - # List all components classes in cluster definition apecloud-mysql - kbcli class list --cluster-definition apecloud-mysql -``` - -### Options - -``` - --cluster-definition string Specify cluster definition, run "kbcli clusterdefinition list" to show all available cluster definition - -h, --help help for list -``` - -### 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 class](kbcli_class.md) - Manage classes - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_class_template.md b/docs/user_docs/cli/kbcli_class_template.md deleted file mode 100644 index 92af595ade8..00000000000 --- a/docs/user_docs/cli/kbcli_class_template.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: kbcli class template ---- - -Generate class definition template - -``` -kbcli class template [flags] -``` - -### Options - -``` - -h, --help help for template - -o, --output string Output class definition template to a file -``` - -### 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 class](kbcli_class.md) - Manage classes - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_fault.md b/docs/user_docs/cli/kbcli_fault.md deleted file mode 100644 index c1677275612..00000000000 --- a/docs/user_docs/cli/kbcli_fault.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: kbcli fault ---- - -Inject faults to pod. - -### Options - -``` - -h, --help help for fault -``` - -### 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 fault delete](kbcli_fault_delete.md) - Delete chaos resources. -* [kbcli fault io](kbcli_fault_io.md) - IO chaos. -* [kbcli fault list](kbcli_fault_list.md) - List chaos resources. -* [kbcli fault network](kbcli_fault_network.md) - Network chaos. -* [kbcli fault node](kbcli_fault_node.md) - Node chaos. -* [kbcli fault pod](kbcli_fault_pod.md) - Pod chaos. -* [kbcli fault stress](kbcli_fault_stress.md) - Add memory pressure or CPU load to the system. -* [kbcli fault time](kbcli_fault_time.md) - Clock skew failure. - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_fault_delete.md b/docs/user_docs/cli/kbcli_fault_delete.md deleted file mode 100644 index 70837bee665..00000000000 --- a/docs/user_docs/cli/kbcli_fault_delete.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: kbcli fault delete ---- - -Delete chaos resources. - -``` -kbcli fault delete [flags] -``` - -### Examples - -``` - # Delete all chaos resources - kbcli fault delete - - # Delete specific chaos resources - kbcli fault delete podchaos -``` - -### Options - -``` - -h, --help help for delete -``` - -### 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 fault](kbcli_fault.md) - Inject faults to pod. - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_fault_io.md b/docs/user_docs/cli/kbcli_fault_io.md deleted file mode 100644 index 80f1f2ced53..00000000000 --- a/docs/user_docs/cli/kbcli_fault_io.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: kbcli fault io ---- - -IO chaos. - -### Options - -``` - -h, --help help for io -``` - -### 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 fault](kbcli_fault.md) - Inject faults to pod. -* [kbcli fault io attribute](kbcli_fault_io_attribute.md) - Override the attributes of the file. -* [kbcli fault io errno](kbcli_fault_io_errno.md) - Causes IO operations to return specific errors. -* [kbcli fault io latency](kbcli_fault_io_latency.md) - Delayed IO operations. -* [kbcli fault io mistake](kbcli_fault_io_mistake.md) - Alters the contents of the file, distorting the contents of the file. - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_fault_io_attribute.md b/docs/user_docs/cli/kbcli_fault_io_attribute.md deleted file mode 100644 index b9cab95f681..00000000000 --- a/docs/user_docs/cli/kbcli_fault_io_attribute.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -title: kbcli fault io attribute ---- - -Override the attributes of the file. - -``` -kbcli fault io attribute [flags] -``` - -### Examples - -``` - # Affects the first container in default namespace's all pods. Delay all IO operations under the /data path by 10s. - kbcli fault io latency --delay=10s --volume-path=/data - - # Affects the first container in mycluster-mysql-0 pod. - kbcli fault io latency mycluster-mysql-0 --delay=10s --volume-path=/data - - # Affects the mysql container in mycluster-mysql-0 pod. - kbcli fault io latency mycluster-mysql-0 --delay=10s --volume-path=/data -c=mysql - - # There is a 50% probability of affecting the read IO operation of the test.txt file under the /data path. - kbcli fault io latency mycluster-mysql-0 --delay=10s --volume-path=/data --path=test.txt --percent=50 --method=READ -c=mysql - - # Same as above.Make all IO operations under the /data path return the specified error number 22 (Invalid argument). - kbcli fault io errno --volume-path=/data --errno=22 - - # Same as above.Modify the IO operation permission attribute of the files under the /data path to 72.(110 in octal). - kbcli fault io attribute --volume-path=/data --perm=72 - - # Modify all files so that random positions of 1's with a maximum length of 10 bytes will be replaced with 0's. - kbcli fault io mistake --volume-path=/data --filling=zero --max-occurrences=10 --max-length=1 -``` - -### Options - -``` - --annotation stringToString Select the pod to inject the fault according to Annotation. (default []) - --blocks uint The number of blocks the file occupies. - -c, --container stringArray The name of the container, such as mysql, prometheus.If it's empty, the first container will be injected. - --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") - --duration string Supported formats of the duration are: ms / s / m / h. (default "10s") - --gid uint32 The owner's group ID. - -h, --help help for attribute - --ino uint ino number. - --label stringToString label for pod, such as '"app.kubernetes.io/component=mysql, statefulset.kubernetes.io/pod-name=mycluster-mysql-0. (default []) - --method stringArray The file system calls that need to inject faults. For example: WRITE READ - --mode string You can select "one", "all", "fixed", "fixed-percent", "random-max-percent", Specify the experimental mode, that is, which Pods to experiment with. (default "all") - --nlink uint32 The number of hard links. - --node stringArray Inject faults into pods in the specified node. - --node-label stringToString label for node, such as '"kubernetes.io/arch=arm64,kubernetes.io/hostname=minikube-m03,kubernetes.io/os=linux. (default []) - --ns-fault stringArray Specifies the namespace into which you want to inject faults. (default [default]) - -o, --output format Prints the output in the specified format. Allowed values: JSON and YAML (default yaml) - --path string The effective scope of the injection error can be a wildcard or a single file. - --percent int Probability of failure per operation, in %. (default 100) - --perm uint16 Decimal representation of file permissions. - --phase stringArray Specify the pod that injects the fault by the state of the pod. - --size uint File size. - --uid uint32 Owner's user ID. - --value string If you choose mode=fixed or fixed-percent or random-max-percent, you can enter a value to specify the number or percentage of pods you want to inject. - --volume-path string The mount point of the volume in the target container must be the root directory of the mount. -``` - -### 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 fault io](kbcli_fault_io.md) - IO chaos. - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_fault_io_errno.md b/docs/user_docs/cli/kbcli_fault_io_errno.md deleted file mode 100644 index 5e9bcb8c5d2..00000000000 --- a/docs/user_docs/cli/kbcli_fault_io_errno.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -title: kbcli fault io errno ---- - -Causes IO operations to return specific errors. - -``` -kbcli fault io errno [flags] -``` - -### Examples - -``` - # Affects the first container in default namespace's all pods. Delay all IO operations under the /data path by 10s. - kbcli fault io latency --delay=10s --volume-path=/data - - # Affects the first container in mycluster-mysql-0 pod. - kbcli fault io latency mycluster-mysql-0 --delay=10s --volume-path=/data - - # Affects the mysql container in mycluster-mysql-0 pod. - kbcli fault io latency mycluster-mysql-0 --delay=10s --volume-path=/data -c=mysql - - # There is a 50% probability of affecting the read IO operation of the test.txt file under the /data path. - kbcli fault io latency mycluster-mysql-0 --delay=10s --volume-path=/data --path=test.txt --percent=50 --method=READ -c=mysql - - # Same as above.Make all IO operations under the /data path return the specified error number 22 (Invalid argument). - kbcli fault io errno --volume-path=/data --errno=22 - - # Same as above.Modify the IO operation permission attribute of the files under the /data path to 72.(110 in octal). - kbcli fault io attribute --volume-path=/data --perm=72 - - # Modify all files so that random positions of 1's with a maximum length of 10 bytes will be replaced with 0's. - kbcli fault io mistake --volume-path=/data --filling=zero --max-occurrences=10 --max-length=1 -``` - -### Options - -``` - --annotation stringToString Select the pod to inject the fault according to Annotation. (default []) - -c, --container stringArray The name of the container, such as mysql, prometheus.If it's empty, the first container will be injected. - --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") - --duration string Supported formats of the duration are: ms / s / m / h. (default "10s") - --errno int The returned error number. - -h, --help help for errno - --label stringToString label for pod, such as '"app.kubernetes.io/component=mysql, statefulset.kubernetes.io/pod-name=mycluster-mysql-0. (default []) - --method stringArray The file system calls that need to inject faults. For example: WRITE READ - --mode string You can select "one", "all", "fixed", "fixed-percent", "random-max-percent", Specify the experimental mode, that is, which Pods to experiment with. (default "all") - --node stringArray Inject faults into pods in the specified node. - --node-label stringToString label for node, such as '"kubernetes.io/arch=arm64,kubernetes.io/hostname=minikube-m03,kubernetes.io/os=linux. (default []) - --ns-fault stringArray Specifies the namespace into which you want to inject faults. (default [default]) - -o, --output format Prints the output in the specified format. Allowed values: JSON and YAML (default yaml) - --path string The effective scope of the injection error can be a wildcard or a single file. - --percent int Probability of failure per operation, in %. (default 100) - --phase stringArray Specify the pod that injects the fault by the state of the pod. - --value string If you choose mode=fixed or fixed-percent or random-max-percent, you can enter a value to specify the number or percentage of pods you want to inject. - --volume-path string The mount point of the volume in the target container must be the root directory of the mount. -``` - -### 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 fault io](kbcli_fault_io.md) - IO chaos. - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_fault_io_latency.md b/docs/user_docs/cli/kbcli_fault_io_latency.md deleted file mode 100644 index 34dedaf539a..00000000000 --- a/docs/user_docs/cli/kbcli_fault_io_latency.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -title: kbcli fault io latency ---- - -Delayed IO operations. - -``` -kbcli fault io latency [flags] -``` - -### Examples - -``` - # Affects the first container in default namespace's all pods. Delay all IO operations under the /data path by 10s. - kbcli fault io latency --delay=10s --volume-path=/data - - # Affects the first container in mycluster-mysql-0 pod. - kbcli fault io latency mycluster-mysql-0 --delay=10s --volume-path=/data - - # Affects the mysql container in mycluster-mysql-0 pod. - kbcli fault io latency mycluster-mysql-0 --delay=10s --volume-path=/data -c=mysql - - # There is a 50% probability of affecting the read IO operation of the test.txt file under the /data path. - kbcli fault io latency mycluster-mysql-0 --delay=10s --volume-path=/data --path=test.txt --percent=50 --method=READ -c=mysql - - # Same as above.Make all IO operations under the /data path return the specified error number 22 (Invalid argument). - kbcli fault io errno --volume-path=/data --errno=22 - - # Same as above.Modify the IO operation permission attribute of the files under the /data path to 72.(110 in octal). - kbcli fault io attribute --volume-path=/data --perm=72 - - # Modify all files so that random positions of 1's with a maximum length of 10 bytes will be replaced with 0's. - kbcli fault io mistake --volume-path=/data --filling=zero --max-occurrences=10 --max-length=1 -``` - -### Options - -``` - --annotation stringToString Select the pod to inject the fault according to Annotation. (default []) - -c, --container stringArray The name of the container, such as mysql, prometheus.If it's empty, the first container will be injected. - --delay string Specific delay time. - --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") - --duration string Supported formats of the duration are: ms / s / m / h. (default "10s") - -h, --help help for latency - --label stringToString label for pod, such as '"app.kubernetes.io/component=mysql, statefulset.kubernetes.io/pod-name=mycluster-mysql-0. (default []) - --method stringArray The file system calls that need to inject faults. For example: WRITE READ - --mode string You can select "one", "all", "fixed", "fixed-percent", "random-max-percent", Specify the experimental mode, that is, which Pods to experiment with. (default "all") - --node stringArray Inject faults into pods in the specified node. - --node-label stringToString label for node, such as '"kubernetes.io/arch=arm64,kubernetes.io/hostname=minikube-m03,kubernetes.io/os=linux. (default []) - --ns-fault stringArray Specifies the namespace into which you want to inject faults. (default [default]) - -o, --output format Prints the output in the specified format. Allowed values: JSON and YAML (default yaml) - --path string The effective scope of the injection error can be a wildcard or a single file. - --percent int Probability of failure per operation, in %. (default 100) - --phase stringArray Specify the pod that injects the fault by the state of the pod. - --value string If you choose mode=fixed or fixed-percent or random-max-percent, you can enter a value to specify the number or percentage of pods you want to inject. - --volume-path string The mount point of the volume in the target container must be the root directory of the mount. -``` - -### 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 fault io](kbcli_fault_io.md) - IO chaos. - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_fault_io_mistake.md b/docs/user_docs/cli/kbcli_fault_io_mistake.md deleted file mode 100644 index 60d8bdee4ce..00000000000 --- a/docs/user_docs/cli/kbcli_fault_io_mistake.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -title: kbcli fault io mistake ---- - -Alters the contents of the file, distorting the contents of the file. - -``` -kbcli fault io mistake [flags] -``` - -### Examples - -``` - # Affects the first container in default namespace's all pods. Delay all IO operations under the /data path by 10s. - kbcli fault io latency --delay=10s --volume-path=/data - - # Affects the first container in mycluster-mysql-0 pod. - kbcli fault io latency mycluster-mysql-0 --delay=10s --volume-path=/data - - # Affects the mysql container in mycluster-mysql-0 pod. - kbcli fault io latency mycluster-mysql-0 --delay=10s --volume-path=/data -c=mysql - - # There is a 50% probability of affecting the read IO operation of the test.txt file under the /data path. - kbcli fault io latency mycluster-mysql-0 --delay=10s --volume-path=/data --path=test.txt --percent=50 --method=READ -c=mysql - - # Same as above.Make all IO operations under the /data path return the specified error number 22 (Invalid argument). - kbcli fault io errno --volume-path=/data --errno=22 - - # Same as above.Modify the IO operation permission attribute of the files under the /data path to 72.(110 in octal). - kbcli fault io attribute --volume-path=/data --perm=72 - - # Modify all files so that random positions of 1's with a maximum length of 10 bytes will be replaced with 0's. - kbcli fault io mistake --volume-path=/data --filling=zero --max-occurrences=10 --max-length=1 -``` - -### Options - -``` - --annotation stringToString Select the pod to inject the fault according to Annotation. (default []) - -c, --container stringArray The name of the container, such as mysql, prometheus.If it's empty, the first container will be injected. - --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") - --duration string Supported formats of the duration are: ms / s / m / h. (default "10s") - --filling string The filling content of the error data can only be zero (filling with 0) or random (filling with random bytes). - -h, --help help for mistake - --label stringToString label for pod, such as '"app.kubernetes.io/component=mysql, statefulset.kubernetes.io/pod-name=mycluster-mysql-0. (default []) - --max-length int The maximum length (in bytes) of each error. (default 1) - --max-occurrences int The maximum number of times an error can occur per operation. (default 1) - --method stringArray The file system calls that need to inject faults. For example: WRITE READ - --mode string You can select "one", "all", "fixed", "fixed-percent", "random-max-percent", Specify the experimental mode, that is, which Pods to experiment with. (default "all") - --node stringArray Inject faults into pods in the specified node. - --node-label stringToString label for node, such as '"kubernetes.io/arch=arm64,kubernetes.io/hostname=minikube-m03,kubernetes.io/os=linux. (default []) - --ns-fault stringArray Specifies the namespace into which you want to inject faults. (default [default]) - -o, --output format Prints the output in the specified format. Allowed values: JSON and YAML (default yaml) - --path string The effective scope of the injection error can be a wildcard or a single file. - --percent int Probability of failure per operation, in %. (default 100) - --phase stringArray Specify the pod that injects the fault by the state of the pod. - --value string If you choose mode=fixed or fixed-percent or random-max-percent, you can enter a value to specify the number or percentage of pods you want to inject. - --volume-path string The mount point of the volume in the target container must be the root directory of the mount. -``` - -### 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 fault io](kbcli_fault_io.md) - IO chaos. - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_fault_list.md b/docs/user_docs/cli/kbcli_fault_list.md deleted file mode 100644 index d1a1686386f..00000000000 --- a/docs/user_docs/cli/kbcli_fault_list.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: kbcli fault list ---- - -List chaos resources. - -``` -kbcli fault list [flags] -``` - -### Examples - -``` - # List all chaos resources - kbcli fault list - - # List all chaos kind - kbcli fault list --kind - - # List specific chaos resources. Use 'kbcli fault list --kind' to get chaos kind. - kbcli fault list podchaos -``` - -### Options - -``` - -h, --help help for list - --kind Print chaos resource kind. -``` - -### 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 fault](kbcli_fault.md) - Inject faults to pod. - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_fault_network.md b/docs/user_docs/cli/kbcli_fault_network.md deleted file mode 100644 index 414204069b4..00000000000 --- a/docs/user_docs/cli/kbcli_fault_network.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: kbcli fault network ---- - -Network chaos. - -### Options - -``` - -h, --help help for network -``` - -### 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 fault](kbcli_fault.md) - Inject faults to pod. -* [kbcli fault network bandwidth](kbcli_fault_network_bandwidth.md) - Limit the bandwidth that pods use to communicate with other objects. -* [kbcli fault network corrupt](kbcli_fault_network_corrupt.md) - Distorts the messages a pod communicates with other objects. -* [kbcli fault network delay](kbcli_fault_network_delay.md) - Make pods communicate with other objects lazily. -* [kbcli fault network dns](kbcli_fault_network_dns.md) - Inject faults into DNS server. -* [kbcli fault network duplicate](kbcli_fault_network_duplicate.md) - Make pods communicate with other objects to pick up duplicate packets. -* [kbcli fault network http](kbcli_fault_network_http.md) - Intercept HTTP requests and responses. -* [kbcli fault network loss](kbcli_fault_network_loss.md) - Cause pods to communicate with other objects to drop packets. -* [kbcli fault network partition](kbcli_fault_network_partition.md) - Make a pod network partitioned from other objects. - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_fault_network_bandwidth.md b/docs/user_docs/cli/kbcli_fault_network_bandwidth.md deleted file mode 100644 index c36c3e6d3c8..00000000000 --- a/docs/user_docs/cli/kbcli_fault_network_bandwidth.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -title: kbcli fault network bandwidth ---- - -Limit the bandwidth that pods use to communicate with other objects. - -``` -kbcli fault network bandwidth [flags] -``` - -### Examples - -``` - # Isolate all pods network under the default namespace from the outside world, including the k8s internal network. - kbcli fault network partition - - # The specified pod is isolated from the k8s external network "kubeblocks.io". - kbcli fault network partition mycluster-mysql-1 --external-targets=kubeblocks.io - - # Isolate the network between two pods. - kbcli fault network partition mycluster-mysql-1 --target-label=statefulset.kubernetes.io/pod-name=mycluster-mysql-2 - - // Like the partition command, the target can be specified through --target-label or --external-targets. The pod only has obstacles in communicating with this target. If the target is not specified, all communication will be blocked. - # Block all pod communication under the default namespace, resulting in a 50% packet loss rate. - kbcli fault network loss --loss=50 - - # Block the specified pod communication, so that the packet loss rate is 50%. - kbcli fault network loss mysql-cluster-mysql-2 --loss=50 - - kbcli fault network corrupt --corrupt=50 - - # Blocks specified pod communication with a 50% packet corruption rate. - kbcli fault network corrupt mysql-cluster-mysql-2 --corrupt=50 - - kbcli fault network duplicate --duplicate=50 - - # Block specified pod communication so that the packet repetition rate is 50%. - kbcli fault network duplicate mysql-cluster-mysql-2 --duplicate=50 - - kbcli fault network delay --latency=10s - - # Block the communication of the specified pod, causing its network delay for 10s. - kbcli fault network delay mysql-cluster-mysql-2 --latency=10s - - # Limit the communication bandwidth between mysql-cluster-mysql-2 and the outside. - kbcli fault network bandwidth mysql-cluster-mysql-2 --rate=1kbps --duration=1m -``` - -### Options - -``` - --annotation stringToString Select the pod to inject the fault according to Annotation. (default []) - --buffer uint32 the maximum number of bytes that can be sent instantaneously. (default 1) - --direction string You can select "to"" or "from"" or "both"". (default "to") - --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") - --duration string Supported formats of the duration are: ms / s / m / h. (default "10s") - -e, --external-target stringArray a network target outside of Kubernetes, which can be an IPv4 address or a domain name, - such as "www.baidu.com". Only works with direction: to. - -h, --help help for bandwidth - --label stringToString label for pod, such as '"app.kubernetes.io/component=mysql, statefulset.kubernetes.io/pod-name=mycluster-mysql-0. (default []) - --limit uint32 the number of bytes waiting in the queue. (default 1) - --minburst uint32 the size of the peakrate bucket. - --mode string You can select "one", "all", "fixed", "fixed-percent", "random-max-percent", Specify the experimental mode, that is, which Pods to experiment with. (default "all") - --node stringArray Inject faults into pods in the specified node. - --node-label stringToString label for node, such as '"kubernetes.io/arch=arm64,kubernetes.io/hostname=minikube-m03,kubernetes.io/os=linux. (default []) - --ns-fault stringArray Specifies the namespace into which you want to inject faults. (default [default]) - -o, --output format Prints the output in the specified format. Allowed values: JSON and YAML (default yaml) - --peakrate uint the maximum consumption rate of the bucket. - --phase stringArray Specify the pod that injects the fault by the state of the pod. - --rate string the rate at which the bandwidth is limited. For example : 10 bps/kbps/mbps/gbps. - --target-label stringToString label for pod, such as '"app.kubernetes.io/component=mysql, statefulset.kubernetes.io/pod-name=mycluster-mysql-0"' (default []) - --target-mode string You can select "one", "all", "fixed", "fixed-percent", "random-max-percent", Specify the experimental mode, that is, which Pods to experiment with. - --target-ns-fault stringArray Specifies the namespace into which you want to inject faults. - --target-value string If you choose mode=fixed or fixed-percent or random-max-percent, you can enter a value to specify the number or percentage of pods you want to inject. - --value string If you choose mode=fixed or fixed-percent or random-max-percent, you can enter a value to specify the number or percentage of pods you want to inject. -``` - -### 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 fault network](kbcli_fault_network.md) - Network chaos. - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_fault_network_corrupt.md b/docs/user_docs/cli/kbcli_fault_network_corrupt.md deleted file mode 100644 index 2f8ad7bbbbe..00000000000 --- a/docs/user_docs/cli/kbcli_fault_network_corrupt.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -title: kbcli fault network corrupt ---- - -Distorts the messages a pod communicates with other objects. - -``` -kbcli fault network corrupt [flags] -``` - -### Examples - -``` - # Isolate all pods network under the default namespace from the outside world, including the k8s internal network. - kbcli fault network partition - - # The specified pod is isolated from the k8s external network "kubeblocks.io". - kbcli fault network partition mycluster-mysql-1 --external-targets=kubeblocks.io - - # Isolate the network between two pods. - kbcli fault network partition mycluster-mysql-1 --target-label=statefulset.kubernetes.io/pod-name=mycluster-mysql-2 - - // Like the partition command, the target can be specified through --target-label or --external-targets. The pod only has obstacles in communicating with this target. If the target is not specified, all communication will be blocked. - # Block all pod communication under the default namespace, resulting in a 50% packet loss rate. - kbcli fault network loss --loss=50 - - # Block the specified pod communication, so that the packet loss rate is 50%. - kbcli fault network loss mysql-cluster-mysql-2 --loss=50 - - kbcli fault network corrupt --corrupt=50 - - # Blocks specified pod communication with a 50% packet corruption rate. - kbcli fault network corrupt mysql-cluster-mysql-2 --corrupt=50 - - kbcli fault network duplicate --duplicate=50 - - # Block specified pod communication so that the packet repetition rate is 50%. - kbcli fault network duplicate mysql-cluster-mysql-2 --duplicate=50 - - kbcli fault network delay --latency=10s - - # Block the communication of the specified pod, causing its network delay for 10s. - kbcli fault network delay mysql-cluster-mysql-2 --latency=10s - - # Limit the communication bandwidth between mysql-cluster-mysql-2 and the outside. - kbcli fault network bandwidth mysql-cluster-mysql-2 --rate=1kbps --duration=1m -``` - -### Options - -``` - --annotation stringToString Select the pod to inject the fault according to Annotation. (default []) - -c, --correlation string Indicates the correlation between the probability of a packet error occurring and whether it occurred the previous time. Value range: [0, 100]. - --corrupt string Indicates the probability of a packet error occurring. Value range: [0, 100]. - --direction string You can select "to"" or "from"" or "both"". (default "to") - --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") - --duration string Supported formats of the duration are: ms / s / m / h. (default "10s") - -e, --external-target stringArray a network target outside of Kubernetes, which can be an IPv4 address or a domain name, - such as "www.baidu.com". Only works with direction: to. - -h, --help help for corrupt - --label stringToString label for pod, such as '"app.kubernetes.io/component=mysql, statefulset.kubernetes.io/pod-name=mycluster-mysql-0. (default []) - --mode string You can select "one", "all", "fixed", "fixed-percent", "random-max-percent", Specify the experimental mode, that is, which Pods to experiment with. (default "all") - --node stringArray Inject faults into pods in the specified node. - --node-label stringToString label for node, such as '"kubernetes.io/arch=arm64,kubernetes.io/hostname=minikube-m03,kubernetes.io/os=linux. (default []) - --ns-fault stringArray Specifies the namespace into which you want to inject faults. (default [default]) - -o, --output format Prints the output in the specified format. Allowed values: JSON and YAML (default yaml) - --phase stringArray Specify the pod that injects the fault by the state of the pod. - --target-label stringToString label for pod, such as '"app.kubernetes.io/component=mysql, statefulset.kubernetes.io/pod-name=mycluster-mysql-0"' (default []) - --target-mode string You can select "one", "all", "fixed", "fixed-percent", "random-max-percent", Specify the experimental mode, that is, which Pods to experiment with. - --target-ns-fault stringArray Specifies the namespace into which you want to inject faults. - --target-value string If you choose mode=fixed or fixed-percent or random-max-percent, you can enter a value to specify the number or percentage of pods you want to inject. - --value string If you choose mode=fixed or fixed-percent or random-max-percent, you can enter a value to specify the number or percentage of pods you want to inject. -``` - -### 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 fault network](kbcli_fault_network.md) - Network chaos. - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_fault_network_delay.md b/docs/user_docs/cli/kbcli_fault_network_delay.md deleted file mode 100644 index fcaba1dcb8f..00000000000 --- a/docs/user_docs/cli/kbcli_fault_network_delay.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -title: kbcli fault network delay ---- - -Make pods communicate with other objects lazily. - -``` -kbcli fault network delay [flags] -``` - -### Examples - -``` - # Isolate all pods network under the default namespace from the outside world, including the k8s internal network. - kbcli fault network partition - - # The specified pod is isolated from the k8s external network "kubeblocks.io". - kbcli fault network partition mycluster-mysql-1 --external-targets=kubeblocks.io - - # Isolate the network between two pods. - kbcli fault network partition mycluster-mysql-1 --target-label=statefulset.kubernetes.io/pod-name=mycluster-mysql-2 - - // Like the partition command, the target can be specified through --target-label or --external-targets. The pod only has obstacles in communicating with this target. If the target is not specified, all communication will be blocked. - # Block all pod communication under the default namespace, resulting in a 50% packet loss rate. - kbcli fault network loss --loss=50 - - # Block the specified pod communication, so that the packet loss rate is 50%. - kbcli fault network loss mysql-cluster-mysql-2 --loss=50 - - kbcli fault network corrupt --corrupt=50 - - # Blocks specified pod communication with a 50% packet corruption rate. - kbcli fault network corrupt mysql-cluster-mysql-2 --corrupt=50 - - kbcli fault network duplicate --duplicate=50 - - # Block specified pod communication so that the packet repetition rate is 50%. - kbcli fault network duplicate mysql-cluster-mysql-2 --duplicate=50 - - kbcli fault network delay --latency=10s - - # Block the communication of the specified pod, causing its network delay for 10s. - kbcli fault network delay mysql-cluster-mysql-2 --latency=10s - - # Limit the communication bandwidth between mysql-cluster-mysql-2 and the outside. - kbcli fault network bandwidth mysql-cluster-mysql-2 --rate=1kbps --duration=1m -``` - -### Options - -``` - --annotation stringToString Select the pod to inject the fault according to Annotation. (default []) - -c, --correlation string Indicates the probability of a packet error occurring. Value range: [0, 100]. - --direction string You can select "to"" or "from"" or "both"". (default "to") - --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") - --duration string Supported formats of the duration are: ms / s / m / h. (default "10s") - -e, --external-target stringArray a network target outside of Kubernetes, which can be an IPv4 address or a domain name, - such as "www.baidu.com". Only works with direction: to. - -h, --help help for delay - --jitter string the variation range of the delay time. - --label stringToString label for pod, such as '"app.kubernetes.io/component=mysql, statefulset.kubernetes.io/pod-name=mycluster-mysql-0. (default []) - --latency string the length of time to delay. - --mode string You can select "one", "all", "fixed", "fixed-percent", "random-max-percent", Specify the experimental mode, that is, which Pods to experiment with. (default "all") - --node stringArray Inject faults into pods in the specified node. - --node-label stringToString label for node, such as '"kubernetes.io/arch=arm64,kubernetes.io/hostname=minikube-m03,kubernetes.io/os=linux. (default []) - --ns-fault stringArray Specifies the namespace into which you want to inject faults. (default [default]) - -o, --output format Prints the output in the specified format. Allowed values: JSON and YAML (default yaml) - --phase stringArray Specify the pod that injects the fault by the state of the pod. - --target-label stringToString label for pod, such as '"app.kubernetes.io/component=mysql, statefulset.kubernetes.io/pod-name=mycluster-mysql-0"' (default []) - --target-mode string You can select "one", "all", "fixed", "fixed-percent", "random-max-percent", Specify the experimental mode, that is, which Pods to experiment with. - --target-ns-fault stringArray Specifies the namespace into which you want to inject faults. - --target-value string If you choose mode=fixed or fixed-percent or random-max-percent, you can enter a value to specify the number or percentage of pods you want to inject. - --value string If you choose mode=fixed or fixed-percent or random-max-percent, you can enter a value to specify the number or percentage of pods you want to inject. -``` - -### 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 fault network](kbcli_fault_network.md) - Network chaos. - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_fault_network_dns.md b/docs/user_docs/cli/kbcli_fault_network_dns.md deleted file mode 100644 index e049edbbfcf..00000000000 --- a/docs/user_docs/cli/kbcli_fault_network_dns.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: kbcli fault network dns ---- - -Inject faults into DNS server. - -### Options - -``` - -h, --help help for dns -``` - -### 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 fault network](kbcli_fault_network.md) - Network chaos. -* [kbcli fault network dns error](kbcli_fault_network_dns_error.md) - Make DNS return an error when resolving external domain names. -* [kbcli fault network dns random](kbcli_fault_network_dns_random.md) - Make DNS return any IP when resolving external domain names. - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_fault_network_dns_error.md b/docs/user_docs/cli/kbcli_fault_network_dns_error.md deleted file mode 100644 index d399fdad724..00000000000 --- a/docs/user_docs/cli/kbcli_fault_network_dns_error.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: kbcli fault network dns error ---- - -Make DNS return an error when resolving external domain names. - -``` -kbcli fault network dns error [flags] -``` - -### Examples - -``` - // Inject DNS faults into all pods under the default namespace, so that any IP is returned when accessing the bing.com domain name. - kbcli fault dns random --patterns=bing.com --duration=1m - - // Inject DNS faults into all pods under the default namespace, so that error is returned when accessing the bing.com domain name. - kbcli fault dns error --patterns=bing.com --duration=1m -``` - -### Options - -``` - --annotation stringToString Select the pod to inject the fault according to Annotation. (default []) - --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") - --duration string Supported formats of the duration are: ms / s / m / h. (default "10s") - -h, --help help for error - --label stringToString label for pod, such as '"app.kubernetes.io/component=mysql, statefulset.kubernetes.io/pod-name=mycluster-mysql-0. (default []) - --mode string You can select "one", "all", "fixed", "fixed-percent", "random-max-percent", Specify the experimental mode, that is, which Pods to experiment with. (default "all") - --node stringArray Inject faults into pods in the specified node. - --node-label stringToString label for node, such as '"kubernetes.io/arch=arm64,kubernetes.io/hostname=minikube-m03,kubernetes.io/os=linux. (default []) - --ns-fault stringArray Specifies the namespace into which you want to inject faults. (default [default]) - -o, --output format Prints the output in the specified format. Allowed values: JSON and YAML (default yaml) - --patterns stringArray Select the domain name template that matching the failure behavior & supporting placeholders ? and wildcards *. - --phase stringArray Specify the pod that injects the fault by the state of the pod. - --value string If you choose mode=fixed or fixed-percent or random-max-percent, you can enter a value to specify the number or percentage of pods you want to inject. -``` - -### 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 fault network dns](kbcli_fault_network_dns.md) - Inject faults into DNS server. - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_fault_network_dns_random.md b/docs/user_docs/cli/kbcli_fault_network_dns_random.md deleted file mode 100644 index 5a53ed5c72a..00000000000 --- a/docs/user_docs/cli/kbcli_fault_network_dns_random.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: kbcli fault network dns random ---- - -Make DNS return any IP when resolving external domain names. - -``` -kbcli fault network dns random [flags] -``` - -### Examples - -``` - // Inject DNS faults into all pods under the default namespace, so that any IP is returned when accessing the bing.com domain name. - kbcli fault dns random --patterns=bing.com --duration=1m - - // Inject DNS faults into all pods under the default namespace, so that error is returned when accessing the bing.com domain name. - kbcli fault dns error --patterns=bing.com --duration=1m -``` - -### Options - -``` - --annotation stringToString Select the pod to inject the fault according to Annotation. (default []) - --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") - --duration string Supported formats of the duration are: ms / s / m / h. (default "10s") - -h, --help help for random - --label stringToString label for pod, such as '"app.kubernetes.io/component=mysql, statefulset.kubernetes.io/pod-name=mycluster-mysql-0. (default []) - --mode string You can select "one", "all", "fixed", "fixed-percent", "random-max-percent", Specify the experimental mode, that is, which Pods to experiment with. (default "all") - --node stringArray Inject faults into pods in the specified node. - --node-label stringToString label for node, such as '"kubernetes.io/arch=arm64,kubernetes.io/hostname=minikube-m03,kubernetes.io/os=linux. (default []) - --ns-fault stringArray Specifies the namespace into which you want to inject faults. (default [default]) - -o, --output format Prints the output in the specified format. Allowed values: JSON and YAML (default yaml) - --patterns stringArray Select the domain name template that matching the failure behavior & supporting placeholders ? and wildcards *. - --phase stringArray Specify the pod that injects the fault by the state of the pod. - --value string If you choose mode=fixed or fixed-percent or random-max-percent, you can enter a value to specify the number or percentage of pods you want to inject. -``` - -### 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 fault network dns](kbcli_fault_network_dns.md) - Inject faults into DNS server. - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_fault_network_duplicate.md b/docs/user_docs/cli/kbcli_fault_network_duplicate.md deleted file mode 100644 index 15196d2e10d..00000000000 --- a/docs/user_docs/cli/kbcli_fault_network_duplicate.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -title: kbcli fault network duplicate ---- - -Make pods communicate with other objects to pick up duplicate packets. - -``` -kbcli fault network duplicate [flags] -``` - -### Examples - -``` - # Isolate all pods network under the default namespace from the outside world, including the k8s internal network. - kbcli fault network partition - - # The specified pod is isolated from the k8s external network "kubeblocks.io". - kbcli fault network partition mycluster-mysql-1 --external-targets=kubeblocks.io - - # Isolate the network between two pods. - kbcli fault network partition mycluster-mysql-1 --target-label=statefulset.kubernetes.io/pod-name=mycluster-mysql-2 - - // Like the partition command, the target can be specified through --target-label or --external-targets. The pod only has obstacles in communicating with this target. If the target is not specified, all communication will be blocked. - # Block all pod communication under the default namespace, resulting in a 50% packet loss rate. - kbcli fault network loss --loss=50 - - # Block the specified pod communication, so that the packet loss rate is 50%. - kbcli fault network loss mysql-cluster-mysql-2 --loss=50 - - kbcli fault network corrupt --corrupt=50 - - # Blocks specified pod communication with a 50% packet corruption rate. - kbcli fault network corrupt mysql-cluster-mysql-2 --corrupt=50 - - kbcli fault network duplicate --duplicate=50 - - # Block specified pod communication so that the packet repetition rate is 50%. - kbcli fault network duplicate mysql-cluster-mysql-2 --duplicate=50 - - kbcli fault network delay --latency=10s - - # Block the communication of the specified pod, causing its network delay for 10s. - kbcli fault network delay mysql-cluster-mysql-2 --latency=10s - - # Limit the communication bandwidth between mysql-cluster-mysql-2 and the outside. - kbcli fault network bandwidth mysql-cluster-mysql-2 --rate=1kbps --duration=1m -``` - -### Options - -``` - --annotation stringToString Select the pod to inject the fault according to Annotation. (default []) - -c, --correlation string Indicates the correlation between the probability of a packet error occurring and whether it occurred the previous time. Value range: [0, 100]. - --direction string You can select "to"" or "from"" or "both"". (default "to") - --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") - --duplicate string the probability of a packet being repeated. Value range: [0, 100]. - --duration string Supported formats of the duration are: ms / s / m / h. (default "10s") - -e, --external-target stringArray a network target outside of Kubernetes, which can be an IPv4 address or a domain name, - such as "www.baidu.com". Only works with direction: to. - -h, --help help for duplicate - --label stringToString label for pod, such as '"app.kubernetes.io/component=mysql, statefulset.kubernetes.io/pod-name=mycluster-mysql-0. (default []) - --mode string You can select "one", "all", "fixed", "fixed-percent", "random-max-percent", Specify the experimental mode, that is, which Pods to experiment with. (default "all") - --node stringArray Inject faults into pods in the specified node. - --node-label stringToString label for node, such as '"kubernetes.io/arch=arm64,kubernetes.io/hostname=minikube-m03,kubernetes.io/os=linux. (default []) - --ns-fault stringArray Specifies the namespace into which you want to inject faults. (default [default]) - -o, --output format Prints the output in the specified format. Allowed values: JSON and YAML (default yaml) - --phase stringArray Specify the pod that injects the fault by the state of the pod. - --target-label stringToString label for pod, such as '"app.kubernetes.io/component=mysql, statefulset.kubernetes.io/pod-name=mycluster-mysql-0"' (default []) - --target-mode string You can select "one", "all", "fixed", "fixed-percent", "random-max-percent", Specify the experimental mode, that is, which Pods to experiment with. - --target-ns-fault stringArray Specifies the namespace into which you want to inject faults. - --target-value string If you choose mode=fixed or fixed-percent or random-max-percent, you can enter a value to specify the number or percentage of pods you want to inject. - --value string If you choose mode=fixed or fixed-percent or random-max-percent, you can enter a value to specify the number or percentage of pods you want to inject. -``` - -### 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 fault network](kbcli_fault_network.md) - Network chaos. - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_fault_network_http.md b/docs/user_docs/cli/kbcli_fault_network_http.md deleted file mode 100644 index 294cf308287..00000000000 --- a/docs/user_docs/cli/kbcli_fault_network_http.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: kbcli fault network http ---- - -Intercept HTTP requests and responses. - -### Options - -``` - -h, --help help for http -``` - -### 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 fault network](kbcli_fault_network.md) - Network chaos. -* [kbcli fault network http abort](kbcli_fault_network_http_abort.md) - Abort the HTTP request and response. -* [kbcli fault network http delay](kbcli_fault_network_http_delay.md) - Delay the HTTP request and response. -* [kbcli fault network http patch](kbcli_fault_network_http_patch.md) - Patch the HTTP request and response. -* [kbcli fault network http replace](kbcli_fault_network_http_replace.md) - Replace the HTTP request and response. - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_fault_network_http_abort.md b/docs/user_docs/cli/kbcli_fault_network_http_abort.md deleted file mode 100644 index 0be4dc89b61..00000000000 --- a/docs/user_docs/cli/kbcli_fault_network_http_abort.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -title: kbcli fault network http abort ---- - -Abort the HTTP request and response. - -``` -kbcli fault network http abort [flags] -``` - -### Examples - -``` - # By default, the method of GET from port 80 is blocked. - kbcli fault network http abort --duration=1m - - # Block the method of GET from port 4399. - kbcli fault network http abort --port=4399 --duration=1m - - # Block the method of POST from port 4399. - kbcli fault network http abort --port=4399 --method=POST --duration=1m - - # Delays post requests from port 4399. - kbcli fault network http delay --port=4399 --method=POST --delay=15s - - # Replace the GET method sent from port 80 with the PUT method. - kbcli fault network http replace --replace-method=PUT --duration=1m - - # Replace the GET method sent from port 80 with the PUT method, and replace the request body. - kbcli fault network http replace --body="you are good luck" --replace-method=PUT --duration=2m - - # Replace the response content "you" from port 80. - kbcli fault network http replace --target=Response --body=you --duration=30s - - # Append content to the body of the post request sent from port 4399, in JSON format. - kbcli fault network http patch --method=POST --port=4399 --body="you are good luck" --type=JSON --duration=30s -``` - -### Options - -``` - --abort Indicates whether to inject the fault that interrupts the connection. (default true) - --annotation stringToString Select the pod to inject the fault according to Annotation. (default []) - --code int32 The status code responded by target. - --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") - --duration string Supported formats of the duration are: ms / s / m / h. (default "10s") - -h, --help help for abort - --label stringToString label for pod, such as '"app.kubernetes.io/component=mysql, statefulset.kubernetes.io/pod-name=mycluster-mysql-0. (default []) - --method string The HTTP method of the target request method. For example: GET, POST, PUT, DELETE, HEAD, OPTIONS, PATCH. (default "GET") - --mode string You can select "one", "all", "fixed", "fixed-percent", "random-max-percent", Specify the experimental mode, that is, which Pods to experiment with. (default "all") - --node stringArray Inject faults into pods in the specified node. - --node-label stringToString label for node, such as '"kubernetes.io/arch=arm64,kubernetes.io/hostname=minikube-m03,kubernetes.io/os=linux. (default []) - --ns-fault stringArray Specifies the namespace into which you want to inject faults. (default [default]) - -o, --output format Prints the output in the specified format. Allowed values: JSON and YAML (default yaml) - --path string The URI path of the target request. Supports Matching wildcards. (default "*") - --phase stringArray Specify the pod that injects the fault by the state of the pod. - --port int32 The TCP port that the target service listens on. (default 80) - --target string Specifies whether the target of fault injection is Request or Response. The target-related fields should be configured at the same time. (default "Request") - --value string If you choose mode=fixed or fixed-percent or random-max-percent, you can enter a value to specify the number or percentage of pods you want to inject. -``` - -### 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 fault network http](kbcli_fault_network_http.md) - Intercept HTTP requests and responses. - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_fault_network_http_delay.md b/docs/user_docs/cli/kbcli_fault_network_http_delay.md deleted file mode 100644 index 04ec969fb70..00000000000 --- a/docs/user_docs/cli/kbcli_fault_network_http_delay.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -title: kbcli fault network http delay ---- - -Delay the HTTP request and response. - -``` -kbcli fault network http delay [flags] -``` - -### Examples - -``` - # By default, the method of GET from port 80 is blocked. - kbcli fault network http abort --duration=1m - - # Block the method of GET from port 4399. - kbcli fault network http abort --port=4399 --duration=1m - - # Block the method of POST from port 4399. - kbcli fault network http abort --port=4399 --method=POST --duration=1m - - # Delays post requests from port 4399. - kbcli fault network http delay --port=4399 --method=POST --delay=15s - - # Replace the GET method sent from port 80 with the PUT method. - kbcli fault network http replace --replace-method=PUT --duration=1m - - # Replace the GET method sent from port 80 with the PUT method, and replace the request body. - kbcli fault network http replace --body="you are good luck" --replace-method=PUT --duration=2m - - # Replace the response content "you" from port 80. - kbcli fault network http replace --target=Response --body=you --duration=30s - - # Append content to the body of the post request sent from port 4399, in JSON format. - kbcli fault network http patch --method=POST --port=4399 --body="you are good luck" --type=JSON --duration=30s -``` - -### Options - -``` - --annotation stringToString Select the pod to inject the fault according to Annotation. (default []) - --code int32 The status code responded by target. - --delay string The time for delay. (default "10s") - --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") - --duration string Supported formats of the duration are: ms / s / m / h. (default "10s") - -h, --help help for delay - --label stringToString label for pod, such as '"app.kubernetes.io/component=mysql, statefulset.kubernetes.io/pod-name=mycluster-mysql-0. (default []) - --method string The HTTP method of the target request method. For example: GET, POST, PUT, DELETE, HEAD, OPTIONS, PATCH. (default "GET") - --mode string You can select "one", "all", "fixed", "fixed-percent", "random-max-percent", Specify the experimental mode, that is, which Pods to experiment with. (default "all") - --node stringArray Inject faults into pods in the specified node. - --node-label stringToString label for node, such as '"kubernetes.io/arch=arm64,kubernetes.io/hostname=minikube-m03,kubernetes.io/os=linux. (default []) - --ns-fault stringArray Specifies the namespace into which you want to inject faults. (default [default]) - -o, --output format Prints the output in the specified format. Allowed values: JSON and YAML (default yaml) - --path string The URI path of the target request. Supports Matching wildcards. (default "*") - --phase stringArray Specify the pod that injects the fault by the state of the pod. - --port int32 The TCP port that the target service listens on. (default 80) - --target string Specifies whether the target of fault injection is Request or Response. The target-related fields should be configured at the same time. (default "Request") - --value string If you choose mode=fixed or fixed-percent or random-max-percent, you can enter a value to specify the number or percentage of pods you want to inject. -``` - -### 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 fault network http](kbcli_fault_network_http.md) - Intercept HTTP requests and responses. - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_fault_network_http_patch.md b/docs/user_docs/cli/kbcli_fault_network_http_patch.md deleted file mode 100644 index 31182bdf04b..00000000000 --- a/docs/user_docs/cli/kbcli_fault_network_http_patch.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -title: kbcli fault network http patch ---- - -Patch the HTTP request and response. - -``` -kbcli fault network http patch [flags] -``` - -### Examples - -``` - # By default, the method of GET from port 80 is blocked. - kbcli fault network http abort --duration=1m - - # Block the method of GET from port 4399. - kbcli fault network http abort --port=4399 --duration=1m - - # Block the method of POST from port 4399. - kbcli fault network http abort --port=4399 --method=POST --duration=1m - - # Delays post requests from port 4399. - kbcli fault network http delay --port=4399 --method=POST --delay=15s - - # Replace the GET method sent from port 80 with the PUT method. - kbcli fault network http replace --replace-method=PUT --duration=1m - - # Replace the GET method sent from port 80 with the PUT method, and replace the request body. - kbcli fault network http replace --body="you are good luck" --replace-method=PUT --duration=2m - - # Replace the response content "you" from port 80. - kbcli fault network http replace --target=Response --body=you --duration=30s - - # Append content to the body of the post request sent from port 4399, in JSON format. - kbcli fault network http patch --method=POST --port=4399 --body="you are good luck" --type=JSON --duration=30s -``` - -### Options - -``` - --annotation stringToString Select the pod to inject the fault according to Annotation. (default []) - --body string The fault of the request body or response body with patch faults. - --code int32 The status code responded by target. - --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") - --duration string Supported formats of the duration are: ms / s / m / h. (default "10s") - -h, --help help for patch - --label stringToString label for pod, such as '"app.kubernetes.io/component=mysql, statefulset.kubernetes.io/pod-name=mycluster-mysql-0. (default []) - --method string The HTTP method of the target request method. For example: GET, POST, PUT, DELETE, HEAD, OPTIONS, PATCH. (default "GET") - --mode string You can select "one", "all", "fixed", "fixed-percent", "random-max-percent", Specify the experimental mode, that is, which Pods to experiment with. (default "all") - --node stringArray Inject faults into pods in the specified node. - --node-label stringToString label for node, such as '"kubernetes.io/arch=arm64,kubernetes.io/hostname=minikube-m03,kubernetes.io/os=linux. (default []) - --ns-fault stringArray Specifies the namespace into which you want to inject faults. (default [default]) - -o, --output format Prints the output in the specified format. Allowed values: JSON and YAML (default yaml) - --path string The URI path of the target request. Supports Matching wildcards. (default "*") - --phase stringArray Specify the pod that injects the fault by the state of the pod. - --port int32 The TCP port that the target service listens on. (default 80) - --target string Specifies whether the target of fault injection is Request or Response. The target-related fields should be configured at the same time. (default "Request") - --type string The type of patch faults of the request body or response body. Currently, it only supports JSON. - --value string If you choose mode=fixed or fixed-percent or random-max-percent, you can enter a value to specify the number or percentage of pods you want to inject. -``` - -### 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 fault network http](kbcli_fault_network_http.md) - Intercept HTTP requests and responses. - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_fault_network_http_replace.md b/docs/user_docs/cli/kbcli_fault_network_http_replace.md deleted file mode 100644 index 4a1f02ccfea..00000000000 --- a/docs/user_docs/cli/kbcli_fault_network_http_replace.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -title: kbcli fault network http replace ---- - -Replace the HTTP request and response. - -``` -kbcli fault network http replace [flags] -``` - -### Examples - -``` - # By default, the method of GET from port 80 is blocked. - kbcli fault network http abort --duration=1m - - # Block the method of GET from port 4399. - kbcli fault network http abort --port=4399 --duration=1m - - # Block the method of POST from port 4399. - kbcli fault network http abort --port=4399 --method=POST --duration=1m - - # Delays post requests from port 4399. - kbcli fault network http delay --port=4399 --method=POST --delay=15s - - # Replace the GET method sent from port 80 with the PUT method. - kbcli fault network http replace --replace-method=PUT --duration=1m - - # Replace the GET method sent from port 80 with the PUT method, and replace the request body. - kbcli fault network http replace --body="you are good luck" --replace-method=PUT --duration=2m - - # Replace the response content "you" from port 80. - kbcli fault network http replace --target=Response --body=you --duration=30s - - # Append content to the body of the post request sent from port 4399, in JSON format. - kbcli fault network http patch --method=POST --port=4399 --body="you are good luck" --type=JSON --duration=30s -``` - -### Options - -``` - --annotation stringToString Select the pod to inject the fault according to Annotation. (default []) - --body string The content of the request body or response body to replace the failure. - --code int32 The status code responded by target. - --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") - --duration string Supported formats of the duration are: ms / s / m / h. (default "10s") - -h, --help help for replace - --label stringToString label for pod, such as '"app.kubernetes.io/component=mysql, statefulset.kubernetes.io/pod-name=mycluster-mysql-0. (default []) - --method string The HTTP method of the target request method. For example: GET, POST, PUT, DELETE, HEAD, OPTIONS, PATCH. (default "GET") - --mode string You can select "one", "all", "fixed", "fixed-percent", "random-max-percent", Specify the experimental mode, that is, which Pods to experiment with. (default "all") - --node stringArray Inject faults into pods in the specified node. - --node-label stringToString label for node, such as '"kubernetes.io/arch=arm64,kubernetes.io/hostname=minikube-m03,kubernetes.io/os=linux. (default []) - --ns-fault stringArray Specifies the namespace into which you want to inject faults. (default [default]) - -o, --output format Prints the output in the specified format. Allowed values: JSON and YAML (default yaml) - --path string The URI path of the target request. Supports Matching wildcards. (default "*") - --phase stringArray Specify the pod that injects the fault by the state of the pod. - --port int32 The TCP port that the target service listens on. (default 80) - --replace-method string The replaced content of the HTTP request method. - --replace-path string The URI path used to replace content. - --target string Specifies whether the target of fault injection is Request or Response. The target-related fields should be configured at the same time. (default "Request") - --value string If you choose mode=fixed or fixed-percent or random-max-percent, you can enter a value to specify the number or percentage of pods you want to inject. -``` - -### 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 fault network http](kbcli_fault_network_http.md) - Intercept HTTP requests and responses. - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_fault_network_loss.md b/docs/user_docs/cli/kbcli_fault_network_loss.md deleted file mode 100644 index c6d0d401e3d..00000000000 --- a/docs/user_docs/cli/kbcli_fault_network_loss.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -title: kbcli fault network loss ---- - -Cause pods to communicate with other objects to drop packets. - -``` -kbcli fault network loss [flags] -``` - -### Examples - -``` - # Isolate all pods network under the default namespace from the outside world, including the k8s internal network. - kbcli fault network partition - - # The specified pod is isolated from the k8s external network "kubeblocks.io". - kbcli fault network partition mycluster-mysql-1 --external-targets=kubeblocks.io - - # Isolate the network between two pods. - kbcli fault network partition mycluster-mysql-1 --target-label=statefulset.kubernetes.io/pod-name=mycluster-mysql-2 - - // Like the partition command, the target can be specified through --target-label or --external-targets. The pod only has obstacles in communicating with this target. If the target is not specified, all communication will be blocked. - # Block all pod communication under the default namespace, resulting in a 50% packet loss rate. - kbcli fault network loss --loss=50 - - # Block the specified pod communication, so that the packet loss rate is 50%. - kbcli fault network loss mysql-cluster-mysql-2 --loss=50 - - kbcli fault network corrupt --corrupt=50 - - # Blocks specified pod communication with a 50% packet corruption rate. - kbcli fault network corrupt mysql-cluster-mysql-2 --corrupt=50 - - kbcli fault network duplicate --duplicate=50 - - # Block specified pod communication so that the packet repetition rate is 50%. - kbcli fault network duplicate mysql-cluster-mysql-2 --duplicate=50 - - kbcli fault network delay --latency=10s - - # Block the communication of the specified pod, causing its network delay for 10s. - kbcli fault network delay mysql-cluster-mysql-2 --latency=10s - - # Limit the communication bandwidth between mysql-cluster-mysql-2 and the outside. - kbcli fault network bandwidth mysql-cluster-mysql-2 --rate=1kbps --duration=1m -``` - -### Options - -``` - --annotation stringToString Select the pod to inject the fault according to Annotation. (default []) - -c, --correlation string Indicates the correlation between the probability of a packet error occurring and whether it occurred the previous time. Value range: [0, 100]. - --direction string You can select "to"" or "from"" or "both"". (default "to") - --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") - --duration string Supported formats of the duration are: ms / s / m / h. (default "10s") - -e, --external-target stringArray a network target outside of Kubernetes, which can be an IPv4 address or a domain name, - such as "www.baidu.com". Only works with direction: to. - -h, --help help for loss - --label stringToString label for pod, such as '"app.kubernetes.io/component=mysql, statefulset.kubernetes.io/pod-name=mycluster-mysql-0. (default []) - --loss string Indicates the probability of a packet error occurring. Value range: [0, 100]. - --mode string You can select "one", "all", "fixed", "fixed-percent", "random-max-percent", Specify the experimental mode, that is, which Pods to experiment with. (default "all") - --node stringArray Inject faults into pods in the specified node. - --node-label stringToString label for node, such as '"kubernetes.io/arch=arm64,kubernetes.io/hostname=minikube-m03,kubernetes.io/os=linux. (default []) - --ns-fault stringArray Specifies the namespace into which you want to inject faults. (default [default]) - -o, --output format Prints the output in the specified format. Allowed values: JSON and YAML (default yaml) - --phase stringArray Specify the pod that injects the fault by the state of the pod. - --target-label stringToString label for pod, such as '"app.kubernetes.io/component=mysql, statefulset.kubernetes.io/pod-name=mycluster-mysql-0"' (default []) - --target-mode string You can select "one", "all", "fixed", "fixed-percent", "random-max-percent", Specify the experimental mode, that is, which Pods to experiment with. - --target-ns-fault stringArray Specifies the namespace into which you want to inject faults. - --target-value string If you choose mode=fixed or fixed-percent or random-max-percent, you can enter a value to specify the number or percentage of pods you want to inject. - --value string If you choose mode=fixed or fixed-percent or random-max-percent, you can enter a value to specify the number or percentage of pods you want to inject. -``` - -### 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 fault network](kbcli_fault_network.md) - Network chaos. - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_fault_network_partition.md b/docs/user_docs/cli/kbcli_fault_network_partition.md deleted file mode 100644 index 3d80f6362a4..00000000000 --- a/docs/user_docs/cli/kbcli_fault_network_partition.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -title: kbcli fault network partition ---- - -Make a pod network partitioned from other objects. - -``` -kbcli fault network partition [flags] -``` - -### Examples - -``` - # Isolate all pods network under the default namespace from the outside world, including the k8s internal network. - kbcli fault network partition - - # The specified pod is isolated from the k8s external network "kubeblocks.io". - kbcli fault network partition mycluster-mysql-1 --external-targets=kubeblocks.io - - # Isolate the network between two pods. - kbcli fault network partition mycluster-mysql-1 --target-label=statefulset.kubernetes.io/pod-name=mycluster-mysql-2 - - // Like the partition command, the target can be specified through --target-label or --external-targets. The pod only has obstacles in communicating with this target. If the target is not specified, all communication will be blocked. - # Block all pod communication under the default namespace, resulting in a 50% packet loss rate. - kbcli fault network loss --loss=50 - - # Block the specified pod communication, so that the packet loss rate is 50%. - kbcli fault network loss mysql-cluster-mysql-2 --loss=50 - - kbcli fault network corrupt --corrupt=50 - - # Blocks specified pod communication with a 50% packet corruption rate. - kbcli fault network corrupt mysql-cluster-mysql-2 --corrupt=50 - - kbcli fault network duplicate --duplicate=50 - - # Block specified pod communication so that the packet repetition rate is 50%. - kbcli fault network duplicate mysql-cluster-mysql-2 --duplicate=50 - - kbcli fault network delay --latency=10s - - # Block the communication of the specified pod, causing its network delay for 10s. - kbcli fault network delay mysql-cluster-mysql-2 --latency=10s - - # Limit the communication bandwidth between mysql-cluster-mysql-2 and the outside. - kbcli fault network bandwidth mysql-cluster-mysql-2 --rate=1kbps --duration=1m -``` - -### Options - -``` - --annotation stringToString Select the pod to inject the fault according to Annotation. (default []) - --direction string You can select "to"" or "from"" or "both"". (default "to") - --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") - --duration string Supported formats of the duration are: ms / s / m / h. (default "10s") - -e, --external-target stringArray a network target outside of Kubernetes, which can be an IPv4 address or a domain name, - such as "www.baidu.com". Only works with direction: to. - -h, --help help for partition - --label stringToString label for pod, such as '"app.kubernetes.io/component=mysql, statefulset.kubernetes.io/pod-name=mycluster-mysql-0. (default []) - --mode string You can select "one", "all", "fixed", "fixed-percent", "random-max-percent", Specify the experimental mode, that is, which Pods to experiment with. (default "all") - --node stringArray Inject faults into pods in the specified node. - --node-label stringToString label for node, such as '"kubernetes.io/arch=arm64,kubernetes.io/hostname=minikube-m03,kubernetes.io/os=linux. (default []) - --ns-fault stringArray Specifies the namespace into which you want to inject faults. (default [default]) - -o, --output format Prints the output in the specified format. Allowed values: JSON and YAML (default yaml) - --phase stringArray Specify the pod that injects the fault by the state of the pod. - --target-label stringToString label for pod, such as '"app.kubernetes.io/component=mysql, statefulset.kubernetes.io/pod-name=mycluster-mysql-0"' (default []) - --target-mode string You can select "one", "all", "fixed", "fixed-percent", "random-max-percent", Specify the experimental mode, that is, which Pods to experiment with. - --target-ns-fault stringArray Specifies the namespace into which you want to inject faults. - --target-value string If you choose mode=fixed or fixed-percent or random-max-percent, you can enter a value to specify the number or percentage of pods you want to inject. - --value string If you choose mode=fixed or fixed-percent or random-max-percent, you can enter a value to specify the number or percentage of pods you want to inject. -``` - -### 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 fault network](kbcli_fault_network.md) - Network chaos. - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_fault_node.md b/docs/user_docs/cli/kbcli_fault_node.md deleted file mode 100644 index e89be737b73..00000000000 --- a/docs/user_docs/cli/kbcli_fault_node.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: kbcli fault node ---- - -Node chaos. - -### Options - -``` - -h, --help help for node -``` - -### 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 fault](kbcli_fault.md) - Inject faults to pod. -* [kbcli fault node detach-volume](kbcli_fault_node_detach-volume.md) - Detach volume -* [kbcli fault node restart](kbcli_fault_node_restart.md) - Restart instance -* [kbcli fault node stop](kbcli_fault_node_stop.md) - Stop instance - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_fault_node_detach-volume.md b/docs/user_docs/cli/kbcli_fault_node_detach-volume.md deleted file mode 100644 index 5a3757e44d3..00000000000 --- a/docs/user_docs/cli/kbcli_fault_node_detach-volume.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -title: kbcli fault node detach-volume ---- - -Detach volume - -``` -kbcli fault node detach-volume [flags] -``` - -### Examples - -``` - # Stop a specified EC2 instance. - kbcli fault node stop node1 -c=aws --region=cn-northwest-1 --duration=3m - - # Stop two specified EC2 instances. - kbcli fault node stop node1 node2 -c=aws --region=cn-northwest-1 --duration=3m - - # Restart two specified EC2 instances. - kbcli fault node restart node1 node2 -c=aws --region=cn-northwest-1 --duration=3m - - # Detach two specified volume from two specified EC2 instances. - kbcli fault node detach-volume node1 node2 -c=aws --region=cn-northwest-1 --duration=1m --volume-id=v1,v2 --device-name=/d1,/d2 - - # Stop two specified GCK instances. - kbcli fault node stop node1 node2 -c=gcp --region=us-central1-c --project=apecloud-platform-engineering - - # Restart two specified GCK instances. - kbcli fault node restart node1 node2 -c=gcp --region=us-central1-c --project=apecloud-platform-engineering - - # Detach two specified volume from two specified GCK instances. - kbcli fault node detach-volume node1 node2 -c=gcp --region=us-central1-c --project=apecloud-platform-engineering --device-name=/d1,/d2 -``` - -### Options - -``` - --auto-approve Skip interactive approval before create secret. - -c, --cloud-provider string Cloud provider type, one of [aws gcp] - --device-name strings The device name of the volume. - --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") - --duration string Supported formats of the duration are: ms / s / m / h. (default "30s") - -h, --help help for detach-volume - -o, --output format Prints the output in the specified format. Allowed values: JSON and YAML (default yaml) - --project string The name of the GCP project. Only available when cloud-provider=gcp. - --region string The region of the node. - --secret string The name of the secret containing cloud provider specific credentials. - --volume-id strings The volume ids of the ec2. Only available when cloud-provider=aws. -``` - -### 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 fault node](kbcli_fault_node.md) - Node chaos. - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_fault_node_restart.md b/docs/user_docs/cli/kbcli_fault_node_restart.md deleted file mode 100644 index 45bc50abf56..00000000000 --- a/docs/user_docs/cli/kbcli_fault_node_restart.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: kbcli fault node restart ---- - -Restart instance - -``` -kbcli fault node restart [flags] -``` - -### Examples - -``` - # Stop a specified EC2 instance. - kbcli fault node stop node1 -c=aws --region=cn-northwest-1 --duration=3m - - # Stop two specified EC2 instances. - kbcli fault node stop node1 node2 -c=aws --region=cn-northwest-1 --duration=3m - - # Restart two specified EC2 instances. - kbcli fault node restart node1 node2 -c=aws --region=cn-northwest-1 --duration=3m - - # Detach two specified volume from two specified EC2 instances. - kbcli fault node detach-volume node1 node2 -c=aws --region=cn-northwest-1 --duration=1m --volume-id=v1,v2 --device-name=/d1,/d2 - - # Stop two specified GCK instances. - kbcli fault node stop node1 node2 -c=gcp --region=us-central1-c --project=apecloud-platform-engineering - - # Restart two specified GCK instances. - kbcli fault node restart node1 node2 -c=gcp --region=us-central1-c --project=apecloud-platform-engineering - - # Detach two specified volume from two specified GCK instances. - kbcli fault node detach-volume node1 node2 -c=gcp --region=us-central1-c --project=apecloud-platform-engineering --device-name=/d1,/d2 -``` - -### Options - -``` - --auto-approve Skip interactive approval before create secret. - -c, --cloud-provider string Cloud provider type, one of [aws gcp] - --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") - --duration string Supported formats of the duration are: ms / s / m / h. (default "30s") - -h, --help help for restart - -o, --output format Prints the output in the specified format. Allowed values: JSON and YAML (default yaml) - --project string The name of the GCP project. Only available when cloud-provider=gcp. - --region string The region of the node. - --secret string The name of the secret containing cloud provider specific credentials. -``` - -### 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 fault node](kbcli_fault_node.md) - Node chaos. - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_fault_node_stop.md b/docs/user_docs/cli/kbcli_fault_node_stop.md deleted file mode 100644 index 5c538dc5223..00000000000 --- a/docs/user_docs/cli/kbcli_fault_node_stop.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: kbcli fault node stop ---- - -Stop instance - -``` -kbcli fault node stop [flags] -``` - -### Examples - -``` - # Stop a specified EC2 instance. - kbcli fault node stop node1 -c=aws --region=cn-northwest-1 --duration=3m - - # Stop two specified EC2 instances. - kbcli fault node stop node1 node2 -c=aws --region=cn-northwest-1 --duration=3m - - # Restart two specified EC2 instances. - kbcli fault node restart node1 node2 -c=aws --region=cn-northwest-1 --duration=3m - - # Detach two specified volume from two specified EC2 instances. - kbcli fault node detach-volume node1 node2 -c=aws --region=cn-northwest-1 --duration=1m --volume-id=v1,v2 --device-name=/d1,/d2 - - # Stop two specified GCK instances. - kbcli fault node stop node1 node2 -c=gcp --region=us-central1-c --project=apecloud-platform-engineering - - # Restart two specified GCK instances. - kbcli fault node restart node1 node2 -c=gcp --region=us-central1-c --project=apecloud-platform-engineering - - # Detach two specified volume from two specified GCK instances. - kbcli fault node detach-volume node1 node2 -c=gcp --region=us-central1-c --project=apecloud-platform-engineering --device-name=/d1,/d2 -``` - -### Options - -``` - --auto-approve Skip interactive approval before create secret. - -c, --cloud-provider string Cloud provider type, one of [aws gcp] - --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") - --duration string Supported formats of the duration are: ms / s / m / h. (default "30s") - -h, --help help for stop - -o, --output format Prints the output in the specified format. Allowed values: JSON and YAML (default yaml) - --project string The name of the GCP project. Only available when cloud-provider=gcp. - --region string The region of the node. - --secret string The name of the secret containing cloud provider specific credentials. -``` - -### 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 fault node](kbcli_fault_node.md) - Node chaos. - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_fault_pod.md b/docs/user_docs/cli/kbcli_fault_pod.md deleted file mode 100644 index 144789ad545..00000000000 --- a/docs/user_docs/cli/kbcli_fault_pod.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: kbcli fault pod ---- - -Pod chaos. - -### Options - -``` - -h, --help help for pod -``` - -### 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 fault](kbcli_fault.md) - Inject faults to pod. -* [kbcli fault pod failure](kbcli_fault_pod_failure.md) - failure pod -* [kbcli fault pod kill](kbcli_fault_pod_kill.md) - kill pod -* [kbcli fault pod kill-container](kbcli_fault_pod_kill-container.md) - kill containers - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_fault_pod_failure.md b/docs/user_docs/cli/kbcli_fault_pod_failure.md deleted file mode 100644 index 4078627619d..00000000000 --- a/docs/user_docs/cli/kbcli_fault_pod_failure.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -title: kbcli fault pod failure ---- - -failure pod - -``` -kbcli fault pod failure [flags] -``` - -### Examples - -``` - # kill all pods in default namespace - kbcli fault pod kill - - # kill any pod in default namespace - kbcli fault pod kill --mode=one - - # kill two pods in default namespace - kbcli fault pod kill --mode=fixed --value=2 - - # kill 50% pods in default namespace - kbcli fault pod kill --mode=percentage --value=50 - - # kill mysql-cluster-mysql-0 pod in default namespace - kbcli fault pod kill mysql-cluster-mysql-0 - - # kill all pods in default namespace - kbcli fault pod kill --ns-fault="default" - - # --label is required to specify the pods that need to be killed. - kbcli fault pod kill --label statefulset.kubernetes.io/pod-name=mysql-cluster-mysql-2 - - # kill pod under the specified node. - kbcli fault pod kill --node=minikube-m02 - - # kill pod under the specified node-label. - kbcli fault pod kill --node-label=kubernetes.io/arch=arm64 - - # Allow the experiment to last for one minute. - kbcli fault pod failure --duration=1m - - # kill container in pod - kbcli fault pod kill-container mysql-cluster-mysql-0 --container=mysql -``` - -### Options - -``` - --annotation stringToString Select the pod to inject the fault according to Annotation. (default []) - --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") - --duration string Supported formats of the duration are: ms / s / m / h. (default "10s") - -h, --help help for failure - --label stringToString label for pod, such as '"app.kubernetes.io/component=mysql, statefulset.kubernetes.io/pod-name=mycluster-mysql-0. (default []) - --mode string You can select "one", "all", "fixed", "fixed-percent", "random-max-percent", Specify the experimental mode, that is, which Pods to experiment with. (default "all") - --node stringArray Inject faults into pods in the specified node. - --node-label stringToString label for node, such as '"kubernetes.io/arch=arm64,kubernetes.io/hostname=minikube-m03,kubernetes.io/os=linux. (default []) - --ns-fault stringArray Specifies the namespace into which you want to inject faults. (default [default]) - -o, --output format Prints the output in the specified format. Allowed values: JSON and YAML (default yaml) - --phase stringArray Specify the pod that injects the fault by the state of the pod. - --value string If you choose mode=fixed or fixed-percent or random-max-percent, you can enter a value to specify the number or percentage of pods you want to inject. -``` - -### 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 fault pod](kbcli_fault_pod.md) - Pod chaos. - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_fault_pod_kill-container.md b/docs/user_docs/cli/kbcli_fault_pod_kill-container.md deleted file mode 100644 index dc02b6bf98f..00000000000 --- a/docs/user_docs/cli/kbcli_fault_pod_kill-container.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -title: kbcli fault pod kill-container ---- - -kill containers - -``` -kbcli fault pod kill-container [flags] -``` - -### Examples - -``` - # kill all pods in default namespace - kbcli fault pod kill - - # kill any pod in default namespace - kbcli fault pod kill --mode=one - - # kill two pods in default namespace - kbcli fault pod kill --mode=fixed --value=2 - - # kill 50% pods in default namespace - kbcli fault pod kill --mode=percentage --value=50 - - # kill mysql-cluster-mysql-0 pod in default namespace - kbcli fault pod kill mysql-cluster-mysql-0 - - # kill all pods in default namespace - kbcli fault pod kill --ns-fault="default" - - # --label is required to specify the pods that need to be killed. - kbcli fault pod kill --label statefulset.kubernetes.io/pod-name=mysql-cluster-mysql-2 - - # kill pod under the specified node. - kbcli fault pod kill --node=minikube-m02 - - # kill pod under the specified node-label. - kbcli fault pod kill --node-label=kubernetes.io/arch=arm64 - - # Allow the experiment to last for one minute. - kbcli fault pod failure --duration=1m - - # kill container in pod - kbcli fault pod kill-container mysql-cluster-mysql-0 --container=mysql -``` - -### Options - -``` - --annotation stringToString Select the pod to inject the fault according to Annotation. (default []) - -c, --container stringArray the name of the container you want to kill, such as mysql, prometheus. - --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") - --duration string Supported formats of the duration are: ms / s / m / h. (default "10s") - -h, --help help for kill-container - --label stringToString label for pod, such as '"app.kubernetes.io/component=mysql, statefulset.kubernetes.io/pod-name=mycluster-mysql-0. (default []) - --mode string You can select "one", "all", "fixed", "fixed-percent", "random-max-percent", Specify the experimental mode, that is, which Pods to experiment with. (default "all") - --node stringArray Inject faults into pods in the specified node. - --node-label stringToString label for node, such as '"kubernetes.io/arch=arm64,kubernetes.io/hostname=minikube-m03,kubernetes.io/os=linux. (default []) - --ns-fault stringArray Specifies the namespace into which you want to inject faults. (default [default]) - -o, --output format Prints the output in the specified format. Allowed values: JSON and YAML (default yaml) - --phase stringArray Specify the pod that injects the fault by the state of the pod. - --value string If you choose mode=fixed or fixed-percent or random-max-percent, you can enter a value to specify the number or percentage of pods you want to inject. -``` - -### 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 fault pod](kbcli_fault_pod.md) - Pod chaos. - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_fault_pod_kill.md b/docs/user_docs/cli/kbcli_fault_pod_kill.md deleted file mode 100644 index 28addb53a71..00000000000 --- a/docs/user_docs/cli/kbcli_fault_pod_kill.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -title: kbcli fault pod kill ---- - -kill pod - -``` -kbcli fault pod kill [flags] -``` - -### Examples - -``` - # kill all pods in default namespace - kbcli fault pod kill - - # kill any pod in default namespace - kbcli fault pod kill --mode=one - - # kill two pods in default namespace - kbcli fault pod kill --mode=fixed --value=2 - - # kill 50% pods in default namespace - kbcli fault pod kill --mode=percentage --value=50 - - # kill mysql-cluster-mysql-0 pod in default namespace - kbcli fault pod kill mysql-cluster-mysql-0 - - # kill all pods in default namespace - kbcli fault pod kill --ns-fault="default" - - # --label is required to specify the pods that need to be killed. - kbcli fault pod kill --label statefulset.kubernetes.io/pod-name=mysql-cluster-mysql-2 - - # kill pod under the specified node. - kbcli fault pod kill --node=minikube-m02 - - # kill pod under the specified node-label. - kbcli fault pod kill --node-label=kubernetes.io/arch=arm64 - - # Allow the experiment to last for one minute. - kbcli fault pod failure --duration=1m - - # kill container in pod - kbcli fault pod kill-container mysql-cluster-mysql-0 --container=mysql -``` - -### Options - -``` - --annotation stringToString Select the pod to inject the fault according to Annotation. (default []) - --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") - --duration string Supported formats of the duration are: ms / s / m / h. (default "10s") - -g, --grace-period int Grace period represents the duration in seconds before the pod should be killed - -h, --help help for kill - --label stringToString label for pod, such as '"app.kubernetes.io/component=mysql, statefulset.kubernetes.io/pod-name=mycluster-mysql-0. (default []) - --mode string You can select "one", "all", "fixed", "fixed-percent", "random-max-percent", Specify the experimental mode, that is, which Pods to experiment with. (default "all") - --node stringArray Inject faults into pods in the specified node. - --node-label stringToString label for node, such as '"kubernetes.io/arch=arm64,kubernetes.io/hostname=minikube-m03,kubernetes.io/os=linux. (default []) - --ns-fault stringArray Specifies the namespace into which you want to inject faults. (default [default]) - -o, --output format Prints the output in the specified format. Allowed values: JSON and YAML (default yaml) - --phase stringArray Specify the pod that injects the fault by the state of the pod. - --value string If you choose mode=fixed or fixed-percent or random-max-percent, you can enter a value to specify the number or percentage of pods you want to inject. -``` - -### 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 fault pod](kbcli_fault_pod.md) - Pod chaos. - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_fault_stress.md b/docs/user_docs/cli/kbcli_fault_stress.md deleted file mode 100644 index 74029b57c81..00000000000 --- a/docs/user_docs/cli/kbcli_fault_stress.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: kbcli fault stress ---- - -Add memory pressure or CPU load to the system. - -``` -kbcli fault stress [flags] -``` - -### Examples - -``` - # Affects the first container in default namespace's all pods.Making CPU load up to 50%, and the memory up to 100MB. - kbcli fault stress --cpu-worker=2 --cpu-load=50 --memory-worker=1 --memory-size=100Mi - - # Affects the first container in mycluster-mysql-0 pod. Making the CPU load up to 50%, and the memory up to 500MB. - kbcli fault stress mycluster-mysql-0 --cpu-worker=2 --cpu-load=50 - - # Affects the mysql container in mycluster-mysql-0 pod. Making the memory up to 500MB. - kbcli fault stress mycluster-mysql-0 --memory-worker=2 --memory-size=500Mi -c=mysql -``` - -### Options - -``` - --annotation stringToString Select the pod to inject the fault according to Annotation. (default []) - -c, --container stringArray The name of the container, such as mysql, prometheus.If it's empty, the first container will be injected. - --cpu-load int Specifies the percentage of CPU occupied. 0 means no extra load added, 100 means full load. The total load is workers * load. - --cpu-worker int Specifies the number of threads that exert CPU pressure. - --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") - --duration string Supported formats of the duration are: ms / s / m / h. (default "10s") - -h, --help help for stress - --label stringToString label for pod, such as '"app.kubernetes.io/component=mysql, statefulset.kubernetes.io/pod-name=mycluster-mysql-0. (default []) - --memory-size string Specify the size of the allocated memory or the percentage of the total memory, and the sum of the allocated memory is size. For example:256MB or 25% - --memory-worker int Specifies the number of threads that apply memory pressure. - --mode string You can select "one", "all", "fixed", "fixed-percent", "random-max-percent", Specify the experimental mode, that is, which Pods to experiment with. (default "all") - --node stringArray Inject faults into pods in the specified node. - --node-label stringToString label for node, such as '"kubernetes.io/arch=arm64,kubernetes.io/hostname=minikube-m03,kubernetes.io/os=linux. (default []) - --ns-fault stringArray Specifies the namespace into which you want to inject faults. (default [default]) - -o, --output format Prints the output in the specified format. Allowed values: JSON and YAML (default yaml) - --phase stringArray Specify the pod that injects the fault by the state of the pod. - --value string If you choose mode=fixed or fixed-percent or random-max-percent, you can enter a value to specify the number or percentage of pods you want to inject. -``` - -### 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 fault](kbcli_fault.md) - Inject faults to pod. - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_fault_time.md b/docs/user_docs/cli/kbcli_fault_time.md deleted file mode 100644 index ec2271ed015..00000000000 --- a/docs/user_docs/cli/kbcli_fault_time.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: kbcli fault time ---- - -Clock skew failure. - -``` -kbcli fault time [flags] -``` - -### Examples - -``` - # Affects the first container in default namespace's all pods.Shifts the clock back five seconds. - kbcli fault time --time-offset=-5s - - # Affects the first container in default namespace's all pods. - kbcli fault time --time-offset=-5m5s - - # Affects the first container in mycluster-mysql-0 pod. Shifts the clock forward five seconds. - kbcli fault time mycluster-mysql-0 --time-offset=+5s50ms - - # Affects the mysql container in mycluster-mysql-0 pod. Shifts the clock forward five seconds. - kbcli fault time mycluster-mysql-0 --time-offset=+5s -c=mysql - - # The clock that specifies the effect of time offset is CLOCK_REALTIME. - kbcli fault time mycluster-mysql-0 --time-offset=+5s --clock-id=CLOCK_REALTIME -c=mysql -``` - -### Options - -``` - --annotation stringToString Select the pod to inject the fault according to Annotation. (default []) - --clock-id stringArray Specifies the clock on which the time offset acts.If it's empty, it will be set to ['CLOCK_REALTIME'].See clock_gettime [https://man7.org/linux/man-pages/man2/clock_gettime.2.html] document for details. - -c, --container stringArray Specifies the injected container name. For example: mysql. If it's empty, the first container will be injected. - --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") - --duration string Supported formats of the duration are: ms / s / m / h. (default "10s") - -h, --help help for time - --label stringToString label for pod, such as '"app.kubernetes.io/component=mysql, statefulset.kubernetes.io/pod-name=mycluster-mysql-0. (default []) - --mode string You can select "one", "all", "fixed", "fixed-percent", "random-max-percent", Specify the experimental mode, that is, which Pods to experiment with. (default "all") - --node stringArray Inject faults into pods in the specified node. - --node-label stringToString label for node, such as '"kubernetes.io/arch=arm64,kubernetes.io/hostname=minikube-m03,kubernetes.io/os=linux. (default []) - --ns-fault stringArray Specifies the namespace into which you want to inject faults. (default [default]) - -o, --output format Prints the output in the specified format. Allowed values: JSON and YAML (default yaml) - --phase stringArray Specify the pod that injects the fault by the state of the pod. - --time-offset string Specifies the length of the time offset. For example: -5s, -10m100ns. - --value string If you choose mode=fixed or fixed-percent or random-max-percent, you can enter a value to specify the number or percentage of pods you want to inject. -``` - -### 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 fault](kbcli_fault.md) - Inject faults to pod. - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_infra.md b/docs/user_docs/cli/kbcli_infra.md deleted file mode 100644 index a7934026e4d..00000000000 --- a/docs/user_docs/cli/kbcli_infra.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: kbcli infra ---- - -infra command - -### Options - -``` - -h, --help help for infra -``` - -### 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 infra create](kbcli_infra_create.md) - create kubernetes cluster. -* [kbcli infra delete](kbcli_infra_delete.md) - delete kubernetes cluster. - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_infra_create.md b/docs/user_docs/cli/kbcli_infra_create.md deleted file mode 100644 index ea38d46ab6e..00000000000 --- a/docs/user_docs/cli/kbcli_infra_create.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -title: kbcli infra create ---- - -create kubernetes cluster. - -``` -kbcli infra create [flags] -``` - -### Examples - -``` - # Create kubernetes cluster with specified config yaml - kbcli infra create -c cluster.yaml - - # example cluster.yaml - cat cluster.yaml - metadata: - name: kb-k8s-test-cluster - user: - name: user1 - privateKeyPath: ~/.ssh/test.pem - nodes: - - name: kb-infra-node-0 - address: 1.1.1.1 - internalAddress: 10.128.0.19 - - name: kb-infra-node-1 - address: 1.1.1.2 - internalAddress: 10.128.0.20 - - name: kb-infra-node-2 - address: 1.1.1.3 - internalAddress: 10.128.0.21 - options: - hugePageFeature: - hugePageSize: 10GB - roleGroup: - etcd: - - kb-infra-node-0 - - kb-infra-node-1 - - kb-infra-node-2 - master: - - kb-infra-node-0 - worker: - - kb-infra-node-1 - - kb-infra-node-2 - - kubernetes: - containerManager: containerd - # apis/kubeadm/types.Networking - networking: - plugin: cilium - dnsDomain: cluster.local - podSubnet: 10.233.64.0/18 - serviceSubnet: 10.233.0.0/18 - controlPlaneEndpoint: - domain: lb.kubeblocks.local - port: 6443 - cri: - containerRuntimeType: "containerd" - containerRuntimeEndpoint: "unix:///run/containerd/containerd.sock" - sandBoxImage: "k8s.gcr.io/pause:3.8" - addons: - - name: openebs - namespace: kube-blocks - sources: - chart: - name: openebs - version: 3.7.0 - repo: https://openebs.github.io/charts - options: - values: - - "localprovisioner.basePath=/mnt/disks" - - "localprovisioner.hostpathClass.isDefaultClass=true" -``` - -### Options - -``` - -c, --config string Specify infra cluster config file. [option] - --container-runtime string Specify kubernetes container runtime. default is containerd (default "containerd") - --debug set debug mode - --etcd strings Specify etcd nodes - -h, --help help for create - --master strings Specify master nodes - --name string Specify kubernetes cluster name - --nodes strings List of machines on which kubernetes is installed. [require] - --output-kubeconfig string Specified output kubeconfig. [option] (default "$HOME/.kube/config") - -p, --password string Specify the password for the account to execute sudo. [option] - --private-key string The PrimaryKey for ssh to the remote machine. [option] - --private-key-path string Specify the file PrimaryKeyPath of ssh to the remote machine. default ~/.ssh/id_rsa. - --sandbox-image string Specified sandbox-image will not be used by the cri. [option] (default "k8s.gcr.io/pause:3.8") - -t, --timeout int Specify the ssh timeout.[option] (default 30) - -u, --user string Specify the account to access the remote server. [require] - --version string Specify install kubernetes version. default version is v1.26.5 (default "v1.26.5") - --worker strings Specify worker nodes -``` - -### 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 -``` - -### SEE ALSO - -* [kbcli infra](kbcli_infra.md) - infra command - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_infra_delete.md b/docs/user_docs/cli/kbcli_infra_delete.md deleted file mode 100644 index df0df7a78e6..00000000000 --- a/docs/user_docs/cli/kbcli_infra_delete.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: kbcli infra delete ---- - -delete kubernetes cluster. - -``` -kbcli infra delete [flags] -``` - -### Examples - -``` - # delete kubernetes cluster with specified config yaml - kbcli infra delete -c cluster.yaml -``` - -### Options - -``` - -c, --config string Specify infra cluster config file. [option] - --debug set debug mode - --delete-cri delete cri - --etcd strings Specify etcd nodes - -h, --help help for delete - --master strings Specify master nodes - --name string Specify kubernetes cluster name - --nodes strings List of machines on which kubernetes is installed. [require] - -p, --password string Specify the password for the account to execute sudo. [option] - --private-key string The PrimaryKey for ssh to the remote machine. [option] - --private-key-path string Specify the file PrimaryKeyPath of ssh to the remote machine. default ~/.ssh/id_rsa. - -t, --timeout int Specify the ssh timeout.[option] (default 30) - -u, --user string Specify the account to access the remote server. [require] - --worker strings Specify worker nodes -``` - -### 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 -``` - -### SEE ALSO - -* [kbcli infra](kbcli_infra.md) - infra command - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_login.md b/docs/user_docs/cli/kbcli_login.md deleted file mode 100644 index 407acf5f7d8..00000000000 --- a/docs/user_docs/cli/kbcli_login.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: kbcli login ---- - -Authenticate with the KubeBlocks Cloud - -``` -kbcli login [flags] -``` - -### Options - -``` - -c, --context string Context name. - -h, --help help for login - --no-browser Do not open the browser for authentication. - -o, --org string Organization name. - -r, --region string Specify the region [jp] to log in. (default "jp") -``` - -### 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 - --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 - - - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_logout.md b/docs/user_docs/cli/kbcli_logout.md deleted file mode 100644 index 416c159489d..00000000000 --- a/docs/user_docs/cli/kbcli_logout.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: kbcli logout ---- - -Log out of the KubeBlocks Cloud - -``` -kbcli logout [flags] -``` - -### Options - -``` - -h, --help help for logout - -r, --region string Specify the region [jp] to log in. (default "jp") -``` - -### 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 - - - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_migration.md b/docs/user_docs/cli/kbcli_migration.md deleted file mode 100644 index 3cf6987d9ed..00000000000 --- a/docs/user_docs/cli/kbcli_migration.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: kbcli migration ---- - -Data migration between two data sources. - -### Options - -``` - -h, --help help for migration -``` - -### 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 migration create](kbcli_migration_create.md) - Create a migration task. -* [kbcli migration describe](kbcli_migration_describe.md) - Show details of a specific migration task. -* [kbcli migration list](kbcli_migration_list.md) - List migration tasks. -* [kbcli migration logs](kbcli_migration_logs.md) - Access migration task log file. -* [kbcli migration templates](kbcli_migration_templates.md) - List migration templates. -* [kbcli migration terminate](kbcli_migration_terminate.md) - Delete migration task. - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_migration_create.md b/docs/user_docs/cli/kbcli_migration_create.md deleted file mode 100644 index e06fc219740..00000000000 --- a/docs/user_docs/cli/kbcli_migration_create.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -title: kbcli migration create ---- - -Create a migration task. - -``` -kbcli migration create NAME [flags] -``` - -### Examples - -``` - # Create a migration task to migrate the entire database under mysql: mydb1 and mytable1 under database: mydb2 to the target mysql - kbcli migration create mytask --template apecloud-mysql2mysql - --source user:123456@127.0.0.1:3306 - --sink user:123456@127.0.0.1:3305 - --migration-object '"mydb1","mydb2.mytable1"' - - # Create a migration task to migrate the schema: myschema under database: mydb1 under PostgreSQL to the target PostgreSQL - kbcli migration create mytask --template apecloud-pg2pg - --source user:123456@127.0.0.1:3306/mydb1 - --sink user:123456@127.0.0.1:3305/mydb1 - --migration-object '"myschema"' - - # Use prechecks, data initialization, CDC, but do not perform structure initialization - kbcli migration create mytask --template apecloud-pg2pg - --source user:123456@127.0.0.1:3306/mydb1 - --sink user:123456@127.0.0.1:3305/mydb1 - --migration-object '"myschema"' - --steps precheck=true,init-struct=false,init-data=true,cdc=true - - # Create a migration task with two tolerations - kbcli migration create mytask --template apecloud-pg2pg - --source user:123456@127.0.0.1:3306/mydb1 - --sink user:123456@127.0.0.1:3305/mydb1 - --migration-object '"myschema"' - --tolerations '"step=global,key=engineType,value=pg,operator=Equal,effect=NoSchedule","step=init-data,key=diskType,value=ssd,operator=Equal,effect=NoSchedule"' - - # Limit resource usage when performing data initialization - kbcli migration create mytask --template apecloud-pg2pg - --source user:123456@127.0.0.1:3306/mydb1 - --sink user:123456@127.0.0.1:3305/mydb1 - --migration-object '"myschema"' - --resources '"step=init-data,cpu=1000m,memory=1Gi"' -``` - -### Options - -``` - -h, --help help for create - --migration-object strings Set the data objects that need to be migrated,such as '"db1.table1","db2"' - --resources strings Resources limit for migration, such as '"cpu=3000m,memory=3Gi"' - --sink string Set the sink database information for migration.such as '{username}:{password}@{connection_address}:{connection_port}/[{database}] - --source string Set the source database information for migration.such as '{username}:{password}@{connection_address}:{connection_port}/[{database}]' - --steps strings Set up migration steps,such as: precheck=true,init-struct=true,init-data=true,cdc=true - --template string Specify migration template, run "kbcli migration templates" to show all available migration templates - --tolerations strings Tolerations for migration, such as '"key=engineType,value=pg,operator=Equal,effect=NoSchedule"' -``` - -### 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 migration](kbcli_migration.md) - Data migration between two data sources. - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_migration_describe.md b/docs/user_docs/cli/kbcli_migration_describe.md deleted file mode 100644 index 73432c7c023..00000000000 --- a/docs/user_docs/cli/kbcli_migration_describe.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: kbcli migration describe ---- - -Show details of a specific migration task. - -``` -kbcli migration describe NAME [flags] -``` - -### Examples - -``` - # describe a specified migration task - kbcli migration describe mytask -``` - -### Options - -``` - -h, --help help for describe -``` - -### 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 migration](kbcli_migration.md) - Data migration between two data sources. - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_migration_list.md b/docs/user_docs/cli/kbcli_migration_list.md deleted file mode 100644 index 62347f4763c..00000000000 --- a/docs/user_docs/cli/kbcli_migration_list.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: kbcli migration list ---- - -List migration tasks. - -``` -kbcli migration list [NAME] [flags] -``` - -### Examples - -``` - # list all migration tasks - kbcli migration list - - # list a single migration task with specified NAME - kbcli migration list mytask - - # list a single migration task in YAML output format - kbcli migration list mytask -o yaml - - # list a single migration task in JSON output format - kbcli migration list mytask -o json - - # list a single migration task in wide output format - kbcli migration list mytask -o wide -``` - -### Options - -``` - -A, --all-namespaces If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace. - -h, --help help for list - -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 migration](kbcli_migration.md) - Data migration between two data sources. - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_migration_logs.md b/docs/user_docs/cli/kbcli_migration_logs.md deleted file mode 100644 index 2048907c9cb..00000000000 --- a/docs/user_docs/cli/kbcli_migration_logs.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -title: kbcli migration logs ---- - -Access migration task log file. - -``` -kbcli migration logs NAME [flags] -``` - -### Examples - -``` - # Logs when returning to the "init-struct" step from the migration task mytask - kbcli migration logs mytask --step init-struct - - # Logs only the most recent 20 lines when returning to the "cdc" step from the migration task mytask - kbcli migration logs mytask --step cdc --tail=20 -``` - -### Options - -``` - --all-containers Get all containers' logs in the pod(s). - -c, --container string Print the logs of this container - -f, --follow Specify if the logs should be streamed. - -h, --help help for logs - --ignore-errors If watching / following pod logs, allow for any errors that occur to be non-fatal - --insecure-skip-tls-verify-backend Skip verifying the identity of the kubelet that logs are requested from. In theory, an attacker could provide invalid log content back. You might want to use this if your kubelet serving certificates have expired. - --limit-bytes int Maximum bytes of logs to return. Defaults to no limit. - --max-log-requests int Specify maximum number of concurrent logs to follow when using by a selector. Defaults to 5. - --pod-running-timeout duration The length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running (default 20s) - --prefix Prefix each log line with the log source (pod name and container name) - -p, --previous If true, print the logs for the previous instance of the container in a pod if it exists. - -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. - --since duration Only return logs newer than a relative duration like 5s, 2m, or 3h. Defaults to all logs. Only one of since-time / since may be used. - --since-time string Only return logs after a specific date (RFC3339). Defaults to all logs. Only one of since-time / since may be used. - --step string Specify the step. Allow values: precheck,init-struct,init-data,cdc - --tail int Lines of recent log file to display. Defaults to -1 with no selector, showing all log lines otherwise 10, if a selector is provided. (default -1) - --timestamps Include timestamps on each line in the log output -``` - -### 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 migration](kbcli_migration.md) - Data migration between two data sources. - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_migration_templates.md b/docs/user_docs/cli/kbcli_migration_templates.md deleted file mode 100644 index cd25b2ee54e..00000000000 --- a/docs/user_docs/cli/kbcli_migration_templates.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: kbcli migration templates ---- - -List migration templates. - -``` -kbcli migration templates [NAME] [flags] -``` - -### Examples - -``` - # list all migration templates - kbcli migration templates - - # list a single migration template with specified NAME - kbcli migration templates mytemplate - - # list a single migration template in YAML output format - kbcli migration templates mytemplate -o yaml - - # list a single migration template in JSON output format - kbcli migration templates mytemplate -o json - - # list a single migration template in wide output format - kbcli migration templates mytemplate -o wide -``` - -### Options - -``` - -A, --all-namespaces If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace. - -h, --help help for templates - -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 migration](kbcli_migration.md) - Data migration between two data sources. - -#### Go Back to [CLI Overview](cli.md) Homepage. - diff --git a/docs/user_docs/cli/kbcli_migration_terminate.md b/docs/user_docs/cli/kbcli_migration_terminate.md deleted file mode 100644 index bcec9fa01ef..00000000000 --- a/docs/user_docs/cli/kbcli_migration_terminate.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: kbcli migration terminate ---- - -Delete migration task. - -``` -kbcli migration terminate NAME [flags] -``` - -### Examples - -``` - # terminate a migration task named mytask and delete resources in k8s without affecting source and target data in database - kbcli migration terminate mytask -``` - -### Options - -``` - -A, --all-namespaces If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace. - --auto-approve Skip interactive approval before deleting - --force If true, immediately remove resources from API and bypass graceful deletion. Note that immediate deletion of some resources may result in inconsistency or data loss and requires confirmation. - --grace-period int Period of time in seconds given to the resource to terminate gracefully. Ignored if negative. Set to 1 for immediate shutdown. Can only be set to 0 when --force is true (force deletion). (default -1) - -h, --help help for terminate - --now If true, resources are signaled for immediate shutdown (same as --grace-period=1). - -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. -``` - -### 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 migration](kbcli_migration.md) - Data migration between two data sources. - -#### Go Back to [CLI Overview](cli.md) Homepage. -