Skip to content

Commit 951e6a0

Browse files
authored
Apply name changes to Fleet docs (#165) (#194)
* Apply naming changes to fleet docs * Add redirects * Change guide name
1 parent 8d3c1df commit 951e6a0

33 files changed

+120
-118
lines changed

docs/en/ingest-management/faq.asciidoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ Also read <<ingest-management-troubleshooting>>.
1212

1313
[discrete]
1414
[[enrolled-agent-not-showing-up]]
15-
== Why doesn't my enrolled Agent show up in the {ingest-manager} app?
15+
== Why doesn't my enrolled agent show up in the {fleet} app?
1616

17-
If {agent} was successfully enrolled, but doesn't show up in the {fleet} list,
17+
If {agent} was successfully enrolled, but doesn't show up in the *Agents* list,
1818
it might not be started. You need to <<run-elastic-agent,start {agent}>>.
1919

2020
[discrete]
@@ -28,9 +28,9 @@ higher level problem to triage.
2828

2929
[discrete]
3030
[[what-is-my-agent-config]]
31-
== What configuration is the {agent} running?
31+
== What policy is the {agent} running?
3232

33-
To find the configuration file, inspect the `elastic-agent.yml` file in the
33+
To find the policy file, inspect the `elastic-agent.yml` file in the
3434
folder where you ran {agent}. If you're running the agent in {fleet} mode, this
3535
file contains the following citation:
3636

@@ -39,13 +39,13 @@ file contains the following citation:
3939
Management: mode: "fleet"
4040
----
4141

42-
The `action_store.yml` contains the entire, unencrypted configuration:
42+
The `action_store.yml` contains the entire, unencrypted policy:
4343

4444
* To see the {es} location, look at `outputs:hosts`.
4545
* To see the {agent} version, look at the download folder and zip filenames.
4646

4747
This file also shows the version of all packages used by the current
48-
configuration.
48+
policy.
4949

5050
[discrete]
5151
[[where-is-the-data-agent-is-sending]]
@@ -110,7 +110,7 @@ available in a future release.
110110
== Does {agent} or {kib} download integration packages?
111111

112112
{agent} does not download integration packages. When you add an integration in
113-
{ingest-manager}, {kib} connects to the {package-registry} at `epr.elastic.co`,
113+
{fleet}, {kib} connects to the {package-registry} at `epr.elastic.co`,
114114
downloads the integration package, and stores its assets in {es}. This means
115115
that you no longer have to run a manual setup command to load integrations as
116116
you did previously with {beats} modules.
@@ -140,7 +140,7 @@ command on the host to load assets, such as ingest pipelines and dashboards. In
140140
contrast, {beats} managed by {agent} use integration packages that {kib}
141141
downloads from the {package-registry} at `epr.elastic.co`. This means that
142142
{agent} does not need extra privileges to set up assets because
143-
{ingest-manager} manages the assets.
143+
{fleet} manages the assets.
144144

145145
[discrete]
146146
[[what-is-the-endpoint-package]]

docs/en/ingest-management/ingest-management-limitations.asciidoc renamed to docs/en/ingest-management/fleet-limitations.asciidoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
[[ingest-management-limitations]]
1+
[[fleet-limitations]]
22
[role="xpack"]
33
= Limitations of this release
44

55
beta[]
66

7-
{ingest-manager} is currently only available to users with the
7+
{fleet} is currently only available to users with the
88
{ref}/built-in-roles.html[superuser role]. This role is necessary to create
9-
indices, install integration assets, and update {agent} configurations. In order
9+
indices, install integration assets, and update {agent} policies. In order
1010
to use {fleet}, the {agent}s must have a direct network connection to {kib} and
1111
{es}. It is also possible to run the {agent}s in standalone mode in cases where
1212
a network connection is not available or not needed.

docs/en/ingest-management/ingest-management-overview.asciidoc renamed to docs/en/ingest-management/fleet-overview.asciidoc

Lines changed: 28 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
[[ingest-management-overview]]
1+
[[fleet-overview]]
22
[role="xpack"]
3-
= Ingest management overview
3+
= Overview
44

55
beta[]
66

@@ -11,13 +11,13 @@ beta[]
1111
{agent} is a single, unified way to add monitoring for logs, metrics, and
1212
other types of data to each host. A single agent makes it easier and faster
1313
to deploy monitoring across your infrastructure. The agent's single, unified
14-
configuration makes it easier to add integrations for new data sources.
14+
policy makes it easier to add integrations for new data sources.
1515

1616
[discrete]
17-
[[ingest-manager]]
18-
== {ingest-manager}
17+
[[fleet]]
18+
== {fleet}
1919

20-
{ingest-manager} provides a web-based UI in {kib} to add and manage integrations
20+
{fleet} provides a web-based UI in {kib} to add and manage integrations
2121
for popular services and platforms, as well as manage a fleet of {agent}s. Our
2222
integrations provide an easy way to add new sources of data, plus they ship
2323
with out-of-the-box assets like dashboards, visualizations, and pipelines to
@@ -29,50 +29,51 @@ image::images/integrations.png[Integrations page]
2929

3030
[discrete]
3131
[[configuring-integrations]]
32-
== {integrations} in {ingest-manager}
32+
== {integrations} in {fleet}
3333

34-
{ingest-manager} provides a web-based UI for configuring integrations with your
34+
{fleet} provides a web-based UI for configuring integrations with your
3535
data sources. This includes popular services and platforms like Nginx or AWS,
3636
as well as many generic input types like log files.
3737

38-
The {agent} configuration allows you to use any number of integrations for
39-
data sources. You can apply the {agent} configuration to multiple agents,
38+
The {agent} policy allows you to use any number of integrations for
39+
data sources. You can apply the {agent} policy to multiple agents,
4040
making it even easier to manage configuration at scale.
4141

4242
[role="screenshot"]
4343
image::images/add-integration.png[Add integration page]
4444

45-
When you add an integration, you select the agent configuration to use then
45+
When you add an integration, you select the agent policy to use then
4646
configure inputs for logs and metrics, such as the path to your Nginx access
4747
logs. When you're done, you save the integration to update the {agent}
48-
configuration. The next time enrolled agents check in, they receive the update.
49-
Having the configurations automatically deployed is more convenient
48+
policy. The next time enrolled agents check in, they receive the update.
49+
Having the policies automatically deployed is more convenient
5050
than doing it yourself by using SSH, Ansible playbooks, or some other tool.
5151

5252
If you prefer infrastructure as code, you may use YAML files and APIs.
53-
{ingest-manager} has an API-first design. Anything you can do in the UI, you
53+
{fleet} has an API-first design. Anything you can do in the UI, you
5454
can also do using the API. This makes it easy to automate and integrate with
5555
other systems.
5656

5757
[discrete]
5858
[[central-management]]
5959
== Central management in {fleet}
6060

61-
You can see the state of all your {agent}s on the {fleet} page. Here you can see
62-
which agents are online, which have errors, and the last time they checked in.
63-
You can also see the version of the {agent} binary and configuration.
61+
You can see the state of all your {agent}s in {fleet}. On the **Agents** page,
62+
you can see which agents are online, which have errors, and the last time
63+
they checked in. You can also see the version of the {agent} binary and
64+
policy.
6465

65-
//TODO: Replace this screen after testing (to show a number of agents).
66+
//TODO: Replace this screenshot with one that shows more than one agent.
6667

6768
[role="screenshot"]
68-
image::images/fleet.png[{fleet} page]
69+
image::images/kibana-fleet-agents.png[Agents page]
6970

7071
{fleet} serves as the communication channel back to the {agent}s. Agents check
7172
in for the latest updates on a regular basis. You can have any number of agents
72-
enrolled into each agent configuration, which allows you to scale up to
73-
thousands of hosts. When you make a change to an agent configuration, all the
73+
enrolled into each agent policy, which allows you to scale up to
74+
thousands of hosts. When you make a change to an agent policy, all the
7475
agents receive the update during their next check-in. You no longer have to
75-
distribute configuration updates yourself.
76+
distribute policy updates yourself.
7677

7778
[discrete]
7879
[[data-streams]]
@@ -86,8 +87,12 @@ permissions. These indices are called _data streams_.
8687
As you can see in the following screen, each data stream (or index) is broken
8788
out by dataset, type, and namespace.
8889

90+
// REVIEWERS: Have I gotten the terminology right here? It sounds
91+
// like datasets is still a concept, but when we talk about the indices created
92+
// here, they are data streams. Is that correct?
93+
8994
[role="screenshot"]
90-
image::images/datasets.png[Datasets page]
95+
image::images/kibana-fleet-datastreams.png[Data streams page]
9196

9297
The _dataset_ is defined by the integration and describes the fields and other
9398
settings for each index. For example, you might have one dataset for process

0 commit comments

Comments
 (0)