falco icon indicating copy to clipboard operation
falco copied to clipboard

falcoSchema.json should be generated by Falco itself

Open leogr opened this issue 1 year ago • 8 comments

Motivation

Falco should be responsible for defining its supported rule syntax schema. Other tools can consume the schema, then.

For projects like falco-project, consuming this schema in JSON format is very useful. The project is currently using a static version of it https://github.com/falcosecurity/falco-playground/blob/main/src/components/Editor/falcoSchema.json

Feature

Make Falco generate the rule syntax schema in JSON format.

Alternatives

Additional context

Initially, I've filled this issue under the falco-playground project since we have a live example of what we need. The end goal is to transfer this issue to the falco repository and implement the feature in Falco.

I'm assigning this issue to me, but I need volunteers to help. :pray: /assign /help

cc @falcosecurity/core-maintainers @falcosecurity/falco-playground-maintainers

leogr avatar Nov 24 '23 14:11 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:

Motivation

Falco should be responsible for defining its supported rule syntax schema. Other tools can consume the schema, then.

For projects like falco-project, consuming this schema in JSON format is very useful. The project is currently using a static version of it https://github.com/falcosecurity/falco-playground/blob/main/src/components/Editor/falcoSchema.json

Feature

Make Falco generate the rule syntax schema in JSON format.

Alternatives

Additional context

I've filled this issue under the falco-playground project since we have a live example of what we need. The end goal is to transfer this issue to the falco repository and implement the feature in Falco.

I'm assigning this issue to me, but I need volunteers to help. :pray: /assign /help

cc @falcosecurity/core-maintainers @falcosecurity/falco-playground-maintainers

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 Nov 24 '23 14:11 poiana

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 Feb 22 '24 15:02 poiana

/remove-lifecycle stale

cc @falcosecurity/falco-maintainers, I really believe we should move that file to the Falco repo. Do you agree?

also, @LucaGuerra, may that file need to be aligned with https://github.com/falcosecurity/falco/pull/2981?

cc @Rohith-Raju

leogr avatar Feb 23 '24 10:02 leogr

@leogr Yes, I agree!! Maybe we could add an additional flag where Falco outputs the schema in Json format

Rohith-Raju avatar Feb 23 '24 13:02 Rohith-Raju

We are doing a similar thing for Falco config files. I believe it's time to revamp this. I'm transferring the issue to the falco repo.

leogr avatar Mar 26 '24 16:03 leogr

/kind feature

Proposing /milestone 0.38.0 cc @falcosecurity/falco-maintainers

If anyone is willing to help, please let me know. :pray:

leogr avatar Mar 26 '24 16: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 Aug 28 '24 16:08 poiana

/remove-lifecycle stale

FedeDP avatar Aug 29 '24 06:08 FedeDP

Implemented in https://github.com/falcosecurity/falco/pull/3313.

FedeDP avatar Sep 06 '24 13:09 FedeDP