Adjust file realm docs #52471
Merged
Adjust file realm docs #52471
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The existing wording in the file realm docs proved confusing for users as it seemed to indicate that it should _only_ be used as a fallback/recovery realm and that it is not a first class realm. This change attempts to clarify this and point out that recovery is _a_ use case for the file realm but not the only intended one.
jkakavas
added
>docs
|
Pinging @elastic/es-docs (>docs) |
|
Pinging @elastic/es-security (:Security/Authentication) |
lcawl
reviewed
Feb 18, 2020
| The `file` realm is very useful as a fallback/recovery realm, for instance in cases where | ||
| the cluster is unresponsive or the security index is unavailable, or when you forget the | ||
| password for your administrative users. | ||
| In this type of scenarios, the `file` realm is a convenient way out - you can |
There was a problem hiding this comment.
Suggested change
| In this type of scenarios, the `file` realm is a convenient way out - you can | |
| In this type of scenario, the `file` realm is a convenient way out - you can |
lcawl
reviewed
Feb 18, 2020
| (no one remembers their username/password). In this type of scenarios, the `file` | ||
| realm is your only way out - you can define a new `admin` user in the `file` realm | ||
| and use it to log in and reset the credentials of all other users. | ||
| The `file` realm is very useful as a fallback/recovery realm, for instance in cases where |
There was a problem hiding this comment.
Not mandatory, but I prefer spelling out "/" and splitting this long sentence in two:
Suggested change
| The `file` realm is very useful as a fallback/recovery realm, for instance in cases where | |
| The `file` realm is very useful as a fallback or recovery realm. For example, use it in cases where |
lcawl
approved these changes
Feb 18, 2020
tvernum
reviewed
Feb 19, 2020
There was a problem hiding this comment.
I feel like this softens the wording too much
I think we can away people away from over using the file realm by explicitly point out the the file realm users cannot be retrieved from the API or the Kibana Security Management UI.
I can come up with some possible wording when I'm not on mobile.
Fair enough
I felt like the "important" above + the docs on the user APIs are enough, but you're probably right, I'll amend this to spell it out |
|
How about now @tvernum ? |
jkakavas
added a commit
to jkakavas/elasticsearch
that referenced
this pull request
Feb 25, 2020
The existing wording in the file realm docs proved confusing for users as it seemed to indicate that it should _only_ be used as a fallback/recovery realm and that it is not a first class realm. This change attempts to clarify this and point out that recovery is _a_ use case for the file realm but not the only intended one.
jkakavas
added a commit
to jkakavas/elasticsearch
that referenced
this pull request
Feb 25, 2020
The existing wording in the file realm docs proved confusing for users as it seemed to indicate that it should _only_ be used as a fallback/recovery realm and that it is not a first class realm. This change attempts to clarify this and point out that recovery is _a_ use case for the file realm but not the only intended one.
jkakavas
added a commit
to jkakavas/elasticsearch
that referenced
this pull request
Feb 25, 2020
The existing wording in the file realm docs proved confusing for users as it seemed to indicate that it should _only_ be used as a fallback/recovery realm and that it is not a first class realm. This change attempts to clarify this and point out that recovery is _a_ use case for the file realm but not the only intended one.
jkakavas
added a commit
that referenced
this pull request
Feb 25, 2020
The existing wording in the file realm docs proved confusing for users as it seemed to indicate that it should _only_ be used as a fallback/recovery realm and that it is not a first class realm. This change attempts to clarify this and point out that recovery is _a_ use case for the file realm but not the only intended one.
jkakavas
added a commit
that referenced
this pull request
Feb 25, 2020
The existing wording in the file realm docs proved confusing for users as it seemed to indicate that it should _only_ be used as a fallback/recovery realm and that it is not a first class realm. This change attempts to clarify this and point out that recovery is _a_ use case for the file realm but not the only intended one.
jkakavas
added a commit
that referenced
this pull request
Feb 25, 2020
The existing wording in the file realm docs proved confusing for users as it seemed to indicate that it should _only_ be used as a fallback/recovery realm and that it is not a first class realm. This change attempts to clarify this and point out that recovery is _a_ use case for the file realm but not the only intended one.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The existing wording in the file realm docs proved confusing
for users as it seemed to indicate that it should only be
used as a fallback/recovery realm and that it is not a
first class realm.
This change attempts to clarify this and point out that recovery
is a use case for the file realm but not the only intended one.