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

add docker+CWL best practices #375

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

Mackenzie-OO7
Copy link
Contributor

Copy link

@acoleman2000 acoleman2000 left a comment

Choose a reason for hiding this comment

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

I think these changes are essentially okay, and mostly seem to paraphrase things in Peter's Docker tutorial. My main question is how did you decide which stuff to include/which stuff to leave out (e.g., leaving out stuff like tagging your builds)? Maybe we want to include reference link to resources like Peter's Docker training for those who want to get even more detail for some of the stuff left out (https://doc.arvados.org/rnaseq-cwl-training/08-supplement-docker/index.html).


- When creating a Dockerfile, it is important to specify the exact version of the software you want to install and the base image you want to use. This helps ensure that your Docker image builds are consistent and reproducible. Additionally, when using the `FROM` command, specify a tag for the base image, otherwise it will default to "latest" which can change at any time.

- To ensure that the user specified in the Dockerfile is actually used to run the tool, it is best to avoid using the `USER` instruction in the Dockerfile. This is because cwltool will override the `USER` instruction and match the user instead, which means that the user specified in the `USER` instruction may not be the user that is actually used to run the tool.

Choose a reason for hiding this comment

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

--no-match-user cwltool flag disables passing the current uid to docker run --user, so it might be useful to mention.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

My main question is how did you decide which stuff to include/which stuff to leave out (e.g., leaving out stuff like tagging your builds)? Maybe we want to include reference link to resources like Peter's Docker training for those who want to get even more detail for some of the stuff left out (https://doc.arvados.org/rnaseq-cwl-training/08-supplement-docker/index.html).

I think I missed that one 😅
Thanks for reviewing! I'll make corrections.

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.

None yet

2 participants