From 20a669f7cd6147347220c8b20f0a3bdf329b327e Mon Sep 17 00:00:00 2001 From: leahleahy <82116004+leahleahy@users.noreply.github.com> Date: Wed, 14 Apr 2021 21:49:40 -0400 Subject: [PATCH 1/3] Update running-on-kubernetes-standalone.asciidoc --- .../running-on-kubernetes-standalone.asciidoc | 38 +++++++++---------- 1 file changed, 18 insertions(+), 20 deletions(-) diff --git a/docs/en/ingest-management/elastic-agent/running-on-kubernetes-standalone.asciidoc b/docs/en/ingest-management/elastic-agent/running-on-kubernetes-standalone.asciidoc index 87ce15bef9..e6ae0d8570 100644 --- a/docs/en/ingest-management/elastic-agent/running-on-kubernetes-standalone.asciidoc +++ b/docs/en/ingest-management/elastic-agent/running-on-kubernetes-standalone.asciidoc @@ -2,13 +2,12 @@ [role="xpack"] === Run {agent} on Kubernetes -You can use {agent} https://www.docker.elastic.co/r/beats/elastic-agent[Docker images] on Kubernetes to +Use {agent} https://www.docker.elastic.co/r/beats/elastic-agent[Docker images] on Kubernetes to retrieve cluster metrics. ifeval::["{release-state}"=="unreleased"] -However, version {version} of {agent} has not yet been -released, so no Docker image is currently available for this version. +A Docker image is not currently available for this version, as version {version} of {agent} has not yet been released. endif::[] @@ -16,12 +15,12 @@ endif::[] [float] ==== Kubernetes deploy manifests -You deploy {agent} in two different ways at the same time: +Deploy {agent} in two different ways at the same time: * As a https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/[DaemonSet] to ensure that there's a running instance on each node of the cluster. These -instances are used to retrieve most metrics from the host, such as system -metrics, Docker stats, and metrics from all the services running on top of +instances are used to retrieve metrics from the host, such as system +metrics, Docker stats, and metrics from all the services running on Kubernetes. * As a single {agent} instance created using a https://kubernetes.io/docs/concepts/workloads/controllers/Deployment/[Deployment]. @@ -32,24 +31,23 @@ running, deploy it now (see the https://github.com/kubernetes/kube-state-metrics#kubernetes-deployment[Kubernetes deployment] docs) -Everything is deployed under the `kube-system` namespace by default. To change -the namespace, modify the manifest file. +Everything is deployed under the `kube-system` namespace by default. Change the namespace by modifying the manifest file. -To download the manifest file, run: +Download the manifest file by running: ["source", "sh", subs="attributes"] ------------------------------------------------ curl -L -O https://raw.githubusercontent.com/elastic/beats/{branch}/deploy/kubernetes/elastic-agent-standalone-kubernetes.yaml ------------------------------------------------ -This manifest includes Kubernetes integration to collect Kubernetes metrics, -System integration to collect system level metrics/logs from nodes and -Pod's log collection using <>. +This manifest includes the Kubernetes integration to collect Kubernetes metrics, +System integration to collect system level metrics and logs from nodes, and +the Pod's log collection using <>. [float] ==== Settings -User need to set Elasticsearch settings before deploying the manifest: +Set the Elasticsearch settings before deploying the manifest: [source,yaml] ------------------------------------------------ @@ -64,10 +62,10 @@ User need to set Elasticsearch settings before deploying the manifest: [float] ===== Running {agent} on master nodes -Kubernetes master nodes can use https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/[taints] +Kubernetes master nodes use https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/[taints] to limit the workloads that can run on them. The manifest for standalone {agent} defines -tolerations so as to run on master nodes too and being able to collect metrics from the control plane -components of Kuberentes (scheduler, controller manager) +tolerations to run on master nodes, which collects metrics from the control plane +components of Kuberentes (scheduler, controller manager). To disable {agent} from running on master nodes remove the following part of the Daemonset spec: [source,yaml] @@ -103,9 +101,9 @@ elastic-agent-hs4pb 1/1 Running 0 81m [float] ==== Autodiscover targeted Pods -It is possible to define autodiscover conditions so as to allow {agent} to automatically -identify Pods and start collecting from them using predefined integrations. For example if a -user want to automatically identify a Redis Pod and start monitoring it using the Redis integration +Ddefine the autodiscover conditions to allow {agent} to automatically +identify Pods and start collecting from them using predefined integrations. For example, if a +user wants to automatically identify a Redis Pod and start monitoring it using the Redis integration, the following configuration should be added as an extra input in the Daemonset manifest: [source,yaml] @@ -135,4 +133,4 @@ the following configuration should be added as an extra input in the Daemonset m ------------------------------------------------ Users can find more information about how to shape their dynamic inputs -for autodiscover at <> docs. \ No newline at end of file +for autodiscover at <> docs. From 18146589261dc83cc4ecabadd71c4da3e0ebe904 Mon Sep 17 00:00:00 2001 From: leahleahy <82116004+leahleahy@users.noreply.github.com> Date: Fri, 16 Apr 2021 16:43:50 -0400 Subject: [PATCH 2/3] Update docs/en/ingest-management/elastic-agent/running-on-kubernetes-standalone.asciidoc Co-authored-by: Brandon Morelli --- .../elastic-agent/running-on-kubernetes-standalone.asciidoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/en/ingest-management/elastic-agent/running-on-kubernetes-standalone.asciidoc b/docs/en/ingest-management/elastic-agent/running-on-kubernetes-standalone.asciidoc index e6ae0d8570..3456133572 100644 --- a/docs/en/ingest-management/elastic-agent/running-on-kubernetes-standalone.asciidoc +++ b/docs/en/ingest-management/elastic-agent/running-on-kubernetes-standalone.asciidoc @@ -19,8 +19,8 @@ Deploy {agent} in two different ways at the same time: * As a https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/[DaemonSet] to ensure that there's a running instance on each node of the cluster. These -instances are used to retrieve metrics from the host, such as system -metrics, Docker stats, and metrics from all the services running on +instances are used to retrieve most metrics from the host, such as system +metrics, Docker stats, and metrics from all the services running on top of Kubernetes. * As a single {agent} instance created using a https://kubernetes.io/docs/concepts/workloads/controllers/Deployment/[Deployment]. From dd506e7f8a6442d0ee7e79520507e253a8185d47 Mon Sep 17 00:00:00 2001 From: Brandon Morelli Date: Tue, 20 Apr 2021 12:14:41 -0700 Subject: [PATCH 3/3] Update docs/en/ingest-management/elastic-agent/running-on-kubernetes-standalone.asciidoc --- .../elastic-agent/running-on-kubernetes-standalone.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/ingest-management/elastic-agent/running-on-kubernetes-standalone.asciidoc b/docs/en/ingest-management/elastic-agent/running-on-kubernetes-standalone.asciidoc index 3456133572..bbd5998d10 100644 --- a/docs/en/ingest-management/elastic-agent/running-on-kubernetes-standalone.asciidoc +++ b/docs/en/ingest-management/elastic-agent/running-on-kubernetes-standalone.asciidoc @@ -101,7 +101,7 @@ elastic-agent-hs4pb 1/1 Running 0 81m [float] ==== Autodiscover targeted Pods -Ddefine the autodiscover conditions to allow {agent} to automatically +You can define autodiscover conditions to allow {agent} to automatically identify Pods and start collecting from them using predefined integrations. For example, if a user wants to automatically identify a Redis Pod and start monitoring it using the Redis integration, the following configuration should be added as an extra input in the Daemonset manifest: