Skip to content

Commit 101d675

Browse files
authored
[DOCS] Replace CONFIG_DIR with ES_PATH_CONF (#31635)
1 parent f924835 commit 101d675

File tree

9 files changed

+18
-18
lines changed

9 files changed

+18
-18
lines changed

docs/reference/settings/security-settings.asciidoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -328,7 +328,7 @@ role mappings are not considered. Defaults to `false`.
328328
`files.role_mapping`::
329329
The {xpack-ref}/security-files.html[location] for the {xpack-ref}/mapping-roles.html#mapping-roles[
330330
YAML role mapping configuration file]. Defaults to
331-
`CONFIG_DIR/role_mapping.yml`.
331+
`ES_PATH_CONF/role_mapping.yml`.
332332

333333
`follow_referrals`::
334334
Specifies whether {security} should follow referrals returned
@@ -494,7 +494,7 @@ considered. Defaults to `false`.
494494

495495
`files.role_mapping`::
496496
The {xpack-ref}/security-files.html[location] for the YAML
497-
role mapping configuration file. Defaults to `CONFIG_DIR/role_mapping.yml`.
497+
role mapping configuration file. Defaults to `ES_PATH_CONF/role_mapping.yml`.
498498

499499
`user_search.base_dn`::
500500
The context to search for a user. Defaults to the root
@@ -719,7 +719,7 @@ for SSL. This setting cannot be used with `certificate_authorities`.
719719
`files.role_mapping`::
720720
Specifies the {xpack-ref}/security-files.html[location] of the
721721
{xpack-ref}/mapping-roles.html[YAML role mapping configuration file].
722-
Defaults to `CONFIG_DIR/role_mapping.yml`.
722+
Defaults to `ES_PATH_CONF/role_mapping.yml`.
723723

724724
`cache.ttl`::
725725
Specifies the time-to-live for cached user entries. A user and a hash of its

x-pack/docs/en/security/auditing/output-logfile.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ audited in plain text when including the request body in audit events.
4747

4848
[[logging-file]]
4949
You can also configure how the logfile is written in the `log4j2.properties`
50-
file located in `CONFIG_DIR`. By default, audit information is appended to the
50+
file located in `ES_PATH_CONF`. By default, audit information is appended to the
5151
`<clustername>_access.log` file located in the standard Elasticsearch `logs` directory
5252
(typically located at `$ES_HOME/logs`). The file rolls over on a daily basis.
5353

x-pack/docs/en/security/authentication/configuring-file-realm.asciidoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
You can manage and authenticate users with the built-in `file` internal realm.
66
All the data about the users for the `file` realm is stored in two files on each
77
node in the cluster: `users` and `users_roles`. Both files are located in
8-
`CONFIG_DIR/` and are read on startup.
8+
`ES_PATH_CONF` and are read on startup.
99

1010
[IMPORTANT]
1111
==============================
@@ -50,7 +50,7 @@ xpack:
5050

5151
. Restart {es}.
5252

53-
. Add user information to the `CONFIG_DIR/users` file on each node in the
53+
. Add user information to the `ES_PATH_CONF/users` file on each node in the
5454
cluster.
5555
+
5656
--
@@ -76,7 +76,7 @@ IMPORTANT: As the administrator of the cluster, it is your responsibility to
7676

7777
--
7878

79-
. Add role information to the `CONFIG_DIR/users_roles` file on each node
79+
. Add role information to the `ES_PATH_CONF/users_roles` file on each node
8080
in the cluster.
8181
+
8282
--

x-pack/docs/en/security/authentication/configuring-ldap-realm.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ xpack:
5656
group_search:
5757
base_dn: "dc=example,dc=com"
5858
files:
59-
role_mapping: "CONFIG_DIR/role_mapping.yml"
59+
role_mapping: "ES_PATH_CONF/role_mapping.yml"
6060
unmapped_groups_as_roles: false
6161
------------------------------------------------------------
6262

x-pack/docs/en/security/authorization/managing-roles.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ see {ref}/security-api-roles.html[Role Management APIs].
137137
=== File-based role management
138138

139139
Apart from the _Role Management APIs_, roles can also be defined in local
140-
`roles.yml` file located in `CONFIG_DIR`. This is a YAML file where each
140+
`roles.yml` file located in `ES_PATH_CONF`. This is a YAML file where each
141141
role definition is keyed by its name.
142142

143143
[IMPORTANT]

x-pack/docs/en/security/reference/files.asciidoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
11
[[security-files]]
22
=== Security Files
33

4-
The {security} uses the following files:
4+
{security} uses the following files:
55

6-
* `CONFIG_DIR/roles.yml` defines the roles in use on the cluster
6+
* `ES_PATH_CONF/roles.yml` defines the roles in use on the cluster
77
(read more <<roles-management-file, here>>).
88

9-
* `CONFIG_DIR/elasticsearch-users` defines the users and their hashed passwords for
9+
* `ES_PATH_CONF/elasticsearch-users` defines the users and their hashed passwords for
1010
the <<file-realm,`file` realm>>.
1111

12-
* `CONFIG_DIR/elasticsearch-users_roles` defines the user roles assignment for the
12+
* `ES_PATH_CONF/elasticsearch-users_roles` defines the user roles assignment for the
1313
the <<file-realm, `file` realm>>.
1414

15-
* `CONFIG_DIR/role_mapping.yml` defines the role assignments for a
15+
* `ES_PATH_CONF/role_mapping.yml` defines the role assignments for a
1616
Distinguished Name (DN) to a role. This allows for LDAP and Active Directory
1717
groups and users and PKI users to be mapped to roles (read more
1818
<<mapping-roles, here>>).
1919

20-
* `CONFIG_DIR/log4j2.properties` contains audit information (read more
20+
* `ES_PATH_CONF/log4j2.properties` contains audit information (read more
2121
<<logging-file, here>>).
2222

2323
[[security-files-location]]

x-pack/docs/en/security/securing-communications/tls-ad.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ xpack:
3737
domain_name: ad.example.com
3838
url: ldaps://ad.example.com:636
3939
ssl:
40-
certificate_authorities: [ "CONFIG_DIR/cacert.pem" ]
40+
certificate_authorities: [ "ES_PATH_CONF/cacert.pem" ]
4141
--------------------------------------------------
4242

4343
The CA cert must be a PEM encoded certificate.

x-pack/docs/en/security/securing-communications/tls-ldap.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ xpack:
2929
order: 0
3030
url: "ldaps://ldap.example.com:636"
3131
ssl:
32-
certificate_authorities: [ "CONFIG_DIR/cacert.pem" ]
32+
certificate_authorities: [ "ES_PATH_CONF/cacert.pem" ]
3333
--------------------------------------------------
3434

3535
The CA certificate must be a PEM encoded.

x-pack/docs/en/security/troubleshooting.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ The role definition might be missing or invalid.
101101
|======================
102102

103103
To help track down these possibilities, add the following lines to the end of
104-
the `log4j2.properties` configuration file in the `CONFIG_DIR`:
104+
the `log4j2.properties` configuration file in the `ES_PATH_CONF`:
105105

106106
[source,properties]
107107
----------------

0 commit comments

Comments
 (0)