From 5d59cf1d6a0ab973286804690a2a0d4f2ac32b4a Mon Sep 17 00:00:00 2001 From: Cheng Pan Date: Fri, 29 Dec 2023 21:51:07 +0800 Subject: [PATCH] [KYUUBI #5867][FOLLOWUP] Fix generated configuration docs and typo MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit # :mag: Description ## Issue References ๐Ÿ”— This pull request is a follow-up of #5867, to fix generated configuration docs and typo to recover CI. ## Describe Your Solution ๐Ÿ”ง Regenerated docs by performing `dev/gen/gen_all_config_docs.sh` Address comment https://github.com/apache/kyuubi/pull/5868#discussion_r1438080698 ## Types of changes :bookmark: - [x] Bugfix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) ## Test Plan ๐Ÿงช Pass GA. --- # Checklist ๐Ÿ“ - [x] This patch was not authored or co-authored using [Generative Tooling](https://www.apache.org/legal/generative-tooling.html) **Be nice. Be informative.** Closes #5932 from pan3793/fix-docs. Closes #5867 93b8f97b0 [Cheng Pan] docs 0ad0d29f3 [Cheng Pan] typo Authored-by: Cheng Pan Signed-off-by: Cheng Pan --- docs/configuration/settings.md | 10 +++++----- .../org/apache/kyuubi/engine/hive/HiveSQLEngine.scala | 2 +- .../kyuubi/engine/deploy/yarn/ApplicationMaster.scala | 2 +- .../scala/org/apache/kyuubi/service/Serverable.scala | 2 +- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/configuration/settings.md b/docs/configuration/settings.md index 4e60ea52b4d..db6edbf2b1c 100644 --- a/docs/configuration/settings.md +++ b/docs/configuration/settings.md @@ -205,16 +205,16 @@ You can configure the Kyuubi properties in `$KYUUBI_HOME/conf/kyuubi-defaults.co | kyuubi.engine.user.isolated.spark.session | true | When set to false, if the engine is running in a group or server share level, all the JDBC/ODBC connections will be isolated against the user. Including the temporary views, function registries, SQL configuration, and the current database. Note that, it does not affect if the share level is connection or user. | boolean | 1.6.0 | | kyuubi.engine.user.isolated.spark.session.idle.interval | PT1M | The interval to check if the user-isolated Spark session is timeout. | duration | 1.6.0 | | kyuubi.engine.user.isolated.spark.session.idle.timeout | PT6H | If kyuubi.engine.user.isolated.spark.session is false, we will release the Spark session if its corresponding user is inactive after this configured timeout. | duration | 1.6.0 | -| kyuubi.engine.yarn.app.name | (none) | The YARN app name when the engine deploy mode is YARN. | string | 1.9.0 | +| kyuubi.engine.yarn.app.name | <undefined> | The YARN app name when the engine deploy mode is YARN. | string | 1.9.0 | | kyuubi.engine.yarn.cores | 1 | kyuubi engine container core number when the engine deploy mode is YARN. | int | 1.9.0 | -| kyuubi.engine.yarn.java.options | (none) | The extra Java options for the AM when the engine deploy mode is YARN. | string | 1.9.0 | +| kyuubi.engine.yarn.java.options | <undefined> | The extra Java options for the AM when the engine deploy mode is YARN. | string | 1.9.0 | | kyuubi.engine.yarn.memory | 1024 | kyuubi engine container memory in mb when the engine deploy mode is YARN. | int | 1.9.0 | -| kyuubi.engine.yarn.priority | (none) | kyuubi engine yarn priority when the engine deploy mode is YARN. | int | 1.9.0 | +| kyuubi.engine.yarn.priority | <undefined> | kyuubi engine yarn priority when the engine deploy mode is YARN. | int | 1.9.0 | | kyuubi.engine.yarn.queue | default | kyuubi engine yarn queue when the engine deploy mode is YARN. | string | 1.9.0 | | kyuubi.engine.yarn.report.interval | PT1S | Interval between reports of the current engine on yarn app status. | duration | 1.9.0 | -| kyuubi.engine.yarn.stagingDir | (none) | Staging directory used while submitting kyuubi engine to YARN, It should be a absolute path in HDFS. | string | 1.9.0 | +| kyuubi.engine.yarn.stagingDir | <undefined> | Staging directory used while submitting kyuubi engine to YARN, It should be a absolute path in HDFS. | string | 1.9.0 | | kyuubi.engine.yarn.submit.timeout | PT30S | The engine submit timeout for YARN application. | duration | 1.7.2 | -| kyuubi.engine.yarn.tags | (none) | kyuubi engine yarn tags when the engine deploy mode is YARN. | seq | 1.9.0 | +| kyuubi.engine.yarn.tags | <undefined> | kyuubi engine yarn tags when the engine deploy mode is YARN. | seq | 1.9.0 | ### Event diff --git a/externals/kyuubi-hive-sql-engine/src/main/scala/org/apache/kyuubi/engine/hive/HiveSQLEngine.scala b/externals/kyuubi-hive-sql-engine/src/main/scala/org/apache/kyuubi/engine/hive/HiveSQLEngine.scala index c489027f432..4e0787039bc 100644 --- a/externals/kyuubi-hive-sql-engine/src/main/scala/org/apache/kyuubi/engine/hive/HiveSQLEngine.scala +++ b/externals/kyuubi-hive-sql-engine/src/main/scala/org/apache/kyuubi/engine/hive/HiveSQLEngine.scala @@ -46,7 +46,7 @@ class HiveSQLEngine extends Serverable("HiveSQLEngine") { // Start engine self-terminating checker after all services are ready and it can be reached by // all servers in engine spaces. backendService.sessionManager.startTerminatingChecker(() => { - selfExist = true + selfExited = true stop() }) } diff --git a/kyuubi-common/src/main/scala/org/apache/kyuubi/engine/deploy/yarn/ApplicationMaster.scala b/kyuubi-common/src/main/scala/org/apache/kyuubi/engine/deploy/yarn/ApplicationMaster.scala index fe6dbbdcfd9..3e396beb070 100644 --- a/kyuubi-common/src/main/scala/org/apache/kyuubi/engine/deploy/yarn/ApplicationMaster.scala +++ b/kyuubi-common/src/main/scala/org/apache/kyuubi/engine/deploy/yarn/ApplicationMaster.scala @@ -60,7 +60,7 @@ object ApplicationMaster extends Logging { yarnConf = KyuubiHadoopUtils.newYarnConfiguration(kyuubiConf) Utils.addShutdownHook(() => { if (!unregistered) { - if (currentEngine != null && currentEngine.selfExist) { + if (currentEngine != null && currentEngine.selfExited) { finalMsg = "Kyuubi Application Master is shutting down." finalStatus = FinalApplicationStatus.SUCCEEDED } else { diff --git a/kyuubi-common/src/main/scala/org/apache/kyuubi/service/Serverable.scala b/kyuubi-common/src/main/scala/org/apache/kyuubi/service/Serverable.scala index 84ec32b1528..2d75e7fc296 100644 --- a/kyuubi-common/src/main/scala/org/apache/kyuubi/service/Serverable.scala +++ b/kyuubi-common/src/main/scala/org/apache/kyuubi/service/Serverable.scala @@ -35,7 +35,7 @@ abstract class Serverable(name: String) extends CompositeService(name) { private val started = new AtomicBoolean(false) - var selfExist = false + var selfExited = false val backendService: AbstractBackendService