Merge pull request inspektor-gadget#2642 from inspektor-gadget/alban_…

…metadata_update

Update gadgets metadata and keep them in sync

.github/workflows/inspektor-gadget.yml

@@ -369,6 +369,18 @@ jobs:
       with:
         category: ig-linux-${{ matrix.platform }}
 
+  build-official-image-based-gadgets:
+    name: Build gadgets
+    # level: 1
+    needs: build-ig
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Check if metadata files are updated
+      run: |
+        GADGET_BUILD_PARAMS="--update-metadata" make build-gadgets
+        git diff --exit-code HEAD --
+
   build-gadget-container-deps:
     # We only build this dependencies to check if they do not contain CWE.
     name: Build gadget-container-deps

gadgets/Makefile

@@ -28,11 +28,16 @@ all: build
 
 build: $(GADGETS)
 
+# GADGET_BUILD_PARAMS can be used to pass additional parameters e.g
+# GADGET_BUILD_PARAMS="--update-metadata" make build
 .PHONY: $(GADGETS)
 $(GADGETS):
 	@echo "Building $@"
-	@sudo -E IG_EXPERIMENTAL=true $(IG) image build --builder-image $(BUILDER_IMAGE) \
-		-t $(GADGET_REPOSITORY)/$@:$(GADGET_TAG) $@
+	@sudo -E IG_EXPERIMENTAL=true $(IG) image build \
+		--builder-image $(BUILDER_IMAGE) \
+		-t $(GADGET_REPOSITORY)/$@:$(GADGET_TAG) \
+		$$GADGET_BUILD_PARAMS \
+		$@
 
 .PHONY:
 push: build

gadgets/snapshot_process/gadget.yaml

@@ -1,5 +1,8 @@
 name: snapshot process
 description: Show running processes
+homepageURL: https://inspektor-gadget.io/
+documentationURL: https://inspektor-gadget.io/docs
+sourceURL: https://github.com/inspektor-gadget/inspektor-gadget/
 snapshotters:
   processes:
     structName: process_entry
@@ -31,7 +34,7 @@ structs:
       attributes:
         template: uid
     - name: mntns_id
-      description: 'Mount namespace inode id'
+      description: Mount namespace inode id
       attributes:
         template: ns
 ebpfParams:

gadgets/snapshot_socket/gadget.yaml

@@ -1,5 +1,8 @@
 name: snapshot socket
 description: Show TCP and UDP sockets
+homepageURL: https://inspektor-gadget.io/
+documentationURL: https://inspektor-gadget.io/docs
+sourceURL: https://github.com/inspektor-gadget/inspektor-gadget/
 snapshotters:
   sockets:
     structName: socket_entry

gadgets/top_file/gadget.yaml

@@ -1,5 +1,8 @@
-name: file
+name: top file
 description: Periodically report read/write activity by file
+homepageURL: https://inspektor-gadget.io/
+documentationURL: https://inspektor-gadget.io/docs
+sourceURL: https://github.com/inspektor-gadget/inspektor-gadget/
 toppers:
   file:
     mapName: stats

gadgets/trace_dns/gadget.yaml

@@ -1,5 +1,8 @@
-name: dns
+name: trace dns
 description: trace dns requests and responses
+homepageURL: https://inspektor-gadget.io/
+documentationURL: https://inspektor-gadget.io/docs/latest/
+sourceURL: https://github.com/inspektor-gadget/inspektor-gadget
 tracers:
   dns:
     mapName: events
@@ -55,11 +58,11 @@ structs:
       attributes:
         width: 16
     - name: netns
-      description: 'Network namespace inode id'
+      description: Network namespace inode id
       attributes:
         template: ns
     - name: mntns_id
-      description: 'Mount namespace inode id'
+      description: Mount namespace inode id
       attributes:
         template: ns
     - name: tid

gadgets/trace_exec/gadget.yaml

@@ -1,5 +1,8 @@
 name: trace exec
 description: trace process executions
+homepageURL: https://inspektor-gadget.io/
+documentationURL: https://inspektor-gadget.io/docs
+sourceURL: https://github.com/inspektor-gadget/inspektor-gadget/
 tracers:
   exec:
     mapName: events

gadgets/trace_malloc/gadget.yaml

@@ -1,5 +1,8 @@
 name: trace malloc
 description: use uprobe to trace malloc and free in libc.so
+homepageURL: https://inspektor-gadget.io/
+documentationURL: https://inspektor-gadget.io/docs
+sourceURL: https://github.com/inspektor-gadget/inspektor-gadget/
 tracers:
   malloc:
     mapName: events

gadgets/trace_mount/gadget.yaml

@@ -1,5 +1,8 @@
 name: trace mount
 description: trace mount syscalls
+homepageURL: https://inspektor-gadget.io/
+documentationURL: https://inspektor-gadget.io/docs
+sourceURL: https://github.com/inspektor-gadget/inspektor-gadget/
 tracers:
   mount:
     mapName: events

gadgets/trace_oomkill/gadget.yaml

@@ -1,5 +1,8 @@
-name: oomkill
+name: trace oomkill
 description: trace OOM killer
+homepageURL: https://inspektor-gadget.io/
+documentationURL: https://inspektor-gadget.io/docs
+sourceURL: https://github.com/inspektor-gadget/inspektor-gadget/
 tracers:
   oomkill:
     mapName: events
@@ -20,8 +23,9 @@ structs:
       attributes:
         template: pid
     - name: pages
+      attributes: {}
     - name: mntns_id
-      description: 'Mount namespace inode id'
+      description: Mount namespace inode id
       attributes:
         template: ns
     - name: timestamp

gadgets/trace_open/gadget.yaml

@@ -1,5 +1,8 @@
-name: open
+name: trace open
 description: trace open files
+homepageURL: https://inspektor-gadget.io/
+documentationURL: https://inspektor-gadget.io/docs
+sourceURL: https://github.com/inspektor-gadget/inspektor-gadget/
 tracers:
   open:
     mapName: events
@@ -41,7 +44,7 @@ structs:
         width: 32
         minWidth: 24
     - name: mntns_id
-      description: 'Mount namespace inode id'
+      description: Mount namespace inode id
       attributes:
         template: ns
 ebpfParams:

gadgets/trace_signal/gadget.yaml

@@ -1,5 +1,8 @@
-name: signal
+name: trace signal
 description: trace signal
+homepageURL: https://inspektor-gadget.io/
+documentationURL: https://inspektor-gadget.io/docs
+sourceURL: https://github.com/inspektor-gadget/inspektor-gadget/
 tracers:
   signal:
     mapName: events
@@ -32,24 +35,24 @@ structs:
       attributes:
         width: 5
     - name: mntns_id
-      description: 'Mount namespace inode id'
+      description: Mount namespace inode id
       attributes:
         template: ns
 ebpfParams:
-  filtered_pid:
-    key: pid
-    defaultValue: ""
-    description: Show only events generated by processes with this pid
-  target_signal:
-    key: signal
-    defaultValue: ""
-    description: Show only events generated by this signal
   failed_only:
     key: failed
     defaultValue: "false"
     description: Show only failed events
+  filtered_pid:
+    key: pid
+    defaultValue: ""
+    description: Show only events generated by processes with this pid
   kill_only:
     key: kill-only
     alias: k
     defaultValue: "false"
     description: Show only events generated by kill family syscalls
+  target_signal:
+    key: signal
+    defaultValue: ""
+    description: Show only events generated by this signal

gadgets/trace_sni/gadget.yaml

@@ -1,10 +1,12 @@
-name: sni
+name: trace sni
 description: trace sni
+homepageURL: https://inspektor-gadget.io/
+documentationURL: https://inspektor-gadget.io/docs
+sourceURL: https://github.com/inspektor-gadget/inspektor-gadget/
 tracers:
   sni:
     mapName: events
     structName: event_t
-
 structs:
   event_t:
     fields:
@@ -30,15 +32,15 @@ structs:
       attributes:
         width: 30
     - name: netns
-      description: 'Network namespace inode id'
+      description: Network namespace inode id
       attributes:
         template: ns
     - name: mntns_id
-      description: 'Mount namespace inode id'
+      description: Mount namespace inode id
       attributes:
         template: ns
     - name: tid
       description: TID of the thread sending the request
       attributes:
-        template: pid
         hidden: true
+        template: pid

gadgets/trace_tcp/gadget.yaml

@@ -1,5 +1,8 @@
-name: tracetcp
+name: trace tcp
 description: monitor connect, accept and close events of TCP connections
+homepageURL: https://inspektor-gadget.io/
+documentationURL: https://inspektor-gadget.io/docs
+sourceURL: https://github.com/inspektor-gadget/inspektor-gadget/
 tracers:
   tracetcp:
     mapName: events

gadgets/trace_tcpconnect/gadget.yaml

@@ -1,5 +1,8 @@
-name: tcpconnect
+name: trace tcpconnect
 description: trace tcp connections
+homepageURL: https://inspektor-gadget.io/
+documentationURL: https://inspektor-gadget.io/docs
+sourceURL: https://github.com/inspektor-gadget/inspektor-gadget/
 tracers:
   tcpconnect:
     mapName: events
@@ -37,6 +40,6 @@ structs:
         alignment: left
         hidden: true
     - name: mntns_id
-      description: 'Mount namespace inode id'
+      description: Mount namespace inode id
       attributes:
         template: ns

gadgets/trace_tcpdrop/gadget.yaml

@@ -1,5 +1,8 @@
-name: tcpdrop
+name: trace tcpdrop
 description: trace TCP packets dropped by the kernel
+homepageURL: https://inspektor-gadget.io/
+documentationURL: https://inspektor-gadget.io/docs
+sourceURL: https://github.com/inspektor-gadget/inspektor-gadget/
 tracers:
   tcpdrop:
     mapName: events

gadgets/trace_tcpretrans/gadget.yaml

@@ -1,5 +1,8 @@
-name: tcpretrans
+name: trace tcpretrans
 description: trace TCP retransmissions
+homepageURL: https://inspektor-gadget.io/
+documentationURL: https://inspektor-gadget.io/docs
+sourceURL: https://github.com/inspektor-gadget/inspektor-gadget/
 tracers:
   tcpretrans:
     mapName: events
@@ -49,17 +52,17 @@ structs:
         alignment: left
         ellipsis: end
     - name: netns
-      description: 'Network namespace inode id'
+      description: Network namespace inode id
       attributes:
         template: ns
     - name: type
-      description: 'Type of the retransmission, either RETRANS or LOSS'
+      description: Type of the retransmission, either RETRANS or LOSS
       attributes:
         width: 7
         alignment: left
         ellipsis: end
     - name: mntns_id
-      description: 'Mount namespace inode id'
+      description: Mount namespace inode id
       attributes:
         template: ns
     - name: state