Skip to content

Commit

Permalink
Remove limitations topic from Fleet and Agent docs (elastic#947)
Browse files Browse the repository at this point in the history
* Remove limitations topic

* Add superuser role requirement

* Mention that agents must have direct connection to fleet server and es
  • Loading branch information
dedemorton committed Aug 3, 2021
1 parent 1c80715 commit 67bae97
Showing 8 changed files with 40 additions and 14 deletions.
4 changes: 4 additions & 0 deletions docs/en/ingest-management/agent-policies.asciidoc
Original file line number Diff line number Diff line change
@@ -202,6 +202,10 @@ Any agents assigned to a policy must be unenrolled or assigned to a different po
[[integration-updates]]
== Integration updates

NOTE: An internet connection is required for {kib} to download integration packages
from the Elastic Package Registry. Make sure the {kib} server can connect to
`https://epr.elastic.co` on port `443`.

Elastic releases integration updates periodically.
Through the online Elastic Package Registry and the {kib} Elastic Package Manager, Integrations are delivered to the {stack}. When Elastic releases a new Integration, it shows up in the Integrations listing in {kib} after a restart (like during a stack upgrade).
// to do: link to the Fleet API docs
Original file line number Diff line number Diff line change
@@ -59,5 +59,3 @@ include::configuration/env/container-envs.asciidoc[leveloffset=+1]
include::elastic-agent-logging.asciidoc[leveloffset=+1]

include::elastic-agent-standalone-logging.asciidoc[leveloffset=+1]

include::redirects.asciidoc[leveloffset=+1]
Original file line number Diff line number Diff line change
@@ -40,15 +40,22 @@ here.

**Prerequisites:**

// TODO: Add a link to the topic about enrollment tokens (instead of the quick start)
// when the topic is available.
* {fleet} is currently only available to users with the
{ref}/built-in-roles.html[superuser role].

* A {fleet-server} must be running in a location accessible to the {agent}. See
<<fleet-server>>.

* In order to use {fleet}, the {agent}s must have a direct network connection
to {fleet-server} and {es}.

* An internet connection is required for {kib} to download integration packages
from the Elastic Package Registry. Make sure the {kib} server can connect to
`https://epr.elastic.co` on port `443`.

* You must have an enrollment token generated by {fleet}. Don't have a {fleet}
enrollment key? Read the {fleet-guide}/fleet-quick-start.html[Quick start
guide] to learn how to get one from {fleet}.
enrollment key? Read <<fleet-enrollment-tokens>> to learn how to get one from
{fleet}.

* You must have the host and IP where {fleet-server} is running. Not sure where
it's running? Look at the {fleet} settings in {kib}.
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@ experimental[]

[discrete]
[[upgrade-agent]]
== Upgrade {agent}
== Upgrade {fleet}-managed {agent}s

Starting with version 7.10, {fleet} provides upgrade capabilities. You can view
and select agents that are out of date, and trigger selected agents to download,
@@ -16,8 +16,10 @@ This approach simplifies the process of keeping your agents up to date. It also
saves you time because you don’t need third-party tools or processes to
manage upgrades.

{agent}s require internet access to perform binary upgrades from {fleet}.

NOTE: The upgrade feature is not supported for upgrading DEB/RPM packages or
Docker images.
Docker images.

To upgrade {agent} to a new version:

9 changes: 7 additions & 2 deletions docs/en/ingest-management/getting-started-traces.asciidoc
Original file line number Diff line number Diff line change
@@ -16,8 +16,6 @@ For feedback and questions, please contact us in the {forum}[discuss forum].
[[fleet-prereqs-traces]]
== Prerequisites

* Please read the <<fleet-limitations,Fleet limitations>>.

* The APM integration is experimental and has a number of known limitations.
Please read the list of {apm-server-ref-v}/apm-integration.html[known limitations].

@@ -32,6 +30,13 @@ Here's what you need for each deployment type:
include::{tab-widgets}/prereq-widget.asciidoc[]
--

* An internet connection is required for {kib} to download integration packages
from the Elastic Package Registry. Make sure the {kib} server can connect to
`https://epr.elastic.co` on port `443`.

* {fleet} is currently only available to users with the
{ref}/built-in-roles.html[superuser role].

[discrete]
[[set-up-fleet-traces]]
== Step 1: Set up {fleet}
9 changes: 7 additions & 2 deletions docs/en/ingest-management/getting-started.asciidoc
Original file line number Diff line number Diff line change
@@ -16,8 +16,6 @@ For feedback and questions, please contact us in the {forum}[discuss forum].
[[fleet-prereqs]]
== Prerequisites

* Please read <<fleet-limitations>>.

* You need {es} for storing and searching your data, and {kib} for visualizing and
managing it. You can use our
{ess-product}[hosted {ess}]
@@ -29,6 +27,13 @@ Here's what you need for each deployment type:
include::{tab-widgets}/prereq-widget.asciidoc[]
--

* An internet connection is required for {kib} to download integration packages
from the Elastic Package Registry. Make sure the {kib} server can connect to
`https://epr.elastic.co` on port `443`.

* {fleet} is currently only available to users with the
{ref}/built-in-roles.html[superuser role].

[discrete]
[[set-up-fleet]]
== Step 1: Set up {fleet}
4 changes: 2 additions & 2 deletions docs/en/ingest-management/index.asciidoc
Original file line number Diff line number Diff line change
@@ -32,8 +32,6 @@ include::overview.asciidoc[leveloffset=+1]

include::beats-agent-comparison.asciidoc[leveloffset=+1]

include::fleet/fleet-limitations.asciidoc[leveloffset=+1]

include::getting-started.asciidoc[leveloffset=+1]

include::getting-started-traces.asciidoc[leveloffset=+1]
@@ -61,3 +59,5 @@ include::faq.asciidoc[leveloffset=+1]
include::release-notes/release-notes-7.14.asciidoc[leveloffset=+1]

include::fleet/fleet-api-docs.asciidoc[leveloffset=+1]

include::redirects.asciidoc[leveloffset=+1]
Original file line number Diff line number Diff line change
@@ -8,3 +8,8 @@ The following pages have moved or been deleted.

See <<run-elastic-agent-standalone>>.

[role="exclude",id="fleet-limitations"]
== Limitations of this release

See <<beats-agent-comparison>>.

0 comments on commit 67bae97

Please sign in to comment.