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

Update getting started guide to include Fleet Server #602

Merged
merged 2 commits into from
May 5, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
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
80 changes: 32 additions & 48 deletions docs/en/ingest-management/getting-started-traces.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -38,25 +38,12 @@ include::{tab-widgets}/prereq-widget.asciidoc[]

Use {fleet} in {kib} to get APM data into the {stack}.

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

. Log in to {kib} and go to **Management > {fleet}**.
+
[role="screenshot"]
image::images/kibana-fleet-start.png[{fleet} in {kib}]
include::{tab-widgets}/add-fleet-server/widget.asciidoc[]

. 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]

. 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]
For more information, see <<fleet-server>>.

[discrete]
[[add-agent-to-fleet-traces]]
Expand All @@ -76,45 +63,40 @@ If RUM is disabled, you should run {agent} on edge machines.

To send APM data 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:
. Under **Enroll in {fleet}**, follow the in-product installation steps.
+
[role="screenshot"]
image::images/add-agent.png[]
+
--
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.
--

. 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 {fleet} generated.
+
[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>>.
+
--
include::{tab-widgets}/install-widget.asciidoc[]
--
* The `install` command installs the {agent} as a managed service, enrolls it
in the selected policy, and starts the service. For example:
+
Because {agent} is installed as an auto-starting service, it will restart
automatically if the system is rebooted.
[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.

* 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. You should
see the newly enrolled agent.
+
[role="screenshot"]
image::images/kibana-fleet-agents.png[{fleet} showing enrolled agents]

Expand All @@ -123,6 +105,7 @@ is running.

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


[discrete]
[[add-apm-integration]]
== Step 3: Add the APM integration
Expand Down Expand Up @@ -157,7 +140,8 @@ image::images/add-integration-apm.png[{fleet} Add APM integration page]
Under **Host**, define the host and port where APM Server will listen.
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 APM integration should appear under **Integrations** in the
default policy, along with the default `system-1` integration.
Expand Down
94 changes: 40 additions & 54 deletions docs/en/ingest-management/getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,46 +16,34 @@ For feedback and questions, please contact us in the {forum}[discuss forum].
[[fleet-prereqs]]
== Prerequisites

Before you begin, please read <<fleet-limitations>>.
* Please read <<fleet-limitations>>.

You need {es} for storing and searching your data, and {kib} for visualizing and
* You need {es} for storing and searching your data, and {kib} for visualizing and
managing it. You can use our
{ess-product}[hosted {ess}]
on {ecloud} (recommended), or self-manage the {stack} on your own hardware.

+
Here's what you need for each deployment type:

+
--
include::{tab-widgets}/prereq-widget.asciidoc[]
--

[discrete]
[[set-up-fleet]]
== Step 1: Set up {fleet}

The best way to get logs, metrics, and security data into the {stack} is
by using {fleet} in {kib}.
Use {fleet} in {kib} to get logs, metrics, and security data into the {stack}.

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:

. Log in to {kib} and go to **Management > {fleet}**.
+
[role="screenshot"]
image::images/kibana-fleet-start.png[{fleet} in {kib}]
The first time you use {fleet}, you might need to set it up and add a
{fleet-server}:

. 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]
include::{tab-widgets}/add-fleet-server/widget.asciidoc[]

. 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]
For more information, see <<fleet-server>>.

[discrete]
[[add-agent-to-fleet]]
Expand All @@ -65,45 +53,41 @@ 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:
. Under **Enroll in {fleet}**, follow the in-product installation steps.
+
[role="screenshot"]
image::images/add-agent.png[]
+
--
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.
--

. 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]

. 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>>.
* 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.

* The `install` command installs the {agent} as a managed service, enrolls it
in the selected policy, and starts the service. 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 Down Expand Up @@ -174,10 +158,12 @@ 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.
default policy, along with the `system-1` integration.
+
[role="screenshot"]
image::images/kibana-fleet-policies-default-with-nginx.png[{fleet} showing default agent policy with nginx-1 datasource]
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.
Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,11 @@ To add {fleet-server}:

//TODO: Mention API for adding the token.

. Log in to {kib} and go to *Management > {fleet}*.
. Log in to {kib} and go to *Management > {fleet}*. The first time you visit
this page, it might take a minute to load.

. Click *{fleet} settings*, and in the *{fleet-server} hosts* field, specify the
URL {agent}s will use to connect to {fleet-server}. For example,
URLs {agent}s will use to connect to {fleet-server}. For example,
`https://192.0.2.1:8220`, where `192.0.2.1` is the host IP where you will
install {fleet-server}.

Expand Down
17 changes: 4 additions & 13 deletions docs/en/ingest-management/tab-widgets/prereq.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
// tag::cloud[]
* Access to a deployment of our {ess-product}[hosted {ess}]
on {ecloud}. The {ess} is available on AWS, GCP, and Azure. {ess-trial}[Try it out for free].
This deployment must include an APM & Fleet node.

* User with the superuser role. See {ref}/built-in-roles.html[Built-in roles].
// end::cloud[]
Expand All @@ -11,15 +12,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 +27,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 +47,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[]