lingwei.kong/hawkbit
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

Update hawkBit Documentation Theme (#2966)

Browse Source
This commit is contained in:
Desislava Marinova
2026-03-23 10:29:22 +02:00
committed by GitHub
parent dc8567caec
commit 4954a7d488
23 changed files with 215 additions and 947 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -1,4 +1,4 @@
<img src=hawkbit_logo.png width=533 height=246 />
<img alt="hawkBit" src=docs/images/hawkbit_logo.png width=530/>
# Eclipse hawkBit™ - Update Server
@@ -117,7 +117,7 @@ at [guide](https://www.eclipse.org/hawkbit/guides/runhawkbit/) -> _Configure Rab
# hawkBit (Spring boot) starters
Next to the [Update Server](hawkbit-monolith/hawkbit-update-server) we are also providing a set
of [Spring Boot Starters](hawkbit-starters) to quick start your
of [Spring Boot Starters](hawkbit-monolith) to quick start your
own [Spring Boot](https://projects.spring.io/spring-boot/) based application.
# Clone, build and run hawkBit

2
docs/README.md
View File

@@ -3,7 +3,7 @@
Eclipse hawkBit™ is a domain independent back-end framework for rolling out software updates to constrained edge devices as well as more powerful controllers and gateways connected to IP based networking infrastructure.
<p align="center">
<img src="images/hawkBit_overview.jpeg" alt="Eclipse hawkBit Overview" width="1200">
<img src="images/hawkBit_overview.png" alt="Eclipse hawkBit Overview" width="1200">
</p>
---

93
docs/device-provisioning.md
View File

@@ -28,29 +28,30 @@ In this scenario, an administrator or backend system first provision the device
### Workflow
```mermaid
%%{init: {'theme':'base', 'themeVariables': {
'primaryColor':'#6BAF4A',
'primaryTextColor':'#000',
'primaryBorderColor':'#6BAF4A',
'lineColor':'#4A2C5C',
'secondaryColor':'#E8D5F2',
'tertiaryColor':'#6BAF4A',
'noteBkgColor':'#F5F5F5',
'noteTextColor':'#000',
'noteBorderColor':'#6BAF4A',
'actorBorder':'#4A2C5C',
'actorBkg':'#6BAF4A',
'actorTextColor':'#000',
'actorLineColor':'#4A2C5C',
'signalColor':'#4A2C5C',
'signalTextColor':'#000',
'labelBoxBkgColor':'#E8D5F2',
'labelBoxBorderColor':'#6BAF4A',
'labelTextColor':'#000',
'loopTextColor':'#000',
'activationBorderColor':'#4A2C5C',
'activationBkgColor':'#F5F5F5',
'sequenceNumberColor':'#FFF'
}}}%%
'primaryColor':'#027ABE',
'primaryTextColor':'#FFF',
'primaryBorderColor':'#015585',
'lineColor':'#43464A',
'secondaryColor':'#9ABFDB',
'tertiaryColor':'#027ABE',
'noteBkgColor':'#F0EEEA',
'noteTextColor':'#43464A',
'noteBorderColor':'#015585',
'actorBorder':'#015585',
'actorBkg':'#027ABE',
'actorTextColor':'#FFF',
'actorLineColor':'#43464A',
'signalColor':'#43464A',
'signalTextColor':'#43464A',
'labelBoxBkgColor':'#9ABFDB',
'labelBoxBorderColor':'#015585',
'labelTextColor':'#015585',
'loopTextColor':'#43464A',
'activationBorderColor':'#015585',
'activationBkgColor':'#F0EEEA',
'sequenceNumberColor':'#FFF'
}}}%%
sequenceDiagram
participant Admin as Admin/Backend System
participant MgmtAPI as Management API<br/>(REST)
@@ -256,29 +257,29 @@ see [Configuration Properties](#configuration-properties) below for details on h
### Workflow
```mermaid
%%{init: {'theme':'base', 'themeVariables': {
'primaryColor':'#6BAF4A',
'primaryTextColor':'#000',
'primaryBorderColor':'#6BAF4A',
'lineColor':'#4A2C5C',
'secondaryColor':'#E8D5F2',
'tertiaryColor':'#6BAF4A',
'noteBkgColor':'#F5F5F5',
'noteTextColor':'#000',
'noteBorderColor':'#6BAF4A',
'actorBorder':'#4A2C5C',
'actorBkg':'#6BAF4A',
'actorTextColor':'#000',
'actorLineColor':'#4A2C5C',
'signalColor':'#4A2C5C',
'signalTextColor':'#000',
'labelBoxBkgColor':'#E8D5F2',
'labelBoxBorderColor':'#6BAF4A',
'labelTextColor':'#000',
'loopTextColor':'#000',
'activationBorderColor':'#4A2C5C',
'activationBkgColor':'#F5F5F5',
'sequenceNumberColor':'#FFF'
}}}%%
'primaryColor':'#027ABE',
'primaryTextColor':'#FFF',
'primaryBorderColor':'#015585',
'lineColor':'#43464A',
'secondaryColor':'#9ABFDB',
'tertiaryColor':'#027ABE',
'noteBkgColor':'#F0EEEA',
'noteTextColor':'#43464A',
'noteBorderColor':'#015585',
'actorBorder':'#015585',
'actorBkg':'#027ABE',
'actorTextColor':'#FFF',
'actorLineColor':'#43464A',
'signalColor':'#43464A',
'signalTextColor':'#43464A',
'labelBoxBkgColor':'#9ABFDB',
'labelBoxBorderColor':'#015585',
'labelTextColor':'#015585',
'loopTextColor':'#43464A',
'activationBorderColor':'#015585',
'activationBkgColor':'#F0EEEA',
'sequenceNumberColor':'#FFF'
}}}%%
sequenceDiagram
participant Device as Device
participant DDIAPI as DDI API<br/>(REST)

163
docs/graphics-source/clustering_overview.drawio
View File

File diff suppressed because one or more lines are too long

106
docs/graphics-source/eventing-within-cluster.drawio
View File

File diff suppressed because one or more lines are too long

165
docs/graphics-source/hawkBit_overview.drawio
View File

File diff suppressed because one or more lines are too long

BIN
docs/graphics-source/hawkbit-palette.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 237 KiB

78
docs/graphics-source/packagemodel.drawio Normal file
View File

@@ -0,0 +1,78 @@
<mxfile host="app.diagrams.net" agent="Claude" version="26.0.0">
<diagram name="Package Model" id="packagemodel">
<mxGraphModel dx="1100" dy="600" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="800" pageHeight="400" math="0" shadow="0">
<root>
<mxCell id="0" />
<mxCell id="1" parent="0" />
<!-- Vehicle / Target Device -->
<mxCell id="car" value="" style="shape=mxgraph.signs.transportation.car_2;fillColor=#1A4D1A;strokeColor=none;fontColor=#FFFFFF;fontSize=12;" vertex="1" parent="1">
<mxGeometry x="30" y="160" width="80" height="50" as="geometry" />
</mxCell>
<!-- Small controller board on car -->
<mxCell id="controller" value="" style="shape=mxgraph.cisco.controllers_and_modules.controller;fillColor=#00CC00;strokeColor=none;" vertex="1" parent="1">
<mxGeometry x="55" y="135" width="30" height="25" as="geometry" />
</mxCell>
<!-- Arrow from DistributionSet to Car -->
<mxCell id="arrow1" value="" style="endArrow=block;endFill=1;strokeColor=#0066CC;strokeWidth=3;entryX=1;entryY=0.5;entryDx=0;entryDy=0;exitX=0;exitY=0.5;exitDx=0;exitDy=0;" edge="1" parent="1" source="ds" target="car">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<!-- DistributionSet -->
<mxCell id="ds" value="&lt;b style=&quot;font-size:14px;&quot;&gt;DistributionSet&lt;/b&gt;&lt;br&gt;&lt;i&gt;version: 1&lt;/i&gt;" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#4B0082;fontColor=#FFFFFF;strokeColor=none;verticalAlign=middle;align=center;fontSize=12;" vertex="1" parent="1">
<mxGeometry x="190" y="110" width="160" height="150" as="geometry" />
</mxCell>
<!-- Software Module 1 (top) -->
<mxCell id="sm1" value="&lt;b style=&quot;font-size:13px;&quot;&gt;Software Module&lt;/b&gt;&lt;br&gt;&lt;i&gt;version: 1.8.beta&lt;/i&gt;&lt;br&gt;&lt;i&gt;key: ccu17&lt;/i&gt;" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#009933;fontColor=#FFFFFF;strokeColor=none;verticalAlign=middle;align=center;fontSize=11;" vertex="1" parent="1">
<mxGeometry x="370" y="90" width="170" height="80" as="geometry" />
</mxCell>
<!-- Software Module 2 (bottom) -->
<mxCell id="sm2" value="&lt;b style=&quot;font-size:13px;&quot;&gt;Software Module&lt;/b&gt;&lt;br&gt;&lt;i&gt;version: 3.1.0&lt;/i&gt;&lt;br&gt;&lt;i&gt;key: os&lt;/i&gt;" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#009933;fontColor=#FFFFFF;strokeColor=none;verticalAlign=middle;align=center;fontSize=11;" vertex="1" parent="1">
<mxGeometry x="370" y="200" width="170" height="80" as="geometry" />
</mxCell>
<!-- Artifact icons for SM1 -->
<!-- .zc file -->
<mxCell id="art1" value=".zc" style="shape=mxgraph.signs.tech.data;fillColor=#CCCCCC;strokeColor=#666666;fontSize=9;fontColor=#333333;verticalAlign=bottom;spacingBottom=-2;" vertex="1" parent="1">
<mxGeometry x="560" y="75" width="28" height="30" as="geometry" />
</mxCell>
<!-- .dat file -->
<mxCell id="art2" value=".dat" style="shape=mxgraph.signs.tech.data;fillColor=#CCCCCC;strokeColor=#666666;fontSize=9;fontColor=#333333;verticalAlign=bottom;spacingBottom=-2;" vertex="1" parent="1">
<mxGeometry x="560" y="108" width="28" height="30" as="geometry" />
</mxCell>
<!-- .txt file -->
<mxCell id="art3" value=".txt" style="shape=mxgraph.signs.tech.data;fillColor=#CCCCCC;strokeColor=#666666;fontSize=9;fontColor=#333333;verticalAlign=bottom;spacingBottom=-2;" vertex="1" parent="1">
<mxGeometry x="560" y="141" width="28" height="30" as="geometry" />
</mxCell>
<!-- .rpm file for SM2 -->
<mxCell id="art4" value=".rpm" style="shape=mxgraph.signs.tech.data;fillColor=#CCCCCC;strokeColor=#666666;fontSize=9;fontColor=#333333;verticalAlign=bottom;spacingBottom=-2;" vertex="1" parent="1">
<mxGeometry x="560" y="220" width="28" height="30" as="geometry" />
</mxCell>
<!-- Connection lines from SM1 to artifacts -->
<mxCell id="line1" value="" style="endArrow=none;strokeColor=#999999;strokeWidth=1;" edge="1" parent="1" source="sm1" target="art1">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="line2" value="" style="endArrow=none;strokeColor=#999999;strokeWidth=1;" edge="1" parent="1" source="sm1" target="art2">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="line3" value="" style="endArrow=none;strokeColor=#999999;strokeWidth=1;" edge="1" parent="1" source="sm1" target="art3">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<!-- Connection line from SM2 to rpm artifact -->
<mxCell id="line4" value="" style="endArrow=none;strokeColor=#999999;strokeWidth=1;" edge="1" parent="1" source="sm2" target="art4">
<mxGeometry relative="1" as="geometry" />
</mxCell>
</root>
</mxGraphModel>
</diagram>
</mxfile>

218
docs/graphics-source/rollout.drawio
View File

@@ -1,218 +0,0 @@
<mxfile host="Electron" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/28.2.5 Chrome/138.0.7204.251 Electron/37.6.1 Safari/537.36" version="28.2.5">
<diagram name="Page-1" id="4hQ0Vji6YOXjBGBZhYzO">
<mxGraphModel dx="961" dy="592" grid="1" gridSize="2" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="827" pageHeight="1169" math="0" shadow="0">
<root>
<mxCell id="0" />
<mxCell id="1" parent="0" />
<mxCell id="wNYtK6DitPIeJlGkPyxx-61" value="" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#f5f5f5;strokeColor=#666666;fontColor=#333333;" vertex="1" parent="1">
<mxGeometry x="81" y="514" width="272" height="125" as="geometry" />
</mxCell>
<mxCell id="wNYtK6DitPIeJlGkPyxx-4" value="" style="html=1;shadow=0;dashed=0;align=center;verticalAlign=middle;shape=mxgraph.arrows2.arrow;dy=0;dx=10;notch=10;fillColor=#d5e8d4;strokeColor=#82b366;" vertex="1" parent="1">
<mxGeometry x="90" y="270" width="110" height="30" as="geometry" />
</mxCell>
<mxCell id="wNYtK6DitPIeJlGkPyxx-5" value="" style="html=1;shadow=0;dashed=0;align=center;verticalAlign=middle;shape=mxgraph.arrows2.arrow;dy=0;dx=10;notch=10;fillColor=#dae8fc;strokeColor=#6c8ebf;" vertex="1" parent="1">
<mxGeometry x="190" y="270" width="50" height="30" as="geometry" />
</mxCell>
<mxCell id="wNYtK6DitPIeJlGkPyxx-8" value="" style="html=1;shadow=0;dashed=0;align=center;verticalAlign=middle;shape=mxgraph.arrows2.arrow;dy=0;dx=10;notch=0;fillColor=#f8cecc;strokeColor=#b85450;" vertex="1" parent="1">
<mxGeometry x="80" y="270" width="20" height="30" as="geometry" />
</mxCell>
<mxCell id="wNYtK6DitPIeJlGkPyxx-9" value="" style="html=1;shadow=0;dashed=0;align=center;verticalAlign=middle;shape=mxgraph.arrows2.arrow;dy=0;dx=10;notch=10;fillColor=#d5e8d4;strokeColor=#82b366;" vertex="1" parent="1">
<mxGeometry x="200" y="320" width="90" height="30" as="geometry" />
</mxCell>
<mxCell id="wNYtK6DitPIeJlGkPyxx-10" value="" style="html=1;shadow=0;dashed=0;align=center;verticalAlign=middle;shape=mxgraph.arrows2.arrow;dy=0;dx=10;notch=10;fillColor=#dae8fc;strokeColor=#6c8ebf;" vertex="1" parent="1">
<mxGeometry x="280" y="320" width="70" height="30" as="geometry" />
</mxCell>
<mxCell id="wNYtK6DitPIeJlGkPyxx-20" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0;exitY=0.5;exitDx=0;exitDy=0;exitPerimeter=0;endArrow=none;endFill=0;startArrow=classic;startFill=1;endSize=4;startSize=4;" edge="1" parent="1" source="wNYtK6DitPIeJlGkPyxx-11">
<mxGeometry relative="1" as="geometry">
<mxPoint x="176" y="302" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="wNYtK6DitPIeJlGkPyxx-21" value="&lt;font style=&quot;font-size: 9px;&quot;&gt;Trigger Next Group&lt;/font&gt;" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];" vertex="1" connectable="0" parent="wNYtK6DitPIeJlGkPyxx-20">
<mxGeometry x="0.4804" relative="1" as="geometry">
<mxPoint y="-3" as="offset" />
</mxGeometry>
</mxCell>
<mxCell id="wNYtK6DitPIeJlGkPyxx-11" value="" style="html=1;shadow=0;dashed=0;align=center;verticalAlign=middle;shape=mxgraph.arrows2.arrow;dy=0;dx=10;notch=0;fillColor=#f8cecc;strokeColor=#b85450;" vertex="1" parent="1">
<mxGeometry x="190" y="320" width="20" height="30" as="geometry" />
</mxCell>
<mxCell id="wNYtK6DitPIeJlGkPyxx-12" value="" style="html=1;shadow=0;dashed=0;align=center;verticalAlign=middle;shape=mxgraph.arrows2.arrow;dy=0;dx=10;notch=10;fillColor=#d5e8d4;strokeColor=#82b366;" vertex="1" parent="1">
<mxGeometry x="310" y="370" width="110" height="30" as="geometry" />
</mxCell>
<mxCell id="wNYtK6DitPIeJlGkPyxx-13" value="" style="html=1;shadow=0;dashed=0;align=center;verticalAlign=middle;shape=mxgraph.arrows2.arrow;dy=0;dx=10;notch=10;fillColor=#dae8fc;strokeColor=#6c8ebf;" vertex="1" parent="1">
<mxGeometry x="410" y="370" width="50" height="30" as="geometry" />
</mxCell>
<mxCell id="wNYtK6DitPIeJlGkPyxx-14" value="" style="html=1;shadow=0;dashed=0;align=center;verticalAlign=middle;shape=mxgraph.arrows2.arrow;dy=0;dx=10;notch=0;fillColor=#f8cecc;strokeColor=#b85450;" vertex="1" parent="1">
<mxGeometry x="300" y="370" width="30" height="30" as="geometry" />
</mxCell>
<mxCell id="wNYtK6DitPIeJlGkPyxx-22" value="" style="endArrow=none;html=1;rounded=0;startSize=4;endSize=4;jumpSize=4;" edge="1" parent="1" source="wNYtK6DitPIeJlGkPyxx-24">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="176" y="252" as="sourcePoint" />
<mxPoint x="176" y="304" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="wNYtK6DitPIeJlGkPyxx-23" value="&lt;div style=&quot;line-height: 90%;&quot;&gt;&lt;font style=&quot;font-size: 9px; line-height: 90%;&quot;&gt;Trigger&lt;/font&gt;&lt;div&gt;&lt;font style=&quot;font-size: 9px; line-height: 90%;&quot;&gt;Threshold&lt;/font&gt;&lt;/div&gt;&lt;/div&gt;" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontColor=#808080;spacing=2;" vertex="1" parent="1">
<mxGeometry x="147" y="217" width="58" height="30" as="geometry" />
</mxCell>
<mxCell id="wNYtK6DitPIeJlGkPyxx-25" value="" style="endArrow=none;html=1;rounded=0;startSize=4;endSize=4;jumpSize=4;" edge="1" parent="1" target="wNYtK6DitPIeJlGkPyxx-24">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="176" y="252" as="sourcePoint" />
<mxPoint x="176" y="304" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="wNYtK6DitPIeJlGkPyxx-24" value="" style="shape=waypoint;sketch=0;fillStyle=solid;size=6;pointerEvents=1;points=[];fillColor=none;resizable=0;rotatable=0;perimeter=centerPerimeter;snapToPoint=1;" vertex="1" parent="1">
<mxGeometry x="166" y="242" width="20" height="20" as="geometry" />
</mxCell>
<mxCell id="wNYtK6DitPIeJlGkPyxx-26" value="" style="endArrow=none;html=1;rounded=0;" edge="1" parent="1">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="102" y="300" as="sourcePoint" />
<mxPoint x="102" y="254" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="wNYtK6DitPIeJlGkPyxx-27" value="" style="shape=waypoint;sketch=0;fillStyle=solid;size=6;pointerEvents=1;points=[];fillColor=none;resizable=0;rotatable=0;perimeter=centerPerimeter;snapToPoint=1;" vertex="1" parent="1">
<mxGeometry x="92" y="242" width="20" height="20" as="geometry" />
</mxCell>
<mxCell id="wNYtK6DitPIeJlGkPyxx-28" value="&lt;div style=&quot;line-height: 90%;&quot;&gt;&lt;font style=&quot;font-size: 9px; line-height: 90%;&quot;&gt;Emergency&lt;/font&gt;&lt;div&gt;&lt;font style=&quot;font-size: 9px; line-height: 90%;&quot;&gt;Shutdown&lt;/font&gt;&lt;div&gt;&lt;font style=&quot;font-size: 9px; line-height: 90%;&quot;&gt;Threshold&lt;/font&gt;&lt;/div&gt;&lt;/div&gt;&lt;/div&gt;" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontColor=#808080;spacing=2;" vertex="1" parent="1">
<mxGeometry x="64.5" y="212" width="75" height="30" as="geometry" />
</mxCell>
<mxCell id="wNYtK6DitPIeJlGkPyxx-31" value="" style="html=1;shadow=0;dashed=0;align=center;verticalAlign=middle;shape=mxgraph.arrows2.arrow;dy=0;dx=10;notch=0;fillColor=#dae8fc;strokeColor=#6c8ebf;" vertex="1" parent="1">
<mxGeometry x="384" y="418" width="160" height="30" as="geometry" />
</mxCell>
<mxCell id="wNYtK6DitPIeJlGkPyxx-32" value="" style="endArrow=none;html=1;rounded=0;entryX=0.297;entryY=0.988;entryDx=0;entryDy=0;entryPerimeter=0;fillColor=#d5e8d4;strokeColor=#82b366;" edge="1" parent="1" target="wNYtK6DitPIeJlGkPyxx-4">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="123" y="380" as="sourcePoint" />
<mxPoint x="212" y="460" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="wNYtK6DitPIeJlGkPyxx-34" value="" style="html=1;dashed=0;whiteSpace=wrap;shape=mxgraph.dfd.start;fillColor=#d5e8d4;strokeColor=#82b366;fontSize=10;" vertex="1" parent="1">
<mxGeometry x="80" y="380" width="86" height="28" as="geometry" />
</mxCell>
<mxCell id="wNYtK6DitPIeJlGkPyxx-35" value="&lt;div style=&quot;line-height: 80%;&quot;&gt;&lt;font style=&quot;font-size: 9px; line-height: 80%;&quot;&gt;Successful&lt;/font&gt;&lt;div&gt;&lt;font style=&quot;font-size: 9px; line-height: 80%;&quot;&gt;Updates&lt;/font&gt;&lt;/div&gt;&lt;/div&gt;" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="93" y="379" width="60" height="30" as="geometry" />
</mxCell>
<mxCell id="wNYtK6DitPIeJlGkPyxx-36" value="" style="html=1;dashed=0;whiteSpace=wrap;shape=mxgraph.dfd.start;fillColor=#f8cecc;strokeColor=#b85450;fontSize=10;" vertex="1" parent="1">
<mxGeometry x="267" y="457" width="86" height="28" as="geometry" />
</mxCell>
<mxCell id="wNYtK6DitPIeJlGkPyxx-37" value="&lt;div style=&quot;line-height: 80%;&quot;&gt;&lt;font size=&quot;1&quot;&gt;Failed Updates&lt;/font&gt;&lt;/div&gt;" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="280" y="456" width="60" height="30" as="geometry" />
</mxCell>
<mxCell id="wNYtK6DitPIeJlGkPyxx-39" value="" style="endArrow=none;html=1;rounded=0;entryX=0;entryY=0;entryDx=10;entryDy=30;entryPerimeter=0;exitX=0.499;exitY=0.027;exitDx=0;exitDy=0;exitPerimeter=0;fillColor=#f8cecc;strokeColor=#b85450;" edge="1" parent="1" source="wNYtK6DitPIeJlGkPyxx-37" target="wNYtK6DitPIeJlGkPyxx-14">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="334" y="404" as="sourcePoint" />
<mxPoint x="384" y="354" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="wNYtK6DitPIeJlGkPyxx-40" value="" style="html=1;dashed=0;whiteSpace=wrap;shape=mxgraph.dfd.start;fillColor=#dae8fc;strokeColor=#6c8ebf;fontSize=10;" vertex="1" parent="1">
<mxGeometry x="463" y="494" width="86" height="28" as="geometry" />
</mxCell>
<mxCell id="wNYtK6DitPIeJlGkPyxx-41" value="&lt;div style=&quot;line-height: 80%;&quot;&gt;&lt;font size=&quot;1&quot;&gt;Pending Updates&lt;/font&gt;&lt;/div&gt;" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="476" y="493" width="60" height="30" as="geometry" />
</mxCell>
<mxCell id="wNYtK6DitPIeJlGkPyxx-42" value="" style="endArrow=none;html=1;rounded=0;entryX=0;entryY=0;entryDx=10;entryDy=30;entryPerimeter=0;fillColor=#dae8fc;strokeColor=#6c8ebf;" edge="1" parent="1">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="506" y="494" as="sourcePoint" />
<mxPoint x="506" y="448" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="wNYtK6DitPIeJlGkPyxx-44" value="Deployment Group 1" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="246" y="270" width="60" height="30" as="geometry" />
</mxCell>
<mxCell id="wNYtK6DitPIeJlGkPyxx-45" value="Deployment Group 2" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="360" y="320" width="60" height="30" as="geometry" />
</mxCell>
<mxCell id="wNYtK6DitPIeJlGkPyxx-46" value="Deployment Group 3" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="470" y="370" width="60" height="30" as="geometry" />
</mxCell>
<mxCell id="wNYtK6DitPIeJlGkPyxx-47" value="Deployment Group 4" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="556" y="418" width="60" height="30" as="geometry" />
</mxCell>
<mxCell id="wNYtK6DitPIeJlGkPyxx-48" value="" style="shape=waypoint;sketch=0;fillStyle=solid;size=6;pointerEvents=1;points=[];fillColor=none;resizable=0;rotatable=0;perimeter=centerPerimeter;snapToPoint=1;" vertex="1" parent="1">
<mxGeometry x="496" y="429" width="20" height="20" as="geometry" />
</mxCell>
<mxCell id="wNYtK6DitPIeJlGkPyxx-49" value="" style="shape=waypoint;sketch=0;fillStyle=solid;size=6;pointerEvents=1;points=[];fillColor=none;resizable=0;rotatable=0;perimeter=centerPerimeter;snapToPoint=1;" vertex="1" parent="1">
<mxGeometry x="506" y="429" width="20" height="20" as="geometry" />
</mxCell>
<mxCell id="wNYtK6DitPIeJlGkPyxx-50" value="" style="shape=waypoint;sketch=0;fillStyle=solid;size=6;pointerEvents=1;points=[];fillColor=none;resizable=0;rotatable=0;perimeter=centerPerimeter;snapToPoint=1;" vertex="1" parent="1">
<mxGeometry x="516" y="429" width="20" height="20" as="geometry" />
</mxCell>
<mxCell id="wNYtK6DitPIeJlGkPyxx-51" value="" style="endArrow=classic;html=1;rounded=0;strokeWidth=2;endFill=1;jumpSize=6;endSize=4;startSize=4;" edge="1" parent="1">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="105" y="614" as="sourcePoint" />
<mxPoint x="201" y="614" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="wNYtK6DitPIeJlGkPyxx-52" value="" style="endArrow=classic;html=1;rounded=0;strokeWidth=2;startArrow=none;startFill=0;endFill=1;endSize=4;startSize=4;" edge="1" parent="1">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="105" y="615" as="sourcePoint" />
<mxPoint x="105" y="532" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="wNYtK6DitPIeJlGkPyxx-53" value="Time" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="157" y="612" width="60" height="30" as="geometry" />
</mxCell>
<mxCell id="wNYtK6DitPIeJlGkPyxx-54" value="Load" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;labelPosition=center;verticalLabelPosition=middle;horizontal=0;" vertex="1" parent="1">
<mxGeometry x="63" y="530" width="60" height="30" as="geometry" />
</mxCell>
<mxCell id="wNYtK6DitPIeJlGkPyxx-55" value="" style="endArrow=none;html=1;rounded=1;curved=0;fillColor=#dae8fc;strokeColor=#6c8ebf;strokeWidth=2;" edge="1" parent="1">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="105" y="614" as="sourcePoint" />
<mxPoint x="153" y="614" as="targetPoint" />
<Array as="points">
<mxPoint x="129" y="526" />
</Array>
</mxGeometry>
</mxCell>
<mxCell id="wNYtK6DitPIeJlGkPyxx-56" value="" style="endArrow=classic;html=1;rounded=0;strokeWidth=2;endFill=1;endSize=4;startSize=4;" edge="1" parent="1">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="219" y="614" as="sourcePoint" />
<mxPoint x="345" y="614" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="wNYtK6DitPIeJlGkPyxx-57" value="" style="endArrow=none;html=1;rounded=1;curved=0;fillColor=#dae8fc;strokeColor=#5B77A1;strokeWidth=2;" edge="1" parent="1">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="219" y="613" as="sourcePoint" />
<mxPoint x="267" y="613" as="targetPoint" />
<Array as="points">
<mxPoint x="243" y="579" />
</Array>
</mxGeometry>
</mxCell>
<mxCell id="wNYtK6DitPIeJlGkPyxx-58" value="" style="endArrow=none;html=1;rounded=1;curved=0;fillColor=#dae8fc;strokeColor=#6E90C2;strokeWidth=2;" edge="1" parent="1">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="237" y="613" as="sourcePoint" />
<mxPoint x="285" y="613" as="targetPoint" />
<Array as="points">
<mxPoint x="261" y="579" />
</Array>
</mxGeometry>
</mxCell>
<mxCell id="wNYtK6DitPIeJlGkPyxx-59" value="" style="endArrow=none;html=1;rounded=1;curved=0;fillColor=#dae8fc;strokeColor=#87B5F2;strokeWidth=2;" edge="1" parent="1">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="251" y="613" as="sourcePoint" />
<mxPoint x="299" y="613" as="targetPoint" />
<Array as="points">
<mxPoint x="275" y="579" />
</Array>
</mxGeometry>
</mxCell>
<mxCell id="wNYtK6DitPIeJlGkPyxx-60" value="" style="endArrow=none;html=1;rounded=1;curved=0;fillColor=#dae8fc;strokeColor=#87C7FF;strokeWidth=2;" edge="1" parent="1">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="269" y="613" as="sourcePoint" />
<mxPoint x="317" y="613" as="targetPoint" />
<Array as="points">
<mxPoint x="293" y="579" />
</Array>
</mxGeometry>
</mxCell>
<mxCell id="wNYtK6DitPIeJlGkPyxx-66" value="" style="endArrow=classic;html=1;rounded=0;entryX=0.577;entryY=0.64;entryDx=0;entryDy=0;entryPerimeter=0;fillColor=#dae8fc;strokeColor=#6c8ebf;" edge="1" parent="1">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="156" y="592" as="sourcePoint" />
<mxPoint x="223.94399999999996" y="592" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="wNYtK6DitPIeJlGkPyxx-67" value="Time" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="288" y="612" width="60" height="30" as="geometry" />
</mxCell>
</root>
</mxGraphModel>
</diagram>
</mxfile>

156
docs/graphics-source/rollout_groups.drawio
View File

File diff suppressed because one or more lines are too long

92
docs/graphics-source/rollouts_load.drawio
View File

File diff suppressed because one or more lines are too long

BIN
docs/images/clustering_overview.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 73 KiB

After

Width:  |  Height:  |  Size: 54 KiB

BIN
docs/images/eventing-within-cluster.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 47 KiB

After

Width:  |  Height:  |  Size: 31 KiB

BIN
docs/images/hawkBit_overview.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 290 KiB

After

Width:  |  Height:  |  Size: 76 KiB

BIN
docs/images/hawkbit.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 14 KiB

20
docs/images/hawkbit.svg Normal file
View File

File diff suppressed because one or more lines are too long
Side by Side

After

Width:  |  Height:  |  Size: 11 KiB

BIN
docs/images/hawkbit_logo.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 118 KiB

After

Width:  |  Height:  |  Size: 34 KiB

30
docs/images/hawkbit_logo.svg Normal file
View File

File diff suppressed because one or more lines are too long
Side by Side

After

Width:  |  Height:  |  Size: 25 KiB

BIN
docs/images/packagemodel.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 22 KiB

After

Width:  |  Height:  |  Size: 22 KiB

BIN
docs/images/rollout_groups.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 52 KiB

After

Width:  |  Height:  |  Size: 27 KiB

BIN
docs/images/rollout_load.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 20 KiB

After

Width:  |  Height:  |  Size: 9.7 KiB

33
docs/index.html
View File

@@ -17,6 +17,7 @@ SPDX-License-Identifier: EPL-2.0
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<meta name="description" content="Description">
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
<link rel="icon" href="images/hawkbit.svg" type="image/svg+xml">
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css">
</head>
@@ -62,17 +63,39 @@ SPDX-License-Identifier: EPL-2.0
<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-http.min.js"></script>
<!-- Latest v2.x.x -->
<script src="https://unpkg.com/docsify-copy-code@2"></script>
<!-- Mermaid -->
<script src="//cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script>
<script src="//unpkg.com/docsify-mermaid@2.0.1/dist/docsify-mermaid.js"></script>
<script>mermaid.initialize({ startOnLoad: false, theme: 'default' });</script>
</body>
<script src="https://cdn.jsdelivr.net/npm/dompurify@3.1.6/dist/purify.min.js"></script>
<style>
.sidebar .sidebar-sep {
margin: 12px 0;
border: 0;
height: 1px;
background: #0ea5ea;
body, input {
background-color: #f0eeea;
}
.sidebar-sep {
margin: 12px 0;
border: 0;
height: 1px;
}
.sidebar, .sidebar-toggle, .sidebar ul li a {
background-color: #43464A;
color: #f0eeea;
}
.sidebar ul li.active>a {
color: #027abe;
}
.sidebar h1 {
font-weight: 700;
}
</style>
<style>

2
docs/what-is-hawkbit.md
View File

@@ -3,7 +3,7 @@
Eclipse **hawkBit™** is a domain-independent back-end framework for rolling out software updates to constrained edge devices as well as more powerful controllers and gateways connected to IP-based networking infrastructure.
<p align="center">
<img src="images/hawkbit_logo.png" alt="eclipse foundation logo" width="800">
<img src="images/hawkbit_logo.svg" alt="eclipse foundation logo" width="800">
</p>
---