Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Always enable file and native realms unless explicitly disabled #78405

Merged
merged 4 commits into from
Sep 29, 2021
Merged

[DOCS] Always enable file and native realms unless explicitly disabled #78405

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
27b45b3
[DOCS] Always enable file and native realms by default
jrodewig Sep 28, 2021
610e8b2
reword
jrodewig Sep 28, 2021
fdc30c6
Update docs/reference/migration/migrate_8_0/security.asciidoc
jrodewig Sep 29, 2021
f6742d7
Update docs/reference/migration/migrate_8_0/security.asciidoc
jrodewig Sep 29, 2021
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
35 changes: 35 additions & 0 deletions docs/reference/migration/migrate_8_0/security.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,41 @@
//Installation and Upgrade Guide

//tag::notable-breaking-changes[]
.The file and native realms are now enabled unless explicitly disabled.
[%collapsible]
====
*Details* +
The file and native realms are now enabled unless explicitly disabled. If
explicitly disabled, the file and native realms remain disabled at all times.

Previously, the file and native realms had the following implicit behaviors:

* If the file and native realms were not configured, they were implicitly disabled
if any other realm was configured.

* If no other realm was available because realms were not configured or
explicitly disabled, the file and native realms were enabled, even if explicitly
disabled.
jrodewig marked this conversation as resolved.
Show resolved Hide resolved

*Impact* +
To explicilty disable the file or native realm, set the respective
`file.<realm-name>.enabled` or `native.<realm-name>.enabled` setting to `false`
under the `xpack.security.authc.realms` namespace in `elasticsearch.yml`.

The following configuration example disables the native realm, named `realm1`,
and the file realm, named `realm2`:
jrodewig marked this conversation as resolved.
Show resolved Hide resolved

[source,yaml]
----
xpack.security.authc.realms:

native.realm1.enabled: false
file.realm2.enabled: false

...
----
====

.The realm `order` setting is now required.
[%collapsible]
====
Expand Down