Skip to content
This repository has been archived by the owner on Dec 14, 2023. It is now read-only.

Latest commit

 

History

History
67 lines (41 loc) · 2.89 KB

requirements.markdown

File metadata and controls

67 lines (41 loc) · 2.89 KB
Raw

Requirements

Host machine requirements

  • Ubuntu 20.04+, macOS, or Windows (the latter is untested and might not work at all).

    Media Cloud is tested on works on Ubuntu 20.04. Older Ubuntu versions, e.g. 16.04, might also work but you will most likely encounter various caching discrepancies due to an older Linux kernel version used by 16.04.

    Other Linux distributions, e.g. CentOS, should work fine but running Media Cloud on them is not supported. Windows hosts should technically work as well, but you're absolutely at your own here.

  • Docker 19.03.4.

    For the sake of your own sanity, make sure that you're running the same version of Docker as in production and testing environments. At the time of writing, said environments run Docker 19.03.4.

    • To install a specific version of Docker on Ubuntu, refer to the installation instructions or just use our Ansible playbook which makes sure to install and hold docker-ce package at version 19.03.4:

      cd provision/
ansible-playbook --inventory='localhost,' --connection=local --tags docker setup.yml

    • To install a specific version of Docker on macOS, download and install Docker Desktop for Mac build 39773 which ships with Docker 19.03.4.

    • To install a specific version of Docker on Windows, download and install Docker Desktop for Windows build 31259 which ships with Docker 19.03.2.

  • Docker Compose.

    On macOS and Windows, Docker Compose will come preinstalled together with Docker Desktop. On Ubuntu, you might want to install it separately using one of the supported methods. Probably the easiest method is to just install it with Pip:

    $ pip3 install docker-compose

  • Python 3.5+.

    Docker Compose and developer scripts are written in Python and require version 3.5 and up.

Development machine requirements

If you're going to develop and test Media Cloud on your machine, you'll need to install a few more requirements:

  • PyYAML Python module.

    Developer script run.py validates YAML present in docker-compose.tests.yml used for testing, so you will need to install PyYAML on your host machine. You can do that with Pip:

    $ pip3 install PyYAML

  • parallel utility.

    Developer scripts don't bother with parallelization of builds and testing themselves, instead relying on GNU parallel to run commands in parallel for them. Install the utility on Ubuntu:

    $ apt-get -y install parallel

    or macOS:

    $ brew install parallel

  • Submodules.

    $ git submodule update --init --recursive