diff --git a/charts/k8s-metacollector/CHANGELOG.md b/charts/k8s-metacollector/CHANGELOG.md index 07c541568..93176a16c 100644 --- a/charts/k8s-metacollector/CHANGELOG.md +++ b/charts/k8s-metacollector/CHANGELOG.md @@ -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 diff --git a/charts/k8s-metacollector/Chart.yaml b/charts/k8s-metacollector/Chart.yaml index 7837a1d84..fc7880200 100644 --- a/charts/k8s-metacollector/Chart.yaml +++ b/charts/k8s-metacollector/Chart.yaml @@ -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. # @@ -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: cncf-falco-dev@lists.cncf.io diff --git a/charts/k8s-metacollector/README.gotmpl b/charts/k8s-metacollector/README.gotmpl index 6120833b6..741e28b1f 100644 --- a/charts/k8s-metacollector/README.gotmpl +++ b/charts/k8s-metacollector/README.gotmpl @@ -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 diff --git a/charts/k8s-metacollector/README.md b/charts/k8s-metacollector/README.md index bc61c2086..e4265a264 100644 --- a/charts/k8s-metacollector/README.md +++ b/charts/k8s-metacollector/README.md @@ -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 @@ -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 @@ -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. | \ No newline at end of file +| tolerations | list | `[]` | tolerations are applied to pods and allow them to be scheduled on nodes with matching taints. |