Skip to content

Commit 898006b

Browse files
Refine applies_to syntax (#48333) (#48511)
* refine applies_to in lists * update tabs to applies switch * fix new hints * fix multi lifecycle badge * more clean up * Apply suggestions from code review --------- (cherry picked from commit 5e37672) Co-authored-by: Visha Angelova <visha.angelova@elastic.co> Co-authored-by: Visha Angelova <91186315+vishaangelova@users.noreply.github.com>
1 parent 10b85ff commit 898006b

36 files changed

Lines changed: 252 additions & 225 deletions

docs/reference/auditbeat/auditbeat-installation-configuration.md

Lines changed: 20 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,13 @@ This guide describes how to get started quickly with audit data collection. You
2323

2424
You need {{es}} for storing and searching your data, and {{kib}} for visualizing and managing it.
2525

26-
:::::::{tab-set}
27-
:group: deployment
26+
:::::::{applies-switch}
2827

29-
::::::{tab-item} {{ech}}
30-
:sync: hosted
28+
::::::{applies-item} ess: ga
3129
To get started quickly, spin up an [{{ech}}](https://www.elastic.co/cloud?page=docs&placement=docs-body) deployment. {{ech}} is available on AWS, GCP, and Azure. [Try it out for free](https://cloud.elastic.co/registration?page=docs&placement=docs-body).
3230
::::::
3331

34-
::::::{tab-item} Self-managed
35-
:sync: self
32+
::::::{applies-item} self: ga
3633
To install and run {{es}} and {{kib}}, see [Installing the {{stack}}](docs-content://deploy-manage/deploy/self-managed/installing-elasticsearch.md).
3734
::::::
3835

@@ -101,7 +98,7 @@ If script execution is disabled on your system, you need to set the execution po
10198
:::
10299

103100
:::{important}
104-
{applies_to}`stack: ga 9.1.0` {applies_to}`stack: ga 9.0.6`
101+
:applies_to: stack: ga 9.0.6+!
105102

106103
The base folder has changed from `C:\ProgramData\` to `C:\Program Files\`
107104
because the latter has stricter permissions. The home path (base for
@@ -133,11 +130,9 @@ Connections to {{es}} and {{kib}} are required to set up Auditbeat.
133130

134131
Set the connection information in `auditbeat.yml`. To locate this configuration file, see [Directory layout](/reference/auditbeat/directory-layout.md).
135132

136-
:::::::{tab-set}
137-
:group: deployment
133+
:::::::{applies-switch}
138134

139-
::::::{tab-item} {{ech}}
140-
:sync: hosted
135+
::::::{applies-item} ess: ga
141136
Specify the [cloud.id](/reference/auditbeat/configure-cloud-id.md) of your {{ech}} deployment, and set [cloud.auth](/reference/auditbeat/configure-cloud-id.md) to a user who is authorized to set up Auditbeat. For example:
142137

143138
```yaml
@@ -148,8 +143,7 @@ cloud.auth: "auditbeat_setup:YOUR_PASSWORD" <1>
148143
1. This examples shows a hard-coded password, but you should store sensitive values in the [secrets keystore](/reference/auditbeat/keystore.md).
149144
::::::
150145
151-
::::::{tab-item} Self-managed
152-
:sync: self
146+
::::::{applies-item} self: ga
153147
1. Set the host and port where Auditbeat can find the {{es}} installation, and set the username and password of a user who is authorized to set up Auditbeat. For example:
154148
155149
```yaml
@@ -270,9 +264,11 @@ Auditbeat comes with predefined assets for parsing, indexing, and visualizing yo
270264
`-e` is optional and sends output to standard error instead of the configured log output.
271265

272266

273-
The default location where Windows log files are stored varies:
274-
* {applies_to}`stack: ga 9.0.6` `C:\Program Files\Auditbeat-Data\logs`
275-
* {applies_to}`stack: ga 9.0` `C:\ProgramData\auditbeat\logs`
267+
By default Windows log files are stored in `C:\Program Files\Auditbeat-Data\logs`.
268+
269+
:::{note}
270+
In versions before 9.0.6, the default location for Windows log files was `C:\ProgramData\auditbeat\logs`.
271+
:::
276272

277273
This step loads the recommended [index template](docs-content://manage-data/data-store/templates.md) for writing to {{es}} and deploys the sample dashboards for visualizing the data in {{kib}}.
278274

@@ -341,9 +337,11 @@ sudo ./auditbeat -e
341337
PS C:\Program Files\auditbeat> Start-Service auditbeat
342338
```
343339

344-
The default location where Windows log files are stored varies:
345-
* {applies_to}`stack: ga 9.0.6` `C:\Program Files\Auditbeat-Data\logs`
346-
* {applies_to}`stack: ga 9.0` `C:\ProgramData\auditbeat\logs`
340+
By default Windows log files are stored in `C:\Program Files\Auditbeat-Data\logs`.
341+
342+
:::{note}
343+
In versions before 9.0.6, the default location for Windows log files was `C:\ProgramData\auditbeat\logs`.
344+
:::
347345
::::::
348346

349347
:::::::
@@ -361,16 +359,16 @@ To open the dashboards:
361359

362360
1. Launch {{kib}}:
363361

364-
:::::::{tab-set}
362+
:::::::{applies-switch}
365363
:group: deployment
366364

367-
::::::{tab-item} {{ech}}
365+
::::::{applies-item} ess: ga
368366
:sync: hosted
369367
1. [Log in](https://cloud.elastic.co/) to your {{ecloud}} account.
370368
2. Navigate to the {{kib}} endpoint in your deployment.
371369
::::::
372370

373-
::::::{tab-item} Self-managed
371+
::::::{applies-item} self: ga
374372
:sync: self
375373
Point your browser to [http://localhost:5601](http://localhost:5601), replacing `localhost` with the name of the {{kib}} host.
376374
::::::

docs/reference/auditbeat/auditbeat-installation-script.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
mapped_pages:
33
- https://www.elastic.co/guide/en/beats/auditbeat/current/auditbeat-installation-script.html
44
applies_to:
5-
stack: ga 9.1.0, ga 9.0.6
5+
stack: ga 9.0.6
66
---
77

88
# Installation script

docs/reference/auditbeat/auditbeat-starting.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,11 @@ sudo ./auditbeat -e
5858
PS C:\Program Files\auditbeat> Start-Service auditbeat
5959
```
6060

61-
The default location where Windows log files are stored varies:
62-
* {applies_to}`stack: ga 9.0.6` `C:\Program Files\Auditbeat-Data\logs`
63-
* {applies_to}`stack: ga 9.0` `C:\ProgramData\auditbeat\logs`
61+
By default Windows log files are stored in `C:\Program Files\Auditbeat-Data\logs`.
62+
63+
:::{note}
64+
In versions before 9.0.6, the default location for Windows log files was `C:\ProgramData\auditbeat\logs`.
65+
:::
6466
::::::
6567

6668
:::::::

docs/reference/auditbeat/processor-translate-guid.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,14 +36,14 @@ The `translate_ldap_attribute` processor has the following configuration setting
3636
| `field` | yes | | Source field containing a GUID. |
3737
| `target_field` | no | | Target field for the mapped attribute value. If not set it will be replaced in place. |
3838
| `ldap_domain` | no | | {applies_to}`stack: ga 9.2.4` DNS domain name (for example, `example.com`) used for DNS SRV discovery and to construct FQDNs from `LOGONSERVER`. When omitted Beats inspects OS metadata to infer the domain (Windows: `USERDNSDOMAIN`, `GetComputerNameEx`, TCP/IP + Kerberos registry keys, hostname; Linux/macOS: `/etc/resolv.conf`, `/etc/krb5.conf`, hostname). |
39-
| `ldap_address` | {applies_to}`stack: ga 9.2.4` no<br>{applies_to}`stack: ga 9.0.0` yes | | LDAP server address (for example, `ldap://ds.example.com:389`). When omitted Beats auto-discovers controllers by querying `_ldaps._tcp.<domain>` first, `_ldap._tcp.<domain>` second, and finally the Windows `LOGONSERVER` variable if available. Candidates are tried in order until one succeeds. |
40-
| `ldap_base_dn` | {applies_to}`stack: ga 9.2.4` no<br>{applies_to}`stack: ga 9.0.0` yes | | LDAP base DN (for example, `dc=example,dc=com`). When omitted Beats queries the server's rootDSE for `defaultNamingContext`/`namingContexts`. If the controller does not expose those attributes, client initialization fails and you must configure the value manually. |
39+
| `ldap_address` | {applies_to}`stack: ga 9.2.4+!` no<br><br>{applies_to}`stack: ga 9.0.0!-9.2.3!` yes | | LDAP server address (for example, `ldap://ds.example.com:389`). When omitted Beats auto-discovers controllers by querying `_ldaps._tcp.<domain>` first, `_ldap._tcp.<domain>` second, and finally the Windows `LOGONSERVER` variable if available. Candidates are tried in order until one succeeds. |
40+
| `ldap_base_dn` | {applies_to}`stack: ga 9.2.4+!` no<br><br>{applies_to}`stack: ga 9.0.0!-9.2.3!` yes | | LDAP base DN (for example, `dc=example,dc=com`). When omitted Beats queries the server's rootDSE for `defaultNamingContext`/`namingContexts`. If the controller does not expose those attributes, client initialization fails and you must configure the value manually. |
4141
| `ldap_bind_user` | no | | LDAP DN/UPN for simple bind. When provided with `ldap_bind_password` Beats performs a standard bind. When set without a password Beats issues an unauthenticated bind using this identity (useful for servers that expect a bind DN even for anonymous operations). |
4242
| `ldap_bind_password` | no | | LDAP password for simple bind. When both the username and password are omitted Beats attempts automatic authentication: on Windows it first tries SSPI with the Beat's service or user identity using the SPN `ldap/<hostname derived from ldap_address>` and falls back to an unauthenticated bind if that fails. Non-Windows platforms immediately use an unauthenticated bind. |
4343
| `ldap_search_attribute` | yes | `objectGUID` | LDAP attribute to search by. |
4444
| `ldap_mapped_attribute` | yes | `cn` | LDAP attribute to map to. |
4545
| `ldap_search_time_limit` | no | 30 | LDAP search time limit in seconds. |
46-
| `ldap_ssl` | no | {applies_to}`stack: ga 9.2.4` no default<br>{applies_to}`stack: ga 9.0.0` `30` | LDAP TLS/SSL connection settings. Refer to [SSL](/reference/auditbeat/configuration-ssl.md). |
46+
| `ldap_ssl` | no | {applies_to}`stack: ga 9.2.4+!` no default<br><br>{applies_to}`stack: ga 9.0.0!-9.2.3!` `30` | LDAP TLS/SSL connection settings. Refer to [SSL](/reference/auditbeat/configuration-ssl.md). |
4747
| `ad_guid_translation` | no | `auto` | {applies_to}`stack: ga 9.2.4` Controls GUID binary conversion for Active Directory attributes. `auto` (default) converts when the LDAP search attribute equals `objectGUID` (case-insensitive). Use `always` to force conversion or `never` to disable it. |
4848
| `ignore_missing` | no | false | Ignore errors when the source field is missing. |
4949
| `ignore_failure` | no | false | Ignore all errors produced by the processor. |

docs/reference/filebeat/filebeat-input-azure-blob-storage.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -127,15 +127,15 @@ $$$supported-attributes$$$
127127
5. [storage_url](#attrib-storage-url)
128128
6. [containers](#attrib-containers)
129129
7. [name](#attrib-container-name)
130-
8. [batch_size](#attrib-batch_size-abs) {applies_to}`stack: ga 9.1.0`
130+
8. [batch_size](#attrib-batch_size-abs) {applies_to}`stack: ga 9.1.0+`
131131
9. [max_workers](#attrib-max_workers)
132132
10. [poll](#attrib-poll)
133133
11. [poll_interval](#attrib-poll_interval)
134134
12. [file_selectors](#attrib-file_selectors)
135135
13. [expand_event_list_from_field](#attrib-expand_event_list_from_field)
136136
14. [timestamp_epoch](#attrib-timestamp_epoch)
137-
15. [path_prefix](#attrib-path_prefix) {applies_to}`stack: ga 9.1.4`
138-
16. [custom_properties](#attrib-custom-properties) {applies_to}`stack: ga 9.1.0`
137+
15. [path_prefix](#attrib-path_prefix) {applies_to}`stack: ga 9.1.4+`
138+
16. [custom_properties](#attrib-custom-properties) {applies_to}`stack: ga 9.1.0+`
139139

140140
## `account_name` [attrib-account-name]
141141

0 commit comments

Comments
 (0)