You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kyuubi.apache.org by ch...@apache.org on 2023/03/21 12:58:24 UTC
[kyuubi] branch branch-1.7 updated: [KYUUBI #4568] Make kyuubi-ctl doc enable variable 'release' automatic substitution
This is an automated email from the ASF dual-hosted git repository.
chengpan pushed a commit to branch branch-1.7
in repository https://gitbox.apache.org/repos/asf/kyuubi.git
The following commit(s) were added to refs/heads/branch-1.7 by this push:
new a88af02e5 [KYUUBI #4568] Make kyuubi-ctl doc enable variable 'release' automatic substitution
a88af02e5 is described below
commit a88af02e5137d667e0a825268db287e9dbf6da05
Author: Alex <zo...@kanzhun.com>
AuthorDate: Tue Mar 21 20:58:01 2023 +0800
[KYUUBI #4568] Make kyuubi-ctl doc enable variable 'release' automatic substitution
### _Why are the changes needed?_
Kyuubi-ctl doc kyuubi version not convert automatic. The version of doc is 1.8.0-SNAPSHOT, but kyuubi version is 1.6.0-SNAPSHOT.
<img width="1911" alt="image" src="https://user-images.githubusercontent.com/43542750/226536654-23a28284-76ef-4c03-bb47-24146a92a94f.png">
### _How was this patch tested?_
- [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible
- [x] Add screenshots for manual tests if appropriate
<img width="1920" alt="image" src="https://user-images.githubusercontent.com/43542750/226536803-08a6d89e-e6fd-4134-b438-052d87fdb0a3.png">
- [ ] [Run test](https://kyuubi.readthedocs.io/en/master/develop_tools/testing.html#running-tests) locally before make a pull request
Closes #4568 from Kiss736921/optimize_ctl_doc.
Closes #4568
eb10a9e3b [Alex] Update docs/tools/kyuubi-ctl.rst
2006a59b3 [Alex] Update docs/tools/kyuubi-ctl.rst
2501e119f [Alex] convert kyuubi-ctl.md to kyuubi-ctl.rst to enable variable 'release' automatic substitution
Lead-authored-by: Alex <zo...@kanzhun.com>
Co-authored-by: Alex <43...@users.noreply.github.com>
Signed-off-by: Cheng Pan <ch...@apache.org>
(cherry picked from commit e00f6b5bf45a461cb8a887c4944c205f2c16902e)
Signed-off-by: Cheng Pan <ch...@apache.org>
---
docs/tools/kyuubi-ctl.md | 183 ---------------------------------------
docs/tools/kyuubi-ctl.rst | 213 ++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 213 insertions(+), 183 deletions(-)
diff --git a/docs/tools/kyuubi-ctl.md b/docs/tools/kyuubi-ctl.md
deleted file mode 100644
index aae67584e..000000000
--- a/docs/tools/kyuubi-ctl.md
+++ /dev/null
@@ -1,183 +0,0 @@
-<!--
-- Licensed to the Apache Software Foundation (ASF) under one or more
-- contributor license agreements. See the NOTICE file distributed with
-- this work for additional information regarding copyright ownership.
-- The ASF licenses this file to You under the Apache License, Version 2.0
-- (the "License"); you may not use this file except in compliance with
-- the License. You may obtain a copy of the License at
--
-- http://www.apache.org/licenses/LICENSE-2.0
--
-- Unless required by applicable law or agreed to in writing, software
-- distributed under the License is distributed on an "AS IS" BASIS,
-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-- See the License for the specific language governing permissions and
-- limitations under the License.
--->
-
-# Managing kyuubi servers and engines Tool
-
-## Usage
-
-```shell
-bin/kyuubi-ctl --help
-```
-
-Output
-
-```shell
-kyuubi 1.6.0-SNAPSHOT
-Usage: kyuubi-ctl [create|get|delete|list] [options]
-
- -zk, --zk-quorum <value>
- The connection string for the zookeeper ensemble, using zk quorum manually.
- -n, --namespace <value> The namespace, using kyuubi-defaults/conf if absent.
- -s, --host <value> Hostname or IP address of a service.
- -p, --port <value> Listening port of a service.
- -v, --version <value> Using the compiled KYUUBI_VERSION default, change it if the active service is running in another.
- -b, --verbose Print additional debug output.
-
-Command: create [server]
-
-Command: create server
- Expose Kyuubi server instance to another domain.
-
-Command: get [server|engine] [options]
- Get the service/engine node info, host and port needed.
-Command: get server
- Get Kyuubi server info of domain
-Command: get engine
- Get Kyuubi engine info belong to a user.
- -u, --user <value> The user name this engine belong to.
- -et, --engine-type <value>
- The engine type this engine belong to.
- -es, --engine-subdomain <value>
- The engine subdomain this engine belong to.
- -esl, --engine-share-level <value>
- The engine share level this engine belong to.
-
-Command: delete [server|engine] [options]
- Delete the specified service/engine node, host and port needed.
-Command: delete server
- Delete the specified service node for a domain
-Command: delete engine
- Delete the specified engine node for user.
- -u, --user <value> The user name this engine belong to.
- -et, --engine-type <value>
- The engine type this engine belong to.
- -es, --engine-subdomain <value>
- The engine subdomain this engine belong to.
- -esl, --engine-share-level <value>
- The engine share level this engine belong to.
-
-Command: list [server|engine] [options]
- List all the service/engine nodes for a particular domain.
-Command: list server
- List all the service nodes for a particular domain
-Command: list engine
- List all the engine nodes for a user
- -u, --user <value> The user name this engine belong to.
- -et, --engine-type <value>
- The engine type this engine belong to.
- -es, --engine-subdomain <value>
- The engine subdomain this engine belong to.
- -esl, --engine-share-level <value>
- The engine share level this engine belong to.
-
- -h, --help Show help message and exit.
-```
-
-## Manage kyuubi servers
-
-You can specify the zookeeper address(`--zk-quorum`) and namespace(`--namespace`), version(`--version`) parameters to query a specific kyuubi server cluster.
-
-### List server
-
-List all the service nodes for a particular domain.
-
-```shell
-bin/kyuubi-ctl list server
-```
-
-### Create server
-
-Expose Kyuubi server instance to another domain.
-
-First read `kyuubi.ha.zookeeper.namespace` in `conf/kyuubi-defaults.conf`, if there are server instances under this namespace, register them in the new namespace specified by the `--namespace` parameter.
-
-```shell
-bin/kyuubi-ctl create server --namespace XXX
-```
-
-### Get server
-
-Get Kyuubi server info of domain.
-
-```shell
-bin/kyuubi-ctl get server --host XXX --port YYY
-```
-
-### Delete server
-
-Delete the specified service node for a domain.
-
-After the server node is deleted, the kyuubi server stops opening new sessions and waits for all currently open sessions to be closed before the process exits.
-
-```shell
-bin/kyuubi-ctl delete server --host XXX --port YYY
-```
-
-## Manage kyuubi engines
-
-You can also specify the engine type(`--engine-type`), engine share level subdomain(`--engine-subdomain`) and engine share level(`--engine-share-level`).
-
-If not specified, the configuration item `kyuubi.engine.type` of `kyuubi-defaults.conf` read, the default value is `SPARK_SQL`, `kyuubi.engine.share.level.subdomain`, the default value is `default`, `kyuubi.engine.share.level`, the default value is `USER`.
-
-If the engine pool mode is enabled through `kyuubi.engine.pool.size`, the subdomain consists of `kyuubi.engine.pool.name` and a number below size, e.g. `engine-pool-0` .
-
-`--engine-share-level` supports the following enum values.
-* CONNECTION
-
-The engine Ref Id (UUID) must be specified via `--engine-subdomain`.
-* USER:
-
-Default Value.
-* GROUP:
-
-The `--user` parameter is the group name corresponding to the user.
-* SERVER:
-
-The `--user` parameter is the user who started the kyuubi server.
-
-### List engine
-
-List all the engine nodes for a user.
-
-```shell
-bin/kyuubi-ctl list engine --user AAA
-```
-
-The management share level is SERVER, the user who starts the kyuubi server is A, the engine is TRINO, and the subdomain is adhoc.
-
-```shell
-bin/kyuubi-ctl list engine --user A --engine-type TRINO --engine-subdomain adhoc --engine-share-level SERVER
-```
-
-### Get engine
-
-Get Kyuubi engine info belong to a user.
-
-```shell
-bin/kyuubi-ctl get engine --user AAA --host XXX --port YYY
-```
-
-### Delete engine
-
-Delete the specified engine node for user.
-
-After the engine node is deleted, the kyuubi engine stops opening new sessions and waits for all currently open sessions to be closed before the process exits.
-
-```shell
-bin/kyuubi-ctl delete engine --user AAA --host XXX --port YYY
-```
-
diff --git a/docs/tools/kyuubi-ctl.rst b/docs/tools/kyuubi-ctl.rst
new file mode 100644
index 000000000..4a9308fed
--- /dev/null
+++ b/docs/tools/kyuubi-ctl.rst
@@ -0,0 +1,213 @@
+.. Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+.. http://www.apache.org/licenses/LICENSE-2.0
+
+.. Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+Administrator CLI
+=================
+
+.. _usage:
+
+Usage
+-----
+.. code-block:: bash
+
+ bin/kyuubi-ctl --help
+
+Output
+
+.. parsed-literal::
+
+ kyuubi |release|
+ Usage: kyuubi-ctl [create|get|delete|list] [options]
+
+ -zk, --zk-quorum <value>
+ The connection string for the zookeeper ensemble, using zk quorum manually.
+ -n, --namespace <value> The namespace, using kyuubi-defaults/conf if absent.
+ -s, --host <value> Hostname or IP address of a service.
+ -p, --port <value> Listening port of a service.
+ -v, --version <value> Using the compiled KYUUBI_VERSION default, change it if the active service is running in another.
+ -b, --verbose Print additional debug output.
+
+ Command: create [server]
+
+ Command: create server
+ Expose Kyuubi server instance to another domain.
+
+ Command: get [server|engine] [options]
+ Get the service/engine node info, host and port needed.
+ Command: get server
+ Get Kyuubi server info of domain
+ Command: get engine
+ Get Kyuubi engine info belong to a user.
+ -u, --user <value> The user name this engine belong to.
+ -et, --engine-type <value>
+ The engine type this engine belong to.
+ -es, --engine-subdomain <value>
+ The engine subdomain this engine belong to.
+ -esl, --engine-share-level <value>
+ The engine share level this engine belong to.
+
+ Command: delete [server|engine] [options]
+ Delete the specified service/engine node, host and port needed.
+ Command: delete server
+ Delete the specified service node for a domain
+ Command: delete engine
+ Delete the specified engine node for user.
+ -u, --user <value> The user name this engine belong to.
+ -et, --engine-type <value>
+ The engine type this engine belong to.
+ -es, --engine-subdomain <value>
+ The engine subdomain this engine belong to.
+ -esl, --engine-share-level <value>
+ The engine share level this engine belong to.
+
+ Command: list [server|engine] [options]
+ List all the service/engine nodes for a particular domain.
+ Command: list server
+ List all the service nodes for a particular domain
+ Command: list engine
+ List all the engine nodes for a user
+ -u, --user <value> The user name this engine belong to.
+ -et, --engine-type <value>
+ The engine type this engine belong to.
+ -es, --engine-subdomain <value>
+ The engine subdomain this engine belong to.
+ -esl, --engine-share-level <value>
+ The engine share level this engine belong to.
+
+ -h, --help Show help message and exit.
+
+.. _manage_kyuubi_servers:
+
+Manage kyuubi servers
+---------------------
+
+You can specify the zookeeper address(``--zk-quorum``) and namespace(``--namespace``), version(``--version``) parameters to query a specific kyuubi server cluster.
+
+.. _list_servers:
+
+List server
+***********
+
+List all the service nodes for a particular domain.
+
+.. code-block:: bash
+
+ bin/kyuubi-ctl list server
+
+.. _create_servers:
+
+Create server
+***********
+Expose Kyuubi server instance to another domain.
+
+First read ``kyuubi.ha.zookeeper.namespace`` in ``conf/kyuubi-defaults.conf``, if there are server instances under this namespace, register them in the new namespace specified by the ``--namespace`` parameter.
+
+.. code-block:: bash
+
+ bin/kyuubi-ctl create server --namespace XXX
+
+.. _get_servers:
+
+Get server
+***********
+
+Get Kyuubi server info of domain.
+
+.. code-block:: bash
+
+ bin/kyuubi-ctl get server --host XXX --port YYY
+
+.. _delete_servers:
+
+Delete server
+***********
+
+Delete the specified service node for a domain.
+
+After the server node is deleted, the kyuubi server stops opening new sessions and waits for all currently open sessions to be closed before the process exits.
+
+.. code-block:: bash
+
+ bin/kyuubi-ctl delete server --host XXX --port YYY
+
+.. _manage_kyuubi_engines:
+
+Manage kyuubi engines
+---------------------
+
+You can also specify the engine type(``--engine-type``), engine share level subdomain(``--engine-subdomain``) and engine share level(``--engine-share-level``).
+
+If not specified, the configuration item ``kyuubi.engine.type`` of ``kyuubi-defaults.conf`` read, the default value is ``SPARK_SQL``, ``kyuubi.engine.share.level.subdomain``, the default value is ``default``, ``kyuubi.engine.share.level``, the default value is ``USER``.
+
+If the engine pool mode is enabled through ``kyuubi.engine.pool.size``, the subdomain consists of ``kyuubi.engine.pool.name`` and a number below size, e.g. ``engine-pool-0`` .
+
+``--engine-share-level`` supports the following enum values.
+
+- CONNECTION
+
+The engine Ref Id (UUID) must be specified via ``--engine-subdomain``.
+
+- USER:
+
+Default Value.
+
+- GROUP:
+
+The ``--user`` parameter is the group name corresponding to the user.
+
+- SERVER:
+
+The ``--user`` parameter is the user who started the kyuubi server.
+
+.. _list_engines:
+
+List engine
+***********
+
+List all the engine nodes for a user.
+
+.. code-block:: bash
+
+ bin/kyuubi-ctl list engine --user AAA
+
+The management share level is SERVER, the user who starts the kyuubi server is A, the engine is TRINO, and the subdomain is adhoc.
+
+.. code-block:: bash
+
+ bin/kyuubi-ctl list engine --user A --engine-type TRINO --engine-subdomain adhoc --engine-share-level SERVER
+
+.. _get_engines:
+
+Get engine
+***********
+
+Get Kyuubi engine info belong to a user.
+
+.. code-block:: bash
+
+ bin/kyuubi-ctl get engine --user AAA --host XXX --port YYY
+
+.. _delete_engines:
+
+Delete engine
+*************
+
+Delete the specified engine node for user.
+
+After the engine node is deleted, the kyuubi engine stops opening new sessions and waits for all currently open sessions to be closed before the process exits.
+
+.. code-block:: bash
+
+ bin/kyuubi-ctl delete engine --user AAA --host XXX --port YYY
\ No newline at end of file