This repository provides a collection of operators related to Falco.

This repository contains the code for the following charms:

1. falco-operator: A machine charm deploying and managing Falco
2. falcosidekick-k8s-operator: A kubernetes charm deploying and managing Falcosidekick

This repository also contains the code for the following charm interfaces:

1. falcosidekick_http_endpoint: An interface for connecting charms to Falcosidekick HTTP endpoint.

In addition to charm related code, this repository also contains packages to the aforementioned charms.

1. falco: A customized Falco package built from source.
2. falcocsidekick: A customized Falcosidekick rock image built from source.

Our documentation is stored in the docs directory and can be viewed at https://canonical.com/juju/docs/falco-charms/. It is based on the Canonical Sphinx Stack and hosted on Read the Docs. In structuring, the documentation employs the Diátaxis approach.

You may open a pull request with your documentation changes, or you can file a bug to provide constructive feedback or suggestions.

To run the documentation locally before submitting your changes:

cd docs
make run

GitHub runs automatic checks on the documentation to verify spelling, validate links and style guide compliance.

You can (and should) run the same checks locally:

make spelling
make linkcheck
make vale
make lint-md

The Falco operators project is a member of the Ubuntu family. It is an open source project that warmly welcomes community projects, contributions, suggestions, fixes and constructive feedback.

• Code of conduct
• Contribute
• Get support
• Issues
• Matrix