java.lang.Object
org.elasticsearch.xpack.core.XPackSettings
A container for xpack setting constants.
-
Field Summary
FieldsModifier and TypeFieldDescriptionSetting for enabling or disabling the api key service.Setting for enabling or disabling APM Data.Setting for enabling or disabling auditing.Setting for controlling whether or not CCR is enabled.static final SslClientAuthenticationModeSetting for enabling or disabling document/field level security.Setting for enabling the enrollment process, ie the enroll APIs are enabled, and the initial cluster node generates and displays enrollment tokens (for Kibana and sometimes for ES nodes) when starting up for the first time.Setting for enabling or disabling enterprise search.Setting for enabling or disabling FIPS mode.Optional setting to prevent startup if required providers are not discovered at runtimeSetting for enabling or disabling graph.static final SslClientAuthenticationModeSetting for enabling or disabling http ssl.static final StringSetting for enabling or disabling machine learning.Setting for enabling or disabling OTel Data.Setting for enabling or disabling universal profiling.static final SslClientAuthenticationModeSetting for enabling or disabling remote cluster client TLS.static final StringSetting for enabling or disabling remote cluster server TLS.static final StringSetting for enabling or disabling the reserved realm.Setting for enabling or disabling the TLS auto-configuration as well as credentials auto-generation for nodes, before starting for the first time, and in the absence of other conflicting configurations.Setting for enabling or disabling security.Setting for enabling or disabling the token service.Setting for enabling or disabling TLS.static final Stringstatic final SslVerificationModeSetting for enabling or disabling watcher. -
Method Summary
Modifier and TypeMethodDescriptiondefaultStoredPasswordHashAlgorithmSetting(String key, Function<Settings, String> defaultHashingAlgorithm) defaultStoredSecureTokenHashAlgorithmSetting(String key, Function<Settings, String> defaultHashingAlgorithm) Similar todefaultStoredPasswordHashAlgorithmSetting(String, Function)but for secure, high-entropy tokens so salted secure hashing algorithms are allowed, in addition to algorithms that are suitable for password hashing.Returns all settings created inXPackSettings.
-
Field Details
-
CCR_ENABLED_SETTING
Setting for controlling whether or not CCR is enabled. -
SECURITY_ENABLED
Setting for enabling or disabling security. Defaults to true. -
WATCHER_ENABLED
Setting for enabling or disabling watcher. Defaults to true. -
GRAPH_ENABLED
Setting for enabling or disabling graph. Defaults to true. -
ML_NATIVE_CODE_PLATFORMS
-
MACHINE_LEARNING_ENABLED
Setting for enabling or disabling machine learning. Defaults to true on platforms that have the ML native code available. -
PROFILING_ENABLED
Setting for enabling or disabling universal profiling. Defaults to true. -
APM_DATA_ENABLED
Setting for enabling or disabling APM Data. Defaults to true. -
OTEL_DATA_ENABLED
Setting for enabling or disabling OTel Data. Defaults to true. -
ENTERPRISE_SEARCH_ENABLED
Setting for enabling or disabling enterprise search. Defaults to true. -
AUDIT_ENABLED
Setting for enabling or disabling auditing. Defaults to false. -
DLS_FLS_ENABLED
Setting for enabling or disabling document/field level security. Defaults to true. -
TRANSPORT_SSL_ENABLED
Setting for enabling or disabling TLS. Defaults to false. -
HTTP_SSL_ENABLED
Setting for enabling or disabling http ssl. Defaults to false. -
RESERVED_REALM_ENABLED_SETTING
Setting for enabling or disabling the reserved realm. Defaults to true -
TOKEN_SERVICE_ENABLED_SETTING
Setting for enabling or disabling the token service. Defaults to the value of https being enabled -
API_KEY_SERVICE_ENABLED_SETTING
Setting for enabling or disabling the api key service. Defaults to true -
FIPS_MODE_ENABLED
Setting for enabling or disabling FIPS mode. Defaults to false -
FIPS_REQUIRED_PROVIDERS
Optional setting to prevent startup if required providers are not discovered at runtime -
ENROLLMENT_ENABLED
Setting for enabling the enrollment process, ie the enroll APIs are enabled, and the initial cluster node generates and displays enrollment tokens (for Kibana and sometimes for ES nodes) when starting up for the first time. This is usually set by start-up scripts, which run before the node starts, which perform TLS and cluster formation specific configuration (persisted in the node's config dir). This can be toggled liberally by admins (it can be made a dynamic setting), in order to permit or not the enrollment of subsequent nodes. Nevertheless, we assumes that whenENROLLMENT_ENABLEDistruethe node MUST have been configured by said start-up scripts (eg we don't support enrollment with general TLS certificates). -
SECURITY_AUTOCONFIGURATION_ENABLED
Setting for enabling or disabling the TLS auto-configuration as well as credentials auto-generation for nodes, before starting for the first time, and in the absence of other conflicting configurations. -
DEFAULT_CIPHERS
-
PASSWORD_HASHING_ALGORITHM
-
SERVICE_TOKEN_HASHING_ALGORITHM
-
DEFAULT_SUPPORTED_PROTOCOLS
-
CLIENT_AUTH_DEFAULT
-
HTTP_CLIENT_AUTH_DEFAULT
-
REMOTE_CLUSTER_CLIENT_AUTH_DEFAULT
-
VERIFICATION_MODE_DEFAULT
-
HTTP_SSL_PREFIX
-
TRANSPORT_SSL_PREFIX
-
REMOTE_CLUSTER_SERVER_SSL_PREFIX
-
REMOTE_CLUSTER_CLIENT_SSL_PREFIX
-
REMOTE_CLUSTER_SERVER_SSL_ENABLED
Setting for enabling or disabling remote cluster server TLS. Defaults to true. -
REMOTE_CLUSTER_CLIENT_SSL_ENABLED
Setting for enabling or disabling remote cluster client TLS. Defaults to true.
-
-
Method Details
-
defaultStoredPasswordHashAlgorithmSetting
-
defaultStoredSecureTokenHashAlgorithmSetting
public static Setting<String> defaultStoredSecureTokenHashAlgorithmSetting(String key, Function<Settings, String> defaultHashingAlgorithm) Similar todefaultStoredPasswordHashAlgorithmSetting(String, Function)but for secure, high-entropy tokens so salted secure hashing algorithms are allowed, in addition to algorithms that are suitable for password hashing. -
getAllSettings
Returns all settings created inXPackSettings.
-