From 4544ab2dbbb2c005916d7bb0db459ed4c115879b Mon Sep 17 00:00:00 2001 From: James Rodewig <40268737+jrodewig@users.noreply.github.com> Date: Wed, 29 Sep 2021 09:10:30 -0400 Subject: [PATCH] [DOCS] Always enable file and native realms unless explicitly disabled (#78405) * [DOCS] Always enable file and native realms by default Adds an 8.0 breaking change for PR #69096. The copy is based on the 7.13 deprecation notice added with PR #69320. * reword * Update docs/reference/migration/migrate_8_0/security.asciidoc Co-authored-by: Yang Wang * Update docs/reference/migration/migrate_8_0/security.asciidoc Co-authored-by: Yang Wang Co-authored-by: Yang Wang --- .../migration/migrate_8_0/security.asciidoc | 34 +++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/docs/reference/migration/migrate_8_0/security.asciidoc b/docs/reference/migration/migrate_8_0/security.asciidoc index e9179430e16e8..9a91b4b503cbc 100644 --- a/docs/reference/migration/migrate_8_0/security.asciidoc +++ b/docs/reference/migration/migrate_8_0/security.asciidoc @@ -6,6 +6,40 @@ //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 either not configured, +not perrmitted by license, or explicitly disabled, the file and native realms +were enabled, even if explicitly disabled. + +*Impact* + +To explicilty disable the file or native realm, set the respective +`file..enabled` or `native..enabled` setting to `false` +under the `xpack.security.authc.realms` namespace in `elasticsearch.yml`. + +The following configuration example disables the native realm and the file realm. + +[source,yaml] +---- +xpack.security.authc.realms: + + native.realm1.enabled: false + file.realm2.enabled: false + + ... +---- +==== + .The realm `order` setting is now required. [%collapsible] ====