-
Notifications
You must be signed in to change notification settings - Fork 140
refactor: docker directory structure #4306
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
base: main
Are you sure you want to change the base?
Conversation
… docs - Add docker/run/docker-compose.yml and docker/run/README.md for runtime configs - Remove legacy docker/Dockerfile, docker/.dockerignore and old docker/make_container.rst - Update documentation to reference new paths: - change include in make_container.rst to docker/build/make_container.rst - update links.rst to point to docker/run/docker-compose.yml
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR reorganizes the docker/ directory to improve maintainability and clarity by separating files based on their purpose: building images, running containers, and testing. The restructuring groups related files into docker/build/, docker/run/, and docker/testing/ subdirectories, updates the docker-compose configuration to be more focused and production-ready, and adds comprehensive documentation through README files in each subdirectory.
Key Changes
- Relocated Docker build files (
Dockerfile,.dockerignore,make_container.rst) todocker/build/ - Moved docker-compose configuration to
docker/run/with simplified service definitions - Enhanced docker-compose.yml with named project, cleaner service profiles, and improved documentation
- Updated all documentation references to reflect new file locations
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docker/run/docker-compose.yml | New docker-compose configuration with external license server support, named project, and cleaner service definitions |
| docker/run/README.md | New documentation explaining usage patterns, available services, profiles, and environment variables |
| docker/make_container.rst | Removed file (moved to docker/build/) |
| docker/docker-compose.yml | Removed file (relocated to docker/run/) |
| docker/Dockerfile | Removed file (relocated to docker/build/) |
| docker/.dockerignore | Removed file (relocated to docker/build/) |
| doc/source/links.rst | Updated link to docker-compose.yml to point to new location |
| doc/source/getting_started/make_container.rst | Updated include path for make_container.rst to new build directory location |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4306 +/- ##
==========================================
+ Coverage 91.31% 91.34% +0.03%
==========================================
Files 193 193
Lines 15742 15742
==========================================
+ Hits 14375 14380 +5
+ Misses 1367 1362 -5 🚀 New features to boost your workflow:
|
|
@pyansys-ci-bot LGTM. |
pyansys-ci-bot
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.

Description
This PR reorganizes the
docker/directory into a cleaner, more maintainable structure by separating files based on their purpose.Changes
New Directory Structure
The
docker/directory has been reorganized into three subdirectories:docker/build/- Contains files for building MAPDL Docker images:Dockerfile.dockerignoremake_container.rst(moved fromdocker/)docker/run/- Contains files for running MAPDL containers:docker-compose.yml(cleaned up to focus on MAPDL/DPF services with external license)README.md(comprehensive usage documentation)docker/testing/- Contains testing-related files (already existed):README.md(new documentation)Key Improvements
docker-compose.ymlfocuses on MAPDL and DPF services with external license serversname: pymapdlto docker-compose.yml for cleaner container namingDocumentation Updates
doc/source/getting_started/make_container.rstto reference new file locationsdoc/source/links.rstwith new docker-compose.yml pathFiles Moved
docker/Dockerfile→docker/build/Dockerfiledocker/.dockerignore→docker/build/.dockerignoredocker/make_container.rst→docker/build/make_container.rstdocker/docker-compose.yml→docker/run/docker-compose.ymlBenefits