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

upate(k8s-metacollector): update the chart's info #592

Merged
merged 3 commits into from
Dec 21, 2023
Merged
Show file tree
Hide file tree
Changes from all 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
7 changes: 7 additions & 0 deletions charts/k8s-metacollector/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@
This file documents all notable changes to `k8s-metacollector` Helm Chart. The release
numbering uses [semantic versioning](http://semver.org).

## v0.1.1

### Major Changes

* Add `work in progress` disclaimer;
* Update chart info.

## v0.1.0

### Major Changes
Expand Down
11 changes: 9 additions & 2 deletions charts/k8s-metacollector/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
apiVersion: v2
name: k8s-metacollector
description: A Helm chart for Kubernetes
description: Install k8s-metacollector to fetch and distribute Kubernetes metadata to Falco instances.

# A chart can be either an 'application' or a 'library' chart.
#
Expand All @@ -15,10 +15,17 @@ type: application
# This is the chart version. This version number should be incremented each time you make changes
# to the chart and its templates, including the app version.
# Versions are expected to follow Semantic Versioning (https://semver.org/)
version: 0.1.0
version: 0.1.1

# This is the version number of the application being deployed. This version number should be
# incremented each time you make changes to the application. Versions are not expected to
# follow Semantic Versioning. They should reflect the version the application is using.
# It is recommended to use it with quotes.
appVersion: "0.0.1"

home: https://github.com/falcosecurity/k8s-metacollector
sources:
- https://github.com/falcosecurity/k8s-metacollector
maintainers:
- name: The Falco Authors
email: [email protected]
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. |
Loading