Added CI workflow to publish CVAT images

.github/workflows/main.yml

@@ -23,16 +23,16 @@ jobs:
  DJANGO_SU_EMAIL: 'admin@localhost.company'
  DJANGO_SU_PASSWORD: '12qwaszx'
  run: |
- docker-compose -f docker-compose.yml -f docker-compose.ci.yml build
- docker-compose -f docker-compose.yml -f docker-compose.ci.yml run cvat_ci /bin/bash -c 'coverage run -a manage.py test cvat/apps utils/cli && mv .coverage ${CONTAINER_COVERAGE_DATA_DIR}'
- docker-compose -f docker-compose.yml -f docker-compose.ci.yml run cvat_ci /bin/bash -c 'cd cvat-data && npm ci && cd ../cvat-core && npm ci && npm run test && mv ./reports/coverage/lcov.info ${CONTAINER_COVERAGE_DATA_DIR} && chmod a+rwx ${CONTAINER_COVERAGE_DATA_DIR}/lcov.info'
+ docker-compose -f docker-compose.yml -f docker-compose.dev.yml -f docker-compose.ci.yml build
+ docker-compose -f docker-compose.yml -f docker-compose.dev.yml -f docker-compose.ci.yml run cvat_ci /bin/bash -c 'coverage run -a manage.py test cvat/apps utils/cli && mv .coverage ${CONTAINER_COVERAGE_DATA_DIR}'
+ docker-compose -f docker-compose.yml -f docker-compose.dev.yml -f docker-compose.ci.yml run cvat_ci /bin/bash -c 'cd cvat-data && npm ci && cd ../cvat-core && npm ci && npm run test && mv ./reports/coverage/lcov.info ${CONTAINER_COVERAGE_DATA_DIR} && chmod a+rwx ${CONTAINER_COVERAGE_DATA_DIR}/lcov.info'
  docker-compose up -d
  docker exec -i cvat /bin/bash -c "echo \"from django.contrib.auth.models import User; User.objects.create_superuser('${DJANGO_SU_NAME}', '${DJANGO_SU_EMAIL}', '${DJANGO_SU_PASSWORD}')\" | python3 ~/manage.py shell"
  - name: Code instrumentation
  run: |
  npm ci
  npm run coverage
- docker-compose up -d --build
+ docker-compose -f docker-compose.yml -f docker-compose.dev.yml up -d --build
  - name: End-to-end testing
  run: |
  cd ./tests

.github/workflows/publish_docker_images.yml

@@ -0,0 +1,54 @@
+name: Publish Docker images
+on:
+ release:
+ types: [published]
+
+jobs:
+ build_and_push_to_registry:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v2
+ - uses: actions/setup-node@v2
+ with:
+ node-version: 12
+
+ - name: Build images
+ run: |
+ CLAM_AV=yes INSTALL_SOURCES=yes docker-compose -f docker-compose.yml -f docker-compose.dev.yml -f docker-compose.ci.yml build
+
+ - name: Run unit tests
+ env:
+ HOST_COVERAGE_DATA_DIR: ${{ github.workspace }}
+ CONTAINER_COVERAGE_DATA_DIR: '/coverage_data'
+ DJANGO_SU_NAME: 'admin'
+ DJANGO_SU_EMAIL: 'admin@localhost.company'
+ DJANGO_SU_PASSWORD: '12qwaszx'
+ run: |
+ docker-compose -f docker-compose.yml -f docker-compose.dev.yml -f docker-compose.ci.yml run cvat_ci /bin/bash -c 'coverage run -a manage.py test cvat/apps utils/cli'
+ docker-compose -f docker-compose.yml -f docker-compose.dev.yml -f docker-compose.ci.yml run cvat_ci /bin/bash -c 'cd cvat-data && npm ci && cd ../cvat-core && npm ci && npm run test'
+ docker-compose up -d
+ docker exec -i cvat /bin/bash -c "echo \"from django.contrib.auth.models import User; User.objects.create_superuser('${DJANGO_SU_NAME}', '${DJANGO_SU_EMAIL}', '${DJANGO_SU_PASSWORD}')\" | python3 ~/manage.py shell"
+
+ - name: Run end-to-end tests
+ run: |
+ cd ./tests
+ npm ci
+ npx cypress run --headless --browser chrome
+ - name: Login to Docker Hub
+ uses: docker/login-action@v1
+ with:
+ username: ${{ secrets.DOCKERHUB_USERNAME }}
+ password: ${{ secrets.DOCKERHUB_TOKEN }}
+ - name: Push to Docker Hub
+ env:
+ DOCKERHUB_WORKSPACE: 'openvino'
+ SERVER_IMAGE_REPO: 'cvat_server'
+ UI_IMAGE_REPO: 'cvat_ui'
+ run: |
+ docker tag "${DOCKERHUB_WORKSPACE}/${SERVER_IMAGE_REPO}:latest" "${DOCKERHUB_WORKSPACE}/${SERVER_IMAGE_REPO}:${{ github.event.release.tag_name }}"
+ docker push "${DOCKERHUB_WORKSPACE}/${SERVER_IMAGE_REPO}:${{ github.event.release.tag_name }}"
+ docker push "${DOCKERHUB_WORKSPACE}/${SERVER_IMAGE_REPO}:latest"
+
+ docker tag "${DOCKERHUB_WORKSPACE}/${UI_IMAGE_REPO}:latest" "${DOCKERHUB_WORKSPACE}/${UI_IMAGE_REPO}:${{ github.event.release.tag_name }}"
+ docker push "${DOCKERHUB_WORKSPACE}/${UI_IMAGE_REPO}:${{ github.event.release.tag_name }}"
+ docker push "${DOCKERHUB_WORKSPACE}/${UI_IMAGE_REPO}:latest"

.github/workflows/schedule.yml

@@ -18,7 +18,7 @@ jobs:
  DJANGO_SU_PASSWORD: "12qwaszx"
  API_ABOUT_PAGE: "localhost:8080/api/v1/server/about"
  run: |
- docker-compose -f docker-compose.yml -f ./tests/docker-compose.email.yml up -d --build
+ docker-compose -f docker-compose.yml -f docker-compose.dev.yml -f ./tests/docker-compose.email.yml up -d --build
  /bin/bash -c 'while [[ "$(curl -s -o /dev/null -w ''%{http_code}'' ${API_ABOUT_PAGE})" != "401" ]]; do sleep 5; done'
  docker exec -i cvat /bin/bash -c "echo \"from django.contrib.auth.models import User; User.objects.create_superuser('${DJANGO_SU_NAME}', '${DJANGO_SU_EMAIL}', '${DJANGO_SU_PASSWORD}')\" | python3 ~/manage.py shell"
  - name: End-to-end testing

Dockerfile

@@ -34,10 +34,11 @@ RUN curl -sL https://github.com/cisco/openh264/archive/v${OPENH264_VERSION}.tar.
  make -j5 && make install PREFIX=${PREFIX} && make clean
 
 WORKDIR /tmp/ffmpeg
-RUN curl -sLO https://ffmpeg.org/releases/ffmpeg-${FFMPEG_VERSION}.tar.bz2 && \
- tar -jx --strip-components=1 -f ffmpeg-${FFMPEG_VERSION}.tar.bz2 && \
+RUN curl -sL https://ffmpeg.org/releases/ffmpeg-${FFMPEG_VERSION}.tar.bz2 --output - | \
+ tar -jx --strip-components=1 && \
  ./configure --disable-nonfree --disable-gpl --enable-libopenh264 --enable-shared --disable-static --prefix="${PREFIX}" && \
- make -j5 && make install && make distclean
+ make -j5 && make install && make clean && \
+ tar -zcf "/tmp/ffmpeg-$FFMPEG_VERSION.tar.gz" . && mv "/tmp/ffmpeg-$FFMPEG_VERSION.tar.gz" .
 
 # Install requirements
 RUN python3 -m venv /opt/venv
@@ -93,8 +94,17 @@ RUN apt-get update && \
  rm -rf /var/lib/apt/lists/* && \
  echo 'application/wasm wasm' >> /etc/mime.types
 
-ARG CLAM_AV
-ENV CLAM_AV=${CLAM_AV}
+# Add a non-root user
+ENV USER=${USER}
+ENV HOME /home/${USER}
+RUN adduser --shell /bin/bash --disabled-password --gecos "" ${USER} && \
+ if [ -z ${socks_proxy} ]; then \
+ echo export "GIT_SSH_COMMAND=\"ssh -o StrictHostKeyChecking=no -o ConnectTimeout=30\"" >> ${HOME}/.bashrc; \
+ else \
+ echo export "GIT_SSH_COMMAND=\"ssh -o StrictHostKeyChecking=no -o ConnectTimeout=30 -o ProxyCommand='nc -X 5 -x ${socks_proxy} %h %p'\"" >> ${HOME}/.bashrc; \
+ fi
+
+ARG CLAM_AV="no"
 RUN if [ "$CLAM_AV" = "yes" ]; then \
  apt-get update && \
  apt-get --no-install-recommends install -yq \
@@ -106,16 +116,6 @@ RUN if [ "$CLAM_AV" = "yes" ]; then \
  rm -rf /var/lib/apt/lists/*; \
  fi
 
-# Add a non-root user
-ENV USER=${USER}
-ENV HOME /home/${USER}
-RUN adduser --shell /bin/bash --disabled-password --gecos "" ${USER} && \
- if [ -z ${socks_proxy} ]; then \
- echo export "GIT_SSH_COMMAND=\"ssh -o StrictHostKeyChecking=no -o ConnectTimeout=30\"" >> ${HOME}/.bashrc; \
- else \
- echo export "GIT_SSH_COMMAND=\"ssh -o StrictHostKeyChecking=no -o ConnectTimeout=30 -o ProxyCommand='nc -X 5 -x ${socks_proxy} %h %p'\"" >> ${HOME}/.bashrc; \
- fi
-
 ARG INSTALL_SOURCES='no'
 WORKDIR ${HOME}/sources
 RUN if [ "$INSTALL_SOURCES" = "yes" ]; then \
@@ -131,7 +131,7 @@ RUN if [ "$INSTALL_SOURCES" = "yes" ]; then \
  done && \
  rm -rf /var/lib/apt/lists/*; \
  fi
-COPY --from=build-image /tmp/openh264/openh264*.tar.gz /tmp/ffmpeg/ffmpeg*.tar.bz2 ${HOME}/sources/
+COPY --from=build-image /tmp/openh264/openh264*.tar.gz /tmp/ffmpeg/ffmpeg*.tar.gz ${HOME}/sources/
 
 # Copy python virtual enviroment and FFmpeg binaries from build-image
 COPY --from=build-image /opt/venv /opt/venv

Dockerfile.ci

@@ -1,4 +1,4 @@
-FROM cvat/server
+FROM openvino/cvat_server
 
 ENV DJANGO_CONFIGURATION=testing
 USER root

LICENSE

@@ -20,3 +20,11 @@ OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
 OR OTHER DEALINGS IN THE SOFTWARE.
 
+This software uses libraries from the [FFmpeg](https://www.ffmpeg.org) project.
+
+FFmpeg is an open source framework licensed under LGPL and GPL.
+See https://www.ffmpeg.org/legal.html. You are solely responsible
+for determining if your use of FFmpeg requires any
+additional licenses. Intel is not responsible for obtaining any
+such licenses, nor liable for any licensing fees due in
+connection with your use of FFmpeg.

README.md

@@ -91,6 +91,13 @@ Limitations:
 - No more than 10 tasks per user
 - Uploaded data is limited to 500Mb
 
+## Prebuilt Docker images
+
+Prebuilt docker images for CVAT releases are available on Docker Hub:
+
+- [cvat_server](https://hub.docker.com/r/openvino/cvat_server)
+- [cvat_ui](https://hub.docker.com/r/openvino/cvat_ui)
+
 ## REST API
 
 Automatically generated Swagger documentation for Django REST API is
@@ -103,6 +110,15 @@ Swagger documentation is visiable on allowed hostes, Update environement variabl
 
 Code released under the [MIT License](https://opensource.org/licenses/MIT).
 
+This software uses libraries from the [FFmpeg](https://www.ffmpeg.org) project.
+
+FFmpeg is an open source framework licensed under LGPL and GPL.
+See https://www.ffmpeg.org/legal.html. You are solely responsible
+for determining if your use of FFmpeg requires any
+additional licenses. Intel is not responsible for obtaining any
+such licenses, nor liable for any licensing fees due in
+connection with your use of FFmpeg.
+
 ## Questions
 
 CVAT usage related questions or unclear concepts can be posted in our

cvat/apps/documentation/installation.md

@@ -81,18 +81,18 @@ server. Proxy is an advanced topic and it is not covered by the guide.
  cd cvat
  ```
 
-- Build docker images by default. It will take some time to download public
- docker image ubuntu:16.04 and install all necessary ubuntu packages to run
- CVAT server.
+- Run docker containers. It will take some time to download the latest CVAT
+ release and other required images like postgres, redis, etc. from DockerHub and create containers.
 
- ```bash
- docker-compose build
+ ```sh
+ docker-compose up -d
  ```
 
-- Run docker containers. It will take some time to download public docker
- images like postgres:10.3-alpine, redis:4.0.5-alpine and create containers.
+- Alternative: if you want to build the images locally with unreleased changes
+ run the following command. It will take some time to build CVAT images.
 
- ```sh
+ ```bash
+ docker-compose -f docker-compose.yml -f docker-compose.dev.yml build
  docker-compose up -d
  ```
 

docker-compose.ci.yml

@@ -1,3 +1,8 @@
+#
+# Copyright (C) 2018-2020 Intel Corporation
+#
+# SPDX-License-Identifier: MIT
+#
 version: '3.3'
 
 services:

docker-compose.dev.yml

@@ -0,0 +1,31 @@
+#
+# Copyright (C) 2021 Intel Corporation
+#
+# SPDX-License-Identifier: MIT
+#
+version: '3.3'
+
+services:
+ cvat:
+ build:
+ context: .
+ args:
+ http_proxy:
+ https_proxy:
+ no_proxy: nuclio,${no_proxy}
+ socks_proxy:
+ USER: 'django'
+ DJANGO_CONFIGURATION: 'production'
+ TZ: 'Etc/UTC'
+ CLAM_AV:
+ INSTALL_SOURCES:
+
+ cvat_ui:
+ build:
+ context: .
+ args:
+ http_proxy:
+ https_proxy:
+ no_proxy:
+ socks_proxy:
+ dockerfile: Dockerfile.ui

docker-compose.yml

@@ -1,5 +1,5 @@
 #
-# Copyright (C) 2018-2020 Intel Corporation
+# Copyright (C) 2018-2021 Intel Corporation
 #
 # SPDX-License-Identifier: MIT
 #
@@ -32,22 +32,11 @@ services:
 
  cvat:
  container_name: cvat
- image: cvat/server
+ image: openvino/cvat_server
  restart: always
  depends_on:
  - cvat_redis
  - cvat_db
- build:
- context: .
- args:
- http_proxy:
- https_proxy:
- no_proxy: nuclio,${no_proxy}
- socks_proxy:
- USER: 'django'
- DJANGO_CONFIGURATION: 'production'
- TZ: 'Etc/UTC'
- CLAM_AV: 'no'
  environment:
  DJANGO_MODWSGI_EXTRA_ARGS: ''
  ALLOWED_HOSTS: '*'
@@ -61,17 +50,8 @@ services:
 
  cvat_ui:
  container_name: cvat_ui
- image: cvat/ui
+ image: openvino/cvat_ui
  restart: always
- build:
- context: .
- args:
- http_proxy:
- https_proxy:
- no_proxy:
- socks_proxy:
- dockerfile: Dockerfile.ui
-
  networks:
  default:
  aliases: