diff --git a/x-pack/elastic-agent/docs/elastic-agent-command-line.asciidoc b/x-pack/elastic-agent/docs/elastic-agent-command-line.asciidoc index e102d5b4787..54ae3ecef4c 100644 --- a/x-pack/elastic-agent/docs/elastic-agent-command-line.asciidoc +++ b/x-pack/elastic-agent/docs/elastic-agent-command-line.asciidoc @@ -46,10 +46,10 @@ elastic-agent enroll [--ca-sha256 ] === 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 `:: @@ -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`:: @@ -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 @@ -145,7 +145,7 @@ elastic-agent inspect output [--output ] [--program ] [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: + -- @@ -197,7 +197,7 @@ elastic-agent run [global-flags] These flags are valid whenever you run `elastic-agent` on the command line. `-c `:: -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`:: @@ -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? + `--path.config `:: -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 `:: @@ -220,7 +224,7 @@ If not specified, {agent} uses `{path.home}/data`. `--path.home `:: 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. diff --git a/x-pack/elastic-agent/docs/elastic-agent-configuration-example.asciidoc b/x-pack/elastic-agent/docs/elastic-agent-configuration-example.asciidoc index b5f0ed0aef6..cd4747b268e 100644 --- a/x-pack/elastic-agent/docs/elastic-agent-configuration-example.asciidoc +++ b/x-pack/elastic-agent/docs/elastic-agent-configuration-example.asciidoc @@ -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] ---- diff --git a/x-pack/elastic-agent/docs/elastic-agent-configuration.asciidoc b/x-pack/elastic-agent/docs/elastic-agent-configuration.asciidoc index d72c572370c..d767fb2f60d 100644 --- a/x-pack/elastic-agent/docs/elastic-agent-configuration.asciidoc +++ b/x-pack/elastic-agent/docs/elastic-agent-configuration.asciidoc @@ -4,6 +4,9 @@ beta[] +// REVIEWERS: Do we want to use "policy settings" instead of configuration +// settings in this topic? + // 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 @@ -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 diff --git a/x-pack/elastic-agent/docs/run-elastic-agent.asciidoc b/x-pack/elastic-agent/docs/run-elastic-agent.asciidoc index 7c48084b8fb..2314f7652f4 100644 --- a/x-pack/elastic-agent/docs/run-elastic-agent.asciidoc +++ b/x-pack/elastic-agent/docs/run-elastic-agent.asciidoc @@ -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}. @@ -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] -. Select **{fleet}**, then click **Add agent** to get an enrollment token. See +. Select **Agents**, then click **Add agent** to get an enrollment token. See <> for detailed steps. . Change to the directory where {agent} is installed, and enroll the agent to @@ -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 <>. diff --git a/x-pack/elastic-agent/docs/running-on-kubernetes.asciidoc b/x-pack/elastic-agent/docs/running-on-kubernetes.asciidoc index 19b4628fde9..3c9e754fad9 100644 --- a/x-pack/elastic-agent/docs/running-on-kubernetes.asciidoc +++ b/x-pack/elastic-agent/docs/running-on-kubernetes.asciidoc @@ -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. + You can use {agent} https://www.docker.elastic.co/r/beats/elastic-agent[Docker images] on Kubernetes to retrieve cluster metrics. @@ -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. diff --git a/x-pack/elastic-agent/docs/unenroll-elastic-agent.asciidoc b/x-pack/elastic-agent/docs/unenroll-elastic-agent.asciidoc index cd77fc3dde3..78c7fab9cf9 100644 --- a/x-pack/elastic-agent/docs/unenroll-elastic-agent.asciidoc +++ b/x-pack/elastic-agent/docs/unenroll-elastic-agent.asciidoc @@ -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.