From e47d3cde04031885706bfe919f477c9a40b96c58 Mon Sep 17 00:00:00 2001 From: yolossn Date: Mon, 14 Apr 2025 02:10:11 +0530 Subject: [PATCH] docs: Add headlamp dashboard configuration this patch updates the docs to include the headlamp dashbaord configuration Signed-off-by: yolossn --- docs/features/kubernetes/configuration.md | 38 +++++++++++++++++++++-- 1 file changed, 36 insertions(+), 2 deletions(-) diff --git a/docs/features/kubernetes/configuration.md b/docs/features/kubernetes/configuration.md index c323d5118a..a22a7d94d9 100644 --- a/docs/features/kubernetes/configuration.md +++ b/docs/features/kubernetes/configuration.md @@ -355,8 +355,7 @@ Specifies the app that provides the Kubernetes dashboard. This will be used for formatting links to kubernetes objects inside the dashboard. -The supported dashboards are: `standard`, `rancher`, `openshift`, `gke`, `aks`, -`eks`. However, not all of them are implemented yet, so please contribute! +The supported dashboards are: `aks`, `eks`, `gke`, `headlamp`, `openshift`, `rancher`, `standard`. However, not all of them are implemented yet, so please contribute! Note that it will default to the regular dashboard provided by the Kubernetes project (`standard`), that can run in any Kubernetes cluster. @@ -448,6 +447,41 @@ cluster locator method can be configured in this way. Configures which [custom resources][3] to look for when returning an entity's Kubernetes resources belonging to the cluster. Same specification as [`customResources`](#customresources-optional) +#### `headlamp` + +When using `headlamp` as your dashboard, you have two configuration options: + +1. External Headlamp instance: + +```yaml +kubernetes: + clusterLocatorMethods: + - type: 'config' + clusters: + - url: http://127.0.0.1:9999 + name: my-cluster + dashboardUrl: http://headlamp.example.com # Your Headlamp instance URL + dashboardApp: 'headlamp' + dashboardParameters: + clusterName: 'my-cluster' # Optional, defaults to 'default' +``` + +2. Internal Headlamp (When using the Headlamp plugin for Backstage): + +```yaml +kubernetes: + clusterLocatorMethods: + - type: 'config' + clusters: + - url: http://127.0.0.1:9999 + name: my-cluster + dashboardApp: 'headlamp' + dashboardParameters: + internal: true + headlampRoute: '/headlamp' # Optional, defaults to '/headlamp' + clusterName: 'my-cluster' # Optional, defaults to 'default' +``` + #### `gke` This cluster locator is designed to work with Kubernetes clusters running in