-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathindex.html
630 lines (402 loc) · 15.9 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
<!DOCTYPE html>
<html class="no-js">
<head lang="en-us">
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,user-scalable=no,initial-scale=1,maximum-scale=1">
<meta http-equiv="X-UA-Compatible" content="IE=10" />
<title>Features - Eclipse hawkBit</title>
<meta name="generator" content="Hugo 0.124.1">
<meta name="description" content="IoT. Update. Device.">
<link rel="canonical" href="https://eclipse.dev/hawkbit/features/">
<meta name="author" content="The Eclipse hawkBit Project">
<meta property="og:url" content="https://eclipse.dev/hawkbit/features/">
<meta property="og:title" content="Eclipse hawkBit">
<meta property="og:image" content="https://eclipse.dev/hawkbit/images/hawkbit_icon.png">
<meta name="apple-mobile-web-app-title" content="Eclipse hawkBit">
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black-translucent">
<link rel="shortcut icon" type="image/x-icon" href="https://eclipse.dev/hawkbit/images/favicon.ico">
<link rel="icon" type="image/x-icon" href="https://eclipse.dev/hawkbit/images/favicon.ico">
<style>
@font-face {
font-family: 'Icon';
src: url('https://eclipse.dev/hawkbit/fonts/icon.eot?52m981');
src: url('https://eclipse.dev/hawkbit/fonts/icon.eot#iefix52m981')
format('embedded-opentype'),
url('https://eclipse.dev/hawkbit/fonts/icon.woff?52m981')
format('woff'),
url('https://eclipse.dev/hawkbit/fonts/icon.ttf?52m981')
format('truetype'),
url('https://eclipse.dev/hawkbit/fonts/icon.svg?52m981#icon')
format('svg');
font-weight: normal;
font-style: normal;
}
</style>
<link rel="stylesheet" href="https://eclipse.dev/hawkbit/stylesheets/application.css">
<link rel="stylesheet" href="https://eclipse.dev/hawkbit/stylesheets/temporary.css">
<link rel="stylesheet" href="https://eclipse.dev/hawkbit/stylesheets/palettes.css">
<link rel="stylesheet" href="https://eclipse.dev/hawkbit/stylesheets/highlight/highlight.css">
<link rel="stylesheet" href="//fonts.googleapis.com/css?family=Ubuntu:400,700|Ubuntu+Mono">
<style>
body, input {
font-family: 'Ubuntu', Helvetica, Arial, sans-serif;
}
pre, code {
font-family: 'Ubuntu Mono', 'Courier New', 'Courier', monospace;
}
</style>
<link rel="stylesheet" href="https://eclipse.dev/hawkbit/css/hawkbit.css">
<link rel="stylesheet" href="//www.eclipse.org/eclipse.org-common/themes/solstice/public/stylesheets/vendor/cookieconsent/cookieconsent.min.css">
<script src="https://eclipse.dev/hawkbit/javascripts/modernizr.js"></script>
<script src="//www.eclipse.org/eclipse.org-common/themes/solstice/public/javascript/vendor/cookieconsent/default.min.js"></script>
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.1.0/css/all.css" integrity="sha384-lKuwvrZot6UHsBSfcMvOkWwlCMgc0TaWr+30HWe3a4ltaBwTZhyTEggF5tJv8tbt" crossorigin="anonymous">
</head>
<body class="palette-primary-deep-purple palette-accent-light-green">
<div class="backdrop">
<div class="backdrop-paper"></div>
</div>
<input class="toggle" type="checkbox" id="toggle-drawer">
<input class="toggle" type="checkbox" id="toggle-search">
<label class="toggle-button overlay" for="toggle-drawer"></label>
<header class="header">
<nav aria-label="Header">
<div class="bar default">
<div class="button button-menu" role="button" aria-label="Menu">
<label class="toggle-button icon icon-menu" for="toggle-drawer">
<span></span>
</label>
</div>
<div class="stretch">
<div class="title">
Features
</div>
</div>
<div class="button button-github" role="button" aria-label="GitHub">
<a href="https://github.com/eclipse/hawkbit" title="@eclipse/hawkbit on GitHub" target="_blank" class="toggle-button icon icon-github"></a>
</div>
<div class="button button-github" role="button" aria-label="Gitter">
<a href="https://gitter.im/eclipse/hawkbit" title="@eclipse/hawkbit on Gitter" target="_blank" class="toggle-button icon fab fa-gitter"></a>
</div>
<div class="button button-github" role="button" aria-label="Docker">
<a href="https://hub.docker.com/u/hawkbit" title="hawkbit on Docker Hub" target="_blank" class="toggle-button icon fab fa-docker"></a>
</div>
</div>
<div class="bar search">
<div class="button button-close" role="button" aria-label="Close">
<label class="toggle-button icon icon-back" for="toggle-search"></label>
</div>
<div class="stretch">
<div class="field">
<input class="query" type="text" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck>
</div>
</div>
<div class="button button-reset" role="button" aria-label="Search">
<button class="toggle-button icon icon-close" id="reset-search"></button>
</div>
</div>
</nav>
</header>
<main class="main">
<div class="drawer">
<nav aria-label="Navigation">
<a href="https://eclipse.dev/hawkbit/" class="project">
<div class="banner">
<div class="logo">
<img src="https://eclipse.dev/hawkbit/images/hawkbit_icon.png">
</div>
<div class="name">
<strong>Eclipse hawkBit™ </strong>
<br>
eclipse-hawkbit/hawkbit
</div>
</div>
</a>
<div class="scrollable">
<div class="wrapper">
<ul class="repo" style="text-align: left; ; padding-left: 2em;">
<li class="repo-stars">
<a href="https://github.com/eclipse-hawkbit/hawkbit/stargazers" target="_blank" title="Stargazers" data-action="star">
<i class="icon icon-star"></i> Stars
<span class="count">–</span>
</a>
</li>
</ul>
<hr>
<div class="toc">
<ul>
<li>
<a title="What is hawkBit" href="/hawkbit/whatishawkbit/">
What is hawkBit
</a>
</li>
<li>
<a title="Getting started" href="/hawkbit/gettingstarted/">
Getting started
</a>
</li>
<li>
<a title="Guides" href="/hawkbit/guides/">
Guides
</a>
</li>
<li>
<a class="current" title="Features" href="/hawkbit/features/">
Features
</a>
<ul id="scrollspy">
</ul>
</li>
<li>
<a title="Concepts" href="/hawkbit/concepts/">
Concepts
</a>
</li>
<li>
<a title="Architecture" href="/hawkbit/architecture/">
Architecture
</a>
</li>
<li>
<a title="APIs" href="/hawkbit/apis/">
APIs
</a>
</li>
<li>
<a title="Release notes" href="/hawkbit/release-notes/">
Release notes
</a>
</li>
<li>
<a title="Blog" href="/hawkbit/blog/">
Blog
</a>
</li>
<li>
<a title="Community" href="/hawkbit/community/">
Community
</a>
</li>
</ul>
<hr>
<ul>
<li>
<a href="https://opensource.org/licenses/EPL-2.0" title="License" target="_blank">
<img src="https://img.shields.io/badge/License-EPL%202.0-green.svg" />
</a>
</li>
<li>
<a href="https://github.com/eclipse-hawkbit/hawkbit/actions/workflows/verify.yml" title="License" target="_blank">
<img src="https://github.com/eclipse-hawkbit/hawkbit/actions/workflows/verify.yml/badge.svg?branch=master" />
</a>
</li>
<li>
<a href="https://sonarcloud.io/summary/new_code?id=eclipse-hawkbit_hawkbit" title="Sonarcloud Status" target="_blank">
<img src="https://sonarcloud.io/api/project_badges/measure?project=eclipse-hawkbit_hawkbit&metric=alert_status" />
</a>
</li>
<li>
<a href="https://search.maven.org/search?q=g:org.eclipse.hawkbit" title="Maven Central Status" target="_blank">
<img src="https://img.shields.io/maven-central/v/org.eclipse.hawkbit/hawkbit-parent?label=maven-central&color=blue" />
</a>
</li>
<li>
<a href="https://gitter.im/eclipse/hawkbit?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge" title="Chat on Gitter" target="_blank">
<img src="https://badges.gitter.im/eclipse/hawkbit.svg" />
</a>
</li>
</ul>
</div>
</div>
</div>
</nav>
</div>
<article class="article">
<div class="wrapper">
<h1>Features </h1>
<h2 id="device-and-software-repository">Device and Software Repository</h2>
<ul>
<li>Repository that holds the provisioning targets and assignable software distributions.</li>
<li>Targets to be logically grouped by Target Types.</li>
<li>That includes a full software update history for every device.</li>
<li>Support for pre-commission devices in the repository and plug and play, i.e. device is created if it is authenticated
for the first time.</li>
</ul>
<h2 id="update-management">Update Management</h2>
<ul>
<li>Directly deploy a defined software distribution to a device (by Management API).</li>
<li>Update handling is independent of the device type, integration approach or connectivity.</li>
<li>Optional user consent flow, download and install updates only after respective end user has confirmed it.</li>
<li>Mass cancel the distribution of an update by invalidating the distribution set.</li>
<li>Use action status codes for easier analysis.</li>
</ul>
<h2 id="artifact-content-delivery">Artifact Content Delivery</h2>
<ul>
<li>Partial downloads supported.</li>
<li>Download resume supported (RFC7233).</li>
<li>Content management by RESTful API and UI (see above).</li>
<li>Authorization based on software assignment, i.e. a device can only download what has been assigned to it in the first
place.</li>
<li>Delta artifact hosting supported.</li>
<li>Artifact signature hosting supported.</li>
<li>Plug-point for artifact encryption allowing to encrypt artifacts on upload.</li>
</ul>
<h2 id="rolloutcampaign-management">Rollout/Campaign Management</h2>
<ul>
<li>Secure handling of large volumes of devices at rollout creation time.</li>
<li>Flexible deployment group definition as part of a rollout.</li>
<li>Monitoring of the rollout progress.</li>
<li>Emergency rollout shutdown in case of update failures.</li>
<li>Manually trigger next rollout group.</li>
</ul>
<h2 id="interfaces">Interfaces</h2>
<h3 id="management-api">Management API</h3>
<ul>
<li>RESTful API</li>
<li>Create/Read/Update/Delete operations for provisioning targets (i.e. devices) and repository content (i.e. software).</li>
<li>Manage and monitor software update operations.</li>
<li>Online API documentation.</li>
<li>JSON payload with Hypermedia support.</li>
<li>Supports filtering, sorting and paging.</li>
</ul>
<h3 id="direct-device-integration-api">Direct Device Integration API</h3>
<ul>
<li>RESTful HTTP based API for direct device integration
<ul>
<li>JSON payload.</li>
<li>Traffic optimized (content based Etag generation, not modified).</li>
</ul>
</li>
<li>Feedback channel from device.</li>
<li>TLS encryption.</li>
</ul>
<h3 id="device-management-federation-api">Device Management Federation API</h3>
<ul>
<li>Indirect device integration through a device management service or application into hawkBit.</li>
<li>Optimized for high service to service throughput with <a href="https://www.rabbitmq.com/amqp-0-9-1-reference.html">AMQP</a>
messaging interface.</li>
<li>Separate AMQP vHost per tenant for maximum security.</li>
</ul>
<aside class="copyright" role="note">
<div class="logo">
<a href="https://www.eclipse.org" target="_blank">
<img src="/hawkbit/images/eclipse_foundation_logo.png" />
</a>
</div>
<p class="notice">
© 2025 The Eclipse hawkBit Project –
Documentation built with
<a href="https://www.gohugo.io" target="_blank">Hugo</a>
using the
<a href="http://github.com/digitalcraftsman/hugo-material-docs" target="_blank">Material</a> theme.
</p>
<p class="quickLinks">
<a href="http://www.eclipse.org/legal/privacy.php" target="_blank">
> Privacy Policy
</a>
<a href="http://www.eclipse.org/legal/termsofuse.php" target="_blank">
> Terms of Use
</a>
<a href="http://www.eclipse.org/legal/copyright.php" target="_blank">
> Copyright Agent
</a>
<a href="http://www.eclipse.org/legal" target="_blank">
> Legal
</a>
<a href="https://www.eclipse.org/org/documents/epl-2.0/EPL-2.0.txt" target="_blank">
> License
</a>
</p>
</aside>
<footer class="footer">
<nav class="pagination" aria-label="Footer">
<div class="previous">
<a href="https://eclipse.dev/hawkbit/concepts/authentication/" title="Authentication">
<span class="direction">
Previous
</span>
<div class="page">
<div class="button button-previous" role="button" aria-label="Previous">
<i class="icon icon-back"></i>
</div>
<div class="stretch">
<div class="title">
Authentication
</div>
</div>
</div>
</a>
</div>
<div class="next">
<a href="https://eclipse.dev/hawkbit/guides/clustering/" title="Clustering">
<span class="direction">
Next
</span>
<div class="page">
<div class="stretch">
<div class="title">
Clustering
</div>
</div>
<div class="button button-next" role="button" aria-label="Next">
<i class="icon icon-forward"></i>
</div>
</div>
</a>
</div>
</nav>
</footer>
</div>
</article>
<div class="results" role="status" aria-live="polite">
<div class="scrollable">
<div class="wrapper">
<div class="meta"></div>
<div class="list"></div>
</div>
</div>
</div>
</main>
<script>
var base_url = 'https:\/\/eclipse.dev\/hawkbit\/';
var repo_id = 'eclipse-hawkbit\/hawkbit';
</script>
<script src="https://eclipse.dev/hawkbit/javascripts/application.js"></script>
<script>
/* Add headers to scrollspy */
var headers = document.getElementsByTagName("h2");
var scrollspy = document.getElementById('scrollspy');
if(scrollspy) {
if(headers.length > 0) {
for(var i = 0; i < headers.length; i++) {
var li = document.createElement("li");
li.setAttribute("class", "anchor");
var a = document.createElement("a");
if(!headers[i].id)
a.setAttribute("href", headers[i].parentNode.href);
else
a.setAttribute("href", "#" + headers[i].id);
a.setAttribute("title", headers[i].innerHTML);
a.innerHTML = headers[i].innerHTML;
li.appendChild(a);
scrollspy.appendChild(li);
}
} else {
scrollspy.parentElement.removeChild(scrollspy)
}
/* Add permanent link next to the headers */
var headers = document.querySelectorAll("h1, h2, h3, h4, h5, h6");
for(var i = 0; i < headers.length; i++) {
var a = document.createElement("a");
a.setAttribute("class", "headerlink");
a.setAttribute("href", "#" + headers[i].id);
a.setAttribute("title", "Permanent link");
a.innerHTML = "#";
headers[i].appendChild(a);
}
}
</script>
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.8.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</body>
</html>