Skip to content

Latest commit

 

History

History
60 lines (37 loc) · 4.26 KB

README.md

File metadata and controls

60 lines (37 loc) · 4.26 KB
Raw

Falco Helm Charts

Falco Core Repository Stable License

This GitHub project is the source for the Falco Helm chart repository that you can use to deploy Falco in your Kubernetes infrastructure.

The purpose of this repository is to provide a place for maintaining and contributing Charts related to the Falco project, with CI processes in place for managing the releasing of Charts into our Helm Chart Repository.

For more information about installing and using Helm, see the Helm Docs.

Repository Structure

This GitHub repository contains the source for the packaged and versioned charts released to https://falcosecurity.github.io/charts (our Helm Chart Repository). We also, are publishing the charts in a OCI Image and it is hosted in GitHub Packages

The Charts in this repository are organized into folders: each directory that contains a Chart.yaml is a chart.

The Charts in the master branch (with a corresponding GitHub release) match the latest packaged Charts in our Helm Chart Repository, though there may be previous versions of a Chart available in that Chart Repository.

Charts

Charts currently available are listed below.

Usage

Adding falcosecurity repository

Before installing any chart provided by this repository, add the falcosecurity Charts Repository:

helm repo add falcosecurity https://falcosecurity.github.io/charts
helm repo update

Installing a chart

Please refer to the instruction provided by the Chart you want to install. For installing Falco via Helm, the documentation is here.

Contributing

We are glad to receive your contributions. To help you in the process, we have prepared a CONTRIBUTING.md, which includes detailed information on contributing to falcosecurity projects. Furthermore, we implemented a mechanism to automatically release and publish our charts whenever a PR is merged (if you are curious how this process works, you can find more details in our release.md).

So, we ask you to follow these simple steps when making your PR:

  • The DCO is required to contribute to a falcosecurity project. So ensure that all your commits have been signed off. We will not be able to merge the PR if a commit is not signed off.
  • Bump the version number of the chart by modifying the version value in the chart's Chart.yaml file. This is particularly important, as it allows our CI to release a new chart version. If the version has not been increased, we will not be able to merge the PR.
  • Add a new section in the chart's CHANGELOG.md file with the new version number of the chart.
  • If your changes affect any chart variables, please update the chart's README.gotmpl file accordingly and run make docs in the main folder.

Finally, when opening your PR, please fill in the provided PR template, including the final checklist of items to indicate that all the steps above have been performed.

If you have any questions, please feel free to contact us via GitHub issues.