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 docs for reusable integrations policies #1264

Merged
merged 6 commits into from
Aug 28, 2024
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
54 changes: 22 additions & 32 deletions docs/en/ingest-management/agent-policies.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -147,12 +147,9 @@ See also the <<agent-policy-scale,recommended scaling options>> for an {agent} p
To manage your {agent}s and the data they collect, create a new policy:

In {fleet}, open the **Agent policies** tab and click **Create agent policy**.

. Name your policy. All other fields are optional and can be modified later.
By default, each policy enables the _system_ integration, which collects system information and metrics.
+
[role="screenshot"]
image::images/create-agent-policy.png[{fleet} in {kib}]
+
. Create the agent policy:
* To use the UI, click **Create agent policy**.
* To use the {fleet} API, click **Preview API request** and run the
Expand All @@ -164,36 +161,29 @@ Also see <<create-a-policy-no-ui>>.
[[add-integration]]
== Add an integration to a policy

Policies consist of one or more integrations.
To add a new integration to a policy:
An {agent} policy consists of one or more integrations that are applied to the agents enrolled in that policy.
To add a new integration to one or more {agent} policies:

. In {fleet}, click **Agent policies**.
Click the name of the policy you want to add an integration to.

. Click **Add integration**.

. Search for and select an integration. You can select a category to narrow your search.

. Click **Add <Integration>**.

. Name the integration and add any required configuration variables.
+
NOTE: Integration policy names must be globally unique across all agent
policies.

. Save the integration policy as part of the larger {agent} policy:
+
--
* To use the UI, click **Save and continue**.
* To use the {fleet} API, click **Preview API request** and run the
request.
--

{fleet} distributes this new policy to all {agent}s that are enrolled in the
{agent} policy.

After the policy has finished applying, the selected integration will be running on the host
and communicating with the {agent}.
Click the name of a policy you want to add an integration to.
. Click **Add <integration>**.
. The Integrations page shows {agent} integrations along with other types, such as {beats}. Scroll down and select **Elastic Agent only** to view only integrations that work with {agent}.
. You can opt to install an {agent} if you haven't already, or choose **Add integration only** to proceed.
. In Step 1 on the **Add <integration>** page, you can select the configuration settings specific to the integration.
. In Step 2 on the page, you have two options:
.. If you'd like to create a new policy for your {agent}s, on the **New hosts** tab specify a name for the new agent policy and choose whether or not to collect system logs and metrics.
Collecting logs and metrics will add the System integration to the new agent policy.
.. If you already have an {agent} policy created, on the **Existing hosts** tab use the drop-down menu to specify one or more agent policies that you'd like to add the integration to.
. Click **Save and continue** to confirm your settings.

This action installs the integration and adds it to the {agent} policies that you specified.
{fleet} distributes the new integration policy to all {agent}s that are enrolled in the agent policies.

You can update the settings for an installed integration at any time:

. In {kib}, go to the **Integrations** page.
. On the **Integration policies** tab, for the integration that you like to update open the **Actions** menu and select **Edit integration**.
. On the **Edit <integration>** page you can update any configuration settings and also update the list of {agent} polices to which the integration is added.

[discrete]
[[apply-a-policy]]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,45 +1,33 @@
[[add-integration-to-policy]]
= Add an {agent} integration to a policy
= Add an integration to an {agent} policy

++++
<titleabbrev>Add an integration to a policy</titleabbrev>
<titleabbrev>Add an integration to an {agent} policy</titleabbrev>
++++

Policies consist of one or more integrations. To add a new integration to a
policy:
An <<agent-policy,{agent} policy>> consists of one or more integrations that are applied to the agents enrolled in that policy.
To add a new integration to one or more {agent} policies:

. In {kib}, go to the **Integrations** page.
+
Notice that the Integrations page shows {agent} integrations along with other
types, such as {beats}.
// lint ignore elastic-agent
. Scroll down and select **Elastic Agent only** so the view shows
integrations that work with {agent}.
+
[role="screenshot"]
image::images/unified-view-selector.png[Screen capture showing options for filtering the view]
. The Integrations page shows {agent} integrations along with other types, such as {beats}. Scroll down and select **Elastic Agent only** to view only integrations that work with {agent}.
. Search for and select an integration. You can select a category to narrow your search.
. Click **Add <Integration>**.
. Name the integration and add any required configuration variables.
+
NOTE: Integration policy names must be globally unique across all agent
policies.

. Choose the agent policy you want to add the integration to. You can choose an
existing agent policy or create a new one.

. Save the integration policy:
+
--
* To use the UI, click **Save integration**.
* To use the {fleet} API, click **Preview API request** and run the
request.
--

This action installs the integration (if it's not already installed) and saves
the integration policy as a part of the larger {agent} policy. {fleet}
distributes this new policy to all {agent}s that are enrolled in the agent
policy.
. Click **Add <integration>**.
. You can opt to install an {agent} if you haven't already, or choose **Add integration only** to proceed.
. In Step 1 on the **Add <integration>** page, you can select the configuration settings specific to the integration.
. In Step 2 on the page, you have two options:
.. If you'd like to create a new policy for your {agent}s, on the **New hosts** tab specify a name for the new agent policy and choose whether or not to collect system logs and metrics.
Collecting logs and metrics will add the System integration to the new agent policy.
.. If you already have an {agent} policy created, on the **Existing hosts** tab use the drop-down menu to specify one or more agent policies that you'd like to add the integration to.
. Click **Save and continue** to confirm your settings.

This action installs the integration (if it's not already installed) and adds it to the {agent} policies that you specified.
{fleet} distributes the new integration policy to all {agent}s that are enrolled in the agent policies.

You can update the settings for an installed integration at any time:

. In {kib}, go to the **Integrations** page.
. On the **Integration policies** tab, for the integration that you like to update open the **Actions** menu and select **Edit integration**.
. On the **Edit <integration>** page you can update any configuration settings and also update the list of {agent} polices to which the integration is added.

If you haven't deployed any {agent}s yet or set up agent policies, start with
one of our quick start guides:
Expand Down