1# Default values for headlamp.
2# This is a YAML-formatted file.
3# Declare variables to be passed into your templates.
5# -- Number of desired pods
8 # -- Container image registry
10 # -- Container image name
11 repository: chainguard-private/headlamp
12 # -- Image pull policy. One of Always, Never, IfNotPresent
13 pullPolicy: IfNotPresent
14 # -- Container image tag, If "" uses appVersion in Chart.yaml
15 tag: latest@sha256:58e144342d4fa6155b6c1437c92cde142fce9cad0f79dbbc6bba7d2c2d907acb
16# -- An optional list of references to secrets in the same namespace to use for pulling any of the images used
18# -- Overrides the name of the chart
20# -- Overrides the full name of the chart
22# -- Override the deployment namespace; defaults to .Release.Namespace
24# -- An optional list of init containers to be run before the main containers.
26# -- An optional list of extra containers to be run along side the main containers.
30 inClusterContextName: "main"
31 # -- base url path at which headlamp should run
33 # -- session token TTL in seconds (default is 24 hours)
35 # -- UNSAFE: authenticate every Headlamp user as the pod's service account when running in-cluster.
36 # This disables per-user authentication and is only safe behind an auth proxy (e.g. OIDC proxy).
37 unsafeUseServiceAccountToken: false
38 # -- path to the service account token file.
39 # Only used when unsafeUseServiceAccountToken is true.
40 # Defaults to /var/run/secrets/kubernetes.io/serviceaccount/token when empty.
41 serviceAccountTokenPath: ""
44 # @param config.oidc.secret - OIDC secret configuration
45 # If you want to use an existing secret, set create to false and provide the name of the secret.
46 # If you want to create a new secret, set create to true and provide the name of the secret.
47 # Also provide the values for clientID, clientSecret, issuerURL, and scopes.
55 # -- Generate OIDC secret. If true, will generate a secret using .config.oidc.
57 # -- Name of the OIDC secret.
60 # @param config.oidc - OIDC env configuration
61 # If you want to set the OIDC configuration directly, set the following values.
65 # clientID: "clientID"
66 # clientSecret: "clientSecret"
67 # issuerURL: "issuerURL"
72 # -- OIDC client secret
76 # -- OIDC scopes to be used
78 # -- OIDC callback URL
80 # -- OIDC client to be used during token validation
82 # -- OIDC Issuer URL to be used during token validation
83 validatorIssuerURL: ""
84 # -- Use 'access_token' instead of 'id_token' when authenticating using OIDC
86 # -- Use PKCE (Proof Key for Code Exchange) for enhanced security in OIDC flow
88 # -- Enable using OIDC cookie for authentication outside of cluster
91 # @param config.oidc - External OIDC secret configuration
92 # If you want to use an external secret for OIDC configuration, enable this option.
93 # Provide the name of the secret to use.
105 # -- Set to true if your external secret contains an OIDC_SCOPES key.
106 # When false (default), the -oidc-scopes argument is omitted so that
107 # a missing key does not produce an empty or unresolved argument.
109 # -- URL to fetch additional user info for the /me endpoint.
110 # For oauth2proxy /oauth2/userinfo can be used. Empty and it will not be used.
112 # -- directory to look for plugins
113 pluginsDir: "/headlamp/plugins"
116 # -- Default image to use when creating pod debug containers. If empty, Headlamp uses its built-in default.
118 # -- Default image to use when creating node shell pods. If empty, Headlamp uses its built-in default.
120 # tlsCertPath: "/headlamp-cert/headlamp-ca.crt"
121 # tlsKeyPath: "/headlamp-cert/headlamp-tls.key"
123 # -- Enable experimental/alpha Cluster Inventory discovery.
125 # -- Experimental/alpha Cluster Inventory access providers config. Required when enabled.
126 accessProvidersConfig: {}
127 # accessProvidersConfig:
129 # - name: secretreader
131 # apiVersion: client.authentication.k8s.io/v1
132 # command: /access-plugins/secretreader/bin/secretreader-plugin
133 # interactiveMode: Never
134 # provideClusterInfo: true
135 # - name: kubeconfig-secretreader
137 # apiVersion: client.authentication.k8s.io/v1
138 # command: /access-plugins/kubeconfig-secretreader/bin/kubeconfig-secretreader-plugin
139 # interactiveMode: Never
140 # provideClusterInfo: true
141 # plugins[] uses the Kubernetes "image" volume type to mount experimental/alpha access provider binaries.
144 # - name: secretreader
145 # image: registry.k8s.io/cluster-inventory-api/secretreader:v0.1.3@sha256:ec3090dc166aa2b42fb35d714d161c417d8b27bbc463404c8f615f5f4c610a1d
146 # mountPath: /access-plugins/secretreader
147 # - name: kubeconfig-secretreader
148 # image: registry.k8s.io/cluster-inventory-api/kubeconfig-secretreader:v0.1.3@sha256:b92966cc6e4ac78002a63862921022a71d54956826f6e4febcb7247495eb98c0
149 # mountPath: /access-plugins/kubeconfig-secretreader
150 # -- Kubernetes label selector used to filter experimental/alpha ClusterProfile resources.
151 labelSelector: "!headlamp.dev/ignore"
152 # -- Override the experimental/alpha Cluster Inventory root reconcile interval. Empty uses the Headlamp default.
153 rootReconcileInterval: ""
154 # -- Override the experimental/alpha Cluster Inventory no-CRD cache TTL. Empty uses the Headlamp default.
156 # Extra arguments that can be given to the container. See charts/headlamp/README.md for more information.
158# -- An optional list of environment variables
160# - name: KUBERNETES_SERVICE_HOST
162# - name: KUBERNETES_SERVICE_PORT
165# -- Mount Service Account token in pod
166automountServiceAccountToken: true
168 # -- Specifies whether a service account should be created
170 # -- Annotations to add to the service account
172 # -- The name of the service account to use.(If not set and create is true, a name is generated using the fullname template)
175 # -- Specified whether a cluster role binding should be created
177 # -- Set name of the Cluster Role with limited permissions from you cluster
178 # for example - clusterRoleName: user-ro
179 clusterRoleName: cluster-admin
180 # -- Annotations to add to the cluster role binding
182# -- Annotations to add to the deployment
183deploymentAnnotations: {}
184# -- Annotations to add to the pod
186# -- Labels to add to the pod
188# -- Controls user namespace isolation for the Headlamp pod.
189# When true (default), the pod shares the host user namespace (user namespaces are DISABLED).
190# When false, the pod uses a separate user namespace (user namespaces are ENABLED) for stronger isolation,
191# if supported by the cluster. Set this to false if your cluster supports user namespaces and you want
192# additional isolation; leave as true if user namespaces are not available.
193# See: https://kubernetes.io/docs/concepts/workloads/pods/user-namespaces/
195# -- Headlamp pod's Security Context
196podSecurityContext: {}
199# -- Headlamp containers Security Context
200# When readOnlyRootFilesystem: true is set, the chart automatically adds a
201# writable emptyDir volume named "headlamp-tmp" mounted at /tmp so the
202# application can write temporary files.
203# You can override this behavior in two ways:
204# 1. Supply your own volumeMount with mountPath: /tmp — the chart will skip
205# adding both the automatic mount and the automatic volume.
206# 2. Supply your own volume named "headlamp-tmp" (e.g. to set sizeLimit) —
207# the chart will skip creating the volume but will still add the /tmp mount
208# pointing to your volume.
213 # readOnlyRootFilesystem: true
218# Uses these defaults if this is empty.
219# allowPrivilegeEscalation: false
222# type: RuntimeDefault
228 # -- Annotations to add to the service
230 # -- Kubernetes Service type
232 # -- Kubernetes Service port
234 # -- Kubernetes Service clusterIP
236 # -- Kubernetes Service loadBalancerIP
238 # -- Kubernetes Service loadBalancerSourceRanges
239 loadBalancerSourceRanges: []
240 # -- Kubernetes Service Nodeport
242 # -- Additional ports to expose on the Service in addition to the default
243 # http port. Each entry must have a unique `name` and a `port`. `targetPort`
244 # defaults to `port` when omitted. `nodePort` is only honored when
245 # `service.type` is `NodePort` or `LoadBalancer`. A matching containerPort
246 # must be provided by the user (e.g. via a sidecar) for traffic to actually
248 extraServicePorts: []
254# -- Headlamp containers volume mounts
256# -- Headlamp pod's volumes
258persistentVolumeClaim:
259 # -- Enable Persistent Volume Claim
261 # -- Annotations to add to the persistent volume claim (if enabled)
263 # -- accessModes for the persistent volume claim, eg: ReadWriteOnce, ReadOnlyMany, ReadWriteMany etc.
265 # -- size of the persistent volume claim, eg: 10Gi. Required if enabled is true.
267 # -- storageClassName for the persistent volume claim.
269 # -- selector for the persistent volume claim.
271 # -- volumeMode for the persistent volume claim, eg: Filesystem, Block.
274 # -- Enable ingress controller resource
276 # -- Annotations for Ingress resource
278 # kubernetes.io/tls-acme: "true"
280 # -- Additional labels to add to the Ingress resource
282 # app.kubernetes.io/part-of: traefik
285 # -- Ingress class name. replacement for the deprecated "kubernetes.io/ingress.class" annotation
287 # -- Hostname(s) for the Ingress resource
288 # Please refer to https://kubernetes.io/docs/reference/kubernetes-api/service-resources/ingress-v1/#IngressSpec for more information.
289 # Each path may optionally specify `backend.service.{name,port}` to override
290 # the default Headlamp Service / `service.port`. `name` supports `tpl` so
291 # values like `{{ .Release.Name }}-extra` can be used. `port` accepts either
292 # `number` or `name` (matching `service.extraServicePorts[].name`).
294 # - host: chart-example.local
297 # type: ImplementationSpecific
299 # type: ImplementationSpecific
304 # -- Ingress TLS configuration
306 # - secretName: chart-example-tls
308 # - chart-example.local
309# HTTPRoute configuration for Gateway API
310# Please refer to https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.HTTPRoute
312 # -- Enable HTTPRoute resource for Gateway API
314 # -- Annotations for HTTPRoute resource
316 # -- Additional labels for HTTPRoute resource
318 # -- Parent references (REQUIRED when enabled - HTTPRoute will not work without this)
322 # namespace: gateway-namespace
324 # -- Hostnames for the HTTPRoute
327 # - headlamp.example.com
329 # -- Custom routing rules (optional, defaults to path prefix /)
330 # If not specified, a default rule routing all traffic to the service is used
332 # Example custom rules:
339 # - name: "{{ .Release.Name }}-headlamp"
341# -- CPU/Memory resource requests/limits
343# We usually recommend not to specify default resources and to leave this as a conscious
344# choice for the user. This also increases chances charts run on environments with little
345# resources, such as Minikube. If you do want to specify resources, uncomment the following
346# lines, adjust them as necessary, and remove the curly braces after 'resources:'.
354# -- Node labels for pod assignment
356# -- Toleration labels for pod assignment
358# -- Affinity settings for pod assignment
360# -- Host aliases to add to the pod's /etc/hosts file
362# -- Topology Spread Constraints for pod assignment
363topologySpreadConstraints: []
365# topologyKey: topology.kubernetes.io/zone
366# whenUnsatisfiable: ScheduleAnyway
370# topologyKey: kubernetes.io/hostname
371# whenUnsatisfiable: DoNotSchedule
375# -- Pod priority class
377# Probe configuration for liveness and readiness checks
379 # -- Scheme to use for liveness and readiness probes (HTTP or HTTPS).
380 # Set to HTTPS when TLS is enabled at the backend server.
383 # -- Initial delay in seconds before starting liveness probe
384 initialDelaySeconds: 0
385 # -- Period in seconds between liveness probe checks
387 # -- Timeout in seconds for liveness probe
389 # -- Minimum consecutive successes for the probe to be considered successful (must be 1 for liveness probes per Kubernetes API)
391 # -- Minimum consecutive failures for the probe to be considered failed
394 # -- Initial delay in seconds before starting readiness probe
395 initialDelaySeconds: 0
396 # -- Period in seconds between readiness probe checks
398 # -- Timeout in seconds for readiness probe
400 # -- Minimum consecutive successes for the probe to be considered successful
402 # -- Minimum consecutive failures for the probe to be considered failed
404# Plugin Manager Sidecar Container Configuration
406 # -- Enable plugin manager
408 # -- Plugin configuration file name
409 configFile: "plugin.yml"
410 # -- Plugin configuration content in YAML format. This is required if plugins.enabled is true.
412 # -- Base node image to use
413 baseImage: cgr.dev/chainguard-private/node:latest@sha256:e18f9c9c1fc1784e6eb14c0af919eb891f2ee069c02db3f5f4294c42e0671cf7
414 # -- Headlamp plugin package version to install
416 # -- Plugin manager containers volume mounts
418 # -- Plugin manager env variable configuration
420 # - name: HTTPS_PROXY
421 # value: "proxy.example.com:8080"
422 # -- Specify resrouces
430 # If omitted, the plugin manager will inherit the global securityContext.
431 # When readOnlyRootFilesystem: true is active (set here or inherited), the
432 # chart automatically adds a writable emptyDir volume named
433 # "headlamp-plugins-tmp" mounted at /tmp in the plugin manager container.
434 # Override behavior mirrors the main container: supply your own /tmp
435 # volumeMount to skip both, or supply your own "headlamp-plugins-tmp" volume
436 # (e.g. to set sizeLimit) to have the chart only add the mount.
440 # allowPrivilegeEscalation: false
441 # readOnlyRootFilesystem: true
446 # -- enable PodDisruptionBudget
447 # ref: https://kubernetes.io/docs/concepts/workloads/pods/disruptions/
450 # type: [null, integer, string]
452 # -- Minimum number/percentage of pods that should remain scheduled.
453 # When it's set, maxUnavailable must be disabled by `maxUnavailable: null`
456 # type: [null, integer, string]
458 # -- Maximum number/percentage of pods that may be made unavailable
461 # type: [null, string]
463 # -- How are unhealthy, but running, pods counted for eviction
464 unhealthyPodEvictionPolicy: null
465# -- Additional Kubernetes manifests to be deployed. Include the manifest as nested YAML.