AEP: new docker stack to handle services #39
Conversation
|
Thanks @unkcpz . I have read through the AEP and most of it seems good to me. I have added a commit with some small fixes to readability. This was easier than doing it through suggestions through the PR review interface. Feel free to point out changes that are incorrect so we can fix them. I have one major question I think: I am bit confused on the image names. It seems that the docker files in |
There was a problem hiding this comment.
@sphuber thanks a lot for the correction, two places may change what I want to express initially.
It seems that the docker files in aiida-core are called base and base-with-service. But the names on the docker hub are supposed to be base and aiida-core?
I kept naming the image in ghcr and dockerhub the aiida-core since I thought it was more natural for people who already use the aiidateam/aiida-core image, no?
The base-with-services is directly from aiidalab, I think the name explains what it is. The full seems a bit too far, what if we want to have an image that includes all the developing tools installed in the image? I have no preference for adding aiida- in front. Maybe not be necessary since for the image we already own the aiidateam and aiidalab namespace.
I see one downside of using name without aiida- that is when the image is used as a base image by other people and upload to dockerhub, if they keep using base would make no sense. So what about we name these two aiidateam/aiida-base and aiidateam/aiida-core (If the first point I mention is not important, aiida-full is also an option)?
Since these two were intended to replace aiidalab/base and aiidalab/base-with-services, maybe following the naming convention is self-explained by name thus a good option as well.
009_new_docker_stack_image/readme.md
Outdated
| - Useless to use `jupyter/minimal-notebook` as base image | ||
|
|
||
| The `jupyter/minimal-notebook` will mapping the port and start a jupyter notebook as the main service of the container which for the `aiida-core` user it is useless. | ||
| Due to the switch to `jupyter/minimal-notebook` as the base image, the `aiida-prerequisites` image has become superfluous and they no longer rely on the `aiidateam/aiida-core` image. |
There was a problem hiding this comment.
It was aiidateam/aiida-core image rely on the aiida-prerequisites
There was a problem hiding this comment.
It is indeed worded a bit unclear. With the "they no longer rely" I meant the "they" to refer to the aiidalab organization, which now just uses jupyter/minimal-notebook. Will improve the language a bit
009_new_docker_stack_image/readme.md
Outdated
|
|
||
| 5. Hide `base` and `base-with-services` images from docker hub and ghcr. | ||
| ### Hide `base` and `base-with-services` images from docker hub and ghcr |
There was a problem hiding this comment.
Sorry that I confused you her. This is a 5th point and the goal was to not show base and base-with-services images for aiidalab. In the end, we will have four official maintained images:
aiidateam/baseaiidateam/aiida-coreaiidalab/labaiidalab/full-stack
There was a problem hiding this comment.
This point used to be in the "goals" section, but since it really is more of an action I have moved it to the "Proposed enhancement". The goal is to make the available images more clear, and this is part of the solution, by hiding certain base images that should not be of interest to users.
Is that interpretation correct?
Maybe I can then simply add a sentence to this section that explicitly says that these images will be hidden on docker hub because they should not be useful to users and can simply confuse.
There was a problem hiding this comment.
And once more regarding the naming:
aiidateam/baseaiidateam/aiida-core
When I see that, to me it is not really clear what each image provides. The base image might be problematic, because it is not clear that it is for AiiDA. Note that we currently don't have other projects in aiidateam that provide a Docker image, but that could be in the future, and users might not know. So I think we should prefix it with aiida-. But also when we stick with base and aiida-core, which one contains the services? To me it is not clear.
I think we should definitely prefix with |
|
After discussion during the team meeting, we settled on @unkcpz I will update the AEP, can you take care of updating the PR on |
Sure, I'll update the PR. Thanks for taking care of AEP. |
The current Docker image provided with `aiida-core` depends on `aiida-prerequisites` as a base image. This image is maintained outside of the `aiida-core` repo, making it additional maintenance to keep it up to date when a new `aiida-core` version is released. In addition, the `aiida-prerequisites` image is no longer maintained because the AiiDAlab stack now depends on another base image. Finally, the `aiida-prerequisites` design had shortcomings as to how the required services, PostgreSQL and RabbitMQ, are handled. They had to be started manually and were not cleanly stopped on container shutdown. Here a proposal is submitted to add two Docker images to `aiida-core` that simplifies their maintenance and that improve the usability by properly and automatically handling the services.
sphuber
force-pushed
the
new-docker-stack
branch
from
ad21ad4 to
06511df
Compare
009_new_docker_stack_image/readme.md
Outdated
|
|
||
| 5. Hide `base` and `base-with-services` images from docker hub and ghcr. | ||
| ### Hide `base` and `base-with-services` images from docker hub and ghcr |
There was a problem hiding this comment.
This point used to be in the "goals" section, but since it really is more of an action I have moved it to the "Proposed enhancement". The goal is to make the available images more clear, and this is part of the solution, by hiding certain base images that should not be of interest to users.
Is that interpretation correct?
Maybe I can then simply add a sentence to this section that explicitly says that these images will be hidden on docker hub because they should not be useful to users and can simply confuse.
009_new_docker_stack_image/readme.md
Outdated
|
|
||
| 5. Hide `base` and `base-with-services` images from docker hub and ghcr. | ||
| ### Hide `base` and `base-with-services` images from docker hub and ghcr |
There was a problem hiding this comment.
And once more regarding the naming:
aiidateam/baseaiidateam/aiida-core
When I see that, to me it is not really clear what each image provides. The base image might be problematic, because it is not clear that it is for AiiDA. Note that we currently don't have other projects in aiidateam that provide a Docker image, but that could be in the future, and users might not know. So I think we should prefix it with aiida-. But also when we stick with base and aiida-core, which one contains the services? To me it is not clear.
draftREADME.md