Skip to content

Commit

Permalink
update(k8s-metacollector): add work in progress disclaimer
Browse files Browse the repository at this point in the history
Furthermo e, fix indentation in commans example

Signed-off-by: Aldo Lacuku <[email protected]>
  • Loading branch information
alacuku authored and poiana committed Dec 21, 2023
1 parent bebb924 commit ef54f73
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
4 changes: 2 additions & 2 deletions charts/k8s-metacollector/README.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ Assuming that Promtheus scrapes only the ServiceMonitors that present a `release
helm install k8s-metacollector falcosecurity/k8s-metacollector \
--create-namespace \
--namespace metacollector \
--set serviceMonitor.create=true \
--set serviceMonitor.labels.release="kube-prometheus-stack"
--set serviceMonitor.create=true \
--set serviceMonitor.labels.release="kube-prometheus-stack"
```

## Uninstalling the Chart
Expand Down
8 changes: 5 additions & 3 deletions charts/k8s-metacollector/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# k8s-metacollector

⚠️ The chart is still a work in progress ⚠️

[k8s-metacollector](https://github.com/falcosecurity/k8s-metacollector) is a self-contained module that can be deployed within a Kubernetes cluster to perform the task of gathering metadata from various Kubernetes resources and subsequently transmitting this collected metadata to designated subscribers.

## Introduction
Expand Down Expand Up @@ -39,8 +41,8 @@ Assuming that Promtheus scrapes only the ServiceMonitors that present a `release
helm install k8s-metacollector falcosecurity/k8s-metacollector \
--create-namespace \
--namespace metacollector \
--set serviceMonitor.create=true \
--set serviceMonitor.labels.release="kube-prometheus-stack"
--set serviceMonitor.create=true \
--set serviceMonitor.labels.release="kube-prometheus-stack"
```

## Uninstalling the Chart
Expand Down Expand Up @@ -125,4 +127,4 @@ The following table lists the main configurable parameters of the k8s-metacollec
| serviceMonitor.scrapeTimeout | string | `"30s"` | scrapeTimeout determines the maximum time Prometheus should wait for a target to respond to a scrape request. If the target does not respond within the specified timeout, Prometheus considers the scrape as failed for that target. |
| serviceMonitor.targetLabels | list | `[]` | targetLabels defines the labels which are transferred from the associated Kubernetes service object onto the ingested metrics. |
| serviceMonitor.tlsConfig | object | `{}` | tlsConfig specifies TLS (Transport Layer Security) configuration for secure communication when scraping metrics from a service. It allows you to define the details of the TLS connection, such as CA certificate, client certificate, and client key. Currently, the k8s-metacollector does not support TLS configuration for the metrics endpoint. |
| tolerations | list | `[]` | tolerations are applied to pods and allow them to be scheduled on nodes with matching taints. |
| tolerations | list | `[]` | tolerations are applied to pods and allow them to be scheduled on nodes with matching taints. |

0 comments on commit ef54f73

Please sign in to comment.