github/falco
1
0
Fork 0
mirror of https://github.com/falcosecurity/falco.git synced 2025-08-25 09:28:55 +00:00
Code Issues Projects Releases Wiki Activity

fix(proposals): typos and language

Browse Source 
Signed-off-by: Lorenzo Fontana <lo@linux.com>
Co-authored-by: Leonardo Di Donato <leodidonato@gmail.com>

Co-Authored-By: Lorenzo Fontana <lo@linux.com>
This commit is contained in:
Leo Di Donato 2019-10-31 16:51:51 +01:00
parent ced04a4d89
commit a64f7faa3c
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
proposals/20191030-api.md
View File

@ -2,13 +2,13 @@
## Summary ## Summary
With this proposal we inted to present the intent of creating a Falco API. This is a proposal to better structure the Falco API.
This proposal also intends to list the set of the gRPC services such API will expose. It will contain a list of gRPC services that can be added to have a first stable version of the API for v1.0.0.
## Motivation ## Motivation
We want users to interface with Falco outputs, inputs, rules, and configurations via thirdy-part clients. We want to enable users to use thirdy-party clients to interface with Falco outputs, inputs, rules, and configurations.
Such ability would enable the community to create a whole set of OSS tools, built on top of Falco. Such ability would enable the community to create a whole set of OSS tools, built on top of Falco.
@ -35,7 +35,7 @@ Some examples, already in place, are:
- Receive Falco events with a well-defined contract over wire --> **outputs** - Receive Falco events with a well-defined contract over wire --> **outputs**
- Receive Falco drops with a well-defined contract over wire --> **drops** - Receive Falco drops with a well-defined contract over wire --> **drops**
- Receive current Falco version and related meta information (commit hash, built type, etc.) --> **version** - Receive current Falco version and related meta information (commit hash, built type, etc.) --> **version**
- Config Falco via API (CRUD) -> **configs** - Configure Falco via API (CRUD) -> **configs**
- Inject and/or modify Falco rules via API (CRUD) --> **rules** - Inject and/or modify Falco rules via API (CRUD) --> **rules**
- Send input events to Falco over wire --> **inputs** - Send input events to Falco over wire --> **inputs**
@ -130,7 +130,7 @@ This translates in having the following set of `proto` files.
#### Benefits #### Benefits
We think this structure makes the implementation more easy to write and to maintain because it automatically matches to abstractions - ie., one service by RPC type, a pool of contexts by RPC type - implemented in the code. We think this structure makes the implementation easier to write and to maintain because it automatically matches the abstractions - ie., one service by RPC type, a pool of contexts by RPC type - implemented in the code.
#### Limitations #### Limitations