This is an automated email from the ASF dual-hosted git repository.
ulyssesyou pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-kyuubi.git
The following commit(s) were added to refs/heads/master by this push:
new 12416a783 [KYUUBI #2345] [DOC] Hot Upgrade Kyuubi Server
12416a783 is described below
commit 12416a783149d9e0b6e4082592c9e10590745e4d
Author: ulysses-you <[email protected]>
AuthorDate: Wed Apr 13 18:06:51 2022 +0800
[KYUUBI #2345] [DOC] Hot Upgrade Kyuubi Server
### _Why are the changes needed?_
Help user upgrade easily.
### _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
Closes #2345 from ulysses-you/hot-upgrade.
Closes #2345
a5898711 [ulysses-you] typo
84bdf4bc [ulysses-you] address comment
e32fd3dc [ulysses-you] enrich
3c92545c [ulysses-you] hot-upgrade
Authored-by: ulysses-you <[email protected]>
Signed-off-by: ulysses-you <[email protected]>
---
docs/deployment/high_availability_guide.md | 29 +++++++++++++++++++++++++++++
1 file changed, 29 insertions(+)
diff --git a/docs/deployment/high_availability_guide.md
b/docs/deployment/high_availability_guide.md
index ff9922551..868d7dfd2 100644
--- a/docs/deployment/high_availability_guide.md
+++ b/docs/deployment/high_availability_guide.md
@@ -82,3 +82,32 @@ For example,
```shell
bin/beeline -u
'jdbc:hive2://10.242.189.214:2181/;serviceDiscoveryMode=zooKeeper;zooKeeperNamespace=kyuubi'
-n kentyao
```
+
+## How to Hot Upgrade Kyuubi Server
+
+Kyuubi supports hot upgrade one of server in a HA cluster which is transparent
to users.
+
+- If you have specified a custom port for Kyuubi server
+
+ For example, the Kyuubi server started at host `kyuubi.host` with port
`10009`, you can run the following cmd using `bin/kyuubi-ctl`:
+
+ ```shell
+ ./bin/kyuubi-ctl delete server --host "kyuubi.host" --port "10009"
+ ```
+
+ Kyuubi server will stop until all session closed, and then you can start a
new Kyuubi server.
+
+- If you use a random port for Kyuubi server
+
+ You can just start the new Kyuubi Server, then runing cmd using
`bin/kyuubi-ctl`:
+
+ ```shell
+ ./bin/kyuubi-ctl delete server --host "kyuubi.host" --port
"${PORT_FPR_OLD_KYUUBI_SERVER}"
+ ```
+
+ The `${PORT_FPR_OLD_KYUUBI_SERVER}` can be found by:
+
+ ```shell
+ grep "server.KyuubiThriftBinaryFrontendService: Starting and exposing JDBC
connection at" logs/kyuubi-*.out
+ ```
+ Note that, you do not need to care when the old Kyuubi server actually
stopped since the new coming session are routed to the new Kyuubi server and
others.
