You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@kyuubi.apache.org by GitBox <gi...@apache.org> on 2022/07/14 05:55:35 UTC
[GitHub] [incubator-kyuubi] turboFei opened a new pull request, #3066: [KYUUBI #3045][FOLLOWUP] Add docs for kyuubi-adminctl
turboFei opened a new pull request, #3066:
URL: https://github.com/apache/incubator-kyuubi/pull/3066
<!--
Thanks for sending a pull request!
Here are some tips for you:
1. If this is your first time, please read our contributor guidelines: https://kyuubi.readthedocs.io/en/latest/community/contributions.html
2. If the PR is related to an issue in https://github.com/apache/incubator-kyuubi/issues, add '[KYUUBI #XXXX]' in your PR title, e.g., '[KYUUBI #XXXX] Your PR title ...'.
3. If the PR is unfinished, add '[WIP]' in your PR title, e.g., '[WIP][KYUUBI #XXXX] Your PR title ...'.
-->
### _Why are the changes needed?_
<!--
Please clarify why the changes are needed. For instance,
1. If you add a feature, you can talk about the use case of it.
2. If you fix a bug, you can clarify why it is a bug.
-->
### _How was this patch tested?_
- [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible
- [ ] Add screenshots for manual tests if appropriate
- [ ] [Run test](https://kyuubi.apache.org/docs/latest/develop_tools/testing.html#running-tests) locally before make a pull request
--
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
[GitHub] [incubator-kyuubi] yaooqinn commented on a diff in pull request #3066: [KYUUBI #3045][FOLLOWUP] Correct the common options and add docs for kyuubi-admin command
Posted by GitBox <gi...@apache.org>.
yaooqinn commented on code in PR #3066:
URL: https://github.com/apache/incubator-kyuubi/pull/3066#discussion_r920849238
##########
docs/tools/kyuubi-admin.md:
##########
@@ -0,0 +1,36 @@
+<!--
+ - 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
+
+The tool to administer the Kyuubi server based on admin resource rest api.
+You can specify the rest host url(`--hostUrl`), auth schema(`--authSchema`), spnego host(`--spnegoHost`) and so on for rest rpc call.
+
+## Usage
+```shell
+bin/kyuubi-admin --help
Review Comment:
can we show help hint for sub commands?
--
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
[GitHub] [incubator-kyuubi] yaooqinn commented on a diff in pull request #3066: [KYUUBI #3045][FOLLOWUP] Correct the common options and add docs for kyuubi-admin command
Posted by GitBox <gi...@apache.org>.
yaooqinn commented on code in PR #3066:
URL: https://github.com/apache/incubator-kyuubi/pull/3066#discussion_r920848275
##########
docs/tools/kyuubi-admin.md:
##########
@@ -0,0 +1,36 @@
+<!--
+ - 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
+
+The tool to administer the Kyuubi server based on admin resource rest api.
+You can specify the rest host url(`--hostUrl`), auth schema(`--authSchema`), spnego host(`--spnegoHost`) and so on for rest rpc call.
Review Comment:
```suggestion
Kyuubi administer tool(kyuubi-admin) provides administrators with some maintenance operations against a kyuubi server or cluster.
```
--
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
[GitHub] [incubator-kyuubi] yaooqinn commented on a diff in pull request #3066: [KYUUBI #3045][FOLLOWUP] Add docs for kyuubi-adminctl
Posted by GitBox <gi...@apache.org>.
yaooqinn commented on code in PR #3066:
URL: https://github.com/apache/incubator-kyuubi/pull/3066#discussion_r920785982
##########
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
+
Review Comment:
please describe what this tool is
--
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
[GitHub] [incubator-kyuubi] turboFei commented on a diff in pull request #3066: [KYUUBI #3045][FOLLOWUP] Correct the common options and add docs for kyuubi-adminctl
Posted by GitBox <gi...@apache.org>.
turboFei commented on code in PR #3066:
URL: https://github.com/apache/incubator-kyuubi/pull/3066#discussion_r920790894
##########
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:
It refers the docs of kyuubi-ctl.
--
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
[GitHub] [incubator-kyuubi] yaooqinn commented on a diff in pull request #3066: [KYUUBI #3045][FOLLOWUP] Add docs for kyuubi-adminctl
Posted by GitBox <gi...@apache.org>.
yaooqinn commented on code in PR #3066:
URL: https://github.com/apache/incubator-kyuubi/pull/3066#discussion_r920783472
##########
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:
remove these lines
--
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
[GitHub] [incubator-kyuubi] turboFei commented on a diff in pull request #3066: [KYUUBI #3045][FOLLOWUP] Correct the common options and add docs for kyuubi-adminctl
Posted by GitBox <gi...@apache.org>.
turboFei commented on code in PR #3066:
URL: https://github.com/apache/incubator-kyuubi/pull/3066#discussion_r920816232
##########
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:
removed.
--
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
[GitHub] [incubator-kyuubi] turboFei commented on a diff in pull request #3066: [KYUUBI #3045][FOLLOWUP] Correct the common options and add docs for kyuubi-adminctl
Posted by GitBox <gi...@apache.org>.
turboFei commented on code in PR #3066:
URL: https://github.com/apache/incubator-kyuubi/pull/3066#discussion_r920815108
##########
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
+
Review Comment:
> 1. kyuubi-admin looks better
It sounds good and does not conflicts with kyuubi-ctl.
We can refactor the kyuubi-ctl in long term.
--
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
[GitHub] [incubator-kyuubi] codecov-commenter commented on pull request #3066: [KYUUBI #3045][FOLLOWUP] Correct the common options and add docs for kyuubi-admin command
Posted by GitBox <gi...@apache.org>.
codecov-commenter commented on PR #3066:
URL: https://github.com/apache/incubator-kyuubi/pull/3066#issuecomment-1184139109
# [Codecov](https://codecov.io/gh/apache/incubator-kyuubi/pull/3066?src=pr&el=h1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation) Report
> Merging [#3066](https://codecov.io/gh/apache/incubator-kyuubi/pull/3066?src=pr&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation) (222b409) into [master](https://codecov.io/gh/apache/incubator-kyuubi/commit/a7d190dd7b92a5e28f6247fe91fdf3e4d7244973?el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation) (a7d190d) will **decrease** coverage by `0.25%`.
> The diff coverage is `91.66%`.
```diff
@@ Coverage Diff @@
## master #3066 +/- ##
============================================
- Coverage 51.57% 51.31% -0.26%
Complexity 6 6
============================================
Files 458 458
Lines 25254 25375 +121
Branches 3517 3540 +23
============================================
- Hits 13025 13022 -3
- Misses 10991 11110 +119
- Partials 1238 1243 +5
```
| [Impacted Files](https://codecov.io/gh/apache/incubator-kyuubi/pull/3066?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation) | Coverage Δ | |
|---|---|---|
| [...la/org/apache/kyuubi/ctl/ControlCliArguments.scala](https://codecov.io/gh/apache/incubator-kyuubi/pull/3066/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-a3l1dWJpLWN0bC9zcmMvbWFpbi9zY2FsYS9vcmcvYXBhY2hlL2t5dXViaS9jdGwvQ29udHJvbENsaUFyZ3VtZW50cy5zY2FsYQ==) | `32.50% <50.00%> (ø)` | |
| [...c/main/scala/org/apache/kyuubi/ctl/CliConfig.scala](https://codecov.io/gh/apache/incubator-kyuubi/pull/3066/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-a3l1dWJpLWN0bC9zcmMvbWFpbi9zY2FsYS9vcmcvYXBhY2hlL2t5dXViaS9jdGwvQ2xpQ29uZmlnLnNjYWxh) | `82.97% <100.00%> (ø)` | |
| [...main/scala/org/apache/kyuubi/ctl/CommandLine.scala](https://codecov.io/gh/apache/incubator-kyuubi/pull/3066/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-a3l1dWJpLWN0bC9zcmMvbWFpbi9zY2FsYS9vcmcvYXBhY2hlL2t5dXViaS9jdGwvQ29tbWFuZExpbmUuc2NhbGE=) | `98.71% <100.00%> (ø)` | |
| [...main/scala/org/apache/kyuubi/ctl/cmd/Command.scala](https://codecov.io/gh/apache/incubator-kyuubi/pull/3066/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-a3l1dWJpLWN0bC9zcmMvbWFpbi9zY2FsYS9vcmcvYXBhY2hlL2t5dXViaS9jdGwvY21kL0NvbW1hbmQuc2NhbGE=) | `80.00% <100.00%> (ø)` | |
| [...in/scala/org/apache/kyuubi/ctl/util/CtlUtils.scala](https://codecov.io/gh/apache/incubator-kyuubi/pull/3066/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-a3l1dWJpLWN0bC9zcmMvbWFpbi9zY2FsYS9vcmcvYXBhY2hlL2t5dXViaS9jdGwvdXRpbC9DdGxVdGlscy5zY2FsYQ==) | `86.66% <100.00%> (ø)` | |
| [...rg/apache/kyuubi/ctl/cmd/log/LogBatchCommand.scala](https://codecov.io/gh/apache/incubator-kyuubi/pull/3066/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-a3l1dWJpLWN0bC9zcmMvbWFpbi9zY2FsYS9vcmcvYXBhY2hlL2t5dXViaS9jdGwvY21kL2xvZy9Mb2dCYXRjaENvbW1hbmQuc2NhbGE=) | `80.00% <0.00%> (-2.00%)` | :arrow_down: |
| [...ain/scala/org/apache/kyuubi/engine/EngineRef.scala](https://codecov.io/gh/apache/incubator-kyuubi/pull/3066/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-a3l1dWJpLXNlcnZlci9zcmMvbWFpbi9zY2FsYS9vcmcvYXBhY2hlL2t5dXViaS9lbmdpbmUvRW5naW5lUmVmLnNjYWxh) | `75.23% <0.00%> (-0.96%)` | :arrow_down: |
| [...che/kyuubi/server/KyuubiTHttpFrontendService.scala](https://codecov.io/gh/apache/incubator-kyuubi/pull/3066/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-a3l1dWJpLXNlcnZlci9zcmMvbWFpbi9zY2FsYS9vcmcvYXBhY2hlL2t5dXViaS9zZXJ2ZXIvS3l1dWJpVEh0dHBGcm9udGVuZFNlcnZpY2Uuc2NhbGE=) | `63.97% <0.00%> (-0.74%)` | :arrow_down: |
| [...in/scala/org/apache/kyuubi/config/KyuubiConf.scala](https://codecov.io/gh/apache/incubator-kyuubi/pull/3066/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-a3l1dWJpLWNvbW1vbi9zcmMvbWFpbi9zY2FsYS9vcmcvYXBhY2hlL2t5dXViaS9jb25maWcvS3l1dWJpQ29uZi5zY2FsYQ==) | `97.25% <0.00%> (-0.10%)` | :arrow_down: |
| [...la/org/apache/kyuubi/ha/HighAvailabilityConf.scala](https://codecov.io/gh/apache/incubator-kyuubi/pull/3066/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-a3l1dWJpLWhhL3NyYy9tYWluL3NjYWxhL29yZy9hcGFjaGUva3l1dWJpL2hhL0hpZ2hBdmFpbGFiaWxpdHlDb25mLnNjYWxh) | `98.23% <0.00%> (ø)` | |
| ... and [6 more](https://codecov.io/gh/apache/incubator-kyuubi/pull/3066/diff?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation) | |
------
[Continue to review full report at Codecov](https://codecov.io/gh/apache/incubator-kyuubi/pull/3066?src=pr&el=continue&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation).
> **Legend** - [Click here to learn more](https://docs.codecov.io/docs/codecov-delta?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation)
> `Δ = absolute <relative> (impact)`, `ø = not affected`, `? = missing data`
> Powered by [Codecov](https://codecov.io/gh/apache/incubator-kyuubi/pull/3066?src=pr&el=footer&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation). Last update [a7d190d...222b409](https://codecov.io/gh/apache/incubator-kyuubi/pull/3066?src=pr&el=lastupdated&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation). Read the [comment docs](https://docs.codecov.io/docs/pull-request-comments?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation).
--
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
[GitHub] [incubator-kyuubi] yaooqinn commented on a diff in pull request #3066: [KYUUBI #3045][FOLLOWUP] Add docs for kyuubi-adminctl
Posted by GitBox <gi...@apache.org>.
yaooqinn commented on code in PR #3066:
URL: https://github.com/apache/incubator-kyuubi/pull/3066#discussion_r920785596
##########
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
Review Comment:
capitalize all or just the leading word
--
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
[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
Posted by 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
[GitHub] [incubator-kyuubi] yaooqinn commented on a diff in pull request #3066: [KYUUBI #3045][FOLLOWUP] Correct the common options and add docs for kyuubi-admin command
Posted by GitBox <gi...@apache.org>.
yaooqinn commented on code in PR #3066:
URL: https://github.com/apache/incubator-kyuubi/pull/3066#discussion_r920848958
##########
docs/tools/kyuubi-admin.md:
##########
@@ -0,0 +1,36 @@
+<!--
+ - 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
+
+The tool to administer the Kyuubi server based on admin resource rest api.
+You can specify the rest host url(`--hostUrl`), auth schema(`--authSchema`), spnego host(`--spnegoHost`) and so on for rest rpc call.
+
Review Comment:
```suggestion
## Installation
```
--
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
[GitHub] [incubator-kyuubi] turboFei commented on a diff in pull request #3066: [KYUUBI #3045][FOLLOWUP] Correct the common options and add docs for kyuubi-admin command
Posted by GitBox <gi...@apache.org>.
turboFei commented on code in PR #3066:
URL: https://github.com/apache/incubator-kyuubi/pull/3066#discussion_r921077638
##########
docs/tools/kyuubi-admin.md:
##########
@@ -0,0 +1,36 @@
+<!--
+ - 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
+
+The tool to administer the Kyuubi server based on admin resource rest api.
+You can specify the rest host url(`--hostUrl`), auth schema(`--authSchema`), spnego host(`--spnegoHost`) and so on for rest rpc call.
+
+## Usage
+```shell
+bin/kyuubi-admin --help
Review Comment:
it is not supported now, because the `--help` option is common for all commands, not for specified command.
--
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
[GitHub] [incubator-kyuubi] yaooqinn commented on a diff in pull request #3066: [KYUUBI #3045][FOLLOWUP] Correct the common options and add docs for kyuubi-admin command
Posted by GitBox <gi...@apache.org>.
yaooqinn commented on code in PR #3066:
URL: https://github.com/apache/incubator-kyuubi/pull/3066#discussion_r920844485
##########
docs/tools/kyuubi-admin.md:
##########
@@ -0,0 +1,36 @@
+<!--
+ - 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
Review Comment:
`Kyuubi Administer Tool`, as you plan to migrate operations with engines too.
--
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
[GitHub] [incubator-kyuubi] turboFei commented on a diff in pull request #3066: [KYUUBI #3045][FOLLOWUP] Correct the common options and add docs for kyuubi-adminctl
Posted by GitBox <gi...@apache.org>.
turboFei commented on code in PR #3066:
URL: https://github.com/apache/incubator-kyuubi/pull/3066#discussion_r920793505
##########
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
+
Review Comment:
can we move the server actions into kyuubi-adminctl later?
--
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
[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
Posted by GitBox <gi...@apache.org>.
yaooqinn commented on code in PR #3066:
URL: https://github.com/apache/incubator-kyuubi/pull/3066#discussion_r920795452
##########
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
+
Review Comment:
1. kyuubi-admin looks better
2. > can we move the server actions into kyuubi-adminctl later?
we can but better duplicate the functions and deprecate them in ctl first
--
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
[GitHub] [incubator-kyuubi] yaooqinn commented on a diff in pull request #3066: [KYUUBI #3045][FOLLOWUP] Correct the common options and add docs for kyuubi-admin command
Posted by GitBox <gi...@apache.org>.
yaooqinn commented on code in PR #3066:
URL: https://github.com/apache/incubator-kyuubi/pull/3066#discussion_r920936243
##########
docs/tools/kyuubi-admin.md:
##########
@@ -0,0 +1,36 @@
+<!--
+ - 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
+
+The tool to administer the Kyuubi server based on admin resource rest api.
+You can specify the rest host url(`--hostUrl`), auth schema(`--authSchema`), spnego host(`--spnegoHost`) and so on for rest rpc call.
+
+## Usage
+```shell
+bin/kyuubi-admin --help
Review Comment:
this is a question for the command, not the content you've written..
--
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
[GitHub] [incubator-kyuubi] turboFei commented on pull request #3066: [KYUUBI #3045][FOLLOWUP] Correct the common options and add docs for kyuubi-admin command
Posted by GitBox <gi...@apache.org>.
turboFei commented on PR #3066:
URL: https://github.com/apache/incubator-kyuubi/pull/3066#issuecomment-1184403777
<img width="858" alt="image" src="https://user-images.githubusercontent.com/6757692/178985238-f1730dc2-56b7-4483-9b15-e52a89e55d7b.png">
--
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
[GitHub] [incubator-kyuubi] turboFei commented on pull request #3066: [KYUUBI #3045][FOLLOWUP] Correct the common options and add docs for kyuubi-admin command
Posted by GitBox <gi...@apache.org>.
turboFei commented on PR #3066:
URL: https://github.com/apache/incubator-kyuubi/pull/3066#issuecomment-1184192269
--
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
[GitHub] [incubator-kyuubi] turboFei closed pull request #3066: [KYUUBI #3045][FOLLOWUP] Correct the common options and add docs for kyuubi-admin command
Posted by GitBox <gi...@apache.org>.
turboFei closed pull request #3066: [KYUUBI #3045][FOLLOWUP] Correct the common options and add docs for kyuubi-admin command
URL: https://github.com/apache/incubator-kyuubi/pull/3066
--
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
[GitHub] [incubator-kyuubi] turboFei commented on pull request #3066: [KYUUBI #3045][FOLLOWUP] Correct the common options and add docs for kyuubi-admin command
Posted by GitBox <gi...@apache.org>.
turboFei commented on PR #3066:
URL: https://github.com/apache/incubator-kyuubi/pull/3066#issuecomment-1185112826
thanks @yaooqinn merged to master
--
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
[GitHub] [incubator-kyuubi] yaooqinn commented on a diff in pull request #3066: [KYUUBI #3045][FOLLOWUP] Add docs for kyuubi-adminctl
Posted by GitBox <gi...@apache.org>.
yaooqinn commented on code in PR #3066:
URL: https://github.com/apache/incubator-kyuubi/pull/3066#discussion_r920786771
##########
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
+
Review Comment:
as I don't understand why refreshing config is admin behavior but creating/deleting a server is not.
--
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
[GitHub] [incubator-kyuubi] yaooqinn commented on a diff in pull request #3066: [KYUUBI #3045][FOLLOWUP] Correct the common options and add docs for kyuubi-admin command
Posted by GitBox <gi...@apache.org>.
yaooqinn commented on code in PR #3066:
URL: https://github.com/apache/incubator-kyuubi/pull/3066#discussion_r920934738
##########
docs/tools/kyuubi-admin.md:
##########
@@ -0,0 +1,63 @@
+<!--
+ - 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.
+ -->
+
+
+# Kyuubi Administer Tool
+
+Kyuubi administer tool(kyuubi-admin) provides administrators with some maintenance operations against a kyuubi server or cluster.
+
+## Installation
+To install kyuubi-admin, you need to unpack the tarball. For example,
+
+```bash
+tar zxf apache-kyuubi-1.6.0-incubating-bin.tgz
Review Comment:
```
tar -xzvf apache-kyuubi-|release|-bin.tgz
```
if you use .rst, the version filed can be replaced dynamically
--
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