Skip to content

Commit

Permalink
[DOCS] Replace CONFIG_DIR with ES_PATH_CONF (#31635)
Browse files Browse the repository at this point in the history
  • Loading branch information
lcawl authored Jun 28, 2018
1 parent f924835 commit 101d675
Show file tree
Hide file tree
Showing 9 changed files with 18 additions and 18 deletions.
6 changes: 3 additions & 3 deletions docs/reference/settings/security-settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -328,7 +328,7 @@ role mappings are not considered. Defaults to `false`.
`files.role_mapping`::
The {xpack-ref}/security-files.html[location] for the {xpack-ref}/mapping-roles.html#mapping-roles[
YAML role mapping configuration file]. Defaults to
`CONFIG_DIR/role_mapping.yml`.
`ES_PATH_CONF/role_mapping.yml`.

`follow_referrals`::
Specifies whether {security} should follow referrals returned
Expand Down Expand Up @@ -494,7 +494,7 @@ considered. Defaults to `false`.

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

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

`cache.ttl`::
Specifies the time-to-live for cached user entries. A user and a hash of its
Expand Down
2 changes: 1 addition & 1 deletion x-pack/docs/en/security/auditing/output-logfile.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ audited in plain text when including the request body in audit events.

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
You can manage and authenticate users with the built-in `file` internal realm.
All the data about the users for the `file` realm is stored in two files on each
node in the cluster: `users` and `users_roles`. Both files are located in
`CONFIG_DIR/` and are read on startup.
`ES_PATH_CONF` and are read on startup.

[IMPORTANT]
==============================
Expand Down Expand Up @@ -50,7 +50,7 @@ xpack:

. Restart {es}.

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

--

. Add role information to the `CONFIG_DIR/users_roles` file on each node
. Add role information to the `ES_PATH_CONF/users_roles` file on each node
in the cluster.
+
--
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ xpack:
group_search:
base_dn: "dc=example,dc=com"
files:
role_mapping: "CONFIG_DIR/role_mapping.yml"
role_mapping: "ES_PATH_CONF/role_mapping.yml"
unmapped_groups_as_roles: false
------------------------------------------------------------

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ see {ref}/security-api-roles.html[Role Management APIs].
=== File-based role management

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

[IMPORTANT]
Expand Down
12 changes: 6 additions & 6 deletions x-pack/docs/en/security/reference/files.asciidoc
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
[[security-files]]
=== Security Files

The {security} uses the following files:
{security} uses the following files:

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

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

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

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

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

[[security-files-location]]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ xpack:
domain_name: ad.example.com
url: ldaps://ad.example.com:636
ssl:
certificate_authorities: [ "CONFIG_DIR/cacert.pem" ]
certificate_authorities: [ "ES_PATH_CONF/cacert.pem" ]
--------------------------------------------------

The CA cert must be a PEM encoded certificate.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ xpack:
order: 0
url: "ldaps://ldap.example.com:636"
ssl:
certificate_authorities: [ "CONFIG_DIR/cacert.pem" ]
certificate_authorities: [ "ES_PATH_CONF/cacert.pem" ]
--------------------------------------------------

The CA certificate must be a PEM encoded.
Expand Down
2 changes: 1 addition & 1 deletion x-pack/docs/en/security/troubleshooting.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ The role definition might be missing or invalid.
|======================

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

[source,properties]
----------------
Expand Down

0 comments on commit 101d675

Please sign in to comment.