Skip to content

Commit 6d97ffe

Browse files
committed
[DOCS] Fix path info for various security files (#30502)
1 parent 3233123 commit 6d97ffe

File tree

12 files changed

+27
-27
lines changed

12 files changed

+27
-27
lines changed

x-pack/docs/en/commands/syskeygen.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ environment variable.
4343
=== Examples
4444

4545
The following command generates a `system_key` file in the
46-
default `$ES_HOME/config/x-pack` directory:
46+
default `$ES_HOME/config` directory:
4747

4848
[source, sh]
4949
--------------------------------------------------

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

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

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

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/x-pack/role_mapping.yml"
59+
role_mapping: "CONFIG_DIR/role_mapping.yml"
6060
unmapped_groups_as_roles: false
6161
------------------------------------------------------------
6262

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

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

297297
Apart from the _Role Management APIs_, roles can also be defined in local
298-
`roles.yml` file located in `CONFIG_DIR/x-pack`. This is a YAML file where each
298+
`roles.yml` file located in `CONFIG_DIR`. This is a YAML file where each
299299
role definition is keyed by its name.
300300

301301
[IMPORTANT]

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ To use file based role-mappings, you must configure the mappings in a YAML file
3636
and copy it to each node in the cluster. Tools like Puppet or Chef can help with
3737
this.
3838

39-
By default, role mappings are stored in `ES_PATH_CONF/x-pack/role_mapping.yml`,
39+
By default, role mappings are stored in `ES_PATH_CONF/role_mapping.yml`,
4040
where `ES_PATH_CONF` is `ES_HOME/config` (zip/tar installations) or
4141
`/etc/elasticsearch` (package installations). To specify a different location,
4242
you configure the `files.role_mapping` realm settings in `elasticsearch.yml`.

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
The {security} uses the following files:
55

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

99
* `CONFIG_DIR/elasticsearch-users` defines the users and their hashed passwords for
@@ -12,12 +12,12 @@ The {security} uses the following files:
1212
* `CONFIG_DIR/elasticsearch-users_roles` defines the user roles assignment for the
1313
the <<file-realm, `file` realm>>.
1414

15-
* `CONFIG_DIR/x-pack/role_mapping.yml` defines the role assignments for a
15+
* `CONFIG_DIR/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/x-pack/log4j2.properties` contains audit information (read more
20+
* `CONFIG_DIR/log4j2.properties` contains audit information (read more
2121
<<logging-file, here>>).
2222

2323
[[security-files-location]]

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

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ instances:
4141
`.env`:
4242
[source,yaml]
4343
----
44-
CERTS_DIR=/usr/share/elasticsearch/config/x-pack/certificates <1>
44+
CERTS_DIR=/usr/share/elasticsearch/config/certificates <1>
4545
ELASTIC_PASSWORD=PleaseChangeMe <2>
4646
----
4747
<1> The path, inside the Docker image, where certificates are expected to be found.
@@ -66,18 +66,18 @@ services:
6666
image: docker.elastic.co/elasticsearch/elasticsearch-platinum:{version}
6767
command: >
6868
bash -c '
69-
if [[ ! -d config/x-pack/certificates/certs ]]; then
70-
mkdir config/x-pack/certificates/certs;
69+
if [[ ! -d config/certificates/certs ]]; then
70+
mkdir config/certificates/certs;
7171
fi;
7272
if [[ ! -f /local/certs/bundle.zip ]]; then
73-
bin/elasticsearch-certgen --silent --in config/x-pack/certificates/instances.yml --out config/x-pack/certificates/certs/bundle.zip;
74-
unzip config/x-pack/certificates/certs/bundle.zip -d config/x-pack/certificates/certs; <1>
73+
bin/elasticsearch-certgen --silent --in config/certificates/instances.yml --out config/certificates/certs/bundle.zip;
74+
unzip config/certificates/certs/bundle.zip -d config/certificates/certs; <1>
7575
fi;
76-
chgrp -R 0 config/x-pack/certificates/certs
76+
chgrp -R 0 config/certificates/certs
7777
'
7878
user: $\{UID:-1000\}
7979
working_dir: /usr/share/elasticsearch
80-
volumes: ['.:/usr/share/elasticsearch/config/x-pack/certificates']
80+
volumes: ['.:/usr/share/elasticsearch/config/certificates']
8181
----
8282

8383
<1> The new node certificates and CA certificate+key are placed under the local directory `certs`.
@@ -184,9 +184,9 @@ WARNING: Windows users not running PowerShell will need to remove `\` and join l
184184
----
185185
docker exec es01 /bin/bash -c "bin/elasticsearch-setup-passwords \
186186
auto --batch \
187-
-Expack.ssl.certificate=x-pack/certificates/es01/es01.crt \
188-
-Expack.ssl.certificate_authorities=x-pack/certificates/ca/ca.crt \
189-
-Expack.ssl.key=x-pack/certificates/es01/es01.key \
187+
-Expack.ssl.certificate=certificates/es01/es01.crt \
188+
-Expack.ssl.certificate_authorities=certificates/ca/ca.crt \
189+
-Expack.ssl.key=certificates/es01/es01.key \
190190
--url https://localhost:9200"
191191
----
192192
--

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,9 @@ This name should match the `keystore.path` value.
4040
[source, yaml]
4141
--------------------------------------------------
4242
xpack.security.http.ssl.enabled: true
43-
xpack.security.http.ssl.key: /home/es/config/x-pack/node01.key <1>
44-
xpack.security.http.ssl.certificate: /home/es/config/x-pack/node01.crt <2>
45-
xpack.security.http.ssl.certificate_authorities: [ "/home/es/config/x-pack/ca.crt" ] <3>
43+
xpack.security.http.ssl.key: /home/es/config/node01.key <1>
44+
xpack.security.http.ssl.certificate: /home/es/config/node01.crt <2>
45+
xpack.security.http.ssl.certificate_authorities: [ "/home/es/config/ca.crt" ] <3>
4646
--------------------------------------------------
4747
<1> The full path to the node key file. This must be a location within the
4848
{es} configuration directory.

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/x-pack/cacert.pem" ]
32+
certificate_authorities: [ "CONFIG_DIR/cacert.pem" ]
3333
--------------------------------------------------
3434

3535
The CA certificate must be a PEM encoded.

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,9 @@ This name should match the `keystore.path` value.
4343
--------------------------------------------------
4444
xpack.security.transport.ssl.enabled: true
4545
xpack.security.transport.ssl.verification_mode: certificate <1>
46-
xpack.security.transport.ssl.key: /home/es/config/x-pack/node01.key <2>
47-
xpack.security.transport.ssl.certificate: /home/es/config/x-pack/node01.crt <3>
48-
xpack.security.transport.ssl.certificate_authorities: [ "/home/es/config/x-pack/ca.crt" ] <4>
46+
xpack.security.transport.ssl.key: /home/es/config/node01.key <2>
47+
xpack.security.transport.ssl.certificate: /home/es/config/node01.crt <3>
48+
xpack.security.transport.ssl.certificate_authorities: [ "/home/es/config/ca.crt" ] <4>
4949
--------------------------------------------------
5050
<1> If you used the `--dns` or `--ip` options with the `elasticsearch-certutil cert` command
5151
and you want to enable strict hostname checking, set the verification mode to

x-pack/docs/en/setup/bootstrap-checks-xes.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ to each user.
4343

4444
If you use files to manage the role mappings, you must configure a YAML file
4545
and copy it to each node in the cluster. By default, role mappings are stored in
46-
`ES_PATH_CONF/x-pack/role_mapping.yml`. Alternatively, you can specify a
46+
`ES_PATH_CONF/role_mapping.yml`. Alternatively, you can specify a
4747
different role mapping file for each type of realm and specify its location in
4848
the `elasticsearch.yml` file. For more information, see
4949
{xpack-ref}/mapping-roles.html#mapping-roles-file[Using Role Mapping Files].

x-pack/docs/en/watcher/trigger/schedule/cron.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@ minute during the weekend:
213213

214214
{xpack} ships with a `elasticsearch-croneval` command line tool that you can use to verify that
215215
your cron expressions are valid and produce the expected results. This tool is
216-
provided in the `$ES_HOME/bin/x-pack` directory.
216+
provided in the `$ES_HOME/bin` directory.
217217

218218
To verify a cron expression, simply pass it in as a parameter to `elasticsearch-croneval`:
219219

0 commit comments

Comments
 (0)