> ## Documentation Index
> Fetch the complete documentation index at: https://docs.controlplane.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Headlamp Dashboard

> Enable Headlamp, an extensible Kubernetes web UI, as the recommended dashboard for managing your Managed Kubernetes cluster.

## Overview

Headlamp is an easy-to-use and extensible Kubernetes web UI.

Headlamp was created to blend the traditional feature set of other web UIs/dashboards (i.e., to list and view resources) with added functionality.

For more details, please refer to the official [Headlamp documentation](https://github.com/kubernetes-sigs/headlamp).

## How to Enable

The Headlamp dashboard add-on can be enabled for your Kubernetes cluster either during the cluster creation process or at any time thereafter. The following sections outline the methods for enabling the add-on:

### At Cluster Creation

* **Through Cluster Manifest**: Add the following snippet to your cluster manifest when creating the cluster:

  ```yaml theme={null}
  spec:
    addOns:
      headlamp: {}
  ```

* **Using the Console**: If you're creating the cluster through the console, navigate to `Add-ons`, find the `Headlamp` add-on in the list of available add-ons, and toggle it on.

### After Cluster Creation

If the Headlamp add-on was not enabled during the cluster creation, you can still enable it using either of the following methods:

#### Using Manifest

Under `spec.addOns` in the YAML manifest of the cluster, you can edit it either by navigating to the cluster in the Console and using the `Edit & Apply` option for the cluster, or by applying the entire manifest using the `cpln apply >_` option in the upper right corner or by using the `cpln` [CLI](/cli-reference/overview).

Add the following:

```yaml YAML theme={null}
spec:
  addOns:
    headlamp: {}
```

#### Using UI

1. **Navigate to Control Plane Console**: Visit the [Control Plane Console](https://console.cpln.io/console/).
2. **Navigate to the Kubernetes cluster**: In the Control Plane Console, navigate to `Kubernetes` in the left sidebar panel and click on the Kubernetes cluster for which you want to enable the dashboard.
3. **Enable Headlamp**: Choose `Add-ons` and locate the `Headlamp` add-on from the list of available add-ons, then toggle it on.

## How to Access

Once enabled, the Headlamp add-on can be used as follows:

1. **Navigate to Control Plane Console**: Visit the [Control Plane Console](https://console.cpln.io/console/).
2. **Access Headlamp**: In the Control Plane Console, navigate to `Kubernetes` in the left sidebar panel and click on `Open` under `Headlamp` for the cluster.