From 026ebe0f7fbc55bc846dbe3d30a112bc0d22b420 Mon Sep 17 00:00:00 2001 From: Avgustin Marinov Date: Mon, 4 Dec 2023 15:15:54 +0200 Subject: [PATCH] Allign docker doc (#1500) * allign docker documentation * remove fabric8 files as this is duplicated way for building docker images (along with docker files) Signed-off-by: Marinov Avgustin --- docs/content/gettingstarted.md | 26 ++++++--------- hawkbit-runtime/README.md | 15 ++++++--- hawkbit-runtime/pom.xml | 14 -------- pom.xml | 61 ---------------------------------- 4 files changed, 21 insertions(+), 95 deletions(-) diff --git a/docs/content/gettingstarted.md b/docs/content/gettingstarted.md index fd3e8b1c6..d58c2c922 100755 --- a/docs/content/gettingstarted.md +++ b/docs/content/gettingstarted.md @@ -24,16 +24,13 @@ In addition, the following vendors offer free trial accounts for their Eclipse h ### Overview -| Service / Container | A | B | C | -|---|---|---|---| -| hawkBit Update Server | ✓ | ✓ | ✓ | -| hawkBit Device Simulator | | | ✓ | -| MySQL | | ✓ | ✓ | -| RabbitMQ | | ✓ | ✓ | +HawkBit Update Server username/password -> admin/admin as default login credentials. They can be overridden by the environment variables spring.security.user.name and spring.security.user.password which are defined in the corresponding default [application.properties](hawkbit-runtime/hawkbit-update-server/src/main/resources/application.properties). -HawkBit Update Server uses username=admin and password=admin as default login credentials. They can be overridden by the environment variables spring.security.user.name and spring.security.user.password which are defined in the corresponding default [application.properties](hawkbit-runtime/hawkbit-update-server/src/main/resources/application.properties). +It supports two configurations: +* monolith - hawkbit-update-server +* micro-service - hawkbit-mgmt-server, hawkbit-ddi-server, hawkbit-dmf-server, hawkbit-vv8-ui. -### A: Run hawkBit Update Server as Docker Container +### A: Run hawkBit Update Server (Monolith) as Docker Container Start the hawkBit Update Server as a single container @@ -41,25 +38,24 @@ Start the hawkBit Update Server as a single container $ docker run -p 8080:8080 hawkbit/hawkbit-update-server:latest ``` -### B: Run hawkBit Update Server with services as Docker Compose +### B: Run hawkBit Update Server (Monolith) with services as Docker Compose Start the hawkBit Update Server together with an MySQL and RabbitMQ instance as containers ```bash $ git clone https://github.com/eclipse/hawkbit.git $ cd hawkbit/hawkbit-runtime/docker -$ docker-compose up -d +$ docker-compose -f docker-compose-monolith-mysql.yml up -d ``` -### C: Run hawkBit Update Server with services as Docker Stack +### C: Run hawkBit Update Server (Micro-Service) with services as Docker Compose -Start the hawkBit Update Server and Device Simulator together with an MySQL and RabbitMQ instance as services within a swarm +Start the hawkBit Update Server together with an MySQL and RabbitMQ instance as containers ```bash $ git clone https://github.com/eclipse/hawkbit.git $ cd hawkbit/hawkbit-runtime/docker -$ docker swarm init -$ docker stack deploy -c docker-compose-stack.yml hawkbit +$ docker-compose -f docker-compose-micro-service-mysql.yml up -d ``` ## From Sources @@ -71,7 +67,7 @@ $ cd hawkbit $ mvn clean install ``` -### 2: Start hawkBit [update server](https://github.com/eclipse/hawkbit/tree/master/hawkbit-runtime/hawkbit-update-server) +### 2: Start hawkBit [update server](https://github.com/eclipse/hawkbit/tree/master/hawkbit-runtime/hawkbit-update-server) (Monolith) ```sh $ java -jar ./hawkbit-runtime/hawkbit-update-server/target/hawkbit-update-server-#version#-SNAPSHOT.jar diff --git a/hawkbit-runtime/README.md b/hawkbit-runtime/README.md index 2aefc23d2..93ff3d90a 100644 --- a/hawkbit-runtime/README.md +++ b/hawkbit-runtime/README.md @@ -2,8 +2,13 @@ hawkBit Runtime === -| Folder | Description | -|--------|-------------| -| `.sandbox/` | Content of the hawkBit sandbox installation running on [hawkbit.eclipse.org](https://hawkbit.eclipse.org/UI/). | -| `docker/` | Docker related files, such es Dockerfiles, compose and stack files to quickly start up an hawkBit. | -| `hawkbit-update-server/` | Spring-Boot application of hawkBit. | +| Folder | Description | +|--------------------------|----------------------------------------------------------------------------------------------------------------------------| +| `.sandbox/` | Content of the hawkBit sandbox installation running on [hawkbit.eclipse.org](https://hawkbit.eclipse.org/UI/). | +| `docker/` | Docker related files, such es Dockerfiles, compose and stack files to quickly start up an hawkBit. | +| `docker/docker_build/` | Docker images build related files, such es Dockerfiles and build shell scripts. | +| `hawkbit-update-server/` | Spring-Boot application of hawkBit. Monolith containing all services. | +| `hawkbit-ddi-server/` | Spring-Boot application of hawkBit DDI server. | +| `hawkbit-dmf-server/` | Spring-Boot application of hawkBit DMF server. | +| `hawkbit-mgmt-server/` | Spring-Boot application of hawkBit Management server. Provides REST Management API and rollouts / auto assigment processing | +| `hawkbit-vv8-ui/` | Spring-Boot application of hawkBit Vaadin 8 UI. | diff --git a/hawkbit-runtime/pom.xml b/hawkbit-runtime/pom.xml index cb957beac..09c265f3a 100644 --- a/hawkbit-runtime/pom.xml +++ b/hawkbit-runtime/pom.xml @@ -93,20 +93,6 @@ - - - docker - - - - io.fabric8 - docker-maven-plugin - - - - - - hawkbit-ddi-server hawkbit-dmf-server diff --git a/pom.xml b/pom.xml index 472e96900..2ef590915 100644 --- a/pom.xml +++ b/pom.xml @@ -410,67 +410,6 @@ flatten-maven-plugin 1.5.0 - - io.fabric8 - docker-maven-plugin - ${docker.maven.plugin.version} - - true - ${docker.host} - - - ${docker.repository.name} - - ${docker.repository.name}:${project.version} - - - eclipse-temurin:${docker.jre.version} - - ${docker.base.image.platform} - - - latest - - - docker - ${docker.jvm.args} - - - 8080 - - - - - - target - . - - ${project.build.finalName}.jar - - 0644 - 0755 - false - - - - - - java $JAVA_OPTS -jar maven/${project.build.finalName}.jar - - - - - - - - package - - remove - build - - - - org.apache.maven.plugins maven-javadoc-plugin