Skip to content

Commit

Permalink
UKDSB-319 : Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
@chris-daly
chris-daly committed Dec 10, 2024
1 parent 7bb8875 commit 77b9e0b
Showing 1 changed file with 35 additions and 30 deletions.
65 changes: 35 additions & 30 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,35 +1,41 @@
# Pre-configured CKAN Docker images

This is the repository of the official [Docker images](https://hub.docker.com/r/ckan/ckan-base/) for [CKAN](https://github.com/ckan/ckan/).
This is the repository of the official [Docker images](https://hub.docker.com/r/ckan/ckan-base/)
for [CKAN](https://github.com/ckan/ckan/).

Please raise issues or code contributions at [github:ckan/ckan-docker-base](https://github.com/ckan/ckan-docker-base)

The images will usually be used as a Docker Compose install in conjunction with other Docker images that make up the CKAN platform. The official CKAN Docker install is located here: [ckan-docker](https://github.com/ckan/ckan-docker)

The following CKAN versions are available in base or dev forms. They are distinguished from one another using different Docker image tags:

| CKAN Version | Type | Base image | Docker tag | Notes |
| --- | --- | --- | --- | --- |
| **2.11.x** | **base image** | `python:3.10-slim-bookworm` | `ckan/ckan-base:2.11`, `ckan/ckan-base:2.11.0`, `ckan/ckan-base:2.11-py3.10`, `ckan/ckan-base:2.11.0-py3.10` | |
| **2.11.x** | **dev image** | `python:3.10-slim-bookworm` | `ckan/ckan-dev:2.11`, `ckan/ckan-dev:2.11.0`, `ckan/ckan-dev:2.11-py3.10`, `ckan/ckan-dev:2.11.0-py3.10` | |
| 2.10.x | base image | `python:3.10-slim-bookworm` | `ckan/ckan-base:2.10-py3.10`, `ckan/ckan-base:2.10.5-py3.10` | |
| 2.10.x | dev image | `python:3.10-slim-bookworm` | `ckan/ckan-dev:2.10-py3.10`, `ckan/ckan-dev:2.10.5-py3.10` | |
| 2.10.x | base image | `alpine:3.17` | `ckan/ckan-base:2.10.5`, `ckan/ckan-base:2.10` | :warning: Deprecated. Please use a Python/Debian based image |
| 2.10.x | dev image | `alpine:3.17` | `ckan/ckan-dev:2.10.5`, `ckan/ckan-dev:2.10` | :warning: Deprecated. Please use a Python/Debian based image |
| 2.9.x | base image | `python:3.9-slim-bookworm` | `ckan/ckan-base:2.9-py3.9`, `ckan/ckan-base:2.9.11-py3.9` | |
| 2.9.x | dev image | `python:3.9-slim-bookworm` | `ckan/ckan-dev:2.9-py3.9`, `ckan/ckan-dev:2.9.11-py3.9` | |
| 2.9.x | base image | `alpine:3.15` | `ckan/ckan-base:2.9.11`, `ckan/ckan-base:2.9` | :warning: Deprecated. Please use a Python/Debian based image |
| 2.9.x | dev image | `alpine:3.15` | `ckan/ckan-dev:2.9.11`, `ckan/ckan-dev:2.9` | :warning: Deprecated. Please use a Python/Debian based image |
| master | base image | `python:3.10-slim-bookworm` | `ckan/ckan-base:master`, `ckan/ckan-base:master-py3.10` | Built daily, do not use in production |
| master | dev image | `python:3.10-slim-bookworm` | `ckan/ckan-dev:master`, `ckan/ckan-dev:master-py3.10` | Built daily, do not use in production |

In addition to the Docker tags listed above, there are additional ones published for each of these images [releases](https://github.com/ckan/ckan-docker-base/releases), in the form:

ckan/ckan-base:{major_version}-py{python_version}-{release_name}


Older CKAN versions might be available as [image tags](https://hub.docker.com/r/ckan/ckan-base/tags) but note that these are not supported as per [CKAN's release policy](https://docs.ckan.org/en/latest/maintaining/releases.html#supported-versions).

The images will usually be used as a Docker Compose install in conjunction with other Docker images that make up the
CKAN platform. The official CKAN Docker install is located here: [ckan-docker](https://github.com/ckan/ckan-docker)

The following CKAN versions are available in base or dev forms. They are distinguished from one another using different
Docker image tags:

| CKAN Version | Type | Base image | Docker tag | Notes |
|-----------------|----------------|-----------------------------|--------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------|
| **2.11.x** | **base image** | `python:3.10-slim-bookworm` | `ckan/ckan-base:2.11`, `ckan/ckan-base:2.11.0`, `ckan/ckan-base:2.11-py3.10`, `ckan/ckan-base:2.11.0-py3.10` | |
| **2.11.x** | **dev image** | `python:3.10-slim-bookworm` | `ckan/ckan-dev:2.11`, `ckan/ckan-dev:2.11.0`, `ckan/ckan-dev:2.11-py3.10`, `ckan/ckan-dev:2.11.0-py3.10` | |
| 2.10.x | base image | `python:3.10-slim-bookworm` | `ckan/ckan-base:2.10-py3.10`, `ckan/ckan-base:2.10.5-py3.10` | |
| 2.10.x | dev image | `python:3.10-slim-bookworm` | `ckan/ckan-dev:2.10-py3.10`, `ckan/ckan-dev:2.10.5-py3.10` | |
| 2.10.x | base image | `alpine:3.17` | `ckan/ckan-base:2.10.5`, `ckan/ckan-base:2.10` | :warning: Deprecated. Please use a Python/Debian based image |
| 2.10.x | dev image | `alpine:3.17` | `ckan/ckan-dev:2.10.5`, `ckan/ckan-dev:2.10` | :warning: Deprecated. Please use a Python/Debian based image |
| 2.9.x | base image | `python:3.9-slim-bookworm` | `ckan/ckan-base:2.9-py3.9`, `ckan/ckan-base:2.9.11-py3.9` | |
| 2.9.x | dev image | `python:3.9-slim-bookworm` | `ckan/ckan-dev:2.9-py3.9`, `ckan/ckan-dev:2.9.11-py3.9` | |
| 2.9.x | base image | `alpine:3.15` | `ckan/ckan-base:2.9.11`, `ckan/ckan-base:2.9` | :warning: Deprecated. Please use a Python/Debian based image |
| 2.9.x | dev image | `alpine:3.15` | `ckan/ckan-dev:2.9.11`, `ckan/ckan-dev:2.9` | :warning: Deprecated. Please use a Python/Debian based image |
| master | base image | `python:3.10-slim-bookworm` | `ckan/ckan-base:master`, `ckan/ckan-base:master-py3.10` | Built daily, do not use in production |
| master | dev image | `python:3.10-slim-bookworm` | `ckan/ckan-dev:master`, `ckan/ckan-dev:master-py3.10` | Built daily, do not use in production |
| **ukds-2.11.0** | **base image** | `python:3.12-slim-bookworm` | `ckan/ckan-base:ukds_2.11.0`, `ckan/ckan-base:ukds_2.11.0-py3.12` | |
| **ukds-2.11.0** | **dev image** | `python:3.12-slim-bookworm` | `ckan/ckan-dev:ukds_2.11.0`, `ckan/ckan-dev:ukds_2.11.0-py3.12` | |

In addition to the Docker tags listed above, there are additional ones published for each of these
images [releases](https://github.com/ckan/ckan-docker-base/releases), in the form:

ckan/ckan-base:{major_version}-py{python_version}-{release_name}

Older CKAN versions might be available as [image tags](https://hub.docker.com/r/ckan/ckan-base/tags) but note that these
are not supported as
per [CKAN's release policy](https://docs.ckan.org/en/latest/maintaining/releases.html#supported-versions).

### Repo structure

Expand Down Expand Up @@ -61,7 +67,6 @@ Once the maintainers decide it's time to do a new release, changes should be doc
part of the release notes. Publishing the new release will trigger the actions that push
the images to Docker Hub.


### Building the images locally

The images can be built locally for development and debugging purposes
Expand All @@ -85,11 +90,11 @@ Available actions:
For instance:

```
./build.sh build ukds base
./build.sh build 2.11
./build.sh build master
./build.sh build 2.10 base
./build.sh build 2.9 dev
```


0 comments on commit 77b9e0b

Please sign in to comment.