Skip to content
sighupioPublic

About

The UI for the SIGHUP Distribution based on Headlamp and custom self developed plugins

Resources

Contributing

Stars

2 stars

Watchers

0 watching

Forks

Repository files navigation

Shows a black logo in light color mode and a white one in dark color mode.
SIGHUP Distribution UI

Release License Slack

SIGHUP Distribution UI is the web interface of SIGHUP Distribution (SD). In one place it shows the state of the cluster and of the SD modules: the cluster overview, the Prometheus alerts, the certificate expiry, the events and the logs, the Velero backups and the policy violations. Built on Headlamp, it is ready for multi-tenant clusters: behind Capsule Proxy, every user sees only the namespaces of their tenant.

If you are new to SD please refer to the official documentation on how to get started with SD.

Overview

SIGHUP Distribution UI cluster overview

  • Cluster overview: a landing page that replaces the default Headlamp overview, with the distribution version, the status of each module and its type (e.g. "opensearch (triple)"), links to the infrastructure UIs (Grafana, Prometheus, OpenSearch Dashboards, MinIO, Hubble, Whisker, Gangplank...), resource usage charts, and summary cards for alerts, certificates, backups and policy violations.
  • Monitoring: firing Prometheus alerts grouped by rule group, with labels, graph queries and runbook links; X.509 certificate expiry tracking (expired, critical < 7d, warning < 28d).
  • Events and logs: historical Kubernetes events and logs from Loki or OpenSearch, and "View Logs" links on the workload detail pages to Grafana Explore or OpenSearch Dashboards.
  • Backups: Velero backups, restores and schedules, with error details and volume snapshot stats.
  • Policy: violations from Kyverno (PolicyReports) or Gatekeeper (constraint status).
  • Multi-tenancy: tenant-scoped pages (events, policy) show only the namespaces the user can access, and pages with cluster-wide data (alerts, certificates, backups) are marked with an "Unrestricted cluster-wide view" indicator. A user without namespaces sees empty results, never cluster-wide data.
  • SSO: the logout goes through Pomerium, so the user lands back on the login page.

Plugins

Each feature is a Headlamp plugin:

Plugin Description
sd-core Cluster landing page with distribution info, module status, service links, charts and summary cards. Pomerium logout.
sd-alerts Firing Prometheus alerts grouped by rule group, with severity counters, details and links to Prometheus.
sd-certificates X.509 certificate expiry monitoring through the Prometheus x509_cert_not_after metric.
sd-events Historical Kubernetes events from Loki or OpenSearch, with time range and namespace filters.
sd-logs Log viewer with Loki and OpenSearch backends.
sd-backups Velero backup, restore and schedule dashboard.
sd-policy Policy violations from Kyverno or Gatekeeper, with namespace filtering.
sd-loki-links "View Logs" links on Pod, Deployment, DaemonSet, StatefulSet and Namespace detail pages.
sd-prometheus-autoconfig Configures the Prometheus address of the Headlamp Prometheus plugin. No UI.
headlamp-reevo-theme Dark theme and logo.
cert-manager Upstream Headlamp plugin for the cert-manager resources, downloaded at build time.

Compatibility

SD UI Headlamp Utilities Module SIGHUP Distribution
v1.0.0 v0.40.1 v0.1.1 v1.36.0

The plugins adapt to the flavor of each SD module (e.g. Loki or OpenSearch, Kyverno or Gatekeeper): see the flavor compatibility matrix.

Usage

The image is published as registry.sighup.io/fury/sd-ui, and as registry.sighup.io/fury-secured/sd-ui after CVE scanning and patching.

The manifests that deploy it are part of the Utilities Module: furyctl deploys it when you create or update an OnPremises or Immutable cluster with spec.distribution.modules.utilities.headlamp enabled in your furyctl.yaml. See the module documentation for the configuration, and its examples to deploy the UI with kustomize on other clusters.

To install SD from scratch, follow one of the Getting started guides.

Development

The development environment is a Kind cluster with the whole SD stack (SSO, Capsule, monitoring, logging...) and Tilt to reload the plugins on every change:

mise install
echo '<your machine IP>' > host-ip.txt
mise run up    # Kind cluster + SIGHUP Distribution + showcase apps
mise run dev   # build the plugins, then Tilt: Headlamp with hot-reload of the plugins

See the Development Guide for the details.

Documentation

Document Description
Development Guide Kind environment: setup, commands, architecture, auth flows, troubleshooting.
Plugin Development Guide How to create a new SD plugin, with patterns and workarounds.
Flavor Compatibility How each plugin behaves with each SD module flavor.
Compatibility Validation End-to-end validation of the plugins against a live cluster.
Releases Release notes.

Contributing

Before contributing, please read first the Contributing Guidelines.

Reporting Issues

In case you experience any problem with the UI, please open a new issue.

License

This project is open source and it's released under the following LICENSE.

About

The UI for the SIGHUP Distribution based on Headlamp and custom self developed plugins

Resources

Contributing

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages