WebODM Helm Chart
WebODM provides browser-based aerial imagery processing backed by PostgreSQL with PostGIS, Redis, Celery, and a private NodeODM processor.
Features
- Official WebODM and NodeODM images pinned by version and immutable digest.
- Separate web, Celery worker, and authenticated processing workloads.
- Configurable application and processing listeners independent from Services.
- Bundled maintained PostgreSQL/PostGIS and Redis dependencies or external service contracts backed by existing Secrets.
- Retained media and processing claims, CPU and NVIDIA GPU modes, OIDC, Ingress, Gateway API, External Secrets, PodDisruptionBudget, and scheduling controls.
- NetworkPolicy enabled by default, restricted service-account token mounting, RuntimeDefault seccomp, probes, Helm tests, and behavioral k3d validation.
Install
helm install webodm oci://ghcr.io/helmforgedev/helm/webodm \
--namespace webodm --create-namespace
The default installation is suitable for functional evaluation. Photogrammetry jobs need substantially more CPU, memory, and storage than the defaults.
Storage and backup
WebODM web and worker pods share the media claim. Configure ReadWriteMany
storage before increasing worker.replicaCount. Back up the PostgreSQL database
and the media claim at the same recovery point. NodeODM task storage is retained
by default but is not a substitute for the WebODM media backup.
With the default ReadWriteOnce media claim, the worker is scheduled onto the
web pod's node. A user-defined global affinity replaces this default, so keep
equivalent co-location rules unless the media claim supports ReadWriteMany.
Security
The official upstream images currently initialize services as root. The chart drops all capabilities except the small set required by the upstream startup scripts, disables privilege escalation, and does not mount service account tokens. NetworkPolicy is enabled by default. Keep the NodeODM Service private, expose only the WebODM HTTP Service, and add explicit controller or external service peers when the cluster CNI enforces policy.
Architecture support
WebODM and the default CPU NodeODM image support amd64 and arm64. The bundled PostGIS image is amd64-only. Use an external PostGIS database on arm64 clusters.
GPU processing
Set processing.gpu.enabled=true to use the pinned official CUDA-enabled
NodeODM image. GPU mode requests nvidia.com/gpu, supports an optional
runtimeClassName, and accepts GPU-specific node selectors and tolerations.
It requires amd64 nodes with a working NVIDIA device plugin and driver stack.
OpenID Connect
WebODM 3.3.0 supports one or more OIDC providers through
settings_override.py. This chart renders one provider from the oidc block
and reads its client secret exclusively from oidc.existingSecret. Configure
the callback URI as https://YOUR_HOST/oidc/callback/ at the identity provider.
Email allowlists, profile synchronization, custom scopes, and group claims are
supported. See OIDC configuration.
External exposure
Ingress and Gateway API HTTPRoute are opt-in. Expose only the WebODM Service;
the authenticated NodeODM Service is intentionally private. Photogrammetry
uploads and downloads are large and long-running, so configure body-size and
timeout settings on the selected proxy. When NetworkPolicy is enabled, add the
Ingress controller or Gateway data-plane namespace to networkPolicy.ingressFrom.
External Secrets
Set externalSecrets.enabled=true and define canonical items to project the
application, database, Redis, or OIDC Secrets. External Secrets Operator must
already be installed. Point the corresponding existingSecret value at each
projected target. See External Secrets.
Configuration reference
The complete values contract is documented inline in values.yaml and enforced by values.schema.json. Production examples are available under examples.
Values & Configuration Reference
All schema parameters, types, defaults, and allowed values are extracted directly from the chart repository. Filter and search them in the interactive reference below or customize in Values Studio.
Application listener ports and Service ports are separate by design. Changing
web.containerPort updates WO_PORT, the container port, and probes; changing
processing.containerPort updates the NodeODM command, container port, and
probes. Services continue to route by the named http target port.
Examples
- Simple evaluation
- Production-oriented sizing
- OIDC login
- NVIDIA GPU processing
- Gateway API exposure
- External Secrets Operator
Use the examples as starting points and review every resource, persistence, and network value against the target cluster. They do not contain production credentials and do not replace a restore or representative processing test.
Architecture and operations
The detailed guides separate design intent from day-two procedures:
When an external application, OIDC, database, or Redis Secret is rotated, Helm cannot checksum the data it does not own. Restart the consuming Deployments and wait for their rollouts after the secret manager updates the Kubernetes Secret.
Validation
helm lint --strict charts/webodm
helm unittest charts/webodm
helm test webodm --namespace webodm --logs
The Helm test checks both the WebODM HTTP endpoint and the authenticated
NodeODM /info endpoint.
Troubleshooting
| Symptom | Check |
|---|---|
| Web pod waits for PostgreSQL | Database host, password Secret and PostGIS initialization |
| Worker stays unready | Redis credentials, Web Service readiness and Celery logs |
| Processor appears offline | Registration Job and processor token consistency |
| Large upload fails | Proxy request body and read/write timeouts |
| Job is evicted | CPU, memory, ephemeral-storage and PVC capacity |
| OIDC button is absent | Provider endpoints, client Secret and mounted settings override |
Security Scan
Security scan results use the same Kubescape policy set as HelmForge CI.
Security Scan: webodm
Framework Score
MITRE + NSA + SOC2 87.9762%
Security posture acceptable.
Uninstall
PersistentVolumeClaims and the generated application Secret use the Helm keep policy. Delete them explicitly only after confirming that their data is no longer required.
References
System Architecture
DESIGN.md SyncedVerified architecture contract rendered dynamically from GitHub DESIGN.md
flowchart LR User[User or API client] --> Edge[Ingress or Gateway] Edge --> Web[WebODM web Deployment] Web --> DB[(PostgreSQL and PostGIS)] Web --> Redis[(Redis)] Worker[Celery worker Deployment] --> DB Worker --> Redis Web --> Media[(Shared media PVC)] Worker --> Media Register[Registration hook Job] --> Web Register --> Node[Private NodeODM Deployment] Web --> Node Node --> Tasks[(Processing PVC)]
WebODM Values Schema Reference
Official schema parameters, default values, and types extracted directly from the chart repository.
Global(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| global | object | - | Global settings shared by the chart. |
Name Override(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| nameOverride | string | - | Chart configuration parameter |
Fullname Override(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| fullnameOverride | string | - | Chart configuration parameter |
Common Labels(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| commonLabels | object | - | Chart configuration parameter |
Image(4)
| Parameter | Type | Default | Description |
|---|---|---|---|
| image.repository | string | - | Chart configuration parameter |
| image.tag | string | - | Chart configuration parameter |
| image.digest | string | - | Chart configuration parameter |
| image.pullPolicy | string | - | Chart configuration parameter Allowed: AlwaysIfNotPresentNever |
Image Pull Secrets(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| imagePullSecrets | array | - | Chart configuration parameter |
Webodm(9)
| Parameter | Type | Default | Description |
|---|---|---|---|
| webodm.host | string | - | Chart configuration parameter |
| webodm.debug | boolean | - | Chart configuration parameter |
| webodm.existingSecret | string | - | Chart configuration parameter |
| webodm.existingSecretKeyKey | string | - | Chart configuration parameter |
| webodm.existingSecretProcessorTokenKey | string | - | Chart configuration parameter |
| webodm.secretKey | string | - | Chart configuration parameter |
| webodm.processorToken | string | - | Chart configuration parameter |
| webodm.extraEnv | array | - | Chart configuration parameter |
| webodm.extraEnvFrom | array | - | Chart configuration parameter |
Web(9)
| Parameter | Type | Default | Description |
|---|---|---|---|
| web.containerPort | integer | - | Chart configuration parameter |
| web.concurrency | integer | - | Chart configuration parameter |
| web.resources.requests.cpu | stringnumber | - | Chart configuration parameter |
| web.resources.requests.memory | string | - | Chart configuration parameter |
| web.resources.limits.cpu | stringnumber | - | Chart configuration parameter |
| web.resources.limits.memory | string | - | Chart configuration parameter |
| web.startupFailureThreshold | integer | - | Chart configuration parameter |
| web.startupPeriodSeconds | integer | - | Chart configuration parameter |
| web.terminationGracePeriodSeconds | integer | - | Chart configuration parameter |
Worker(7)
| Parameter | Type | Default | Description |
|---|---|---|---|
| worker.replicaCount | integer | - | Chart configuration parameter |
| worker.concurrency | integer | - | Chart configuration parameter |
| worker.resources.requests.cpu | stringnumber | - | Chart configuration parameter |
| worker.resources.requests.memory | string | - | Chart configuration parameter |
| worker.resources.limits.cpu | stringnumber | - | Chart configuration parameter |
| worker.resources.limits.memory | string | - | Chart configuration parameter |
| worker.terminationGracePeriodSeconds | integer | - | Chart configuration parameter |
Processing(37)
| Parameter | Type | Default | Description |
|---|---|---|---|
| processing.enabled | boolean | - | Chart configuration parameter |
| processing.containerPort | integer | - | Chart configuration parameter |
| processing.image.repository | string | - | Chart configuration parameter |
| processing.image.tag | string | - | Chart configuration parameter |
| processing.image.digest | string | - | Chart configuration parameter |
| processing.image.pullPolicy | string | - | Chart configuration parameter Allowed: AlwaysIfNotPresentNever |
| processing.gpu.enabled | boolean | - | Chart configuration parameter |
| processing.gpu.image.repository | string | - | Chart configuration parameter |
| processing.gpu.image.tag | string | - | Chart configuration parameter |
| processing.gpu.image.digest | string | - | Chart configuration parameter |
| processing.gpu.image.pullPolicy | string | - | Chart configuration parameter Allowed: AlwaysIfNotPresentNever |
| processing.gpu.count | integer | - | Chart configuration parameter |
| processing.gpu.runtimeClassName | string | - | Chart configuration parameter |
| processing.gpu.nodeSelector | object | - | Chart configuration parameter |
| processing.gpu.tolerations | array | - | Chart configuration parameter |
| processing.label | string | - | Chart configuration parameter |
| processing.parallelQueueProcessing | integer | - | Chart configuration parameter |
| processing.maxImages | integer | - | Chart configuration parameter |
| processing.maxConcurrency | integer | - | Chart configuration parameter |
| processing.maxRuntime | integer | - | Chart configuration parameter |
| processing.cleanupTasksAfter | integer | - | Chart configuration parameter |
| processing.cleanupUploadsAfter | integer | - | Chart configuration parameter |
| processing.resources.requests.cpu | stringnumber | - | Chart configuration parameter |
| processing.resources.requests.memory | string | - | Chart configuration parameter |
| processing.resources.requests.ephemeral-storage | string | - | Chart configuration parameter |
| processing.resources.limits.cpu | stringnumber | - | Chart configuration parameter |
| processing.resources.limits.memory | string | - | Chart configuration parameter |
| processing.resources.limits.ephemeral-storage | string | - | Chart configuration parameter |
| processing.terminationGracePeriodSeconds | integer | - | Chart configuration parameter |
| processing.persistence.enabled | boolean | - | Chart configuration parameter |
| processing.persistence.existingClaim | string | - | Chart configuration parameter |
| processing.persistence.storageClass | string | - | Chart configuration parameter |
| processing.persistence.accessModes | array | - | Chart configuration parameter |
| processing.persistence.size | string | - | Chart configuration parameter |
| processing.persistence.retain | boolean | - | Chart configuration parameter |
| processing.persistence.annotations | object | - | Chart configuration parameter |
| processing.tmpSizeLimit | string | - | Chart configuration parameter |
Persistence(7)
| Parameter | Type | Default | Description |
|---|---|---|---|
| persistence.enabled | boolean | - | Chart configuration parameter |
| persistence.existingClaim | string | - | Chart configuration parameter |
| persistence.storageClass | string | - | Chart configuration parameter |
| persistence.accessModes | array | - | Chart configuration parameter |
| persistence.size | string | - | Chart configuration parameter |
| persistence.retain | boolean | - | Chart configuration parameter |
| persistence.annotations | object | - | Chart configuration parameter |
Service & Networking(5)
| Parameter | Type | Default | Description |
|---|---|---|---|
| service.type | string | - | Chart configuration parameter Allowed: ClusterIPNodePortLoadBalancer |
| service.port | integer | - | Chart configuration parameter |
| service.annotations | object | - | Chart configuration parameter |
| service.ipFamilyPolicy | string | - | Chart configuration parameter Allowed: SingleStackPreferDualStackRequireDualStack |
| service.ipFamilies | array | - | Chart configuration parameter |
Processing Service(4)
| Parameter | Type | Default | Description |
|---|---|---|---|
| processingService.port | integer | - | Chart configuration parameter |
| processingService.annotations | object | - | Chart configuration parameter |
| processingService.ipFamilyPolicy | string | - | Chart configuration parameter Allowed: SingleStackPreferDualStackRequireDualStack |
| processingService.ipFamilies | array | - | Chart configuration parameter |
Oidc(15)
| Parameter | Type | Default | Description |
|---|---|---|---|
| oidc.enabled | boolean | - | Chart configuration parameter |
| oidc.name | string | - | Chart configuration parameter |
| oidc.clientId | string | - | Chart configuration parameter |
| oidc.existingSecret | string | - | Chart configuration parameter |
| oidc.existingSecretClientSecretKey | string | - | Chart configuration parameter |
| oidc.authEndpoint | string | - | Chart configuration parameter |
| oidc.tokenEndpoint | string | - | Chart configuration parameter |
| oidc.userinfoEndpoint | string | - | Chart configuration parameter |
| oidc.icon | string | - | Chart configuration parameter |
| oidc.allowedEmails | array | - | Chart configuration parameter |
| oidc.updateProfile | boolean | - | Chart configuration parameter |
| oidc.customScopes | array | - | Chart configuration parameter |
| oidc.groupClaims | array | - | Chart configuration parameter |
| oidc.createGroups | boolean | - | Chart configuration parameter |
| oidc.ignoreGroups | array | - | Chart configuration parameter |
Ingress(5)
| Parameter | Type | Default | Description |
|---|---|---|---|
| ingress.enabled | boolean | - | Chart configuration parameter |
| ingress.ingressClassName | string | - | Chart configuration parameter |
| ingress.annotations | object | - | Chart configuration parameter |
| ingress.hosts | array | - | Chart configuration parameter |
| ingress.tls | array | - | Chart configuration parameter |
Gateway API(5)
| Parameter | Type | Default | Description |
|---|---|---|---|
| gatewayAPI.enabled | boolean | - | Chart configuration parameter |
| gatewayAPI.parentRefs | array | - | Chart configuration parameter |
| gatewayAPI.hostnames | array | - | Chart configuration parameter |
| gatewayAPI.annotations | object | - | Chart configuration parameter |
| gatewayAPI.rules | array | - | Chart configuration parameter |
Network Policy(3)
| Parameter | Type | Default | Description |
|---|---|---|---|
| networkPolicy.enabled | boolean | - | Chart configuration parameter |
| networkPolicy.ingressFrom | array | - | Chart configuration parameter |
| networkPolicy.extraEgress | array | - | Chart configuration parameter |
Pdb(2)
| Parameter | Type | Default | Description |
|---|---|---|---|
| pdb.enabled | boolean | - | Chart configuration parameter |
| pdb.minAvailable | integerstring | - | Chart configuration parameter |
External Secrets(3)
| Parameter | Type | Default | Description |
|---|---|---|---|
| externalSecrets.enabled | boolean | - | Chart configuration parameter |
| externalSecrets.refreshInterval | string | - | Chart configuration parameter |
| externalSecrets.items | array | - | Chart configuration parameter |
External Database(6)
| Parameter | Type | Default | Description |
|---|---|---|---|
| externalDatabase.host | string | - | Chart configuration parameter |
| externalDatabase.port | integer | - | Chart configuration parameter |
| externalDatabase.database | string | - | Chart configuration parameter |
| externalDatabase.username | string | - | Chart configuration parameter |
| externalDatabase.existingSecret | string | - | Chart configuration parameter |
| externalDatabase.existingSecretPasswordKey | string | - | Chart configuration parameter |
External Redis(5)
| Parameter | Type | Default | Description |
|---|---|---|---|
| externalRedis.host | string | - | Chart configuration parameter |
| externalRedis.port | integer | - | Chart configuration parameter |
| externalRedis.database | integer | - | Chart configuration parameter |
| externalRedis.existingSecret | string | - | Chart configuration parameter |
| externalRedis.existingSecretPasswordKey | string | - | Chart configuration parameter |
Postgresql(14)
| Parameter | Type | Default | Description |
|---|---|---|---|
| postgresql.enabled | boolean | - | Chart configuration parameter |
| postgresql.image.repository | string | - | Chart configuration parameter |
| postgresql.image.tag | string | - | Chart configuration parameter |
| postgresql.image.pullPolicy | string | - | Chart configuration parameter Allowed: AlwaysIfNotPresentNever |
| postgresql.architecture | string | - | Chart configuration parameter Allowed: standalonereplication |
| postgresql.auth.database | string | - | Chart configuration parameter |
| postgresql.auth.username | string | - | Chart configuration parameter |
| postgresql.auth.password | string | - | Chart configuration parameter |
| postgresql.auth.existingSecret | string | - | Chart configuration parameter |
| postgresql.auth.existingSecretUserPasswordKey | string | - | Chart configuration parameter |
| postgresql.initdb.runDefaultScript | boolean | - | Chart configuration parameter |
| postgresql.initdb.scripts.10-webodm-postgis.sql | string | - | Chart configuration parameter |
| postgresql.standalone.persistence.enabled | boolean | - | Chart configuration parameter |
| postgresql.standalone.persistence.size | string | - | Chart configuration parameter |
Redis(8)
| Parameter | Type | Default | Description |
|---|---|---|---|
| redis.enabled | boolean | - | Chart configuration parameter |
| redis.architecture | string | - | Chart configuration parameter Allowed: standalonereplication |
| redis.auth.enabled | boolean | - | Chart configuration parameter |
| redis.auth.password | string | - | Chart configuration parameter |
| redis.auth.existingSecret | string | - | Chart configuration parameter |
| redis.auth.existingSecretPasswordKey | string | - | Chart configuration parameter |
| redis.standalone.persistence.enabled | boolean | - | Chart configuration parameter |
| redis.standalone.persistence.size | string | - | Chart configuration parameter |
Pod Labels(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| podLabels | object | - | Chart configuration parameter |
Pod Annotations(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| podAnnotations | object | - | Chart configuration parameter |
Pod Security(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| podSecurityContext.seccompProfile.type | string | - | Chart configuration parameter Allowed: RuntimeDefaultLocalhostUnconfined |
Container Security(6)
| Parameter | Type | Default | Description |
|---|---|---|---|
| securityContext.runAsUser | integer | - | Chart configuration parameter |
| securityContext.runAsNonRoot | boolean | - | Chart configuration parameter |
| securityContext.allowPrivilegeEscalation | boolean | - | Chart configuration parameter |
| securityContext.readOnlyRootFilesystem | boolean | - | Chart configuration parameter |
| securityContext.capabilities.drop | array | - | Chart configuration parameter |
| securityContext.capabilities.add | array | - | Chart configuration parameter |
Node Selector(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| nodeSelector | object | - | Chart configuration parameter |
Tolerations(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| tolerations | array | - | Chart configuration parameter |
Affinity(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| affinity | object | - | Chart configuration parameter |
Topology Spread Constraints(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| topologySpreadConstraints | array | - | Chart configuration parameter |
Priority Class Name(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| priorityClassName | string | - | Chart configuration parameter |
Service Account(4)
| Parameter | Type | Default | Description |
|---|---|---|---|
| serviceAccount.create | boolean | - | Chart configuration parameter |
| serviceAccount.name | string | - | Chart configuration parameter |
| serviceAccount.annotations | object | - | Chart configuration parameter |
| serviceAccount.automountServiceAccountToken | boolean | - | Chart configuration parameter |
No schema parameters match your search
Try searching for a different keyword or reset the filter.