-
Notifications
You must be signed in to change notification settings - Fork 188
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
examples: Embed a gadget within the application
Signed-off-by: Mauricio Vásquez <mauriciov@microsoft.com>
- Loading branch information
1 parent
fef7a86
commit 3c70086
Showing
7 changed files
with
171 additions
and
22 deletions.
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| from_memory |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| # Embedding a gadget image within the application | ||
|
|
||
| This example shows how a gadget image can be embedded in the application binary | ||
| and how it can be run from there. | ||
|
|
||
| The `trace_open.tar` file was created with: | ||
|
|
||
| ```bash | ||
| $ sudo -E ig image export trace_open:latest trace_open.tar | ||
| ``` | ||
|
|
||
| ### How to compile | ||
|
|
||
| ```bash | ||
| $ go build . | ||
| ``` | ||
|
|
||
| ### How to run | ||
|
|
||
| The compiled binary doesn't need any parameters, just run it with root permissions: | ||
|
|
||
| ```bash | ||
| $ sudo ./from_memory | ||
| ``` | ||
|
|
||
| The gadget runs successfully. | ||
|
|
||
| ```bash | ||
| $ sudo ./from_memory | ||
| TIMESTAMP PID UID GID MNTNS… E… FD FL… MODE COMM FNAME | ||
| 33760132075419 308204 0 0 402653 0 23 524 0 from_me /sys/kernel/tra | ||
| 33760214948931 1101 108 117 402653 0 7 524 0 systemd /proc/meminfo | ||
| 33760215059910 1101 108 117 402653 0 7 524 0 systemd /sys/fs/cgroup/ | ||
| 33760215123230 1101 108 117 402653 0 7 524 0 systemd /sys/fs/cgroup/ | ||
| 33760215153988 1101 108 117 402653 0 7 524 0 systemd /sys/fs/cgroup/ | ||
| 33760215186640 1101 108 117 402653 0 7 524 0 systemd /sys/fs/cgroup/ | ||
| 33760215219722 1101 108 117 402653 0 7 524 0 systemd /sys/fs/cgroup/ | ||
| 33760215251071 1101 108 117 402653 0 7 524 0 systemd /sys/fs/cgroup/ | ||
| ``` |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| // Copyright 2024 The Inspektor Gadget authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package main | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "context" | ||
| _ "embed" | ||
| "fmt" | ||
| "os" | ||
|
|
||
| orasoci "oras.land/oras-go/v2/content/oci" | ||
|
|
||
| "github.com/quay/claircore/pkg/tarfs" | ||
|
|
||
| gadgetcontext "github.com/inspektor-gadget/inspektor-gadget/pkg/gadget-context" | ||
| clioperator "github.com/inspektor-gadget/inspektor-gadget/pkg/operators/cli" | ||
| _ "github.com/inspektor-gadget/inspektor-gadget/pkg/operators/ebpf" | ||
| ocihandler "github.com/inspektor-gadget/inspektor-gadget/pkg/operators/oci-handler" | ||
| "github.com/inspektor-gadget/inspektor-gadget/pkg/runtime/local" | ||
| ) | ||
|
|
||
| // embed the tarball containing the gadget image. It was created with | ||
| // $ sudo -E ig image export trace_open:latest trace_open.tar | ||
|
|
||
| //go:embed trace_open.tar | ||
| var traceOpenBytes []byte | ||
|
|
||
| func do() error { | ||
| ctx := context.Background() | ||
|
|
||
| // Create an FS from the tarball bytes | ||
| fs, err := tarfs.New(bytes.NewReader(traceOpenBytes)) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| // Create the oras target from the FS | ||
| target, err := orasoci.NewFromFS(ctx, fs) | ||
| if err != nil { | ||
| return fmt.Errorf("getting oci store from bytes: %w", err) | ||
| } | ||
|
|
||
| gadgetCtx := gadgetcontext.New( | ||
| context.Background(), | ||
| // The name of the gadget to run is needed as a tarball can contain multiple images. | ||
| "ghcr.io/inspektor-gadget/gadget/trace_open:latest", | ||
| gadgetcontext.WithDataOperators(ocihandler.OciHandler, clioperator.CLIOperator), | ||
| gadgetcontext.WithOrasReadonlyTarget(target), | ||
| ) | ||
|
|
||
| runtime := local.New() | ||
| if err := runtime.Init(nil); err != nil { | ||
| return fmt.Errorf("runtime init: %w", err) | ||
| } | ||
| defer runtime.Close() | ||
|
|
||
| params := map[string]string{ | ||
| "operator.cli.output": "columns", | ||
| } | ||
| if err := runtime.RunGadget(gadgetCtx, nil, params); err != nil { | ||
| return fmt.Errorf("running gadget: %w", err) | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func main() { | ||
| if err := do(); err != nil { | ||
| fmt.Printf("Error running application: %s\n", err) | ||
| os.Exit(1) | ||
| } | ||
| } |
Binary file not shown.
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
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