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 2022/12/19 16:14:17 UTC

[incubator-kyuubi] branch master updated: [KYUUBI #4005] Remove deprecated from description of kyuubi.frontend.bind.host

This is an automated email from the ASF dual-hosted git repository.

chengpan 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 6e5803cbf [KYUUBI #4005] Remove deprecated from description of kyuubi.frontend.bind.host
6e5803cbf is described below

commit 6e5803cbf52f51decff6fa0152eaeaf66ba7dd6e
Author: Cheng Pan <ch...@apache.org>
AuthorDate: Tue Dec 20 00:14:07 2022 +0800

    [KYUUBI #4005] Remove deprecated from description of kyuubi.frontend.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
    
    9c3b1277 [Cheng Pan] comments
    0ef140e4 [Cheng Pan] Remove deprecated from description of kyuubi.frontend.bind.host
    
    Authored-by: Cheng Pan <ch...@apache.org>
    Signed-off-by: Cheng Pan <ch...@apache.org>
---
 docs/deployment/settings.md                                            | 2 +-
 kyuubi-common/src/main/scala/org/apache/kyuubi/config/KyuubiConf.scala | 3 +--
 2 files changed, 2 insertions(+), 3 deletions(-)

diff --git a/docs/deployment/settings.md b/docs/deployment/settings.md
index 42afedf13..c12047443 100644
--- a/docs/deployment/settings.md
+++ b/docs/deployment/settings.md
@@ -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
diff --git a/kyuubi-common/src/main/scala/org/apache/kyuubi/config/KyuubiConf.scala b/kyuubi-common/src/main/scala/org/apache/kyuubi/config/KyuubiConf.scala
index c08ac5c54..c54a6a4cc 100644
--- a/kyuubi-common/src/main/scala/org/apache/kyuubi/config/KyuubiConf.scala
+++ b/kyuubi-common/src/main/scala/org/apache/kyuubi/config/KyuubiConf.scala
@@ -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