Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/security/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ and encryption, etc.

Authentication <authentication>
Authorization <authorization/index>
Session Configuration <session_configuration>
kinit
hadoop_credentials_manager
internal_secure_access
Expand Down
40 changes: 40 additions & 0 deletions docs/security/session_configuration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
<!--
- 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.
-->

# Protect Session Configurations

For a multi-tenant deployment, configure at least one of
`kyuubi.session.conf.ignore.list` or `kyuubi.session.conf.restrict.list`. Both
lists are empty by default, so clients can otherwise override sensitive
session-level configurations during engine bootstrap and connection setup.

One conservative starting point is:

```properties
kyuubi.session.conf.ignore.list=spark.driver.memory,spark.executor.memory
kyuubi.session.conf.restrict.list=kyuubi.session.engine.spark.main.resource,kyuubi.engine.share.level,spark.master,spark.submit.deployMode,spark.sql.extensions,spark.sql.optimizer.excludedRules
```

This example is not comprehensive. Tailor both lists to the deployment. The
ignore list silently drops matching client values, while the restrict list
rejects the connection. Some settings are static or consumed during engine
startup and therefore cannot be changed later. For other settings, configure
the engine's operation-level restrictions when changes through `SET` statements
must also be prevented.

See the [session configuration settings](../configuration/settings.md#session)
for details.