update(docs): add more details to kubernetes readme #96
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
poiana
added
kind/documentation
incertum
force-pushed
the
update-docs
branch
2 times, most recently
from
a77c640
to
d2b5cec
Compare
Signed-off-by: Melissa Kilby <melissa.kilby.oss@gmail.com>
incertum
force-pushed
the
update-docs
branch
from
d2b5cec
to
b2336d0
Compare
leogr
approved these changes
Dec 19, 2023
|
|
||
| For additional guidance on using Falco in Kubernetes or benchmarking within a testbed, consider exploring the repository at https://github.com/falcosecurity/cncf-green-review-testing. Please note that the repository primarily focuses on testbed benchmarking, and as a result, the setup might not be best for real-world use. | ||
|
|
||
| __NOTE__: If you're working with [minikube](https://minikube.sigs.k8s.io/docs/start/) locally, bear in mind that specific mount setups might be necessary. For instance, running `minikube start --mount --mount-string="/usr/src:/usr/src" --driver=docker` ensures that the `driver-loader` can access `/usr/src/kernels/` if the kernel driver (`kmod` or `ebpf`) is built on-the-fly. Running Falco with `--modern-bpf` does not require building a driver because it is already bundled within the userspace binary. This capability is enabled by the newer CORE (Compile Once - Run Everywhere) BPF feature and works only on more recent kernels (>= 5.8). |
There was a problem hiding this comment.
This page https://falco.org/docs/install-operate/running/#docker may help users check which mounts are required, depending on the chosen setup.
Comment on lines
+17
to
+28
| ### What's Included in the `falco` Deployment? | ||
|
|
||
| **initContainers** | ||
| - `falco-driver-loader`: Downloads the kernel driver or attempts to build it on-the-fly. | ||
| - `falcoctl-artifact-install`: Downloads default rules and installs falcoctl along with other artifacts like plugins. | ||
|
|
||
|
|
||
| **containers** | ||
| - `falco`: Executes the Falco binary. | ||
| - `falcoctl-artifact-follow`: Utilizes falcoctl's functionality to watch for updated rules. | ||
|
|
||
| The template daemonset setup does not handle the method of extracting Falco logs from the container to their final destination (such as a data lake or SIEM). You can explore using tools like `falco-exporter`, `falcosidekick`, or create custom solutions. |
There was a problem hiding this comment.
Note for the future: this may slightly change a bit in Falco 0.37 since the porting of the driver loader into falcoctl cc @alacuku @Andreagit97 @LucaGuerra
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: incertum, leogr The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
LGTM label has been added. Git tree hash: 36b07d78b0100797bf4da90152a939290dd784b7
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What type of PR is this?
/kind documentation
Any specific area of the project related to this PR?
What this PR does / why we need it:
Update docs for Kubernetes deployment to provide more details and add a note around what to keep in mind when testing this with
minikubeas I experienced some hiccups there.@leogr @maxgio92
Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer: