3e86014566
### _Why are the changes needed?_ Add a docs for session conf advisor which includes: 1. the step of how to use 2. an example ### _How was this patch tested?_  Closes #3175 from ulysses-you/session-advisor. Closes #3175 0743644a [ulysses-you] address comment 43f2cda3 [ulysses-you] Add session conf advisor docs Authored-by: ulysses-you <ulyssesyou18@gmail.com> Signed-off-by: ulysses-you <ulyssesyou@apache.org>
74 lines
2.6 KiB
ReStructuredText
74 lines
2.6 KiB
ReStructuredText
.. Licensed to the Apache Software Foundation (ASF) under one or more
|
|
contributor license agreements. See the NOTICE file distributed with
|
|
this work for additional information regarding copyright ownership.
|
|
The ASF licenses this file to You under the Apache License, Version 2.0
|
|
(the "License"); you may not use this file except in compliance with
|
|
the License. You may obtain a copy of the License at
|
|
|
|
.. http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
.. Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
|
|
Inject Session Conf with Custom Config Advisor
|
|
==============================================
|
|
|
|
.. versionadded:: 1.5.0
|
|
|
|
Session Conf Advisor
|
|
--------------------
|
|
|
|
Kyuubi supports inject session configs with custom config advisor. It is usually used to append or overwrite session configs dynamically, so administrators of Kyuubi can have an ability to control the user specified configs.
|
|
|
|
The steps of injecting session configs
|
|
--------------------------------------
|
|
|
|
1. create a custom class which implements the ``org.apache.kyuubi.plugin.SessionConfAdvisor``.
|
|
2. compile and put the jar into ``$KYUUBI_HOME/jars``
|
|
3. adding configuration at ``kyuubi-defaults.conf``:
|
|
|
|
.. code-block:: java
|
|
|
|
kyuubi.session.conf.advisor=${classname}
|
|
|
|
The ``org.apache.kyuubi.plugin.SessionConfAdvisor`` has a zero-arg constructor, holds one method with user and session conf and returns a new conf map.
|
|
|
|
.. code-block:: java
|
|
|
|
public interface SessionConfAdvisor {
|
|
default Map<String, String> getConfOverlay(String user, Map<String, String> sessionConf) {
|
|
return Collections.EMPTY_MAP;
|
|
}
|
|
}
|
|
|
|
.. note:: The returned conf map will overwrite the original session conf.
|
|
|
|
Example
|
|
-------
|
|
|
|
We have a custom class ``CustomSessionConfAdvisor``:
|
|
|
|
.. code-block:: java
|
|
|
|
@Override
|
|
public class CustomSessionConfAdvisor {
|
|
Map<String, String> getConfOverlay(String user, Map<String, String> sessionConf) {
|
|
if ("uly".equals(user)) {
|
|
return Collections.singletonMap("spark.driver.memory", "1G");
|
|
} else {
|
|
return Collections.EMPTY_MAP;
|
|
}
|
|
}
|
|
}
|
|
|
|
If a user `uly` creates a connection with:
|
|
|
|
.. code-block:: java
|
|
|
|
jdbc:hive2://localhost:10009/;hive.server2.proxy.user=uly;#spark.driver.memory=2G
|
|
|
|
The final Spark application will allocate ``1G`` rather than ``2G`` for the driver jvm.
|