Skip to content

Commit

Permalink
[DOCS] Fix problems in Elastic Agent docs found during doc testing (e…
Browse files Browse the repository at this point in the history
…lastic#19252) (elastic#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.
  • Loading branch information
dedemorton authored Jun 17, 2020
1 parent 77bc7a5 commit d680b8f
Show file tree
Hide file tree
Showing 6 changed files with 50 additions and 37 deletions.
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
[[elastic-agent-cmd-options]]
[role="xpack"]
= Command line options

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

experimental[]
Expand Down
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
4 changes: 4 additions & 0 deletions x-pack/elastic-agent/docs/elastic-agent.asciidoc
Original file line number Diff line number Diff line change
@@ -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:

Expand Down
14 changes: 9 additions & 5 deletions x-pack/elastic-agent/docs/install-elastic-agent.asciidoc
Original file line number Diff line number Diff line change
@@ -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"]
Expand Down Expand Up @@ -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[]

64 changes: 33 additions & 31 deletions x-pack/elastic-agent/docs/run-elastic-agent.asciidoc
Original file line number Diff line number Diff line change
@@ -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 <<elastic-agent-configuration>>.

//<<elastic-agent-configuration-example,`elastic-agent_configuration_example.yml`>>
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 <<ingest-management-getting-started>> for detailed steps.

. Enroll the agent:
. Enroll the Agent:
+
[source,shell]
----
Expand All @@ -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 <<elastic-agent-configuration>>.

//<<elastic-agent-configuration-example,`elastic-agent_configuration_example.yml`>>

0 comments on commit d680b8f

Please sign in to comment.