A Headlamp plugin for viewing and managing OPA Gatekeeper policies, violations, and a library of community-sourced templates in Kubernetes clusters.
- ConstraintTemplates: View Gatekeeper constraint templates.
- Constraints: Browse constraints with enforcement actions and match rules.
- Violations: Monitor policy violations across your cluster.
- Gatekeeper Library: Browse, customize, and apply ConstraintTemplates and Constraints from the OPA Gatekeeper Library.
- Detailed Views: Comprehensive details for templates and constraints.
- Headlamp installed and configured.
- A Kubernetes cluster with Gatekeeper installed.
- For development of the plugin: Node.js and npm (or yarn).
- Install Headlamp
- Open Plugin Catalog
- Select the Gatekeeper plugin and click the install button
- After install you may need to restart Headlamp
This project uses a Makefile
for common tasks.
-
Clone the repository:
git clone <repository-url> cd gatekeeper-headlamp-plugin
-
Setup & Initial Build: Installs dependencies, builds the plugin, and deploys it to the default Headlamp plugins directory.
make setup
-
Development Workflow: Builds and deploys the plugin. Use this after making code changes.
make dev
-
View all Makefile commands and documentation:
make help
The Makefile is extensively documented with details on build processes, platform support, troubleshooting, and more.
After running make deploy
(or make setup
/make dev
), the plugin should be available in your Headlamp plugins directory:
- Linux/macOS:
~/.config/Headlamp/plugins/gatekeeper-headlamp-plugin/
- Windows:
%APPDATA%/Headlamp/plugins/gatekeeper-headlamp-plugin/
Restart Headlamp if it was running. The "Gatekeeper" section will appear in the sidebar.