Skip to content

Commit

Permalink
Update getting started guide to include Fleet Server
Browse files Browse the repository at this point in the history
  • Loading branch information
dedemorton committed Apr 30, 2021
1 parent e43f37b commit 76797fa
Show file tree
Hide file tree
Showing 9 changed files with 39 additions and 61 deletions.
84 changes: 36 additions & 48 deletions docs/en/ingest-management/getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -37,25 +37,16 @@ by using {fleet} in {kib}.
TIP: Not using {fleet}? Advanced users who want to configure and manage
{agent}s manually can <<run-elastic-agent-standalone,run agents standalone>>.

The first time you use {fleet}, you need to set it up:
The first time you use {fleet}, you need to set it up and add {fleet-server}:

. Log in to {kib} and go to **Management > {fleet}**.
+
[role="screenshot"]
image::images/kibana-fleet-start.png[{fleet} in {kib}]
//TODO: Make Fleet Server an active link to the Fleet Server topic

. 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-fleet-settings.png[{fleet} settings]
//TODO: Use tagged regions to include steps from the Fleet Server docs.

. Enable central management. Click the **Agents** tab and click
**Create user and enable central management**.
+
[role="screenshot"]
image::images/kibana-fleet-enable.png[{fleet} showing prompt to enable central management]
//TODO: Add fleet/images/management-nav.png (for new users)

//TODO: Indicate that the page might take a minute to load because it's setting
//up stuff behind the scenes

[discrete]
[[add-agent-to-fleet]]
Expand All @@ -65,45 +56,37 @@ include::elastic-agent/elastic-agent.asciidoc[tag=agent-install-intro]

To send logs and metrics to the {stack}:

. On the **Agents** tab in {fleet}, click **Add agent**, and look at the
deployment instructions under **Enroll in {fleet}**.
. On the **Agents** tab in {fleet}, click **Add agent**.

. As instructed, download and extract the {agent} to your host. To do this
quickly from the command line, run:
. Follow the in-product installation steps under **Enroll in {fleet}**.
+
--
include::elastic-agent/install-elastic-agent.asciidoc[tag=install-elastic-agent]

See the https://www.elastic.co/downloads/elastic-agent[download page] for other
installation options.
--
[role="screenshot"]
image::images/add-agent.png[]

. Back in {fleet}, under **Choose an agent policy**, notice that the default
policy is selected. The default policy includes a system integration for
collecting logs and metrics from the host system. Use the default policy to get
started quickly.
*Notes:*

. Under **Enroll and start the {agent}**, copy the install command if it's
available for your platform, or make a note of the {kib} URL and enrollment
token that was generated by {fleet}.
+
[role="screenshot"]
image::images/kibana-fleet-enroll.png[{fleet} showing agent enrollment page]
* Use the default agent policy to get started quickly. This policy includes a
system integration for collecting logs and metrics from the host system. You
can change the policy later.

. From the agent directory, run the appropriate command to install, enroll, and
start an {agent}. Note that this command installs {agent} files in the locations
described in <<installation-layout>>.
* The `install` command installs the {agent} as a managed service and enrolls it
in the selected policy. For example:
+
--
include::{tab-widgets}/install-widget.asciidoc[]
--
[source, yaml]
----
./elastic-agent install -f --url=https://10.0.2.2:8220 \
--enrollment-token=blJqaUdua0JqYXA0bmNscVVjUkE6ZGh4WWNRSHRRek9aSS1paEs2cHdFQQ==
----
+
Because {agent} is installed as an auto-starting service, it will restart
automatically if the system is rebooted.
* Because {agent} is installed as an auto-starting service, it will restart
automatically if the system is rebooted.

* To see where files are installed, see <<installation-layout>>.

If installation is successful, you’ll see the agent on the *Agents*
tab in *Fleet*. Notice that the Default policy is assigned to the
agent.

. In {fleet}, click **Continue** to go to the **Agents** tab, where you should
see the newly enrolled agent.
+
[role="screenshot"]
image::images/kibana-fleet-agents.png[{fleet} showing enrolled agents]

Expand All @@ -112,6 +95,8 @@ is running.

If you run into problems, see <<fleet-troubleshooting>>.

//TODO: Update Troubleshooting. It has some old info.

[discrete]
[[view-data]]
== Step 3: Monitor host logs and metrics
Expand Down Expand Up @@ -174,7 +159,10 @@ and make sure the **Paths** are correct for your host. Inspect or change other
settings

. When you're done, save and deploy the changes.
+

. To see the updated policy, click the *Policies* tab, then click the
*Default policy* link.

The newly added Nginx integration should appear under **Integrations** in the
default policy, along with the `system-1` integration that you used earlier to
collect host data.
Expand Down
Binary file added docs/en/ingest-management/images/add-agent.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/en/ingest-management/images/add-integration.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/en/ingest-management/images/kibana-fleet-agents.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/en/ingest-management/images/kibana-fleet-datastreams.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 3 additions & 13 deletions docs/en/ingest-management/tab-widgets/prereq.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,8 @@ on {ecloud}. The {ess} is available on AWS, GCP, and Azure. {ess-trial}[Try it o
license. {stack-gs}/get-started-elastic-stack.html[Learn how to install the
{stack} on your own hardware].
* Secure, encrypted connection between {kib} and {es}. See:
** {ref}/configuring-security.html[Configuring security in {es}]
** {kibana-ref}/using-kibana-with-security.html[Configuring security in {kib}]
** {kibana-ref}/configuring-tls.html[Encrypt communications in {kib}]
+
TIP: You can disable the TLS check by setting
`xpack.fleet.agents.tlsCheckDisabled: true` in the {kib}
configuration. For example, you might want to do this if {kib} is
behind a proxy that terminates the SSL connection.
* Secure, encrypted connection between {kib} and {es}. For more information,
see {ref}/configuring-stack-security.html[Configure security for the {stack}].
* User with the superuser role. See {ref}/built-in-roles.html[Built-in roles].
Expand All @@ -33,7 +26,7 @@ must be set. {fleet} requires this setting in order to save API keys and encrypt
them in {kib}. You can either set `xpack.encryptedSavedObjects.encryptionKey` to
an alphanumeric value of at least 32 characters, or run the
{kibana-ref}/kibana-encryption-keys.html[`kibana-encryption-keys` command] to
generate the key.
generate the key.
**Example security settings**

Expand All @@ -53,9 +46,6 @@ kibana.yml example:
[source,yaml]
----
xpack.security.enabled: true
xpack.fleet.agents.tlsCheckDisabled: true
xpack.encryptedSavedObjects.encryptionKey: "something_at_least_32_characters"
elasticsearch.username: "my_username"
elasticsearch.password: "my_password"
----
// end::self-managed[]

0 comments on commit 76797fa

Please sign in to comment.