docs(docker): rework docker installation page (#2496)

Co-authored-by: Vincent HEMERY <[email protected]> Co-authored-by: Romain Bioteau <[email protected]> Co-authored-by: Emmanuel Duchastenier <[email protected]>
bonitasoft · Nov 16, 2023 · e30fedc · e30fedc
1 parent 4d7e195
commit e30fedc
Show file tree

Hide file tree

Showing 12 changed files with 625 additions and 207 deletions.
diff --git a/modules/ROOT/pages/bonita-studio-download-installation.adoc b/modules/ROOT/pages/bonita-studio-download-installation.adoc
@@ -49,7 +49,7 @@ When the download is finished, you should have one of the following files on you
 * Linux: `BonitaStudioCommunity-x.y-x86_64.run`
 
 === Subscription edition
-Subcription editions cover the now unique Enterprise editions, but also the Performance, Efficiency, and Teamwork editions that are no longer sold but still supported at Bonitasoft. +
+Subscription editions cover the now unique Enterprise editions, but also the Performance, Efficiency, and Teamwork editions that are no longer sold but still supported at Bonitasoft. +
 To download the latest version of Bonita Studio Subscription edition, go to the https://customer.bonitasoft.com/download/request[Customer Service Center] and request the download of the version you need.
 
 When the download is complete, you have one of the following new files:

diff --git a/modules/identity/pages/special-users.adoc b/modules/identity/pages/special-users.adoc
@@ -14,6 +14,7 @@ Its default credentials are:
 * username: `platformAdmin`
 * password: `platform`
 
+[#technical-user]
 == Technical user
 
 Each tenant has an administrator (also known as the *tenant technical user*) with a tenant-specific username and password. The tenant administrator can manage the maintenance state for the tenant, install a Business Data Model, install the resources and the organization. +

diff --git a/modules/runtime/examples/docker/cluster/docker-compose.yml b/modules/runtime/examples/docker/cluster/docker-compose.yml
@@ -0,0 +1,60 @@
+# Example on how to use Postgres (latest available version) with Bonita in a cluster mode
+services:
+  bonita-db:
+    image: bonitasoft/bonita-postgres:latest
+    ports:
+      - "5432:5432"
+    environment:
+      POSTGRES_PASSWORD: my-secret-pw
+    restart: always
+    # Uncomment those lines to mount a volume with your dumps
+    #volumes:
+    #  - ~/my/test/dumps:/opt/bonita/dump
+
+  # In case you have built an Application, use instead as example:
+  # my-application:
+  #  image: my-application-[my built environment]:[my aplication's semantic version]
+  bonita:
+    # this uses the latest maintenance version, but you can also pin a specific maintenance version such as {bonitaVersion}-u0
+    image: bonitasoft.jfrog.io/docker/bonita-subscription:pass:a[{bonitaVersion}]
+    # Update the hostname with the one used when generating the license
+    hostname: localhost
+    volumes:
+      # Replace ~/bonita-lic with the folder containing the license
+      - ~/bonita-lic:/opt/bonita_lic/
+    environment:
+      - DB_VENDOR=postgres
+      - DB_HOST=bonita-db
+      - DB_PORT=5432
+      - DB_NAME=bonita
+      - DB_USER=bonita
+      - DB_PASS=bpm
+      - BIZ_DB_NAME=business_data
+      - BIZ_DB_USER=business_data
+      - BIZ_DB_PASS=bpm
+      - CLUSTER_MODE=true
+    labels:
+      - "traefik.enable=true"
+      - "traefik.http.routers.bonita.entrypoints=web"
+      - "traefik.http.routers.bonita.rule=Host(`bonita.localhost`)"
+      - "traefik.http.services.bonita.loadbalancer.server.port=8080"
+    restart: on-failure:2
+    depends_on:
+      bonita-db:
+        # It uses the HEALTHCHECK of the database Docker image
+        condition: service_healthy
+
+  traefik:
+    image: traefik:v2.10.5
+    container_name: traefik
+    command:
+      #- "--log.level=DEBUG"
+      - "--api.insecure=true"
+      - "--providers.docker=true"
+      - "--providers.docker.exposedbydefault=false"
+      - "--entrypoints.web.address=:80"
+    ports:
+      - "80:80"
+      - "8080:8080"
+    volumes:
+      - "/var/run/docker.sock:/var/run/docker.sock:ro"
diff --git a/modules/runtime/examples/docker/community/mysql/docker-compose.yml b/modules/runtime/examples/docker/community/mysql/docker-compose.yml
@@ -0,0 +1,32 @@
+# Example on how to use MySQL (latest available version) with a Community edition of Bonita
+services:
+  bonita-db:
+    image: bonitasoft/bonita-mysql:latest
+    ports:
+      - "3306:3306"
+    environment:
+      MYSQL_ROOT_PASSWORD: my-secret-pw
+    restart: always
+
+  # In case you have built an Application, use instead as example:
+  # my-application:
+  #  image: my-application-[my built environment]:[my aplication's semantic version]
+  bonita:
+    image: bonita:pass:a[{bonitaVersion}]
+    ports:
+      - "8080:8080"
+    environment:
+      - DB_VENDOR=mysql
+      - DB_HOST=bonita-db
+      - DB_PORT=3306
+      - DB_NAME=bonita
+      - DB_USER=bonita
+      - DB_PASS=bpm
+      - BIZ_DB_NAME=business_data
+      - BIZ_DB_USER=business_data
+      - BIZ_DB_PASS=bpm
+    restart: on-failure:2
+    depends_on:
+      bonita-db:
+        # It uses the HEALTHCHECK of the database Docker image
+        condition: service_healthy
diff --git a/modules/runtime/examples/docker/community/postgres/docker-compose.yml b/modules/runtime/examples/docker/community/postgres/docker-compose.yml
@@ -0,0 +1,35 @@
+# Example on how to use Postgres (latest available version) with a Community edition of Bonita
+services:
+  bonita-db:
+    image: bonitasoft/bonita-postgres:latest
+    ports:
+      - "5432:5432"
+    environment:
+      POSTGRES_PASSWORD: my-secret-pw
+    restart: always
+    # Uncomment those lines to mount a volume with your dumps
+    #volumes:
+    #  - ~/my/test/dumps:/opt/bonita/dump
+
+  # In case you have built an Application, use instead as example:
+  # my-application:
+  #  image: my-application-[my built environment]:[my aplication's semantic version]
+  bonita:
+    image: bonita:pass:a[{bonitaVersion}]
+    ports:
+      - "8080:8080"
+    environment:
+      - DB_VENDOR=postgres
+      - DB_HOST=bonita-db
+      - DB_PORT=5432
+      - DB_NAME=bonita
+      - DB_USER=bonita
+      - DB_PASS=bpm
+      - BIZ_DB_NAME=business_data
+      - BIZ_DB_USER=business_data
+      - BIZ_DB_PASS=bpm
+    restart: on-failure:2
+    depends_on:
+      bonita-db:
+        # It uses the HEALTHCHECK of the database Docker image
+        condition: service_healthy
diff --git a/modules/runtime/examples/docker/community/sqlserver/docker-compose.yml b/modules/runtime/examples/docker/community/sqlserver/docker-compose.yml
@@ -0,0 +1,32 @@
+# Example on how to use SQL Server (latest available version) with a Community edition of Bonita
+services:
+  bonita-db:
+    image: bonitasoft/bonita-sqlserver:latest
+    ports:
+      - "1433:1433"
+    environment:
+      MSSQL_SA_PASSWORD: Change-Me-123
+    restart: always
+
+  # In case you have built an Application, use instead as example:
+  # my-application:
+  #  image: my-application-[my built environment]:[my aplication's semantic version]
+  bonita:
+    image: bonita:pass:a[{bonitaVersion}]
+    ports:
+      - "8080:8080"
+    environment:
+      - DB_VENDOR=sqlserver
+      - DB_HOST=bonita-db
+      - DB_PORT=1433
+      - DB_NAME=bonita
+      - DB_USER=bonita
+      - DB_PASS=bpm
+      - BIZ_DB_NAME=business_data
+      - BIZ_DB_USER=business_data
+      - BIZ_DB_PASS=bpm
+    restart: on-failure:2
+    depends_on:
+      bonita-db:
+        # It uses the HEALTHCHECK of the database Docker image
+        condition: service_healthy
diff --git a/modules/runtime/examples/docker/subscription/mysql/docker-compose.yml b/modules/runtime/examples/docker/subscription/mysql/docker-compose.yml
@@ -0,0 +1,38 @@
+# Example on how to use MySQL (latest available version) with a Subscription edition of Bonita
+services:
+  bonita-db:
+    image: bonitasoft/bonita-mysql:latest
+    ports:
+      - "3306:3306"
+    environment:
+      MYSQL_ROOT_PASSWORD: my-secret-pw
+    restart: always
+
+  # In case you have built an Application, use instead as example:
+  # my-application:
+  #  image: my-application-[my built environment]:[my aplication's semantic version]
+  bonita:
+    # this uses the latest maintenance version, but you can also pin a specific maintenance version such as {bonitaVersion}-u0
+    image: bonitasoft.jfrog.io/docker/bonita-subscription:pass:a[{bonitaVersion}]
+    # Update the hostname with the one used when generating the license
+    hostname: localhost
+    volumes:
+      # Replace ~/bonita-lic with the folder containing the license
+      - ~/bonita-lic:/opt/bonita_lic/
+    ports:
+      - "8080:8080"
+    environment:
+      - DB_VENDOR=mysql
+      - DB_HOST=bonita-db
+      - DB_PORT=3306
+      - DB_NAME=bonita
+      - DB_USER=bonita
+      - DB_PASS=bpm
+      - BIZ_DB_NAME=business_data
+      - BIZ_DB_USER=business_data
+      - BIZ_DB_PASS=bpm
+    restart: on-failure:2
+    depends_on:
+      bonita-db:
+        # It uses the HEALTHCHECK of the database Docker image
+        condition: service_healthy
diff --git a/modules/runtime/examples/docker/subscription/postgres/docker-compose.yml b/modules/runtime/examples/docker/subscription/postgres/docker-compose.yml
@@ -0,0 +1,41 @@
+# Example on how to use Postgres (latest available version) with a Subscription edition of Bonita
+services:
+  bonita-db:
+    image: bonitasoft/bonita-postgres:latest
+    ports:
+      - "5432:5432"
+    environment:
+      POSTGRES_PASSWORD: my-secret-pw
+    restart: always
+    # Uncomment those lines to mount a volume with your dumps
+    #volumes:
+    #  - ~/my/test/dumps:/opt/bonita/dump
+
+  # In case you have built an Application, use instead as example:
+  # my-application:
+  #  image: my-application-[my built environment]:[my aplication's semantic version]
+  bonita:
+    # this uses the latest maintenance version, but you can also pin a specific maintenance version such as {bonitaVersion}-u0
+    image: bonitasoft.jfrog.io/docker/bonita-subscription:pass:a[{bonitaVersion}]
+    # Update the hostname with the one used when generating the license
+    hostname: localhost
+    volumes:
+      # Replace ~/bonita-lic with the folder containing the license
+      - ~/bonita-lic:/opt/bonita_lic/
+    ports:
+      - "8080:8080"
+    environment:
+      - DB_VENDOR=postgres
+      - DB_HOST=bonita-db
+      - DB_PORT=5432
+      - DB_NAME=bonita
+      - DB_USER=bonita
+      - DB_PASS=bpm
+      - BIZ_DB_NAME=business_data
+      - BIZ_DB_USER=business_data
+      - BIZ_DB_PASS=bpm
+    restart: on-failure:2
+    depends_on:
+      bonita-db:
+        # It uses the HEALTHCHECK of the database Docker image
+        condition: service_healthy
diff --git a/modules/runtime/examples/docker/subscription/sqlserver/docker-compose.yml b/modules/runtime/examples/docker/subscription/sqlserver/docker-compose.yml
@@ -0,0 +1,38 @@
+# Example on how to use SQL Server (latest available version) with a Subscription edition of Bonita
+services:
+  bonita-db:
+    image: bonitasoft/bonita-sqlserver:latest
+    ports:
+      - "1433:1433"
+    environment:
+      MSSQL_SA_PASSWORD: Change-Me-123
+    restart: always
+
+  # In case you have built an Application, use instead as example:
+  # my-application:
+  #  image: my-application-[my built environment]:[my aplication's semantic version]
+  bonita:
+    # this uses the latest maintenance version, but you can also pin a specific maintenance version such as {bonitaVersion}-u0
+    image: bonitasoft.jfrog.io/docker/bonita-subscription:pass:a[{bonitaVersion}]
+    # Update the hostname with the one used when generating the license
+    hostname: localhost
+    volumes:
+      # Replace ~/bonita-lic with the folder containing the license
+      - ~/bonita-lic:/opt/bonita_lic/
+    ports:
+      - "8080:8080"
+    environment:
+      - DB_VENDOR=sqlserver
+      - DB_HOST=bonita-db
+      - DB_PORT=1433
+      - DB_NAME=bonita
+      - DB_USER=bonita
+      - DB_PASS=bpm
+      - BIZ_DB_NAME=business_data
+      - BIZ_DB_USER=business_data
+      - BIZ_DB_PASS=bpm
+    restart: on-failure:2
+    depends_on:
+      bonita-db:
+        # It uses the HEALTHCHECK of the database Docker image
+        condition: service_healthy