ITADN
sebrandon1/compliance-operator-dashboard
sebrandon1/compliance-operator-dashboard · 文件
文件最后提交记录最后更新时间
README.md

Compliance Operator Dashboard

Web dashboard for the OpenShift Compliance Operator that provides full lifecycle management from a single UI: install the operator, run scans, view results, apply remediations, and uninstall.

Companion project to compliance-scripts -- the same workflows reimplemented natively in Go with a React frontend, shipped as a single binary.

Features

  • Operator Install / Uninstall -- One-click install with real-time WebSocket progress. Auto-detects Red Hat certified vs community operator.
  • Scan Management -- Create scans from any profile, run recommended suites (CIS, NIST 800-53, PCI-DSS), rescan, and delete.
  • Results & Remediation -- Severity filtering, search, per-check rationale, and one-click remediation apply.
  • Real-Time Updates -- WebSocket-driven live streaming of scan status, results, and remediation outcomes.
  • Single Binary -- Go backend with embedded React SPA via go:embed.

Quick Start

make build
./bin/compliance-operator-dashboard serve

Dashboard starts at http://localhost:8080 using your current kubeconfig.

Commands

make build             # Build frontend + Go binary
make run               # Build and run
make test              # Run Go unit tests
make lint              # Run golangci-lint
make frontend-dev      # Start Vite dev server (port 5173, proxies API to :8080)
make clean             # Remove build artifacts

Guides

GuideDescription
Getting StartedStep-by-step walkthrough with screenshots
ConfigurationCLI flags, environment variables, examples
API ReferenceREST endpoints and WebSocket
ArchitectureProject layout, key patterns, operator versioning

Requirements

  • Go 1.22+
  • Node.js 18+
  • Access to an OpenShift cluster with kubeconfig configured