This repository contains the official Headlamp plugin for Inspektor Gagdet, providing an easier interface to run gadgets, better visualize the data, and manage the lifecycle of gadgets.

Before using this plugin, you need to install Inspektor Gadget on your Kubernetes cluster. For Headlamp Desktop users, you can directly install it from App Catalog. For other installation workflows, please refer to the Inspektor Gadget documentation.

• Install Headlamp (https://headlamp.dev/docs/latest/installation/desktop/)
• Open Plugin Catalog
• Select the "Inspektor Gadget" and press the install button.
• Restart Headlamp

To use the plugin as part of Headlamp in-cluster installation, you can install it using Helm:

helm repo add headlamp https://kubernetes-sigs.github.io/headlamp/
helm repo update

initContainers:
  - name: "headlamp-plugins"
    image: ghcr.io/inspektor-gadget/headlamp-plugin:0.1.0-beta.2
    imagePullPolicy: Always
    command:
      [
        "/bin/sh",
        "-c",
        "mkdir -p /build/plugins && cp -r /plugins/* /build/plugins/",
      ]
    volumeMounts:
      - name: "headlamp-plugins"
        mountPath: "/build/plugins"

persistentVolumeClaim:
  enabled: true
  accessModes:
    - ReadWriteMany
  size: 1Gi

volumeMounts:
  - name: "headlamp-plugins"
    mountPath: "/build/plugins"

volumes:
  - name: "headlamp-plugins"
    persistentVolumeClaim:
      claimName: "headlamp"

config:
  pluginsDir: "/build/plugins"

helm install my-headlamp headlamp/headlamp \
  --namespace kube-system \
  -f values.yaml

To test this plugin locally with a development instance of Headlamp:

1. Make sure you have Headlamp running first. Follow the Headlamp Quickstart Guide.

2. Once Headlamp is running, install and start this plugin:

   npm install
   npm start

This will build the plugin and make it available in your local Headlamp instance at runtime.