Welcome to the RTI BioCloud Docker Library! This repository serves as a central location for building and cataloging the Docker images used by RTI's cloud-based bioinformatics toolkit.
The Dockerfiles are organized in the following structure: <tool_name>/<tool_version>/Dockerfile. Each tool has its own directory containing the Dockerfile and related files.
If a software tool does not have a version (e.g., a custom script), use v1.0 for the tool-version folder (e.g., rti_tool/v1.0/Dockerfile). Folder names and tool names should contain only lowercase characters and underscores (not hyphens) should be used to separate words.
Commiting a Dockerfile to this repository will automatically result in the building of a new docker image that is uploaded to Docker Hub. To submit a commit developers should complete the following steps:
- Fork this repository to their account (if not previously done).
- Create a branch for the specific docker you working on.
- Create the necessary directory structure when applicable as described above.
- Create the Dockerfile and appropriate documentation and commit to the branch you created in step 2.
- Create a pull request to merge this with this repository
- Address any comments that come up during the review.
Once a pull request has been received, the repository administrators will review the commit and check for the following items:
Basic Information
- Test the Dockerfile locally by building an image, running a container, and confirming it works as expected while remaining clean and functional.
- Choose a specific base image with a version tag, e.g.,
FROM ubuntu:20.04instead ofFROM ubuntu. - Add comments to describe each Dockerfile step, including complex or non-standard configurations.
- Store scripts, files, and software tools in the
/optdirectory to prevent cluttering the root directory. - Reduce image size by removing tar files after extraction and delete temporary files and caches generated during the build process.
- Ensure sensitive data (e.g., API keys, passwords) is not hardcoded in the Dockerfile.
- Specify a meaningful
ENTRYPOINTorCMDto define how the container should run. - Include minimum LABELs:
-
LABEL maintainer="Your Name <[email protected]>" -
LABEL description="Short description of the purpose of this image" -
LABEL software-website="https://example.com" -
LABEL software-version="1.0" -
LABEL license="https://www.example.com/legal/end-user-software-license-agreement"
-
Committing
- Organize each tool based off of the guide above in the Respository Structure section above.
- Commit changes to a single Dockerfile and its associated files at a time. No multi-directory commits.
- Verify build was successful and that the tool is available on Docker Hub (see the Docker Hub section below).
- Maintain documentation alongside the Dockerfile, describing how to build, run, and use the image.
Each pull request received will be subject to a review process that will confirm that checklist items are addressed. The review process will consist of
- Review Code: Check for syntax errors, coding standards, and best practices.
- Review Documentation: Ensure that comments and READMEs are clear and informative.
- Review Execution: Verify that the Dockerfile builds locally.
If all three of these review stages are satisfactory then the approval will be given to merge the pull request and initiate the build of the docker image.
All Docker images are published on Docker Hub under the RTI BioCloud organization. You can find the repository at https://hub.docker.com/u/rtibiocloud. Each image is tagged using the following format: <tool-version>_<first-6-characters-of-git-hash>.
When adding new Dockerfiles, the GitHub action will automatically build and push the Docker images to Docker Hub. If the corresponding repository does not exist, the push command will create it.
If you have any questions, suggestions, or need assistance, please feel free to reach out to our team:
- Nathan Gaddis ([email protected])
- Jesse Marks ([email protected])
- Bryan Quach ([email protected])