You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[OnWeek] Fix Vale rule warnings in reference/fleet (pt1) (#3907)
This PR is part of the OnWeek project about fixing Vale rule violations
in docs-content.
It fixes warnings in part of the `reference/fleet` folder.
Assisted by Cursor.
Copy file name to clipboardExpand all lines: reference/fleet/add-fleet-server-kubernetes.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -138,7 +138,7 @@ A {{fleet-server}} is an {{agent}} that is enrolled in a {{fleet-server}} policy
138
138
::::{tip}
139
139
If you already have a {{fleet}} policy with the {{fleet-server}} integration, you know its ID, and you know how to generate an [{{es}} service token](elasticsearch://reference/elasticsearch/command-line-tools/service-tokens-command.md) for the {{fleet-server}}, skip directly to [{{fleet-server}} installation](#add-fleet-server-kubernetes-install).
140
140
141
-
Also note that the`service token` required by the {{fleet-server}} is different from the `enrollment tokens` used by {{agent}}s to enroll to {{fleet}}.
141
+
The`service token` required by the {{fleet-server}} is different from the `enrollment tokens` used by {{agent}}s to enroll to {{fleet}}.
Copy file name to clipboardExpand all lines: reference/fleet/advanced-kubernetes-managed-by-fleet.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -83,7 +83,7 @@ containers:
83
83
```
84
84
85
85
Notes
86
-
: The <ImageVersion> is just a placeholder for the elastic-agent image version that you will download in your manifest: eg. `image: docker.elastic.co/elastic-agent/elastic-agent: 8.11.0` Important thing is to update your manifest with args details
86
+
: The <ImageVersion> is a placeholder for the elastic-agent image version that you will download in your manifest: eg. `image: docker.elastic.co/elastic-agent/elastic-agent: 8.11.0` Important thing is to update your manifest with args details
Copy file name to clipboardExpand all lines: reference/fleet/agent-command-reference.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -501,7 +501,7 @@ elastic-agent privileged
501
501
Install {{agent}} permanently on the system and manage it by using the system’s service manager. The agent will start automatically after installation is complete. On Linux (tar package), this command requires a system and service manager like systemd.
502
502
503
503
::::{important}
504
-
If you installed {{agent}} from a DEB or RPM package, the `install` command will skip the installation itself and function as an alias of the [`enroll` command](#elastic-agent-enroll-command) instead. Note that after an upgrade of the {{agent}} using DEB or RPM the {{agent}} service needs to be restarted.
504
+
If you installed {{agent}} from a DEB or RPM package, the `install` command will skip the installation itself and function as an alias of the [`enroll` command](#elastic-agent-enroll-command) instead. After an upgrade of the {{agent}} using DEB or RPM the {{agent}} service needs to be restarted.
505
505
::::
506
506
507
507
@@ -734,7 +734,7 @@ See the `--unprivileged` option and [Run {{agent}} without administrative privil
734
734
`--unprivileged`
735
735
: Run {{agent}} without full superuser privileges. This option is useful in organizations that limit `root` access on Linux or macOS systems, or `admin` access on Windows systems. For details and limitations for running {{agent}} in this mode, refer to [Run {{agent}} without administrative privileges](/reference/fleet/elastic-agent-unprivileged.md).
736
736
737
-
Note that changing to `unprivileged` mode is prevented if the agent is currently enrolled in a policy that includes an integration that requires administrative access, such as the {{elastic-defend}} integration.
737
+
Changing to `unprivileged` mode is prevented if the agent is currently enrolled in a policy that includes an integration that requires administrative access, such as the {{elastic-defend}} integration.
738
738
739
739
{applies_to}`stack: preview` {applies_to}`serverless: preview` To run {{agent}} without superuser privileges as a pre-existing user or group, for instance under an Active Directory account, you can specify the user or group, and the password to use.
740
740
@@ -827,7 +827,7 @@ You can also run the `./otelcol` command, which calls `./elastic-agent otel` and
: Locations to the config file(s). Note that only a single location can be set per flag entry, for example `--config=file:/path/to/first --config=file:path/to/second`.
830
+
: Locations to the config file(s). Only a single location can be set per flag entry, for example `--config=file:/path/to/first --config=file:path/to/second`.
831
831
832
832
`--feature-gates flag`
833
833
: Comma-delimited list of feature gate identifiers. Prefix with `-` to disable the feature. Prefixing with `+` or no prefix will enable the feature.
@@ -1062,7 +1062,7 @@ elastic-agent uninstall
1062
1062
1063
1063
Run {{agent}} without full superuser privileges. This is useful in organizations that limit `root` access on Linux or macOS systems, or `admin` access on Windows systems. For details and limitations forrunning {{agent}}in this mode, refer to [Run {{agent}} without administrative privileges](/reference/fleet/elastic-agent-unprivileged.md).
1064
1064
1065
-
Note that changing a running {{agent}} to `unprivileged` mode is prevented if the agent is currently enrolled with a policy that contains the {{elastic-defend}} integration.
1065
+
Changing a running {{agent}} to `unprivileged` mode is prevented if the agent is currently enrolled with a policy that contains the {{elastic-defend}} integration.
1066
1066
1067
1067
{applies_to}`stack: preview` {applies_to}`serverless: preview` To run {{agent}} without superuser privileges as a pre-existing user or group, for instance under an Active Directory account, add either a `--user` or `--group` parameter together with a `--password` parameter.
Copy file name to clipboardExpand all lines: reference/fleet/agent-policy.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,7 +30,7 @@ Within an {{agent}} policy is a set of individual integration policies. These in
30
30
* Maintain flexibility in large-scale deployments by quickly testing changes before rolling them out.
31
31
* Provide a way to group and manage larger swaths of your infrastructure landscape.
32
32
33
-
For example, it might make sense to create a policy per operating system type: Windows, macOS, and Linux hosts. Or, organize policies by functional groupings of how the hosts are used: IT email servers, Linux servers, user work-stations, etc. Or perhaps by user categories: engineering department, marketing department, etc.
33
+
For example, it might make sense to create a policy per operating system type: Windows, macOS, and Linux hosts. Or, organize policies by functional groupings of how the hosts are used: IT email servers, Linux servers, user work-stations, and so on. Or perhaps by user categories: engineering department, marketing department, and so on.
34
34
35
35
36
36
## Policy types [agent-policy-types]
@@ -100,7 +100,7 @@ To add a new integration to one or more {{agent}} policies:
100
100
6. In Step 2 on the page, you have two options:
101
101
102
102
1. If you’d like to create a new policy for your {{agent}}s, on the **New hosts** tab specify a name for the new agent policy and choose whether or not to collect system logs and metrics. Collecting logs and metrics will add the System integration to the new agent policy.
103
-
2. If you already have an {{agent}} policy created, on the **Existing hosts** tab use the drop-down menu to specify one or more agent policies that you’d like to add the integration to. Note that this feature, known as **reusable integration policies**, is available only for certain subscription levels. For more information, refer to [Elastic subscriptions](https://www.elastic.co/subscriptions).
103
+
2. If you already have an {{agent}} policy created, on the **Existing hosts** tab use the drop-down menu to specify one or more agent policies that you'd like to add the integration to. This feature, known as **reusable integration policies**, is available only for certain subscription levels. For more information, refer to [Elastic subscriptions](https://www.elastic.co/subscriptions).
104
104
105
105
7. Click **Save and continue** to confirm your settings.
106
106
@@ -200,7 +200,7 @@ To edit a custom field:
200
200
2. Click the **Settings** tab and scroll to **Custom fields**. Any custom fields that have been configured are shown.
201
201
3. Click the edit icon to update a field or click the delete icon to remove it.
202
202
203
-
Note that adding custom tags is not supported for a small set of inputs:
203
+
Adding custom tags is not supported for a small set of inputs:
Copy file name to clipboardExpand all lines: reference/fleet/agent-processors.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -86,7 +86,7 @@ Processors have the following limitations.
86
86
* Cannot enrich events with data from {{es}} or other custom data sources.
87
87
* Cannot process data after it’s been converted to the Elastic Common Schema (ECS) because the conversion is performed by {{es}} ingest pipelines. This means that your processor configuration cannot refer to fields that are created by ingest pipelines or {{ls}} because those fields are created *after* the processor runs, not before.
88
88
* May break integration ingest pipelines in {{es}} if the user-defined processing removes or alters fields expected by ingest pipelines.
89
-
* If you create new fields via processors, you are responsible for setting up field mappings in the `*-@custom` component template and making sure the new mappings are aligned with ECS.
89
+
* If you create new fields using processors, you are responsible for setting up field mappings in the `*-@custom` component template and making sure the new mappings are aligned with ECS.
90
90
91
91
92
92
## What other options are available for processing data? [processing-options]
Copy file name to clipboardExpand all lines: reference/fleet/air-gapped.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,9 +13,9 @@ When running {{agent}}s in a restricted or closed network, you need to take extr
13
13
* {{kib}} is able to reach the {{package-registry}} to download package metadata and content.
14
14
* {{agent}}s are able to download binaries during upgrades from the {{artifact-registry}}.
15
15
16
-
The {{package-registry}} must therefore be accessible from {{kib}} via an HTTP Proxy and/or self-hosted.
16
+
The {{package-registry}} must therefore be accessible from {{kib}} through an HTTP Proxy or self-hosted.
17
17
18
-
The {{artifact-registry}} must therefore be accessible from {{kib}} via an HTTP Proxy and/or self-hosted.
18
+
The {{artifact-registry}} must therefore be accessible from {{kib}} through an HTTP Proxy or self-hosted.
19
19
20
20
::::{tip}
21
21
See the {{elastic-sec}} Solution documentation for air-gapped [offline endpoints](/solutions/security/configure-elastic-defend/configure-offline-endpoints-air-gapped-environments.md).
@@ -110,8 +110,8 @@ There are different distributions available:
110
110
111
111
* {{version.stack}} (recommended): *docker.elastic.co/package-registry/distribution:{{version.stack}}* - Selection of packages from the production repository released with {{stack}} {{version.stack}}.
112
112
* lite-{{version.stack}}: *docker.elastic.co/package-registry/distribution:lite-{{version.stack}}* - Subset of the most commonly used packages from the production repository released with {{stack}} {{version.stack}}. This image is a good candidate to start using {{fleet}} in air-gapped environments.
113
-
* production: *docker.elastic.co/package-registry/distribution:production* - Packages available in the production registry ([https://epr.elastic.co](https://epr.elastic.co)). Note that this image is updated every time a new version of a package gets published.
114
-
* lite: *docker.elastic.co/package-registry/distribution:lite* - Subset of the most commonly used packages available in the production registry ([https://epr.elastic.co](https://epr.elastic.co)). Note that this image is updated every time a new version of a package gets published.
113
+
* production: *docker.elastic.co/package-registry/distribution:production* - Packages available in the production registry ([https://epr.elastic.co](https://epr.elastic.co)). This image is updated every time a new version of a package gets published.
114
+
* lite: *docker.elastic.co/package-registry/distribution:lite* - Subset of the most commonly used packages available in the production registry ([https://epr.elastic.co](https://epr.elastic.co)). This image is updated every time a new version of a package gets published.
115
115
116
116
117
117
To update the distribution image, re-pull the image and then restart the docker container.
Copy file name to clipboardExpand all lines: reference/fleet/automatic-integrations-synchronization.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -147,7 +147,7 @@ If the integration syncing reports connection errors or fails to report the sync
147
147
2. In the **Outputs** section, check that the remote {{es}} output is healthy. In particular, check that the remote {{es}} output's host URL matches the host URL of an {{es}} output on the remote cluster.
148
148
3. Edit the remote {{es}} output, and check if the remote {{kib}} URL is correct, as well as the validity and privileges of the remote {{kib}} API key.
149
149
150
-
Note that an incorrect value in either of these fields does not cause the output to become unhealthy, but it affects the integration synchronization.
150
+
An incorrect value in either of these fields does not cause the output to become unhealthy, but it affects the integration synchronization.
151
151
::::
152
152
153
153
### Integrations are not installed on the remote cluster
Copy file name to clipboardExpand all lines: reference/fleet/beats-agent-comparison.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ Elastic provides two main ways to send data to {{es}}:
16
16
17
17
The method you use depends on your use case, which features you need, and whether you want to centrally manage your agents.
18
18
19
-
{{beats}} and {{agent}} can both send data directly to {{es}} or via {{ls}}, where you can further process and enhance the data, before visualizing it in {{kib}}.
19
+
{{beats}} and {{agent}} can both send data directly to {{es}} or through {{ls}}, where you can further process and enhance the data, before visualizing it in {{kib}}.
20
20
21
21
This article summarizes the features and functionality you need to be aware of before adding new {{agent}}s or replacing your current {{beats}} with {{agent}}s. Starting in version 7.14.0, {{agent}} is generally available (GA).
22
22
@@ -66,11 +66,11 @@ The following table shows the outputs supported by the {{agent}} in 9.0.0-beta1:
66
66
67
67
| {{beats}} configuration | {{agent}} support |
68
68
| --- | --- |
69
-
|[Modules](beats://reference/filebeat/configuration-filebeat-modules.md)| Supported via integrations. |
69
+
|[Modules](beats://reference/filebeat/configuration-filebeat-modules.md)| Supported through integrations. |
70
70
|[Input setting overrides](beats://reference/filebeat/advanced-settings.md)| Not configurable. Set to default values. |
71
71
|[General settings](beats://reference/filebeat/configuration-general-options.md)| Many of these global settings are now internal to the agent and should not be modified. |
72
72
|[Project paths](beats://reference/filebeat/configuration-path.md)| {{agent}} configures these paths to provide a simpler and more streamlined configuration experience. |
73
-
|[External configuration file loading](beats://reference/filebeat/filebeat-configuration-reloading.md)| Config is distributed via policy. |
73
+
|[External configuration file loading](beats://reference/filebeat/filebeat-configuration-reloading.md)| Config is distributed through policy. |
74
74
|[Live reloading](beats://reference/filebeat/_live_reloading.md)| Related to the config file reload. |
75
75
|[Outputs](beats://reference/filebeat/configuring-output.md)| Configured through {{fleet}}. See [Supported outputs](#supported-outputs-beats-and-agent). |
@@ -95,7 +95,7 @@ The following table shows a comparison of capabilities supported by {{beats}} an
95
95
| --- |:---:|:---:|:---:| --- |
96
96
| Single agent for all use cases |||| {{agent}} provides logs, metrics, and more. You’d need to install multiple {{beats}} for these use cases. |
97
97
| Install integrations from web UI or API |||| {{agent}} integrations are installed with a convenient web UI or API, but {{beats}} modules are installed with a CLI. This installs {{es}} assets such as index templates and ingest pipelines, and {{kib}} assets such as dashboards. |
98
-
| Configure from web UI or API |||<br>(optional) | {{fleet}}-managed {{agent}} integrations can be configured in the web UI or API. Standalone {{agent}} can use the web UI, API, or YAML. {{beats}} can only be configured via YAML files. |
98
+
| Configure from web UI or API |||<br>(optional) | {{fleet}}-managed {{agent}} integrations can be configured in the web UI or API. Standalone {{agent}} can use the web UI, API, or YAML. {{beats}} can only be configured through YAML files. |
99
99
| Central, remote agent policy management |||| {{agent}} policies can be centrally managed through {{fleet}}. You have to manage {{beats}} configuration yourself or with a third-party solution. |
100
100
| Central, remote agent binary upgrades |||| {{agent}}s can be remotely upgraded through {{fleet}}. You have to upgrade {{beats}} yourself or with a third-party solution. |
101
101
| Add {{kib}} and {{es}} assets for a single integration or module |||| {{agent}} integrations allow you to add {{kib}} and {{es}} assets for a single integration at a time. {{beats}} installs hundreds of assets for all modules at once. |
@@ -111,7 +111,7 @@ The following table shows a comparison of capabilities supported by {{beats}} an
111
111
| Secret management |||| {{agent}} stores credentials in the agent policy. {{beats}} allows users to access credentials in a local [keystore](beats://reference/filebeat/keystore.md). |
112
112
| Progressive or canary deployments ||<br>{applies_to}`stack: ga 9.1.0`|| To upgrade {{fleet}}-managed {{agents}} progressively, you can [configure an automatic upgrade](upgrade-elastic-agent.md#auto-upgrade-agents) in the {{agent}} policy. {applies_to}`stack: ga 9.1.0`<br><br>With standalone {{agent}} and {{beats}} you can deploy configuration files progressively using third party solutions. |
113
113
| Multiple configurations per host ||<br>(uses input conditions instead) |<br>(uses input conditions instead) | {{agent}} uses a single {{agent}} policy for configuration, and uses [variables and input conditions](dynamic-input-configuration.md) to adapt on a per-host basis. {{beats}} supports multiple configuration files per host, enabling third party solutions to deploy files hierarchically or in multiple groups, and enabling finer-grained access control to those files. |
114
-
| Compatible with version control and infrastructure as code solutions ||<br>(only via API) || Agent policies created in the {{fleet}} UI can't be managed with external version control or infrastructure as code solutions. However, you could develop a solution that [uses the {{fleet}} API or adds a preconfigured policy to Kibana](/reference/fleet/create-policy-no-ui.md). {{beats}} and {{agent}} in standalone mode use a YAML file that is compatible with these solutions. |
114
+
| Compatible with version control and infrastructure as code solutions ||<br>(only using API) || Agent policies created in the {{fleet}} UI can't be managed with external version control or infrastructure as code solutions. However, you could develop a solution that [uses the {{fleet}} API or adds a preconfigured policy to Kibana](/reference/fleet/create-policy-no-ui.md). {{beats}} and {{agent}} in standalone mode use a YAML file that is compatible with these solutions. |
115
115
| Spooling data to local disk |||| This feature is currently being [considered for development](https://github.com/elastic/elastic-agent/issues/3490). |
0 commit comments