From d680b8f61c5c398247857c58345c2e97232cbf6a Mon Sep 17 00:00:00 2001 From: DeDe Morton Date: Wed, 17 Jun 2020 14:02:30 -0700 Subject: [PATCH] [DOCS] Fix problems in Elastic Agent docs found during doc testing (#19252) (#19254) * [DOCS] Fix problems found during doc testing * Mark all topics as licensed (xpack) * Capitalize Agent to match current style guidelines * More changes to capitalize Agent * Remove reviewer comment. --- .../docs/elastic-agent-command-line.asciidoc | 1 + ...astic-agent-configuration-example.asciidoc | 1 + .../docs/elastic-agent-configuration.asciidoc | 3 +- .../elastic-agent/docs/elastic-agent.asciidoc | 4 ++ .../docs/install-elastic-agent.asciidoc | 14 ++-- .../docs/run-elastic-agent.asciidoc | 64 ++++++++++--------- 6 files changed, 50 insertions(+), 37 deletions(-) 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 2068e94f3422..bbbd083e8cc4 100644 --- a/x-pack/elastic-agent/docs/elastic-agent-command-line.asciidoc +++ b/x-pack/elastic-agent/docs/elastic-agent-command-line.asciidoc @@ -1,4 +1,5 @@ [[elastic-agent-cmd-options]] +[role="xpack"] = Command line options experimental[] 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 2300f7f96217..464712c6a278 100644 --- a/x-pack/elastic-agent/docs/elastic-agent-configuration-example.asciidoc +++ b/x-pack/elastic-agent/docs/elastic-agent-configuration-example.asciidoc @@ -1,4 +1,5 @@ [[elastic-agent-configuration-example]] +[role="xpack"] = Configuration example experimental[] diff --git a/x-pack/elastic-agent/docs/elastic-agent-configuration.asciidoc b/x-pack/elastic-agent/docs/elastic-agent-configuration.asciidoc index fc34d15503c6..abb28cc154aa 100644 --- a/x-pack/elastic-agent/docs/elastic-agent-configuration.asciidoc +++ b/x-pack/elastic-agent/docs/elastic-agent-configuration.asciidoc @@ -1,11 +1,12 @@ [[elastic-agent-configuration]] +[role="xpack"] = Configuration settings experimental[] By default {agent} runs in standalone mode to ingest system data and send it to a local {es} instance running on port 9200. It uses the demo credentials of the -`elastic` user. It's also configured to monitor all {beats} managed by the agent +`elastic` user. It's also configured to monitor all {beats} managed by the Agent and send the {beats} logs and metrics to the same {es) instance. To alter this behavior, configure the output and other configuration settings: diff --git a/x-pack/elastic-agent/docs/elastic-agent.asciidoc b/x-pack/elastic-agent/docs/elastic-agent.asciidoc index 92cbfdd7e42c..1dc9a1a8ba35 100644 --- a/x-pack/elastic-agent/docs/elastic-agent.asciidoc +++ b/x-pack/elastic-agent/docs/elastic-agent.asciidoc @@ -1,11 +1,15 @@ [[elastic-agent-installation-configuration]] +[role="xpack"] + = Manage your {agent}s experimental[] +// tag::agent-install-intro[] {agent} is a single, unified agent that you can deploy to hosts or containers to collect data and send it to the {stack}. Behind the scenes, {agent} runs the {beats} shippers or Endpoint required for your configuration. +// end::agent-install-intro[] To learn how to install, configure, and run your {agent}s, see: diff --git a/x-pack/elastic-agent/docs/install-elastic-agent.asciidoc b/x-pack/elastic-agent/docs/install-elastic-agent.asciidoc index 06cca040135a..3f8df7bb94c5 100644 --- a/x-pack/elastic-agent/docs/install-elastic-agent.asciidoc +++ b/x-pack/elastic-agent/docs/install-elastic-agent.asciidoc @@ -1,17 +1,18 @@ -:release-state: released - [[elastic-agent-installation]] +[role="xpack"] = Install {agent} experimental[] -Download and install the agent on each system you want to monitor. +Download and install the Agent on each system you want to monitor. + +//TODO: Replace with tabbed panel when the code is stable. + +// tag::install-elastic-agent[] To download and install {elastic-agent}, use the commands that work with your system: -//TODO: Replace with tabbed panels when the code is stable (might be after 7.8). - *mac:* ifeval::["{release-state}"=="unreleased"] @@ -79,3 +80,6 @@ PS C:\Program Files\Elastic-Agent> .\install-service-elastic-agent.ps1 NOTE: If script execution is disabled on your system, you need to set the execution policy for the current session to allow the script to run. For example: `PowerShell.exe -ExecutionPolicy UnRestricted -File .\install-service-elastic-agent.ps1`. endif::[] + +// end::install-elastic-agent[] + diff --git a/x-pack/elastic-agent/docs/run-elastic-agent.asciidoc b/x-pack/elastic-agent/docs/run-elastic-agent.asciidoc index 560b3eb19d85..7ea68c4770dd 100644 --- a/x-pack/elastic-agent/docs/run-elastic-agent.asciidoc +++ b/x-pack/elastic-agent/docs/run-elastic-agent.asciidoc @@ -1,55 +1,31 @@ [[run-elastic-agent]] +[role="xpack"] = Run {agent} experimental[] {agent} runs in two modes: standalone or fleet. The two modes differ in how you -configure and manage the agent. - -[float] -[[standalone-mode]] -== Run in standalone mode (default) - -With _standalone mode_, you manually configure and manage the agent locally. -Each agent is configured to be in standalone mode by default after installation. - -If {agent} is installed as an auto-starting service, it will run automatically -when you restart your system. - -To start {agent} manually, run: - -[source,shell] ----- -./elastic-agent run ----- - -If no configuration file is specified, {agent} uses the default configuration, -`elastic-agent.yml`, which is located in the same directory as {agent}. Specify -the `-c` flag to use a different configuration file. - -For configuration options, see <>. - -//<> +configure and manage the Agent. [float] [[fleet-mode]] == 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} +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. To create a trusted communication channel between {agent} and {kib}, enroll the -agent to {fleet}. +Agent to {fleet}. To enroll an {agent} to {fleet}: -. Stop the agent, if it's already running. +. Stop the Agent, if it's already running. . Go the **{fleet}** tab in {ingest-manager}, and click **Enroll new agent** to generate a token. See <> for detailed steps. -. Enroll the agent: +. Enroll the Agent: + [source,shell] ---- @@ -63,3 +39,29 @@ To start {agent}, run: ---- ./elastic-agent run ---- + +[float] +[[standalone-mode]] +== Run in standalone mode (default) + +With _standalone mode_, you manually configure and manage the Agent locally. +Each Agent is configured to be in standalone mode by default after installation. + +If {agent} is installed as an auto-starting service, it will run automatically +when you restart your system. + +To start {agent} manually, run: + +[source,shell] +---- +./elastic-agent run +---- + +If no configuration file is specified, {agent} uses the default configuration, +`elastic-agent.yml`, which is located in the same directory as {agent}. Specify +the `-c` flag to use a different configuration file. + +For configuration options, see <>. + +//<> +