[GitHub] [incubator-kyuubi] yaooqinn commented on a diff in pull request #3066: [KYUUBI #3045][FOLLOWUP] Correct the common options and add docs for kyuubi-adminctl

[GitBox <gi...@apache.org>]

yaooqinn commented on code in PR #3066:
URL: https://github.com/apache/incubator-kyuubi/pull/3066#discussion_r920793114


##########
docs/tools/kyuubi-adminctl.md:
##########
@@ -0,0 +1,55 @@
+<!--
+ - 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.
+ -->
+
+
+# Administer kyuubi server Tool
+
+## Usage
+```shell
+bin/kyuubi-adminctl --help
+```
+Output
+```shell
+kyuubi 1.6.0-SNAPSHOT
+Usage: kyuubi-adminctl [refresh] [options]
+
+  -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.
+  --hostUrl <value>        Host url for rest api.
+  --authSchema <value>     Auth schema for rest api, valid values are basic, spnego.
+  --username <value>       Username for basic authentication.
+  --password <value>       Password for basic authentication.
+  --spnegoHost <value>     Spnego host for spnego authentication.
+  --conf <value>           Kyuubi config property pair, formatted key=value.
+
+Command: refresh [config] <args>...
+        Refresh the resource.
+Command: refresh config [<configType>]
+        Refresh the config with specified type.
+  <configType>             The valid config type can be one of the following: hadoopConf.
+
+  -h, --help               Show help message and exit.
+```

Review Comment:
   we are improving all the docs



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@kyuubi.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@kyuubi.apache.org
For additional commands, e-mail: notifications-help@kyuubi.apache.org