IDE integrated remote debugging options (vscode) #76

[kowh-ai]

Following on from okfn/docker-ckan#76

[AyanIanniello]

I think the bash command that worked to launch debugpy for ckan 2.9 needs to be adapted for ckan 2.10 or maybe other part of ckan.
Here is what I did:

(1) exposed a second port 5678 in the DockerFile:

services:
   ckan-dev:
	[...]
	ports:
      	- "0.0.0.0:${CKAN_PORT_HOST}:${CKAN_PORT}"
      	- "0.0.0.0:5678:5678"  # added line

(2) made a copy of the file ckan-docker-base/ckan-2.10/dev/setup/start_ckan_development.sh in ckan-docker/ckan/setup/start_ckan_development.sh and added the lines below to the ckan/Dockerfile.dev which will overwrite the start_ckan_development.sh it pulls from ckan base 2.10.3

COPY ./setup/start_ckan_development.sh ${APP_DIR}/start_ckan_development.sh
RUN chmod +x ${APP_DIR}/start_ckan_development.sh

(3) Updated the ckan-docker/ckan/setup/start_ckan_development.sh with:

pip install debugpy
sudo ckan -EH /usr/bin/python -m debugpy --log-to-stderr --wait-for-client --listen 0.0.0.0:5678 /usr/bin/ckan serve --reload $CKAN_INI

Build and run the docker containers

docker compose -f docker-compose.dev.yml build
docker compose -f docker-compose.dev.yml up

I hit various error from here and tried slight changes (among other things replaced sudo with su command, tried ckan -c run $CKAN_INI instead of serve --reload). but I just don't understand enough ckan to adapt this line.

Will watch this space and hope someone will share how they made it work for them 🙂

[wardi]

@AyanIanniello I've added this feature in ckan/ckan-docker-base#50 and documented it in 275a937
please give it a try and let me know if it's working for you.