Smart District Data Infrastructure (SDDI)
enabled Docker images for
CKAN
Report Bug
·
Request Feature
This repository provides CKAN Docker images for the
sddi-ckan-k8s Helm chart.
The images contain CKAN itself compiled with a set of CKAN extension to add functionality required for
the SDDI concept and beyond that.
All images are available form ghcr.io/tum-gis Github container registry.
See packages for all image flavors and tags.
- 📖 Table of content
- 📥 Image flavor overview
- 🔢 Image versioning
- 🚀 Usage
- 📖 Configuration an documentation
- 🛠️ Contributing
- 🤝 Thanks
- 🛠️ Build images
The CKAN-SDDI Docker images are released in three flavors, that are described below. For each flavor a one package exists in this repository, where the image can be pulled.
docker pull ghcr.io/tum-gis/ckan-sddi-base
docker pull ghcr.io/tum-gis/ckan-sddi
docker pull ghcr.io/tum-gis/ckan-sddi-social
CKAN base image with a minimal set of extensions required for SDDI. Default SDDI groups and topics are preinstalled. This image is used as base image for the other images. If you plan to extend the SDDI images, use this as base image.
ghcr.io/tum-gis/ckan-sddi-base
sddi-base + commonly used CKAN extensions for e.g. extended data format and preview support.
This is the image most people will usually want.
ghcr.io/tum-gis/ckan-sddi
sddi + optional CKAN extension for social media features, that may require staff
for moderation of social media content.
ghcr.io/tum-gis/ckan-sddi-social
The images in this repo are versioned and tagged according to the
releases of this repository.
The latest tag points to the latest release number. The edge version is built from the
latest commit to the main branch of this repo.
The CKAN and CKAN extension versions used for each image are listed in the table below.
For development and debugging we provide a debug version for each image version.
These images are indicated by the -debug suffix on the image tag, e.g. latest-debug or 0.0.6-debug.
The debug images have the FLASK debug toolbar enabled and all required debugging dependencies installed.
Read more on CKAN's debug mode in the
official docs.
Debug images are available starting from v0.0.6.
Warning: The debug image versions should not be used in a production environment! With debug mode enabled, a visitor to your site could execute malicious commands.
All available tags are listed in the packages of each image:
CKAN version: 2.9.7
CKAN base image: ghcr.io/keitaroinc/ckan:2.9.7-focal
The CKAN catalog platform uses several extensions to provide the functionality needed for the SDDI concept. The table below lists the included extensions with the currently used version. Depending of the version of the upstream repository of the individual extensions, the version refers either to a release version or commit hash.
To ensure stable versioning for the images, the versions in the Dockerfiles
are alway pinned to a stable release number or commit hash.
Note: Version pinning is only applied for release versions. The
edgeimage may depend on upstream branches instead.
| Extension | Version | sddi-base |
sddi |
sddi-social |
Description |
|---|---|---|---|---|---|
scheming |
0dda2be |
✔️ | ✔️ | ✔️ | Configure and share CKAN dataset metadata forms. |
hierarchy |
v1.2.0 |
✔️ | ✔️ | ✔️ | Allows to organize organizations and groups in a hierarchy tree (nested groups/orgs). |
grouphierarchysddi |
63289a8 |
✔️ | ✔️ | ✔️ | Extends hierarchy with pre-defined groups and topics of the SDDI concept. |
relation |
1.0.0 |
✔️ | ✔️ | ✔️ | Enables to create and visualize different types of relations (realated_to, depends_on, part_of) between catalog entries. |
spatial |
v2.0.0 |
✔️ | ✔️ | ✔️ | Provides the ability to search for datasets according to a given spatial extent. |
datesearch |
a01061a |
✔️ | ✔️ | ✔️ | Provides the ability to search for datasets according to a given time frame. The search includes all datasets, in which the time of validity overlaps in at least one second with the search time frame. |
repeating |
f09ed71 |
✔️ | ✔️ | ✔️ | This extension provides a way to store repeating fields in CKAN datasets, resources, organizations and groups. |
composite |
1e6d7bb |
✔️ | ✔️ | ✔️ | The extension allows to store structured dataset metadata, single or multiple fields. Only one level of subfields is possible. The subfields can be basic text, date type or dropboxes. |
restricted |
02e7e14 |
✔️ | ✔️ | CKAN extension to restrict the accessibility to the resources of a dataset. This way the package metadata is accesible but not the data itself (resource). The resource access restriction level can be individualy defined for every package. | |
dcat |
v1.4.0 |
✔️ | ✔️ | Allow CKAN to expose and consume metadata from other catalogs using RDF documents serialized using DCAT. | |
geoview |
v0.0.20 |
✔️ | ✔️ | This extension contains view plugins to display geospatial files and services in CKAN. | |
disqus |
✔️ | The Disqus extension allows site visitors to comment on individual packages using an AJAX-based commenting system. The downsides of this plugin are that comments are not stored locally and user information is not shared between CKAN and the commenting system. |
The images provided in this repo are designed for the
sddi-ckan-k8s Helm chart. Go to the Helm chart repository
to find examples an how to run the images.
The configuration of the Docker images is mainly done using environment variables using the
naming convention of ckanext-envvars.
Refer to the documentation of ckan
and the extensions listed below to find the available configuration options.
Bug fixes, issue reports and contributions are greatly appreciated.
- This repo is based on the CKAN Docker images of Keitaro. Many thank's for your great work!
- Switch to the image folder, e.g.
cd sddi-base - Run
./build.shto the image. Run./build.sh 2.9.7to build* using a specific CKAN version. - Use
./build-push.shto build and push the image.