From 0076972ab8901fce23c028e2c1044b87f6654564 Mon Sep 17 00:00:00 2001 From: David Trattnig <david@subsquare.at> Date: Mon, 29 Nov 2021 19:02:24 +0100 Subject: [PATCH] Update docs on run targets. --- README.md | 12 +++++++++--- docs/bare-metal-installation.md | 25 ++++++++++++++++++++++--- docs/developer-guide.md | 12 ++++++------ 3 files changed, 37 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 07219f42..5980561f 100644 --- a/README.md +++ b/README.md @@ -90,15 +90,21 @@ If you only want to run the single Engine Docker container, you can do this in a cp config/sample-docker.engine.ini config/engine.docker.ini ``` -You'll need to do a few configurations which are required: +You'll need update a few settings: - The password `db_pass` for the local database holding scheduling information - The app secret `api_tank_secret` for connecting to [AURA Tank](https://gitlab.servus.at/aura/tank) - Also check the `ENV` variables defined in the `run.sh` script. -Now start the engine with: +At the moment production deployment using Docker and Docker Compose is [*work in progress*](https://gitlab.servus.at/aura/meta/-/issues/56). For now, starting Engine in Docker requires you to do a local build first: ```shell - ./run.sh docker:engine + ./run.sh docker:build +``` + +After your build has finished start the Engine with: + +```shell + ./run.sh docker:dev ``` ## Read more diff --git a/docs/bare-metal-installation.md b/docs/bare-metal-installation.md index 343458f9..29a017d6 100644 --- a/docs/bare-metal-installation.md +++ b/docs/bare-metal-installation.md @@ -8,6 +8,7 @@ 1. [Setting up the database](#setting-up-the-database) 3. [Configuration](#configuration) 4. [Running Engine](#running-engine) + 1. [Starting dependencies](#starting-dependencies) 5. [Daemonized Engine](#daemonized-engine) 1. [Running with Systemd](#running-with-systemd) 2. [Running with Supervisor](#running-with-supervisor) @@ -110,13 +111,31 @@ If you have defined a virtual env during the installation step you'll need to ac source python/bin/activate ``` -There's a convencience script `run.sh` to get Engine components started: +There's a convenience script `run.sh` to get Engine components started. ```shell engine$ ./run.sh ``` -Keep in mind you'll also need to start Engine Core separately. +The script executes the *default target*, which is usually `dev` for development environments. + +You can call this target explicitely too: + +```shell +engine$ ./run.sh dev +``` + +Or run Engine in production mode: + +```shell +engine$ ./run.sh prod +``` + +For details on the run script, consult the [AURA CLI documentation](https://gitlab.servus.at/aura/meta/-/blob/master/docs/administration/cli.md). + +### Starting dependencies + +You'll also need to start Engine Core separately. > Note it should not matter in which order you start Engine and Engine Core. @@ -127,7 +146,7 @@ engine-core$ ./run.sh Last but not least, Engine API is the target service to store playlogs, health information and details for the [Studio Clock](https://gitlab.servus.at/aura/dashboard-clock). ```shell -engine-core$ ./run.sh +engine-api$ ./run.sh ``` In order to have the complete Engine experience, other AURA Components are required to be running too. Checkout the [Meta Repository](https://gitlab.servus.at/aura/meta) on how to run for example AURA Web using Docker Compose. diff --git a/docs/developer-guide.md b/docs/developer-guide.md index a2cb20f9..fae38260 100644 --- a/docs/developer-guide.md +++ b/docs/developer-guide.md @@ -37,16 +37,10 @@ For a start it's recommended to create a general `aura` project folder. In there There's a convenience script to start all of the three main dependencies (Steering, Dashboard, Tank) all at once: -```bash - ~/code/aura/meta$ ./run.sh aura local -``` - ## Engine Components - *...TBD...* - ## Running for Development Ensure you have following other projects up and running: @@ -165,6 +159,12 @@ Build your own, local Docker image ./run.sh docker:build ``` +Run the locally build image + +```shell +./run.sh docker:dev +``` + Releasing a new version to DockerHub ```shell -- GitLab