865a8b75c9
# 🔍 Description ## Issue References 🔗 This pull request is to improve doc for Session Conf Advisor ## Describe Your Solution 🔧 improve doc for Session Conf Advisor ## Types of changes 🔖 - [ ] 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 🧪 #### Behavior Without This Pull Request ⚰️ #### Behavior With This Pull Request 🎉 #### Related Unit Tests --- # Checklist 📝 - [ ] This patch was not authored or co-authored using [Generative Tooling](https://www.apache.org/legal/generative-tooling.html) **Be nice. Be informative.** Closes #5951 from zhaohehuhu/Improvement-0108. Closes #5951 9f2c66210 [hezhao2] Improve doc for Session Conf Advisor Authored-by: hezhao2 <hezhao2@cisco.com> Signed-off-by: Cheng Pan <chengpan@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
|
|
|
|
public class CustomSessionConfAdvisor implements SessionConfAdvisor {
|
|
@Override
|
|
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.
|