Here you can learn how you can contribute to Inspektor Gadget.
To better understand how the pieces fit together, we recommend reading the architecture documentation before starting to play with Inspektor Gadget.
Setup developer environment
and clone this repo:
git clone firstname.lastname@example.org:your_account/inspektor-gadget.git.
- Install Docker , Docker Buildx and Golang .
Building the code
Inspektor Gadget is composed of a client executable that runs on the operator’s machine, and a container image that runs in the Kubernetes cluster. They can be built together or independently.
Building the client executable
You can compile the client executable for your platform by running
To cross compile for all supported platforms, you can run
make kubectl-gadget-all or select a specific one with
make kubectl-gadget-linux-amd64 or
Building the gadget container image
Inspektor Gadget provides two different container images:
- gadget-default: Contains CO-RE and BCC gadgets
- gadget-core: Containes only CO-RE gadgets that are integrated with the gadget tracer manager
- traceloop gadget is not included, it will be included once #371 is fixed.
You can build and push the container gadget image by running the following commands:
$ make gadget-default-container # or make gadget-core-container $ make push-gadget-default-container
The eBPF code is built using a Docker container, so you don’t have to worry installing the compilers to build it.
If you push the container images to another registry, you can use the
argument when deploying to the Kubernetes cluster.
- Using a locally built container image requires pushing it to a container
registry, either local or remote. The default registry can be overridden by
changing the value of the
CONTAINER_REPOenv variable, which defaults to
ghcr.io/kinvolk/inspektor-gadgetif not defined.
- The compilation uses
tools/image-tagto choose the tag of the container image to use according to the branch that you are compiling.
- If you wish to make changes to traceloop program, update
gadget-default.Dockerfileto pick your own image of traceloop.
- As for traceloop, it is also possible to change the BCC to be used as described in BCC section.
- You can generate the required BTF information for some well known
kernel versions by setting
Building the eBPF object files
If you need to compile the eBPF code of the gadgets, the ebpf-objects target will help you in this task:
$ make ebpf-objects ... go: downloading github.com/giantswarm/crd-docs-generator v0.7.1 ... Wrote /work/pkg/gadgettracermanager/containers-map/containersmap_bpfel.go
Building Local Gadget
Inspektor Gadget also provides the
trace containers without Kubernetes. It can be built independently from the
kubectl-gadget and the gadget container image. The result is a single binary
that can be copied to a Kubernetes node or any host to trace its containers.
$ make local-gadget
Development environment on minikube
For faster iteration, it’s possible to make changes to Inspektor Gadget and test them on minikube locally without pushing container images to any registry.
- Follow the specific installation instructions for minikube.
- Deploy the locally modified version of Inspektor Gadget to an already
running minikube cluster with
You can run the different unit tests with:
$ make test
The integration tests use a Kubernetes cluster to deploy and test Inspektor Gadget. Be sure that you have a valid kubeconfig and run:
$ export KUBECONFIG=... # not needed if valid config in $HOME/.kube/config $ make integration-tests
Inspektor Gadget uses GitHub Actions as CI. Please check dedicated CI documentation for details.
Code of Conduct
Please refer to the Kinvolk Code of Conduct .
For making PRs/commits consistent and easier to review, please check out Kinvolk’s contribution guidelines on git .
Good first issues
Proposing new features
If you want to propose a new feature or do a big change in the architecture it’s highly recommended to open an issue first to discuss it with the team.
Our planning is published through two different project boards:
- Inspektor Gadget Roadmap has the high level view of the big issues that we are planning to tackle in the upcoming months.
- Inspektor Gadget Sprint Planning has the week-to-week plans of which bugs we are currently working on, and the different priorities of the issues involved.
Porting BCC gadgets
This project uses some gadgets from BCC . Instead of keeping our patched versions, we prefer to make those gadgets suitable to be used with Inspektor Gadget by contributing to the upstream project.
A BCC gadget has to provide a filtering mechanism by cgroup id and mount namespace id in order to be compatible with Inspektor Gadget. You can get some inspiration from the opensnoop and execsnoop implementations to port a different BCC gadget.
Once the gadget has been updated in the BCC repo, it can be added to Inspektor
Gadget by filling a PR adding the gadget to
add gadget bindsnoop
PR is an example of it.
The adding new BCC-based gadgets in Inspektor Gadget blogpost presents some more details about this process.
Updating BCC from upstream
As you can see in
gadget-default.Dockerfile, the gadget container image
uses the BCC container image as its parent image.
Given that there is not an official container repository to get that BCC image,
we keep a synchronised
Kinvolk BCC fork
that is configured to publish the images on Kinvolk container registries
, by using the
already available in
Given that, if you want to update the BCC version used by Inspektor Gadget,
it is necessary to first update the
Kinvolk BCC fork
so that the Github actions are triggered, and a new image is published.
Once the image is available in registries, you have to update
gadget-default.Dockerfile so that it uses the just created image, same goes for local
Update BCC container image
PR is an example of it.
Currently, we use Docker Hub to pull the BCC image when building the gadget
container image. Notice we do not use the
latest tag because it is overwritten
after each push on master branch. Instead, we use the
stable unique tags
that are named with format:
<Timestamp><Commit-SHA>. For instance, tag
202107061407494e8e8c describes that it was created in 2021-07-06 at 14:07:49
from commit SHA starting with