https://github.com/sozercan/gatekeeper-headlamp-plugin

💡 Headlamp plugin for Gatekeeper
https://github.com/sozercan/gatekeeper-headlamp-plugin

dashboard devops devsecops gatekeeper headlamp kubernetes kubernetes-dashboard kubernetes-ui opa policy security

Last synced: about 2 months ago
JSON representation

💡 Headlamp plugin for Gatekeeper

• Host: GitHub
• URL: https://github.com/sozercan/gatekeeper-headlamp-plugin
• Owner: sozercan
• Created: 2025-06-07T05:33:57.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2025-11-03T00:01:59.000Z (8 months ago)
• Last Synced: 2025-11-03T01:17:00.840Z (8 months ago)
• Topics: dashboard, devops, devsecops, gatekeeper, headlamp, kubernetes, kubernetes-dashboard, kubernetes-ui, opa, policy, security
• Language: TypeScript
• Homepage:
• Size: 5.02 MB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Gatekeeper Headlamp Plugin

A [Headlamp](https://headlamp.dev) plugin for viewing and managing [OPA Gatekeeper](https://open-policy-agent.github.io/gatekeeper/) policies, violations, and a library of community-sourced templates in Kubernetes clusters.

[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/gatekeeper-headlamp-plugin)](https://artifacthub.io/packages/search?repo=gatekeeper-headlamp-plugin)

## Features

- **ConstraintTemplates**: View Gatekeeper constraint templates.

![Constraint Templates](images/constraint_template.png)

- **Constraints**: Browse constraints with enforcement actions and match rules.

![Constraints](images/constraints.png)

- **Violations**: Monitor policy violations across your cluster.

![Violations](images/violations.png)

- **Gatekeeper Library**: Browse, customize, and apply ConstraintTemplates and Constraints from the OPA Gatekeeper Library.

![Gatekeeper Library](images/library.png)

- **Detailed Views**: Comprehensive details for templates and constraints.

![Constraint Details](images/constraints_detail.png)

## Prerequisites

- Headlamp installed and configured.

- A Kubernetes cluster with [Gatekeeper installed](https://open-policy-agent.github.io/gatekeeper/website/docs/install/).

- For development of the plugin: Node.js and npm (or yarn).

## Installation

- Install [Headlamp](https://headlamp.dev)

- Open Plugin Catalog

- Select the Gatekeeper plugin and click the install button

- After install you may need to restart Headlamp

## Development

This project uses a `Makefile` for common tasks.

1.  **Clone the repository:**

    ```bash

    git clone 

    cd gatekeeper-headlamp-plugin

    ```

1.  **Setup & Initial Build:**

    Installs dependencies, builds the plugin, and deploys it to the default Headlamp plugins directory.

    ```bash

    make setup

    ```

1.  **Development Workflow:**

    Builds and deploys the plugin. Use this after making code changes.

    ```bash

    make dev

    ```

1.  **View all Makefile commands and documentation:**

    ```bash

    make help

    ```

    The Makefile is extensively documented with details on build processes, platform support, troubleshooting, and more.

### Loading the Plugin in Headlamp

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.