Skip to content
xeol-operator

Quick start

Four steps get you from nothing to your first scan results.

Artifact Hub

  1. Add the chart repository:

    helm repo add xeol-operator https://rishang.github.io/xeol-operator
    helm repo update

  2. Install it. Pick the tab that fits your cluster: with Grafana, or with the built-in web page.

    helm install xeol-operator xeol-operator/xeol-operator -n xeol-system --create-namespace \
      --set serviceMonitor.enabled=true \
      --set prometheusRule.enabled=true \
      --set grafanaDatasource.enabled=true

    You need kube-prometheus-stack and Grafana’s Infinity plugin.

  3. Check that it’s scanning:

    kubectl -n xeol-system get pods        # READY 1/1 once the EOL database is built
    kubectl -n xeol-system port-forward svc/xeol-operator-metrics 8080 &
    curl -s localhost:8080/api/v1/status   # images_scanned grows towards images_tracked

  4. Optional: add vulnerability scanning with trivy.

    helm upgrade xeol-operator xeol-operator/xeol-operator -n xeol-system --reuse-values --set trivy.enabled=true

    The pod first downloads trivy’s database (~1.6 GB). It turns Ready again once that’s done.

Next steps

Section titled “Next steps”