Skip to content

Commit d2363a2

Browse files
krisnovapoiana
authored andcommitted
Adding basic README.md content
Signed-off-by: Kris Nova <[email protected]>
1 parent 5969b1d commit d2363a2

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Falcoctl
2+
3+
A Go CLI tool to interface with Falco, and perform useful tasks in the Falco Runtime Security ecosystem.
4+
5+
## Call for contributors/maintainers
6+
7+
This is a Go project that has a lot of potential in the Falco ecosystem, but needs contributions and even a maintainer or two.
8+
9+
If you would like to get involved with contributing to this specific project, please check out [the Falco community](https://github.com/falcosecurity/community) to get involved.
10+
11+
# The Paradigms
12+
13+
So `falcoctl` was born out of a need to encapsulate common logic for the project.
14+
Right now there are a lot of scripts, in many languages, and even container images that perform ad-hoc tasks.
15+
We hope to make `falcoctl` the source of truth for these tasks or chores and give operators a first class experience.
16+
There are two main avenues in which we perform these tasks with `falcoctl`
17+
18+
- Locally
19+
- Remote (Kubernetes)
20+
21+
For instance, `falcoctl` supports generating TLS certificate material.
22+
Installing these certificates for use "locally" has many different implications than remotely installing secrets in Kuberentes.
23+
24+
## Local
25+
26+
This implies taking action directly on a system.
27+
If you look in the `/cmd` directory [you can see](https://github.com/falcosecurity/falcoctl/blob/master/cmd/install_tls.go#L1) various examples where the commands are compiled differently for different architectures.
28+
29+
## Remote
30+
31+
Here is where we would use local configuration to perform basic tasks in Kubernetes with `falco`.
32+
For instance, installing falco, updating rules, etc.
33+
34+

0 commit comments

Comments
 (0)