Skip to content

Commit

Permalink
[KYUUBI #4005] Remove deprecated from description of kyuubi.frontend.…
Browse files Browse the repository at this point in the history
…bind.host

### _Why are the changes needed?_

Unlike `kyuubi.frontend.bind.port`, which is deprecated and replaced by `kyuubi.frontend.thrift.binary.bind.port`, `kyuubi.frontend.bind.host` is still encouraged to use, and it can be overwritten by `kyuubi.frontend.<protocol>.bind.host`, e.g. `kyuubi.frontend.thrift.binary.bind.host`, `kyuubi.frontend.thrift.http.bind.host`, `kyuubi.frontend.rest.bind.host`, `kyuubi.frontend.mysql.bind.host`

### _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

- [x] [Run test](https://kyuubi.apache.org/docs/latest/develop_tools/testing.html#running-tests) locally before make a pull request

Closes #4005 from pan3793/doc.

Closes #4005

9c3b127 [Cheng Pan] comments
0ef140e [Cheng Pan] Remove deprecated from description of kyuubi.frontend.bind.host

Authored-by: Cheng Pan <chengpan@apache.org>
Signed-off-by: Cheng Pan <chengpan@apache.org>
  • Loading branch information
pan3793 committed Dec 19, 2022
1 parent 69a0c10 commit 6e5803c
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/deployment/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -286,7 +286,7 @@ kyuubi.event.async.pool.wait.queue.size|100|Size of the wait queue for the async
Key | Default | Meaning | Type | Since
--- | --- | --- | --- | ---
kyuubi.frontend.backoff.slot.length|PT0.1S|(deprecated) Time to back off during login to the thrift frontend service.|duration|1.0.0
kyuubi.frontend.bind.host|&lt;undefined&gt;|(deprecated) Hostname or IP of the machine on which to run the thrift frontend service via binary protocol.|string|1.0.0
kyuubi.frontend.bind.host|&lt;undefined&gt;|Hostname or IP of the machine on which to run the frontend services.|string|1.0.0
kyuubi.frontend.bind.port|10009|(deprecated) Port of the machine on which to run the thrift frontend service via binary protocol.|int|1.0.0
kyuubi.frontend.connection.url.use.hostname|true|When true, frontend services prefer hostname, otherwise, ip address. Note that, the default value is set to `false` when engine running on Kubernetes to prevent potential network issue.|boolean|1.5.0
kyuubi.frontend.login.timeout|PT20S|(deprecated) Timeout for Thrift clients during login to the thrift frontend service.|duration|1.0.0
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -385,8 +385,7 @@ object KyuubiConf {
.createWithDefault(Seq(FrontendProtocols.THRIFT_BINARY.toString))

val FRONTEND_BIND_HOST: OptionalConfigEntry[String] = buildConf("kyuubi.frontend.bind.host")
.doc("(deprecated) Hostname or IP of the machine on which to run the thrift frontend service " +
"via binary protocol.")
.doc("Hostname or IP of the machine on which to run the frontend services.")
.version("1.0.0")
.serverOnly
.stringConf
Expand Down

0 comments on commit 6e5803c

Please sign in to comment.