CKAN
CKAN is an open-source data management system for powering data hubs and data portals. It is used by governments, research institutions, and other organizations to manage and publish collections of data.
Features
- CKAN application — uWSGI-based Python application serving the data portal on port 5000
- DataPusher — optional companion service for automatic resource loading (CSV, Excel to DataStore)
- Solr StatefulSet — built-in search engine with CKAN-specific schema configuration
- PostgreSQL subchart — bundled metadata store with option for external database
- Redis subchart — bundled task queue and caching layer with option for external Redis
- Auto-generated secrets — sysadmin password, session secret, JWT secret
- Persistent storage — PVC for uploaded datasets at
/var/lib/ckan - Health probes — startup, liveness, and readiness probes on
/api/action/status_show - Ingress support — configurable with
ingressClassName(traefik, nginx, etc.) - Plugin system — configure CKAN plugins via
ckan.plugins - Configurable process ports — CKAN, DataPusher, and Solr values change the listeners rather than only the Kubernetes metadata
- Hardened runtime — image-native non-root UIDs, seccomp, dropped capabilities, and disabled ServiceAccount token mounting
- NetworkPolicy — public CKAN ingress with internal-only component ports
Install
Helm repository
helm repo add helmforge https://repo.helmforge.dev
helm repo update
helm install ckan helmforge/ckan -f values.yaml
OCI registry
helm install ckan oci://ghcr.io/helmforgedev/helm/ckan --version <version> -f values.yaml
Architecture
Deployment: ckan (uWSGI, port 5000)
Deployment: datapusher (port 8800)
StatefulSet: solr (port 8983)
├─ PostgreSQL (subchart)
└─ Redis (subchart)
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.
|-----|---------|-------------|
| image.repository | ckan/ckan-base | CKAN container image |
| image.tag | 2.12.0 | Image tag |
| ckan.containerPort | 5000 | CKAN uWSGI listener port |
| ckan.uwsgiProcesses | 2 | uWSGI worker processes |
| ckan.siteUrl | http://localhost:5000 | Public site URL |
| ckan.sysadminName | admin | Sysadmin username |
| ckan.sysadminPassword | "" (auto) | Sysadmin password |
| ckan.plugins | envvars image_view text_view datatables_view | Active plugins |
| ckan.replicaCount | 1 | CKAN replicas |
| datapusher.enabled | true | Enable DataPusher |
| solr.enabled | true | Enable built-in Solr |
| solr.persistence.size | 5Gi | Solr data volume size |
| database.mode | subchart | Database mode: subchart or external |
| redisConfig.mode | subchart | Redis mode: subchart or external |
| persistence.enabled | true | Enable CKAN storage persistence |
| persistence.size | 10Gi | CKAN storage volume size |
| service.type | ClusterIP | Service type |
| service.port | 80 | Service port |
| ingress.enabled | false | Enable ingress |
| ingress.ingressClassName | traefik | Ingress class |
| networkPolicy.enabled | true | Restrict CKAN, DataPusher, and Solr ingress |
| serviceAccount.automountServiceAccountToken | false | Mount Kubernetes API credentials |
| postgresql.enabled | true | Enable PostgreSQL subchart |
| redis.enabled | true | Enable Redis subchart |
This chart deploys CKAN 2.12.0 with HelmForge PostgreSQL 2.1.1 and Redis 3.1.0.
It intentionally does not keep Chart.lock; dependencies are resolved by the release workflow.
Upgrade Notes
CKAN 2.12.0 is a minor application upgrade. Back up the CKAN database and
persistent storage, review the upstream 2.11.6 and 2.12.0 release notes, and
test extensions against CKAN 2.12 before production rollout. Keep the Solr,
PostgreSQL, and Redis services available while CKAN performs its upgrade steps.
The previous redisConfig.external.url value is replaced by structured host,
port, TLS, database, and Secret-backed password fields.
Examples
See production values for a hardened bundled topology and external datastores for a DataStore-capable deployment.
External Database
postgresql:
enabled: false
database:
mode: external
external:
host: postgres.example.com
port: 5432
ckanDatabase: ckan
datastoreDatabase: datastore
username: ckan
existingSecret: ckan-database
existingSecretPasswordKey: password
existingSecretDatastoreReadPasswordKey: datastore-read-password
sslMode: verify-full
With verify-full, mount the trusted PostgreSQL CA and point libpq to it:
ckan:
extraEnv:
- name: PGSSLROOTCERT
value: /etc/ckan/postgresql-ca/ca.crt
extraVolumes:
- name: postgresql-ca
secret:
secretName: postgresql-ca
extraVolumeMounts:
- name: postgresql-ca
mountPath: /etc/ckan/postgresql-ca
readOnly: true
External Redis
redis:
enabled: false
redisConfig:
mode: external
external:
host: redis.example.com
port: 6379
database: 0
tls: true
sslCertReqs: required
existingSecret: ckan-redis
existingSecretPasswordKey: redis-password
Ingress
ingress:
enabled: true
ingressClassName: traefik # or nginx
annotations:
cert-manager.io/cluster-issuer: letsencrypt-prod
hosts:
- host: ckan.example.com
paths:
- path: /
pathType: Prefix
tls:
- secretName: ckan-tls
hosts:
- ckan.example.com
Plugins
Configure CKAN plugins via ckan.plugins:
ckan:
plugins: "envvars image_view text_view recline_view datastore datapusher spatial_metadata spatial_query"
The chart configures DataStore read and write URLs but does not provision its
database or least-privilege roles. Prepare them according to the upstream
DataStore documentation before adding datastore and datapusher to the
plugin list. DataStore is supported only with database.mode=external.
Security
Generated sysadmin, session, and JWT values are preserved during Helm upgrades.
For production, use ckan.existingSecret and externally managed datastore
credential Secrets so recovery does not depend on the Helm release Secret.
The CKAN image must update /srv/app/ckan.ini during startup, so its root
filesystem remains writable. Other hardening defaults remain enabled. Review
security.md before restricting NetworkPolicy egress or
adding third-party plugins.
Troubleshooting
Start with the CKAN logs, dependency endpoints, and recent events. A Ready web pod does not validate DataPusher jobs, every extension, or a separate DataStore database. The operations guide contains backup, restore, dependency, and first-start checks.
More Information
Security Scan: ckan
| Framework | Score |
|---|---|
| MITRE + NSA + SOC2 | 76.893936% |
Security posture acceptable.
System Architecture
DESIGN.md SyncedVerified architecture contract rendered dynamically from GitHub DESIGN.md
flowchart LR Client[Client or Ingress] --> Service[CKAN Service] Service --> CKAN[CKAN uWSGI Deployment] CKAN --> PostgreSQL[(PostgreSQL)] CKAN --> Redis[(Redis)] CKAN --> Solr[(Solr search index)] CKAN --> DataPusher[DataPusher Deployment] Backup[Backup CronJob] --> PostgreSQL Backup --> S3[(S3-compatible storage)]
Ckan Values Schema Reference
Official schema parameters, default values, and types extracted directly from the chart repository.
Global(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| global | object | - | Chart configuration parameter |
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(3)
| Parameter | Type | Default | Description |
|---|---|---|---|
| image.repository | string | - | Chart configuration parameter |
| image.tag | 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 |
Ckan(17)
| Parameter | Type | Default | Description |
|---|---|---|---|
| ckan.containerPort | integer | - | Chart configuration parameter |
| ckan.uwsgiProcesses | integer | - | Chart configuration parameter |
| ckan.uwsgiHarakiri | integer | - | Chart configuration parameter |
| ckan.siteUrl | string | - | Chart configuration parameter |
| ckan.siteTitle | string | - | Chart configuration parameter |
| ckan.sysadminName | string | - | Chart configuration parameter |
| ckan.sysadminEmail | string | - | Chart configuration parameter |
| ckan.sysadminPassword | string | - | Chart configuration parameter |
| ckan.existingSecret | string | - | Chart configuration parameter |
| ckan.existingSecretPasswordKey | string | - | Chart configuration parameter |
| ckan.existingSecretSessionKey | string | - | Chart configuration parameter |
| ckan.existingSecretJwtKey | string | - | Chart configuration parameter |
| ckan.sessionSecret | string | - | Chart configuration parameter |
| ckan.jwtSecret | string | - | Chart configuration parameter |
| ckan.plugins | string | - | Chart configuration parameter |
| ckan.replicaCount | integer | - | Chart configuration parameter |
| ckan.extraEnv | array | - | Chart configuration parameter |
Datapusher(18)
| Parameter | Type | Default | Description |
|---|---|---|---|
| datapusher.enabled | boolean | - | Chart configuration parameter |
| datapusher.image.repository | string | - | Chart configuration parameter |
| datapusher.image.tag | string | - | Chart configuration parameter |
| datapusher.image.pullPolicy | string | - | Chart configuration parameter Allowed: AlwaysIfNotPresentNever |
| datapusher.replicaCount | integer | - | Chart configuration parameter |
| datapusher.port | integer | - | Chart configuration parameter |
| datapusher.resources | object | - | Chart configuration parameter |
| datapusher.podSecurityContext.fsGroup | integer | - | Chart configuration parameter |
| datapusher.podSecurityContext.fsGroupChangePolicy | string | - | Chart configuration parameter |
| datapusher.podSecurityContext.seccompProfile.type | string | - | Chart configuration parameter |
| datapusher.securityContext.allowPrivilegeEscalation | boolean | - | Chart configuration parameter |
| datapusher.securityContext.capabilities.drop | array | - | Chart configuration parameter |
| datapusher.securityContext.readOnlyRootFilesystem | boolean | - | Chart configuration parameter |
| datapusher.securityContext.runAsNonRoot | boolean | - | Chart configuration parameter |
| datapusher.securityContext.runAsUser | integer | - | Chart configuration parameter |
| datapusher.securityContext.runAsGroup | integer | - | Chart configuration parameter |
| datapusher.podLabels | object | - | Chart configuration parameter |
| datapusher.podAnnotations | object | - | Chart configuration parameter |
Solr(20)
| Parameter | Type | Default | Description |
|---|---|---|---|
| solr.enabled | boolean | - | Chart configuration parameter |
| solr.image.repository | string | - | Chart configuration parameter |
| solr.image.tag | string | - | Chart configuration parameter |
| solr.image.pullPolicy | string | - | Chart configuration parameter Allowed: AlwaysIfNotPresentNever |
| solr.port | integer | - | Chart configuration parameter |
| solr.persistence.enabled | boolean | - | Chart configuration parameter |
| solr.persistence.size | string | - | Chart configuration parameter |
| solr.persistence.storageClass | string | - | Chart configuration parameter |
| solr.persistence.accessModes | array | - | Chart configuration parameter |
| solr.resources | object | - | Chart configuration parameter |
| solr.podSecurityContext.fsGroup | integer | - | Chart configuration parameter |
| solr.podSecurityContext.fsGroupChangePolicy | string | - | Chart configuration parameter |
| solr.podSecurityContext.seccompProfile.type | string | - | Chart configuration parameter |
| solr.securityContext.allowPrivilegeEscalation | boolean | - | Chart configuration parameter |
| solr.securityContext.capabilities.drop | array | - | Chart configuration parameter |
| solr.securityContext.readOnlyRootFilesystem | boolean | - | Chart configuration parameter |
| solr.securityContext.runAsNonRoot | boolean | - | Chart configuration parameter |
| solr.securityContext.runAsUser | integer | - | Chart configuration parameter |
| solr.securityContext.runAsGroup | integer | - | Chart configuration parameter |
| solr.externalUrl | string | - | Chart configuration parameter |
Database(13)
| Parameter | Type | Default | Description |
|---|---|---|---|
| database.mode | string | - | Chart configuration parameter Allowed: subchartexternal |
| database.external.host | string | - | Chart configuration parameter |
| database.external.port | integer | - | Chart configuration parameter |
| database.external.ckanDatabase | string | - | Chart configuration parameter |
| database.external.datastoreDatabase | string | - | Chart configuration parameter |
| database.external.username | string | - | Chart configuration parameter |
| database.external.password | string | - | Chart configuration parameter |
| database.external.datastoreReadUsername | string | - | Chart configuration parameter |
| database.external.datastoreReadPassword | string | - | Chart configuration parameter |
| database.external.existingSecret | string | - | Chart configuration parameter |
| database.external.existingSecretPasswordKey | string | - | Chart configuration parameter |
| database.external.existingSecretDatastoreReadPasswordKey | string | - | Chart configuration parameter |
| database.external.sslMode | string | - | Chart configuration parameter Allowed: disableallowpreferrequireverify-caverify-full |
Redis Config(10)
| Parameter | Type | Default | Description |
|---|---|---|---|
| redisConfig.mode | string | - | Chart configuration parameter Allowed: subchartexternal |
| redisConfig.external.host | string | - | Chart configuration parameter |
| redisConfig.external.port | integer | - | Chart configuration parameter |
| redisConfig.external.database | integer | - | Chart configuration parameter |
| redisConfig.external.tls | boolean | - | Chart configuration parameter |
| redisConfig.external.sslCertReqs | string | - | Chart configuration parameter Allowed: requiredoptionalnone |
| redisConfig.external.sslCaCerts | string | - | Chart configuration parameter |
| redisConfig.external.password | string | - | Chart configuration parameter |
| redisConfig.external.existingSecret | string | - | Chart configuration parameter |
| redisConfig.external.existingSecretPasswordKey | string | - | Chart configuration parameter |
Persistence(5)
| Parameter | Type | Default | Description |
|---|---|---|---|
| persistence.enabled | boolean | - | Chart configuration parameter |
| persistence.size | string | - | Chart configuration parameter |
| persistence.storageClass | string | - | Chart configuration parameter |
| persistence.accessModes | array | - | Chart configuration parameter |
| persistence.existingClaim | string | - | Chart configuration parameter |
Service & Networking(3)
| Parameter | Type | Default | Description |
|---|---|---|---|
| service.type | string | - | Chart configuration parameter Allowed: ClusterIPNodePortLoadBalancer |
| service.port | integer | - | Chart configuration parameter |
| service.annotations | object | - | 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 |
Health Probes(17)
| Parameter | Type | Default | Description |
|---|---|---|---|
| probes.liveness.httpGet.path | string | - | Chart configuration parameter |
| probes.liveness.httpGet.port | any | - | Chart configuration parameter |
| probes.liveness.initialDelaySeconds | integer | - | Chart configuration parameter |
| probes.liveness.periodSeconds | integer | - | Chart configuration parameter |
| probes.liveness.timeoutSeconds | integer | - | Chart configuration parameter |
| probes.liveness.failureThreshold | integer | - | Chart configuration parameter |
| probes.readiness.httpGet.path | string | - | Chart configuration parameter |
| probes.readiness.httpGet.port | any | - | Chart configuration parameter |
| probes.readiness.initialDelaySeconds | integer | - | Chart configuration parameter |
| probes.readiness.periodSeconds | integer | - | Chart configuration parameter |
| probes.readiness.timeoutSeconds | integer | - | Chart configuration parameter |
| probes.readiness.failureThreshold | integer | - | Chart configuration parameter |
| probes.startup.tcpSocket.port | any | - | Chart configuration parameter |
| probes.startup.initialDelaySeconds | integer | - | Chart configuration parameter |
| probes.startup.periodSeconds | integer | - | Chart configuration parameter |
| probes.startup.timeoutSeconds | integer | - | Chart configuration parameter |
| probes.startup.failureThreshold | integer | - | 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 |
Network Policy(3)
| Parameter | Type | Default | Description |
|---|---|---|---|
| networkPolicy.enabled | boolean | - | Chart configuration parameter |
| networkPolicy.ingressFrom | array | - | Chart configuration parameter |
| networkPolicy.egress | array | - | Chart configuration parameter |
Backup(37)
| Parameter | Type | Default | Description |
|---|---|---|---|
| backup.enabled | boolean | - | Chart configuration parameter |
| backup.schedule | string | - | Chart configuration parameter |
| backup.suspend | boolean | - | Chart configuration parameter |
| backup.concurrencyPolicy | string | - | Chart configuration parameter Allowed: AllowForbidReplace |
| backup.successfulJobsHistoryLimit | integer | - | Chart configuration parameter |
| backup.failedJobsHistoryLimit | integer | - | Chart configuration parameter |
| backup.backoffLimit | integer | - | Chart configuration parameter |
| backup.archivePrefix | string | - | Chart configuration parameter |
| backup.images.postgresql | string | - | Chart configuration parameter |
| backup.images.uploader | string | - | Chart configuration parameter |
| backup.resources | object | - | Chart configuration parameter |
| backup.podSecurityContext.fsGroup | integer | - | Chart configuration parameter |
| backup.podSecurityContext.fsGroupChangePolicy | string | - | Chart configuration parameter |
| backup.podSecurityContext.seccompProfile.type | string | - | Chart configuration parameter |
| backup.securityContext.allowPrivilegeEscalation | boolean | - | Chart configuration parameter |
| backup.securityContext.capabilities.drop | array | - | Chart configuration parameter |
| backup.securityContext.readOnlyRootFilesystem | boolean | - | Chart configuration parameter |
| backup.securityContext.runAsNonRoot | boolean | - | Chart configuration parameter |
| backup.securityContext.runAsUser | integer | - | Chart configuration parameter |
| backup.securityContext.runAsGroup | integer | - | Chart configuration parameter |
| backup.s3.endpoint | string | - | Chart configuration parameter |
| backup.s3.bucket | string | - | Chart configuration parameter |
| backup.s3.prefix | string | - | Chart configuration parameter |
| backup.s3.createBucketIfNotExists | boolean | - | Chart configuration parameter |
| backup.s3.existingSecret | string | - | Chart configuration parameter |
| backup.s3.existingSecretAccessKeyKey | string | - | Chart configuration parameter |
| backup.s3.existingSecretSecretKeyKey | string | - | Chart configuration parameter |
| backup.s3.accessKey | string | - | Chart configuration parameter |
| backup.s3.secretKey | string | - | Chart configuration parameter |
| backup.database.host | string | - | Chart configuration parameter |
| backup.database.port | any | - | Chart configuration parameter |
| backup.database.name | string | - | Chart configuration parameter |
| backup.database.username | string | - | Chart configuration parameter |
| backup.database.password | string | - | Chart configuration parameter |
| backup.database.existingSecret | string | - | Chart configuration parameter |
| backup.database.existingSecretPasswordKey | string | - | Chart configuration parameter |
| backup.database.postgresDumpArgs | string | - | Chart configuration parameter |
Pod Security(3)
| Parameter | Type | Default | Description |
|---|---|---|---|
| podSecurityContext.fsGroup | integer | - | Chart configuration parameter |
| podSecurityContext.fsGroupChangePolicy | string | - | Chart configuration parameter |
| podSecurityContext.seccompProfile.type | string | - | Chart configuration parameter |
Container Security(6)
| Parameter | Type | Default | Description |
|---|---|---|---|
| securityContext.allowPrivilegeEscalation | boolean | - | Chart configuration parameter |
| securityContext.capabilities.drop | array | - | Chart configuration parameter |
| securityContext.readOnlyRootFilesystem | boolean | - | Chart configuration parameter |
| securityContext.runAsNonRoot | boolean | - | Chart configuration parameter |
| securityContext.runAsUser | integer | - | Chart configuration parameter |
| securityContext.runAsGroup | integer | - | Chart configuration parameter |
Resources(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| resources | object | - | 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 |
Termination Grace Period Seconds(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| terminationGracePeriodSeconds | integer | - | 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 |
Extra Volumes(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| extraVolumes | array | - | Chart configuration parameter |
Extra Volume Mounts(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| extraVolumeMounts | array | - | Chart configuration parameter |
Extra Manifests(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| extraManifests | array | - | Chart configuration parameter |
Postgresql(9)
| Parameter | Type | Default | Description |
|---|---|---|---|
| postgresql.enabled | boolean | - | Chart configuration parameter |
| postgresql.architecture | string | - | Chart configuration parameter Allowed: standalonereplication |
| postgresql.startupProbe.initialDelaySeconds | integer | - | Chart configuration parameter |
| postgresql.readinessProbe.initialDelaySeconds | integer | - | Chart configuration parameter |
| 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 |
Redis(6)
| 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 |
No schema parameters match your search
Try searching for a different keyword or reset the filter.