plugins icon indicating copy to clipboard operation
plugins copied to clipboard

Developer guide for plugins

Open RichardoC opened this issue 3 years ago • 17 comments

Is there a guide to getting started with building/testing the plugins, and how to add a new one?

An example from the Kubernetes project

Thanks!

RichardoC avatar Jan 30 '23 21:01 RichardoC

Hi, You can read our blog post which describes how to write a plugin. https://falco.org/blog/extend-falco-inputs-with-a-plugin-the-basics/

We'll trying to adapt it as a tutorial in the docs for future.

Issif avatar Feb 01 '23 15:02 Issif

Thank you, I was attempting to follow that guide but ran in to issues where the libc on my machine doesn't match the version included in the falco container image I was running. Perhaps we could update this guide to use the same container image used to build the falco images to prevent this sort of issue?

My current (bad) approach has been to do the following (or building an image based on falco), to avoid this issue


nerdctl run --rm -it -v$(pwd):/example:rw  --entrypoint="/bin/bash" falcosecurity/falco -c 'apt update ; apt --fix-broken install -y ; apt install -y wget && wget https://go.dev/dl/go1.19.5.linux-amd64.tar.gz && tar -C /usr/local -xzf go1.19.5.linux-amd64.tar.gz && export PATH=$PATH:/usr/local/go/bin && cd /example && make clean && make && /usr/bin/falco -u  -c /example/examples/running-locally/falco.yaml  -r /example/examples/running-locally/falco_rules.yaml  --list-plugins'

Thanks!

RichardoC avatar Feb 01 '23 17:02 RichardoC

cc @jasondellaluce

leogr avatar Mar 19 '23 18:03 leogr

Issues go stale after 90d of inactivity.

Mark the issue as fresh with /remove-lifecycle stale.

Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Provide feedback via https://github.com/falcosecurity/community.

/lifecycle stale

poiana avatar Jun 24 '23 13:06 poiana

/remove-lifecycle stale

RichardoC avatar Jun 25 '23 22:06 RichardoC

Issues go stale after 90d of inactivity.

Mark the issue as fresh with /remove-lifecycle stale.

Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Provide feedback via https://github.com/falcosecurity/community.

/lifecycle stale

poiana avatar Sep 24 '23 03:09 poiana

/remove-lifecycle stale

In the last months, our documentation has been revised and extended. I guess most of what the developers need is described at https://falco.org/docs/plugins/developers-guide/.

Do you think anything still needs to be added? :thinking:

leogr avatar Sep 25 '23 12:09 leogr

I'm ok for closing this issue.

Issif avatar Sep 25 '23 12:09 Issif

Issues go stale after 90d of inactivity.

Mark the issue as fresh with /remove-lifecycle stale.

Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Provide feedback via https://github.com/falcosecurity/community.

/lifecycle stale

poiana avatar Dec 24 '23 15:12 poiana

It's still missing build details like which glibc to target, which go versions to use and other toolchain like things Instead of documenting it, it could be as simple as providing a container which can be used to generate compatible plugins? My approach to this can be seen in the command in https://github.com/falcosecurity/plugins/issues/225#issuecomment-1412405353

RichardoC avatar Dec 24 '23 15:12 RichardoC

It's still missing build details like which glibc to target, which go versions to use and other toolchain like things

cc @LucaGuerra

leogr avatar Jan 09 '24 09:01 leogr

/remove-lifecycle stale

leogr avatar Jan 09 '24 09:01 leogr

Issues go stale after 90d of inactivity.

Mark the issue as fresh with /remove-lifecycle stale.

Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Provide feedback via https://github.com/falcosecurity/community.

/lifecycle stale

poiana avatar Apr 08 '24 09:04 poiana

/remove-lifecycle stale /help

leogr avatar Apr 08 '24 14:04 leogr

@leogr: This request has been marked as needing help from a contributor.

Please ensure the request meets the requirements listed here.

If this request no longer meets these requirements, the label can be removed by commenting with the /remove-help command.

In response to this:

/remove-lifecycle stale /help

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

poiana avatar Apr 08 '24 14:04 poiana

/assign

leogr avatar Apr 08 '24 14:04 leogr

Issues go stale after 90d of inactivity.

Mark the issue as fresh with /remove-lifecycle stale.

Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Provide feedback via https://github.com/falcosecurity/community.

/lifecycle stale

poiana avatar Jul 07 '24 15:07 poiana

Stale issues rot after 30d of inactivity.

Mark the issue as fresh with /remove-lifecycle rotten.

Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

Provide feedback via https://github.com/falcosecurity/community.

/lifecycle rotten

poiana avatar Aug 06 '24 16:08 poiana

Rotten issues close after 30d of inactivity.

Reopen the issue with /reopen.

Mark the issue as fresh with /remove-lifecycle rotten.

Provide feedback via https://github.com/falcosecurity/community. /close

poiana avatar Sep 05 '24 16:09 poiana

@poiana: Closing this issue.

In response to this:

Rotten issues close after 30d of inactivity.

Reopen the issue with /reopen.

Mark the issue as fresh with /remove-lifecycle rotten.

Provide feedback via https://github.com/falcosecurity/community. /close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

poiana avatar Sep 05 '24 16:09 poiana