Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Apply name changes to elastic agent docs #21549

Merged
merged 3 commits into from
Oct 16, 2020
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 13 additions & 9 deletions x-pack/elastic-agent/docs/elastic-agent-command-line.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,10 @@ elastic-agent enroll <kibana_url> <enrollment_token> [--ca-sha256 <string>]
=== Options

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

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

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

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

`--help`::
Expand Down Expand Up @@ -125,9 +125,9 @@ elastic-agent help enroll
[[elastic-agent-inspect-command]]
== elastic-agent inspect

Show the current {agent} configuration.
Show the current {agent} policy.

If no parameters are specified, shows the full {agent} configuration.
If no parameters are specified, shows the full {agent} policy.

[discrete]
=== Synopsis
Expand All @@ -145,7 +145,7 @@ elastic-agent inspect output [--output <string>] [--program <string>]
[discrete]
=== Options

`output`:: Display the current configuration for the output. This command
`output`:: Display the current policy for the output. This command
accepts additional flags:
+
--
Expand Down Expand Up @@ -197,7 +197,7 @@ elastic-agent run [global-flags]
These flags are valid whenever you run `elastic-agent` on the command line.

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

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

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

// REVIEWERS: Do we need to remove the path settings here? It sounds like
// we won't allow users to set custom paths because it won't allow them to
// auto upgrade. Is that correct?

dedemorton marked this conversation as resolved.
Show resolved Hide resolved
`--path.config <string>`::
The directory where {agent} looks for its configuration file. The default
The directory where {agent} looks for its policy file. The default
varies by platform.

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

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

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
[[elastic-agent-configuration-example]]
[[elastic-agent-policy-example]]
[role="xpack"]
= Configuration example
= Policy example

beta[]

The following example shows a full list of configuration options:
The following example shows a full list of policy options:

[source,yaml]
----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@

beta[]

// REVIEWERS: Do we want to use "policy settings" instead of configuration
// settings in this topic?

dedemorton marked this conversation as resolved.
Show resolved Hide resolved
// TODO: This topic assumes users know what standalone and fleet are. When we
// add the settings reference, we should clean this up: describe the available
// options, then show how to configure them manually for standalone. We should
Expand All @@ -18,7 +21,7 @@ and send the logs and metrics to the same {es} instance.
To alter this behavior, configure the output and other configuration settings.
When running the agent standalone, specify configuration settings in the
`elastic-agent.yml` file. When using {fleet}, do not modify settings in
the `elastic-agent.yml` file. Instead, use {ingest-manager} in {kib} to change
the `elastic-agent.yml` file. Instead, use {fleet} in {kib} to change
settings.

TIP: To get started quickly, you can use {fleet} to generate a standalone
Expand Down
14 changes: 7 additions & 7 deletions x-pack/elastic-agent/docs/run-elastic-agent.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ configure and manage the agent.
== Run in {fleet} mode

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

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

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

. In {ingest-manager}, click **Settings** and change the defaults, if necessary.
. In {fleet}, click **Settings** and change the defaults, if necessary.
For self-managed installations, set the URLs for {es} and {kib}, including
the http ports, then save your changes.
+
[role="screenshot"]
image::images/kibana-ingest-manager-settings.png[{ingest-manager} settings]
image::images/kibana-fleet-settings.png[{fleet} settings]
dedemorton marked this conversation as resolved.
Show resolved Hide resolved

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

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

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

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

For configuration options, see <<elastic-agent-configuration>>.
Expand Down
5 changes: 4 additions & 1 deletion x-pack/elastic-agent/docs/running-on-kubernetes.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
[role="xpack"]
=== Run {agent} on Kubernetes

//REVIEWERS: This topic is not hooked up to the docs anywhere. Should it be?
//It needs to be edited.

dedemorton marked this conversation as resolved.
Show resolved Hide resolved
You can use {agent} https://www.docker.elastic.co/r/beats/elastic-agent[Docker images] on Kubernetes to
retrieve cluster metrics.

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

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

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

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

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