Skip to content

Conversation

@DiamondJoseph
Copy link
Contributor

Adds debugpy to the container that is built for deploying services with.

This, along with documenting how to make use of it when deploying with e.g. Kubernetes, will allow for remote debugging of the code, and provide a standard approach to solve #234

@DiamondJoseph
Copy link
Contributor Author

Do we need documentation for configuring a Helm chart/Kubernetes resources, such that the documentation for how to remote debug can be added to it? Or can we defer to the developer guide/ helm create? I don't know how beginner friendly I really need to be to enable people with less experience to get involved here.

@DiamondJoseph DiamondJoseph requested a review from coretl March 18, 2025 17:01
@DiamondJoseph DiamondJoseph marked this pull request as ready for review March 18, 2025 17:01
ENTRYPOINT ["python" "-m"]
# Allows for modifying the ENTRYPOINT for debugging, e.g.
#ENTRYPOINT ["python", "-m", "debugpy", "-m"]
CMD ["{{ repo_name }}", "--version"]{% endif %}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While we're at this, should we remove --version as the default use of the container is far more likely to be "run the cli", not "check the version of the cli"?

Suggested change
CMD ["{{ repo_name }}", "--version"]{% endif %}
CMD ["{{ repo_name }}"]{% endif %}

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I vote to leave the Dockerfile as something that exits successfully and make it obvious how to modify it.

@coretl
Copy link
Contributor

coretl commented Mar 19, 2025

Do we need documentation for configuring a Helm chart/Kubernetes resources, such that the documentation for how to remote debug can be added to it? Or can we defer to the developer guide/ helm create? I don't know how beginner friendly I really need to be to enable people with less experience to get involved here.

I think that depends how DLS specific the guide is. If it can be made generic then it probably belongs in the copier template, but if not then the developer portal is better.

@DiamondJoseph
Copy link
Contributor Author

I am going to test out these new docs by following them along.

@DiamondJoseph
Copy link
Contributor Author

Does not as hoped support hot swapping of code through the debugpy protocols

@DiamondJoseph DiamondJoseph deleted the debugpy branch April 7, 2025 11:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants