diff --git a/deployment/docker/README.md b/deployment/docker/README.md index 933ebb32dc7..a5093ffb746 100644 --- a/deployment/docker/README.md +++ b/deployment/docker/README.md @@ -109,7 +109,9 @@ export IMAGE_VERSION=1.0.0-M5 ### Enabling development mode -`kapua-sql` container can optionally enable its web admin console. To enable it, provide the `--dev` option. +Development mode deploys some development components to help development and debugging. + +To enable it, provide the `--dev` option. Example: @@ -117,12 +119,33 @@ Example: ./docker-deploy.sh --dev ``` -With this mode, you can access a web browser on http://localhost:8181/ to see the H2 web admin console, that has to be configured with the settings previously shown in the "Accessing components" subsection. -We propose an image to simplify this configuration phase: +Following ports/components will be available: + +| Application/Service | Endpoint | +|-----------------------|-----------------| +| H2 Web Admin console | localhost:8181 | +| Elasticsearch Browser | localhost:55000 | + +#### Notes + +##### H2 Web Admin Console + +The parameters to connect to H2 DB instance are the following + +| Parameter | Value | +|----------------|--------------------------------------| +| Saved Settings | Generic H2 (Server) | +| Driver Class | org.h2.Driver | +| Driver Class | org.h2.Driver | +| JDBC URL | jdbc:h2:tcp://localhost:3306/kapuadb | +| User Name | kapua | +| Password | kapua | + +It is to be noted that as an alternative of the web console you can, of course, use whatever database tool you like, for example DBeaver https://dbeaver.io/ -![WebBrowserH2Sett](kapua-webBrowserH2Settings.png "WebBrowser H2 settings") +#### Elasticsearch Browser -It is to be noted that as an alternative of the web console you can, of course, use whatever database tool you like, for example "dbeaver" https://dbeaver.io/ +Deployed component is already configured to connect to Elasticsearch instance. --- diff --git a/deployment/docker/compose/extras/docker-compose.es-dev.yml b/deployment/docker/compose/extras/docker-compose.es-dev.yml new file mode 100644 index 00000000000..564a7972e00 --- /dev/null +++ b/deployment/docker/compose/extras/docker-compose.es-dev.yml @@ -0,0 +1,12 @@ +version: '3.1' + +services: + es-hq: + container_name: es-hq + image: elastichq/elasticsearch-hq + ports: + - "55000:5000" + depends_on: + - es + environment: + - HQ_DEFAULT_URL=http://es:9200 \ No newline at end of file diff --git a/deployment/docker/kapua-webBrowserH2Settings.png b/deployment/docker/kapua-webBrowserH2Settings.png deleted file mode 100644 index f6a7ca9e721..00000000000 Binary files a/deployment/docker/kapua-webBrowserH2Settings.png and /dev/null differ diff --git a/deployment/docker/unix/docker-deploy.sh b/deployment/docker/unix/docker-deploy.sh index 70f78913a3b..6e946591ee6 100755 --- a/deployment/docker/unix/docker-deploy.sh +++ b/deployment/docker/unix/docker-deploy.sh @@ -53,6 +53,7 @@ docker_compose() { if [[ "$3" == true ]]; then echo "Dev mode enabled!" COMPOSE_FILES+=(-f "${SCRIPT_DIR}/../compose/extras/docker-compose.db-dev.yml") + COMPOSE_FILES+=(-f "${SCRIPT_DIR}/../compose/extras/docker-compose.es-dev.yml") fi # SSL diff --git a/deployment/docker/unix/docker-logs.sh b/deployment/docker/unix/docker-logs.sh index add8cae3c77..11f114a08e1 100755 --- a/deployment/docker/unix/docker-logs.sh +++ b/deployment/docker/unix/docker-logs.sh @@ -24,6 +24,10 @@ docker_common() { docker_logs() { declare -a COMPOSE_FILES; + if [[ "$(docker ps | grep elastichq/elasticsearch-hq)" != "" ]] ; then + COMPOSE_FILES+=(-f "${SCRIPT_DIR}/../compose/extras/docker-compose.es-dev.yml") + fi + if [[ "$(docker ps | grep kapua/kapua-keycloak)" != "" ]] ; then COMPOSE_FILES+=(-f "${SCRIPT_DIR}/../compose/sso/docker-compose.keycloak.yml") fi diff --git a/deployment/docker/unix/docker-undeploy.sh b/deployment/docker/unix/docker-undeploy.sh index ee57d9d5b49..b6d33ad574f 100755 --- a/deployment/docker/unix/docker-undeploy.sh +++ b/deployment/docker/unix/docker-undeploy.sh @@ -24,6 +24,10 @@ docker_common() { docker_undeploy() { declare -a COMPOSE_FILES; + if [[ "$(docker ps | grep elastichq/elasticsearch-hq)" != "" ]] ; then + COMPOSE_FILES+=(-f "${SCRIPT_DIR}/../compose/extras/docker-compose.es-dev.yml") + fi + if [[ "$(docker ps | grep kapua/kapua-keycloak)" != "" ]] ; then COMPOSE_FILES+=(-f "${SCRIPT_DIR}/../compose/sso/docker-compose.keycloak.yml") fi diff --git a/deployment/docker/win/docker-deploy.ps1 b/deployment/docker/win/docker-deploy.ps1 index 96b4812ea74..c179355eb1b 100644 --- a/deployment/docker/win/docker-deploy.ps1 +++ b/deployment/docker/win/docker-deploy.ps1 @@ -71,6 +71,8 @@ If($dev) { Write-Host "Dev mode enabled!" $compose_files+="-f" $compose_files+=$(Join-Path $script_dir .. compose extras docker-compose.db-dev.yml) + $compose_files+="-f" + $compose_files+=$(Join-Path $script_dir .. compose extras docker-compose.es-dev.yml) } docker-compose -f $(Join-Path $script_dir .. compose docker-compose.yml) $compose_files up -d