diff --git a/.ci/Dockerfile b/.ci/Dockerfile index d6eee046611b..9ac6c32772e4 100644 --- a/.ci/Dockerfile +++ b/.ci/Dockerfile @@ -1,7 +1,7 @@ # NOTE: This Dockerfile is ONLY used to run certain tasks in CI. It is not used to run Kibana or as a distributable. # If you're looking for the Kibana Docker image distributable, please see: src/dev/build/tasks/os_packages/docker_generator/templates/dockerfile.template.ts -ARG NODE_VERSION=10.22.1 +ARG NODE_VERSION=12.19.0 FROM node:${NODE_VERSION} AS base diff --git a/.ci/packer_cache_for_branch.sh b/.ci/packer_cache_for_branch.sh index ab0ab845b2dc..b8b5f7d3c3f0 100755 --- a/.ci/packer_cache_for_branch.sh +++ b/.ci/packer_cache_for_branch.sh @@ -18,7 +18,7 @@ node scripts/es snapshot --download-only; node scripts/es snapshot --license=oss --download-only; # download reporting browsers -(cd "x-pack" && yarn gulp downloadChromium); +(cd "x-pack" && node ../node_modules/.bin/gulp downloadChromium); # cache the chromedriver archive chromedriverDistVersion="$(node -e "console.log(require('chromedriver').version)")" @@ -51,10 +51,6 @@ tar -cf "$HOME/.kibana/bootstrap_cache/$branch.tar" \ .chromedriver \ .geckodriver; -echo "Adding node_modules" -# Find all of the node_modules directories that aren't test fixtures, and aren't inside other node_modules directories, and append them to the tar -find . -type d -name node_modules -not -path '*__fixtures__*' -prune -print0 | xargs -0I % tar -rf "$HOME/.kibana/bootstrap_cache/$branch.tar" "%" - echo "created $HOME/.kibana/bootstrap_cache/$branch.tar" if [[ "$branch" != "master" ]]; then diff --git a/.eslintrc.js b/.eslintrc.js index 561e9bc55bf9..ad9de04251e4 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -1035,12 +1035,19 @@ module.exports = { * Alerting Services overrides */ { - // typescript only for front and back end + // typescript for front and back end files: ['x-pack/plugins/{alerts,stack_alerts,actions,task_manager,event_log}/**/*.{ts,tsx}'], rules: { '@typescript-eslint/no-explicit-any': 'error', }, }, + { + // typescript only for back end + files: ['x-pack/plugins/triggers_actions_ui/server/**/*.ts'], + rules: { + '@typescript-eslint/no-explicit-any': 'error', + }, + }, /** * Lens overrides diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 0e0099ff672f..b7fb3ff04db7 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -26,7 +26,7 @@ /src/plugins/vis_type_vislib/ @elastic/kibana-app /src/plugins/vis_type_xy/ @elastic/kibana-app /src/plugins/visualize/ @elastic/kibana-app -/src/plugins/visualizations/ @elastic/kibana-application +/src/plugins/visualizations/ @elastic/kibana-app # Application Services /examples/bfetch_explorer/ @elastic/kibana-app-arch @@ -123,8 +123,8 @@ # ML team owns and maintains the transform plugin despite it living in the Elasticsearch management section. /x-pack/plugins/transform/ @elastic/ml-ui /x-pack/test/functional/apps/transform/ @elastic/ml-ui -/x-pack/test/functional/services/transform/ @elastic/ml-ui/ -x-pack/test/api_integration_basic/apis/ml/ @elastic/ml-ui +/x-pack/test/functional/services/transform/ @elastic/ml-ui +/x-pack/test/api_integration_basic/apis/ml/ @elastic/ml-ui /x-pack/test/functional_basic/apps/ml/ @elastic/ml-ui /x-pack/test/api_integration_basic/apis/transform/ @elastic/ml-ui @@ -137,6 +137,7 @@ x-pack/test/api_integration_basic/apis/ml/ @elastic/ml-ui /x-pack/test/functional/es_archives/maps/ @elastic/kibana-gis /x-pack/test/visual_regression/tests/maps/index.js @elastic/kibana-gis #CC# /src/plugins/maps_legacy/ @elastic/kibana-gis +#CC# /src/plugins/maps_oss/ @elastic/kibana-gis #CC# /x-pack/plugins/file_upload @elastic/kibana-gis #CC# /x-pack/plugins/maps_legacy_licensing @elastic/kibana-gis #CC# /src/plugins/home/server/tutorials @elastic/kibana-gis @@ -261,6 +262,7 @@ x-pack/plugins/telemetry_collection_xpack/schema/xpack_plugins.json @elastic/kib # Elasticsearch UI /src/plugins/dev_tools/ @elastic/es-ui /src/plugins/console/ @elastic/es-ui +/src/plugins/es_ui_shared/ @elastic/es-ui /x-pack/plugins/cross_cluster_replication/ @elastic/es-ui /x-pack/plugins/index_lifecycle_management/ @elastic/es-ui /x-pack/plugins/console_extensions/ @elastic/es-ui diff --git a/.github/paths-labeller.yml b/.github/paths-labeller.yml index bd8427ea18d6..f74870578ecb 100644 --- a/.github/paths-labeller.yml +++ b/.github/paths-labeller.yml @@ -12,8 +12,7 @@ - "x-pack/plugins/apm/**/*.*" - "Team:Ingest Management": - "x-pack/plugins/fleet/**/*.*" - - "x-pack/test/api_integration/apis/fleet/**/*.*" - - "x-pack/test/epm_api_integration/**/*.*" + - "x-pack/test/fleet_api_integration/**/*.*" - "Team:uptime": - "x-pack/plugins/uptime/**/*.*" - "x-pack/plugins/apm/e2e/cypress/support/step_definitions/csm/*.*" diff --git a/.node-version b/.node-version index c2f6421352c4..260a0e20f68f 100644 --- a/.node-version +++ b/.node-version @@ -1 +1 @@ -10.22.1 +12.19.0 diff --git a/.nvmrc b/.nvmrc index c2f6421352c4..260a0e20f68f 100644 --- a/.nvmrc +++ b/.nvmrc @@ -1 +1 @@ -10.22.1 +12.19.0 diff --git a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.md b/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.md index e7facb4a109c..4a9fc940c596 100644 --- a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.md +++ b/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.md @@ -19,6 +19,7 @@ export interface UiSettingsParams | [category](./kibana-plugin-core-public.uisettingsparams.category.md) | string[] | used to group the configured setting in the UI | | [deprecation](./kibana-plugin-core-public.uisettingsparams.deprecation.md) | DeprecationSettings | optional deprecation information. Used to generate a deprecation warning. | | [description](./kibana-plugin-core-public.uisettingsparams.description.md) | string | description provided to a user in UI | +| [metric](./kibana-plugin-core-public.uisettingsparams.metric.md) | {
type: UiStatsMetricType;
name: string;
} | Metric to track once this property changes | | [name](./kibana-plugin-core-public.uisettingsparams.name.md) | string | title in the UI | | [optionLabels](./kibana-plugin-core-public.uisettingsparams.optionlabels.md) | Record<string, string> | text labels for 'select' type UI element | | [options](./kibana-plugin-core-public.uisettingsparams.options.md) | string[] | array of permitted values for this setting | diff --git a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.metric.md b/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.metric.md new file mode 100644 index 000000000000..0855cfd77a46 --- /dev/null +++ b/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.metric.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [UiSettingsParams](./kibana-plugin-core-public.uisettingsparams.md) > [metric](./kibana-plugin-core-public.uisettingsparams.metric.md) + +## UiSettingsParams.metric property + +> Warning: This API is now obsolete. +> +> Temporary measure until https://github.com/elastic/kibana/issues/83084 is in place +> + +Metric to track once this property changes + +Signature: + +```typescript +metric?: { + type: UiStatsMetricType; + name: string; + }; +``` diff --git a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.md b/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.md index f134decb5102..7bcb996e98e1 100644 --- a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.md +++ b/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.md @@ -19,6 +19,7 @@ export interface UiSettingsParams | [category](./kibana-plugin-core-server.uisettingsparams.category.md) | string[] | used to group the configured setting in the UI | | [deprecation](./kibana-plugin-core-server.uisettingsparams.deprecation.md) | DeprecationSettings | optional deprecation information. Used to generate a deprecation warning. | | [description](./kibana-plugin-core-server.uisettingsparams.description.md) | string | description provided to a user in UI | +| [metric](./kibana-plugin-core-server.uisettingsparams.metric.md) | {
type: UiStatsMetricType;
name: string;
} | Metric to track once this property changes | | [name](./kibana-plugin-core-server.uisettingsparams.name.md) | string | title in the UI | | [optionLabels](./kibana-plugin-core-server.uisettingsparams.optionlabels.md) | Record<string, string> | text labels for 'select' type UI element | | [options](./kibana-plugin-core-server.uisettingsparams.options.md) | string[] | array of permitted values for this setting | diff --git a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.metric.md b/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.metric.md new file mode 100644 index 000000000000..4d54bf9ae472 --- /dev/null +++ b/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.metric.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UiSettingsParams](./kibana-plugin-core-server.uisettingsparams.md) > [metric](./kibana-plugin-core-server.uisettingsparams.metric.md) + +## UiSettingsParams.metric property + +> Warning: This API is now obsolete. +> +> Temporary measure until https://github.com/elastic/kibana/issues/83084 is in place +> + +Metric to track once this property changes + +Signature: + +```typescript +metric?: { + type: UiStatsMetricType; + name: string; + }; +``` diff --git a/docs/development/plugins/embeddable/server/kibana-plugin-plugins-embeddable-server.embeddablesetup.getattributeservice.md b/docs/development/plugins/embeddable/server/kibana-plugin-plugins-embeddable-server.embeddablesetup.getattributeservice.md deleted file mode 100644 index 9cd77ca6e3a3..000000000000 --- a/docs/development/plugins/embeddable/server/kibana-plugin-plugins-embeddable-server.embeddablesetup.getattributeservice.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-plugins-embeddable-server](./kibana-plugin-plugins-embeddable-server.md) > [EmbeddableSetup](./kibana-plugin-plugins-embeddable-server.embeddablesetup.md) > [getAttributeService](./kibana-plugin-plugins-embeddable-server.embeddablesetup.getattributeservice.md) - -## EmbeddableSetup.getAttributeService property - -Signature: - -```typescript -getAttributeService: any; -``` diff --git a/docs/development/plugins/embeddable/server/kibana-plugin-plugins-embeddable-server.embeddablesetup.md b/docs/development/plugins/embeddable/server/kibana-plugin-plugins-embeddable-server.embeddablesetup.md index bd024095e80b..5109a75ad57f 100644 --- a/docs/development/plugins/embeddable/server/kibana-plugin-plugins-embeddable-server.embeddablesetup.md +++ b/docs/development/plugins/embeddable/server/kibana-plugin-plugins-embeddable-server.embeddablesetup.md @@ -7,14 +7,13 @@ Signature: ```typescript -export interface EmbeddableSetup +export interface EmbeddableSetup extends PersistableStateService ``` ## Properties | Property | Type | Description | | --- | --- | --- | -| [getAttributeService](./kibana-plugin-plugins-embeddable-server.embeddablesetup.getattributeservice.md) | any | | | [registerEmbeddableFactory](./kibana-plugin-plugins-embeddable-server.embeddablesetup.registerembeddablefactory.md) | (factory: EmbeddableRegistryDefinition) => void | | | [registerEnhancement](./kibana-plugin-plugins-embeddable-server.embeddablesetup.registerenhancement.md) | (enhancement: EnhancementRegistryDefinition) => void | | diff --git a/docs/discover/context.asciidoc b/docs/discover/context.asciidoc deleted file mode 100644 index e26c91bfef07..000000000000 --- a/docs/discover/context.asciidoc +++ /dev/null @@ -1,66 +0,0 @@ -[[document-context]] -== View a document in context - -Once you've narrowed your search to a specific event, -you might want to inspect the documents that occurred -immediately before and after the event. With the Context view, -you can do just that for index patterns that contain time-based events. - -To open the Context view, click the expand icon (<) in the document table, and then click -*View surrounding documents.* - -The documents are sorted -by the time field specified in the index pattern and displayed using the -same set of columns as the *Discover* view from which the context was opened. -The anchor document is highlighted in blue. - - -[role="screenshot"] -image::images/Discover-ContextView.png[Image showing context view feature, with anchor documents highlighted in blue] - -[float] -[[filter-context]] -=== Filter the context - -The -filters you applied in *Discover* are carried over to the Context view. Pinned filters remain active, while normal -filters are copied in a disabled state. You can re-enable these filters to -refine your context view. - -If the Context view contains a large number of documents not related to the event under -investigation, you can use filters to restrict the documents to -display. - -[float] -[[change-context-size]] -=== Change the number of surrounding documents - -By default, the five newest and oldest -documents are listed. To increase the number of documents that surround the anchor document, -click *Load*. Five documents are added with each click. - -[float] -[[configure-context-ContextView]] -=== Configure the context view - -To configure the Context view, use these settings in <>. - -[horizontal] -`context:defaultSize`:: The number of documents to display by default. -`context:step`:: The default number of documents to load with each button click. -`context:tieBreakerFields`:: The field to use for tiebreaking in case of equal time field values. -The default is the -`_doc` field. -+ -You can enter a comma-separated list of field -names, which is checked in sequence for suitability when a context is -displayed. The first suitable field is used as the tiebreaking -field. A field is suitable if the field exists and is sortable in the index -pattern the context is based on. -+ -Although not required, it is recommended to only -use fields that have {ref}/doc-values.html[doc values] enabled to achieve -good performance and avoid unnecessary {ref}/modules-fielddata.html[field -data] usage. Common examples for suitable fields include log line numbers, -monotonically increasing counters and high-precision timestamps. diff --git a/docs/discover/document-data.asciidoc b/docs/discover/document-data.asciidoc deleted file mode 100644 index dd245e4b4558..000000000000 --- a/docs/discover/document-data.asciidoc +++ /dev/null @@ -1,55 +0,0 @@ -[[document-data]] -== View document data - -When you submit a search query in *Discover*, the most recent documents that match the query -are listed in the documents table. -By default, the table includes columns for -the time field and the document `_source`, which shows all fields and values in the document. - -[float] -[[sorting]] -=== Modify the document table - -Use the following commands to -tailor the documents table to suit your needs. - -[horizontal] -Add a field column:: -Hover over the list of *Available fields* and then click *add* next to each field you want to include as a column in the table. -The first field you add replaces the `_source` column. -Change sort order:: By default, columns are sorted by the values in the field. -If a time field is configured for the current index pattern, -the documents are sorted in reverse chronological order. -+ -To change the sort order, hover over the column -and click image:images/sort-icon.png[]. -The first click sorts by ascending order, the second click sorts by descending order, and the third -click removes the field from the sorted fields. - -Move a field column:: Hover over the column header and click the (<<) or (>>) icons. -Remove a field column :: Hover over the list of *Specified fields* -and then click *remove*. -Or, use the (x) control in the column header. - -[float] -=== Drill down into field-level details -To view the document data in either table or JSON format, click the expand icon (>). -The expanded view provides these options for viewing your document: - -* View the events that surround your document. -For example, you might want to see the 10 documents that occurred -immediately before and after your event. - -* View the document data as a separate page. You can bookmark and -share the link for direct access to a particular document. - -[role="screenshot"] -image::images/Expanded-Document.png[Image showing expanded view, with JSON and table viewing options] - - -[float] -=== Configure the number of documents to show - -By default, the documents table includes the 500 most recent documents that -match the query. To change this number, set the `discover:sampleSize` property in <>. diff --git a/docs/discover/field-filter.asciidoc b/docs/discover/field-filter.asciidoc deleted file mode 100644 index 0c521b401e4b..000000000000 --- a/docs/discover/field-filter.asciidoc +++ /dev/null @@ -1,155 +0,0 @@ -[[field-filter]] -== Filter by field - -*Discover* offers -various types of filters, so you can restrict your documents to the exact data you want. -For example, you might look at the results for a -particular period of time. Or, you might include—or exclude— -all HTTP redirects that come from a specific IP and port. - -[float] -=== Add a filter - -A quick way to add a filter is from the fields list. - -. Click the field to filter on. -+ -You'll see the number of documents that contain -the field, the top 5 values for the field, and the percentage of documents -that contain each value. -+ -[role="screenshot"] -image::images/filter-field.png[Picture showing top 5 values for each field, and correspnding percentage of documents that contain each value] - -. Use the image:images/PositiveFilter.jpg[Positive Filter] icon to -show only documents that contain that value, -or image:images/NegativeFilter.jpg[Negative Filter] to exclude all documents with that value. -+ -If there is no data to display, you might need to set a <>. -You can choose a time from the quick filter or choose your -own using absolute or relative times. - -. Try also these filtering options: -+ -* To limit the field -list to a particular data type, click *Filter by type*. -You can also filter for whether that type is -aggregatable or searchable. -+ -* To filter for whether a field is present, expand the document in -the document table, hover over the field, and click the *Filter for field present* icon. - -[float] -=== Filter by condition - -You can filter using advanced criteria, -such as if a value is equal to or in between certain values. - -. Click *Add Filter*. - -. Select a field. - -. Select an operation for your filter: -+ -[horizontal] -`is`:: The value for the field matches the given value. -`is not`:: The value for the field does not match the given value. -`is one of`:: The field matches one of the specified values. -`is not one of`:: The value for the field does not match any of the specified values. -`is between`:: The value for the field is in the given range. -`is not between`:: The value for the field is not in the given range. -`exists`:: Any value is present for the field. -`does not exist`:: No value is present for the field. -. Choose values for your filter. -+ -Values from your indices may be suggested -as selections if you are filtering against an aggregatable field. - -. (Optional) Specify a label for the filter. - -. Click *Save* to apply the filter to your search. -+ -NOTE: If you are experiencing long-running queries as a result of the value suggestions, you can -turn off the suggestions by setting `filterEditor:suggestValues` to `false` -in <>. - -[float] -[[filter-pinning]] -=== Edit, disable, and delete filters - -To modify a filter, click its tag, and then select one of the following actions. - -*Pin across all apps*:: -Persist the filter -when you switch contexts in Kibana. For example, you can pin a filter -in *Discover* and it remains in place when you switch to *Visualize*. -A filter is based on a particular index field—if the indices being -searched do not contain the field in a pinned filter, it has no effect. - -*Edit filter*:: -Edit the -filter definition and label. - -*Exclude results*:: -Switch from a positive -filter to a negative filter, and vice versa. - -*Temporarily disable*:: -Disable the filter without -removing it. Click again to reenable the filter. - -*Delete*:: -Delete the filter. - -To apply an action to all filters, -click the *Actions* icon, and then select the action. - - - -[float] -[[filter-edit]] -=== Modify the filter query - -You can directly modify -the query that filters your search results. This enables you -to create more complex filters using multiple fields. - -. Click the filter tag, and then select *Edit > Edit Query DSL*. - -. Edit the query for the filter. -+ -//// -image::images/edit_filter_query_json.png[] -+ -//// -For example, if you are using the sample log data, you can use the -{ref}/query-dsl-bool-query.html[bool query] to create a filter -that displays the hits that originated from Canada or China that resulted in a 404 error: -+ -========== -[source,json] -{ - "bool": { - "should": [ - { - "term": { - "geoip.country_name.raw": "Canada" - } - }, - { - "term": { - "geoip.country_name.raw": "China" - } - } - ], - "must": [ - { - "term": { - "response": "404" - } - } - ] - } -} -========== diff --git a/docs/discover/images/Discover-Start.png b/docs/discover/images/Discover-Start.png old mode 100644 new mode 100755 index 12ec2f9889bb..437684fdbcd7 Binary files a/docs/discover/images/Discover-Start.png and b/docs/discover/images/Discover-Start.png differ diff --git a/docs/discover/images/add-icon.png b/docs/discover/images/add-icon.png new file mode 100644 index 000000000000..5c5ebbf44400 Binary files /dev/null and b/docs/discover/images/add-icon.png differ diff --git a/docs/discover/images/discover-index-pattern.png b/docs/discover/images/discover-index-pattern.png new file mode 100644 index 000000000000..a9bbc35e363d Binary files /dev/null and b/docs/discover/images/discover-index-pattern.png differ diff --git a/docs/discover/images/document-table-expanded.png b/docs/discover/images/document-table-expanded.png new file mode 100755 index 000000000000..052ffbc9cbcc Binary files /dev/null and b/docs/discover/images/document-table-expanded.png differ diff --git a/docs/discover/images/document-table.png b/docs/discover/images/document-table.png new file mode 100644 index 000000000000..7aca8b14ae1f Binary files /dev/null and b/docs/discover/images/document-table.png differ diff --git a/docs/discover/images/filter-field.png b/docs/discover/images/filter-field.png index dd6ee72df93c..79f49bc8da11 100644 Binary files a/docs/discover/images/filter-field.png and b/docs/discover/images/filter-field.png differ diff --git a/docs/discover/images/visualize-from-discover.png b/docs/discover/images/visualize-from-discover.png new file mode 100644 index 000000000000..17ef6002b19b Binary files /dev/null and b/docs/discover/images/visualize-from-discover.png differ diff --git a/docs/discover/viewing-field-stats.asciidoc b/docs/discover/viewing-field-stats.asciidoc deleted file mode 100644 index 5c4617734753..000000000000 --- a/docs/discover/viewing-field-stats.asciidoc +++ /dev/null @@ -1,14 +0,0 @@ -[[viewing-field-stats]] -== View field data statistics - -From the fields list, you can see how many of the documents in the documents -table contain a particular field, what the top 5 values are, and what -percentage of documents contain each value. - -You can visualize data in various ways. You can only apply the quick visualize -to aggregatable fields. You can visualize the keyword fields, and -they are available in the side bar if you uncheck "Hide missing fields". - -To view field data statistics, click the name of a field in the fields list. - -image:images/filter-field.png[Fields list that displays the top five search results] diff --git a/docs/redirects.asciidoc b/docs/redirects.asciidoc index 833273c7b3ef..ccad3670d3d2 100644 --- a/docs/redirects.asciidoc +++ b/docs/redirects.asciidoc @@ -148,3 +148,24 @@ This content has moved. See This content has moved. See {ref}/index-mgmt.html[Index management]. +[role="exclude",id="field-filter"] +== Filter by field + +This content has moved. See <>. + + +[role="exclude",id="document-context"] +== View a document in context + +This content has moved. See <>. + + +[role="exclude",id="document-data"] +== View document data + +This content has moved. See <>. + +[role="exclude",id="viewing-field-stats"] +== View field data statistics + +This content has moved. See <>. diff --git a/docs/settings/ssl-settings.asciidoc b/docs/settings/ssl-settings.asciidoc deleted file mode 100644 index 3a0a474d9d59..000000000000 --- a/docs/settings/ssl-settings.asciidoc +++ /dev/null @@ -1,99 +0,0 @@ -[float] -=== {component} TLS/SSL settings -You can configure the following TLS/SSL settings. If the settings are not -configured, the default values are used. See -{ref}/security-settings.html[Default TLS/SSL Settings]. - -ifdef::server[] -+{ssl-prefix}.ssl.enabled+:: -Used to enable or disable TLS/SSL. The default is `false`. -endif::server[] - -+{ssl-prefix}.ssl.supported_protocols+:: -Supported protocols with versions. Valid protocols: `SSLv2Hello`, -`SSLv3`, `TLSv1`, `TLSv1.1`, `TLSv1.2`. Defaults to `TLSv1.2`, `TLSv1.1`, -`TLSv1`. Defaults to the value of `xpack.ssl.supported_protocols`. - -ifdef::server[] -+{ssl-prefix}.ssl.client_authentication+:: -Controls the server's behavior in regard to requesting a certificate -from client connections. Valid values are `required`, `optional`, and `none`. -`required` forces a client to present a certificate, while `optional` -requests a client certificate but the client is not required to present one. -ifndef::client-auth-default[] -Defaults to the value of `xpack.ssl.client_authentication`. -endif::client-auth-default[] -ifdef::client-auth-default[] -Defaults to +{client-auth-default}+. -endif::client-auth-default[] -endif::server[] - -ifdef::verifies[] -+{ssl-prefix}.ssl.verification_mode+:: -Controls the verification of certificates. Valid values are `none`, -`certificate`, and `full`. Defaults to the value of `xpack.ssl.verification_mode`. -endif::verifies[] - -+{ssl-prefix}.ssl.cipher_suites+:: -Supported cipher suites can be found in Oracle's http://docs.oracle.com/javase/8/docs/technotes/guides/security/SunProviders.html[ -Java Cryptography Architecture documentation]. Defaults to the value of -`xpack.ssl.cipher_suites`. - -[float] -==== {component} TLS/SSL key and trusted certificate settings - -The following settings are used to specify a private key, certificate, and the -trusted certificates that should be used when communicating over an SSL/TLS connection. -If none of the settings are specified, the default values are used. -See {ref}/security-settings.html[Default TLS/SSL settings]. - -ifdef::server[] -A private key and certificate must be configured. -endif::server[] -ifndef::server[] -A private key and certificate are optional and would be used if the server requires client authentication for PKI -authentication. -endif::server[] -If none of the settings bare specified, the defaults values are used. -See {ref}/security-settings.html[Default TLS/SSL settings]. - -[float] -===== PEM encoded files - -When using PEM encoded files, use the following settings: - -+{ssl-prefix}.ssl.key+:: -Path to a PEM encoded file containing the private key. - -+{ssl-prefix}.ssl.key_passphrase+:: -The passphrase that will be used to decrypt the private key. This value is -optional as the key may not be encrypted. - -+{ssl-prefix}.ssl.certificate+:: -Path to a PEM encoded file containing the certificate (or certificate chain) -that will be presented when requested. - -+{ssl-prefix}.ssl.certificate_authorities+:: -List of paths to the PEM encoded certificate files that should be trusted. - -[float] -===== Java keystore files - -When using Java keystore files (JKS), which contain the private key, certificate -and certificates that should be trusted, use the following settings: - -+{ssl-prefix}.ssl.keystore.path+:: -Path to the keystore that holds the private key and certificate. - -+{ssl-prefix}.ssl.keystore.password+:: -Password to the keystore. - -+{ssl-prefix}.ssl.keystore.key_password+:: -Password for the private key in the keystore. Defaults to the -same value as +{ssl-prefix}.ssl.keystore.password+. - -+{ssl-prefix}.ssl.truststore.path+:: -Path to the truststore file. - -+{ssl-prefix}.ssl.truststore.password+:: -Password to the truststore. diff --git a/docs/setup/settings.asciidoc b/docs/setup/settings.asciidoc index 2f2c87ca9c7d..efc7a1b93093 100644 --- a/docs/setup/settings.asciidoc +++ b/docs/setup/settings.asciidoc @@ -512,8 +512,8 @@ In addition to this setting, trusted certificates may be specified via <