new: driver command #343

FedeDP · 2023-11-03T14:24:29Z

What type of PR is this?

/kind feature

Any specific area of the project related to this PR?

/area library
/area cli

What this PR does / why we need it:

First draft at implementing falcoctl driver command, see #327

Which issue(s) this PR fixes:

Eventually #327 will get fixed, but i don't think a single PR will make it :)

Fixes #

Special notes for your reviewer:

What we need:

FedeDP · 2023-11-03T14:27:05Z

About select smart autologic; this is as simple as adding new "distro" overriding the PreferredDriver interface method, like this:

func init() {
	distros["arch"] = &arch{generic: &generic{}}
}

type arch struct {
	*generic
}

func (c *arch) PreferredDriver(info kernel.Info) _type.DriverType {
        if info.Architecture == "aarch64" {
            dtype, _ := _type.Parse("bpf")
            return dtype
        }
        dtype, _ := _type.Parse("modern-bpf")
        return dtype
}

(ok this is a super stupid example btw!)

FedeDP · 2023-11-03T14:31:56Z

Example output:

sudo ./falcoctl driver prepare --driver-version 6.0.1+driver
[sudo] password di federico:
2023-11-03 15:31:36 INFO  Running falcoctl driver prepare
                      ├ driver version: 6.0.1+driver
                      ├ driver type: kmod
                      ├ arch: x86_64
                      ├ kernel release: 6.5.7-arch1-1
                      └ kernel version: 1
2023-11-03 15:31:36 INFO  found distro target: arch
2023-11-03 15:31:36 INFO  Trying to download a driver url: https://download.falco.org/driver/6.0.1+driver/x86_64/falco_arch_6.5.7-arch1-1_1.ko
2023-11-03 15:31:36 ERROR unable to find a prebuilt falco driver
2023-11-03 15:31:36 ERROR build unimplemented

FedeDP · 2023-11-06T08:46:38Z

Makefile

@@ -56,7 +56,7 @@ fmt: gci addlicense
 	go mod tidy
 	go fmt ./...
 	find . -type f -name '*.go' -a -exec $(GCI) write -s standard -s default -s "prefix(github.com/falcosecurity/falcoctl)" {} \;
-	find . -type f -name '*.go' -exec $(ADDLICENSE) -l apache -c "The Falco Authors" -y "$(shell date +%Y)" {} \;
+	find . -type f -name '*.go' -exec $(ADDLICENSE) -l apache -s -c "The Falco Authors" -y "$(shell date +%Y)" {} \;


-s Include SPDX identifier in license header. Set -s=only to only include SPDX identifier.

FedeDP · 2023-11-06T08:46:56Z

cmd/driver/driver_linux.go

+)
+
+// NewDriverCmd returns the driver command.
+func NewDriverCmd(ctx context.Context, opt *commonoptions.Common) *cobra.Command {


driver subcmd is only available on linux systems.

FedeDP · 2023-11-06T08:47:10Z

cmd/driver/driver_others.go

+
+// NewDriverCmd returns an empty driver command since it is not supported on non linuxes
+func NewDriverCmd(ctx context.Context, opt *commonoptions.Common) *cobra.Command {
+	return &cobra.Command{}


By returning an empty command, cobra will skip it.

FedeDP · 2023-11-06T08:48:12Z

cmd/driver/prepare/prepare.go

+
+	d, err := driverdistro.DiscoverDistro(o.Printer, o.HostRoot)
+	if err != nil {
+		if errors.Is(err, driverdistro.ErrUnsupported) && o.Build {


errUnsupported returns a generic distro, to attempt a build.

FedeDP · 2023-11-06T10:10:39Z

What is implemented so far:

What we miss:

build kmod
build bpf
cos_version_greater
get_kernel_config
flatcar_relocate_tools
~~insmod/modprobe of kmod once built/downloaded~~
~~DRIVER_INSECURE_DOWNLOAD~~, DRIVER_CURL_OPTIONS, ~~DRIVER_KERNEL_RELEASE~~, ~~DRIVER_KERNEL_VERSION~~ support

Open points:

who will pass --driver-version parameter? Falco knows it, but falcoctl does not (unless we let it call the Falco endpoint to gather the info, but since falcoctl driver needs to run before Falco...)
how to support source_only and print_env falco-driver-loader options?

FedeDP · 2023-11-06T15:42:08Z

I think this is already big enough as a starting point.
/cc @alacuku @leogr

FedeDP · 2023-11-08T15:03:22Z

/hold

alacuku

Thanks for the PR, left some comments.

pkg/driver/type/type.go

cmd/driver/config/config.go

cmd/driver/install/install.go

cmd/driver/printenv/printenv.go

FedeDP · 2023-11-21T10:27:01Z

I consider this PR ready!
I will add tests and eventually improve things (together with @alacuku perhaps!) in next PRs (yes there will surely be other PRs) 😄

FedeDP · 2023-11-21T13:57:48Z

Squashed to a single commit :) @alacuku is now happy 😃

alacuku

/LGTM

pkg/driver/distro/distro.go

It exposes 4 subcmds: * `install` to install (ie: either download or build) kmod or eBPF probe * `cleanup` to cleanup a driver * `printenv` to print environment variables about driver-loader * `config` to configure the driver-loader feature Signed-off-by: Federico Di Pierro <nierro92@gmail.com>

FedeDP · 2023-11-21T16:17:02Z

/unhold

maxgio92

/approve

poiana · 2023-11-21T16:33:52Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: alacuku, FedeDP, maxgio92

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:

~~OWNERS~~ [FedeDP,maxgio92]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

maxgio92 · 2023-11-21T16:37:33Z

Great job @FedeDP! 👏🏻 ❤️

Signed-off-by: Federico Di Pierro <nierro92@gmail.com>

poiana added do-not-merge/work-in-progress kind/feature dco-signoff: yes area/library area/cli labels Nov 3, 2023

poiana requested review from alacuku and loresuso November 3, 2023 14:24

poiana added size/XXL approved labels Nov 3, 2023

FedeDP force-pushed the new/driver_prepare branch from 4bc454c to 8503a93 Compare November 3, 2023 14:31

FedeDP force-pushed the new/driver_prepare branch 3 times, most recently from 8b8730b to fceb81a Compare November 6, 2023 08:41

FedeDP commented Nov 6, 2023

View reviewed changes

FedeDP added this to the v0.7.0 milestone Nov 6, 2023

FedeDP self-assigned this Nov 6, 2023

poiana requested a review from leogr November 6, 2023 15:42

FedeDP changed the title ~~wip: new: driver command~~ new: driver command Nov 6, 2023

poiana removed the do-not-merge/work-in-progress label Nov 6, 2023

poiana added the do-not-merge/hold label Nov 8, 2023

FedeDP changed the title ~~new: driver command~~ wip: new: driver command Nov 8, 2023

poiana added the do-not-merge/work-in-progress label Nov 8, 2023

alacuku reviewed Nov 13, 2023

View reviewed changes

FedeDP force-pushed the new/driver_prepare branch from d831e84 to cc6443f Compare November 15, 2023 10:14

FedeDP force-pushed the new/driver_prepare branch from c45fcb7 to 25aeda1 Compare November 21, 2023 13:57

poiana added dco-signoff: no and removed dco-signoff: yes labels Nov 21, 2023

FedeDP force-pushed the new/driver_prepare branch from 25aeda1 to faefd7d Compare November 21, 2023 13:58

poiana added dco-signoff: yes and removed dco-signoff: no labels Nov 21, 2023

alacuku approved these changes Nov 21, 2023

View reviewed changes

poiana assigned alacuku Nov 21, 2023

poiana added the lgtm label Nov 21, 2023

maxgio92 reviewed Nov 21, 2023

View reviewed changes

pkg/driver/distro/distro.go Outdated Show resolved Hide resolved

FedeDP force-pushed the new/driver_prepare branch from faefd7d to 1c40175 Compare November 21, 2023 15:40

poiana removed the do-not-merge/hold label Nov 21, 2023

maxgio92 approved these changes Nov 21, 2023

View reviewed changes

poiana assigned maxgio92 Nov 21, 2023

poiana merged commit 4228e71 into main Nov 21, 2023
14 checks passed

poiana deleted the new/driver_prepare branch November 21, 2023 16:34

FedeDP mentioned this pull request Nov 22, 2023

cleanup(pkg/driver): use unix where available. #353

Closed

FedeDP added a commit to falcosecurity/falco that referenced this pull request Nov 27, 2023

chore(cmake): bumped falcoctl to dev from falcosecurity/falcoctl#343.

129957c

Signed-off-by: Federico Di Pierro <nierro92@gmail.com>

FedeDP added a commit to falcosecurity/falco that referenced this pull request Dec 1, 2023

chore(cmake): bumped falcoctl to dev from falcosecurity/falcoctl#343.

05470a9

Signed-off-by: Federico Di Pierro <nierro92@gmail.com>

FedeDP added a commit to falcosecurity/falco that referenced this pull request Dec 1, 2023

chore(cmake): bumped falcoctl to dev from falcosecurity/falcoctl#343.

cee562d

Signed-off-by: Federico Di Pierro <nierro92@gmail.com>

FedeDP added a commit to falcosecurity/falco that referenced this pull request Dec 6, 2023

chore(cmake): bumped falcoctl to dev from falcosecurity/falcoctl#343.

edfd88e

Signed-off-by: Federico Di Pierro <nierro92@gmail.com>

poiana pushed a commit to falcosecurity/falco that referenced this pull request Dec 11, 2023

chore(cmake): bumped falcoctl to dev from falcosecurity/falcoctl#343.

7452c5d

Signed-off-by: Federico Di Pierro <nierro92@gmail.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

new: driver command #343

new: driver command #343

FedeDP commented Nov 3, 2023 •

edited

FedeDP commented Nov 3, 2023

FedeDP commented Nov 3, 2023

FedeDP Nov 6, 2023

FedeDP Nov 6, 2023

FedeDP Nov 6, 2023

FedeDP Nov 6, 2023

FedeDP commented Nov 6, 2023 •

edited

FedeDP commented Nov 6, 2023

FedeDP commented Nov 8, 2023

alacuku left a comment

FedeDP commented Nov 21, 2023

FedeDP commented Nov 21, 2023

alacuku left a comment

FedeDP commented Nov 21, 2023

maxgio92 left a comment

poiana commented Nov 21, 2023

maxgio92 commented Nov 21, 2023

new: driver command #343

new: driver command #343

Conversation

FedeDP commented Nov 3, 2023 • edited

FedeDP commented Nov 3, 2023

FedeDP commented Nov 3, 2023

FedeDP Nov 6, 2023

Choose a reason for hiding this comment

FedeDP Nov 6, 2023

Choose a reason for hiding this comment

FedeDP Nov 6, 2023

Choose a reason for hiding this comment

FedeDP Nov 6, 2023

Choose a reason for hiding this comment

FedeDP commented Nov 6, 2023 • edited

FedeDP commented Nov 6, 2023

FedeDP commented Nov 8, 2023

alacuku left a comment

Choose a reason for hiding this comment

FedeDP commented Nov 21, 2023

FedeDP commented Nov 21, 2023

alacuku left a comment

Choose a reason for hiding this comment

FedeDP commented Nov 21, 2023

maxgio92 left a comment

Choose a reason for hiding this comment

poiana commented Nov 21, 2023

maxgio92 commented Nov 21, 2023

FedeDP commented Nov 3, 2023 •

edited

FedeDP commented Nov 6, 2023 •

edited