Skip to content

Commit ab09f8f

Browse files
committed
style edits
1 parent 903fac9 commit ab09f8f

File tree

2 files changed

+99
-95
lines changed

2 files changed

+99
-95
lines changed

deploy-manage/users-roles/cluster-or-deployment-auth/file-based.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ mapped_pages:
55
- https://www.elastic.co/guide/en/cloud-on-k8s/current/k8s-users-and-roles.html
66
applies_to:
77
deployment:
8-
self: all
9-
eck: all
8+
self: ga
9+
eck: ga
1010
products:
1111
- id: elasticsearch
1212
- id: cloud-kubernetes
@@ -16,9 +16,7 @@ products:
1616

1717
You can manage and authenticate users with the built-in `file` realm. With the `file` realm, users are defined in local files on each node in the cluster.
1818

19-
The `file` realm is useful as a fallback or recovery realm. For example 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 scenario, the `file` realm is a convenient workaround: 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. For more information, see [file-based recovery](/troubleshoot/elasticsearch/file-based-recovery.md).
20-
21-
Refer to [enabling a file realm user for recovery](https://www.youtube.com/watch?v=sueO7sz1buw) for a video walkthrough.
19+
The `file` realm is useful as a fallback or recovery realm. For example, you might use this realm 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 scenario, the `file` realm is a convenient workaround: 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. For a walkthrough of this process, refer to [](/troubleshoot/elasticsearch/file-based-recovery.md). Refer to [enabling a file realm user for recovery](https://www.youtube.com/watch?v=sueO7sz1buw) for a video walkthrough.
2220

2321
::::{important}
2422
* In self-managed deployments, as the administrator of the cluster, it is your responsibility to ensure the same users are defined on every node in the cluster. The {{stack}} {{security-features}} do not deliver any mechanism to guarantee this.
@@ -27,7 +25,7 @@ Refer to [enabling a file realm user for recovery](https://www.youtube.com/watch
2725

2826
## Configure a file realm [file-realm-configuration]
2927

30-
You don’t need to explicitly configure a `file` realm. The `file` and `native` realms are added to the realm chain by default. Unless configured otherwise, the `file` realm is added first, followed by the `native` realm. You can define only one `file` realm per node.
28+
You don’t need to explicitly configure a `file` realm. The `file` and `native` realms are added to the realm chain by default. Unless configured otherwise, the `file` realm is added first, followed by the `native` realm. You can define only one `file` realm on each node.
3129

3230
1. (Optional) Add a realm configuration to [`elasticsearch.yml`](/deploy-manage/stack-settings.md) under the `xpack.security.authc.realms.file` namespace. At a minimum, you must set the realm’s `order` attribute.
3331

@@ -37,15 +35,17 @@ You don’t need to explicitly configure a `file` realm. The `file` and `native`
3735
xpack.security.authc.realms.file.file1.order: 0
3836
```
3937
40-
2. (Optional) For self-managed deployments, you may change how often the `users` and `users_roles` files are checked.
38+
2. (Optional) For self-managed deployments, you can change how often the `users` and `users_roles` files are checked.
4139

4240
By default, {{es}} checks these files for changes every 5 seconds. You can change this default behavior by changing the `resource.reload.interval.high` setting in the [`elasticsearch.yml`](/deploy-manage/stack-settings.md) file.
4341

4442
:::{{warning}}
4543
Because `resource.reload.interval.high` is a common setting in {{es}}, changing its value may effect other schedules in the system.
4644
:::
4745

48-
3. In self-managed deployments, if either prior setting is modified, you will need to [rolling restart](/deploy-manage/maintenance/start-stop-services/full-cluster-restart-rolling-restart-procedures.md#restart-cluster-rolling) those {{es}} nodes for your changes to take effect. In {{eck}}, changes are automatically propagated.
46+
3. In self-managed deployments, if of these settings is modified, perform a [rolling restart](/deploy-manage/maintenance/start-stop-services/full-cluster-restart-rolling-restart-procedures.md#restart-cluster-rolling) of the {{es}} nodes for your changes to take effect.
47+
48+
In {{eck}}, changes are automatically propagated.
4949

5050

5151
## Add users
@@ -110,13 +110,13 @@ In a self-managed cluster, you can edit the contents of `ES_PATH_CONF/users` and
110110
:::{tab-item} {{eck}}
111111
You can pass `users` and `user_roles` files to {{eck}} using a file realm secret:
112112
113-
```yaml
113+
```yaml subs=true
114114
apiVersion: elasticsearch.k8s.elastic.co/v1
115115
kind: Elasticsearch
116116
metadata:
117117
name: elasticsearch-sample
118118
spec:
119-
version: 8.16.1
119+
version: {{version.stack}}
120120
auth:
121121
fileRealm:
122122
- secretName: my-filerealm-secret-1

0 commit comments

Comments
 (0)