Browse Source

documentations

aguryev 3 years ago
parent
commit
3764499dcd
3 changed files with 34 additions and 2 deletions
  1. 32 0
      Readme.md
  2. 1 1
      start_mysql_container.sh
  3. 1 1
      ui/Readme.md

+ 32 - 0
Readme.md

@@ -53,3 +53,35 @@ For example, to use existing *BAANGT* images and run *BAANGT UI Web-Service* on
 To stop all *BAANGT* containers use:
 
 	./run_services_in_docker.sh stop
+
+**NOTE:**  
+The described above method launches **BAANGT Services** with the following databases:
+- *BAANGT* Testrun definitions in the default location `sqlite:///testrun.db` (within docker container `baangt-ui`)
+- *BAANGT* Testrun results in the docker container `postgres`
+
+### Other options
+#### Run BAANGT Services with MySQL
+Alternatively, you may start docker container with **two** MySQL databases (`definition` for *BAANGT* Testrun definitions *and* `execution` for *BAANGT* Testrun results) by executing
+
+	./start_mysql_container.sh
+
+with optional parameter that specifies the MySQL running port.  
+Wait until the status of the `mysql` container will be *healthly*: see *STATUS* under `docker ps`
+```
+$ docker ps
+CONTAINER ID        IMAGE                 COMMAND                  CREATED             STATUS                    PORTS                               NAMES
+8bb944f3de6b        mysql-baangt:latest   "/entrypoint.sh mysq…"   25 minutes ago      Up 24 minutes (healthy)   33060/tcp, 0.0.0.0:3305->3306/tcp   mysql
+```
+Then execute
+
+	./run_services_with_mysql.sh
+
+to launch the other needed containers.
+
+#### Run BAANGT Services with Permanent Databases
+For the long-term testing you may want to use permanent databases (local or permanent docker containers -- without attribute `--rm`). To achieve that just adjust the values of the environmental variables `DATABASE_URL` in a `run_services...sh` script
+```
+docker run -d --name rq-worker... -e DATABASE_URL=<url_of_baangt_testrun_RESULTS_database>...
+docker run -d --name baangt-api... -e DATABASE_URL=<url_of_baangt_testrun_RESULTS_database>...
+docker run -d --name baangt-ui... -e DATABASE_URL=<url_of_baangt_testrun_DEFINITIONS_database>...
+```

+ 1 - 1
start_mysql_container.sh

@@ -23,4 +23,4 @@ docker build -t mysql-baangt:latest mysql
 # running docker container
 echo
 echo Starting MySQL container...
-docker run --name mysql2 -p ${port}:3306 -d -e MYSQL_RANDOM_ROOT_PASSWORD=yes --rm mysql-baangt:latest
+docker run --name mysql -p ${port}:3306 -d -e MYSQL_RANDOM_ROOT_PASSWORD=yes --rm mysql-baangt:latest

+ 1 - 1
ui/Readme.md

@@ -47,8 +47,8 @@ To benefit subclasses that was installed in [**BAANGT Execution API**](https://g
 ```JSON
 {
 	"classnames": {
+		"plugin.baangt-subclassingDemo.myTestCaseSequence": "Demo subclass cloned from https://gogs.earthsquad.global/athos/baangt-subclassingDemo",
 		...
-		"plugin.baangt-subclassingDemo.myTestCaseSequence": "Demo subclass cloned from https://gogs.earthsquad.global/athos/baangt-subclassingDemo"
 	},
 	...
 }