Конфигурационные параметры Zeppelin

Для конфигурации сервиса используйте следующие параметры, доступные в ADCM.

ПРИМЕЧАНИЕ
  • Некоторые из перечисленных параметров становятся доступны в UI ADCM после установки флага Advanced.

  • Значения, установленные в Custom-параметрах, перепишут текущие значения параметров, даже если они read-only.

User-managed interpreters
Параметр Описание Значение по умолчанию

Allow user-managed interpreters

Позволяет использовать интерпретаторы Zeppelin, у которых объявлено свойство user-managed=true. Если опция включена, при рестарте Zeppelin с помощью ADCM кастомные свойства интерпретатора будут сохранены

true

Custom interpreter.json

Активирует конфигурацию для интерпретаторов, описанную в поле ADCM interpreter.json

false

interpreter.json

Кастомная JSON-конфигурация интерпретаторов, которые должны быть доступны в веб-интерфейсе Zeppelin. Использование этой конфигурации перезаписывает настройки всех интерпретаторов (пользовательских и системных)

interpreters.json

interpreter.sh

Кастомное содержимое скрипта interpreter.sh. Данный скрипт вызывается при запуске Zeppelin и выполняет инициализацию окружения, необходимую для работы Zeppelin

interpreters.sh

zeppelin-site.xml
Параметр Описание Значение по умолчанию

zeppelin.dep.localrepo

Локальный репозиторий для загрузчика зависимостей

/srv/zeppelin/local-repo

zeppelin.server.addr

Адрес биндинга Zeppelin-сервера

0.0.0.0

zeppelin.server.port

Порт сервера

8180

zeppelin.server.kerberos.principal

Имя принципала, загружаемого из keytab-файла

 — 

zeppelin.server.kerberos.keytab

Путь к keytab-файлу

 — 

zeppelin.shell.auth.type

Устанавливает тип аутентификации. Допустимые значения: SIMPLE и KERBEROS

 — 

zeppelin.shell.principal

Имя принципала, загружаемого из keytab-файла

 — 

zeppelin.shell.keytab.location

Путь к keytab-файлу

 — 

zeppelin.jdbc.auth.type

Устанавливает тип аутентификации. Допустимые значения: SIMPLE и KERBEROS

 — 

zeppelin.jdbc.keytab.location

Путь к keytab-файлу

 — 

zeppelin.jdbc.principal

Имя принципала, загружаемого из keytab-файла

 — 

zeppelin.jdbc.auth.kerberos.proxy.enable

Если используется тип аутентификации KERBEROS, этот параметр включает/отключает проксирование с использованием логина пользователя для установки соединения

true

spark.yarn.keytab

Абсолютный путь к keytab-файлу для принципала. Этот keytab-файл будет скопирован на узел, на котором запущен YARN Application Master через безопасный распределенный кеш (Secure Distributed Cache), для периодического обновления логин-тикетов и токенов делегирования

 — 

spark.yarn.principal

Имя принципала, используемое для логина в KDC, запущенном на защищенном HDFS-кластере

 — 

zeppelin.livy.keytab

Путь к keytab-файлу

 — 

zeppelin.livy.principal

Имя принципала, загружаемого из keytab-файла

 — 

zeppelin.server.ssl.port

Номер порта, используемого для SSL-соединения

8180

zeppelin.ssl

Определяет, использовать ли SSL-соединение

false

zeppelin.ssl.keystore.path

Путь к keystore-файлу, который использует Zeppelin

 — 

zeppelin.ssl.keystore.password

Пароль для доступа к keystore-файлу

 — 

zeppelin.ssl.truststore.path

Путь к truststore-файлу, который использует Zeppelin

 — 

zeppelin.ssl.truststore.password

Пароль для доступа к truststore-файлу

 — 

Zeppelin server heap memory settings
Параметр Описание Значение по умолчанию

Zeppelin Server Heap Memory

Задает начальный (-Xms) и максимальный (-Xmx) размер Java heap для Zeppelin Server

-Xms700m -Xmx1024m

Shiro Simple username/password auth
Параметр Описание Значение по умолчанию

Users/password map

Сопоставление типа <username: password>. Например, <myUser1: password1>

 — 

sessionManager

Класс, отвечающий за создание, поддержку и очистку всех сессий приложения

org.apache.shiro.web.session.mgt.DefaultWebSessionManager

securityManager.sessionManager

Реализация компонента SessionManager для SecurityManager

$sessionManager

securityManager.sessionManager.globalSessionTimeout

Тайм-аут в миллисекундах, по истечении которого сессия считается истекшей и пользователю необходимо выполнить вход в систему

86400000

shiro.loginUrl

Устанавливает свойство loginUrl для стандартных фильтров Shiro

/api/login

cookie

Класс, отвечающий за обработку файлов cookie

org.apache.shiro.web.servlet.SimpleCookie

cookie.name

Имя сессионного cookie-файла, используемого Shiro. Этот параметр должен быть равен параметру responseExcludeHeaders в /usr/lib/knox/data/services/zeppelinui/{version}/service.xml

JSESSIONID

cookie.httpOnly

Определяет, должны ли cookie Shiro иметь атрибут HttpOnly

true

cookie.secure

Определяет, должны ли cookie Shiro иметь атрибут Secure

false

sessionManager.sessionIdCookie

Реализация cookie для sessionManager

$cookie

Shiro LDAP auth
Параметр Описание Значение по умолчанию

ldapRealm

Расширяет провайдер Apache Shiro, чтобы разрешить поиск LDAP и предоставить членство в группе провайдеру авторизации

org.apache.zeppelin.realm.LdapRealm

ldapRealm.contextFactory.authenticationMechanism

Указывает тип аутентификации, используемый LDAP-сервисом

simple

ldapRealm.contextFactory.url

URL LDAP-сервера. Например, ldap://ldap.example.com:389

 — 

ldapRealm.userDnTemplate

Опциональный параметр. Knox использует это значение для составления UserDN для привязки аутентификации. UserDN, где токен {0} указывает на атрибут, который соответствует логину пользователя. Например, UserDnTemplate для Apache DS с Knox: uid={0},ou=people,dc=hadoop,dc=apache,dc=org

 — 

ldapRealm.pagingSize

Позволяет установить размер страницы LDAP

100

ldapRealm.authorizationEnabled

Включает авторизацию для Shiro ldapRealm

true

ldapRealm.contextFactory.systemAuthenticationMechanism

Определяет механизм аутентификации, используемый Shiro ldapRealm context factory. Допустимые значения: simple и digest-md5

 — 

ldapRealm.userLowerCase

Возвращает имена пользователей из LDAP в нижнем регистре

true

ldapRealm.memberAttributeValueTemplate

Атрибут для идентификации пользователя в группе. Например: cn={0},ou=people,dc=hadoop,dc=apache,dc=org

 — 

ldapRealm.searchBase

Начальный DN в LDAP DIT, с которого следует начать поиск. Поиск осуществляется только в дочерних деревьях указанного поддерева. Например: dc=hadoop,dc=apache,dc=org

 — 

ldapRealm.userSearchBase

База поиска для DN привязки пользователя. По умолчанию используется значение ldapRealm.searchBase, если значение не задано. Если задан параметр ldapRealm.userSearchAttributeName, также необходимо указать значение для ldapRealm.searchBase или ldapRealm.userSearchBase

 — 

ldapRealm.groupSearchBase

База поиска, используемая для поиска групп. По умолчанию используется значение ldapRealm.searchBase. Устанавливается только в том случае, если ldapRealm.authorizationEnabled=true

 — 

ldapRealm.groupObjectClass

Значение класса объекта, который идентифицирует записи группы в LDAP

groupofnames

ldapRealm.userSearchAttributeName

Атрибут, соответствующий логин-токену пользователя. Этот атрибут используется с результатами поиска для вычисления UserDN для привязки аутентификации

sAMAccountName

ldapRealm.memberAttribute

Значение атрибута, определяющего членство в группе. При значении rememberer найденные группы рассматриваются как динамические группы

member

ldapRealm.userSearchScope

Позволяет определить searchScopes. Возможные значения: subtree, one, base

subtree

ldapRealm.groupSearchScope

Позволяет определить groupSearchScope. Возможные значения: subtree, one, base

subtree

ldapRealm.contextFactory.systemUsername

Учетная запись службы LDAP, которую Zeppelin использует для поиска LDAP. При необходимости укажите полное имя пользователя учетной записи. Например: uid=guest,ou=people,dc=hadoop,dc=apache,dc=org. Для этой учетной записи требуется разрешение на чтение базового DN-поиска

 — 

ldapRealm.contextFactory.systemPassword

Устанавливает пароль для systemUsername. Этот пароль будет добавлен в хранилище ключей с учетными данными hadoop

 — 

ldapRealm.groupSearchEnableMatchingRuleInChain

Включает поддержку вложенных групп с помощью оператора LDAP_MATCHING_RULE_IN_CHAIN

true

ldapRealm.rolesByGroup

Опциональный параметр. Сопоставление физических групп с логическими ролями приложений. Например: "LDN_USERS":"user_role", "NYK_USERS":"user_role", "HKG_USERS":"user_role", "GLOBAL_ADMIN":"admin_role"

 — 

ldapRealm.allowedRolesForAuthentication

Необязательный список ролей, которым разрешено проходить аутентификацию. Если параметр не задан, всем группам разрешено проходить аутентификацию. Не влияет на разрешения для конкретных URL-адресов, которые будут продолжать работать, как указано в [urls]. Например: admin_role,user_role

 — 

ldapRealm.permissionsByRole

Опциональный параметр. Устанавливает права по ролям. Например: 'user_role = :ToDoItemsJdo::*, :ToDoItem::*; admin_role = *'

 — 

securityManager.realms

Указывает список Apache Shiro Realms

$ldapRealm

sessionManager

Класс, отвечающий за создание, поддержку и очистку всех сессий приложения

org.apache.shiro.web.session.mgt.DefaultWebSessionManager

securityManager.sessionManager

Реализация компонента SessionManager для SecurityManager

$sessionManager

securityManager.sessionManager.globalSessionTimeout

Тайм-аут в миллисекундах, по истечении которого сессия считается истекшей и пользователю необходимо выполнить вход в систему

86400000

shiro.loginUrl

Устанавливает свойство loginUrl для стандартных фильтров Shiro

/api/login

cookie

Класс, отвечающий за обработку файлов cookie

org.apache.shiro.web.servlet.SimpleCookie

cookie.name

Имя сессионного cookie-файла, используемого Shiro. Этот параметр должен быть равен параметру responseExcludeHeaders в /usr/lib/knox/data/services/zeppelinui/{version}/service.xml

JSESSIONID

cookie.httpOnly

Определяет, должны ли cookie Shiro иметь атрибут HttpOnly

true

cookie.secure

Определяет, должны ли cookie Shiro иметь атрибут Secure

false

sessionManager.sessionIdCookie

Реализация cookie для sessionManager

$cookie

Shiro Active Directory auth
Параметр Описание Значение по умолчанию

activeDirectoryRealm

Shiro realm для работы с Active Directory

org.apache.zeppelin.realm.ActiveDirectoryGroupRealm

activeDirectoryRealm.systemUsername

Имя пользователя для подключения к Active Directory

 — 

activeDirectoryRealm.systemPassword

Пароль для подключения к Active Directory

 — 

activeDirectoryRealm.searchBase

Базовый DN сервера Active Directory. Например: CN=Users,DC=SOME_GROUP,DC=COMPANY,DC=COM

 — 

activeDirectoryRealm.url

URL-адрес сервера Active Directory. Например: ldap://ldap.example.com:389

 — 

activeDirectoryRealm.groupRolesMap

Сопоставление групп Active Directory с ролями Apache Shiro. Например: 'CN=aGroupName,OU=groups,DC=SOME_GROUP,DC=COMPANY,DC=COM':'group1', 'CN=bGroupName,OU=groups,DC=SOME_GROUP,DC=COMPANY,DC=COM':'group2'

 — 

activeDirectoryRealm.authorizationCachingEnabled

Включает/отключает кеширование решений об авторизации

false

securityManager.realms

Shiro Realm, используемый компонентом securityManager

$activeDirectoryRealm

sessionManager

Класс, отвечающий за создание, поддержку и очистку всех сессий приложения

org.apache.shiro.web.session.mgt.DefaultWebSessionManager

securityManager.sessionManager

Реализация компонента SessionManager для SecurityManager

$sessionManager

securityManager.sessionManager.globalSessionTimeout

Тайм-аут в миллисекундах, по истечении которого сессия считается истекшей и пользователю необходимо выполнить вход в систему

86400000

shiro.loginUrl

Устанавливает свойство loginUrl для стандартных фильтров Shiro

/api/login

cookie

Класс, отвечающий за обработку файлов cookie

org.apache.shiro.web.servlet.SimpleCookie

cookie.name

Имя сессионного cookie-файла, используемого Shiro. Этот параметр должен быть равен параметру responseExcludeHeaders в /usr/lib/knox/data/services/zeppelinui/{version}/service.xml

JSESSIONID

cookie.httpOnly

Определяет, должны ли cookie Shiro иметь атрибут HttpOnly

true

cookie.secure

Определяет, должны ли cookie Shiro иметь атрибут Secure

false

sessionManager.sessionIdCookie

Реализация cookie для sessionManager

$cookie

Shiro SSO Knox
Параметр Описание Значение по умолчанию

knoxJwtRealm

Shiro realm для работы с Knox

org.apache.zeppelin.realm.ActiveDirectoryGroupRealm

knoxJwtRealm.providerUrl

URL-адрес сервера Knox. Например: https://<knox-host>:8443/

 — 

knoxJwtRealm.login

URL для выполнения входа в систему (login)

gateway/knoxsso/knoxauth/login.html

knoxJwtRealm.logout

URL для выполнения выхода из системы (logout)

gateway/knoxssout/api/v1/webssout

knoxJwtRealm.logoutAPI

Активирует действие выход из системы (logout), используя API

true

knoxJwtRealm.redirectParam

URL для редиректа клиента после выхода из системы

originalUrl

knoxJwtRealm.cookieName

Имя файла cookie, используемого Knox SSO

hadoop-jwt

knoxJwtRealm.publicKeyPath

Путь к открытому ключу (сертификату), используемому Knox

/usr/lib/zeppelin/gateway.cer

sessionManager

Класс, отвечающий за создание, поддержку и очистку всех сессий приложения

org.apache.shiro.web.session.mgt.DefaultWebSessionManager

securityManager.sessionManager

Реализация компонента SessionManager для SecurityManager

$sessionManager

securityManager.sessionManager.globalSessionTimeout

Тайм-аут в миллисекундах, по истечении которого сессия считается истекшей и пользователю необходимо выполнить вход в систему

86400000

shiro.loginUrl

Устанавливает свойство loginUrl для стандартных фильтров Shiro

/api/login

cookie

Класс, отвечающий за обработку файлов cookie

org.apache.shiro.web.servlet.SimpleCookie

cookie.httpOnly

Определяет, должны ли cookie Shiro иметь атрибут HttpOnly

true

cookie.secure

Определяет, должны ли cookie Shiro иметь атрибут Secure

false

sessionManager.sessionIdCookie

Реализация cookie для sessionManager

$cookie

cookie.name

Имя сессионного cookie, используемого Shiro. Этот параметр должен быть равен параметру responseExcludeHeaders в /usr/lib/knox/data/services/zeppelinui/{version}/service.xml

WWW-AUTHENTICATE

knoxJwtRealm.groupPrincipalMapping

Определяет правила сопоставления принципалов и групп

group.principal.mapping

knoxJwtRealm.principalMapping

Определяет правила сопоставления принципалов

principal.mapping

Additional configuration Shiro.ini
Параметр Описание Значение по умолчанию

Additional main section in shiro.ini

Позволяет добавить пары ключ/значение в секцию main файла shiro.ini

 — 

Additional roles section in shiro.ini

Позволяет добавить пары ключ/значение в секцию roles файла shiro.ini

 — 

Additional urls section in shiro.ini

Позволяет добавить пары ключ/значение в секцию urls файла shiro.ini

 — 

Credential Encryption
Параметр Описание Значение по умолчанию

Encryption enable

Включает или выключает функцию шифрования учетных данных. Если опция включена, Zeppelin хранит учетные данные (пароли настроек, учетные данные для взаимодействия с другими сервисами) в зашифрованном виде

false

Credential provider path

Путь к хранилищу ключей JCEKS

jceks://file/etc/hive/conf/hive.jceks

Custom jceks

Укажите значение true при использовании кастомного файла JCEKS-хранилища. Укажите значение false для использования дефолтного файла хранилища, который генерируется автоматически

false

Другие параметры
Параметр Описание Значение по умолчанию

Custom zeppelin-site.xml

В этой секции вы можете указать значения для кастомных параметров, которые не отображаются в интерфейсе ADCM, но могут присутствовать в конфигурационном файле zeppelin-site.xml

 — 

Custom zeppelin-env.sh

В этой секции вы можете указать значения для кастомных параметров, которые не отображаются в интерфейсе ADCM, но могут присутствовать в конфигурационном файле zeppelin-env.sh

Custom log4j.properties

В этой секции вы можете указать значения для кастомных параметров, которые не отображаются в интерфейсе ADCM, но могут присутствовать в конфигурационном файле log4j.properties

Нашли ошибку? Выделите текст и нажмите Ctrl+Enter чтобы сообщить о ней