diff --git a/charts/kyuubi/README.md b/charts/kyuubi/README.md index a1e5c4b62..dfec578dd 100644 --- a/charts/kyuubi/README.md +++ b/charts/kyuubi/README.md @@ -50,7 +50,7 @@ helm install --dry-run --debug --generate-name ../kyuubi ## Documentation -Configuration guide documentation for Kyuubi lives [on the website](https://kyuubi.readthedocs.io/en/master/deployment/settings.html#kyuubi-configurations). (Not just for Helm Chart) +Configuration guide documentation for Kyuubi lives [on the website](https://kyuubi.readthedocs.io/en/master/configuration/settings.html#kyuubi-configurations). (Not just for Helm Chart) ## Contributing diff --git a/charts/kyuubi/templates/_helpers.tpl b/charts/kyuubi/templates/_helpers.tpl index 4c9da32b9..502bf4646 100644 --- a/charts/kyuubi/templates/_helpers.tpl +++ b/charts/kyuubi/templates/_helpers.tpl @@ -17,7 +17,7 @@ {{/* A comma separated string of enabled frontend protocols, e.g. "REST,THRIFT_BINARY". -For details, see 'kyuubi.frontend.protocols': https://kyuubi.readthedocs.io/en/master/deployment/settings.html#frontend +For details, see 'kyuubi.frontend.protocols': https://kyuubi.readthedocs.io/en/master/configuration/settings.html#frontend */}} {{- define "kyuubi.frontend.protocols" -}} {{- $protocols := list }} diff --git a/charts/kyuubi/values.yaml b/charts/kyuubi/values.yaml index 940a7c80e..da4add0ed 100644 --- a/charts/kyuubi/values.yaml +++ b/charts/kyuubi/values.yaml @@ -121,7 +121,7 @@ kyuubiConfDir: /opt/kyuubi/conf # Kyuubi configurations files kyuubiConf: # The value (templated string) is used for kyuubi-env.sh file - # See example at conf/kyuubi-env.sh.template and https://kyuubi.readthedocs.io/en/master/deployment/settings.html#environments for more details + # See example at conf/kyuubi-env.sh.template and https://kyuubi.readthedocs.io/en/master/configuration/settings.html#environments for more details kyuubiEnv: ~ # kyuubiEnv: | # export JAVA_HOME=/usr/jdk64/jdk1.8.0_152 @@ -130,7 +130,7 @@ kyuubiConf: # export HIVE_HOME=/opt/hive # The value (templated string) is used for kyuubi-defaults.conf file - # See https://kyuubi.readthedocs.io/en/master/deployment/settings.html#kyuubi-configurations for more details + # See https://kyuubi.readthedocs.io/en/master/configuration/settings.html#kyuubi-configurations for more details kyuubiDefaults: ~ # kyuubiDefaults: | # kyuubi.authentication=NONE @@ -142,7 +142,7 @@ kyuubiConf: # kyuubi.ha.namespace=kyuubi # The value (templated string) is used for log4j2.xml file - # See example at conf/log4j2.xml.template https://kyuubi.readthedocs.io/en/master/deployment/settings.html#logging for more details + # See example at conf/log4j2.xml.template https://kyuubi.readthedocs.io/en/master/configuration/settings.html#logging for more details log4j2: ~ # Command to launch Kyuubi server (templated) diff --git a/conf/kyuubi-defaults.conf.template b/conf/kyuubi-defaults.conf.template index c93971d91..eef36ad10 100644 --- a/conf/kyuubi-defaults.conf.template +++ b/conf/kyuubi-defaults.conf.template @@ -33,4 +33,4 @@ # kyuubi.ha.namespace kyuubi # -# Details in https://kyuubi.readthedocs.io/en/master/deployment/settings.html +# Details in https://kyuubi.readthedocs.io/en/master/configuration/settings.html diff --git a/docker/kyuubi-configmap.yaml b/docker/kyuubi-configmap.yaml index 9b7993596..6a6d430ce 100644 --- a/docker/kyuubi-configmap.yaml +++ b/docker/kyuubi-configmap.yaml @@ -52,4 +52,4 @@ data: # kyuubi.frontend.bind.port 10009 # - # Details in https://kyuubi.readthedocs.io/en/master/deployment/settings.html + # Details in https://kyuubi.readthedocs.io/en/master/configuration/settings.html diff --git a/docs/client/rest/rest_api.md b/docs/client/rest/rest_api.md index bf4917e88..fc04857d0 100644 --- a/docs/client/rest/rest_api.md +++ b/docs/client/rest/rest_api.md @@ -449,7 +449,7 @@ Refresh the Hadoop configurations of the Kyuubi server. ### POST /admin/refresh/user_defaults_conf -Refresh the [user defaults configs](../../deployment/settings.html#user-defaults) with key in format in the form of `___{username}___.{config key}` from default property file. +Refresh the [user defaults configs](../../configuration/settings.html#user-defaults) with key in format in the form of `___{username}___.{config key}` from default property file. ### POST /admin/refresh/kubernetes_conf diff --git a/docs/deployment/settings.md b/docs/configuration/settings.md similarity index 99% rename from docs/deployment/settings.md rename to docs/configuration/settings.md index 7ce3c2d4b..77e1d6dee 100644 --- a/docs/deployment/settings.md +++ b/docs/configuration/settings.md @@ -16,7 +16,7 @@ --> -# Introduction to the Kyuubi Configurations System +# Configurations Kyuubi provides several ways to configure the system and corresponding engines. diff --git a/docs/deployment/index.rst b/docs/deployment/index.rst index ec3ece951..1b6bf8766 100644 --- a/docs/deployment/index.rst +++ b/docs/deployment/index.rst @@ -31,15 +31,6 @@ Basics high_availability_guide migration-guide -Configurations --------------- - -.. toctree:: - :maxdepth: 2 - :glob: - - settings - Engines ------- diff --git a/docs/index.rst b/docs/index.rst index 7f6e0a248..e86041ffc 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -179,6 +179,7 @@ What's Next :glob: quick_start/index + configuration/settings deployment/index Security monitor/index diff --git a/docs/security/authentication.rst b/docs/security/authentication.rst index f16a452c8..00bf368ff 100644 --- a/docs/security/authentication.rst +++ b/docs/security/authentication.rst @@ -43,4 +43,4 @@ The related configurations can be found at `Authentication Configurations`_ jdbc ../extensions/server/authentication -.. _Authentication Configurations: ../deployment/settings.html#authentication +.. _Authentication Configurations: ../configuration/settings.html#authentication diff --git a/docs/security/authorization/spark/overview.rst b/docs/security/authorization/spark/overview.rst index fcbaa880b..364d6485f 100644 --- a/docs/security/authorization/spark/overview.rst +++ b/docs/security/authorization/spark/overview.rst @@ -106,4 +106,4 @@ You can specify config `spark.kyuubi.conf.restricted.list` values to disable cha 2. A set statement with key equal to `spark.sql.optimizer.excludedRules` and value containing `org.apache.kyuubi.plugin.spark.authz.ranger.*` also does not allow modification. .. _Apache Ranger: https://ranger.apache.org/ -.. _Spark Configurations: ../../../deployment/settings.html#spark-configurations +.. _Spark Configurations: ../../../configuration/settings.html#spark-configurations diff --git a/docs/security/ldap.md b/docs/security/ldap.md index f668ad0c9..7994afb51 100644 --- a/docs/security/ldap.md +++ b/docs/security/ldap.md @@ -56,5 +56,5 @@ kyuubi.authentication.ldap.userFilter=hive-admin,hive,hive-test,hive-user kyuubi.authentication.ldap.customLDAPQuery=(&(objectClass=group)(objectClass=top)(instanceType=4)(cn=Domain*)), (&(objectClass=person)(|(sAMAccountName=admin)(|(memberOf=CN=Domain Admins,CN=Users,DC=domain,DC=com)(memberOf=CN=Administrators,CN=Builtin,DC=domain,DC=com)))) ``` -Please refer to [Settings for LDAP authentication in Kyuubi](../deployment/settings.html?highlight=LDAP#authentication) +Please refer to [Settings for LDAP authentication in Kyuubi](../configuration/settings.html?highlight=LDAP#authentication) for all configurations. diff --git a/kyuubi-server/src/main/scala/org/apache/kyuubi/engine/ProcBuilder.scala b/kyuubi-server/src/main/scala/org/apache/kyuubi/engine/ProcBuilder.scala index 304799db8..44b317c71 100644 --- a/kyuubi-server/src/main/scala/org/apache/kyuubi/engine/ProcBuilder.scala +++ b/kyuubi-server/src/main/scala/org/apache/kyuubi/engine/ProcBuilder.scala @@ -340,7 +340,7 @@ trait ProcBuilder { protected def validateEnv(requiredEnv: String): Throwable = { KyuubiSQLException(s"$requiredEnv is not set! For more information on installing and " + s"configuring $requiredEnv, please visit https://kyuubi.readthedocs.io/en/master/" + - s"deployment/settings.html#environments") + s"configuration/settings.html#environments") } def clusterManager(): Option[String] = None diff --git a/kyuubi-server/src/test/scala/org/apache/kyuubi/config/AllKyuubiConfiguration.scala b/kyuubi-server/src/test/scala/org/apache/kyuubi/config/AllKyuubiConfiguration.scala index 5dde9f935..1f4c9e171 100644 --- a/kyuubi-server/src/test/scala/org/apache/kyuubi/config/AllKyuubiConfiguration.scala +++ b/kyuubi-server/src/test/scala/org/apache/kyuubi/config/AllKyuubiConfiguration.scala @@ -31,7 +31,7 @@ import org.apache.kyuubi.zookeeper.ZookeeperConf // scalastyle:off line.size.limit /** * End-to-end test cases for configuration doc file - * The golden result file is "docs/deployment/settings.md". + * The golden result file is "docs/configuration/settings.md". * * To run the entire test suite: * {{{ @@ -46,7 +46,7 @@ import org.apache.kyuubi.zookeeper.ZookeeperConf // scalastyle:on line.size.limit class AllKyuubiConfiguration extends KyuubiFunSuite { private val kyuubiHome: String = Utils.getCodeSourceLocation(getClass).split("kyuubi-server")(0) - private val markdown = Paths.get(kyuubiHome, "docs", "deployment", "settings.md") + private val markdown = Paths.get(kyuubiHome, "docs", "configuration", "settings.md") .toAbsolutePath private def loadConfigs = Array( @@ -64,7 +64,7 @@ class AllKyuubiConfiguration extends KyuubiFunSuite { builder ++= s""" - |# Introduction to the Kyuubi Configurations System + |# Configurations | |Kyuubi provides several ways to configure the system and corresponding engines. |