Healthchecks provided for all context storages

CONTRIBUTING.md

@@ -106,7 +106,7 @@ To execute all tests, including integration with DBs and APIs tests, run
 ```bash
 make test_all
 ```
-for successful execution of this command `Docker` and `docker-compose` are required.
+for successful execution of this command `Docker` and `docker compose` are required.
 
 To make sure that the code satisfies only the style requirements, run
 ```bash
@@ -127,22 +127,22 @@ DFF uses docker images for two purposes:
 The first group can be launched via
 
 ```bash
-docker-compose --profile context_storage up
+docker compose --profile context_storage up
 ```
 
 This will download and run all the databases (`mysql`, `postgres`, `redis`, `mongo`, `ydb`).
 
 The second group can be launched via
 
 ```bash
-docker-compose --profile stats up
+docker compose --profile stats up
 ```
 
 This will download and launch Superset Dashboard, Clickhouse, OpenTelemetry Collector.
 
 To launch both groups run
 ```bash
-docker-compose --profile context_storage --profile stats up
+docker compose --profile context_storage --profile stats up
 ```
 or
 ```bash

docker-compose.yml → compose.yml

@@ -1,5 +1,6 @@
 version: "3.9"
 services:
+
   mysql:
     env_file: [.env_file]
     image: mysql:latest
@@ -10,6 +11,13 @@ services:
       - 3307:3306
     volumes:
       - mysql-data:/var/lib/mysql
+    healthcheck:
+      test: mysql -u $${MYSQL_USERNAME} -p$${MYSQL_PASSWORD} -e "select 1;"
+      interval: 5s
+      timeout: 10s
+      retries: 5
+      start_period: 30s
+
   psql:
     env_file: [.env_file]
     image: postgres:latest
@@ -20,6 +28,13 @@ services:
       - 5432:5432
     volumes:
       - postgres-data:/var/lib/postgresql/data
+    healthcheck:
+      test: psql pg_isready -U $${POSTGRES_USERNAME} -d $${POSTGRES_DB}
+      interval: 5s
+      timeout: 10s
+      retries: 5
+      start_period: 30s
+
   redis:
     env_file: [.env_file]
     image: redis:latest
@@ -31,6 +46,13 @@ services:
       - 6379:6379
     volumes:
       - redis-data:/data
+    healthcheck:
+      test: redis-cli --raw incr ping
+      interval: 5s
+      timeout: 10s
+      retries: 5
+      start_period: 30s
+
   mongo:
     env_file: [.env_file]
     image: mongo:latest
@@ -41,6 +63,13 @@ services:
       - 27017:27017
     volumes:
       - mongo-data:/data/db
+    healthcheck:
+      test: mongosh --norc --quiet --eval 'db.runCommand("ping").ok' localhost:27017/test
+      interval: 5s
+      timeout: 10s
+      retries: 5
+      start_period: 30s
+
   ydb:
     env_file: [.env_file]
     image: cr.yandex/yc/yandex-docker-local-ydb:latest
@@ -55,6 +84,13 @@ services:
     volumes:
       - ydb-data:/ydb_data
       - ydb-certs:/ydb_certs
+    healthcheck:
+      test: sh ./health_check
+      interval: 5s
+      timeout: 10s
+      retries: 5
+      start_period: 30s
+
   dashboard:
     env_file: [.env_file]
     build:
@@ -70,6 +106,7 @@ services:
       - stats
     ports:
       - "8088:8088"
+
   dashboard-metadata:
     env_file: [.env_file]
     image: postgres:latest
@@ -83,11 +120,13 @@ services:
     command: -p 5433
     healthcheck:
       test: pg_isready -p 5433 --username=$${POSTGRES_USERNAME}
-      interval: 4s
-      timeout: 3s
-      retries: 3
+      interval: 5s
+      timeout: 10s
+      retries: 5
+      start_period: 30s
     volumes:
       - dashboard-data:/var/lib/postgresql/data
+
   clickhouse:
     env_file: [.env_file]
     image: clickhouse/clickhouse-server:latest
@@ -101,10 +140,12 @@ services:
     volumes:
       - ch-data:/var/lib/clickhouse/
     healthcheck:
-      test: wget --no-verbose --tries=1 --spider http://localhost:8123/ping || exit 1
+      test: wget --no-verbose --tries=1 --spider http://localhost:8123/ping
       interval: 5s
-      timeout: 4s
+      timeout: 10s
       retries: 5
+      start_period: 30s
+
   otelcol:
     image: otel/opentelemetry-collector-contrib:latest
     profiles:
@@ -121,6 +162,7 @@ services:
     ports:
       - "4317:4317"    # OTLP over gRPC receiver
       - "4318:4318"    # OTLP over HTTP receiver
+
 volumes:
   ch-data:
   dashboard-data:

docs/source/user_guides/context_guide.rst

@@ -214,17 +214,17 @@ and the connection parameters, for example, *mongodb://admin:pass@localhost:2701
 The GitHub-based distribution of DFF includes Docker images for each of the supported database types.
 Therefore, the easiest way to deploy your service together with a database is to clone the GitHub
 distribution and to take advantage of the packaged
-`docker-compose file <https://github.com/deeppavlov/dialog_flow_framework/blob/master/docker-compose.yml>`_.
+`docker compose file <https://github.com/deeppavlov/dialog_flow_framework/blob/master/compose.yml>`_.
 
 .. code-block:: shell
   :linenos:
 
   git clone https://github.com/deeppavlov/dialog_flow_framework.git
   cd dialog_flow_framework
   # assuming we need to deploy mongodb
-  docker-compose up mongo
+  docker compose up mongo
 
-The images can be configured using the docker-compose file or the
+The images can be configured using the docker compose file or the
 `environment file <https://github.com/deeppavlov/dialog_flow_framework/blob/master/.env_file>`_,
 also available in the distribution. Consult these files for more options.
 

docs/source/user_guides/superset_guide.rst

@@ -21,7 +21,7 @@ Collection procedure
 .. code-block:: shell
     :linenos:
 
-    # clone the original repository to access the docker-compose file
+    # clone the original repository to access the docker compose file
     git clone https://github.com/deeppavlov/dialog_flow_framework.git
     # install with the stats extra
     cd dialog_flow_framework
@@ -32,11 +32,11 @@ Collection procedure
 .. code-block:: shell
     :linenos:
 
-    # clone the original repository to access the docker-compose file
+    # clone the original repository to access the docker compose file
     git clone https://github.com/deeppavlov/dialog_flow_framework.git
     # launch the required services
     cd dialog_flow_framework
-    docker-compose --profile stats up
+    docker compose --profile stats up
 
 **Collecting data**
 

makefile

@@ -50,19 +50,14 @@ lint: venv
 .PHONY: lint
 
 docker_up:
-	docker-compose --profile context_storage --profile stats up -d --build
+	docker compose --profile context_storage --profile stats up -d --build --wait
 .PHONY: docker_up
 
-wait_db: docker_up
-	while ! docker-compose exec psql pg_isready; do sleep 1; done > /dev/null
-	while ! docker-compose exec mysql bash -c 'mysql -u $$MYSQL_USERNAME -p$$MYSQL_PASSWORD -e "select 1;"'; do sleep 1; done &> /dev/null
-.PHONY: wait_db
-
 test: venv
 	source <(cat .env_file | sed 's/=/=/' | sed 's/^/export /') && pytest -m "not no_coverage" --cov-fail-under=$(TEST_COVERAGE_THRESHOLD) --cov-report html --cov-report term --cov=dff --allow-skip=$(TEST_ALLOW_SKIP) tests/
 .PHONY: test
 
-test_all: venv wait_db test lint
+test_all: venv docker_up test lint
 .PHONY: test_all
 
 build_drawio: