Skip to content

Dockerfiles used for the development and deployment of edx.org

License

Notifications You must be signed in to change notification settings

edx/public-dockerfiles

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 

# Dockerfiles and image publish workflows

Under the [epic](#12) to remove dockerfiles and workflow setup for devstack, dockerfiles were moved to this repository.

## Overview

This repository aims to streamline all the dockerfiles and docker images publishing from a single source. Images for the following services are included in this repo.

  • commerce-coordinator
  • code-jail
  • course-discovery
  • credentials
  • ecommerce
  • edx-analytics-dashboard
  • edx-analytics-data-api
  • edx-exams
  • edx-notes-api
  • edx-platform
  • enterprise-access
  • enterprise-subsidy
  • enterprise-catalog
  • license-manager
  • portal-designer
  • program-intent-engagement
  • registrar
  • xqueue

---

### Locally build the images

We can locally build and test the images. Following steps are to be taken to test the images.

  1. Clone the repository
  2. Build the image using following command <br/> docker build -t <image-name>:<tag> --target <target> -f <path-to-your-dockerfile> . --progress=plain <br/> you can go with your custom tag for testing.
  3. Once the image is built, you can run the container for that image using the following command <br/> docker container run --name <name-for-container> <name-of-image-built>
  4. Once the container runs, you can enter the shell using command <br/> docker exec -it <container-name> <shell-executable>
  5. You can run commands in shell and test if the image is is built correctly and container is running smoothly.

---

### Repository Structure

`plaintext ├── dockerfiles/ │ ├── ida1.Dockerfile │ ├── ida2.Dockerfile │ ├── ... │ └── idaN.Dockerfile ├── workflows/ │ └── push-docker-images.yml ├── README.md └── .gitignore `

--- ### Handling image publish failures In case you receive an email informing you regarding failure to publish the image, please refer to [this document](https://2u-internal.atlassian.net/wiki/spaces/AT/pages/1648787501/Runbook+for+handling+failure+to+publish+docker+image).

--- ### How to Contribute If you wish to contribute to the repository either optimizing workflows or updating dockerfiles, please create an issue against the work you want to take up. Once tested image locally, raise a PR and request review from [arbi-bom team](https://github.com/orgs/openedx/teams/2u-arbi-bom). If you are changing dockerfiles of any particular IDA, it's advisable to get a review from the owner team as well. IDAs ownership and team info can be found at [this sheet](https://docs.google.com/spreadsheets/d/1qpWfbPYLSaE_deaumWSEZfz91CshWd3v3B7xhOk5M4U/view?gid=1990273504#gid=1990273504).

About

Dockerfiles used for the development and deployment of edx.org

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published