Skip to content

Build Deployment_Documentation

Jump to bottom
Ashutosh Singh edited this page Jul 7, 2021 · 7 revisions

NOTE: Make sure you have already cloned original emba repository in the emba directory

NOTE: If you are using docker desktop on a Mac or windows machine. Remove line network_mode: host from docker-compose.yml

NOTE: If you are using docker desktop windows machine. The database host inside env would be host.docker.internal

NOTE: For now our compose file is compatible with docker-compose version 1.27.x. 1.28.x and 1.29.x are already available and by default you will end up with latest version unless you specify explicitly while installing. Please install version1.27.x untill we fix this

Initial Setup

  1. Change directory to root of the repository i.e amos-ss2021-emba-service
  2. Clone original emba repository (git clone https://github.com/e-m-b-a/emba.git)
  3. Run ./emba/installer.sh -F to force install all the dependencies on host. This enables functionalities like CVE Search.
  4. Setup docker containers(See below)

Updating environment variables

Refer to template.env, you will see the following env variables

1. DATABASE_NAME: Name of the sql database
2. DATABASE_USER: User of the database
3. DATABASE_PASSWORD: For for logging in to the database
4. DATABASE_HOST: host of the database
5. DATABASE_PORT: port
6. MYSQL_ROOT_PASSWORD: Root password. Always equal to DATABASE_PASSWORD for our dev setups
7. MYSQL_DATABASE: Database that gets created on MySql Container startup. Same as DATABASE_NAME
8. REDIS_HOST: Host of Redis DB
9. REDIS_PORT: Port of Redis DB

We are not maintaining a central copy for now. Till then please main your own copy wherever you setup your dev environment.

Building and running containers

  1. Build your image
    docker-compose build

  2. Before bringing your containers up rename template.env -> .env and edit .env file should to look like:

DATABASE_NAME=<Name you are going to give your db>
DATABASE_USER=root
DATABASE_PASSWORD=<value of MYSQL_ROOT_PASSWORD>
DATABASE_HOST=0.0.0.0(or host.docker.internal for windows)
DATABASE_PORT=3306
MYSQL_ROOT_PASSWORD=<This should be set>
MYSQL_DATABASE =<Same as DATABASE_NAME> 
REDIS_HOST=0.0.0.0(or host.docker.internal for windows)
REDIS_HOST=6379

  1. Bring your containers up
    docker-compose up -d

  2. Restart your emba container. Since there is no explicit dependency between containers declared in docker-compose file, you might need to restart your emba container.
    docker-compose restart emba

  3. How to exec into your emba-django container
    docker exec -it amos-ss2021-emba-service_emba_1 bash

Testing Django setup

Test if django application (uWSGI workers) came up
curl -XGET 'http://0.0.0.0:8000'
You should get a response like this:

<!DOCTYPE html>
<html>
<head>
    <title></title>
</head>
<body>
    <h1>EMBArk home!</h1>
</body>

Updating code

Whenever you change any code in embark(django project). You will have to make it live. Since all our code is mounted through compose. Developers just need to run the following command -
docker-compose restart emba

Exec inside the containers

If you want to run something from inside the container like a shell script to analyze some firmware

  1. Paste that firmware inside directory embark
  2. Exec(Enter) into your container with docker exec -it amos-ss2021-emba-service_emba_1 bash
  3. Run your script.
Clone this wiki locally