Skip to content

Commit b254e44

Browse files
committed
Apply name changes to elastic agent docs
1 parent c858dd0 commit b254e44

File tree

6 files changed

+32
-22
lines changed

6 files changed

+32
-22
lines changed

x-pack/elastic-agent/docs/elastic-agent-command-line.asciidoc

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,10 @@ elastic-agent enroll <kibana_url> <enrollment_token> [--ca-sha256 <string>]
4646
=== Options
4747

4848
`kibana_url`::
49-
Required. URL of the {kib} endpoint where {ingest-manager} is running.
49+
Required. URL of the {kib} endpoint where {fleet} is running.
5050

5151
`enrollment_token`::
52-
Required. Enrollment token generated by {ingest-manager}. You can use the same
52+
Required. Enrollment token generated by {fleet}. You can use the same
5353
enrollment token for multiple agents.
5454

5555
`--ca-sha256 <string>`::
@@ -60,7 +60,7 @@ verification.
6060
Comma-separated list of root certificates used for server verification.
6161

6262
`--force`::
63-
Force overwrite of current configuration without prompting for confirmation.
63+
Force overwrite of current policy without prompting for confirmation.
6464
This flag is helpful when using automation software or scripted deployments.
6565

6666
`--help`::
@@ -125,9 +125,9 @@ elastic-agent help enroll
125125
[[elastic-agent-inspect-command]]
126126
== elastic-agent inspect
127127

128-
Show the current {agent} configuration.
128+
Show the current {agent} policy.
129129

130-
If no parameters are specified, shows the full {agent} configuration.
130+
If no parameters are specified, shows the full {agent} policy.
131131

132132
[discrete]
133133
=== Synopsis
@@ -145,7 +145,7 @@ elastic-agent inspect output [--output <string>] [--program <string>]
145145
[discrete]
146146
=== Options
147147

148-
`output`:: Display the current configuration for the output. This command
148+
`output`:: Display the current policy for the output. This command
149149
accepts additional flags:
150150
+
151151
--
@@ -197,7 +197,7 @@ elastic-agent run [global-flags]
197197
These flags are valid whenever you run `elastic-agent` on the command line.
198198

199199
`-c <string>`::
200-
The configuration file to use. If not specified, {agent} uses
200+
The policy file to use. If not specified, {agent} uses
201201
`{path.home}/elastic-agent.yml`.
202202

203203
`--e`::
@@ -208,8 +208,12 @@ The environment in which the agent will run.
208208

209209
//TODO: Clarify what we mean by environment by showing an example.
210210

211+
// REVIEWERS: Do we need to remove the path settings here? It sounds like
212+
// we won't allow users to set custom paths because it won't allow them to
213+
// auto upgrade. Is that correct?
214+
211215
`--path.config <string>`::
212-
The directory where {agent} looks for its configuration file. The default
216+
The directory where {agent} looks for its policy file. The default
213217
varies by platform.
214218

215219
`--path.data <string>`::
@@ -220,7 +224,7 @@ If not specified, {agent} uses `{path.home}/data`.
220224

221225
`--path.home <string>`::
222226
The home directory of {agent}. `path.home` determines the location of the
223-
configuration files and data directory.
227+
policy files and data directory.
224228
+
225229
If not specified, {agent} uses the current working directory.
226230

x-pack/elastic-agent/docs/elastic-agent-configuration-example.asciidoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
[[elastic-agent-configuration-example]]
1+
[[elastic-agent-policy-example]]
22
[role="xpack"]
3-
= Configuration example
3+
= Policy example
44

55
beta[]
66

7-
The following example shows a full list of configuration options:
7+
The following example shows a full list of policy options:
88

99
[source,yaml]
1010
----

x-pack/elastic-agent/docs/elastic-agent-configuration.asciidoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44

55
beta[]
66

7+
// REVIEWERS: Do we want to use "policy settings" instead of configuration
8+
// settings in this topic?
9+
710
// TODO: This topic assumes users know what standalone and fleet are. When we
811
// add the settings reference, we should clean this up: describe the available
912
// options, then show how to configure them manually for standalone. We should
@@ -18,7 +21,7 @@ and send the logs and metrics to the same {es} instance.
1821
To alter this behavior, configure the output and other configuration settings.
1922
When running the agent standalone, specify configuration settings in the
2023
`elastic-agent.yml` file. When using {fleet}, do not modify settings in
21-
the `elastic-agent.yml` file. Instead, use {ingest-manager} in {kib} to change
24+
the `elastic-agent.yml` file. Instead, use {fleet} in {kib} to change
2225
settings.
2326

2427
TIP: To get started quickly, you can use {fleet} to generate a standalone

x-pack/elastic-agent/docs/run-elastic-agent.asciidoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ configure and manage the agent.
1212
== Run in {fleet} mode
1313

1414
With _fleet mode_, you manage {agent} remotely. The agent uses a trusted {kib}
15-
instance to retrieve configurations and report agent events. This trusted {kib}
16-
instance must have {ingest-manager} and {fleet} enabled.
15+
instance to retrieve policies and report agent events. This trusted {kib}
16+
instance must have {fleet} enabled.
1717

1818
To create a trusted communication channel between {agent} and {kib}, enroll the
1919
agent to {fleet}.
@@ -22,14 +22,14 @@ To enroll an {agent} to {fleet}:
2222

2323
. Stop {agent}, if it's already running.
2424

25-
. In {ingest-manager}, click **Settings** and change the defaults, if necessary.
25+
. In {fleet}, click **Settings** and change the defaults, if necessary.
2626
For self-managed installations, set the URLs for {es} and {kib}, including
2727
the http ports, then save your changes.
2828
+
2929
[role="screenshot"]
30-
image::images/kibana-ingest-manager-settings.png[{ingest-manager} settings]
30+
image::images/kibana-fleet-settings.png[{fleet} settings]
3131

32-
. Select **{fleet}**, then click **Add agent** to get an enrollment token. See
32+
. Select **Agents**, then click **Add agent** to get an enrollment token. See
3333
<<ingest-management-getting-started>> for detailed steps.
3434

3535
. Change to the directory where {agent} is installed, and enroll the agent to
@@ -60,8 +60,8 @@ To start {agent} manually, run:
6060

6161
include::{beats-repo-dir}/x-pack/elastic-agent/docs/tab-widgets/run-standalone-widget.asciidoc[]
6262

63-
Use the `-c` flag to specify the configuration file. If no configuration file is
64-
specified, {agent} uses the default configuration, `elastic-agent.yml`, which is
63+
Use the `-c` flag to specify the policy file. If no policy file is
64+
specified, {agent} uses the default policy, `elastic-agent.yml`, which is
6565
located in the same directory as {agent}.
6666

6767
For configuration options, see <<elastic-agent-configuration>>.

x-pack/elastic-agent/docs/running-on-kubernetes.asciidoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
[role="xpack"]
33
=== Run {agent} on Kubernetes
44

5+
//REVIEWERS: This topic is not hooked up to the docs anywhere. Should it be?
6+
//It needs to be edited.
7+
58
You can use {agent} https://www.docker.elastic.co/r/beats/elastic-agent[Docker images] on Kubernetes to
69
retrieve cluster metrics.
710

@@ -44,7 +47,7 @@ curl -L -O https://raw.githubusercontent.com/elastic/beats/{branch}/deploy/kuber
4447

4548
By default, {agent} is enrolled to an existing Kibana deployment,
4649
if present using the specified credentials. FLEET_ENROLLMENT_TOKEN parameter is used to connect Agent to the
47-
corresponding Ingest Management configuration. It is suggested to connect Daemonset Agents to a node scope configuration
50+
corresponding {agent} policy. It is suggested to connect Daemonset Agents to a node scope configuration
4851
and Deployment Agent to a cluster scope configuration. Then Kubernetes package will be deployed enabling cluster scope
4952
datasets using cluster scope configuration while node scope datasets will be enabled under node scope configuration.
5053

x-pack/elastic-agent/docs/unenroll-elastic-agent.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
You can unenroll an agent to invalidate the API key used to connect to {es}.
66

7-
. In {ingest-manager}, select **{fleet}**.
7+
. In {fleet}, select **Agents**.
88

99
. Under Agents, choose **Unenroll** from the **Actions** menu next to the agent
1010
you want to unenroll.

0 commit comments

Comments
 (0)