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

Add agent_on_k8s docs and k8s provider #401

Merged
merged 3 commits into from
Feb 25, 2021

Conversation

ChrsMark
Copy link
Member

@ChrsMark ChrsMark commented Feb 22, 2021

This PR adds documentation for:

  1. Kubernetes Provider
  2. Running Agent standalone on Kubernetes

Closes elastic/beats#21848
Part of elastic/beats#23613

Kubernetes provider implementation PR: elastic/beats#21480

Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
@ChrsMark ChrsMark self-assigned this Feb 22, 2021
@apmmachine
Copy link
Contributor

A docs preview will be available soon:
- HTML diff
- Observability guide

Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
Comment on lines 43 to 51
1. Kubernetes integration to collect k8s metrics from each nodes' kubelet
2. Kubernetes integration to collect metrics from `kube-state-metrics`. https://github.com/kubernetes/kube-state-metrics#usage[kube-state-metrics] is needed to be already deployed
in the cluster. If `kube-state-metrics` is not already running, deploy it now (see the
https://github.com/kubernetes/kube-state-metrics#kubernetes-deployment[Kubernetes
deployment] docs)
3. Kubernetes integration to collect metrics from `proxy` kubernetes component on each of the nodes.
4. Kubernetes integration to collect metrics from Kubernetes API server, Scheduler and Controller-manager
5. System integration to collect system level metrics from nodes.
6. Pod's log collection using <<kubernetes-provider,dynamic inputs and kubernetes provider>>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This may be too detailed, and it will be easy to forget to update if manifests are modified to include more things.

Perhaps we can rephrase it to don't detail so much what specific components are collected metrics from. We could also include references to the docs of dashboards or UIs where this data can be visualized.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍🏼 I made it shorter and more abstract. I like the idea of linking each integration to its respective page (Kubernetes integration/package, System Integration/package etc) however I'm not sure what would be the proper page to choose. Currently we have an Integrations page (https://www.elastic.co/integrations?solution=all-solutions&category=kubernetes) but this refers to Beats integrations and not to packages 🤔 . @dedemorton any ideas here?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, maybe this is not needed, specially thinking that this is a "running on..." page and there will be more pages with info about UIs and so on.

Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
Copy link
Contributor

@blakerouse blakerouse left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks really good.

------------------------------------------------

[float]
==== Autodiscover targeted Pods
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great for the docs!

Copy link
Contributor

@ph ph left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @ChrsMark This is really great!

@ph
Copy link
Contributor

ph commented Feb 24, 2021

@ChrsMark What is the release target for the doc 7.13?

@ChrsMark ChrsMark merged commit 9676b3d into elastic:master Feb 25, 2021
@ChrsMark
Copy link
Member Author

@ChrsMark What is the release target for the doc 7.13?

@ph I think it will depend on #401 (comment) and what we will decide about the target version of manifests.

bmorelli25 pushed a commit to bmorelli25/observability-docs that referenced this pull request Apr 21, 2021
bmorelli25 pushed a commit to bmorelli25/observability-docs that referenced this pull request Apr 21, 2021
bmorelli25 added a commit that referenced this pull request Apr 21, 2021
Co-authored-by: Brandon Morelli <bmorelli25@gmail.com>
Co-authored-by: Brandon Morelli <brandon.morelli@elastic.co>
Co-authored-by: Brandon Morelli <bmorelli25@gmail.com>
Co-authored-by: Brandon Morelli <brandon.morelli@elastic.co>
Co-authored-by: Chris Mark <chrismarkou92@gmail.com>
Co-authored-by: leahleahy <82116004+leahleahy@users.noreply.github.com>
bmorelli25 added a commit that referenced this pull request Apr 21, 2021
Co-authored-by: Brandon Morelli <bmorelli25@gmail.com>
Co-authored-by: Brandon Morelli <brandon.morelli@elastic.co>
Co-authored-by: Brandon Morelli <bmorelli25@gmail.com>
Co-authored-by: Brandon Morelli <brandon.morelli@elastic.co>
Co-authored-by: Chris Mark <chrismarkou92@gmail.com>
Co-authored-by: leahleahy <82116004+leahleahy@users.noreply.github.com>
bmorelli25 pushed a commit to bmorelli25/observability-docs that referenced this pull request Apr 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Elastic Agent] Add documentation for the k8s provider
5 participants