Skip to content

Commit ef33855

Browse files
Copilotillume
andcommitted
Add documentation for custom API server endpoint
- Updated Helm chart README with apiServerEndpoint configuration - Added installation example with custom API endpoint - Documented use case with kube-oidc-proxy Co-authored-by: illume <9541+illume@users.noreply.github.com>
1 parent 7051d8f commit ef33855

File tree

1 file changed

+22
-9
lines changed

1 file changed

+22
-9
lines changed

charts/headlamp/README.md

Lines changed: 22 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,18 @@ $ helm install my-headlamp headlamp/headlamp \
5353
--set ingress.hosts[0].paths[0].path=/
5454
```
5555

56+
### Installation with Custom API Server Endpoint
57+
58+
For use cases where API requests need to pass through a proxy (e.g., kube-oidc-proxy for OIDC authentication from private endpoints):
59+
60+
```console
61+
$ helm install my-headlamp headlamp/headlamp \
62+
--namespace kube-system \
63+
--set config.apiServerEndpoint=https://kube-oidc-proxy.example.com:443
64+
```
65+
66+
This is particularly useful with managed Kubernetes clusters (like EKS) when using [kube-oidc-proxy](https://github.com/jetstack/kube-oidc-proxy) to handle OIDC authentication.
67+
5668
## Configuration
5769

5870
### Core Parameters
@@ -67,15 +79,16 @@ $ helm install my-headlamp headlamp/headlamp \
6779

6880
### Application Configuration
6981

70-
| Key | Type | Default | Description |
71-
|--------------------|--------|-----------------------|---------------------------------------------------------------------------|
72-
| config.inCluster | bool | `true` | Run Headlamp in-cluster |
73-
| config.baseURL | string | `""` | Base URL path for Headlamp UI |
74-
| config.pluginsDir | string | `"/headlamp/plugins"` | Directory to load Headlamp plugins from |
75-
| config.enableHelm | bool | `false` | Enable Helm operations like install, upgrade and uninstall of Helm charts |
76-
| config.extraArgs | array | `[]` | Additional arguments for Headlamp server |
77-
| config.tlsCertPath | string | `""` | Certificate for serving TLS |
78-
| config.tlsKeyPath | string | `""` | Key for serving TLS |
82+
| Key | Type | Default | Description |
83+
|-------------------------|--------|-----------------------|---------------------------------------------------------------------------|
84+
| config.inCluster | bool | `true` | Run Headlamp in-cluster |
85+
| config.apiServerEndpoint| string | `""` | Custom Kubernetes API server endpoint (overrides default in-cluster endpoint). Useful when requests need to pass through a proxy like kube-oidc-proxy. |
86+
| config.baseURL | string | `""` | Base URL path for Headlamp UI |
87+
| config.pluginsDir | string | `"/headlamp/plugins"` | Directory to load Headlamp plugins from |
88+
| config.enableHelm | bool | `false` | Enable Helm operations like install, upgrade and uninstall of Helm charts |
89+
| config.extraArgs | array | `[]` | Additional arguments for Headlamp server |
90+
| config.tlsCertPath | string | `""` | Certificate for serving TLS |
91+
| config.tlsKeyPath | string | `""` | Key for serving TLS |
7992

8093
### OIDC Configuration
8194

0 commit comments

Comments
 (0)