From 02427f20549f012137d311c66544e8259f9927a1 Mon Sep 17 00:00:00 2001 From: David Kilfoyle Date: Tue, 20 Aug 2024 18:08:56 -0400 Subject: [PATCH 1/6] Update docs for reusable integrations policies --- .../ingest-management/agent-policies.asciidoc | 39 ++++++------------ .../add-integration-to-policy.asciidoc | 40 +++++++++---------- 2 files changed, 31 insertions(+), 48 deletions(-) diff --git a/docs/en/ingest-management/agent-policies.asciidoc b/docs/en/ingest-management/agent-policies.asciidoc index 2edc9f907..debd7983b 100644 --- a/docs/en/ingest-management/agent-policies.asciidoc +++ b/docs/en/ingest-management/agent-policies.asciidoc @@ -164,36 +164,23 @@ Also see <>. [[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 **. - -. 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 **Add **. +. 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 ** 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. [discrete] [[apply-a-policy]] diff --git a/docs/en/ingest-management/integrations/add-integration-to-policy.asciidoc b/docs/en/ingest-management/integrations/add-integration-to-policy.asciidoc index 8dbe4c375..9e344bafc 100644 --- a/docs/en/ingest-management/integrations/add-integration-to-policy.asciidoc +++ b/docs/en/ingest-management/integrations/add-integration-to-policy.asciidoc @@ -1,12 +1,12 @@ [[add-integration-to-policy]] -= Add an {agent} integration to a policy += Add an {agent} integration to one or more {agent} policies ++++ -Add an integration to a policy +Add an integration to one or more policies ++++ -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 {kib}, go to the **Integrations** page. + @@ -20,26 +20,22 @@ integrations that work with {agent}. image::images/unified-view-selector.png[Screen capture showing options for filtering the view] . Search for and select an integration. You can select a category to narrow your search. . Click **Add **. -. Name the integration and add any required configuration variables. -+ -NOTE: Integration policy names must be globally unique across all agent -policies. +. 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 ** 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. -. Choose the agent policy you want to add the integration to. You can choose an -existing agent policy or create a new one. +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. -. 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. +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 ** 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: From 288e23344de05800b9bced742c1811009fd8e9b6 Mon Sep 17 00:00:00 2001 From: David Kilfoyle Date: Thu, 22 Aug 2024 12:14:31 -0400 Subject: [PATCH 2/6] Cleanup --- .../ingest-management/agent-policies.asciidoc | 17 ++++++++++------- .../add-integration-to-policy.asciidoc | 16 ++++------------ 2 files changed, 14 insertions(+), 19 deletions(-) diff --git a/docs/en/ingest-management/agent-policies.asciidoc b/docs/en/ingest-management/agent-policies.asciidoc index debd7983b..2911c80a2 100644 --- a/docs/en/ingest-management/agent-policies.asciidoc +++ b/docs/en/ingest-management/agent-policies.asciidoc @@ -147,12 +147,9 @@ See also the <> 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 @@ -168,9 +165,9 @@ An {agent} policy consists of one or more integrations that are applied to the a 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 the name of a policy you want to add an integration to. . Click **Add **. +. 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 ** page, you can select the configuration settings specific to the integration. . In Step 2 on the page, you have two options: @@ -179,9 +176,15 @@ Collecting logs and metrics will add the System integration to the new agent pol .. 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. +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 ** 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]] == Apply a policy diff --git a/docs/en/ingest-management/integrations/add-integration-to-policy.asciidoc b/docs/en/ingest-management/integrations/add-integration-to-policy.asciidoc index 9e344bafc..4c73fcfcb 100644 --- a/docs/en/ingest-management/integrations/add-integration-to-policy.asciidoc +++ b/docs/en/ingest-management/integrations/add-integration-to-policy.asciidoc @@ -1,23 +1,15 @@ [[add-integration-to-policy]] -= Add an {agent} integration to one or more {agent} policies += Add an integration to an {agent} policy ++++ -Add an integration to one or more policies +Add an integration to an {agent} policy ++++ -An {agent} policy consists of one or more integrations that are applied to the agents enrolled in that policy. +An <> 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 **. . You can opt to install an {agent} if you haven't already, or choose **Add integration only** to proceed. From 26110eefa5cb03e6f5d46143b6aed7174be59239 Mon Sep 17 00:00:00 2001 From: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com> Date: Wed, 28 Aug 2024 10:43:50 -0400 Subject: [PATCH 3/6] Update docs/en/ingest-management/agent-policies.asciidoc Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com> --- docs/en/ingest-management/agent-policies.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/ingest-management/agent-policies.asciidoc b/docs/en/ingest-management/agent-policies.asciidoc index 2911c80a2..75ba712c0 100644 --- a/docs/en/ingest-management/agent-policies.asciidoc +++ b/docs/en/ingest-management/agent-policies.asciidoc @@ -166,7 +166,7 @@ To add a new integration to one or more {agent} policies: . In {fleet}, click **Agent policies**. Click the name of a policy you want to add an integration to. -. Click **Add **. +. Click **Add **. . 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 ** page, you can select the configuration settings specific to the integration. From 2ad5ee350f7eb5a585a83491e428e4ddc4662af4 Mon Sep 17 00:00:00 2001 From: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com> Date: Wed, 28 Aug 2024 10:43:58 -0400 Subject: [PATCH 4/6] Update docs/en/ingest-management/agent-policies.asciidoc Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com> --- docs/en/ingest-management/agent-policies.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/ingest-management/agent-policies.asciidoc b/docs/en/ingest-management/agent-policies.asciidoc index 75ba712c0..1fd6a1cfc 100644 --- a/docs/en/ingest-management/agent-policies.asciidoc +++ b/docs/en/ingest-management/agent-policies.asciidoc @@ -169,7 +169,7 @@ Click the name of a policy you want to add an integration to. . Click **Add **. . 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 ** page, you can select the configuration settings specific to the integration. +. In Step 1 on the **Add ** 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. From 4ca314c01c1f1b12df249c03b64048739ca738d9 Mon Sep 17 00:00:00 2001 From: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com> Date: Wed, 28 Aug 2024 10:44:04 -0400 Subject: [PATCH 5/6] Update docs/en/ingest-management/integrations/add-integration-to-policy.asciidoc Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com> --- .../integrations/add-integration-to-policy.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/ingest-management/integrations/add-integration-to-policy.asciidoc b/docs/en/ingest-management/integrations/add-integration-to-policy.asciidoc index 4c73fcfcb..fc0dea97b 100644 --- a/docs/en/ingest-management/integrations/add-integration-to-policy.asciidoc +++ b/docs/en/ingest-management/integrations/add-integration-to-policy.asciidoc @@ -13,7 +13,7 @@ To add a new integration to one or more {agent} policies: . Search for and select an integration. You can select a category to narrow your search. . Click **Add **. . 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 ** page, you can select the configuration settings specific to the integration. +. In Step 1 on the **Add ** 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. From f878a3067cc7f5b902ccec47d219acd5dd286de1 Mon Sep 17 00:00:00 2001 From: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com> Date: Wed, 28 Aug 2024 10:44:12 -0400 Subject: [PATCH 6/6] Update docs/en/ingest-management/integrations/add-integration-to-policy.asciidoc Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com> --- .../integrations/add-integration-to-policy.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/ingest-management/integrations/add-integration-to-policy.asciidoc b/docs/en/ingest-management/integrations/add-integration-to-policy.asciidoc index fc0dea97b..9033a38e8 100644 --- a/docs/en/ingest-management/integrations/add-integration-to-policy.asciidoc +++ b/docs/en/ingest-management/integrations/add-integration-to-policy.asciidoc @@ -11,7 +11,7 @@ To add a new integration to one or more {agent} policies: . In {kib}, go to the **Integrations** page. . 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 **. +. Click **Add **. . 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 ** page, you can select the configuration settings specific to the integration. . In Step 2 on the page, you have two options: