gitea/ckan
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

more doco/log updates

Browse Source
This commit is contained in:
Brett 2022-07-18 16:57:28 +02:00
parent 7ce4d322ab
commit 959e73d3ee
3 changed files with 31 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
README.md
View File

@ -74,7 +74,6 @@ The Docker images used to build your CKAN project are located in the `ckan/` fol
* `Dockerfile.dev`: this is based on `ckan/ckan-base:<version>-dev` also located located in the DockerHub repository, and extends `ckan/ckan-base:<version>` to include: * `Dockerfile.dev`: this is based on `ckan/ckan-base:<version>-dev` also located located in the DockerHub repository, and extends `ckan/ckan-base:<version>` to include:
* Any extension cloned on the `src` folder will be installed in the derived CKAN container when booting up Docker Compose (`docker-compose up`). This includes installing any requirements listed in a `requirements.txt` (or `pip-requirements.txt`) file and running `python setup.py develop`. * Any extension cloned on the `src` folder will be installed in the derived CKAN container when booting up Docker Compose (`docker-compose up`). This includes installing any requirements listed in a `requirements.txt` (or `pip-requirements.txt`) file and running `python setup.py develop`.
* The CKAN image used will development requirements needed to run the tests .
* CKAN will be started running `ckan -c /srv/app/ckan.ini run`. * CKAN will be started running `ckan -c /srv/app/ckan.ini run`.
* Make sure to add the local plugins to the `CKAN__PLUGINS` env var in the `.env` file. * Make sure to add the local plugins to the `CKAN__PLUGINS` env var in the `.env` file.

31
TODO.livelog.txt Normal file
View File

@ -0,0 +1,31 @@
# (from) July 7 2022
# This repo will be actively worked on from now.
# This file will be a ToDo/bits'n'bobs list of things to take care of
ckan/ckan-docker-base: For the base images Dockerfiles (prod and dev) and related scripts
ckan/ckan-docker: For the project-oriented image template (prod and dev). Patching only done in Dev ### This repo!
All the other images should live in separate repos
1. Solr - use ckan-solr (https://github.com/ckan/ckan-solr)
2. PostgreSQL - use current method (base image: postgres:12-alpine from DockerHub, enhanced in a Dockerfile)
### This may change to be more like Solr though
3. Redis - use current method (DockerHub image: redis:${REDIS_VERSION} specified as a compose service in the compose file)
latest image to used is redis:6
4. nginx - use a late(ish) nginx image from DockerHub, enhanced in a Dockerfile)
5. DataPusher - built from the actual datapusher repo (https://github.com/ckan/datapusher)
6. CKAN - built from the ckan/ckan-base:2.9.5 base image (which is built from the ckan/ckan-docker-base repo). Include a .dev option
7. CKAN Worker - add new (ckan worker) container in the compose setup
Versions 2.9 and 2.10 (when it's out) only. Plan the repo layout for having multiple versions - OKFN could used as an example
NB: Had to update the prerun.py script as it was failing on check_solr_connection
### ToDo (remaining things to think about and/or 'to fix') ###
1. nginx - what caching should I implement?
2. DataPusher - needed to use a custom requirements.txt (see https://github.com/ckan/datapusher/pull/251)
3. Use Multi-Stage images defined in the docker-compose.yml file...for security reasons really.
Also check out https://github.com/ckan/ckan/pull/4635 for Francesco's tests
4. CKAN Worker (maybe)

37
auxilliary stuff (delete before going live)/TODO.LIVE.txt
View File

@ -1,37 +0,0 @@
# (from) July 7 2022
# This repo will be actively worked on from now.
# This file will be my ToDo list of things to take care of
ckan/ckan-docker-base: For the base images Dockerfiles (prod and dev) and related scripts
ckan/ckan-docker: For the project-oriented image template (prod and dev). Patching only done in Dev ### This repo!
All the other images should live in separate repos
1. Solr - use ckan-solr (https://github.com/ckan/ckan-solr)
2. PostgreSQL - use current method (base image: postgres:12-alpine from DockerHub, enhanced in a Dockerfile)
### This may change to be more like Solr though
3. Redis - use current method (DockerHub image: redis:${REDIS_VERSION} specified as a compose service in the compose file)
latest image to used is redis:6
4. nginx - base image: nginx:1.19.8-alpine from DockerHub, enhanced in a Dockerfile)
5. DataPusher - built from the actual datapusher repo (https://github.com/ckan/datapusher)
6. CKAN - built from the ckan/ckan-base:2.9.5 base image (which is built from the ckan/ckan-docker-base repo)
7. CKAN Worker - add new (ckan worker) container in the compose setup
Versions 2.9 and 2.10 (when it's out) only. Plan the repo layout for having multiple versions - OKFN could used as an example
Go through all the new changes in the current repo and use those for the new repo if they make sense
- Francesco's PR https://github.com/ckan/ckan/pull/4635 which is a beauty!
- use FROM ubuntu:focal for ckan
- Health Checks https://github.com/ckan/ckan/pull/6812
- Restarts https://github.com/ckan/ckan/pull/6569
- Make asure ARGs are used if they are added to compose file
- Check out Florian's docs https://github.com/dbca-wa/ckan/blob/dbca2022/doc/maintaining/installing/install-from-docker-compose.rst
- Check out Florian's repo https://github.com/dbca-wa/ckan/tree/dbca2022
- Documentation to be re-done from scratch...anything that could be useful can be mentioned here eg: local storage for ckan.ini
- Had to update the prerun.py script as it was failing on check_solr_connection
ToDo (workarounds to fix)
1. nginx - what caching should I implement?
2. DataPusher - needed to use a custom requirements.txt (see https://github.com/ckan/datapusher/pull/251)