Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Easier docker setup for development environment #1549

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

lullis
Copy link
Contributor

@lullis lullis commented Jan 30, 2025

I couldn't find anything in the documentation indicating how to set up the docker service for development. The Dockerfile is outdated (the second target is setup to run the idp project, but the env variables defined are not matching) and not really reflecting the current tooling used elsewhere. The docker-compose also does not have any mechanism to set an environment file which makes it hard to make changes.

Fixes #1548

Description of the Change

The Dockerfile now is used only to give a container with all the installed dependencies, and the docker-compose is focused on a development workflow, the application code is loaded as a volume, so changes in the code repository are immediately available inside the container. Environment variables that are specific to the development environment are defined in the dockerc-compose file, and environment variables that might be controlled by the developer (e.g, whether to enable or disable OIDC), can be configured through a .env file placed at the root of the project.

Checklist

  • PR only contains one change (considered splitting up PR)
  • unit-test added
  • documentation updated
  • CHANGELOG.md updated (only for user relevant changes)
  • author name in AUTHORS

- Dockerfile now only is concerned with building the container.
  Everything else (volumes, port configuration, environment variables
  for the application) is defined via compose
- Add a sample env file to allow easy configuration of different setups during development.
- Moved dependencies defined on requirements.txt from idp folder into dev dependencies from pyproject
- Added documentation to set up those services with Docker
@lullis lullis requested a review from dopry January 31, 2025 03:34
@lullis lullis changed the title Fix Dockerfile Easier docker setup for development environment Jan 31, 2025
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.

Dockerfile for idp test app not using correct paths
1 participant