Commit graph

249 commits

Author SHA1 Message Date
Jonathan Buttner
9623e522c3
[ML] Inference document configurable settings (#108273)
* Starting to document various inference settings

* Finish settings

* Update docs/reference/settings/inference-settings.asciidoc

Co-authored-by: Max Hniebergall <137079448+maxhniebergall@users.noreply.github.com>

* Update docs/reference/settings/inference-settings.asciidoc

Co-authored-by: István Zoltán Szabó <istvan.szabo@elastic.co>

* Update docs/reference/settings/inference-settings.asciidoc

Co-authored-by: István Zoltán Szabó <istvan.szabo@elastic.co>

* Update docs/reference/settings/inference-settings.asciidoc

Co-authored-by: István Zoltán Szabó <istvan.szabo@elastic.co>

* Update docs/reference/settings/inference-settings.asciidoc

Co-authored-by: István Zoltán Szabó <istvan.szabo@elastic.co>

* Update docs/reference/settings/inference-settings.asciidoc

Co-authored-by: István Zoltán Szabó <istvan.szabo@elastic.co>

* Update docs/reference/settings/inference-settings.asciidoc

Co-authored-by: István Zoltán Szabó <istvan.szabo@elastic.co>

* Update docs/reference/settings/inference-settings.asciidoc

Co-authored-by: István Zoltán Szabó <istvan.szabo@elastic.co>

---------

Co-authored-by: Max Hniebergall <137079448+maxhniebergall@users.noreply.github.com>
Co-authored-by: István Zoltán Szabó <istvan.szabo@elastic.co>
2024-05-07 10:19:08 -04:00
florent-leborgne
0c500e5264
Remove Beta label for RCS2.0 from 8.14 (#108030) 2024-05-02 15:43:21 +02:00
Liam Thompson
33a71e3289
[DOCS] Refactor book-scoped variables in docs/reference/index.asciidoc (#107413)
* Remove `es-test-dir` book-scoped variable

* Remove `plugins-examples-dir` book-scoped variable

* Remove `:dependencies-dir:` and `:xes-repo-dir:` book-scoped variables

- In `index.asciidoc`, two variables (`:dependencies-dir:` and `:xes-repo-dir:`) were removed.
- In `sql/index.asciidoc`, the `:sql-tests:` path was updated to fuller path
- In `esql/index.asciidoc`, the `:esql-tests:` path was updated idem

* Replace `es-repo-dir` with `es-ref-dir`

* Move `:include-xpack: true` to few files that use it, remove from index.asciidoc
2024-04-17 14:37:07 +02:00
Yang Wang
3d53707adc
[Doc] Remove invalid watcher ssl enabled settings (#106901)
In #99115 we updated the ssl settings template to cover new features. It
inadvertently introduced a doc bug that show invalied ssl.enabled
settings for watcher HTTP and email. This PR removes them.
2024-03-29 12:53:20 +01:00
Albert Zaharovits
6fec837e32
[Doc] API Key deletion settings (#105392)
This documents API Key delete settings.
2024-02-18 17:38:56 +02:00
Slobodan Adamović
1f0ea3e015
[Doc] Mark secure_bind_password settings as reloadable (#105448)
This is a followup to #104320, which updates the docs for `secure_bind_password` 
settings and marks them as reloadable.
2024-02-13 14:04:32 +01:00
David Roberts
e8288fbaa8
[ML] Improve docs around ML nodes and xpack.ml.enabled (#105199)
Since these docs were originally written there have been a couple
of changes:

1. We now support aarch64 as well as x86_64, so the SSE4.2 guidance
   needed clarification.
2. ML is more deeply embedded into Elasticsearch functionality
   across nodes that are not ML nodes. For example, ingest pipelines
   now routinely use ML, and, in the near future, index mappings
   will too in the form of semantic text. Although we cannot mandate
   that xpack.ml.enabled is set uniformly across the cluster, as
   that would be a breaking change, we should say ever more strongly
   that ML must be enabled on all nodes if all ML functionality is to
   work correctly. The primary reason for wanting to disable ML is
   hardware incompatibility, and if ML is disabled for that reason
   then it should not be used at all.
2024-02-06 16:20:46 +00:00
Jake Landis
15258c8688
Minor doc fixes for PKI realm (#103831)
Remove the reference to the transport client and clarify the usage of username_pattern
2024-01-09 09:49:59 -06:00
Jake Landis
64026130fd
Add setting xpack.security.fips_mode.required_providers (#103483)
This commit adds an optional setting xpack.security.fips_mode.required_providers
to allow enforcing specific JCE/JSSE security providers while running in FIPS mode.

If running in FIPS mode with this value set and the required provider(s) is not found
an exception will be thrown during startup preventing the service from starting.
2023-12-21 12:11:40 -06:00
Johannes Fredén
39d9ce8f89
[DOCS] Update SAML guide to reference attribute_delimiters.group (#103102)
This is a follow up PR from
https://github.com/elastic/elasticsearch/pull/102769. The SAML realm can
now be configured to split the `groups` attribute by delimiter, this
updates the docs to mention that.
2023-12-08 05:11:11 -05:00
Johannes Fredén
077b47db37
Add support for splitting saml groups by delimiter (#102769)
* Add support for splitting saml groups by delimiter
2023-12-07 08:55:46 +01:00
Johannes Fredén
70b15945a9
Add ldap user metadata mappings for full name and email (#102925)
* Add ldap user metadata mappings for full name and email
2023-12-06 13:28:21 +01:00
Andrei Dan
2f0e58520e
Document DSL setting to signalling lack of progress for index (#101635) 2023-11-01 08:44:38 +00:00
Andrei Dan
74ea04fb2d
[DOCS] document tail merging and create tutorial for migrating to DSL (#101117)
This documents tail merging, the enabled flag, and
adds a tutorial to migrate a data stream from ILM to DSL.
2023-10-25 11:12:36 +01:00
Jake Landis
19e3036458
Support rotatating the JWT shared secret (#99278)
This commit adds support to reload the JWT shared secret.
Notably this commit also includes support for a rotatable secret which includes
support for a configurable grace period where the elder value (after rotation)
is still accessible. This allows a time bound leniency where both values are
valid at the same time to help mitigate tightly coupled systems rotations.
The rotatable secret currently only supports checking if it is set or it matches
an external secret. However, future updates will accept a function that
can be be used as input to a 3rd party system that can try the current secret
but automatically fall back to the prior secret if that fails during the grace period.
The implementation of rotatable secret uses a StampedLock with optimistic
reads to help ensure minimal performance impact for the reading and expiry
of the secret.
2023-09-20 09:56:36 -05:00
Jake Landis
369c5f4926
Fix doc for deprecated TLS settings (#98513) 2023-09-19 11:11:54 -05:00
Yang Wang
ebe4fe9f15
[Doc] Add links to the new API key based remote cluster page (#99115)
This PR adds links to the new API key based remote cluster page in
multiple places.

Relates: #98330
2023-09-01 06:08:49 -04:00
Yang Wang
f307e6fedd
[Docs] Document IP filtering for RCS 2.0 (#98553)
This PR adds documentation for RCS 2.0 IP filtering.

Relates: #98472
2023-08-24 23:23:40 -04:00
Andrei Dan
01ed7de99f
GA the data stream lifecycle (#98644)
This makes the data stream lifecycle generally available. This will allow
data streams to take advantage of a native simplified and resilient
lifecycle implementation.
2023-08-21 17:28:54 +01:00
Yang Wang
b337f9b6f3
[Docs] Misc doc update for RCS 2.0 (#98472)
This PR adds docs for the following items: * Remote indices privileges *
Remote cluster network settings * Remote cluster security settings * New
privileges * New response field for RemoteInfo API

List of preview pages: * [Remote indices in defining
roles](https://elasticsearch_98472.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/defining-roles.html#roles-remote-indices-priv)
* [Remote indices in PutRole
API](https://elasticsearch_98472.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/security-api-put-role.html#security-api-put-role-request-body)
* [Remote cluster server SSL
settings](https://elasticsearch_98472.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/security-settings.html#_remote_cluster_server_api_key_based_model_tlsssl_settings)
* [Remote cluster client SSL
settings](https://elasticsearch_98472.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/security-settings.html#_remote_cluster_client_api_key_based_model_tlsssl_settings)
* [Remote cluster network
settings](https://elasticsearch_98472.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/modules-network.html#remote-cluster-network-settings)
and
[here](https://elasticsearch_98472.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/modules-network.html#common-network-settings)
* [Remote cluster credentials
setting](https://elasticsearch_98472.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/remote-clusters-settings.html)
* [New
privileges](https://elasticsearch_98472.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/security-privileges.html)
* [New response field for RemoteInfo
API](https://elasticsearch_98472.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/cluster-remote-info.html#cluster-remote-info-api-response-body)
2023-08-15 20:11:21 -04:00
Jake Landis
80cc651614
Fix jwt and oidc doc (#97942)
This commit corrects the following issues with JWT and OIDC `jwkset_path` documentation:
* only https is supported for the JWT realm (OIDC support both https and http)
* JWT realm does not use a file watcher to reload the file every 5 seconds
* simplify "path" to  "file name" ..technically it is resolved path, but 99% of the time it will be just 
     a file name in the config directory and "path" is ambiguous
* remove special mention of using the absolute path in cloud. .. this is an unnecessary implementation 
     detail and the only setting (of many) that calls out the cloud config directly by absolute path
* ensure the 2 different JWT documentations are the same
* make mention of when the JWT file will be reloaded (it is not backed by the file watcher, only OIDC is)
2023-08-15 15:50:17 -05:00
Keith Massey
841050043e
Hiding data stream lifecycle documentation in released docs (#98334) 2023-08-10 08:18:05 -05:00
Mary Gouseti
9aed799b51
HealthPeriodicLogger disabled by default (#97722)
Co-authored-by: Matt Culbreth <matt.culbreth@elastic.co>
2023-07-18 10:18:23 +03:00
Andrei Dan
22bc45a82f
Change default value for data stream lifecycle poll interval to 5 mins (#97583) 2023-07-17 06:52:45 -04:00
Matt Culbreth
da81686125
Add Health API Periodic Logging (#96772)
Logs the health status of the cluster and of each health indicator as observed by the Health API
2023-07-05 11:17:18 -04:00
Mary Gouseti
1abd51b167
Start with data stream lifecycle documentation (#95326) 2023-06-28 16:18:05 +03:00
Pablo Alcantar Morales
1c8c4d80f7
Document the enhancements to ILM Health Indicator (#96980) 2023-06-27 10:54:36 +02:00
debadair
777598d602
[DOCS] Remove redirect pages (#88738)
* [DOCS] Remove manual redirects

* [DOCS] Removed refs to modules-discovery-hosts-providers

* [DOCS] Fixed broken internal refs

* Fixing bad cross links in ES book, and adding redirects.asciidoc[] back into docs/reference/index.asciidoc.

* Update docs/reference/search/point-in-time-api.asciidoc

Co-authored-by: James Rodewig <james.rodewig@elastic.co>

* Update docs/reference/setup/restart-cluster.asciidoc

Co-authored-by: James Rodewig <james.rodewig@elastic.co>

* Update docs/reference/sql/endpoints/translate.asciidoc

Co-authored-by: James Rodewig <james.rodewig@elastic.co>

* Update docs/reference/snapshot-restore/restore-snapshot.asciidoc

Co-authored-by: James Rodewig <james.rodewig@elastic.co>

* Update repository-azure.asciidoc

* Update node-tool.asciidoc

* Update repository-azure.asciidoc

---------

Co-authored-by: amyjtechwriter <61687663+amyjtechwriter@users.noreply.github.com>
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
Co-authored-by: Amy Jonsson <amy.jonsson@elastic.co>
Co-authored-by: James Rodewig <james.rodewig@elastic.co>
2023-05-24 12:32:46 +01:00
István Zoltán Szabó
6db4d906ad
[DOCS] Document xpack.ml.model_repository setting (#95789) 2023-05-03 17:19:13 +02:00
DeDe Morton
a6c7c1f1e4
[DOCS] Describe how to use Elastic Agent to monitor Elasticsearch (#94348)
* [DOCS] Describe how to use Elastic Agent to monitor Elasticsearch

* Temporarily fix doc build

* Add question about showing Elastic Agent metrics in the monitoring UI

* Apply changes from review

* Activate link to Kibana docs

* Fix broken link

* Update docs/reference/monitoring/indices.asciidoc
2023-03-24 09:00:21 -07:00
Tim Vernum
34c270c023
Do not fail node if SAML HTTP metadata is unavailable (#92810)
This commit changes the SAML realm to use placeholder metadata (UnresolvedEntity) when the real metadata cannot be loaded over HTTPS - unless metadata.http.fail_on_error is set to true.

All future use of the realm will fail until the metadata is available, but this change allows the node to bootstrap successfully.
2023-02-16 17:32:01 +11:00
Yang Wang
9ce06fddc4
JWT realm documentation update - take 2 (#92539)
This PR is another round of documentation update for the JWT realm with the goal to achieve better clarity, differentiating more between the two token types and encourage readers to choose between them carefully.

Relates: #92409
2023-01-23 12:40:55 +11:00
Abdon Pijpelink
648d80e517
[DOCS] Add ssl.verification_mode to secure settings (#93083)
Co-authored-by: Adam Locke <adam.locke@elastic.co>
2023-01-19 17:13:55 +01:00
Yang Wang
56036676cb
JWT Realm - documentation update (#92409)
* wip

* Initial update for the JWT realm doc

* Apply suggestions from code review

Co-authored-by: amyjtechwriter <61687663+amyjtechwriter@users.noreply.github.com>

Co-authored-by: amyjtechwriter <61687663+amyjtechwriter@users.noreply.github.com>
2022-12-19 12:22:24 +00:00
Anthony McGlone
d80f4a68af
[DOCS] Add missing xpack security setting (#91995)
* [DOCS] Add missing xpack security setting

* [DOCS] CR feedback for missing xpack security setting

* Update docs/reference/settings/security-settings.asciidoc

Co-authored-by: Abdon Pijpelink <abdon.pijpelink@elastic.co>

Co-authored-by: Abdon Pijpelink <abdon.pijpelink@elastic.co>
2022-12-01 14:50:06 +01:00
Mary Gouseti
cfd23d512f
Disk indicator troubleshooting guides (#90504) 2022-10-14 15:24:21 +02:00
Paramdeep Singh
34ff7a9d98
Consolidated Circuit Breaker documentation to include EQL and ML infer (#90809)
Fixes #85851 

Co-authored-by: Iraklis Psaroudakis <kingherc@gmail.com>
2022-10-14 14:33:52 +03:00
Joe Gallo
21356162eb
ILM don't rollover empty indices (#89557) 2022-09-19 18:37:41 -04:00
James Baiera
c570d3e88e
Add advice on restoring ILM indices into unmanaged state (#89140) 2022-09-11 23:29:54 -04:00
Keith Massey
e61bfcfab8
Documenting master_is_stable health API settings (#87901) 2022-07-26 12:02:38 -05:00
James Baiera
6ce5f73e97
Add health user action for unhealthy SLM policy failure counts (#88523)
This PR adds a user action to the SLM health indicator which checks each SLM policy's invocations 
since last success field and reports degraded health (YELLOW) in the event that any policy is at or 
above the failure threshold (default is 5 failures in a row).
2022-07-25 15:58:20 -04:00
Yang Wang
36336fe471
Add setting for tcp_keepalive for oidc back-channel (#87868)
This PR adds a new setting to enable tcp keepalive probes for the
connections used by the oidc back-channel communication. It defaults to
true as tcp keepalive is generally useful for ES.

Relates: #87773
2022-07-07 11:41:14 +09:30
Yang Wang
f075d505c5
Automatically close idle connections in OIDC back-channel (#87773)
In some environment, the back-channel connection can be dropped
without sending a TCP RST to ES. When that happens, reusing the same
connection results into timeout error.

This PR adds a new http.connection_pool_ttl setting to control how long
a connection in the OIDC back-channel pool can be idle before it is
closed. This allows ES to more actively close idle connections to avoid
the timeout issue.

The new setting has a 3min default which means idle connections are
closed every 3 min if server response does not specify a shorter keep-alive.

Resolves: #75515
2022-06-20 22:31:17 +10:00
David Kilfoyle
40e9f3097c
[DOCS] Add TSDS docs, take two (#87703)
* Revert "Revert "[DOCS] Add TSDS docs (#86905)" (#87702)"

This reverts commit 0c86d7b9b2.

* First fix to tests

* Add data_stream object to index template

* small rewording

* Add enable data stream object in gradle example setup

* Add bullet about data stream must be enabled in template
2022-06-16 12:44:10 -04:00
David Kilfoyle
0c86d7b9b2
Revert "[DOCS] Add TSDS docs (#86905)" (#87702)
Reverts elastic/elasticsearch#86905
2022-06-15 13:32:12 -04:00
David Kilfoyle
d57f4ac2c6
[DOCS] Add TSDS docs (#86905)
* [DOCS] Add TSDB docs

* Update docs/build.gradle

Co-authored-by: Adam Locke <adam.locke@elastic.co>

* Address Nik's comments, part 1

* Address Nik's comments, part deux

* Reword write index

* Add feature flags

* Wrap one more section in feature flag

* Small fixes

* set index.routing_path to optional

* Update storage reduction value

* Update create index template code example

Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
Co-authored-by: Adam Locke <adam.locke@elastic.co>
2022-06-15 12:22:07 -04:00
Przemysław Witek
8656a29675
[Transform] Implement per-transform num_failure_retries setting. (#87361) 2022-06-09 15:22:06 +02:00
Yang Wang
f5ceed19fc
User Profile - remove feature flag (#87383)
The feature flag is no longer necessary in the 8.4 release cycle. The
feature itself is still in beta.
2022-06-08 10:18:18 -04:00
Adam Locke
03f75416b5
[DOCS] JWT doc enhancements (#86411)
* [DOCS] Add examples for run-as privileges

* Add JWT run_as and realm examples

* Adding examples for run_as, moving that section, and other 🔥 edits

* Add section headers 🖍️

* Incorporate Justin's suggestions from code review

Co-authored-by: Justin Cranford <89857999+justincr-elastic@users.noreply.github.com>

* Edits and clarifications based on reviewer feedback.

* Clarify run_as privilege in roles

* Fix typo

* Add redirect to fix cross-book linking

* Expand the run_as examples

* Update request

* Remove NOTCONSOLE from curl commands

* Update run_as example and expand section on unsupported realms

* Split note for unsupported realms

* Remove note that OAuth2 tokens aren't supported and clarify run_as from unsupported realms

* Apply Justin's suggestions from code review

Co-authored-by: Justin Cranford <89857999+justincr-elastic@users.noreply.github.com>

* Update support for different authentication mechanisms

* Apply suggestions from code review

Co-authored-by: Justin Cranford <89857999+justincr-elastic@users.noreply.github.com>

* Add note from review, cleanup, and typo fixes

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
Co-authored-by: Justin Cranford <89857999+justincr-elastic@users.noreply.github.com>
2022-06-03 18:12:36 -04:00
Justin Cranford
7b75311382
List rp.signature_algorithm supported values in docs (#87365) 2022-06-03 13:56:00 -04:00