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

Introduce kubernetes package granularity #1018

Merged
merged 10 commits into from
Jun 28, 2021
Merged
Show file tree
Hide file tree
Changes from 3 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
228 changes: 0 additions & 228 deletions packages/kubernetes/_dev/build/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,231 +82,3 @@ the masters won't be visible. In these cases it won't be possible to use `schedu

The Kubernetes package is tested with Kubernetes 1.13.x, 1.14.x, 1.15.x, 1.16.x, 1.17.x, and 1.18.x

## Metrics

### apiserver

This is the `apiserver` dataset of the Kubernetes package, in charge of retrieving metrics
from the Kubernetes API (available at `/metrics`).

This metricset needs access to the `apiserver` component of Kubernetes, accessible typically
by any POD via the `kubernetes.default` service or via environment
variables (`KUBERNETES_SERVICE_HOST` and `KUBERNETES_SERVICE_PORT`).

When the API uses https, the pod will need to authenticate using its default token and trust
the server using the appropiate CA file.

Configuration example using https and token based authentication:


In order to access the `/metrics` path of the API service, some Kubernetes environments might
require the following permission to be added to a ClusterRole.

```yaml
rules:
- nonResourceURLs:
- /metrics
verbs:
- get
```

{{event "apiserver"}}

{{fields "apiserver"}}

### container

This is the `container` dataset of the Kubernetes package. It collects container related metrics
from Kubelet's monitoring APIs.

{{event "container"}}

{{fields "container"}}

### controllermanager

This is the `controllermanager` dataset for the Kubernetes package. It collects from
Kubernetes controller component `metrics` endpoint.

{{event "controllermanager"}}

{{fields "controllermanager"}}

### event

This is the `event` dataset of the Kubernetes package. It collects Kubernetes events
related metrics.

{{event "event"}}

{{fields "event"}}

### node

This is the `node` dataset of the Kubernetes package. It collects Node related metrics
from Kubelet's monitoring APIs.

{{event "node"}}

{{fields "node"}}

### pod

This is the `pod` dataset of the Kubernetes package. It collects Pod related metrics
from Kubelet's monitoring APIs.

{{event "pod"}}

{{fields "pod"}}

### proxy

This is the `proxy` dataset of the Kubernetes package. It collects metrics
from Kubernetes Proxy component.

{{event "proxy"}}

{{fields "proxy"}}

### scheduler

This is the `scheduler` dataset of the Kubernetes package. It collects metrics
from Kubernetes Scheduler component.

{{event "scheduler"}}

{{fields "scheduler"}}

### state_container

This is the `state_container` dataset of the Kubernetes package. It collects container related
metrics from `kube_state_metrics`.

{{event "state_container"}}

{{fields "state_container"}}

### state_cronjob

This is the `state_cronjob` dataset of the Kubernetes package. It collects cronjob related
metrics from `kube_state_metrics`.

{{event "state_cronjob"}}

{{fields "state_cronjob"}}

### state_daemonset

This is the `state_daemonset` dataset of the Kubernetes package. It collects daemonset related
metrics from `kube_state_metrics`.

{{event "state_daemonset"}}

{{fields "state_daemonset"}}

### state_deployment

This is the `state_deployment` dataset of the Kubernetes package. It collects deployment related
metrics from `kube_state_metrics`.

{{event "state_deployment"}}

{{fields "state_deployment"}}

### state_node

This is the `state_node` dataset of the Kubernetes package. It collects node related
metrics from `kube_state_metrics`.

{{event "state_node"}}

{{fields "state_node"}}

### state_persistentvolume

This is the `state_persistentvolume` dataset of the Kubernetes package. It collects
PersistentVolume related metrics from `kube_state_metrics`.

{{event "state_persistentvolume"}}

{{fields "state_persistentvolume"}}

### state_persistentvolumeclaim

This is the `state_persistentvolumeclaim` dataset of the Kubernetes package. It collects
PersistentVolumeClaim related metrics from `kube_state_metrics`.

{{event "state_persistentvolumeclaim"}}

{{fields "state_persistentvolumeclaim"}}

### state_pod

This is the `state_pod` dataset of the Kubernetes package. It collects
Pod related metrics from `kube_state_metrics`.

{{event "state_pod"}}

{{fields "state_pod"}}

### state_replicaset

This is the `state_replicaset` dataset of the Kubernetes package. It collects
Replicaset related metrics from `kube_state_metrics`.

{{event "state_replicaset"}}

{{fields "state_replicaset"}}

### state_resourcequota

This is the `state_resourcequota` dataset of the Kubernetes package. It collects ResourceQuota related metrics
from `kube_state_metrics`.

{{event "state_resourcequota"}}

{{fields "state_resourcequota"}}

### state_service

This is the `state_service` dataset of the Kubernetes package. It collects
Service related metrics from `kube_state_metrics`.

{{event "state_service"}}

{{fields "state_service"}}

### state_statefulset

This is the `state_statefulset` dataset of the Kubernetes package.

{{event "state_statefulset"}}

{{fields "state_statefulset"}}

### state_storageclass

This is the `state_storageclass` dataset of the Kubernetes package. It collects
StorageClass related metrics from `kube_state_metrics`.

{{event "state_storageclass"}}

{{fields "state_storageclass"}}

### system

This is the `system` dataset of the Kubernetes package. It collects System related metrics
from Kubelet's monitoring APIs.

{{event "system"}}

{{fields "system"}}

### volume

This is the `volume` dataset of the Kubernetes package. It collects Volume related metrics
from Kubelet's monitoring APIs.

{{event "volume"}}

{{fields "volume"}}
31 changes: 31 additions & 0 deletions packages/kubernetes/_dev/build/docs/apiserver.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
## Metrics

### apiserver

This is the `apiserver` dataset of the Kubernetes package, in charge of retrieving metrics
from the Kubernetes API (available at `/metrics`).

This metricset needs access to the `apiserver` component of Kubernetes, accessible typically
by any POD via the `kubernetes.default` service or via environment
variables (`KUBERNETES_SERVICE_HOST` and `KUBERNETES_SERVICE_PORT`).

When the API uses https, the pod will need to authenticate using its default token and trust
the server using the appropiate CA file.

Configuration example using https and token based authentication:


In order to access the `/metrics` path of the API service, some Kubernetes environments might
require the following permission to be added to a ClusterRole.

```yaml
rules:
- nonResourceURLs:
- /metrics
verbs:
- get
```

{{event "apiserver"}}

{{fields "apiserver"}}
10 changes: 10 additions & 0 deletions packages/kubernetes/_dev/build/docs/container.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
## Metrics

### container

This is the `container` dataset of the Kubernetes package. It collects container related metrics
from Kubelet's monitoring APIs.

{{event "container"}}

{{fields "container"}}
10 changes: 10 additions & 0 deletions packages/kubernetes/_dev/build/docs/controllermanager.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
## Metrics

### controllermanager

This is the `controllermanager` dataset for the Kubernetes package. It collects from
Kubernetes controller component `metrics` endpoint.

{{event "controllermanager"}}

{{fields "controllermanager"}}
10 changes: 10 additions & 0 deletions packages/kubernetes/_dev/build/docs/event.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
## Metrics

### event

This is the `event` dataset of the Kubernetes package. It collects Kubernetes events
related metrics.

{{event "event"}}

{{fields "event"}}
10 changes: 10 additions & 0 deletions packages/kubernetes/_dev/build/docs/node.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
## Metrics

### node

This is the `node` dataset of the Kubernetes package. It collects Node related metrics
from Kubelet's monitoring APIs.

{{event "node"}}

{{fields "node"}}
10 changes: 10 additions & 0 deletions packages/kubernetes/_dev/build/docs/pod.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
## Metrics

### pod

This is the `pod` dataset of the Kubernetes package. It collects Pod related metrics
from Kubelet's monitoring APIs.

{{event "pod"}}

{{fields "pod"}}
10 changes: 10 additions & 0 deletions packages/kubernetes/_dev/build/docs/proxy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
## Metrics

### proxy

This is the `proxy` dataset of the Kubernetes package. It collects metrics
from Kubernetes Proxy component.

{{event "proxy"}}

{{fields "proxy"}}
10 changes: 10 additions & 0 deletions packages/kubernetes/_dev/build/docs/scheduler.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
## Metrics

### scheduler

This is the `scheduler` dataset of the Kubernetes package. It collects metrics
from Kubernetes Scheduler component.

{{event "scheduler"}}

{{fields "scheduler"}}
10 changes: 10 additions & 0 deletions packages/kubernetes/_dev/build/docs/state_container.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
## Metrics

### state_container

This is the `state_container` dataset of the Kubernetes package. It collects container related
metrics from `kube_state_metrics`.

{{event "state_container"}}

{{fields "state_container"}}
10 changes: 10 additions & 0 deletions packages/kubernetes/_dev/build/docs/state_cronjob.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
## Metrics

### state_cronjob

This is the `state_cronjob` dataset of the Kubernetes package. It collects cronjob related
metrics from `kube_state_metrics`.

{{event "state_cronjob"}}

{{fields "state_cronjob"}}
10 changes: 10 additions & 0 deletions packages/kubernetes/_dev/build/docs/state_daemonset.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
## Metrics

### state_daemonset

This is the `state_daemonset` dataset of the Kubernetes package. It collects daemonset related
metrics from `kube_state_metrics`.

{{event "state_daemonset"}}

{{fields "state_daemonset"}}
10 changes: 10 additions & 0 deletions packages/kubernetes/_dev/build/docs/state_deployment.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
## Metrics

### state_deployment

This is the `state_deployment` dataset of the Kubernetes package. It collects deployment related
metrics from `kube_state_metrics`.

{{event "state_deployment"}}

{{fields "state_deployment"}}
Loading