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 <Avgustin.Marinov@bosch.com>
This commit is contained in:
Avgustin Marinov
@@ -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
|
||||
|
||||
@@ -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. |
|
||||
|
||||
@@ -93,20 +93,6 @@
|
||||
</resources>
|
||||
</build>
|
||||
|
||||
<profiles>
|
||||
<profile>
|
||||
<id>docker</id>
|
||||
<build>
|
||||
<plugins>
|
||||
<plugin>
|
||||
<groupId>io.fabric8</groupId>
|
||||
<artifactId>docker-maven-plugin</artifactId>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</build>
|
||||
</profile>
|
||||
</profiles>
|
||||
|
||||
<modules>
|
||||
<module>hawkbit-ddi-server</module>
|
||||
<module>hawkbit-dmf-server</module>
|
||||
|
||||
61
pom.xml
61
pom.xml
@@ -410,67 +410,6 @@
|
||||
<artifactId>flatten-maven-plugin</artifactId>
|
||||
<version>1.5.0</version>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>io.fabric8</groupId>
|
||||
<artifactId>docker-maven-plugin</artifactId>
|
||||
<version>${docker.maven.plugin.version}</version>
|
||||
<configuration>
|
||||
<verbose>true</verbose>
|
||||
<dockerHost>${docker.host}</dockerHost>
|
||||
<images>
|
||||
<image>
|
||||
<alias>${docker.repository.name}</alias>
|
||||
<name>
|
||||
${docker.repository.name}:${project.version}
|
||||
</name>
|
||||
<build>
|
||||
<from>eclipse-temurin:${docker.jre.version}</from>
|
||||
<createImageOptions>
|
||||
<platform>${docker.base.image.platform}</platform>
|
||||
</createImageOptions>
|
||||
<tags>
|
||||
<tag>latest</tag>
|
||||
</tags>
|
||||
<env>
|
||||
<SPRING_PROFILES_ACTIVE>docker</SPRING_PROFILES_ACTIVE>
|
||||
<JAVA_OPTS>${docker.jvm.args}</JAVA_OPTS>
|
||||
</env>
|
||||
<ports>
|
||||
<port>8080</port>
|
||||
</ports>
|
||||
<assembly>
|
||||
<inline>
|
||||
<fileSets>
|
||||
<fileSet>
|
||||
<directory>target</directory>
|
||||
<outputDirectory>.</outputDirectory>
|
||||
<includes>
|
||||
<include>${project.build.finalName}.jar</include>
|
||||
</includes>
|
||||
<fileMode>0644</fileMode>
|
||||
<directoryMode>0755</directoryMode>
|
||||
<filtered>false</filtered>
|
||||
</fileSet>
|
||||
</fileSets>
|
||||
</inline>
|
||||
</assembly>
|
||||
<entryPoint>
|
||||
<shell>java $JAVA_OPTS -jar maven/${project.build.finalName}.jar</shell>
|
||||
</entryPoint>
|
||||
</build>
|
||||
</image>
|
||||
</images>
|
||||
</configuration>
|
||||
<executions>
|
||||
<execution>
|
||||
<phase>package</phase>
|
||||
<goals>
|
||||
<goal>remove</goal>
|
||||
<goal>build</goal>
|
||||
</goals>
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-javadoc-plugin</artifactId>
|
||||
|
||||
Reference in New Issue
Block a user