Skip to content
Ckan icon
v1.4.2App: v2.12.0Pinned DigestS3 Backup Ready

Production Helm chart • Apache-2.0 • Zero-Root • Verified on Kubernetes v1.33-v1.36+

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)
Official Schema

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.

View Values Schema

|-----|---------|-------------| | 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 Synced

Verified 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)]
Official Contractvalues.schema.json

Ckan Values Schema Reference

Official schema parameters, default values, and types extracted directly from the chart repository.

196 parametersValues Studio

Global(1)

ParameterTypeDefaultDescription
globalobject-Chart configuration parameter

Name Override(1)

ParameterTypeDefaultDescription
nameOverridestring-Chart configuration parameter

Fullname Override(1)

ParameterTypeDefaultDescription
fullnameOverridestring-Chart configuration parameter

Common Labels(1)

ParameterTypeDefaultDescription
commonLabelsobject-Chart configuration parameter

Image(3)

ParameterTypeDefaultDescription
image.repositorystring-Chart configuration parameter
image.tagstring-Chart configuration parameter
image.pullPolicystring-Chart configuration parameter
Allowed:AlwaysIfNotPresentNever

Image Pull Secrets(1)

ParameterTypeDefaultDescription
imagePullSecretsarray-Chart configuration parameter

Ckan(17)

ParameterTypeDefaultDescription
ckan.containerPortinteger-Chart configuration parameter
ckan.uwsgiProcessesinteger-Chart configuration parameter
ckan.uwsgiHarakiriinteger-Chart configuration parameter
ckan.siteUrlstring-Chart configuration parameter
ckan.siteTitlestring-Chart configuration parameter
ckan.sysadminNamestring-Chart configuration parameter
ckan.sysadminEmailstring-Chart configuration parameter
ckan.sysadminPasswordstring-Chart configuration parameter
ckan.existingSecretstring-Chart configuration parameter
ckan.existingSecretPasswordKeystring-Chart configuration parameter
ckan.existingSecretSessionKeystring-Chart configuration parameter
ckan.existingSecretJwtKeystring-Chart configuration parameter
ckan.sessionSecretstring-Chart configuration parameter
ckan.jwtSecretstring-Chart configuration parameter
ckan.pluginsstring-Chart configuration parameter
ckan.replicaCountinteger-Chart configuration parameter
ckan.extraEnvarray-Chart configuration parameter

Datapusher(18)

ParameterTypeDefaultDescription
datapusher.enabledboolean-Chart configuration parameter
datapusher.image.repositorystring-Chart configuration parameter
datapusher.image.tagstring-Chart configuration parameter
datapusher.image.pullPolicystring-Chart configuration parameter
Allowed:AlwaysIfNotPresentNever
datapusher.replicaCountinteger-Chart configuration parameter
datapusher.portinteger-Chart configuration parameter
datapusher.resourcesobject-Chart configuration parameter
datapusher.podSecurityContext.fsGroupinteger-Chart configuration parameter
datapusher.podSecurityContext.fsGroupChangePolicystring-Chart configuration parameter
datapusher.podSecurityContext.seccompProfile.typestring-Chart configuration parameter
datapusher.securityContext.allowPrivilegeEscalationboolean-Chart configuration parameter
datapusher.securityContext.capabilities.droparray-Chart configuration parameter
datapusher.securityContext.readOnlyRootFilesystemboolean-Chart configuration parameter
datapusher.securityContext.runAsNonRootboolean-Chart configuration parameter
datapusher.securityContext.runAsUserinteger-Chart configuration parameter
datapusher.securityContext.runAsGroupinteger-Chart configuration parameter
datapusher.podLabelsobject-Chart configuration parameter
datapusher.podAnnotationsobject-Chart configuration parameter

Solr(20)

ParameterTypeDefaultDescription
solr.enabledboolean-Chart configuration parameter
solr.image.repositorystring-Chart configuration parameter
solr.image.tagstring-Chart configuration parameter
solr.image.pullPolicystring-Chart configuration parameter
Allowed:AlwaysIfNotPresentNever
solr.portinteger-Chart configuration parameter
solr.persistence.enabledboolean-Chart configuration parameter
solr.persistence.sizestring-Chart configuration parameter
solr.persistence.storageClassstring-Chart configuration parameter
solr.persistence.accessModesarray-Chart configuration parameter
solr.resourcesobject-Chart configuration parameter
solr.podSecurityContext.fsGroupinteger-Chart configuration parameter
solr.podSecurityContext.fsGroupChangePolicystring-Chart configuration parameter
solr.podSecurityContext.seccompProfile.typestring-Chart configuration parameter
solr.securityContext.allowPrivilegeEscalationboolean-Chart configuration parameter
solr.securityContext.capabilities.droparray-Chart configuration parameter
solr.securityContext.readOnlyRootFilesystemboolean-Chart configuration parameter
solr.securityContext.runAsNonRootboolean-Chart configuration parameter
solr.securityContext.runAsUserinteger-Chart configuration parameter
solr.securityContext.runAsGroupinteger-Chart configuration parameter
solr.externalUrlstring-Chart configuration parameter

Database(13)

ParameterTypeDefaultDescription
database.modestring-Chart configuration parameter
Allowed:subchartexternal
database.external.hoststring-Chart configuration parameter
database.external.portinteger-Chart configuration parameter
database.external.ckanDatabasestring-Chart configuration parameter
database.external.datastoreDatabasestring-Chart configuration parameter
database.external.usernamestring-Chart configuration parameter
database.external.passwordstring-Chart configuration parameter
database.external.datastoreReadUsernamestring-Chart configuration parameter
database.external.datastoreReadPasswordstring-Chart configuration parameter
database.external.existingSecretstring-Chart configuration parameter
database.external.existingSecretPasswordKeystring-Chart configuration parameter
database.external.existingSecretDatastoreReadPasswordKeystring-Chart configuration parameter
database.external.sslModestring-Chart configuration parameter
Allowed:disableallowpreferrequireverify-caverify-full

Redis Config(10)

ParameterTypeDefaultDescription
redisConfig.modestring-Chart configuration parameter
Allowed:subchartexternal
redisConfig.external.hoststring-Chart configuration parameter
redisConfig.external.portinteger-Chart configuration parameter
redisConfig.external.databaseinteger-Chart configuration parameter
redisConfig.external.tlsboolean-Chart configuration parameter
redisConfig.external.sslCertReqsstring-Chart configuration parameter
Allowed:requiredoptionalnone
redisConfig.external.sslCaCertsstring-Chart configuration parameter
redisConfig.external.passwordstring-Chart configuration parameter
redisConfig.external.existingSecretstring-Chart configuration parameter
redisConfig.external.existingSecretPasswordKeystring-Chart configuration parameter

Persistence(5)

ParameterTypeDefaultDescription
persistence.enabledboolean-Chart configuration parameter
persistence.sizestring-Chart configuration parameter
persistence.storageClassstring-Chart configuration parameter
persistence.accessModesarray-Chart configuration parameter
persistence.existingClaimstring-Chart configuration parameter

Service & Networking(3)

ParameterTypeDefaultDescription
service.typestring-Chart configuration parameter
Allowed:ClusterIPNodePortLoadBalancer
service.portinteger-Chart configuration parameter
service.annotationsobject-Chart configuration parameter

Ingress(5)

ParameterTypeDefaultDescription
ingress.enabledboolean-Chart configuration parameter
ingress.ingressClassNamestring-Chart configuration parameter
ingress.annotationsobject-Chart configuration parameter
ingress.hostsarray-Chart configuration parameter
ingress.tlsarray-Chart configuration parameter

Health Probes(17)

ParameterTypeDefaultDescription
probes.liveness.httpGet.pathstring-Chart configuration parameter
probes.liveness.httpGet.portany-Chart configuration parameter
probes.liveness.initialDelaySecondsinteger-Chart configuration parameter
probes.liveness.periodSecondsinteger-Chart configuration parameter
probes.liveness.timeoutSecondsinteger-Chart configuration parameter
probes.liveness.failureThresholdinteger-Chart configuration parameter
probes.readiness.httpGet.pathstring-Chart configuration parameter
probes.readiness.httpGet.portany-Chart configuration parameter
probes.readiness.initialDelaySecondsinteger-Chart configuration parameter
probes.readiness.periodSecondsinteger-Chart configuration parameter
probes.readiness.timeoutSecondsinteger-Chart configuration parameter
probes.readiness.failureThresholdinteger-Chart configuration parameter
probes.startup.tcpSocket.portany-Chart configuration parameter
probes.startup.initialDelaySecondsinteger-Chart configuration parameter
probes.startup.periodSecondsinteger-Chart configuration parameter
probes.startup.timeoutSecondsinteger-Chart configuration parameter
probes.startup.failureThresholdinteger-Chart configuration parameter

Service Account(4)

ParameterTypeDefaultDescription
serviceAccount.createboolean-Chart configuration parameter
serviceAccount.namestring-Chart configuration parameter
serviceAccount.annotationsobject-Chart configuration parameter
serviceAccount.automountServiceAccountTokenboolean-Chart configuration parameter

Network Policy(3)

ParameterTypeDefaultDescription
networkPolicy.enabledboolean-Chart configuration parameter
networkPolicy.ingressFromarray-Chart configuration parameter
networkPolicy.egressarray-Chart configuration parameter

Backup(37)

ParameterTypeDefaultDescription
backup.enabledboolean-Chart configuration parameter
backup.schedulestring-Chart configuration parameter
backup.suspendboolean-Chart configuration parameter
backup.concurrencyPolicystring-Chart configuration parameter
Allowed:AllowForbidReplace
backup.successfulJobsHistoryLimitinteger-Chart configuration parameter
backup.failedJobsHistoryLimitinteger-Chart configuration parameter
backup.backoffLimitinteger-Chart configuration parameter
backup.archivePrefixstring-Chart configuration parameter
backup.images.postgresqlstring-Chart configuration parameter
backup.images.uploaderstring-Chart configuration parameter
backup.resourcesobject-Chart configuration parameter
backup.podSecurityContext.fsGroupinteger-Chart configuration parameter
backup.podSecurityContext.fsGroupChangePolicystring-Chart configuration parameter
backup.podSecurityContext.seccompProfile.typestring-Chart configuration parameter
backup.securityContext.allowPrivilegeEscalationboolean-Chart configuration parameter
backup.securityContext.capabilities.droparray-Chart configuration parameter
backup.securityContext.readOnlyRootFilesystemboolean-Chart configuration parameter
backup.securityContext.runAsNonRootboolean-Chart configuration parameter
backup.securityContext.runAsUserinteger-Chart configuration parameter
backup.securityContext.runAsGroupinteger-Chart configuration parameter
backup.s3.endpointstring-Chart configuration parameter
backup.s3.bucketstring-Chart configuration parameter
backup.s3.prefixstring-Chart configuration parameter
backup.s3.createBucketIfNotExistsboolean-Chart configuration parameter
backup.s3.existingSecretstring-Chart configuration parameter
backup.s3.existingSecretAccessKeyKeystring-Chart configuration parameter
backup.s3.existingSecretSecretKeyKeystring-Chart configuration parameter
backup.s3.accessKeystring-Chart configuration parameter
backup.s3.secretKeystring-Chart configuration parameter
backup.database.hoststring-Chart configuration parameter
backup.database.portany-Chart configuration parameter
backup.database.namestring-Chart configuration parameter
backup.database.usernamestring-Chart configuration parameter
backup.database.passwordstring-Chart configuration parameter
backup.database.existingSecretstring-Chart configuration parameter
backup.database.existingSecretPasswordKeystring-Chart configuration parameter
backup.database.postgresDumpArgsstring-Chart configuration parameter

Pod Security(3)

ParameterTypeDefaultDescription
podSecurityContext.fsGroupinteger-Chart configuration parameter
podSecurityContext.fsGroupChangePolicystring-Chart configuration parameter
podSecurityContext.seccompProfile.typestring-Chart configuration parameter

Container Security(6)

ParameterTypeDefaultDescription
securityContext.allowPrivilegeEscalationboolean-Chart configuration parameter
securityContext.capabilities.droparray-Chart configuration parameter
securityContext.readOnlyRootFilesystemboolean-Chart configuration parameter
securityContext.runAsNonRootboolean-Chart configuration parameter
securityContext.runAsUserinteger-Chart configuration parameter
securityContext.runAsGroupinteger-Chart configuration parameter

Resources(1)

ParameterTypeDefaultDescription
resourcesobject-Chart configuration parameter

Node Selector(1)

ParameterTypeDefaultDescription
nodeSelectorobject-Chart configuration parameter

Tolerations(1)

ParameterTypeDefaultDescription
tolerationsarray-Chart configuration parameter

Affinity(1)

ParameterTypeDefaultDescription
affinityobject-Chart configuration parameter

Topology Spread Constraints(1)

ParameterTypeDefaultDescription
topologySpreadConstraintsarray-Chart configuration parameter

Priority Class Name(1)

ParameterTypeDefaultDescription
priorityClassNamestring-Chart configuration parameter

Termination Grace Period Seconds(1)

ParameterTypeDefaultDescription
terminationGracePeriodSecondsinteger-Chart configuration parameter

Pod Labels(1)

ParameterTypeDefaultDescription
podLabelsobject-Chart configuration parameter

Pod Annotations(1)

ParameterTypeDefaultDescription
podAnnotationsobject-Chart configuration parameter

Extra Volumes(1)

ParameterTypeDefaultDescription
extraVolumesarray-Chart configuration parameter

Extra Volume Mounts(1)

ParameterTypeDefaultDescription
extraVolumeMountsarray-Chart configuration parameter

Extra Manifests(1)

ParameterTypeDefaultDescription
extraManifestsarray-Chart configuration parameter

Postgresql(9)

ParameterTypeDefaultDescription
postgresql.enabledboolean-Chart configuration parameter
postgresql.architecturestring-Chart configuration parameter
Allowed:standalonereplication
postgresql.startupProbe.initialDelaySecondsinteger-Chart configuration parameter
postgresql.readinessProbe.initialDelaySecondsinteger-Chart configuration parameter
postgresql.auth.databasestring-Chart configuration parameter
postgresql.auth.usernamestring-Chart configuration parameter
postgresql.auth.passwordstring-Chart configuration parameter
postgresql.auth.existingSecretstring-Chart configuration parameter
postgresql.auth.existingSecretUserPasswordKeystring-Chart configuration parameter

Redis(6)

ParameterTypeDefaultDescription
redis.enabledboolean-Chart configuration parameter
redis.architecturestring-Chart configuration parameter
Allowed:standalonereplication
redis.auth.enabledboolean-Chart configuration parameter
redis.auth.passwordstring-Chart configuration parameter
redis.auth.existingSecretstring-Chart configuration parameter
redis.auth.existingSecretPasswordKeystring-Chart configuration parameter