Chainguard Container for kubernetes-csi-external-health-monitor

CSI External Health Monitor Controller

Chainguard Containers are regularly-updated, secure-by-default container images.

Download this Container Image

For those with access, this container image is available on cgr.dev:

docker pull cgr.dev/ORGANIZATION/kubernetes-csi-external-health-monitor:latest

Be sure to replace the ORGANIZATION placeholder with the name used for your organization's private repository within the Chainguard Registry.

Compatibility Notes

This image provides the CSI External Health Monitor Controller component for Kubernetes CSI (Container Storage Interface) drivers. It is designed to monitor the health of persistent volumes provisioned by CSI drivers and report volume conditions to Kubernetes. The image is built on Wolfi, providing regular security updates and a minimal attack surface. Chainguard's external-health-monitor image maintains functional parity with the upstream external-health-monitor.

Getting Started

The CSI External Health Monitor Controller is typically deployed as a sidecar container alongside CSI driver components. It monitors volume health by periodically calling CSI driver APIs and reporting volume conditions to Kubernetes.

Basic Deployment

The health monitor controller can be deployed as part of a CSI driver deployment:

apiVersion: apps/v1
kind: Deployment
metadata:
  name: csi-driver-with-health-monitor
spec:
  replicas: 1
  selector:
    matchLabels:
      app: csi-driver
  template:
    metadata:
      labels:
        app: csi-driver
    spec:
      containers:
      - name: csi-driver
        image: your-csi-driver:latest
        # CSI driver configuration...
      - name: health-monitor
        image: cgr.dev/ORGANIZATION/kubernetes-csi-external-health-monitor:latest
        args:
        - --v=2
        - --csi-address=/csi/csi.sock
        - --leader-election=true
        - --http-endpoint=:8080
        - --timeout=30s
        - --monitor-interval=60s
        - --enable-node-watcher=true
        ports:
        - containerPort: 8080
          name: http-endpoint
        volumeMounts:
        - name: socket-dir
          mountPath: /csi
      volumes:
      - name: socket-dir
        emptyDir: {}

Configuration Options

The external health monitor supports several command-line arguments:

• --csi-address: Path to the CSI driver socket
• --leader-election: Enable leader election for multiple replicas
• --http-endpoint: HTTP endpoint for metrics and health checks
• --timeout: Timeout for CSI operations
• --monitor-interval: Interval between health checks
• --enable-node-watcher: Enable node watcher for volume condition monitoring

Kubernetes Integration

The health monitor requires appropriate RBAC permissions to monitor volumes and report conditions:

apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
  name: external-health-monitor
rules:
- apiGroups: [""]
  resources: ["persistentvolumes", "persistentvolumeclaims", "nodes", "pods"]
  verbs: ["get", "list", "watch"]
- apiGroups: [""]
  resources: ["events"]
  verbs: ["get", "list", "watch", "create", "patch"]
- apiGroups: ["storage.k8s.io"]
  resources: ["volumeattachments", "storageclasses", "csinodes"]
  verbs: ["get", "list", "watch"]

Monitoring and Observability

The health monitor exposes metrics on the configured HTTP endpoint:

• Volume health status metrics
• CSI operation metrics
• Controller operation metrics

Access metrics via:

curl http://localhost:8080/metrics

Documentation and Resources

• CSI External Health Monitor Documentation
• Kubernetes CSI Documentation

What are Chainguard Containers?

Chainguard's free tier of Starter container images are built with Wolfi, our minimal Linux undistro.

All other Chainguard Containers are built with Chainguard OS, Chainguard's minimal Linux operating system designed to produce container images that meet the requirements of a more secure software supply chain.

The main features of Chainguard Containers include:

• Minimal design, without unnecessary software bloat
• Daily builds to ensure container images are up-to-date with available security patches
• High quality build-time SBOMs attesting to the provenance of all artifacts within the image
• Verifiable signatures provided by Sigstore
• Reproducible builds with Cosign and apko (read more about reproducibility)

For cases where you need container images with shells and package managers to build or debug, most Chainguard Containers come paired with a development, or -dev, variant.

In all other cases, including Chainguard Containers tagged as :latest or with a specific version number, the container images include only an open-source application and its runtime dependencies. These minimal container images typically do not contain a shell or package manager.

Although the -dev container image variants have similar security features as their more minimal versions, they include additional software that is typically not necessary in production environments. We recommend using multi-stage builds to copy artifacts from the -dev variant into a more minimal production image.

Need additional packages?

To improve security, Chainguard Containers include only essential dependencies. Need more packages? Chainguard customers can use Custom Assembly to add packages, either through the Console, chainctl, or API.

To use Custom Assembly in the Chainguard Console: navigate to the image you'd like to customize in your Organization's list of images, and click on the Customize image button at the top of the page.

Learn More

Refer to our Chainguard Containers documentation on Chainguard Academy. Chainguard also offers VMs and Libraries — contact us for access.

Trademarks

This software listing is packaged by Chainguard. The trademarks set forth in this offering are owned by their respective companies, and use of them does not imply any affiliation, sponsorship, or endorsement by such companies.