From 9468b8d14440a19aeef6103c548b1dce5168460f Mon Sep 17 00:00:00 2001 From: lgtm <1gtm@users.noreply.github.com> Date: Mon, 9 Oct 2023 06:21:34 -0700 Subject: [PATCH] Update docs for kubedb/cli@54f42c6a (#564) Signed-off-by: 1gtm <1gtm@appscode.com> --- docs/reference/cli/kubectl-dba.md | 1 + docs/reference/cli/kubectl-dba_data_drop.md | 1 + .../cli/kubectl-dba_data_drop_mongodb.md | 63 +++++++++++++++++ docs/reference/cli/kubectl-dba_data_insert.md | 1 + .../kubectl-dba_data_insert_elasticsearch.md | 2 +- .../cli/kubectl-dba_data_insert_mariadb.md | 2 +- .../cli/kubectl-dba_data_insert_mongodb.md | 64 +++++++++++++++++ .../cli/kubectl-dba_data_insert_mysql.md | 2 +- .../cli/kubectl-dba_data_insert_postgres.md | 2 +- .../cli/kubectl-dba_data_insert_redis.md | 2 +- docs/reference/cli/kubectl-dba_data_verify.md | 1 + .../kubectl-dba_data_verify_elasticsearch.md | 4 +- .../cli/kubectl-dba_data_verify_mariadb.md | 2 +- .../cli/kubectl-dba_data_verify_mongodb.md | 64 +++++++++++++++++ .../cli/kubectl-dba_data_verify_mysql.md | 2 +- .../cli/kubectl-dba_data_verify_postgres.md | 2 +- .../cli/kubectl-dba_data_verify_redis.md | 2 +- .../cli/kubectl-dba_remote-config.md | 65 ++++++++++++++++++ .../cli/kubectl-dba_remote-config_mysql.md | 68 +++++++++++++++++++ .../cli/kubectl-dba_remote-config_postgres.md | 68 +++++++++++++++++++ 20 files changed, 407 insertions(+), 11 deletions(-) create mode 100644 docs/reference/cli/kubectl-dba_data_drop_mongodb.md create mode 100644 docs/reference/cli/kubectl-dba_data_insert_mongodb.md create mode 100644 docs/reference/cli/kubectl-dba_data_verify_mongodb.md create mode 100644 docs/reference/cli/kubectl-dba_remote-config.md create mode 100644 docs/reference/cli/kubectl-dba_remote-config_mysql.md create mode 100644 docs/reference/cli/kubectl-dba_remote-config_postgres.md diff --git a/docs/reference/cli/kubectl-dba.md b/docs/reference/cli/kubectl-dba.md index 32673bec74..81fef30779 100644 --- a/docs/reference/cli/kubectl-dba.md +++ b/docs/reference/cli/kubectl-dba.md @@ -62,6 +62,7 @@ kubectl-dba [flags] * [kubectl-dba exec](/docs/reference/cli/kubectl-dba_exec.md) - Execute script or command to a database. * [kubectl-dba options](/docs/reference/cli/kubectl-dba_options.md) - Print the list of flags inherited by all commands * [kubectl-dba pause](/docs/reference/cli/kubectl-dba_pause.md) - Pause the processing of an object. +* [kubectl-dba remote-config](/docs/reference/cli/kubectl-dba_remote-config.md) - generate appbinding , secrets for remote replica * [kubectl-dba restart](/docs/reference/cli/kubectl-dba_restart.md) - Smartly restart the pods of the database. * [kubectl-dba resume](/docs/reference/cli/kubectl-dba_resume.md) - Resume processing of an object. * [kubectl-dba show-credentials](/docs/reference/cli/kubectl-dba_show-credentials.md) - Prints credentials of the database. diff --git a/docs/reference/cli/kubectl-dba_data_drop.md b/docs/reference/cli/kubectl-dba_data_drop.md index 4b6c5d3d32..30735f08eb 100644 --- a/docs/reference/cli/kubectl-dba_data_drop.md +++ b/docs/reference/cli/kubectl-dba_data_drop.md @@ -74,6 +74,7 @@ kubectl-dba data drop * [kubectl-dba data](/docs/reference/cli/kubectl-dba_data.md) - Insert, Drop or Verify data in a database * [kubectl-dba data drop elasticsearch](/docs/reference/cli/kubectl-dba_data_drop_elasticsearch.md) - Delete data from elasticsearch database * [kubectl-dba data drop mariadb](/docs/reference/cli/kubectl-dba_data_drop_mariadb.md) - Verify rows in a MariaDB database +* [kubectl-dba data drop mongodb](/docs/reference/cli/kubectl-dba_data_drop_mongodb.md) - Drop data from mongodb * [kubectl-dba data drop mysql](/docs/reference/cli/kubectl-dba_data_drop_mysql.md) - Verify rows in a MySQL database * [kubectl-dba data drop postgres](/docs/reference/cli/kubectl-dba_data_drop_postgres.md) - Delete data from postgres database * [kubectl-dba data drop redis](/docs/reference/cli/kubectl-dba_data_drop_redis.md) - Delete data from redis database diff --git a/docs/reference/cli/kubectl-dba_data_drop_mongodb.md b/docs/reference/cli/kubectl-dba_data_drop_mongodb.md new file mode 100644 index 0000000000..1f89ad96ad --- /dev/null +++ b/docs/reference/cli/kubectl-dba_data_drop_mongodb.md @@ -0,0 +1,63 @@ +--- +title: Kubectl-Dba Data Drop Mongodb +menu: + docs_{{ .version }}: + identifier: kubectl-dba-data-drop-mongodb + name: Kubectl-Dba Data Drop Mongodb + parent: reference-cli +menu_name: docs_{{ .version }} +section_menu_id: reference +--- +## kubectl-dba data drop mongodb + +Drop data from mongodb + +### Synopsis + +Use this cmd to drop data from a mongodb database. + +``` +kubectl-dba data drop mongodb [flags] +``` + +### Examples + +``` +kubectl dba data drop mg -n demo mg-rs +``` + +### Options + +``` + -h, --help help for mongodb +``` + +### 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/runner/.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 + --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 Password for basic authentication to the API server + --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 + --username string Username for basic authentication to the API server +``` + +### SEE ALSO + +* [kubectl-dba data drop](/docs/reference/cli/kubectl-dba_data_drop.md) - Drop data from a database + diff --git a/docs/reference/cli/kubectl-dba_data_insert.md b/docs/reference/cli/kubectl-dba_data_insert.md index d454fc814d..d85dfab1f1 100644 --- a/docs/reference/cli/kubectl-dba_data_insert.md +++ b/docs/reference/cli/kubectl-dba_data_insert.md @@ -74,6 +74,7 @@ kubectl-dba data insert * [kubectl-dba data](/docs/reference/cli/kubectl-dba_data.md) - Insert, Drop or Verify data in a database * [kubectl-dba data insert elasticsearch](/docs/reference/cli/kubectl-dba_data_insert_elasticsearch.md) - Insert data to a elasticsearch database * [kubectl-dba data insert mariadb](/docs/reference/cli/kubectl-dba_data_insert_mariadb.md) - Connect to a mariadb object +* [kubectl-dba data insert mongodb](/docs/reference/cli/kubectl-dba_data_insert_mongodb.md) - Insert data to mongodb * [kubectl-dba data insert mysql](/docs/reference/cli/kubectl-dba_data_insert_mysql.md) - Connect to a mysql object * [kubectl-dba data insert postgres](/docs/reference/cli/kubectl-dba_data_insert_postgres.md) - Insert data to a postgres object's pod * [kubectl-dba data insert redis](/docs/reference/cli/kubectl-dba_data_insert_redis.md) - Insert data to a redis database diff --git a/docs/reference/cli/kubectl-dba_data_insert_elasticsearch.md b/docs/reference/cli/kubectl-dba_data_insert_elasticsearch.md index 4397f72369..3517164379 100644 --- a/docs/reference/cli/kubectl-dba_data_insert_elasticsearch.md +++ b/docs/reference/cli/kubectl-dba_data_insert_elasticsearch.md @@ -30,7 +30,7 @@ kubectl dba insert -n demo es es-quickstart --rows 1000 ``` -h, --help help for elasticsearch - -r, --rows int rows in (default 10) + -r, --rows int number of rows to insert (default 100) ``` ### Options inherited from parent commands diff --git a/docs/reference/cli/kubectl-dba_data_insert_mariadb.md b/docs/reference/cli/kubectl-dba_data_insert_mariadb.md index d8307f6616..e872611e9c 100644 --- a/docs/reference/cli/kubectl-dba_data_insert_mariadb.md +++ b/docs/reference/cli/kubectl-dba_data_insert_mariadb.md @@ -30,7 +30,7 @@ kubectl dba insert mariadb -n demo sample-mariadb --rows 1000 ``` -h, --help help for mariadb - -r, --rows int rows in (default 10) + -r, --rows int number of rows to insert (default 100) ``` ### Options inherited from parent commands diff --git a/docs/reference/cli/kubectl-dba_data_insert_mongodb.md b/docs/reference/cli/kubectl-dba_data_insert_mongodb.md new file mode 100644 index 0000000000..2a5742fbaa --- /dev/null +++ b/docs/reference/cli/kubectl-dba_data_insert_mongodb.md @@ -0,0 +1,64 @@ +--- +title: Kubectl-Dba Data Insert Mongodb +menu: + docs_{{ .version }}: + identifier: kubectl-dba-data-insert-mongodb + name: Kubectl-Dba Data Insert Mongodb + parent: reference-cli +menu_name: docs_{{ .version }} +section_menu_id: reference +--- +## kubectl-dba data insert mongodb + +Insert data to mongodb + +### Synopsis + +Use this cmd to insert data into a mongodb database. + +``` +kubectl-dba data insert mongodb [flags] +``` + +### Examples + +``` +kubectl dba data insert mg -n demo mg-rs --rows 500 +``` + +### Options + +``` + -h, --help help for mongodb + -r, --rows int number of rows to insert (default 100) +``` + +### 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/runner/.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 + --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 Password for basic authentication to the API server + --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 + --username string Username for basic authentication to the API server +``` + +### SEE ALSO + +* [kubectl-dba data insert](/docs/reference/cli/kubectl-dba_data_insert.md) - Insert random data in a database + diff --git a/docs/reference/cli/kubectl-dba_data_insert_mysql.md b/docs/reference/cli/kubectl-dba_data_insert_mysql.md index dd03c5ea67..9f3306667f 100644 --- a/docs/reference/cli/kubectl-dba_data_insert_mysql.md +++ b/docs/reference/cli/kubectl-dba_data_insert_mysql.md @@ -30,7 +30,7 @@ kubectl dba insert mysql -n demo sample-mysql --rows 1000 ``` -h, --help help for mysql - -r, --rows int rows in (default 10) + -r, --rows int number of rows to insert (default 100) ``` ### Options inherited from parent commands diff --git a/docs/reference/cli/kubectl-dba_data_insert_postgres.md b/docs/reference/cli/kubectl-dba_data_insert_postgres.md index d4e747a912..b44d523075 100644 --- a/docs/reference/cli/kubectl-dba_data_insert_postgres.md +++ b/docs/reference/cli/kubectl-dba_data_insert_postgres.md @@ -30,7 +30,7 @@ kubectl dba insert postgres -n demo sample-postgres --rows 500 ``` -h, --help help for postgres - -r, --rows int rows in (default 10) + -r, --rows int number of rows to insert (default 100) ``` ### Options inherited from parent commands diff --git a/docs/reference/cli/kubectl-dba_data_insert_redis.md b/docs/reference/cli/kubectl-dba_data_insert_redis.md index f3368024af..bfdf657aae 100644 --- a/docs/reference/cli/kubectl-dba_data_insert_redis.md +++ b/docs/reference/cli/kubectl-dba_data_insert_redis.md @@ -30,7 +30,7 @@ kubectl dba data insert redis -n demo sample-redis --rows 500 ``` -h, --help help for redis - -r, --rows int rows in (default 10) + -r, --rows int number of rows to insert (default 100) ``` ### Options inherited from parent commands diff --git a/docs/reference/cli/kubectl-dba_data_verify.md b/docs/reference/cli/kubectl-dba_data_verify.md index b5354a69db..c905fadcc3 100644 --- a/docs/reference/cli/kubectl-dba_data_verify.md +++ b/docs/reference/cli/kubectl-dba_data_verify.md @@ -74,6 +74,7 @@ kubectl-dba data verify * [kubectl-dba data](/docs/reference/cli/kubectl-dba_data.md) - Insert, Drop or Verify data in a database * [kubectl-dba data verify elasticsearch](/docs/reference/cli/kubectl-dba_data_verify_elasticsearch.md) - Verify rows in a elasticsearch database * [kubectl-dba data verify mariadb](/docs/reference/cli/kubectl-dba_data_verify_mariadb.md) - Verify rows in a MariaDB database +* [kubectl-dba data verify mongodb](/docs/reference/cli/kubectl-dba_data_verify_mongodb.md) - Verify data to a mongodb resource * [kubectl-dba data verify mysql](/docs/reference/cli/kubectl-dba_data_verify_mysql.md) - Verify rows in a MySQL database * [kubectl-dba data verify postgres](/docs/reference/cli/kubectl-dba_data_verify_postgres.md) - Verify rows in a postgres database * [kubectl-dba data verify redis](/docs/reference/cli/kubectl-dba_data_verify_redis.md) - Verify rows in a redis database diff --git a/docs/reference/cli/kubectl-dba_data_verify_elasticsearch.md b/docs/reference/cli/kubectl-dba_data_verify_elasticsearch.md index 8d1e13c261..0ddf3f9763 100644 --- a/docs/reference/cli/kubectl-dba_data_verify_elasticsearch.md +++ b/docs/reference/cli/kubectl-dba_data_verify_elasticsearch.md @@ -14,7 +14,7 @@ Verify rows in a elasticsearch database ### Synopsis -Use this cmd to verify data in a elasticsearc object +Use this cmd to verify data in a elasticsearch object ``` kubectl-dba data verify elasticsearch [flags] @@ -30,7 +30,7 @@ kubectl dba verify -n demo es es-quickstart --rows 1000 ``` -h, --help help for elasticsearch - -r, --rows int rows in (default 10) + -r, --rows int number of rows to verify (default 100) ``` ### Options inherited from parent commands diff --git a/docs/reference/cli/kubectl-dba_data_verify_mariadb.md b/docs/reference/cli/kubectl-dba_data_verify_mariadb.md index f306328ccc..2e2635cd13 100644 --- a/docs/reference/cli/kubectl-dba_data_verify_mariadb.md +++ b/docs/reference/cli/kubectl-dba_data_verify_mariadb.md @@ -30,7 +30,7 @@ kubectl dba verify mariadb -n demo sample-mariadb --rows 1000 ``` -h, --help help for mariadb - -r, --rows int rows in (default 10) + -r, --rows int number of rows to verify (default 100) ``` ### Options inherited from parent commands diff --git a/docs/reference/cli/kubectl-dba_data_verify_mongodb.md b/docs/reference/cli/kubectl-dba_data_verify_mongodb.md new file mode 100644 index 0000000000..dc9c68fb4f --- /dev/null +++ b/docs/reference/cli/kubectl-dba_data_verify_mongodb.md @@ -0,0 +1,64 @@ +--- +title: Kubectl-Dba Data Verify Mongodb +menu: + docs_{{ .version }}: + identifier: kubectl-dba-data-verify-mongodb + name: Kubectl-Dba Data Verify Mongodb + parent: reference-cli +menu_name: docs_{{ .version }} +section_menu_id: reference +--- +## kubectl-dba data verify mongodb + +Verify data to a mongodb resource + +### Synopsis + +Use this cmd to verify data existence in a mongodb object + +``` +kubectl-dba data verify mongodb [flags] +``` + +### Examples + +``` +kubectl dba data verify mg -n demo mg-rs --rows 500 +``` + +### Options + +``` + -h, --help help for mongodb + -r, --rows int number of rows to verify (default 100) +``` + +### 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/runner/.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 + --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 Password for basic authentication to the API server + --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 + --username string Username for basic authentication to the API server +``` + +### SEE ALSO + +* [kubectl-dba data verify](/docs/reference/cli/kubectl-dba_data_verify.md) - Verify data in a database + diff --git a/docs/reference/cli/kubectl-dba_data_verify_mysql.md b/docs/reference/cli/kubectl-dba_data_verify_mysql.md index 7d6861695d..bf87d7ae21 100644 --- a/docs/reference/cli/kubectl-dba_data_verify_mysql.md +++ b/docs/reference/cli/kubectl-dba_data_verify_mysql.md @@ -30,7 +30,7 @@ kubectl dba verify mysql -n demo sample-mysql --rows 1000 ``` -h, --help help for mysql - -r, --rows int rows in (default 10) + -r, --rows int number of rows to verify (default 100) ``` ### Options inherited from parent commands diff --git a/docs/reference/cli/kubectl-dba_data_verify_postgres.md b/docs/reference/cli/kubectl-dba_data_verify_postgres.md index a6fa404632..526784e408 100644 --- a/docs/reference/cli/kubectl-dba_data_verify_postgres.md +++ b/docs/reference/cli/kubectl-dba_data_verify_postgres.md @@ -30,7 +30,7 @@ kubectl dba verify pg -n demo sample-postgres --rows 500 ``` -h, --help help for postgres - -r, --rows int rows in (default 10) + -r, --rows int number of rows to verify (default 100) ``` ### Options inherited from parent commands diff --git a/docs/reference/cli/kubectl-dba_data_verify_redis.md b/docs/reference/cli/kubectl-dba_data_verify_redis.md index 66ae348986..a6a915f9ed 100644 --- a/docs/reference/cli/kubectl-dba_data_verify_redis.md +++ b/docs/reference/cli/kubectl-dba_data_verify_redis.md @@ -30,7 +30,7 @@ kubectl dba data verify redis -n demo sample-redis --rows 500 ``` -h, --help help for redis - -r, --rows int rows in (default 10) + -r, --rows int number of rows to verify (default 100) ``` ### Options inherited from parent commands diff --git a/docs/reference/cli/kubectl-dba_remote-config.md b/docs/reference/cli/kubectl-dba_remote-config.md new file mode 100644 index 0000000000..a4ec023e6c --- /dev/null +++ b/docs/reference/cli/kubectl-dba_remote-config.md @@ -0,0 +1,65 @@ +--- +title: Kubectl-Dba Remote-Config +menu: + docs_{{ .version }}: + identifier: kubectl-dba-remote-config + name: Kubectl-Dba Remote-Config + parent: reference-cli +menu_name: docs_{{ .version }} +section_menu_id: reference +--- +## kubectl-dba remote-config + +generate appbinding , secrets for remote replica + +### Synopsis + +generate appbinding , secrets for remote replica + +``` +kubectl-dba remote-config [flags] +``` + +### Examples + +``` +kubectl dba remote-config mysql -n -u -p$ -d +``` + +### Options + +``` + -h, --help help for remote-config +``` + +### 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/runner/.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 + --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 Password for basic authentication to the API server + --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 + --username string Username for basic authentication to the API server +``` + +### SEE ALSO + +* [kubectl-dba](/docs/reference/cli/kubectl-dba.md) - kubectl plugin for KubeDB +* [kubectl-dba remote-config mysql](/docs/reference/cli/kubectl-dba_remote-config_mysql.md) - generate appbinding , secrets for remote replica +* [kubectl-dba remote-config postgres](/docs/reference/cli/kubectl-dba_remote-config_postgres.md) - generate appbinding , secrets for remote replica + diff --git a/docs/reference/cli/kubectl-dba_remote-config_mysql.md b/docs/reference/cli/kubectl-dba_remote-config_mysql.md new file mode 100644 index 0000000000..60dbab8a01 --- /dev/null +++ b/docs/reference/cli/kubectl-dba_remote-config_mysql.md @@ -0,0 +1,68 @@ +--- +title: Kubectl-Dba Remote-Config Mysql +menu: + docs_{{ .version }}: + identifier: kubectl-dba-remote-config-mysql + name: Kubectl-Dba Remote-Config Mysql + parent: reference-cli +menu_name: docs_{{ .version }} +section_menu_id: reference +--- +## kubectl-dba remote-config mysql + +generate appbinding , secrets for remote replica + +### Synopsis + +generate appbinding , secrets for remote replica + +``` +kubectl-dba remote-config mysql [flags] +``` + +### Examples + +``` +kubectl dba remote-config mysql -n -u -p$ -d + kubectl dba remote-config mysql -n -u -p$ -d + +``` + +### Options + +``` + -d, --dns string dns name for the remote replica (default "localhost") + -h, --help help for mysql + -n, --namespace string host namespace for the remote replica (default "default") + -p, --pass string password name for the remote replica (default "password") + -u, --user string user name for the remote replica (default "postgres") + -y, --yes permission for alter password for the remote replica +``` + +### 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/runner/.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 + --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 + --password string Password for basic authentication to the API server + --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 + --username string Username for basic authentication to the API server +``` + +### SEE ALSO + +* [kubectl-dba remote-config](/docs/reference/cli/kubectl-dba_remote-config.md) - generate appbinding , secrets for remote replica + diff --git a/docs/reference/cli/kubectl-dba_remote-config_postgres.md b/docs/reference/cli/kubectl-dba_remote-config_postgres.md new file mode 100644 index 0000000000..78625f9698 --- /dev/null +++ b/docs/reference/cli/kubectl-dba_remote-config_postgres.md @@ -0,0 +1,68 @@ +--- +title: Kubectl-Dba Remote-Config Postgres +menu: + docs_{{ .version }}: + identifier: kubectl-dba-remote-config-postgres + name: Kubectl-Dba Remote-Config Postgres + parent: reference-cli +menu_name: docs_{{ .version }} +section_menu_id: reference +--- +## kubectl-dba remote-config postgres + +generate appbinding , secrets for remote replica + +### Synopsis + +generate appbinding , secrets for remote replica + +``` +kubectl-dba remote-config postgres [flags] +``` + +### Examples + +``` +kubectl dba remote-config mysql -n -u -p$ -d + kubectl dba remote-config mysql -n -u -p$ -d + +``` + +### Options + +``` + -d, --dns string dns name for the remote replica (default "localhost") + -h, --help help for postgres + -n, --namespace string host namespace for the remote replica (default "default") + -p, --pass string password name for the remote replica (default "password") + -u, --user string user name for the remote replica (default "postgres") + -y, --yes permission for alter password for the remote replica +``` + +### 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/runner/.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 + --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 + --password string Password for basic authentication to the API server + --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 + --username string Username for basic authentication to the API server +``` + +### SEE ALSO + +* [kubectl-dba remote-config](/docs/reference/cli/kubectl-dba_remote-config.md) - generate appbinding , secrets for remote replica +