Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

build: add minimal and statically linked builds #1377

Merged
merged 28 commits into from
Sep 10, 2020
Merged

build: add minimal and statically linked builds #1377

merged 28 commits into from
Sep 10, 2020

Conversation

leogr
Copy link
Member

@leogr leogr commented Sep 2, 2020 •
edited
Loading

What type of PR is this?

/kind feature

Any specific area of the project related to this PR?

/area build

/area engine

What this PR does / why we need it:

This PR follows draios/sysdig#1682 up and introduces two building options:

  • MINIMAL_BUILD allows making a stripped-down version of the Falco binary containing only the engine and basic input/output
  • MUSL_OPTIMIZED_BUILD allows making a statically linked binary (using musl)

The two options can be used separately.

Finally, this PR adds a new step in the CI pipeline to build and publish a new kind of artifact: a TGZ package containing the statically linked binary of Falco.

Special notes for your reviewer:

TODOs:

  • enable publishing the new TGZ for git tag (currently enabled on the master branch only - dev release) done by a19e759

  • list the new TGZ in the README.md not needed, since the binary link points to both static and non-static tgzs

  • mark the minimal build as experimental (we will not publish it)

  • with -DMINIMAL_BUILD=True, the sysdig dependency produces a reduced set of fields thus this check will fail 👉 disable the checksum for minimal build (as discussed with @leodido and @fntlnz)

  • add CI step for minimal build

  • use the static build (musl) as default binary for the TGZ

  • use the static build (musl) as default for the falcosecurity/no-driver container image

  • Stripped and musl build options draios/sysdig#1682 needs to be merged

  • sysdig version must be updated here, once ☝️ that gets merged (see the comment in the code)

  • push the modified falco-tester to the latest tag, and update the reference here (see the comment in the code)

  • document the new building options in https://github.com/falcosecurity/falco-website

/hold
/milestone 0.26.0

Does this PR introduce a user-facing change?:

new: tgz (tarball) containing the statically-linked (musl) binary of Falco is now automatically built and published on bintray
update: falcosecurity/falco-no-driver image now uses the statically-linked Falco

@poiana poiana added this to the 0.26.0 milestone Sep 2, 2020
@poiana poiana requested review from Kaizhe and mfdii September 2, 2020 12:51
@leogr leogr force-pushed the feat/minimal-build branch 2 times, most recently from a47e711 to 662acd3 Compare September 2, 2020 13:00
@fntlnz fntlnz force-pushed the feat/minimal-build branch 4 times, most recently from e40cb6c to be94763 Compare September 2, 2020 15:07
@krisnova
Copy link
Contributor

krisnova commented Sep 2, 2020

Should we expect any changes with the signal handler with this? I ran @fntlnz's static binary from some time ago and I noticed that Falco was no longer respecting ^C signals from my keyboard. I had to kill -9 the PID in order to exit the program.

Screenshot from 2020-09-02 16-10-38

@fntlnz
Copy link
Contributor

fntlnz commented Sep 3, 2020

@kris-nova that might be a problem in the binary I generated back then. I just tested this with the latest commit and the signal handlers are having the right behavior.
image

@leogr
Copy link
Member Author

leogr commented Sep 3, 2020

Should we expect any changes with the signal handler with this? I ran @fntlnz's static binary from some time ago and I noticed that Falco was no longer respecting ^C signals from my keyboard. I had to kill -9 the PID in order to exit the program.

Screenshot from 2020-09-02 16-10-38

Hey Kris,

I did not notice this problem in the statically linked build.

BTW, the one in your screenshot should not be a build from this branch since from version 0.25.0 Falco prints out the version number (can you see that in the @fntlnz screenshot).

leogr and others added 5 commits September 9, 2020 10:20
@leogr @fntlnz
build: add MINIMAL_BUILD option
96f2c89 
Co-Authored-By: Lorenzo Fontana <fontanalorenz@gmail.com>
Signed-off-by: Leonardo Grasso <me@leonardograsso.com>
@leogr @fntlnz
build: remove webserver from minimal build
7b7ddbb 
Co-Authored-By: Lorenzo Fontana <fontanalorenz@gmail.com>
Signed-off-by: Leonardo Grasso <me@leonardograsso.com>
@leogr
build: remove civetweb when minimal build
c581f30 
Signed-off-by: Leonardo Grasso <me@leonardograsso.com>
@leogr
build: disallow k8s audit trace file when minimal build
6d7b922 
Signed-off-by: Leonardo Grasso <me@leonardograsso.com>
@leogr
build(userspace): avoid openssl dep for engine fields verification
6955a7e 
Signed-off-by: Leonardo Grasso <me@leonardograsso.com>
leodido and others added 2 commits September 9, 2020 11:09
@leodido @leogr
deps: update driver version
5ede2d4 
Co-authored-by: Leonardo Grasso <me@leonardograsso.com>
Signed-off-by: Leonardo Di Donato <leodidonato@gmail.com>
@leodido @leogr
build: engine fields checksum only when not building the minimal Falco
aa6be4c 
Co-authored-by: Leonardo Grasso <me@leonardograsso.com>
Signed-off-by: Leonardo Di Donato <leodidonato@gmail.com>
@poiana poiana added size/XXL and removed size/XL labels Sep 9, 2020
@leodido @leogr
chore(cmake/modules): correct logging for string-view-lite (always) b…
c5f7b38 
…undled header dependency

Co-authored-by: Leonardo Grasso <me@leonardograsso.com>
Signed-off-by: Leonardo Di Donato <leodidonato@gmail.com>
@leodido leodido force-pushed the feat/minimal-build branch 2 times, most recently from 8103214 to 3b9c909 Compare September 9, 2020 13:55
@leodido @leogr
new(.circleci): test the minimal build
4df263e 
Co-authored-by: Leonardo Grasso <me@leonardograsso.com>
Signed-off-by: Leonardo Di Donato <leodidonato@gmail.com>
leodido and others added 6 commits September 9, 2020 14:52
@leodido @leogr
build: publish musl artifacts
20b601f 
Co-authored-by: Leonardo Grasso <me@leonardograsso.com>
Signed-off-by: Leonardo Di Donato <leodidonato@gmail.com>
@leodido @leogr
build(.circleci): specify falco etc directory for musl build
020b726 
Co-authored-by: Leonardo Grasso <me@leonardograsso.com>
Signed-off-by: Leonardo Di Donato <leodidonato@gmail.com>
@leodido @leogr @fntlnz
build(rules): fix rules etc dir
9cb85ef 
Co-authored-by: Leonardo Grasso <me@leonardograsso.com>
Co-authored-by: Lorenzo Fontana <lo@linux.com>
Signed-off-by: Leonardo Di Donato <leodidonato@gmail.com>
@leodido @leogr @fntlnz
update(docker/no-driver): use the statically linked falco tarball
2487057 
Co-authored-by: Leonardo Grasso <me@leonardograsso.com>
Co-authored-by: Lorenzo Fontana <lo@linux.com>
Signed-off-by: Leonardo Di Donato <leodidonato@gmail.com>
@leodido @leogr @fntlnz
chore(.circleci): re-enable the usual falco-tester docker image for CI
cc872b6 
Co-authored-by: Leonardo Grasso <me@leonardograsso.com>
Co-authored-by: Lorenzo Fontana <lo@linux.com>
Signed-off-by: Leonardo Di Donato <leodidonato@gmail.com>
@leodido @leogr @fntlnz
build: update the driver version to 73554b9
dacb616 
Co-authored-by: Leonardo Grasso <me@leonardograsso.com>
Co-authored-by: Lorenzo Fontana <lo@linux.com>
Signed-off-by: Leonardo Di Donato <leodidonato@gmail.com>
@leodido leodido changed the title wip: build: add minimal and statically linked builds build: add minimal and statically linked builds Sep 10, 2020
@leogr leogr mentioned this pull request Sep 10, 2020
Merged
leodido
leodido approved these changes Sep 10, 2020
View reviewed changes
Copy link
Member

@leodido leodido left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧨

@poiana poiana added the lgtm label Sep 10, 2020
@poiana
Copy link

poiana commented Sep 10, 2020

LGTM label has been added.

Git tree hash: 0aa37d86837597517396167d5ea0d15741a1a5eb

@poiana
Copy link

poiana commented Sep 10, 2020

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: fntlnz, leodido

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@fntlnz
Copy link
Contributor

fntlnz commented Sep 10, 2020

/hold cancel

@poiana poiana merged commit f02a998 into master Sep 10, 2020
@poiana poiana deleted the feat/minimal-build branch September 10, 2020 13:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@leodido leodido leodido approved these changes

@fntlnz fntlnz fntlnz approved these changes

@Kaizhe Kaizhe Awaiting requested review from Kaizhe

@mfdii mfdii Awaiting requested review from mfdii

Assignees

@leodido leodido

@fntlnz fntlnz

Labels
approved area/build area/engine dco-signoff: yes kind/feature lgtm release-note size/XXL
Projects
None yet
Milestone
0.26.0
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@leogr @krisnova @fntlnz @poiana @leodido