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

Introduce new, Hugo templates based, website (#713)

Browse Source 
* Add new hugo-based website for hawkBit

Signed-off-by: Jeroen Laverman <jeroen.laverman@bosch-si.com>

* Fix broken links + wordings
- , i.e. -> i.e,
- , e.g. -> e.g.,
- hawkbit -> hawkBit
- don't -> do not
- isn't -> is not

Signed-off-by: Jeroen Laverman <jeroen.laverman@bosch-si.com>

* Remove old documentation and add maven integration

Signed-off-by: Jeroen Laverman <jeroen.laverman@bosch-si.com>

* Add Intellij files to ignore

Signed-off-by: Jeroen Laverman <jeroen.laverman@bosch-si.com>

* Update README

Signed-off-by: Jeroen Laverman <jeroen.laverman@bosch-si.com>

* Update Copyright header
* exclude website artifacts

Signed-off-by: Jeroen Laverman <jeroen.laverman@bosch-si.com>

* Harmonize usage of i.e. and e.g.

Signed-off-by: Jeroen Laverman <jeroen.laverman@bosch-si.com>

* Add remark for windows user

Signed-off-by: Jeroen Laverman <jeroen.laverman@bosch-si.com>

* Fix indention

Signed-off-by: Jeroen Laverman <jeroen.laverman@bosch-si.com>

* Introduce review findings

Signed-off-by: Jeroen Laverman <jeroen.laverman@bosch-si.com>

* Change image in 'run hawkbit' guide

Signed-off-by: Jeroen Laverman <jeroen.laverman@bosch-si.com>
This commit is contained in:
Jeroen Laverman
2018-08-01 11:01:02 +02:00
committed by Dominic Schabel
parent fa751c397b
commit f96876afe0
145 changed files with 1543 additions and 5832 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
.gitignore vendored
View File

@@ -11,6 +11,7 @@ target
.springbeans
.metadata
.project
.idea
# Windows image file caches
Thumbs.db
@@ -50,8 +51,17 @@ classpath-data.json
# Eclipse IDE
*.pydevproject
# Intellij
*.iml
# Maven
maven.properties
# Test Files
*.tmp
# Documentation
docs/themes/**
docs/public/**
docs/content/rest-api/*.html
.gitmodules

30
docs/README.md
View File

@@ -1,23 +1,25 @@
# Eclipse hawkBit Documentation
The hawkBit documentation is built with [Hugo](https://www.gohugo.io/) using the [Material](http://github.com/digitalcraftsman/hugo-material-docs)
theme. Compiling the documentation is not included within the regular Maven build.
## Prerequisites
1. **Install Hugo**: see [installing Hugo](https://gohugo.io/getting-started/installing/) documentation on how to install Hugo.
2. **Install hawkBit**: run `mvn install` in the parent directory to generate the latest REST docs for hawkBit.
The hawkBit documentation is based on [Jekyll](http://jekyllrb.com/). Jekyll is a Ruby gem and thus requires a Ruby runtime to be executed. Compiling the documentation is not included within the regular Maven build.
## Build and Serve documentation
The following Maven targets are available in order to build and serve the documentation:
### Unix / Mac
* `mvn install`: _i._ Copies the generated REST docs to `content/rest-api/` and _ii._ downloads the required Hugo theme
* `mvn site`: Serve the documentation on [localhost:1313/hawkbit/](localhost:1313/hawkbit/)
* `mvn clean`: Delete generated artifacts (REST docs, Hugo theme)
On a unix or mac you don't need to extra install Jekyll. The Maven build is downloading the ruby runtime and the necessary ruby-gems via the Maven rubygems-proxy repository. The Ruby runtime is downloaded into the `target` folder and executed during the build.
_Note: Currently, **only** Unix/macOS is supported! For Windows, use the hugo commands in CMD._
To serve the current documentation you only need to call `mvn install gem:exec@jekyll-serve` (within the `docs` folder). It automatically monitors the filesystem and every local changes are generated on-demand on the local server [http://127.0.0.1:4000/hawkbit/](http://127.0.0.1:4000/hawkbit/).
### Windows
## Generate /public folder
In order to generate the `/public` folder, which can be put on a web-server, run the following command:
On a Windows operating system you'll need to install Jekyll manually. If you don't have installed Jekyll on your machine you can use the [PortableJekyll](https://github.com/madhur/PortableJekyll) project. Just clone the Github repository and start the `setpath.cmd` which setups the necessary path entries into the CMD (don't forget to copy them into the environment path variable to have the path set for every command prompt).
The Maven build on windows just executes the `Jekyll` process using the maven-exec plugin. This allows to use Maven to build and serve the documentation on a windows machine as well.
To serve the current documentation you only need to call `mvn exec:exec@jekyll-serve`. It automatically monitors the filesystem and every local changes are generated on-demand on the local server [http://127.0.0.1:4000/hawkbit/](http://127.0.0.1:4000/hawkbit/).
## Test API docs integration
In order to verify the hawkbit-rest-docs integration you have to run the serve command above and when running call `mvn install`in parallel to include the generated rest docs into the serve run.
```bash
$ hugo
```

25
docs/cleanup.sh Normal file
View File

@@ -0,0 +1,25 @@
#
# Copyright (c) 2018 Bosch Software Innovations GmbH and others.
#
# All rights reserved. This program and the accompanying materials
# are made available under the terms of the Eclipse Public License v1.0
# which accompanies this distribution, and is available at
# http://www.eclipse.org/legal/epl-v10.html
#
# This script is used to clean up the previously generated or downloaded files.
#!/bin/bash
echo "[INFO] Remove Hugo Theme"
rm -rf themes resources public
echo "[INFO] ... done"
echo "[INFO] "
echo "[INFO] Remove generated REST docs"
rm -f content/rest-api/*.html
echo "[INFO] ... done"

107
docs/config.toml Executable file
View File

@@ -0,0 +1,107 @@
#
# Copyright (c) 2018 Bosch Software Innovations GmbH and others.
#
# All rights reserved. This program and the accompanying materials
# are made available under the terms of the Eclipse Public License v1.0
# which accompanies this distribution, and is available at
# http://www.eclipse.org/legal/epl-v10.html
#
baseurl = "https://www.eclipse.org/hawkbit/"
languageCode = "en-us"
title = "Eclipse hawkBit"
theme = "hugo-material-docs"
metadataformat = "toml"
canonifyurls = false
[params]
# General information
author = "The Eclipse hawkBit Project"
description = "IoT. Update. Device."
copyright = "The Eclipse hawkBit Project"
logo = "images/hawkbit_icon.png"
favicon = "images/favicon.ico"
# Repository
provider = "GitHub"
repo_url = "https://github.com/eclipse/hawkbit"
permalink = "#"
# Custom assets
custom_css = ["css/hawkbit.css","//www.eclipse.org/eclipse.org-common/themes/solstice/public/stylesheets/vendor/cookieconsent/cookieconsent.min.css"]
custom_js = []
# Syntax highlighting theme
highlight_css = ""
[params.palette]
primary = "deep-purple"
accent = "light-green"
[params.font]
text = "Ubuntu"
code = "Ubuntu Mono"
[social]
github = "eclipse/hawkbit"
gitter = "eclipse/hawkbit"
docker = "hawkbit"
[[menu.main]]
name = "What is hawkBit"
url = "/whatishawkbit/"
weight = 10
[[menu.main]]
name = "Getting started"
url = "/gettingstarted/"
weight = 20
[[menu.main]]
name = "Guides"
url = "/guides/"
weight = 30
[[menu.main]]
name = "Features"
url = "/features/"
weight = 40
[[menu.main]]
name = "Concepts"
url = "/concepts/"
weight = 50
[[menu.main]]
name = "Architecture"
url = "/architecture/"
weight = 60
[[menu.main]]
name = "Management UI"
url = "/ui/"
weight = 70
[[menu.main]]
name = "APIs"
url = "/apis/"
weight = 80
[[menu.main]]
name = "Community"
url = "/community/"
weight = 90
[[menu.main]]
name = "Release Notes"
url = "/release-notes/"
weight = 100
[blackfriday]
smartypants = true
fractions = true
smartDashes = true
plainIDAnchors = true

26
docs/src/main/resources/documentation/interfaces/ddi-api.md → docs/content/apis/ddi_api.md
View File

@@ -1,33 +1,33 @@
---
layout: documentation
title: DDI-API
title: Direct Device Integration API
parent: APIs
weight: 82
---
{% include base.html %}
This API is based on HTTP standards and based on a polling mechanism.
The _hawkbit_ [update server](https://github.com/eclipse/hawkbit) provides REST resources which are consumed by the device to retrieve software update tasks.
The hawkBit [update server](https://github.com/eclipse/hawkbit) provides REST resources which are consumed by the device to retrieve software update tasks.
Note: in DDI the target is identified using a **controllerId**. Controller is used as a term for the actual service/client on the device. That allows users to have in some cases even multiple clients on the same target for different tasks, e.g. Firmware update and App management.
{{% note %}}
In DDI the target is identified using a **controllerId**. Controller is used as a term for the actual service/client on the device. That allows users to have in some cases even multiple clients on the same target for different tasks, e.g. Firmware update and App management.
{{% /note %}}
# State Machine Mapping
## State Machine Mapping
For historical reasons the DDI has a different state machine and status messages than the [Target State Machine](../architecture/targetstate.html) of the _hawkBit_ update server.
For historical reasons the DDI has a different state machine and status messages than the [Target State Machine](../../concepts/targetstate/) of the hawkBit update server.
This is kept in order to ensure that _DDI_ stays compatible for devices out there in the field. A future version "2" of _DDI_ might change that. _DDI_ also defines more states than the update server, e.g. multiple DDI states are currently mapped by the _DDI_ implementation to _RUNNING_ state. It is possible that in the future _hawkBit_ will fully leverage these additional states.
This is kept in order to ensure that _DDI_ stays compatible for devices out there in the field. A future version "2" of _DDI_ might change that. _DDI_ also defines more states than the update server, e.g. multiple DDI states are currently mapped by the _DDI_ implementation to _RUNNING_ state. It is possible that in the future hawkBit will fully leverage these additional states.
The _DDI_ API allows the device to provide the following feedback messages:
DDI `status.execution` type | handling by update server | Mapped ActionStatus type
--------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -----------------------------------------------------
CANCELED | This is send by the target as confirmation of a cancelation request by the update server. | CANCELED
REJECTED | This is send by the target in case an update of a cancelation is rejected, i.e. cannot be fulfilled at this point in time. Note: the target should send a CLOSED->ERROR if it believes it will not be able to proceed the action at all. | WARNING
CANCELED | This is send by the target as confirmation of a cancellation request by the update server. | CANCELED
REJECTED | This is send by the target in case an update of a cancellation is rejected, i.e. cannot be fulfilled at this point in time. Note: the target should send a CLOSED->ERROR if it believes it will not be able to proceed the action at all. | WARNING
CLOSED | Target completes the action either with `status.result.finished` SUCCESS or FAILURE as result. Note: DDI defines also a status NONE which will not be interpreted by the update server and handled like SUCCESS. | ERROR (DDI FAILURE) or FINISHED (DDI SUCCESS or NONE)
PROCEEDING | This can be used by the target to inform that it is working on the action. | RUNNING
SCHEDULED | This can be used by the target to inform that it scheduled on the action. | RUNNING
RESUMED | This can be used by the target to inform that it continued to work on the action. | RUNNING
# Resource Overview
<iframe src="../../rest-api/rootcontroller-api-guide.html"></iframe>
<iframe width="100%" height="800px" frameborder="0" src="../../rest-api/rootcontroller-api-guide/"></iframe>

123
docs/src/main/resources/documentation/interfaces/dmf-api.md → docs/content/apis/dmf_api.md
View File

@@ -1,11 +1,11 @@
---
layout: documentation
title: DMF-API
title: Device Management Federation API
parent: API
weight: 83
---
{% include base.html %}
Currently bodies of messages are based on JSON. The DMF API provides java classes which allows that the message body can be deserialized at runtime into a java object. Also java classes can be used to serialize java objects into JSON bodies to send a message to _hawkBit_.
Currently bodies of messages are based on JSON. The DMF API provides java classes which allows that the message body can be deserialized at runtime into a java object. Also java classes can be used to serialize java objects into JSON bodies to send a message to hawkBit.
<!--more-->
## Basics
@@ -22,9 +22,9 @@ Queues can also be bound to multiple exchanges.
**Exchanges** are just publish messages.
The user decides who can produce on an exchange and who can create bindings on that exchange for delivery to a specific queue.
_hawkBit_ will create all necessary queues, exchanges and bindings for the user, making it easy to get started.
hawkBit will create all necessary queues, exchanges and bindings for the user, making it easy to get started.
The exchange name for outgoing messages is **dmf.exchange**.
The queue name for incoming messages is **sp_direct_queue**. Unless a ``reply_to`` header is set, _hawkBit_ will reply on the **sp.direct.exchange** which is bound to the **sp_direct_queue**.
The queue name for incoming messages is **sp_direct_queue**. Unless a ``reply_to`` header is set, hawkBit will reply on the **sp.direct.exchange** which is bound to the **sp_direct_queue**.
The user can set a ``reply_to`` header (see chapter below), to change the default sender exchange.
@@ -32,7 +32,7 @@ The following chapter describes the message body, header and properties.
Note: the DMF protocol was intended to be open for other non update use cases by design (e.g. [Eclipse Hono](https://github.com/eclipse/hono). As a result, DMF uses the term **thing** and not **target** but they are actually synonyms in this case.
## Messages sent to _hawkBit_
## Messages sent to hawkBit
All messages have to be sent to the exchange **dmf.exchange**.
### Message to register a thing
@@ -52,8 +52,8 @@ All messages have to be sent to the exchange **dmf.exchange**.
**Example Header**
| Headers | MessageProperties |
|---------------------------------------|---------------------------------|
| Headers | MessageProperties
|---------------------------------------|---------------------------------
| type=THING\_CREATED <br /> tenant=tenant123 <br /> thingId=abc <br /> sender=Lwm2m | content\_type=application/json <br /> reply_to (optional) =sp.connector.replyTo
@@ -74,8 +74,8 @@ All messages have to be sent to the exchange **dmf.exchange**.
**Example Header and Payload**
| Headers | MessageProperties |
|---------------------------------------|---------------------------------|
| Headers | MessageProperties
|---------------------------------------|---------------------------------
| type=EVENT <br /> tenant=tenant123 <br /> thingId=abc <br /> topic=UPDATE\_ATTRIBUTES | content\_type=application/json <br />
Payload Template
@@ -89,7 +89,7 @@ Payload Template
}
```
### Message to send an action status event to _hawkBit_
### Message to send an action status event to hawkBit
The Java representation is ActionUpdateStatus:
@@ -107,39 +107,39 @@ Payload Template
```json
{
"actionId": long,
"softwareModuleId": long,
"actionStatus":"String",
"message":["String"]
"actionId": long,
"softwareModuleId": long,
"actionStatus":"String",
"message":["String"]
}
```
Possible actionStatus
| Header | Description |
|-----------------|------------------------------------|
| DOWNLOAD | Device is downloading |
| RETRIEVED | Device management service has retrieved something |
| RUNNING | Update is running |
| FINISHED | Update process finished successful |
| ERROR | Error during update process |
| WARNING | Warning during update process |
| CANCELED | Cancel update process successful |
| CANCEL_REJECTED | Cancel update process has been rejected |
| Header | Description
|-----------------|------------------------------------
| DOWNLOAD | Device is downloading
| RETRIEVED | Device management service has retrieved something
| RUNNING | Update is running
| FINISHED | Update process finished successful
| ERROR | Error during update process
| WARNING | Warning during update process
| CANCELED | Cancel update process successful
| CANCEL_REJECTED | Cancel update process has been rejected
**Example Header and Payload**
| Headers | MessageProperties |
|---------------------------------------|---------------------------------|
| Headers | MessageProperties
|---------------------------------------|---------------------------------
| type=EVENT <br /> tenant=tenant123 <br /> topic=UPDATE\_ACTION\_STATUS | content_type=application/json
```json
{
"actionId":137,
"softwareModuleId":17,
"actionStatus":"DOWNLOAD",
"message":["The download has started"]
"actionId":137,
"softwareModuleId":17,
"actionStatus":"DOWNLOAD",
"message":["The download has started"]
}
```
@@ -160,19 +160,19 @@ Payload Template
```json
{
"actionId": long
"actionId": long
}
```
**Example Header and payload**
| Headers | MessageProperties |
|---------------------------------------|---------------------------------|
| Headers | MessageProperties
|---------------------------------------|---------------------------------
| type=EVENT <br /> tenant=tenant123 <br /> thingId=abc <br /> topic=CANCEL\_DOWNLOAD | content_type=application/json
```json
{
"actionId":137
"actionId":137
}
```
@@ -180,37 +180,37 @@ After this message has been sent, an action status event with either actionStatu
**Example Header and Payload when cancellation is successful**
| Headers | MessageProperties |
|---------------------------------------|---------------------------------|
| Headers | MessageProperties
|---------------------------------------|---------------------------------
| type=EVENT <br /> tenant=tenant123 <br /> topic=UPDATE\_ACTION\_STATUS | content_type=application/json
```json
{
"actionId":137,
"softwareModuleId":17,
"actionStatus":"CANCELED",
"message":["The update was canceled."]
"actionId":137,
"softwareModuleId":17,
"actionStatus":"CANCELED",
"message":["The update was canceled."]
}
```
**Example Header and Payload when cancellation was rejected**
| Headers | MessageProperties |
|---------------------------------------|---------------------------------|
| Headers | MessageProperties
|---------------------------------------|---------------------------------
| type=EVENT <br /> tenant=tenant123 <br /> topic=UPDATE\_ACTION\_STATUS | content_type=application/json
```json
{
"actionId":137,
"softwareModuleId":17,
"actionStatus":"CANCEL_REJECTED",
"message":["The cancellation was not possible since the target sent an unexpected response."]
"actionId":137,
"softwareModuleId":17,
"actionStatus":"CANCEL_REJECTED",
"message":["The cancellation was not possible since the target sent an unexpected response."]
}
```
## Messages sent by _hawkBit_
All messages from _hawkBit_ will be sent to the **sp_direct_queue** or the one specified in the ``reply_to`` property.
## Messages sent by hawkBit
All messages from hawkBit will be sent to the **sp_direct_queue** or the one specified in the ``reply_to`` property.
### Message sent by _hawkBit_ to initialize an update task
### Message sent by hawkBit to initialize an update task
| Header | Description | Type | Mandatory
@@ -232,9 +232,9 @@ Payload Template
```json
{
"actionId": long,
"targetSecurityToken": "String",
"softwareModules":[
"actionId": long,
"targetSecurityToken": "String",
"softwareModules":[
{
"moduleId": long,
"moduleType":"String",
@@ -264,15 +264,16 @@ Payload Template
**Example Header and Payload**
| Headers | MessageProperties |
|---------------------------------------|---------------------------------|
| Headers | MessageProperties
|---------------------------------------|---------------------------------
| type=EVENT <br /> tenant=tenant123 <br /> thingId=abc <br /> topic=DOWNLOAD\_AND\_INSTALL | content_type=application/json
```json
"actionId":137,
"targetSecurityToken":"bH7XXAprK1ChnLfKSdtlsp7NOlPnZAYY",
"softwareModules":[
{
{
"actionId":137,
"targetSecurityToken":"bH7XXAprK1ChnLfKSdtlsp7NOlPnZAYY",
"softwareModules":[{
"moduleId":7,
"moduleType":"firmware",
"moduleVersion":"7.7.7",

42
docs/src/main/resources/documentation/interfaces/management-api.md → docs/content/apis/management_api.md
View File

@@ -1,21 +1,19 @@
---
layout: documentation
title: Management-API
title: Management API
parent: API
weight: 81
---
{% include base.html %}
The Management API is a RESTful API that enables to perform Create/Read/Update/Delete operations for provisioning targets (i.e. devices) and repository content (i.e. software).
<!--more-->
# Management API
## Overview
The Management API is a RESTful API that enables to perform Create/Read/Update/Delete operations for provisioning targets (i.e. devices) and repository content (i.e. software). Based on the Management API you can manage and monitor software update operations via HTTP/HTTPS. The _Management API_ supports JSON payload with hypermedia as well as filtering, sorting and paging. Furthermore the Management API provides permission based access control and standard roles as well as custom role creation.
Based on the Management API you can manage and monitor software update operations via HTTP/HTTPS. The _Management API_ supports JSON payload with hypermedia as well as filtering, sorting and paging. Furthermore the Management API provides permission based access control and standard roles as well as custom role creation.
The API is protected and needs authentication and authorization based on the security concept.
## API Version
_hawkBit_ provides an consistent Management API interface that guarantees backwards compatibility for future releases by version control.
hawkBit provides an consistent Management API interface that guarantees backwards compatibility for future releases by version control.
The current version of the Management API is `version 1 (v1)` with the URI http://localhost:8080/rest/v1/
@@ -30,16 +28,16 @@ Supported HTTP-methods are:
Available Management APIs resources are:
- [Targets](managementapi/targets.html)
- [Distribution sets](managementapi/distributionsets.html)
- [Distribution set types](managementapi/distributionsettypes.html)
- [Software modules](managementapi/softwaremodules.html)
- [Software module types](managementapi/softwaremoduletypes.html)
- [Target tag](managementapi/targettag.html)
- [Distribution set tag](managementapi/distributionsettag.html)
- [Rollouts](managementapi/rollouts.html)
- [Target filters](managementapi/targetfilters.html)
- [System configuration](managementapi/tenant.html)
- [Targets](/hawkbit/apis/mgmt/targets/)
- [Distribution sets](/hawkbit/apis/mgmt/distributionsets/)
- [Distribution set types](/hawkbit/apis/mgmt/distributionsettypes/)
- [Software modules](/hawkbit/apis/mgmt/softwaremodules/)
- [Software module types](/hawkbit/apis/mgmt/softwaremoduletypes/)
- [Target tag](/hawkbit/apis/mgmt/targettag/)
- [Distribution set tag](/hawkbit/apis/mgmt/distributionsettag/)
- [Rollouts](/hawkbit/apis/mgmt/rollouts/)
- [Target filters](/hawkbit/apis/mgmt/targetfilters/)
- [System configuration](/hawkbit/apis/mgmt/tenant/)
## Headers
@@ -49,7 +47,7 @@ For all requests an `Authorization` header has to be set.
* Username: `Tenant\username`
* Password: `password`
Also have a look to the [Security](../security/security.html) chapter.
Also have a look to the [Security](../../concepts/authentication/) chapter.
In addition, for POST and PUT requests the `Content-Type` header has to be set. Accepted content-types are.
@@ -63,7 +61,7 @@ Besides the relevant data (name, description, createdBy etc.) of a resource enti
A _Distribution Set_ entity may have for example URIs to artifacts, _Software Modules_, _Software Module Types_ and metadata.
{% highlight json %}
```json
"_links": {
"artifacts": {
"href": "http://localhost:8080/rest/v1/softwaremodules/83/artifacts"
@@ -77,4 +75,4 @@ A _Distribution Set_ entity may have for example URIs to artifacts, _Software Mo
"metadata": {
"href": "http://localhost:8080/rest/v1/softwaremodules/83/metadata?offset=0&limit=50"
}
{% endhighlight %}
```

0
docs/content/apis/mgmt/_index.md Normal file
View File

7
docs/content/apis/mgmt/distributionsets.md Normal file
View File

@@ -0,0 +1,7 @@
---
title: Distribution Sets API
parent: Management API
weight: -101
---
<iframe width="100%" height="800px" frameborder="0" src="../../../rest-api/distributionsets-api-guide/"></iframe>

7
docs/content/apis/mgmt/distributionsettag.md Normal file
View File

@@ -0,0 +1,7 @@
---
title: Distribution Set Tag API
parent: Management API
weight: -105
---
<iframe width="100%" height="800px" frameborder="0" src="../../../rest-api/distributionsettag-api-guide/"></iframe>

7
docs/content/apis/mgmt/distributionsettypes.md Normal file
View File

@@ -0,0 +1,7 @@
---
title: Distribution Set Types API
parent: Management API
weight: -102
---
<iframe width="100%" height="800px" frameborder="0" src="../../../rest-api/distributionsettypes-api-guide/"></iframe>

7
docs/content/apis/mgmt/rollouts.md Normal file
View File

@@ -0,0 +1,7 @@
---
title: Rollouts API
parent: Management API
weight: -106
---
<iframe width="100%" height="800px" frameborder="0" src="../../../rest-api/rollout-api-guide/"></iframe>

7
docs/content/apis/mgmt/softwaremodules.md Normal file
View File

@@ -0,0 +1,7 @@
---
title: Software Modules API
parent: Management API
weight: -103
---
<iframe width="100%" height="800px" frameborder="0" src="../../../rest-api/softwaremodules-api-guide/"></iframe>

7
docs/content/apis/mgmt/softwaremoduletypes.md Normal file
View File

@@ -0,0 +1,7 @@
---
title: Software Module Types API
parent: Management API
weight: -100
---
<iframe width="100%" height="800px" frameborder="0" src="../../../rest-api/softwaremoduletypes-api-guide/"></iframe>

7
docs/content/apis/mgmt/targetfilters.md Normal file
View File

@@ -0,0 +1,7 @@
---
title: Target Filters API
parent: Management API
weight: -107
---
<iframe width="100%" height="800px" frameborder="0" src="../../../rest-api/targetfilters-api-guide/"></iframe>

7
docs/content/apis/mgmt/targets.md Normal file
View File

@@ -0,0 +1,7 @@
---
title: Targets API
parent: Management API
weight: -100
---
<iframe width="100%" height="800px" frameborder="0" src="../../../rest-api/targets-api-guide/"></iframe>

7
docs/content/apis/mgmt/targettag.md Normal file
View File

@@ -0,0 +1,7 @@
---
title: Target Tag API
parent: Management API
weight: -104
---
<iframe width="100%" height="800px" frameborder="0" src="../../../rest-api/targettag-api-guide/"></iframe>

7
docs/content/apis/mgmt/tenant.md Normal file
View File

@@ -0,0 +1,7 @@
---
title: System Configuration API
parent: Management API
weight: -108
---
<iframe width="100%" height="800px" frameborder="0" src="../../../rest-api/tenant-api-guide/"></iframe>

7
docs/content/architecture.md Normal file
View File

@@ -0,0 +1,7 @@
---
title: Architecture
weight: 60
---
Overview of hawkBit modules and used 3rd party technology:
![](../images/architecture/architecture.png)

35
docs/content/community.md Executable file
View File

@@ -0,0 +1,35 @@
---
title: Community
weight: 90
---
## Presentations
Here you can find links to arbitrary material covering Eclipse hawkBit which has been presented at events, conferences and meet-ups.
- 09/23/2015 - Eclipse IoT Working Group meeting - [slides](https://docs.bosch-iot-rollouts.com/slides/hawkBitProposal20150923.html)
- 04/11/2015 - EclipseCon Europe 2015 - [slides](https://docs.bosch-iot-rollouts.com/slides/eclipseCon2015.html)
- 03/09/2016 - EclipseCon North America 2016 - [slides](https://docs.bosch-iot-rollouts.com/slides/eclipseConNA2016.html)
- 05/16/2016 - Eclipse Virtual IoT Meetup - [video](https://www.youtube.com/watch?v=g-dhKMaaanE) - [slides](https://docs.bosch-iot-rollouts.com/slides/virtualIoTMeetup2016.html)
- 03/20/2017 - Eclipse IoT Day SanJose, CA - [video](https://www.youtube.com/watch?v=x5OfBgnYW44) - [slides](https://docs.bosch-iot-rollouts.com/slides/iotDaySanJose2017.pdf)
- 09/12/2017 - Eclipse IoT Day ThingMonk 2017 - [video](https://www.youtube.com/watch?v=7hK-kiQjKGA)
- 01/10/2018 - Eclipse Virtual IoT Meetup - [video](https://www.youtube.com/watch?v=8vcLXs9lc-4) - [slides](https://docs.bosch-iot-rollouts.com/slides/hawkBitIntroduction.html)
## Articles
- 10/27/2015 - Why software provisioning goes open source - [article](http://blog.bosch-si.com/categories/technology/2015/10/software-provisioning-goes-open-source-find/)
- 05/25/2016 - jaxenter: Eclipse hawkBit - [english](https://jaxenter.com/eclipse-hawkbit-126445.html) - [german](https://jaxenter.de/eclipse-hawkbit-46372)
- 09/27/2016 - Eclipse Newsletter - 'IoT is the new black' - [article](http://www.eclipse.org/community/eclipse_newsletter/2016/september/article2.php)
## Chat
Questions? Problems? Searching for a quick response from the team behind hawkBit and from the hawkBit community, join the [Gitter Chat](https://gitter.im/eclipse/hawkbit).
## Mailing List
A great way to stay up to date with hawkBit activity is to subscribe to the Mailing list provided by Eclipse. Sign up for the mailing list [here](https://dev.eclipse.org/mailman/listinfo/hawkbit-dev).
## Issue Tracker
Issues and bugs related to hawkBit are tracked with the Github Issue tracking system. If you find any issues, please report them [here](https://github.com/eclipse/hawkbit/issues).
## Contributing
An overview of the contribution process is [here](https://wiki.eclipse.org/Development_Resources/Contributing_via_Git). Checkout the [Contribution Guidelines](https://github.com/eclipse/hawkbit/blob/master/CONTRIBUTING.md) on the Eclipse hawkBit GitHub Repository.

73
docs/content/concepts/authentication.md Normal file
View File

@@ -0,0 +1,73 @@
---
title: Authentication
parent: Concepts
weight: 51
---
A hawkBit update server can be accessed in four different ways:
- _Direct Device Integration (DDI) API_ by **targets**.
- _Management API_ by 3rd party **applications**.
- _Device Management Federation (DMF) API_ by 3rd party **applications** through AMQP.
- _Management UI_ by **users**.
<!--more-->
## DDI API Authentication Modes
### Security Token
hawkBit supports multiple ways to authenticate a target against the server. The different authentication modes can be individual enabled and disabled within hawkBit. Both on system level (with Spring Boot properties) as per individual tenant.
#### Target Security Token Authentication
There is a 32 alphanumeric character security-token for each created target within IoT hawkBit. This token can be used to authenticate the target at hawkBit through the HTTP-Authorization header with the custom scheme _TargetToken_.
```
GET /SPDEMO/controller/v1/0e945f95-9117-4500-9b0a-9c6d72fa6c07 HTTP/1.1
Host: your.hawkBit.server
Authorization: TargetToken bH7XXAprK1ChnLfKSdtlsp7NOlPnZAYY
```
The target security token is provided in [DMF API](../../apis/dmf_api/) as part of the update message in order to allow DMF clients to leverage the feature or can it be manually retrieved per target by [Management API](../../apis/management_api/) or in the [Management UI](../../ui) in the target details.
Note: needs to be enabled in your hawkBit installation **and** in the tenant configuration. That allows both the operator as well as the individual customer (if run in a multi-tenant setup) to enable this access method. See [DdiSecurityProperties](https://github.com/eclipse/hawkbit/blob/master/hawkbit-security-core/src/main/java/org/eclipse/hawkbit/security/DdiSecurityProperties.java) for system wide enablement.
The additional activation for the individual tenant:
![Enable Target Token](../../images/security/targetToken.png)
#### Gateway Security Token Authentication
Often the targets are connected through a gateway which manages the targets directly and as a result are indirectly connected to the hawkBit update server.
To authenticate this gateway and allow it to manage all target instances under its tenant there is a _GatewayToken_ to authenticate this gateway through the HTTP-Authorization header with a custom scheme _GatewayToken_. This is of course also handy during development or for testing purposes. However, we generally recommend to use this token with care as it allows to act _in the name of_ any device.
```
GET /SPDEMO/controller/v1/0e945f95-9117-4500-9b0a-9c6d72fa6c07 HTTP/1.1
Host: your.hawkBit.server
Authorization: GatewayToken 3nkswAZhX81oDtktq0FF9Pn0Tc0UGXPW
```
Note: needs to be enabled in your hawkBit installation **and** in the tenant configuration. That allows both the operator as well as the individual customer (if run in a multi-tenant setup) to enable this access method. See [DdiSecurityProperties](https://github.com/eclipse/hawkbit/blob/master/hawkbit-security-core/src/main/java/org/eclipse/hawkbit/security/DdiSecurityProperties.java) for system wide enablement.
The additional activation for the individual tenant:
![Enable Gateway Token](../../images/security/gatewayToken.png)
#### Anonymous access
Here we offer general anonymous access for all targets (see [DdiSecurityProperties](https://github.com/eclipse/hawkbit/blob/master/hawkbit-security-core/src/main/java/org/eclipse/hawkbit/security/DdiSecurityProperties.java)) which we consider not really sufficient for a production system but it might come in handy to get a project started in the beginning.
However, anonymous download on the other side might be interesting even in production for scenarios where the artifact itself is already encrypted.
The activation for the individual tenant:
![Enable Anonymous Download](../../images/security/anonymousDownload.png)
## DMF API
Authentication is provided by _RabbitMQ_ [vhost and user credentials](https://www.rabbitmq.com/access-control.html) that is used for the integration.
## Management API
- Basic Auth
## Management UI
- Login Dialog

62
docs/content/concepts/authorization.md Normal file
View File

@@ -0,0 +1,62 @@
---
title: Authorization
parent: Concepts
weight: 52
---
Authorization is handled separately for _Direct Device Integration (DDI) API_ and _Device Management Federation (DMF) API_ (where successful authentication includes full authorization) and _Management API_ and _UI_ which is based on Spring security [authorities](https://github.com/eclipse/hawkbit/blob/master/hawkbit-security-core/src/main/java/org/eclipse/hawkbit/im/authentication/SpPermission.java).
<!--more-->
However, keep in mind that hawkBit does not offer an off the shelf authentication provider to leverage these permissions and the underlying multi user/tenant capabilities of hawkBit. Check out [Spring security documentation](http://projects.spring.io/spring-security/) for further information. In hawkBit [SecurityAutoConfiguration](https://github.com/eclipse/hawkbit/blob/master/hawkbit-autoconfigure/src/main/java/org/eclipse/hawkbit/autoconfigure/security/SecurityAutoConfiguration.java) is a good starting point for integration.
The default implementation is single user/tenant with basic auth and the logged in user is provided with all permissions.
## DDI API
An authenticated target is permitted to:
- retrieve commands from the server
- provide feedback to the the server
- download artifacts that are assigned to it
A target might be permitted to download artifacts without authentication (if enabled, see above). Only the download can be permitted to disable the authentication. This can be used in scenarios where the artifacts itself are e.g. signed and secured.
## Management API and UI
### Delivered Permissions
- READ_/UPDATE_/CREATE_/DELETE_TARGETS for:
- Target entities including metadata (that includes also the installed and assigned distribution sets)
- Target tags
- Target actions
- Target registration rules
- Bulk operations
- Target filters
- READ_/UPDATE_/CREATE_/DELETE_REPOSITORY for:
- Distribution sets
- Software Modules
- Artifacts
- DS tags
- READ_TARGET_SECURITY_TOKEN
- Permission to read the target security token. The security token is security concerned and should be protected.
- DOWNLOAD_REPOSITORY_ARTIFACT
- Permission to download artifacts of an software module (Note: READ_REPOSITORY allows only to read the metadata).
- TENANT_CONFIGURATION
- Permission to administrate the tenant settings.
- ROLLOUT_MANAGEMENT
- Permission to provision targets through rollouts.
### Permission Matrix for example uses cases that need more than one permission
Use Case | Needed permissions
-------------------------------------------------------------------------- | --------------------------------------------------
Search _targets_ by installed or assigned _distribution set_ | READ_TARGET, READ_REPOSITORY
Assign _DS_ to a _target_ | READ_REPOSITORY, UPDATE_TARGET
Assign DS to target through a _Rollout_, i.e. _Rollout_ creation and start | READ_REPOSITORY, UPDATE_TARGET, ROLLOUT_MANAGEMENT
Read _Rollout_ status including its _deployment groups_ | ROLLOUT_MANAGEMENT
Checks _targets_ inside _Rollout deployment group_ | READ_TARGET, ROLLOUT_MANAGEMENT
## Device Management Federation API
The provided _RabbitMQ_ [vhost and user](https://www.rabbitmq.com/access-control.html) should be provided with the necessary permissions to send messages to hawkBit through the exchange and receive messages from it through the specified queue.

18
docs/src/main/resources/documentation/architecture/datamodel.md → docs/content/concepts/datamodel.md
View File

@@ -1,21 +1,21 @@
---
layout: documentation
title: Data Model
parent: Concepts
weight: 53
---
{% include base.html %}
# Data Model
The hawkBit data model was designed to have enough flexibility to define complex software structures (e.g. operating system, runtimes, apps, different kind of artifacts) on one side and simplicity compared to the capabilities of a full blown configuration management on the other.
<!--more-->
It does define a hierarchy of software that starts with a distribution, which can have (sub-)modules and these may have multiple artifacts. However, it does not consider any kind of dependency definitions between modules or artifacts. As a result dependency checks if necessary have to be done outside hawkBit, i.e. on the device itself or before the entity creation in hawkBit by the origin.
Provisioning Target Definition
## Provisioning Target Definition
A Provisioning Target is a neutral definition that may be an actual real device (e.g. gateway, embedded sensor) or a virtual device (e.g. vehicle, smart home).
The definition in hawkBit might reflect the transactional behavior if necessary on the device side. A vehicle might be updated device by device or as a whole. As a result one way of defining a vehicle in hawkBit could be to have one all inclusive Software Module or one module per (sub-) device.
Software Structure Definition
## Software Structure Definition
The structure defines the model of the supported software by the provisioning target
@@ -32,16 +32,18 @@ Artifact: binaries for a software module. Note: the decision which artifacts hav
e.g. Full package, signatures, binary deltas
Entity Relationships
## Entity Relationships
The public defined entities and their relation which are reflected by the Management API.
Deleting and Archiving Software Modules
## Deleting and Archiving Software Modules
When a user deletes a Software Module, the update server cannot simply remove all the corresponding data. Because when the Software Module is already assigned to a Distribution Set or was assigned to a Target in the past, the hawkBit server has to make sure that remains a clean and full update history for every target. The history contains all information (e.g. name, version) of the software, which was assigned to a specific Target. Obviously storing the binary data of the artifacts is not necessary for the history purpose.
The delete process which is performed, when there are historical connections to targets is called SoftDelete. This process marks the Software Module as deleted and removes the artifact, but it won't delete the meta data, which describes the SoftwareModule and the associated Artifacts. SoftwareModules, which are marked as delete won't be visible for the user, when he is requesting all SoftwareModules.
Just in case there are no connections to Distribution Sets and targets the server will perform a HardDelete. This process deletes all stored data, including all meta information.
Note: in case of of a SoftDelete the unique constraints are still in place, i.e. you cannot create an entity with the same name/key. This constraint might be removed in future versions because of the impact on the user experience (i.e. he does not see the soft deleted module but cannot create a new one).
{{% note %}}
In case of of a SoftDelete the unique constraints are still in place, i.e. you cannot create an entity with the same name/key. This constraint might be removed in future versions because of the impact on the user experience (i.e. he does not see the soft deleted module but cannot create a new one).
{{% /note %}}

14
docs/src/main/resources/documentation/architecture/rollout-management.md → docs/content/concepts/rollout-management.md
View File

@@ -1,14 +1,14 @@
---
layout: documentation
title: Rollout Management
parent: Concepts
weight: 54
---
{% include base.html %}
Software update operations in large scale IoT scenarios with hundreds of thousands of devices require special handling.
<!--more-->
That includes:
- _Technical Scalability_ by means of horizontal scale of the _hawkBit_ server cluster in the cloud.
- _Technical Scalability_ by means of horizontal scale of the hawkBit server cluster in the cloud.
- _Global_ artifact _content delivery_ capacities.
- _Functional Scalability_ by means of:
- Secure handling of large volumes of devices at rollout creation time.
@@ -17,7 +17,7 @@ That includes:
- Reporting capabilities for a complete understanding of the rollout progress at each point in time.
Eclipse _hawkBit_ sees these capabilities under the term Rollout Management.
Eclipse hawkBit sees these capabilities under the term Rollout Management.
The following capabilities are currently supported by the _Rollout Management_:
- Create, update and start of rollouts.
@@ -43,7 +43,7 @@ The cascading execution of the deployment groups is based on two thresholds that
## Rollout state machine
### State Machine on Rollout
![](../images/rolloutstatediagram.png){:width="100%" .image-center}
![](../../images/rolloutstatediagram.png)
### State Machine on Rollout Deployment Group
![](../images/rolloutgroupstatediagram.png){:width="100%" .image-center}
![](../../images/rolloutgroupstatediagram.png)

14
docs/src/main/resources/documentation/architecture/targetstate.md → docs/content/concepts/targetstate.md
View File

@@ -1,15 +1,13 @@
---
layout: documentation
title: Target State Machine
parent: Concepts
weight: 55
---
{% include base.html %}
# Target States
A target has a current state which reflects the provisioning status of the device at this point in time. State changes are driven either by the update server by means of starting an update or by the controller on the provisioning target that gives feedback to the update server, e.g. "I am here", "I am working on a provisioning", "I have finished a provisioning".
<!--more-->
# Defined states
## Defined states
State | Description
---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------
@@ -19,5 +17,5 @@ PENDING | Installation of assigned _Distribution Set_ is not yet confirmed.
ERROR | Installation of assigned _Distribution Set_ has failed.
REGISTERED | Target registered at the update server but no _Distribution Set_ assigned. Is the initial starting point for plug-and-play devices.
# Transitions
![](../images/architecture/targetStatusStates.png){:width="100%"}
## Transitions
![](../../images/architecture/targetStatusStates.png)

16
docs/src/main/resources/documentation/overview/features.md → docs/content/features.md
View File

@@ -1,22 +1,19 @@
---
layout: documentation
title: Features
weight: 40
---
{% include base.html %}
# Feature overview
### Device and software repository
## Device and software repository
- Repository that holds the provisioning targets and assignable software distributions.
- That includes a full software update history for every device.
- 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.
### Update Management
## Update Management
- Directly deploy a defined software distribution to a device (by Management UI or API).
- Update handling is independent of the device type, integration approach or connectivity.
### Management UI/Console
## Management UI
- Create/Read/Update/Delete operations for provisioning targets (i.e. devices) and repository content (i.e. software).
- Manage and monitor software update operations.
- Optimized for professional users, e.g. administrators, developers and 2nd/3rd level support staff.
@@ -28,7 +25,7 @@ title: Features
- All information on one page.
- Optional integration with Bosch IoT Permissions service for full multi user support with fine granular permission based authorization.
### Artifact Content Delivery
## Artifact Content Delivery
- Partial downloads supported.
- Download resume supported (RFC7233).
- Content management by RESTful API and UI (see above).
@@ -36,13 +33,14 @@ title: Features
- Delta artifact hosting supported.
- Artifact signature hosting supported.
### Rollout/Campaign Management
## Rollout/Campaign Management
- Secure handling of large volumes of devices at rollout creation time.
- Flexible deployment group definition as part of a rollout.
- Monitoring of the rollout progress.
- Emergency rollout shutdown in case of update failures.
## Interfaces
### Management API
- RESTful API
- Create/Read/Update/Delete operations for provisioning targets (i.e. devices) and repository content (i.e. software).

57
docs/content/gettingstarted.md Executable file
View File

@@ -0,0 +1,57 @@
---
title: Getting Started
weight: 20
---
## From Docker Image
### Update server only
```sh
$ docker run -d -p 8080:8080 hawkbit/hawkbit-update-server
```
### Updates server + MySql + RabbitMq
```sh
$ git clone https://github.com/eclipse/hawkbit.git
$ cd hawkbit/hawkbit-runtime/hawkbit-update-server/docker
$ docker-compose up -d
```
## From Sources
### Clone and build hawkBit
```sh
$ git clone https://github.com/eclipse/hawkbit.git
$ cd hawkbit
$ mvn clean install
```
### Start hawkBit
[update server](https://github.com/eclipse/hawkbit/tree/master/hawkbit-runtime/hawkbit-update-server)
```sh
$ java -jar ./hawkbit-runtime/hawkbit-update-server/target/hawkbit-update-server-#version#-SNAPSHOT.jar
```
### Build hawkBit examples
```sh
$ git clone https://github.com/eclipse/hawkbit-examples.git
$ cd hawkbit-examples
$ mvn clean install
```
### Start hawkBit device simulator
[Device Simulator](https://github.com/eclipse/hawkbit-examples/tree/master/hawkbit-device-simulator)
```sh
$ java -jar ./hawkbit-device-simulator/target/hawkbit-device-simulator-#version#.jar
```
### Generate Getting Started data
[Example Management API Client](https://github.com/eclipse/hawkbit-examples/tree/master/hawkbit-example-mgmt-simulator)
```sh
$ java -jar ./hawkbit-example-mgmt-simulator/target/hawkbit-example-mgmt-simulator-#version#.jar
```

38
docs/src/main/resources/documentation/guide/clustering.md → docs/content/guides/clustering.md
View File

@@ -1,50 +1,48 @@
---
layout: documentation
title: Clustering
parent: Guides
weight: 33
---
{% include base.html %}
hawkBit is able to run in a cluster with some constraints. This guide provides insights in the basic concepts and how to setup your own cluster. You can find additional information in the [hawkBit runtimes's README](https://github.com/eclipse/hawkbit/blob/master/hawkbit-runtime/hawkbit-update-server/README.md).
<!--more-->
# Cluster
## Big picture
_hawkBit_ is able to run in a cluster with some constraints. This guide provides insights in the basic concepts and how to setup your own cluster. You can find additional information in the [hawkbit runtimes's README](https://github.com/eclipse/hawkbit/blob/master/hawkbit-runtime/hawkbit-update-server/README.md).
![](../../images/overall_cluster.png)
# Big picture
![](../images/overall_cluster.png){:width="100%"}
# Events
## Events
Event communication between nodes is based on [Spring Cloud Bus](https://cloud.spring.io/spring-cloud-bus/) and [Spring Cloud Stream](http://docs.spring.io/spring-cloud-stream/docs/current/reference/htmlsingle/). There are different [binder implementations](http://docs.spring.io/spring-cloud-stream/docs/current/reference/htmlsingle/#_binders) available. The _hawkbit Update Server_ uses RabbitMQ binder. Every node gets his own queue to receive cluster events, the default payload is JSON.
If an event is thrown locally at one node, it will be automatically delivered to all other available nodes via the Spring Cloud Bus's topic exchange:
![](../images/eventing-within-cluster.png){:width="100%"}
![](../../images/eventing-within-cluster.png)
Via the ServiceMatcher you can check whether an event happened locally at one node or on a different node.
`serviceMatcher.isFromSelf(event)`
# Caching
## Caching
Every node is maintaining its own caches independent from other nodes. So there is no globally shared/synchronized cache instance within the cluster. In order to keep nodes in sync a TTL (time to live) can be set for all caches to ensure that after some time the cache is refreshed from the database. To enable the TTL just set the property "hawkbit.cache.global.ttl" (value in milliseconds). Of course you can implement a shared cache, e.g. Redis.
See [CacheAutoConfiguration](https://github.com/eclipse/hawkbit/blob/master/hawkbit-autoconfigure/src/main/java/org/eclipse/hawkbit/autoconfigure/cache/CacheAutoConfiguration.java)
# Schedulers
## Schedulers
Every node has multiple schedulers which run after a defined period of time. All schedulers always run on every node. This has to be kept in mind e.g. if the scheduler executes critical code which has to be executed only once.
# Known constraints
## Known constraints
## UI sessions
As of today _hawkBit_ isn't storing user sessions in a shared, clusterwide cache. Session is only bound to the node where the login took place. If this node is going down for whatever reason, the session is lost and the user is forced to login again.
### UI sessions
As of today hawkBit is not storing user sessions in a shared, cluster wide cache. Session is only bound to the node where the login took place. If this node is going down for whatever reason, the session is lost and the user is forced to login again.
In case that's not an option, you can help yourself by introducing a shared session cache based on e.g. Redis.
Furthermore _hawkBit_ isn't supporting session stickiness out of the box either. However most of the well known load balancers out there can solve this issue.
Furthermore hawkBit is not supporting session stickiness out of the box either. However most of the well known load balancer out there can solve this issue.
## Caching of download IDs
### Caching of download IDs
The downloadId is generated and stored in the DownloadIdCache. It is used for downloading an artifact.
In _hawkbit_ exists an interface called "[DownloadIdCache](https://github.com/eclipse/hawkbit/blob/master/hawkbit-core/src/main/java/org/eclipse/hawkbit/cache/DownloadIdCache.java)" and one implementation of it: "DefaultDownloadIdCache". This default implementation can't be used within a cluster. Its containing data is only available inside one node and can't be shared with other nodes. E.g. the downloadId which is stored in this cache after authentication on node A can only be used for downloading the artifact by node A.
In hawkBit exists an interface called "[DownloadIdCache](https://github.com/eclipse/hawkbit/blob/master/hawkbit-core/src/main/java/org/eclipse/hawkbit/cache/DownloadIdCache.java)" and one implementation of it: "DefaultDownloadIdCache". This default implementation can't be used within a cluster. Its containing data is only available inside one node and can't be shared with other nodes. E.g. the downloadId which is stored in this cache after authentication on node A can only be used for downloading the artifact by node A.
In a cluster-capable environment this fact can lead to issues as it could happen, that the downloadId is stored on node A and node B would like to download the artifact by means of the downloadId which is not available on node B. To solve this issue you can use a cluster-shared cache e.g. Redis or create a new cluster-aware implementation of the interface "DownloadIdCache".
## Denial-of-Service (DoS) filter
_hawkbit_ owns the feature of guarding itself from DoS attacks, a [DoS filter](https://github.com/eclipse/hawkbit/blob/master/hawkbit-security-core/src/main/java/org/eclipse/hawkbit/security/DosFilter.java). It reduces the maximum number of requests per seconds which can be configured for read and write requests.
### Denial-of-Service (DoS) filter
hawkBit owns the feature of guarding itself from DoS attacks, a [DoS filter](https://github.com/eclipse/hawkbit/blob/master/hawkbit-security-core/src/main/java/org/eclipse/hawkbit/security/DosFilter.java). It reduces the maximum number of requests per seconds which can be configured for read and write requests.
This mechanism is only working for every node separately, i.e. in a cluster environment the worst-case behaviour would be that the maximum number of requests per seconds will be increased to its product if every request is handled by a different node.
The same constraint exists with the validator to check if a user tried too many logins within a defined period of time.

26
docs/src/main/resources/documentation/guide/customtheme.md → docs/content/guides/customtheme.md
View File

@@ -1,21 +1,19 @@
---
layout: documentation
title: Clustering
title: Custom Theme
parent: Guides
weight: 34
---
{% include base.html %}
This guide provides details about using and creating themes that control the visual look of Eclipse hawkBit Management UI. Theme customization is done using Sass, which is an extension of CSS (Cascading Style Sheets).
<!--more-->
# Custom Theme
The mechanism described below is the rather simple case by customizing the theme by means of configuring a set of variables as defined by the hawkBit default theme. A full customization be means of copying the hawkBit theme and customize it completely is not described here but of course possible.
This guide provides details about using and creating themes that control the visual look of Eclipse _hawkBit_ Management UI. Theme customization is done using Sass, which is an extension of CSS (Cascading Style Sheets).
The mechanism described below is the rather simple case by customizing the theme by means of configuring a set of variables as defined by the _hawkBit_ default theme. A full customization be means of copying the _hawkBit_ theme and customize it completely is not described here but of course possible.
# Example App
## Example App
An example application with customized theme can be found [here](https://github.com/eclipse/hawkbit-examples/tree/master/hawkbit-custom-theme-example).
# Overview
## Overview
Vaadin separates the appearance of the user interface from its logic using themes. Themes can include Sass or CSS style sheets, custom HTML layouts, and any necessary graphics.
Theme resources can also be accessed from application code as ThemeResource objects. Custom themes are placed under the src/main/resources/VAADIN/themes/ folder of the application.
@@ -26,15 +24,15 @@ If a new custom theme has to be created, it should always be placed under the sr
Every custom theme should always refer the base theme and customization can be done by the use of variables mentioned in the XXXXvariable.scss. For details of the creation of the custom theme please refer the next section.
# Procedure to create a theme
## Procedure to create a theme
- Create a new folder **"XXXtheme"** (significant to the new theme) under src/main/resources/VAADIN/themes/ folder.
- Create a folder named as **"customstyles"**.
- Create a **XXXvariables.scss** file under **customstyles** folder, putting all the variables inside the same file. For more details about the variables we recommend to take a look at the [hawkBit defaults](https://github.com/eclipse/hawkbit/blob/master/hawkbit-ui/src/main/resources/VAADIN/themes/hawkbit/customstyles/hawkbitvariables.scss).
- Create **styles.scss** file under the **"XXXtheme"** folder.
- Any images should be placed under the sub folder **"images"** folder.
- Within the **_styles.scss_** file, import **XXXvariables.scss** and the base theme (hawkbit theme as mentioned in previous chapter **Overview** . Please find below the syntax:
- Within the **_styles.scss_** file, import **XXXvariables.scss** and the base theme (hawkBit theme as mentioned in previous chapter **Overview** . Please find below the syntax:
```
```css
@import "../hawkbit/customstyles/hawkbitvariables";
@import "customstyles/examplevariables";
@import "../hawkbit/hawkbittheme";
@@ -48,5 +46,5 @@ Every custom theme should always refer the base theme and customization can be d
- Finally the structure should be as in the [example app](https://github.com/eclipse/hawkbit-examples/tree/master/hawkbit-custom-theme-example/src/main/resources/VAADIN).
# Procedure to add a custom footer
## Procedure to add a custom footer
- Any footer can be added by creating "footer.html" in **src/main/resources --> VAADIN -- themes --> {XXXtheme} --> layouts** folder. An example can be found [here](https://github.com/eclipse/hawkbit/blob/master/hawkbit-ui/src/main/resources/VAADIN/themes/hawkbit/layouts/footer.html).

22
docs/src/main/resources/documentation/guide/feignclient.md → docs/content/guides/feignclient.md
View File

@@ -1,21 +1,23 @@
---
layout: documentation
title: Clustering
title: Feign Client
parent: Guides
weight: 32
---
{% include base.html %}
In this guide we describe how to create a [Feign](https://github.com/Netflix/feign) Rest Client based on a [Spring Boot](http://projects.spring.io/spring-boot/) Application.
<!--more-->
# Create Feign REST Client
In this guide we describe how to create a [Feign](https://github.com/Netflix/feign) Rest Client based on a [Spring Boot](http://projects.spring.io/spring-boot/) Application. hawkBit provides REST interfaces for [Management API](https://github.com/eclipse/hawkbit/tree/master/hawkbit-ddi-api) and [DDI API] (https://github.com/eclipse/hawkbit/tree/master/hawkbit-ddi-api). Using this interfaces you can create a feign client with the help of the [feign inheritance support] (http://projects.spring.io/spring-cloud/spring-cloud.html#spring-cloud-feign-inheritance).
## Create Feign REST Client
hawkBit provides REST interfaces for [Management API](https://github.com/eclipse/hawkbit/tree/master/hawkbit-ddi-api) and [DDI API](https://github.com/eclipse/hawkbit/tree/master/hawkbit-ddi-api). Using this interfaces you can create a feign client with the help of the [feign inheritance support](http://projects.spring.io/spring-cloud/spring-cloud.html#spring-cloud-feign-inheritance).
Our [example](https://github.com/eclipse/hawkbit-examples) modules demonstrate how to create [Feign](https://github.com/Netflix/feign) client resources. Here you can find the [Management API client resources](hhttps://github.com/eclipse/hawkbit-examples/tree/master/hawkbit-example-mgmt-feign-client) and the [DDI client resources](https://github.com/eclipse/hawkbit-examples/tree/master/hawkbit-example-ddi-feign-client).
A small [simulator application](https://github.com/eclipse/hawkbit-examples/tree/master/hawkbit-example-mgmt-simulator) demonstrates how you can interact with the hawkBit via the [Management API
](http://www.eclipse.org/hawkbit/documentation/interfaces/management-api.html).
### Example Managment API simulator
## Example Management API simulator
In the follow code section, you can a see a feign client resource example. The interface extend the orgin api inteface to declare the `@FeignClient`. The `@FeignClient`declares that a REST client with that interface should be created.
In the follow code section, you can a see a feign client resource example. The interface extend the origin api interface to declare the `@FeignClient`. The `@FeignClient`declares that a REST client with that interface should be created.
```
```Java
@FeignClient(url = "${hawkbit.url:localhost:8080}/" + MgmtRestConstants.TARGET_V1_REQUEST_MAPPING)
public interface MgmtTargetClientResource extends MgmtTargetRestApi {
}
@@ -23,7 +25,7 @@ public interface MgmtTargetClientResource extends MgmtTargetRestApi {
This interface can be autowired and use as a normal java interface:
```
```Java
public class CreateStartedRolloutExample {
@Autowired
@@ -40,7 +42,7 @@ public class CreateStartedRolloutExample {
At [hawkbit-example-core-feign-client](https://github.com/eclipse/hawkbit-examples/tree/master/hawkbit-example-core-feign-client) is a spring configuration to auto configure some beans, which can be reused for a own feign client.
```
```Java
@Configuration
@ConditionalOnClass(Feign.class)
@Import(FeignClientsConfiguration.class)

53
docs/src/main/resources/documentation/guide/runhawkbit.md → docs/content/guides/runhawkbit.md
View File

@@ -1,19 +1,18 @@
---
layout: documentation
title: Run hawkBit
parent: Guides
weight: 31
---
{% include base.html %}
In this guide we describe how to run a full featured hawkBit setup based on a production ready infrastructure. It is based on the hawkBit example modules and update server.
<!--more-->
# Run hawkBit
In this guide we describe how to run a full featured hawkBit setup based on a production ready infrastructure. It is based on the _hawkBit_ example modules and update server.
{{% note %}}
The update server can in fact be run stand alone. However, only with an embedded H2, no Device Management Federation API and no artifact storage.
{{% /note %}}
Note: the update server can in fact be run [stand alone](https://github.com/eclipse/hawkbit/tree/master/hawkbit-runtime/hawkbit-update-server). However, only with an embedded H2, no [Device Management Federation API](../interfaces/dmf-api.html) and no artifact storage.
This guide will focus on a complete setup that includes all _hawkBit_ features.
# System Architecture
## System Architecture
This guide describes a target architecture that is more like one that you will expect in a production system.
- hawkBit [Update Server](https://github.com/eclipse/hawkbit/tree/master/hawkbit-runtime/hawkbit-update-server).
@@ -23,62 +22,58 @@ This guide describes a target architecture that is more like one that you will e
- [hawkBit Device Simulator](https://github.com/eclipse/hawkbit-examples/tree/master/hawkbit-device-simulator).
- [hawkBit Management API example client](https://github.com/eclipse/hawkbit-examples/tree/master/hawkbit-mgmt-api-client).
# Prerequisites
## Prerequisites
- You have a working [hawkBit core build](https://github.com/eclipse/hawkbit).
- You have a working [hawkBit examples build](https://github.com/eclipse/hawkbit-examples).
# Steps
## Adapt hawkBit Update Server and Device Simulator to your environment.
As mentioned you can create your own application with _hawkBit_ inside or adapt the existing example app. The second option will be shown here.
As mentioned you can create your own application with hawkBit inside or adapt the existing example app. The second option will be shown here.
### Set MariaDB dependency to compile in the [update server POM](https://github.com/eclipse/hawkbit/blob/master/hawkbit-runtime/hawkbit-update-server/pom.xml)
{% highlight plaintext %}
```xml
<dependency>
<groupId>org.mariadb.jdbc</groupId>
<artifactId>mariadb-java-client</artifactId>
<scope>compile</scope>
</dependency>
{% endhighlight %}
```
### Configure MariaDB/MySQL connection settings.
For this you can either edit the existing *application.properties* or create a [new profile](http://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#boot-features-external-config-profile-specific-properties).
{% highlight plaintext %}
```
spring.jpa.database=MYSQL
spring.datasource.url=jdbc:mysql://localhost:3306/YOUR_SCHEMA
spring.datasource.username=YOUR_USER
spring.datasource.password=YOUR_PWD
spring.datasource.driverClassName=org.mariadb.jdbc.Driver
{% endhighlight %}
```
### Configure RabbitMQ connection settings for update server and device simulator (optional).
We provide already defaults that should work with a standard Rabbit installation. Otherwise configure the following in the `application.properties` of the two services:
{% highlight plaintext %}
```
spring.rabbitmq.username=guest
spring.rabbitmq.password=guest
spring.rabbitmq.virtualHost=/
spring.rabbitmq.host=localhost
spring.rabbitmq.port=5672
{% endhighlight %}
```
### Adapt hostname of example scenario [creation script](https://github.com/eclipse/hawkbit-examples/blob/master/hawkbit-example-mgmt-simulator/src/main/resources/application.properties)
Should only be necessary if your system does not run on localhost or uses a different port than the example app.
Adapt `application.properties` in this case:
{% highlight plaintext %}
```
hawkbit.url=localhost:8080
{% endhighlight %}
```
or provide the parameter on command line:
{% highlight plaintext %}
```
hawkbit-example-mgmt-simulator-##VERSION##.jar --hawkbit.url=YOUR_HOST:PORT
{% endhighlight %}
```
## Compile & Run
@@ -88,14 +83,14 @@ see [update server](https://github.com/eclipse/hawkbit/tree/master/hawkbit-runti
### Compile & Run example scenario [creation script](https://github.com/eclipse/hawkbit-examples/tree/master/hawkbit-example-mgmt-simulator) (optional).
This has to be done before the device simulator is started. _hawkBit_ creates the mandatory tenant metadata with first login into either _Management UI_ or API (which is done by this client).
This has to be done before the device simulator is started. hawkBit creates the mandatory tenant metadata with first login into either _Management UI_ or API (which is done by this client).
However, this is not done by _DMF_ which is in fact used by the device simulator, i.e. without calling _Management API_ first _hawkBit_ would drop all _DMF_ messages as the tenant is unknown.
However, this is not done by _DMF_ which is in fact used by the device simulator, i.e. without calling _Management API_ first hawkBit would drop all _DMF_ messages as the tenant is unknown.
### Compile & Run device simulator (optional).
see [device simulator](https://github.com/eclipse/hawkbit-examples/tree/master/hawkbit-device-simulator)
## Enjoy hawkBit with a real database, artifact storage and all [interfaces](../interfaces/interfaces.html) available.
# Enjoy hawkBit with a real database, artifact storage and all [interfaces](../../apis/) available.
![](../images/gettingStartedResult.png){:width="100%"}
![](../../images/hawkbit_ui.png)

19
docs/src/main/resources/news/2018-07-26-first-release.md → docs/content/news/2018-07-26-first-release.md
View File

@@ -1,15 +1,8 @@
---
layout: news
title: First release
date: 2018-07-26 08:00:00
section: news
author:
name: Jeroen Laverman
id: laverman
title: Eclipse hawkBit 0.2.0 - First Release
weight: -200
---
# Eclipse hawkBit 0.2.0 - First Release
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. It is part of the Eclipse IoT
since 2015 and with version _0.2.0_ a first release is available.
@@ -35,7 +28,7 @@ The features are accessible via the following interfaces:
* Direct Device Integration (DDI) API
* Device Management Federation (DMF) API
![hawkBit Overview](../img/hawkBit_overview.jpeg){:width="60%" .image-center}
![hawkBit Overview](../../images/hawkBit_overview.jpeg)
## What's new?
@@ -55,7 +48,7 @@ multiple (or all `CTRL` + `A`) items can be selected and removed at once using t
faster and more intuitive, it also saves a lot of display real estate which can now be used to focus on what is important.
We hope you like this change as much as we do! _(Requires: hawkBit > 0.2.2)_
![Screenshot of improved UI](../img/hawkbit_ui.png){:width="60%" .image-center}
![Screenshot of improved UI](../../images/hawkbit_ui.png)
### MS SQL Server
@@ -85,7 +78,9 @@ To start the hawkBit Update Server image, open a terminal and run:
```
$ docker run -d -p 8080:8080 hawkbit/hawkbit-update-server
```
> _Note: This requires a running [Docker deamon](https://docs.docker.com/install/) on your system._
{{% note %}}
_Note: This requires a running [Docker deamon](https://docs.docker.com/install/) on your system._
{{% /note %}}
Now, browse to [http://localhost:8080](http://localhost:8080) and log-in with `admin:admin`. There you go!

0
docs/content/news/_index.md Normal file
View File

32
docs/content/release-notes.md Executable file
View File

@@ -0,0 +1,32 @@
---
title: Release Notes
weight: 100
---
## 0.2.1
**Release Date:** Friday, July 6, 2018 <br />
[Tag](https://github.com/eclipse/hawkbit/releases/tag/0.2.1) /
[Release](https://github.com/eclipse/hawkbit/milestone/9?closed=1)
## 0.2.0
First Eclipse hawkBit release including:
* **Core features:**
* Device and Software Repository
* Update Management Management UI/Console
* Artifact Content Delivery
* Rollout/Campaign Management
* **Interfaces:**
* Management API
* Direct Device Integration (DDI) API
* Device Management Federation (DMF) API
**Release Date:** Friday, June 15, 2018 <br />
[Tag](https://github.com/eclipse/hawkbit/releases/tag/0.2.0) /
[Release](https://github.com/eclipse/hawkbit/milestone/1?closed=1) /
[Eclipse](https://projects.eclipse.org/projects/iot.hawkbit/releases/0.2.0)

0
docs/content/rest-api/_index.md Normal file
View File

64
docs/src/main/resources/documentation/interfaces/management-ui.md → docs/content/ui.md
View File

@@ -1,11 +1,9 @@
---
layout: documentation
title: Management-UI
title: Management UI
weight: 70
---
{% include base.html %}
The _hawkBit_ Management UI provides several views for the different use cases:
The hawkBit Management UI provides several views for the different use cases:
- _Deployment Management_ view for target administration and manual deployment.
- _Distribution Management_ view software repository metadata management.
@@ -13,13 +11,13 @@ The _hawkBit_ Management UI provides several views for the different use cases:
- _Target Filter Management_ view to manage target filters that can be used both in Deployment and Rollout Management views.
- _Rollout Management_ for large scale rollout orchestration.
# Deployment Management
## Deployment Management
## Purpose
### Purpose
Target status overview, target management and manual deployments.
## Feature explained
### Feature explained
- Target Status: check status of all targets.
- Target list allows filters based on:
- Assigned/installed _DistributionSet_ (drag and drop a set on the filter icon on the top of the list)
@@ -47,42 +45,41 @@ Controller_id_1,targetName1
Controller_id_2,targetName2
```
![Deployment Management view](../images/ui/deployment_mgmt.png){:width="100%"}
![Deployment Management view](../images/ui/deployment_mgmt.png)
# Distribution Management
## Distribution Management
## Purpose
### Purpose
Distribution Set view to manage software repository metadata, i.e. Distribution Sets, their Software Modules and the respective types.
## Features explained
### Features explained
- Browse, create, delete and update Distribution Sets.
- Browse, create, delete and update Distribution Set Types.
- Browse, create, delete and update Software Modules.
- Browse, create, delete and update Software Module Types.
- Assign Software Modules to Distribution Sets.
![Distribution Management view](../images/ui/distribution_mgmt.png){:width="100%"}
![Distribution Management view](../images/ui/distribution_mgmt.png)
# Artifact Management
## Artifact Management
## Purpose
### Purpose
Software artifact management, both metadata (i.e. Software Modules) and artifacts themselves.
## Features explained
Allows to:
### Features explained
- Browse, create, delete and update Software Modules.
- Browse, create, delete and update Software Module Types.
- Upload and delete software artifacts for a module.
![Artifact Management view](../images/ui/artifact_mgmt.png){:width="100%"}
![Artifact Management view](../images/ui/artifact_mgmt.png)
# Rollout Management
## Rollout Management
## Purpose
### Purpose
Software rollout in large scale, rollout status overview and rollout management.
## Features explained
### Features explained
- Create, update, copy and delete of rollouts.
- Start, pause and resume of rollouts.
- Progress monitoring for the entire rollout and the individual groups.
@@ -94,24 +91,25 @@ Software rollout in large scale, rollout status overview and rollout management.
- _Trigger threshold_ to define the percentage of installation to be completed , to trigger the start of next group
- _Error threshold_ defines the percentage of error tolerance of a group before calling for a emergency shutdown of a rollout
![Rollout Management view](../images/ui/rollout_mgmt.png){:width="100%"}
![Rollout Management view](../images/ui/rollout_mgmt.png)
![Rollout Management view](../images/ui/rollout_groups.png){:width="100%"}
![Rollout Management view](../images/ui/rollout_groups.png)
## Note
- Deletion of targets which are in a rollout, changes the rollout statistics.
{{% note %}}
Deletion of targets which are in a rollout, changes the rollout statistics.
{{% /note %}}
# Target Filter Management
## Target Filter Management
## Purpose
### Purpose
Custom target filter overview and filter management.
## Features explained
### Features explained
- Custom target filter allows user to filter targets by defining custom query.
- Displays custom target filter list and user can search any particular filter.
- Create, update and delete features are supported for target filters.
## How to Filter
### How to Filter
The basic syntax to filter is: `field<basic_operator>value <composite_operator> field<basic_operator>value <...>`
- `field`: is the name of the resource field.
- `value`: is the value of the target field
@@ -126,18 +124,18 @@ The basic syntax to filter is: `field<basic_operator>value <composite_operator>
- Use `=IN=` for 'in' parameter.(Example: name=IN=(target1,target2).
- Use `*` for wildcard matches.
## Examples
### Examples
Custom query | Description
------------------------------------------------------------------------------------------ | -----------------------------------------------------------------------------------------------------------------------------------------------------
updatestatus==error | Gives all targets in ‘error’ state.
controllerId!=192.168.2.42 | Gives all targets that don't have the controllerId 192.168.2.42.
controllerId!=192.168.2.42 | Gives all targets that do not have the controllerId 192.168.2.42.
name==\*CCU\* | Gives all targets which contain the term ‘CCU’ in there name.
name==\*CCU\* or description==\*CCU\* | Gives all targets that either have the term ‘CCU’ in their name or their description.
name==\*SHC\* and description==\*SHC\* | Gives all targets that have the term SHC in their name and their description.
name==CCU* and updatestatus==pending | Gives all targets with their name starting with ‘CCU’ and which are in ‘pending’ state.
(assignedds.name==‘ECU-DS’ and description==test) or updatestatus!=error | Gives all targets which are either assigned to ‘ECU-DS’ and have description equals to ‘test’ or which are not in error status.
(updatestatus!=In\_sync or updatestatus!=error) and name==\*SHC1\* | Gives all targets that don't have the updatestatus In\_sync or error and that contains the term SHC1 in their name.
(updatestatus!=In\_sync or updatestatus!=error) and name==\*SHC1\* | Gives all targets that do not have the update status In\_sync or error and that contains the term SHC1 in their name.
(updatestatus!=error or updatestatus!=pending) and (name==\*CCU\* or description==\*CCU\*) | Gives all targets that either have the term ‘CCU’ in their name or their description and that either have the _update status_ not in state error or pending.
![Target Filter Management view](../images/ui/target_filter.png){:width="100%"}
![Target Filter Management view](../images/ui/target_filter.png)

25
docs/src/main/resources/documentation/overview/introduction.md → docs/content/whatishawkbit.md Normal file → Executable file
View File

@@ -1,27 +1,19 @@
---
layout: documentation
title: Introduction
title: What is hawkBit?
weight: 10
---
Eclipse hawkBit&trade; is an 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.
{% include base.html %}
![](../images/hawkbit_logo.png)
## Overview
![](../images/hawkbit_logo.png?){:width="300px" .image-left}
<br />
<br />
<br />
hawkBit is an 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.
<br />
## Motivation for Software Updates in IoT
Having software update capabilities ensures a secure IoT by means that it gives IoT projects a fighting chance against pandoras box that they opened the moment their devices got connected. From that moment on devices are at the forefront of IT security threats many embedded software developers historically never had to face. Shipping for instance a Linux powered device connected to the Internet without any security updates ever applied during its lifetime is kind of a suicidal act these days.
## Why Software Updates in IoT?
Having software update capabilities ensures a secure IoT by means that it gives IoT projects a fighting chance against pandora's box that they opened the moment their devices got connected. From that moment on devices are at the forefront of IT security threats many embedded software developers historically never had to face. Shipping for instance a Linux powered device connected to the Internet without any security updates ever applied during its lifetime is kind of a suicidal act these days.
A more charming argument for software update is that it enables agile development for hardware and hardware near development. Concepts like a minimum viable product can be applied for devices as not all features need to be ready at manufacturing time. Changes on the cloud side of the IoT project can be applied to the devices at runtime as well.
Sometimes Software Update is a business model on its own as it makes devices much more attractive to the customer if they are updateable, i.e. they do not only buy a product because of its current feature set but make also a bet on its future capabilities. In addition new revenue streams may arise from the fact that feature extensions can potentially be monetized (e.g. Apps) without the need to design, manufacture and ship a new device (revision).
## Motivation for hawkBit
## Why hawkBit?
**Updating software** (components) on constrained edge devices as well as more powerful controllers and gateways is as mentioned before a **common requirement** in most IoT scenarios.
@@ -36,12 +28,13 @@ Existing **device management systems** usually **lack** the capability to **effi
At the same time the wide functional scope of a full fledged **device management system introduces unnecessary (and unwanted) complexity** to many IoT projects. This is particularly true for IoT solutions working with constrained devices where requirements regarding generic device management are often very limited only but a secure & reliable software update process is still mandatory.
As a result we have the need for a domain independent solution
* that works for the majority of IoT projects
* that goes beyond the pure update and handles more complex **roll out strategies** needed by large scale IoT projects.
* that at the same time is **focused on software updates** in the IoT space
* and that is able to work on its own for simple scenarios while having the capability to integrate with existing device management systems and protocols.
# Requirements to a _cloud ready_ IoT Software Update system
## Cloud Ready
* **Technical Scalability**: connect millions of devices and ship terabytes of software on a global scale.
* **Functional Scalability**: rollouts with hundreds of thousands of individual devices in it.

36
docs/install-theme.sh Normal file
View File

@@ -0,0 +1,36 @@
#
# Copyright (c) 2018 Bosch Software Innovations GmbH and others.
#
# All rights reserved. This program and the accompanying materials
# are made available under the terms of the Eclipse Public License v1.0
# which accompanies this distribution, and is available at
# http://www.eclipse.org/legal/epl-v10.html
#
# This script checks if 'hugo' is installed. Afterwards, the Hugo theme is downloaded.
#!/bin/bash
hugo version
if [ $? != 0 ]
then
echo "[ERROR] Please install Hugo first before proceeding."
exit 1
fi
echo "[INFO] "
echo "[INFO] Install Hugo Theme"
HUGO_THEMES=themes/hugo-material-docs
if [ ! -d ${HUGO_THEMES} ]
then
git submodule add --force https://github.com/digitalcraftsman/hugo-material-docs.git ${HUGO_THEMES}
echo "[INFO] ... done"
else
echo "[INFO] ... theme already installed in: ${HUGO_THEMES}"
fi
echo "[INFO] "
echo "[INFO] Launch the documentation locally by running 'mvn site' (or 'hugo server' in the docs directory),"
echo "[INFO] and browse to 'http://localhost:1313/hawkbit/'. "

0
docs/layouts/404.html Executable file
View File

50
docs/layouts/_default/list.html Executable file
View File

@@ -0,0 +1,50 @@
{{ partial "head" . }}
<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">
{{ partial "header" . }}
</header>
<main class="main">
<div class="drawer">
{{ partial "drawer" . }}
</div>
<article class="article">
<div class="wrapper">
<h1>Pages in {{ .Title }}</h1>
{{ range .Data.Pages }}
<a href="{{ .Permalink }}" title="{{ .Title }}">
<h2>{{ .Title }}</h2>
</a>
<br>
{{ printf "%s" .Summary | markdownify }} <br><a href="{{ .Permalink }}">[...]</a>
<hr>
{{ end }}
{{ partial "copyright.html" . }}
</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>
{{ partial "footer_js" . }}

49
docs/layouts/_default/single.html Executable file
View File

@@ -0,0 +1,49 @@
{{ partial "head" . }}
{{ if (eq (trim .Site.Params.provider " " | lower) "github") | and (isset .Site.Params "repo_url") }}
{{ $repo_id := replace .Site.Params.repo_url "https://github.com/" ""}}
{{ .Scratch.Set "repo_id" $repo_id }}
{{ end }}
<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">
{{ partial "header" . }}
</header>
<main class="main">
<div class="drawer">
{{ partial "drawer" . }}
</div>
<article class="article">
<div class="wrapper">
<h1>{{ .Title }} {{ if .IsDraft }} (Draft){{ end }}</h1>
{{ .Content }}
{{ partial "copyright.html" . }}
<footer class="footer">
{{ partial "footer" . }}
</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>
{{ partial "footer_js" . }}

101
docs/layouts/index.html Executable file
View File

@@ -0,0 +1,101 @@
{{ partial "head" . }}
{{ if (eq (trim .Site.Params.provider " " | lower) "github") | and (isset .Site.Params "repo_url") }}
{{ $repo_id := replace .Site.Params.repo_url "https://github.com/" ""}}
{{ .Scratch.Set "repo_id" $repo_id }}
{{ end }}
<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">
{{ partial "header" . }}
</header>
<main class="main">
<div class="drawer">
{{ partial "drawer" . }}
</div>
<article class="article">
<div class="wrapper">
<div class="jumbotron">IoT. Update. Device.</div>
<div>
<p>
Eclipse hawkBit&trade; 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>
<img src="images/hawkBit_overview.jpeg" />
<h2>Interfaces</h2>
<p>
hawkBit offers a direct device integration via HTTP or a device management federation API
which allows to connect devices with different protocol adapter. Users can make use of the graphical
user interface
and other service can interact with hawkBit through the RESTful management API.
</p>
<h2>Rollout</h2>
<div style="width: 100%; overflow: hidden;">
<div style="width: 50%; float: left;">
<p>
hawkBit supports an easy and flexible rollout management which allows you to update a large
amount of devices in separated groups.
</p>
<ul>
<li>Cascading start of the deployment groups based on installation status of the previous
group.
</li>
<li>Emergency shutdown of the rollout in case a group exceeds the defined error threshold.
</li>
<li>Rollout progress monitoring for the entire rollout and the individual groups.</li>
</ul>
</div>
<div style="margin-left: 50%;">
<br/>
<br/>
<img src="images/rollout.png" />
</div>
</div>
<h2>Package Model</h2>
<div style="width: 100%; overflow: hidden;">
<div style="width: 50%; float: left;">
<br/>
<img src="images/packagemodel.png" />
</div>
<div style="margin-left: 55%;">
<p>
A software update does not always contain only a single file. The hawkBit meta model allows
you to configure your files in virtual software and distribution packages.
</p>
</div>
</div>
</div>
{{ partial "copyright.html" . }}
</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>
{{ partial "footer_js" . }}

33
docs/layouts/partials/copyright.html Executable file
View File

@@ -0,0 +1,33 @@
<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">
{{ with .Site.Params.copyright }}
&copy; {{ now.Year }} {{ . }} &ndash;
{{ end }}
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">
&gt; Privacy Policy
</a>
<a href="http://www.eclipse.org/legal/termsofuse.php" target="_blank">
&gt; Terms of Use
</a>
<a href="http://www.eclipse.org/legal/copyright.php" target="_blank">
&gt; Copyright Agent
</a>
<a href="http://www.eclipse.org/legal" target="_blank">
&gt; Legal
</a>
<a href="https://www.eclipse.org/org/documents/epl-v10.php" target="_blank">
&gt; License
</a>
</p>
</aside>

75
docs/layouts/partials/drawer.html Executable file
View File

@@ -0,0 +1,75 @@
<nav aria-label="Navigation">
<a href="{{ with .Site.BaseURL }}{{ . }}{{ else }}{{ .Site.BaseURL }}{{ end }}" class="project">
<div class="banner">
{{ with .Site.Params.logo }}
<div class="logo">
<img src="{{ $.Site.BaseURL }}{{ . }}">
</div>
{{ end }}
<div class="name">
<strong>{{ .Site.Title }}&trade; {{ with .Site.Params.version }}<span class="version">{{ . }}</span>{{ end }}</strong>
{{ with .Scratch.Get "repo_id" }}
<br>
{{ . }}
{{ end }}
</div>
</div>
</a>
<div class="scrollable">
<div class="wrapper">
{{ if (eq (trim .Site.Params.provider " " | lower) "github") | and (isset .Site.Params "repo_url") }}
<ul class="repo">
<li class="repo-download">
<a href="https://hub.docker.com/u/hawkbit/" target="_blank" title="hawkBit on DockerHub" data-action="docker">
<i class="icon icon-search"></i> Dockerhub
</a>
</li>
<li class="repo-stars">
<a href="{{ .Site.Params.repo_url }}" target="_blank" title="hawkBit on GitHub" data-action="star">
<i class="icon icon-star"></i> Stars
<span class="count">&ndash;</span>
</a>
</li>
</ul>
<hr>
{{ end }}
<div class="toc">
{{ if gt (len .Site.Menus.main) 0 }}
<ul>
{{ partial "nav" . }}
</ul>
{{ end }}
{{ if isset .Site.Params "author" }}
<hr>
<ul>
<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>
<li>
<a href="https://circleci.com/gh/eclipse/hawkbit" title="Circle CI Status" target="_blank">
<img src="https://circleci.com/gh/eclipse/hawkbit.svg?style=shield" />
</a>
</li>
<!--<li>
<a href="https://sonar.ops.bosch-iot-rollouts.com" title="SonarQube Status" target="_blank">
<img src="https://sonar.ops.bosch-iot-rollouts.com/api/badges/gate?key=org.eclipse.hawkbit:hawkbit-parent" />
</a>
</li>-->
<li>
<a href="https://maven-badges.herokuapp.com/maven-central/org.eclipse.hawkbit/hawkbit-parent" title="Maven Central Status" target="_blank">
<img src="https://maven-badges.herokuapp.com/maven-central/org.eclipse.hawkbit/hawkbit-parent/badge.svg" />
</a>
</li>
</ul>
</ul>
{{ end }}
</div>
</div>
</div>
</nav>

74
docs/layouts/partials/footer.html Executable file
View File

@@ -0,0 +1,74 @@
{{ if .IsPage }}
{{ if .Prev | or .Next }}
<nav class="pagination" aria-label="Footer">
<div class="previous">
{{ if .Prev }}
<a href="{{ .Prev.Permalink }}" title="{{ .Prev.Title }}">
<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">
{{ .Prev.Title }}
</div>
</div>
</div>
</a>
{{ end }}
</div>
<div class="next">
{{ if .Next }}
<a href="{{ .Next.Permalink }}" title="{{ .Next.Title }}">
<span class="direction">
Next
</span>
<div class="page">
<div class="stretch">
<div class="title">
{{ .Next.Title }}
</div>
</div>
<div class="button button-next" role="button" aria-label="Next">
<i class="icon icon-forward"></i>
</div>
</div>
</a>
{{ end }}
</div>
</nav>
{{ end }}
{{ end }}
{{ if .IsHome }}
{{ if gt (len .Site.Pages) 2 }}
<nav class="pagination" aria-label="Footer">
<div class="previous">
</div>
{{ $title := (index (.Site.Pages.ByDate) 1).Title }}
{{ $permalink := (index (.Site.Pages.ByDate) 1).Permalink }}
<div class="next">
<a href="{{ $permalink }}" title="{{ $title }}">
<span class="direction">
Next
</span>
<div class="page">
<div class="stretch">
<div class="title">
{{ $title }}
</div>
</div>
<div class="button button-next" role="button" aria-label="Next">
<i class="icon icon-forward"></i>
</div>
</div>
</a>
</div>
</nav>
{{ end }}
{{ end }}

60
docs/layouts/partials/footer_js.html Executable file
View File

@@ -0,0 +1,60 @@
<script>
{{ with .Scratch.Get "repo_id" }}
var base_url = '{{ (printf "%s" $.Site.BaseURL) | safeJS }}';
var repo_id = '{{ . | safeJS }}';
{{ else }}
var base_url = '';
var repo_id = '';
{{ end }}
</script>
<script src="{{ "javascripts/application.js" | absURL }}"></script>
{{ range .Site.Params.custom_js }}
<script src="{{ . | absURL }}"></script>
{{ end }}
<script>
{{ "/* Add headers to scrollspy */" | safeJS }}
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 */" | safeJS }}
var headers = document.querySelectorAll("h1, h2, h3, h4, h5, h6");
for(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 = {{ or .Site.Params.permalink "¶" }};
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>

81
docs/layouts/partials/head.html Executable file
View File

@@ -0,0 +1,81 @@
<!DOCTYPE html>
<!--[if lt IE 7 ]><html class="no-js ie6"><![endif]-->
<!--[if IE 7 ]><html class="no-js ie7"><![endif]-->
<!--[if IE 8 ]><html class="no-js ie8"><![endif]-->
<!--[if IE 9 ]><html class="no-js ie9"><![endif]-->
<!--[if (gt IE 9)|!(IE)]><!--> <html class="no-js"> <!--<![endif]-->
<head {{ with .Site.LanguageCode }}lang="{{ . }}"{{ end }}>
<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>{{ .Title }}{{ if not .IsHome }} - {{ .Site.Title }}{{ end }}</title>
{{ .Hugo.Generator }}
{{ with .Site.Params.description }}
<meta name="description" content="{{ . }}">
{{ end }}
<link rel="canonical" href="{{ .Permalink }}">
{{ with .Site.Params.author }}
<meta name="author" content="{{ . }}">
{{ end }}
<meta property="og:url" content="{{ .Permalink }}">
{{ with .Site.Title }}<meta property="og:title" content="{{ . }}">{{ end }}
{{ with .Site.Params.logo }}<meta property="og:image" content="{{ . | absURL }}">{{ end }}
{{ with .Site.Title }}<meta name="apple-mobile-web-app-title" content="{{ . }}">{{ end }}
<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="{{ with .Site.Params.favicon }}{{ . | absURL }}{{ else }}{{ "images/favicon.ico" | absURL }}{{ end }}">
<link rel="icon" type="image/x-icon" href="{{ with .Site.Params.favicon }}{{ . | absURL }}{{ else }}{{ "images/favicon.ico" | absURL }}{{ end }}">
<style>
@font-face {
font-family: 'Icon';
src: url('{{ "fonts/icon.eot?52m981" | absURL }}');
src: url('{{ "fonts/icon.eot?#iefix52m981" | absURL }}')
format('embedded-opentype'),
url('{{ "fonts/icon.woff?52m981" | absURL }}')
format('woff'),
url('{{ "fonts/icon.ttf?52m981" | absURL }}')
format('truetype'),
url('{{ "fonts/icon.svg?52m981#icon" | absURL }}')
format('svg');
font-weight: normal;
font-style: normal;
}
</style>
<link rel="stylesheet" href="{{ "stylesheets/application.css" | absURL }}">
<link rel="stylesheet" href="{{ "stylesheets/temporary.css" | absURL }}">
<link rel="stylesheet" href="{{ "stylesheets/palettes.css" | absURL }}">
<link rel="stylesheet" href="{{ with .Site.Params.highlight_css }}{{ . | absURL }}{{ else }}{{ "stylesheets/highlight/highlight.css" | absURL }}{{ end }}">
{{/* set default values if no custom ones are defined */}}
{{ $text := or .Site.Params.font.text "Roboto" }}
{{ $code := or .Site.Params.font.code "Roboto Mono" }}
<link rel="stylesheet" href="//fonts.googleapis.com/css?family={{ $text }}:400,700|{{ replace $code " " "+" | safeURL }}">
<style>
body, input {
font-family: '{{ $text }}', Helvetica, Arial, sans-serif;
}
pre, code {
font-family: '{{ $code }}', 'Courier New', 'Courier', monospace;
}
</style>
{{ range .Site.Params.custom_css }}
<link rel="stylesheet" href="{{ . | absURL }}">
{{ end }}
<script src="{{ "javascripts/modernizr.js" | absURL }}"></script>
<script src="//www.eclipse.org/eclipse.org-common/themes/solstice/public/javascript/vendor/cookieconsent/default.min.js"></script>
{{ with .RSSLink }}
<link href="{{ . }}" rel="alternate" type="application/rss+xml" title="{{ $.Site.Title }}" />
<link href="{{ . }}" rel="feed" type="application/rss+xml" title="{{ $.Site.Title }}" />
{{ end }}
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.1.0/css/all.css" integrity="sha384-lKuwvrZot6UHsBSfcMvOkWwlCMgc0TaWr+30HWe3a4ltaBwTZhyTEggF5tJv8tbt" crossorigin="anonymous">
</head>
<body class="{{ with .Site.Params.palette.primary }}palette-primary-{{ . }}{{end }} {{ with .Site.Params.palette.accent }}palette-accent-{{ . }}{{ end }}">

57
docs/layouts/partials/header.html Executable file
View File

@@ -0,0 +1,57 @@
<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">
{{ .Title }}
</div>
</div>
{{ with .Site.Social.twitter }}
<div class="button button-twitter" role="button" aria-label="Twitter">
<a href="https://twitter.com/{{ . }}" title="@{{ . }} on Twitter" target="_blank" class="toggle-button icon icon-twitter"></a>
</div>
{{ end }}
{{ with .Site.Social.github }}
<div class="button button-github" role="button" aria-label="GitHub">
<a href="https://github.com/{{ . }}" title="@{{ . }} on GitHub" target="_blank" class="toggle-button icon icon-github"></a>
</div>
{{ end }}
{{ with .Site.Social.gitter }}
<div class="button button-github" role="button" aria-label="Gitter">
<a href="https://gitter.im/{{ . }}" title="@{{ . }} on Gitter" target="_blank" class="toggle-button icon fab fa-gitter"></a>
</div>
{{ end }}
{{ with .Site.Social.docker }}
<div class="button button-github" role="button" aria-label="Docker">
<a href="https://hub.docker.com/u/{{ . }}" title="{{ . }} on Docker Hub" target="_blank" class="toggle-button icon fab fa-docker"></a>
</div>
{{ end }}
<!-- TODO: disabled until Hugo supports the generation of a content index natively
<div class="button button-search" role="button" aria-label="Search">
<label class="toggle-button icon icon-search" title="Search" for="toggle-search"></label>
</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>

13
docs/layouts/partials/nav_link.html Executable file
View File

@@ -0,0 +1,13 @@
{{ $currentMenuEntry := .Scratch.Get "currentMenuEntry" }}
{{ $isCurrent := eq .Permalink ($currentMenuEntry.URL | absURL | printf "%s") }}
<a {{ if $isCurrent }}class="current"{{ end }} title="{{ $currentMenuEntry.Name }}" href="{{ $currentMenuEntry.URL }}">
{{ $currentMenuEntry.Pre }}
{{ $currentMenuEntry.Name }}
</a>
{{ if $isCurrent }}
<ul id="scrollspy">
</ul>
{{ end }}

4
docs/layouts/shortcodes/note.html Executable file
View File

@@ -0,0 +1,4 @@
<div class="admonition note">
<p class="admonition-title">{{ .Get "title" }}</p>
<p>{{ printf "%s" .Inner | markdownify }}</p>
</div>

4
docs/layouts/shortcodes/warning.html Executable file
View File

@@ -0,0 +1,4 @@
<div class="admonition warning">
<p class="admonition-title">{{ .Get "title" }}</p>
<p>{{ printf "%s" .Inner | markdownify }}</p>
</div>

277
docs/pom.xml
View File

@@ -1,6 +1,6 @@
<!--
Copyright (c) 2015 Bosch Software Innovations GmbH and others.
Copyright (c) 2018 Bosch Software Innovations GmbH and others.
All rights reserved. This program and the accompanying materials
are made available under the terms of the Eclipse Public License v1.0
@@ -18,81 +18,21 @@
<artifactId>docs</artifactId>
<packaging>pom</packaging>
<name>hawkBit :: Documentation</name>
<description>Documenation for hawkBit</description>
<description>Documentation for hawkBit</description>
<properties>
<jekyll.config>localconfig.yml</jekyll.config>
<exec-maven-plugin.version>1.6.0</exec-maven-plugin.version>
</properties>
<!-- Jekyll Linux Build -->
<profiles>
<profile>
<id>jekyll-unix</id>
<activation>
<activeByDefault>true</activeByDefault>
</activation>
<repositories>
<repository>
<id>rubygems-proxy</id>
<name>Rubygems Proxy</name>
<url>http://rubygems-proxy.torquebox.org/releases</url>
<layout>default</layout>
<releases>
<enabled>true</enabled>
</releases>
<snapshots>
<enabled>false</enabled>
<updatePolicy>never</updatePolicy>
</snapshots>
</repository>
</repositories>
<build>
<plugins>
<plugin>
<groupId>de.saumya.mojo</groupId>
<artifactId>gem-maven-plugin</artifactId>
<version>1.1.5</version>
<executions>
<execution>
<id>generate-documentation</id>
<goals>
<goal>exec</goal>
</goals>
<phase>generate-resources</phase>
<configuration>
<file>${project.build.directory}/rubygems/bin/jekyll</file>
<execArgs>build --trace --source ${project.basedir}/src/main/resources --destination ${project.build.outputDirectory} --config ${project.basedir}/src/main/resources/${jekyll.config}</execArgs>
</configuration>
</execution>
<execution>
<!-- run me with: mvn gem:exec@jekyll-serve -->
<id>jekyll-serve</id>
<goals>
<goal>exec</goal>
</goals>
<configuration>
<file>${project.build.directory}/rubygems/bin/jekyll</file>
<execArgs>serve --trace --source ${project.basedir}/src/main/resources --destination ${project.build.outputDirectory} --config ${project.basedir}/src/main/resources/${jekyll.config}</execArgs>
</configuration>
<phase>none</phase>
</execution>
</executions>
<configuration>
<supportNative>true</supportNative>
<jrubyVersion>9.0.5.0</jrubyVersion>
<addProjectClasspath>true</addProjectClasspath>
<jrubyVerbose>false</jrubyVerbose>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-dependency-plugin</artifactId>
<executions>
<execution>
<id>unpack-api-docs</id>
<phase>generate-resources</phase>
<phase>prepare-package</phase>
<goals>
<goal>unpack</goal>
</goals>
@@ -104,227 +44,64 @@
<version>${project.version}</version>
<type>jar</type>
<overWrite>true</overWrite>
<outputDirectory>${basedir}/target/classes/documentation/</outputDirectory>
<includes>**</includes>
<outputDirectory>${basedir}/content/</outputDirectory>
<includes>**/*.html</includes>
</artifactItem>
</artifactItems>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
<dependencies>
<dependency>
<groupId>rubygems</groupId>
<artifactId>jekyll</artifactId>
<type>gem</type>
<optional>true</optional>
</dependency>
</dependencies>
</profile>
<!-- Jekyll Windows Build -->
<profile>
<id>jekyll-windows</id>
<activation>
<os>
<family>windows</family>
</os>
</activation>
<build>
<plugins>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>exec-maven-plugin</artifactId>
<version>${exec-maven-plugin.version}</version>
<executions>
<execution>
<id>generate-documentation</id>
<id>install-hugo-theme</id>
<goals>
<goal>exec</goal>
</goals>
<phase>generate-resources</phase>
<phase>install</phase>
<configuration>
<executable>Jekyll</executable>
<executable>/bin/bash</executable>
<workingDirectory>${project.basedir}</workingDirectory>
<arguments>
<argument>build</argument>
<argument>--trace</argument>
<argument>--source</argument>
<argument>${project.basedir}/src/main/resources</argument>
<argument>--destination</argument>
<argument>${project.build.outputDirectory}</argument>
<argument>--config</argument>
<argument>${project.basedir}/src/main/resources/${jekyll.config}</argument>
<argument>install-theme.sh</argument>
</arguments>
</configuration>
</execution>
<execution>
<!-- run me with: mvn exec:exec@jekyll-serve -->
<id>jekyll-serve</id>
<id>serve</id>
<goals>
<goal>exec</goal>
</goals>
<phase>site</phase>
<configuration>
<executable>Jekyll</executable>
<executable>hugo</executable>
<workingDirectory>${project.basedir}</workingDirectory>
<arguments>
<argument>serve</argument>
<argument>--trace</argument>
<argument>--source</argument>
<argument>${project.basedir}/src/main/resources</argument>
<argument>--destination</argument>
<argument>${project.build.outputDirectory}</argument>
<argument>--config</argument>
<argument>${project.basedir}/src/main/resources/${jekyll.config}</argument>
<argument>server</argument>
</arguments>
</configuration>
<phase>none</phase>
</execution>
</executions>
<configuration>
<supportNative>true</supportNative>
<jrubyVersion>9.0.5.0</jrubyVersion>
<addProjectClasspath>true</addProjectClasspath>
<jrubyVerbose>false</jrubyVerbose>
</configuration>
</plugin>
</plugins>
</build>
</profile>
</profiles>
<build>
<plugins>
<plugin>
<artifactId>maven-assembly-plugin</artifactId>
<configuration>
<descriptors>
<descriptor>src/main/resources/assembly.xml</descriptor>
</descriptors>
</configuration>
<executions>
<execution>
<id>make-assembly</id>
<phase>package</phase>
<id>cleanup</id>
<goals>
<goal>single</goal>
<goal>exec</goal>
</goals>
<phase>clean</phase>
<configuration>
<executable>/bin/bash</executable>
<workingDirectory>${project.basedir}</workingDirectory>
<arguments>
<argument>cleanup.sh</argument>
</arguments>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>rubygems</groupId>
<artifactId>jekyll</artifactId>
<version>3.1.2</version>
<type>gem</type>
</dependency>
<dependency>
<groupId>rubygems</groupId>
<artifactId>liquid</artifactId>
<type>gem</type>
<version>3.0.6</version>
</dependency>
<dependency>
<groupId>rubygems</groupId>
<artifactId>kramdown</artifactId>
<type>gem</type>
<version>1.10.0</version>
</dependency>
<dependency>
<groupId>rubygems</groupId>
<artifactId>mercenary</artifactId>
<type>gem</type>
<version>0.3.5</version>
</dependency>
<dependency>
<groupId>rubygems</groupId>
<artifactId>safe_yaml</artifactId>
<type>gem</type>
<version>1.0.4</version>
</dependency>
<dependency>
<groupId>rubygems</groupId>
<artifactId>colorator</artifactId>
<type>gem</type>
<version>0.1</version>
</dependency>
<dependency>
<groupId>rubygems</groupId>
<artifactId>rouge</artifactId>
<type>gem</type>
<version>1.10.1</version>
</dependency>
<dependency>
<groupId>rubygems</groupId>
<artifactId>jekyll-sass-converter</artifactId>
<type>gem</type>
<version>1.4.0</version>
</dependency>
<dependency>
<groupId>rubygems</groupId>
<artifactId>sass</artifactId>
<type>gem</type>
<version>3.4.22</version>
</dependency>
<dependency>
<groupId>rubygems</groupId>
<artifactId>jekyll-watch</artifactId>
<type>gem</type>
<version>1.3.1</version>
</dependency>
<dependency>
<groupId>rubygems</groupId>
<artifactId>listen</artifactId>
<type>gem</type>
<version>3.0.6</version>
</dependency>
<dependency>
<groupId>rubygems</groupId>
<artifactId>rb-fsevent</artifactId>
<type>gem</type>
<version>0.9.7</version>
</dependency>
<dependency>
<groupId>rubygems</groupId>
<artifactId>rb-inotify</artifactId>
<type>gem</type>
<version>0.9.7</version>
</dependency>
<dependency>
<groupId>rubygems</groupId>
<artifactId>ffi</artifactId>
<type>gem</type>
<version>1.9.10</version>
</dependency>
<dependency>
<groupId>rubygems</groupId>
<artifactId>celluloid-essentials</artifactId>
<version>0.20.5</version>
<type>gem</type>
</dependency>
<dependency>
<groupId>rubygems</groupId>
<artifactId>celluloid-supervision</artifactId>
<type>gem</type>
<version>0.20.5</version>
</dependency>
<dependency>
<groupId>rubygems</groupId>
<artifactId>yajl-ruby</artifactId>
<type>gem</type>
<version>1.2.1</version>
</dependency>
<dependency>
<groupId>rubygems</groupId>
<artifactId>bundler</artifactId>
<type>gem</type>
<version>1.11.2</version>
</dependency>
</dependencies>
</dependencyManagement>
</project>

14
docs/src/main/resources/AhawkBit.md
View File

@@ -1,14 +0,0 @@
---
layout: default
date : "2015-06-22T11:08:19+08:00"
title : "What is Eclipse hawkBit"
series : "homepagetop"
sequence: "1"
order : "1"
imagename : "hawkbit transparency.png"
animatestyle: "slideInRight"
style: "thumb5"
fadeduration: "4"
---
<b>hawkBit</b> 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.

14
docs/src/main/resources/Binterfaces.md
View File

@@ -1,14 +0,0 @@
---
layout: default
title : "Interfaces"
series : "homepagetop"
sequence: "2"
order : 2
imagename : "hawkBit_overview.jpeg"
style: "thumb1"
animatestyle: "fadeIn"
fadestyle: "fadeIn"
fadeduration: "4"
---
hawkBit offers a <b>direct device integration</b> via HTTP or an <b>device management federation API</b> which allows you to connect devices with different protocol adapter. Users can make use of the <b>graphical user interface</b> and other service can interact with hawkBit through the <b>RESTful management API</b>.

17
docs/src/main/resources/CRollout.md
View File

@@ -1,17 +0,0 @@
---
layout: default
title : "Rollout"
series : "homepagetop"
sequence: "5"
order : 3
imagename : "rollout.png"
style: "thumb1"
animatestyle: "fadeIn"
fadestyle: "fadeIn"
fadeduration: "4"
---
hawkBit supports an easy and flexible rollout management which allows you to update a large amount of devices in separated groups.
- Cascading start of the deployment groups based on installation status of the previous group.
- Emergency shutdown of the rollout in case a group exceeds the defined error threshold.
- Rollout progress monitoring for the entire rollout and the individual groups.

14
docs/src/main/resources/DPackageModel.md
View File

@@ -1,14 +0,0 @@
---
layout: default
title : "Package Model"
series : "homepagetop"
sequence: "7"
order : 4
imagename : "packagemodel.png"
style: "thumb1"
animatestyle: "fadeIn"
fadestyle: "fadeIn"
fadeduration: "4"
---
A software update does not always contain only a single file. The hawkBit meta model allows you to configure your files in virtual software and distribution packages.

53
docs/src/main/resources/_data/doclinks.yml
View File

@@ -1,53 +0,0 @@
- title: "Introduction"
href: ""
sub:
- title: "Overview"
href: "/documentation/overview/introduction.html"
- title: "Features"
href: "/documentation/overview/features.html"
- title: "Getting Started"
href: "/documentation/overview/getting-started.html"
- title: "Concepts"
href: ""
sub:
- title: "Architecture"
href: "/documentation/architecture/architecture.html"
- title: "Data model"
href: "/documentation/architecture/datamodel.html"
- title: "Target States"
href: "/documentation/architecture/targetstate.html"
- title: "Rollout Management"
href: "/documentation/architecture/rollout-management.html"
- title: "Interfaces"
href: ""
sub:
- title: "Overview"
href: "/documentation/interfaces/interfaces.html"
- title: "Management UI"
href: "/documentation/interfaces/management-ui.html"
- title: "Management API"
href: "/documentation/interfaces/management-api.html"
- title: "DDI API"
href: "/documentation/interfaces/ddi-api.html"
- title: "DMF API"
href: "/documentation/interfaces/dmf-api.html"
- title: "Security"
href: ""
sub:
- title: "Overview"
href: "/documentation/security/security.html"
- title: "Guides"
href: ""
sub:
- title: "Build and Run hawkBit"
href: "/documentation/guide/runhawkbit.html"
- title: "Clustering"
href: "/documentation/guide/clustering.html"
- title: "Theme Customization"
href: "/documentation/guide/customtheme.html"
- title: "Create Feign Client"
href: "/documentation/guide/feignclient.html"

2
docs/src/main/resources/_data/menus.yml
View File

@@ -1,2 +0,0 @@
- name: Documentation
url: documentation/overview/introduction.html

13
docs/src/main/resources/_includes/base.html
View File

@@ -1,13 +0,0 @@
<!--base to have relative path for offline navigation -->
{% assign base = '.' %}
{% assign depth = page.url | split: '/' | size | minus: 1 %}
{% if page.permalink != null %}
{% assign depth = depth | plus: 1 %}
{% endif %}
{% if depth == 1 %}{% assign base = '.' %}
{% elsif depth == 2 %}{% assign base = '..' %}
{% elsif depth == 3 %}{% assign base = '../..' %}
{% elsif depth == 4 %}{% assign base = '../../..' %}
{% elsif depth == 5 %}{% assign base = '../../../..' %}
{% elsif depth == 6 %}{% assign base = '../../../../..' %}{% endif %}

26
docs/src/main/resources/_includes/footer.html
View File

@@ -1,26 +0,0 @@
<!-- Footer -->
<footer>
<div class="container">
<div class="row">
<div class="col-md-4">
<h3 class="footer-links-header">Quick Links</h3>
<ul class="footer-links clearfix">
<li><a href="http://www.eclipse.org/legal/privacy.php">Privacy Policy</a></li>
<li><a href="http://www.eclipse.org/legal/termsofuse.php">Terms of Use</a></li>
<li><a href="http://www.eclipse.org/legal/copyright.php">Copyright Agent</a></li>
<li><a href="http://www.eclipse.org/legal/">Legal Resources</a></li>
</ul>
<ul class="footer-links clearfix">
<li><a href="http://www.eclipse.org">Eclipse Home</a></li>
<li><a href="http://marketplace.eclipse.org/">Market Place</a></li>
<li><a href="http://live.eclipse.org/">Eclipse Live</a></li>
<li><a href="http://www.planeteclipse.org/">Eclipse Planet</a></li>
<li><a href="http://www.eclipse.org/security/">Reporting a Security Vulnerability</a></li>
</ul>
</div>
<div class="col-md-2">
</div>
</footer>
<!--/.Footer-->

34
docs/src/main/resources/_includes/header.html
View File

@@ -1,34 +0,0 @@
<!--Header section Site navigation -->
{% include base.html %}
<!-- Navigation -->
<nav class="navbar navbar-inverse navbar-fixed-top" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="{{base}}/index.html">Eclipse hawkBit™</a>
</div>
<div class="collapse navbar-collapse wow fadeIn" id="navbar-collapse" data-wow-delay="0.2s">
<ul class="nav navbar-nav pull-right">
{% for menu in site.data.menus %}
<li {% if page.path contains menu.url %} class ="active"{% endif %}>
{% if menu.url contains 'https://' or menu.url contains 'http://' %}
<a target="_blank" href="{{ menu.url }}">{{ menu.name }}</a>
{% else %}
<a href="{{base}}/{{ menu.url }}">{{ menu.name }}</a>
{% endif %}
</li>
{% endfor %}
</ul>
</div>
<!-- /.navbar-collapse -->
</div>
<style>#forkongithub a{background:#8d0c0c;color:#fff;text-decoration:none;font-family:Arial, Helvetica, sans-serif;text-align:center;font-weight:bold;padding:5px 40px;font-size:12px;line-height:3rem;position:relative;transition:0.5s;}#forkongithub a:hover{background:#c11;color:#fff;}#forkongithub a::before,#forkongithub a::after{content:"";width:100%;display:block;position:absolute;top:1px;left:0;height:1px;background:#fff;}#forkongithub a::after{bottom:1px;top:auto;}@media screen and (min-width:800px){#forkongithub{position:fixed;display:block;top:0;right:0;width:50px;overflow:visible;height:200px;z-index:9999;}#forkongithub a{width:260px;position:absolute;top:40px;right:-60px;transform:rotate(45deg);-webkit-transform:rotate(45deg);-ms-transform:rotate(45deg);-moz-transform:rotate(45deg);-o-transform:rotate(45deg);}}</style><span id="forkongithub"><a href="https://github.com/eclipse/hawkbit">Fork me on GitHub</a></span>
<!-- /.container -->
</nav>

65
docs/src/main/resources/_includes/headhomepagesection.html
View File

@@ -1,65 +0,0 @@
<!--Head section for CSS/Javascript -->
<head>
<meta charset="utf-8">
<meta content='width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no' name='viewport'>
<meta name="description" content="IoT Eclipse hawkBit">
<meta name="author" content="">
{% include base.html %}
<title>Eclipse hawkBit - IoT Software Update</title>
<!--Stylesheets-->
<!-- Bootstrap 3.3.1 -->
<link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.1/css/bootstrap.min.css" rel="stylesheet" type="text/css" />
<!-- Font Awesome Icons -->
<link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.2.0/css/font-awesome.css" rel="stylesheet" type="text/css" />
<link rel="stylesheet" href="{{base}}/css/prettyPhoto.css" type="text/css" media="screen" title="prettyPhoto main stylesheet" charset="utf-8" />-
<!-- Custom CSS -->
<link href="{{base}}/css/hawkbit.css" rel="stylesheet">
<!-- Wow CSS -->
<link href="{{base}}/css/animate.css" rel="stylesheet">
<!--<link href="https://cdnjs.cloudflare.com/ajax/libs/wow/1.1.2/animate.css" rel="stylesheet">-->
<!--Javascript-->
<!-- JQuery 2.1.1-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>
<!-- Bootstrap 3.3.1 JS -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.1/js/bootstrap.min.js" type="text/javascript"></script>
<!-- Below css/js is only for Homepage -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/wow/1.1.2/wow.min.js"></script>
<!-- Custom JS -->
<script src="{{base}}/js/app.js"></script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-61866024-1', 'auto');
ga('send', 'pageview');
</script>
<script src="{{base}}/js/jquery.prettyPhoto.js" type="text/javascript" charset="utf-8"></script>
<script type="text/javascript" charset="utf-8">
$(document).ready(function(){
$("a[rel^='prettyPhoto']").prettyPhoto();
});
</script>
<script type="text/javascript" charset="utf-8">
new WOW().init();
</script>
<script type="text/javascript">
$(document).ready(function(){
$(".tip-right").tooltip({
placement : 'right'
});
});
</script>
</head>

31
docs/src/main/resources/_includes/headsection.html
View File

@@ -1,31 +0,0 @@
<!--Head section for CSS/Javascript -->
<head>
<meta charset="utf-8">
<meta content='width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no' name='viewport'>
<meta name="description" content="IoT Software Update">
<meta name="author" content="">
{% include base.html %}
<title>Eclipse hawkBit - IoT Software Update</title>
<!--Stylesheets-->
<!-- Bootstrap 3.3.1 -->
<link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.1/css/bootstrap.min.css" rel="stylesheet" type="text/css" />
<!-- Font Awesome Icons -->
<link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.2.0/css/font-awesome.css" rel="stylesheet" type="text/css" />
<link rel="stylesheet" href="{{base}}/css/prettyPhoto.css" type="text/css" media="screen" title="prettyPhoto main stylesheet" charset="utf-8" />
<!-- Custom CSS -->
<link href="{{base}}/css/hawkbit.css" rel="stylesheet">
<!--Javascript-->
<!-- JQuery 2.1.1-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>
<!-- Bootstrap 3.3.1 JS -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.1/js/bootstrap.min.js" type="text/javascript"></script>
<script src="{{base}}/js/jquery.prettyPhoto.js" type="text/javascript" charset="utf-8"></script>
<script type="text/javascript" charset="utf-8">
$(document).ready(function(){
$("a[rel^='prettyPhoto']").prettyPhoto();
});
</script>
</head>

54
docs/src/main/resources/_includes/homepagebottom.html
View File

@@ -1,54 +0,0 @@
<div class="box">
<h2 class="box-headline" id="header10">Community</h2>
{% for main in site.pages %}
{% if main.series == 'homepagebottom' %}
<div class="{{main.style}} container-fluid wow fadeInDown">
<div class="row">
<div class="col-md-1">
<i class="{{main.imagename}}"></i>
</div>
<div class="col-md-2">
<a href= "{{main.accesslink}}" target="_blank"><h4>{{main.title}}</h4></a>
</div>
<div class="col-md-7">
<section>{{ main.content }}</section>
</div>
</div>
</div>
{% endif %}
{% if main.series == 'homepageAddProjects' %}
<div id = "zoo" class="box">
<div class="row">
<div class="col-md-12 page-header pull-left">
<h2>Projects/Products using hawkBit</h2>
</div>
<div class="container-fluid">
<!--table class="table table-striped table-condensed">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
<th>License</th>
<th>Author(s)</th>
</tr></thead>
<tbody>
{{ main.content }}
</tbody><tfoot></tfoot></table-->
<br>
<p align = "center"><img src="{{ base }}/img/companies_logo.jpg" class="box-img img-responsive"></p>
</div>
</div>
<hr>
{% endif %}
{% endfor %}
</div>

18
docs/src/main/resources/_includes/homepagecontributors.html
View File

@@ -1,18 +0,0 @@
<div class="box">
<h2 class="box-headline" id="header10">Existing Contributors</h2>
<hr>
{% for main in site.pages reversed %}
{% if main.series == 'homepagecontributors' %}
<div class="row">
<div class="col-md-6">
<a href="{{main.url1}}" target="_blank"><img src="{{main.image1}}" /></a>
</div>
<div class="col-md-6">
<a href="{{main.url2}}" target="_blank"><img src="{{main.image2}}" /></a>
</div>
</div>
{% endif %}
{% endfor %}
</div>

36
docs/src/main/resources/_includes/homepageheader.html
View File

@@ -1,36 +0,0 @@
<!--Header section Site navigation -->
{% include base.html %}
<!-- Navigation -->
<nav class="navbar navbar-inverse navbar-fixed-top navbar-lp" role="navigation">
<div class="navbar-brand-logo"> </div>
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="{{base}}/index.html">Eclipse hawkBit™</a>
</div>
<div class="collapse navbar-collapse wow fadeIn" id="navbar-collapse" data-wow-delay="0.2s">
<ul class="nav navbar-nav pull-right">
{% for menu in site.data.menus %}
<li {% if page.path contains menu.url %} class ="active"{% endif %}>
{% if menu.url contains 'https://' or menu.url contains 'http://' %}
<a target="_blank" href="{{ menu.url }}">{{ menu.name }}</a>
{% else %}
<a href="{{base}}/{{ menu.url }}">{{ menu.name }}</a>
{% endif %}
</li>
{% endfor %}
</ul>
</div>
<!-- /.navbar-collapse -->
</div>
<!-- /.container -->
<style>#forkongithub a{background:#8d0c0c;color:#fff;text-decoration:none;font-family:Arial, Helvetica, sans-serif;text-align:center;font-weight:bold;padding:5px 40px;font-size:12px;line-height:3rem;position:relative;transition:0.5s;}#forkongithub a:hover{background:#c11;color:#fff;}#forkongithub a::before,#forkongithub a::after{content:"";width:100%;display:block;position:absolute;top:1px;left:0;height:1px;background:#fff;}#forkongithub a::after{bottom:1px;top:auto;}@media screen and (min-width:800px){#forkongithub{position:fixed;display:block;top:0;right:0;width:50px;overflow:visible;height:200px;z-index:9999;}#forkongithub a{width:260px;position:absolute;top:40px;right:-60px;transform:rotate(45deg);-webkit-transform:rotate(45deg);-ms-transform:rotate(45deg);-moz-transform:rotate(45deg);-o-transform:rotate(45deg);}}</style><span id="forkongithub"><a href="https://github.com/eclipse/hawkbit">Fork me on GitHub</a></span>
</nav>

36
docs/src/main/resources/_includes/homepagemiddle.html
View File

@@ -1,36 +0,0 @@
<!-- Middle Content -->
<div class="box">
{% for main in site.pages %}
<!-- {% if main.series == 'homepagemiddle' %}-->
<div class="container-fluid wow {{main.animatestyle}} {{main.style}}">
<!-- Example row of columns -->
<div class="row">
<div class="col-md-4 text-center">
<h2 class="ex">Devices</h2>
<p class="ex">Easy to connect devices to either the direct device protocol using HTTP or integrate with any protocol your device is talking and build an device to hawkBit-DMF adapter.</p>
</div>
<div class="col-md-4 text-center">
<h2 class="ex">User Interface</h2>
<p class="ex">The user interface allows to manage and monitor your software update process for either a small group of devices till monitor a large software rollout.</p>
</div>
<div class="col-md-4 text-center">
<h2 class="ex">Cloud Ready</h2>
<p class="ex">hawkBit is based on the spring-boot project and allows you to adapt and deploy it to any cloud-platform</p>
</div>
</div>
</div>
<!-- /container -->
<!-- {% endif %}-->
{% endfor %}
</div>
<hr>

44
docs/src/main/resources/_includes/homepagetop.html
View File

@@ -1,44 +0,0 @@
<!-- Top Content -->
{% for main in site.pages %}
{% if main.series == 'homepagetop' %}
{% capture thecycle %}{% cycle 'odd', 'even' %}{% endcapture %}
<div class="box">
{% if thecycle == 'odd' %}
<img class="box-img img-responsive pull-right wow {{ main.animatestyle}} zoom1" src="{{ base }}/img/{{ main.imagename}}">
{% if main.videourl %}
<div class="{{ main.style }}">
<a title="{{main.videotitle}}" data-rel="prettyPhoto" href="{{main.videourl}}" rel="prettyPhoto" >
<i class="fa fa-play-circle fa-5 play-icon"></i>
</a>
<!-- {% if main.playvideo== 'yes' %}
<video width="500" height="500" controls autoplay><source src="{{base}}/video/mov_bbb.mp4" type="video/mp4"></video>
{% endif %} -->
</div>
{% endif %}
{% else %}
<img class="box-img img-responsive pull-left wow fadeInLeft zoom1" src="{{ base }}/img/{{ main.imagename}}">
{% if main.videourl %}
<div class="{{ main.style }}">
<a title="{{main.videotitle}}" data-rel="prettyPhoto" href="{{main.videourl}}" rel="prettyPhoto" >
<i class="fa fa-play-circle fa-5 play-icon"></i>
</a>
</div>
{% endif %}
{% endif %}
{% if main.fadeduration %}
<div class="wow {{ main.fadestyle}}" data-wow-duration="{{ main.fadeduration}}s">
{% else %}
<div class="wow {{ main.fadestyle}}">
{% endif %}
<h2 class="box-headline" id="header{{main.sequence}}">{{ main.title}}</h2>
<p>{{ main.content }}</p>
</div>
</div>
<hr class="box-separator">
{% endif %}
{% endfor %}

21
docs/src/main/resources/_includes/submenu.html
View File

@@ -1,21 +0,0 @@
{% include base.html %}
{% for menu in include.level %}
{% if menu.sub != null %}
<li>
{{ menu.title }}
<ul class="nav navmenu-nav">
<!-- 2nd level -->
{% include submenu.html level=menu.sub %}
</ul>
</li>
{% else %}
<li >
{% if menu.href contains 'https://' or menu.href contains 'http://' %}
<a target="_blank" href="{{ menu.href }}">{{ menu.title }}</a>
{% else %}
<a href="{{base}}{{ menu.href }}">{{ menu.title }}</a>
{% endif %}
</li>
{% endif %}
{% endfor %}

78
docs/src/main/resources/_layouts/blog.html
View File

@@ -1,78 +0,0 @@
---
layout: default
---
{% include base.html %}
<div class="container content">
<div class="row">
<div class="span12">
<div class="page-header pull-left">
<h3>
<a href="{{$base}}/blog/index.html">Go Back</a>
</h3>
</div>
<div class="page-header pull-right">
<a href="https://github.com/eclipse/hawkbit/tree/development/docs/blog" target="_blank"><h4>Add a new blog post!</h4></a>
</div>
</div>
</div>
<h2>{{page.title}}</h2>
<div class="postmetadata">
<ul>
{% if page.eclipseid %}
<li>
<i class="icon-user"></i>
<a href="http://projects.eclipse.org/users/{{page.eclipseid}}">{{ page.author }}</a>
</li>
{% elsif page.githubid %}
<li>
<i class="icon-user"></i>
<a href="https://github.com/{{page.githubid}}">{{ page.author }}</a>
</li>
{% else %}
<li>
<i class="icon-user"></i>{{ page.author }}
</li>
{% endif %}
<li>
<i class="icon-calendar"></i> {{ page.date | date: "%b %-d, %Y" }}
</li>
</ul>
</div>
<section>
{{ content }}
{% if page.videourl %}
<div class="{{ page.style }}">
<a title="{{page.imgtitle}}" data-rel="prettyPhoto" href="{{page.videourl}}" rel="prettyPhoto" >
<img src="{{ $base}}/img/blogpics/{{page.imagename}}" class="box-img img-responsive zoom1">
<i class="fa fa-play-circle fa-5 play-icon"></i>
</a>
</div>
{% endif %}
</div>
<!-- Pagination -->
{% if paginator.total_pages > 1 %}
<div class="pagination">
<ul>
{% if paginator.previous_page %}
<li class="prev"><a href="/blog/{% if paginator.previous_page != 1 %}page{{ paginator.previous_page }}{% endif %}">Previous</a></li>
{% endif %}
<li><a {% if paginator.page == 1 %}class="active" {% endif %}href="/blog/">1</a></li>
{% for count in (2..paginator.total_pages) %}
<li><a {% if paginator.page == count %}class="active" {% endif %}href="/blog/page{{ count }}">{{ count }}</a></li>
{% endfor %}
{% if paginator.next_page %}
<li class="next"><a href="/blog/page{{ paginator.next_page }}">Next</a></li>
{% endif %}
</ul>
</div>
{% endif %}
</div>

113
docs/src/main/resources/_layouts/blog_summary.html
View File

@@ -1,113 +0,0 @@
---
layout: default
---
{% include base.html %}
<div class="container content">
<div class="row">
<div class="col-md-9 page-header pull-left">
<h3>
Blogs
</h3>
</div>
<div class="col-md-3 page-header pull-right">
<a href="https://github.com/eclipse/hawkbit/tree/development/docs/blog" target="_blank"><h3>Add a new blog post!</h3></a>
</div>
</div>
<!--{% assign sorted_pages = (site.pages | sort: 'page.sequence') %}-->
<div class="row">
<div class="col-md-9">
{% for blog in site.pages reversed %}
{% if blog.section == 'blog' %}
<h2><a href="{{base}}{{ blog.url}}">{{blog.title}}</a></h2>
<div class="postmetadata">
<ul>
{% if blog.eclipseid %}
<li>
<i class="icon-user"></i>
<a href="http://projects.eclipse.org/user/{{blog.eclipseid}}">{{ blog.author }}</a>
</li>
{% elsif blog.githubid %}
<li>
<i class="icon-user"></i>
<a href="https://github.com/{{blog.githubid}}">{{ blog.author }}</a>
</li>
{% else %}
<li>
<i class="icon-user"></i>{{ blog.author }}
</li>
{% endif %}
<li>
<i class="icon-calendar"></i> {{ blog.date | date: "%b %-d, %Y" }}
</li>
</ul>
</div>
<section>
{% if blog.content contains '<!--more-->' %}
{{ blog.content | split:'<!--more-->' | first }}
<a href="{{base}}{{ blog.url}}">Read More...</a>
{% else %}
{{ blog.content }}
{% endif %}
</section>
{% endif %}
{% endfor %}
</div>
<div class="col-md-3 pull-right">
<div class="well">
<center><h3>Blogs Overview</h3></center>
<ul class="nav nav-stacked" id="sidebar">
{% for blog in site.pages reversed %}
{% if blog.section == 'blog' %}
<li><a href="{{base}}{{ blog.url}}">{{blog.title}}<br></a></li>
<ul>
{% if blog.eclipseid %}
<li type="square">by <a href="http://projects.eclipse.org/user/{{blog.eclipseid}}"><em>{{ blog.author }}</em></a></li>
{% elsif blog.githubid %}
<li type="square">by <a href="https://github.com/{{blog.githubid}}"><em>{{ blog.author }}</em></a></li>
{% else %}
<li type="square">by <em>{{ blog.author }}</em></li>
{% endif %}
</ul>
{% endif %}
{% endfor %}
</ul>
</div>
</div>
</div>
</div>
<!-- Pagination -->
{% if paginator.total_pages > 1 %}
<div class="pagination">
<ul>
{% if paginator.previous_page %}
<li class="prev"><a href="/blog/{% if paginator.previous_page != 1 %}page{{ paginator.previous_page }}{% endif %}">Previous</a></li>
{% endif %}
<li><a {% if paginator.page == 1 %}class="active" {% endif %}href="/blog/">1</a></li>
{% for count in (2..paginator.total_pages) %}
<li><a {% if paginator.page == count %}class="active" {% endif %}href="/blog/page{{ count }}">{{ count }}</a></li>
{% endfor %}
{% if paginator.next_page %}
<li class="next"><a href="/blog/page{{ paginator.next_page }}">Next</a></li>
{% endif %}
</ul>
</div>
{% endif %}

13
docs/src/main/resources/_layouts/default.html
View File

@@ -1,13 +0,0 @@
<!DOCTYPE html>
<html>
{% include headsection.html %}
<body>
{% include header.html %}
{{ content }}
{% include footer.html %}
</body>
</html>

33
docs/src/main/resources/_layouts/documentation.html
View File

@@ -1,33 +0,0 @@
<!DOCTYPE html>
<html>
{% include headsection.html %}
<body>
{% include header.html %}
<div id="header_wrapper" class="container">
<div class="nav-bar col-md-3">
<nav class="navmenu navmenu-default" role="navigation">
<ul class="nav navmenu-nav">
{% include submenu.html level=site.data.doclinks %}
</ul>
</nav>
</div>
<div id="page" class="col-md-9">
<div class="inner">
<div id="maincontainer">
<section id="top" class="documentation-section">
<div class="row">
<div class="span8 offset3">
{{ content }}
</div>
</div>
</section>
</div>
</div>
</div>
</div>
{% include footer.html %}
</body>
</html>

82
docs/src/main/resources/_layouts/downloads.html
View File

@@ -1,82 +0,0 @@
---
layout: default
---
{% include base.html %}
<div class="container content">
<div class="row">
<div class="span12">
<div class="page-header">
<h2>
Downloads
</h2>
</div>
</div>
</div>
{% for download in site.pages %}
{% if download.section == 'downloadsA' %}
<!-- <div class="box box-dl">
<div class="col-md-1"><i class="{{download.imagename}}"></i></div>
<div href="#" class="col-md-11">
<h3>
<b>{{download.title}}</b>
</h3>
{{download.content}}
</div>
</div>
<hr class="separator">-->
<div class="box">
<div class="row">
<div class="col-md-5">
<table class="pricing">
<tfoot>
<tr>
<td></td>
</tr>
</tfoot>
<tbody>
<tr>
<td class="focus">
hawkBit
<span>Download hawkBit through these sources</span>
</td>
</tbody>
</table>
</div>
<div class="col-md-1"></div>
<div class="col-md-4">
<table class="pricing">
<tfoot>
<tr>
<td></td>
</tr>
</tfoot>
<tbody>
<tr>
<td class="focus">
</td>
</tr>
<tr>
<tr>
</tbody>
</table>
</div>
</div>
<hr>
<div class="container clearfix">
<h1>Source code</h1>
<p>The source code for Eclipse hawkBit is available on <a href="http://github.com/eclipse/hawkBit" target="_blank"><b>Github</b></a></p>
</div>
</div>
{% endif %}
{% endfor %}
</div>

27
docs/src/main/resources/_layouts/homepage.html
View File

@@ -1,27 +0,0 @@
<!DOCTYPE html>
<html>
{% include headhomepagesection.html %}
<body>
{% include homepageheader.html %}
<!-- Additional Header homepage -->
<header class="header">
<div class="tagline">
<div class="container">
<h1><span id="describe" class="wow bounceInDown">IoT.</span><span id="share" class="wow bounceInDown" data-wow-delay="1s"> Update.</span><span id="integrate" class="wow bounceInDown" data-wow-delay="0.3s"> Device.</span></h1>
</div>
</div>
</header>
<!-- Content -->
<div class="container">
{% include homepagetop.html %}
{% include homepagemiddle.html %}
{% include homepagebottom.html %}
<!--{% include homepagecontributors.html %} -->
</div>
<!-- /.container -->
{% include footer.html %}
</body>
</html>

31
docs/src/main/resources/_layouts/news.html
View File

@@ -1,31 +0,0 @@
---
layout: default
---
{% include base.html %}
<div class="container content">
<div class="row">
<div class="span12">
<div class="page-header pull-left">
<h3>
<a href="{{base}}/news/index.html">Go Back</a>
</h3>
</div>
</div>
</div>
<h2>{{page.title}}</h2>
<div class="postmetadata">
<ul>
<li>
<i class="icon-calendar"></i> {{ page.date | date: "%b %-d, %Y" }}
</li>
</ul>
</div>
<section>
{{ content }}
</section>
</div>

65
docs/src/main/resources/_layouts/news_summary.html
View File

@@ -1,65 +0,0 @@
---
layout: default
---
{% include base.html %}
<div class="container content">
<div class="row">
<div class="span12">
<div class="page-header">
<h2>
News
</h2>
</div>
</div>
</div>
<div class="row">
<div class="col-md-9">
{% for news in site.pages reversed %}
{% if news.section == 'news' %}
<h2><a href="{{base}}{{ news.url }}">{{news.title}}</a></h2>
<div class="postmetadata">
<ul>
<li>
<i class="icon-calendar"></i> {{ news.date | date: "%b %-d, %Y" }}
</li>
</ul>
</div>
<section>
{% if news.content contains '<!--more-->' %}
{{ news.content | split:'<!--more-->' | first }}
<a href="{{base}}{{ news.url }}">Read More...</a>
{% else %}
{{ news.content }}
{% endif %}
</section>
{% endif %}
{% endfor %}
</div>
<div class="col-md-3 pull-right">
<div class="well">
<center><h3>News Overview</h3></center>
<ul class="nav nav-stacked" id="sidebar">
{% for news in site.pages reversed %}
{% if news.section == 'news' %}
<li><a href="{{base}}{{ news.url}}">{{news.title}}</a></li>
<ul>
<li type="square"> <a href="{{base}}{{ news.url}}"><em>{{ news.date | date: "%b %-d, %Y" }}</em></a></li>
</ul>
{% endif %}
{% endfor %}
</ul>
</div>
</div>
</div>
</div>

20
docs/src/main/resources/_layouts/overview.html
View File

@@ -1,20 +0,0 @@
---
layout: default
---
{% include base.html %}
<div class="container content">
<div class="row">
<div class="span12">
<div class="page-header pull-left">
<h3>
<a href="{$base}/index.html">Go Back</a>
</h3>
</div>
</div>
</div>
<h1>{{page.title}}</h1>
<section>
{{ content }}
</section>
</div>

24
docs/src/main/resources/assembly.xml
View File

@@ -1,24 +0,0 @@
<!--
Copyright (c) 2015 Bosch Software Innovations GmbH and others.
All rights reserved. This program and the accompanying materials
are made available under the terms of the Eclipse Public License v1.0
which accompanies this distribution, and is available at
http://www.eclipse.org/legal/epl-v10.html
-->
<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0 http://maven.apache.org/xsd/assembly-1.1.0.xsd">
<id>site</id>
<baseDirectory>/</baseDirectory>
<formats>
<format>zip</format>
</formats>
<fileSets>
<fileSet>
<directory>${project.build.outputDirectory}</directory>
<outputDirectory>/</outputDirectory>
</fileSet>
</fileSets>
</assembly>

4
docs/src/main/resources/blog/index.md
View File

@@ -1,4 +0,0 @@
---
layout: blog_summary
permalink: /blog/
---

2744
docs/src/main/resources/css/animate.css vendored
View File

File diff suppressed because it is too large Load Diff

862
docs/src/main/resources/css/hawkbit.css
View File

@@ -1,862 +0,0 @@
@import url('http://fonts.googleapis.com/css?family=Open+Sans:300,300italic,600,600italic,700');
body {
margin-top: 50px;
/* padding for .navbar-fixed-top. */
font-family: 'Open Sans', sans-serif;
line-height: 1.85em;
color: #111;
font-weight: 300;
-webkit-font-smoothing: antialiased;
font-smoothing: antialiased;
}
a {
color: #0088cc;
}
iframe {
width: 100%;
height: 1280px;
border: 0;
}
a:hover {
text-decoration: none;
}
code {
color: #919191;
background-color: #f9f2f4;
}
.image-center {
margin: 0 auto;
display: block;
}
.image-left {
float: left;
margin: 0px 0 0px 0px;
padding: 20px;
}
.navbar-inverse .navbar-brand {
font-size: 48px;
font-weight: bold;
padding-top: 10px;
color: #6ab252;
}
.navbar-inverse .navbar-brand-logo {
background-image: url("../img/hawkbit_flower.png");
background-size: 250px;
background-repeat: no-repeat;
position: absolute;
display: block;
width: 230px;
height: 200px;
}
/*scroll stuff*/
.navbar-lp {
-webkit-transition: height 0.3s;
-moz-transition: height 0.3s;
transition: height 0.3s;
}
.navbar-lp .navbar-brand {
font-size: 65px;
font-weight: bold;
padding-top: 40px;
color: #6ab252;
}
.navbar-lp .navbar-brand-logo {
background-image: url("../img/hawkbit_flower.png");
background-size: 250px;
background-repeat: no-repeat;
position: absolute;
display: block;
width: 250px;
height: 200px;
top: 0;
}
.navbar-lp .navbar-nav {
padding-top: 30px;
}
.navbar-lp {
-webkit-transition: all 0.3s;
-moz-transition: all 0.3s;
transition: all 0.3s;
}
.navbar-lp.scroll .navbar-brand {
font-size: 48px;
padding-top: 10px;
-webkit-transition: all 0.3s;
-moz-transition: all 0.3s;
transition: all 0.3s;
}
.navbar-lp.scroll .navbar-brand-logo {
background-image: url("../img/hawkbit_flower.png");
background-size: 80px;
background-repeat: no-repeat;
position: absolute;
width: 110px;
height: 80px;
top: 0;
}
.navbar-lp.scroll .navbar-nav {
padding-top: 0px;
}
/*scroll stuff ends*/
.navbar-inverse .navbar-nav>li>a {
color: rgba(255, 255, 255, 0.65);
font-size: 16px;
font-weight: bold;
}
.navbar-inverse .navbar-nav>li>a:hover {
color: #6ab252;
}
.navbar-inverse {
background-color: #411355;
border-color: #411355;
padding: 12px 5px 5px 5px;
}
.navbar-inverse .navbar-toggle {
border-color: #411355;
}
.navbar-inverse .navbar-toggle:hover,
.navbar-inverse .navbar-toggle:focus {
background-color: #411355;
}
.navbar-inverse .navbar-collapse,
.navbar-inverse .navbar-form {
border-color: rgba(255, 255, 255, 0);
}
.header {
display: block;
width: 100%;
text-align: center;
background: #411355;
-webkit-background-size: cover;
-moz-background-size: cover;
background-size: cover;
-o-background-size: cover;
margin-bottom: 58px;
}
.tagline {
padding: 60px 0 50px;
}
.tagline h1 {
font-size: 60px;
color: rgba(255, 255, 255, 0.9);
}
.box-separator {
margin: 50px 0;
}
.separator {
margin: 50px 0 30px;
}
.box {
overflow: hidden;
}
.box-img.pull-left {
margin-right: 40px;
}
.box-img.pull-right {
margin-left: 40px;
}
.box-headline {
font-size: 50px;
color: #666;
}
#adi .box-headline {
margin-bottom: 58px;
}
#adi img {
width: 90%;
}
footer {
margin: 50px 0;
}
@media(max-width:1200px) {
.box-separator {
margin: 50px 0;
}
.box-img.pull-left {
margin-right: 20px;
}
.box-img.pull-right {
margin-left: 20px;
}
.box-headline {
font-size: 35px;
}
}
@media(max-width:991px) {
.box-separator {
margin: 40px 0;
}
.box-img.pull-left {
margin-right: 10px;
}
.box-img.pull-right {
margin-left: 10px;
}
.box-headline {
font-size: 30px;
}
}
@media(max-width:768px) {
.container {
margin: 0 15px;
}
.box-separator {
margin: 40px 0;
}
.box-headline {
font-size: 25px;
}
}
@media(max-width:668px) {
.box-separator {
margin: 30px 0;
}
}
@media(max-width:640px) {
.tagline {
padding: 75px 0 25px 0;
}
.navbar-inverse .navbar-brand {
font-size: 65px;
padding-top: 20px;
}
.navbar-inverse .navbar-brand-logo {
background-image: url("../img/hawkbit_flower.png");
background-size: 100px;
background-repeat: no-repeat;
position: absolute;
width: 100px;
height: 200px;
}
.tagline h1 {
font-size: 45px;
margin-top: 10px;
}
}
@media(max-width:375px) {
.box-separator {
margin: 10px 0;
}
.box-img {
max-width: 100%;
}
.box-img.pull-left {
margin-right: 0;
margin-bottom: 10px;
}
.box-img.pull-right {
margin-bottom: 10px;
margin-left: 0;
}
}
/*Content Header
========================*/
.content-header {
margin: 50px 0px;
}
.content-header h1 {
color: #666;
}
/*Blog/News
========================*/
.blogpost,
.news {
padding: 0 0 0px;
margin: 20px 0 0px;
}
.blogpost h3,
.news h3 {
font-size: 28px;
}
.blogpost p .news p {
margin: 20px 0;
font-size: 18px;
}
.metadata {
margin-bottom: 20px;
padding: 5px 0;
}
.metadata ul {
margin: 0;
padding: 0
}
.metadata ul li {
display: inline-block;
margin-right: 20px;
}
.metadata i {
margin: 4px 5px 0 0;
color: #666;
}
/*downloads
========================*/
.box-dl h3 {
margin-top: 5px;
font-weight: bold;
color: #333;
}
.box-dl .fa {
color: #999;
}
/*Home page Image-Hover*/
.zoom1 {
-webkit-transform: scale(1);
transform: scale(1);
-ms-transform: scale(1);
-webkit-transition: .3s ease-in-out;
-ms-transition: .3s ease-in-out;
transition: .3s ease-in-out;
}
.zoom1:hover {
-webkit-transform: scale(0.9);
-ms-transform: scale(0.9);
transform: scale(0.9);
}
/*Home page Image-VideoOverlay*/
.thumb1,
.thumb2,
.thumb3,
.thumb4,
.thumb5 {
position: relative;
}
.thumb1 .play-icon {
outline: medium none;
position: absolute;
z-index: 100;
opacity: 0.8;
color: #003151;
font-size: 4em;
left: 325px;
top: 125px;
}
.thumb1 .play-icon:hover,
.thumb2 .play-icon:hover,
.thumb3 .play-icon:hover,
.thumb4 .play-icon:hover,
.thumb5 .play-icon:hover {
opacity: 1;
-webkit-transform: scale(1.1);
-ms-transform: scale(1.1);
transform: scale(1.1);
}
.thumb2 .play-icon {
color: #003151;
font-size: 4em;
opacity: 0.8;
outline: medium none;
position: absolute;
left: 325px;
z-index: 100;
top: 125px;
}
.thumb3 .play-icon {
color: #003151;
font-size: 4em;
opacity: 0.8;
outline: medium none;
position: absolute;
left: 200px;
z-index: 100;
top: 115px;
}
.thumb4 .play-icon {
color: #003151;
font-size: 4em;
opacity: 0.8;
outline: medium none;
position: absolute;
left: 250px;
z-index: 100;
top: 125px;
}
.thumb5 .play-icon {
color: #003151;
font-size: 4em;
opacity: 0.8;
outline: medium none;
position: absolute;
left: 800px;
z-index: 100;
top: 125px;
}
/*community*/
.team {
background: -moz-linear-gradient(center top, rgba(106, 178, 82, 1) 0%, rgba(147, 200, 130, 1) 100%) repeat scroll 0 0 rgba(0, 0, 0, 0);
background: linear-gradient(center top, rgba(106, 178, 82, 1) 0%, rgba(147, 200, 130, 1) 100%) repeat scroll 0 0 rgba(0, 0, 0, 0);
background: -webkit-linear-gradient(top, rgba(106, 178, 82, 1) 0%, rgba(147, 200, 130, 1) 100%) repeat scroll 0 0 rgba(0, 0, 0, 0);
border-radius: 30px;
box-shadow: 0 1px 3px rgba(0, 0, 0, 0.25), 0 1px 0 rgba(0, 0, 0, 0.1) inset;
height: auto;
margin-bottom: 5px;
padding: 8px;
position: relative;
}
.team:hover {
background: -moz-linear-gradient(center top, rgba(106, 178, 82, 1) 0%, rgba(255, 255, 255, 0.3) 100%) repeat scroll 0 0 rgba(0, 0, 0, 0);
background: linear-gradient(center top, rgba(106, 178, 82, 1) 0%, rgba(255, 255, 255, 0.3) 100%) repeat scroll 0 0 rgba(0, 0, 0, 0);
background: -webkit-linear-gradient(top, rgba(106, 178, 82, 1) 0%, rgba(255, 255, 255, 0.3) 100%) repeat scroll 0 0 rgba(0, 0, 0, 0);
border-radius: 30px;
box-shadow: 0 1px 3px rgba(0, 0, 0, 0.25), 0 1px 0 rgba(0, 0, 0, 0.1) inset;
border: 0px solid #3300CC;
}
.team .fa {
color: #333;
}
/*Usecases*/
.teamuc {
background: -moz-linear-gradient(center top, rgba(106, 178, 82, 1) 0%, rgba(177, 189, 205, 1) 100%) repeat scroll 0 0 rgba(0, 0, 0, 0);
background: linear-gradient(center top, rgba(106, 178, 82, 1) 0%, rgba(177, 189, 205, 1) 100%) repeat scroll 0 0 rgba(0, 0, 0, 0);
background: -webkit-linear-gradient(top, rgba(106, 178, 82, 1) 0%, rgba(177, 189, 205, 1) 100%) repeat scroll 0 0 rgba(0, 0, 0, 0);
filter: progid: DXImageTransform.Microsoft.gradient( startColorstr='#a7cfdf', endColorstr='#23538a', GradientType=0);
border-radius: 4px;
box-shadow: 0 1px 3px rgba(0, 0, 0, 0.25), 0 1px 0 rgba(0, 0, 0, 0.1) inset;
height: auto;
margin-bottom: 5px;
padding: 8px;
position: relative;
}
p.ex {
color: #fff;
}
h2.ex {
color: #fff;
font-weight: bold;
}
.vbtn {
background: #3498db;
background-image: -webkit-linear-gradient(top, #002E5C, #2980b9);
background-image: -moz-linear-gradient(top, #002E5C, #2980b9);
background-image: -ms-linear-gradient(top, #002E5C, #2980b9);
background-image: -o-linear-gradient(top, #002E5C, #2980b9);
background-image: linear-gradient(top bottom, #002E5C, #2980b9);
-webkit-border-radius: 28;
-moz-border-radius: 28;
border-radius: 28px;
color: #ffffff;
font-weight: bold;
padding: 10px 20px 10px 20px;
text-decoration: none;
}
.vbtn:hover {
background: #3cb0fd;
background-image: -webkit-linear-gradient(top, #30567B, #3498db);
background-image: -moz-linear-gradient(top, #30567B, #3498db);
background-image: -ms-linear-gradient(top, #30567B, #3498db);
background-image: -o-linear-gradient(top, #30567B, #3498db);
background-image: linear-gradient(to bottom, #30567B, #3498db);
color: #ffffff;
font-weight: bold;
text-decoration: none;
box-shadow: inset 0 0 0 1px #27496d, 0 5px 15px #193047;
}
.vbtn:active {
background: #3cb0fd;
background-image: -webkit-linear-gradient(top, #30567B, #3498db);
background-image: -moz-linear-gradient(top, #30567B, #3498db);
background-image: -ms-linear-gradient(top, #30567B, #3498db);
background-image: -o-linear-gradient(top, #30567B, #3498db);
background-image: linear-gradient(to bottom, #30567B, #3498db);
color: #ffffff;
font-weight: bold;
text-decoration: none;
box-shadow: inset 0 0 0 1px #27496d, 0 5px 15px #193047;
}
.vbtn:focus {
background: #3cb0fd;
background-image: -webkit-linear-gradient(top, #30567B, #3498db);
background-image: -moz-linear-gradient(top, #30567B, #3498db);
background-image: -ms-linear-gradient(top, #30567B, #3498db);
background-image: -o-linear-gradient(top, #30567B, #3498db);
background-image: linear-gradient(to bottom, #30567B, #3498db);
color: #ffffff;
font-weight: bold;
text-decoration: none;
box-shadow: inset 0 0 0 1px #27496d, 0 5px 15px #193047;
}
/*Footer
========================*/
footer {
border-top: 1px solid #eee;
background: #f5f5f5;
padding: 30px 0;
color: #ccc;
margin-top: 40px;
margin-bottom: 0px;
}
#extra h3 {
font-weight: 400;
border-bottom: 1px solid #999;
padding: 5px;
}
.footer-links-header {
color: #333;
padding-top: 0px;
margin-top: 0px;
}
footer h3 {
margin-top: 16px;
margin-bottom: 6px;
font-size: 20px;
font-weight: 555;
}
.footer-links {
width: 49%;
display: inline-block;
margin: 0;
list-style: none;
}
footer ul {
-webkit-padding-start: 0px;
}
/*documentation*/
.nav-bar {
margin-top: 50px;
background-color: #dadada;
border: 1px solid #ccc;
padding-top: 12px;
}
.nav-bar .nav .navmenu-nav {
padding: 3px 15px;
}
.nav-bar .nav>li>a {
position: relative;
display: block;
padding: 0px 0px;
}
.documentation-section {
padding-top: 68px;
margin-top: -38px;
margin-left: 25px;
}
.info-note {
color: #2283A3;
font-size: 2em;
}
/* blogs*/
@media (max-width: 767px) {
.blogstep .blogpicture {
float: none;
text-align: center;
}
.blogstep .blogtext {
padding: 0;
}
}
.blogstep {
padding: 0 0 20px 40px;
background: url(../img/blogpics/stepline.png) no-repeat 10px 3px;
}
.blogstep .blogpicture {
float: right;
}
.blogstep .blogpicture img {
max-width: 100%;
}
.blogstep .blogtext {
padding: 0 400px 0 0;
color: #848484;
}
.blogstep .blogtext p {
padding-bottom: 10px;
}
.blogstep .blogtext a {
color: #0066FF;
}
.clear {
clear: both;
height: 0;
overflow: hidden;
}
table {
background: #B0C4DE none repeat scroll 0 0;
border: 1px solid #ccc;
border-radius: 4px;
margin: 20px;
width: 100%;
}
table th {
background: rgba(0, 0, 0, 0) -moz-linear-gradient(center top, #B0C4DE, #B0C4DE) repeat scroll 0 0;
background: rgba(0, 0, 0, 0) linear-gradient(center top, #B0C4DE, #B0C4DE) repeat scroll 0 0;
background: rgba(0, 0, 0, 0) -webkit-linear-gradient(center top, #B0C4DE, #B0C4DE) repeat scroll 0 0;
border-bottom: 1px solid #c0c0c0;
border-top: 1px solid #e0e0e0;
padding: 4px 6px;
}
table tr:first-child th:first-child {
border-top-left-radius: 3px;
}
table tr:first-child th:last-child {
border-top-right-radius: 3px;
}
table td:first-child {
border-left: 0 none;
text-align: left;
}
table td {
background: rgba(0, 0, 0, 0) -moz-linear-gradient(center top, #fbfbfb, #fafafa) repeat scroll 0 0;
background: rgba(0, 0, 0, 0) linear-gradient(center top, #fbfbfb, #fafafa) repeat scroll 0 0;
background: rgba(0, 0, 0, 0) -webkit-linear-gradient(center top, #fbfbfb, #fafafa) repeat scroll 0 0;
border-bottom: 1px solid #e0e0e0;
border-left: 1px solid #e0e0e0;
border-top: 1px solid #f0f0f0;
padding: 4px 6px;
}
table tr.even td {
background: rgba(0, 0, 0, 0) -moz-linear-gradient(center top, #f8f8f8, #f6f6f6) repeat scroll 0 0;
background: rgba(0, 0, 0, 0) linear-gradient(center top, #f8f8f8, #f6f6f6) repeat scroll 0 0;
background: rgba(0, 0, 0, 0) -webkit-linear-gradient(center top, #f8f8f8, #f6f6f6) repeat scroll 0 0;
}
table tr:last-child td {
border-bottom: 0 none;
}
table tr:last-child td:first-child {
border-bottom-left-radius: 3px;
}
table tr:last-child td:last-child {
border-bottom-right-radius: 3px;
}
table tr:hover td {
background: rgba(0, 0, 0, 0) -moz-linear-gradient(center top, #f2f2f2, #f0f0f0) repeat scroll 0 0;
background: rgba(0, 0, 0, 0) linear-gradient(center top, #f2f2f2, #f0f0f0) repeat scroll 0 0;
background: rgba(0, 0, 0, 0) -webkit-linear-gradient(center top, #f2f2f2, #f0f0f0) repeat scroll 0 0;
}
#zoo table {
margin: 0;
}
.pricing {
-moz-border-bottom-colors: none;
-moz-border-left-colors: none;
-moz-border-right-colors: none;
-moz-border-top-colors: none;
border-color: #d4d4d4;
border-image: none;
border-radius: 5px 5px 9px 9px;
border-style: solid;
border-width: 1px 1px 4px;
color: #c0c2c2;
font-family: "Lato", sans-serif;
font-size: 12px;
font-weight: 400;
margin-bottom: 40px;
width: 100%;
}
.pricing thead th {
background: #333 none repeat scroll 0 0;
border-top-left-radius: 4px;
border-top-right-radius: 4px;
color: #f4f4f4;
float: left;
font-family: "Lato", sans-serif;
font-size: 24px;
padding: 13px 8%;
text-align: center;
text-transform: uppercase;
width: 100%;
}
.pricing tfoot td {
background: #ededed none repeat scroll 0 0;
border-bottom-left-radius: 6px;
border-bottom-right-radius: 6px;
padding: 20px 8%;
width: 100%;
}
.pricing td {
background: #fff none repeat scroll 0 0;
border: 1px solid #d4d4d4;
float: left;
padding: 10px 8%;
width: 100%;
}
.pricing tfoot td {
text-align: center;
}
.pricing td.focus {
background: #3a5a82;
none repeat scroll 0 0;
border-bottom: 1px solid #d4d4d4;
color: #fff;
font-family: "Lato", sans-serif;
font-size: 32px;
font-weight: 400;
padding: 25px 8%;
text-align: center;
width: 100%;
}
.pricing td.focus-best {
background: #a00 none repeat scroll 0 0;
border-bottom: 1px solid #d4d4d4;
color: #fff;
font-family: "Lato", sans-serif;
font-size: 32px;
font-weight: 400;
padding: 25px 8%;
text-align: center;
width: 100%;
}
.pricing td.focus span {
display: block;
font-size: 10px;
margin-top: 5px;
}
.pricing td.focus-best span {
display: block;
font-size: 10px;
}
.pricing td h6 {
color: #c0c2c2;
float: left;
font-family: "Lato", sans-serif;
font-size: 12px;
font-weight: 400;
width: 60%;
}
.pricing td p {
float: left;
text-align: right;
width: 40%;
}
.btn-primary:hover {
box-shadow: 0 0 3px rgba(0, 0, 0, 1);
}
#tbltext {
color: #000000;
}

170
docs/src/main/resources/css/prettyPhoto.css
View File

@@ -1,170 +0,0 @@
div.pp_default .pp_top,div.pp_default .pp_top .pp_middle,div.pp_default .pp_top .pp_left,div.pp_default .pp_top .pp_right,div.pp_default .pp_bottom,div.pp_default .pp_bottom .pp_left,div.pp_default .pp_bottom .pp_middle,div.pp_default .pp_bottom .pp_right{height:13px}
div.pp_default .pp_top .pp_left{background:url(../img/prettyPhoto/default/sprite.png) -78px -93px no-repeat}
div.pp_default .pp_top .pp_middle{background:url(../img/prettyPhoto/default/sprite_x.png) top left repeat-x}
div.pp_default .pp_top .pp_right{background:url(../img/prettyPhoto/default/sprite.png) -112px -93px no-repeat}
div.pp_default .pp_content .ppt{color:#f8f8f8}
div.pp_default .pp_content_container .pp_left{background:url(../img/prettyPhoto/default/sprite_y.png) -7px 0 repeat-y;padding-left:13px}
div.pp_default .pp_content_container .pp_right{background:url(../img/prettyPhoto/default/sprite_y.png) top right repeat-y;padding-right:13px}
div.pp_default .pp_next:hover{background:url(../img/prettyPhoto/default/sprite_next.png) center right no-repeat;cursor:pointer}
div.pp_default .pp_previous:hover{background:url(../img/prettyPhoto/default/sprite_prev.png) center left no-repeat;cursor:pointer}
div.pp_default .pp_expand{background:url(../img/prettyPhoto/default/sprite.png) 0 -29px no-repeat;cursor:pointer;width:28px;height:28px}
div.pp_default .pp_expand:hover{background:url(../img/prettyPhoto/default/sprite.png) 0 -56px no-repeat;cursor:pointer}
div.pp_default .pp_contract{background:url(../img/prettyPhoto/default/sprite.png) 0 -84px no-repeat;cursor:pointer;width:28px;height:28px}
div.pp_default .pp_contract:hover{background:url(../img/prettyPhoto/default/sprite.png) 0 -113px no-repeat;cursor:pointer}
div.pp_default .pp_close{width:30px;height:30px;background:url(../img/prettyPhoto/default/sprite.png) 1px 1px no-repeat;cursor:pointer}
div.pp_default .pp_gallery ul li a{background:url(../img/prettyPhoto/default/default_thumb.png) center center #f8f8f8;border:1px solid #aaa}
div.pp_default .pp_social{margin-top:7px}
div.pp_default .pp_gallery a.pp_arrow_previous,div.pp_default .pp_gallery a.pp_arrow_next{position:static;left:auto}
div.pp_default .pp_nav .pp_play,div.pp_default .pp_nav .pp_pause{background:url(../img/prettyPhoto/default/sprite.png) -51px 1px no-repeat;height:30px;width:30px}
div.pp_default .pp_nav .pp_pause{background-position:-51px -29px}
div.pp_default a.pp_arrow_previous,div.pp_default a.pp_arrow_next{background:url(../img/prettyPhoto/default/sprite.png) -31px -3px no-repeat;height:20px;width:20px;margin:4px 0 0}
div.pp_default a.pp_arrow_next{left:52px;background-position:-82px -3px}
div.pp_default .pp_content_container .pp_details{margin-top:5px}
div.pp_default .pp_nav{clear:none;height:30px;width:110px;position:relative}
div.pp_default .pp_nav .currentTextHolder{font-family:Georgia;font-style:italic;color:#999;font-size:11px;left:75px;line-height:25px;position:absolute;top:2px;margin:0;padding:0 0 0 10px}
div.pp_default .pp_close:hover,div.pp_default .pp_nav .pp_play:hover,div.pp_default .pp_nav .pp_pause:hover,div.pp_default .pp_arrow_next:hover,div.pp_default .pp_arrow_previous:hover{opacity:0.7}
div.pp_default .pp_description{font-size:11px;font-weight:700;line-height:14px;margin:5px 50px 5px 0}
div.pp_default .pp_bottom .pp_left{background:url(../img/prettyPhoto/default/sprite.png) -78px -127px no-repeat}
div.pp_default .pp_bottom .pp_middle{background:url(../img/prettyPhoto/default/sprite_x.png) bottom left repeat-x}
div.pp_default .pp_bottom .pp_right{background:url(../img/prettyPhoto/default/sprite.png) -112px -127px no-repeat}
div.pp_default .pp_loaderIcon{background:url(../img/prettyPhoto/default/loader.gif) center center no-repeat}
div.light_rounded .pp_top .pp_left{background:url(../img/prettyPhoto/light_rounded/sprite.png) -88px -53px no-repeat}
div.light_rounded .pp_top .pp_right{background:url(../img/prettyPhoto/light_rounded/sprite.png) -110px -53px no-repeat}
div.light_rounded .pp_next:hover{background:url(../img/prettyPhoto/light_rounded/btnNext.png) center right no-repeat;cursor:pointer}
div.light_rounded .pp_previous:hover{background:url(../img/prettyPhoto/light_rounded/btnPrevious.png) center left no-repeat;cursor:pointer}
div.light_rounded .pp_expand{background:url(../img/prettyPhoto/light_rounded/sprite.png) -31px -26px no-repeat;cursor:pointer}
div.light_rounded .pp_expand:hover{background:url(../img/prettyPhoto/light_rounded/sprite.png) -31px -47px no-repeat;cursor:pointer}
div.light_rounded .pp_contract{background:url(../img/prettyPhoto/light_rounded/sprite.png) 0 -26px no-repeat;cursor:pointer}
div.light_rounded .pp_contract:hover{background:url(../img/prettyPhoto/light_rounded/sprite.png) 0 -47px no-repeat;cursor:pointer}
div.light_rounded .pp_close{width:75px;height:22px;background:url(../img/prettyPhoto/light_rounded/sprite.png) -1px -1px no-repeat;cursor:pointer}
div.light_rounded .pp_nav .pp_play{background:url(../img/prettyPhoto/light_rounded/sprite.png) -1px -100px no-repeat;height:15px;width:14px}
div.light_rounded .pp_nav .pp_pause{background:url(../img/prettyPhoto/light_rounded/sprite.png) -24px -100px no-repeat;height:15px;width:14px}
div.light_rounded .pp_arrow_previous{background:url(../img/prettyPhoto/light_rounded/sprite.png) 0 -71px no-repeat}
div.light_rounded .pp_arrow_next{background:url(../img/prettyPhoto/light_rounded/sprite.png) -22px -71px no-repeat}
div.light_rounded .pp_bottom .pp_left{background:url(../img/prettyPhoto/light_rounded/sprite.png) -88px -80px no-repeat}
div.light_rounded .pp_bottom .pp_right{background:url(../img/prettyPhoto/light_rounded/sprite.png) -110px -80px no-repeat}
div.dark_rounded .pp_top .pp_left{background:url(../img/prettyPhoto/dark_rounded/sprite.png) -88px -53px no-repeat}
div.dark_rounded .pp_top .pp_right{background:url(../img/prettyPhoto/dark_rounded/sprite.png) -110px -53px no-repeat}
div.dark_rounded .pp_content_container .pp_left{background:url(../img/prettyPhoto/dark_rounded/contentPattern.png) top left repeat-y}
div.dark_rounded .pp_content_container .pp_right{background:url(../img/prettyPhoto/dark_rounded/contentPattern.png) top right repeat-y}
div.dark_rounded .pp_next:hover{background:url(../img/prettyPhoto/dark_rounded/btnNext.png) center right no-repeat;cursor:pointer}
div.dark_rounded .pp_previous:hover{background:url(../img/prettyPhoto/dark_rounded/btnPrevious.png) center left no-repeat;cursor:pointer}
div.dark_rounded .pp_expand{background:url(../img/prettyPhoto/dark_rounded/sprite.png) -31px -26px no-repeat;cursor:pointer}
div.dark_rounded .pp_expand:hover{background:url(../img/prettyPhoto/dark_rounded/sprite.png) -31px -47px no-repeat;cursor:pointer}
div.dark_rounded .pp_contract{background:url(../img/prettyPhoto/dark_rounded/sprite.png) 0 -26px no-repeat;cursor:pointer}
div.dark_rounded .pp_contract:hover{background:url(../img/prettyPhoto/dark_rounded/sprite.png) 0 -47px no-repeat;cursor:pointer}
div.dark_rounded .pp_close{width:75px;height:22px;background:url(../img/prettyPhoto/dark_rounded/sprite.png) -1px -1px no-repeat;cursor:pointer}
div.dark_rounded .pp_description{margin-right:85px;color:#fff}
div.dark_rounded .pp_nav .pp_play{background:url(../img/prettyPhoto/dark_rounded/sprite.png) -1px -100px no-repeat;height:15px;width:14px}
div.dark_rounded .pp_nav .pp_pause{background:url(../img/prettyPhoto/dark_rounded/sprite.png) -24px -100px no-repeat;height:15px;width:14px}
div.dark_rounded .pp_arrow_previous{background:url(../img/prettyPhoto/dark_rounded/sprite.png) 0 -71px no-repeat}
div.dark_rounded .pp_arrow_next{background:url(../img/prettyPhoto/dark_rounded/sprite.png) -22px -71px no-repeat}
div.dark_rounded .pp_bottom .pp_left{background:url(../img/prettyPhoto/dark_rounded/sprite.png) -88px -80px no-repeat}
div.dark_rounded .pp_bottom .pp_right{background:url(../img/prettyPhoto/dark_rounded/sprite.png) -110px -80px no-repeat}
div.dark_rounded .pp_loaderIcon{background:url(../img/prettyPhoto/dark_rounded/loader.gif) center center no-repeat}
div.dark_square .pp_left,div.dark_square .pp_middle,div.dark_square .pp_right,div.dark_square .pp_content{background:#000}
div.dark_square .pp_description{color:#fff;margin:0 85px 0 0}
div.dark_square .pp_loaderIcon{background:url(../img/prettyPhoto/dark_square/loader.gif) center center no-repeat}
div.dark_square .pp_expand{background:url(../img/prettyPhoto/dark_square/sprite.png) -31px -26px no-repeat;cursor:pointer}
div.dark_square .pp_expand:hover{background:url(../img/prettyPhoto/dark_square/sprite.png) -31px -47px no-repeat;cursor:pointer}
div.dark_square .pp_contract{background:url(../img/prettyPhoto/dark_square/sprite.png) 0 -26px no-repeat;cursor:pointer}
div.dark_square .pp_contract:hover{background:url(../img/prettyPhoto/dark_square/sprite.png) 0 -47px no-repeat;cursor:pointer}
div.dark_square .pp_close{width:75px;height:22px;background:url(../img/prettyPhoto/dark_square/sprite.png) -1px -1px no-repeat;cursor:pointer}
div.dark_square .pp_nav{clear:none}
div.dark_square .pp_nav .pp_play{background:url(../img/prettyPhoto/dark_square/sprite.png) -1px -100px no-repeat;height:15px;width:14px}
div.dark_square .pp_nav .pp_pause{background:url(../img/prettyPhoto/dark_square/sprite.png) -24px -100px no-repeat;height:15px;width:14px}
div.dark_square .pp_arrow_previous{background:url(../img/prettyPhoto/dark_square/sprite.png) 0 -71px no-repeat}
div.dark_square .pp_arrow_next{background:url(../img/prettyPhoto/dark_square/sprite.png) -22px -71px no-repeat}
div.dark_square .pp_next:hover{background:url(../img/prettyPhoto/dark_square/btnNext.png) center right no-repeat;cursor:pointer}
div.dark_square .pp_previous:hover{background:url(../img/prettyPhoto/dark_square/btnPrevious.png) center left no-repeat;cursor:pointer}
div.light_square .pp_expand{background:url(../img/prettyPhoto/light_square/sprite.png) -31px -26px no-repeat;cursor:pointer}
div.light_square .pp_expand:hover{background:url(../img/prettyPhoto/light_square/sprite.png) -31px -47px no-repeat;cursor:pointer}
div.light_square .pp_contract{background:url(../img/prettyPhoto/light_square/sprite.png) 0 -26px no-repeat;cursor:pointer}
div.light_square .pp_contract:hover{background:url(../img/prettyPhoto/light_square/sprite.png) 0 -47px no-repeat;cursor:pointer}
div.light_square .pp_close{width:75px;height:22px;background:url(../img/prettyPhoto/light_square/sprite.png) -1px -1px no-repeat;cursor:pointer}
div.light_square .pp_nav .pp_play{background:url(../img/prettyPhoto/light_square/sprite.png) -1px -100px no-repeat;height:15px;width:14px}
div.light_square .pp_nav .pp_pause{background:url(../img/prettyPhoto/light_square/sprite.png) -24px -100px no-repeat;height:15px;width:14px}
div.light_square .pp_arrow_previous{background:url(../img/prettyPhoto/light_square/sprite.png) 0 -71px no-repeat}
div.light_square .pp_arrow_next{background:url(../img/prettyPhoto/light_square/sprite.png) -22px -71px no-repeat}
div.light_square .pp_next:hover{background:url(../img/prettyPhoto/light_square/btnNext.png) center right no-repeat;cursor:pointer}
div.light_square .pp_previous:hover{background:url(../img/prettyPhoto/light_square/btnPrevious.png) center left no-repeat;cursor:pointer}
div.facebook .pp_top .pp_left{background:url(../img/prettyPhoto/facebook/sprite.png) -88px -53px no-repeat}
div.facebook .pp_top .pp_middle{background:url(../img/prettyPhoto/facebook/contentPatternTop.png) top left repeat-x}
div.facebook .pp_top .pp_right{background:url(../img/prettyPhoto/facebook/sprite.png) -110px -53px no-repeat}
div.facebook .pp_content_container .pp_left{background:url(../img/prettyPhoto/facebook/contentPatternLeft.png) top left repeat-y}
div.facebook .pp_content_container .pp_right{background:url(../img/prettyPhoto/facebook/contentPatternRight.png) top right repeat-y}
div.facebook .pp_expand{background:url(../img/prettyPhoto/facebook/sprite.png) -31px -26px no-repeat;cursor:pointer}
div.facebook .pp_expand:hover{background:url(../img/prettyPhoto/facebook/sprite.png) -31px -47px no-repeat;cursor:pointer}
div.facebook .pp_contract{background:url(../img/prettyPhoto/facebook/sprite.png) 0 -26px no-repeat;cursor:pointer}
div.facebook .pp_contract:hover{background:url(../img/prettyPhoto/facebook/sprite.png) 0 -47px no-repeat;cursor:pointer}
div.facebook .pp_close{width:22px;height:22px;background:url(../img/prettyPhoto/facebook/sprite.png) -1px -1px no-repeat;cursor:pointer}
div.facebook .pp_description{margin:0 37px 0 0}
div.facebook .pp_loaderIcon{background:url(../img/prettyPhoto/facebook/loader.gif) center center no-repeat}
div.facebook .pp_arrow_previous{background:url(../img/prettyPhoto/facebook/sprite.png) 0 -71px no-repeat;height:22px;margin-top:0;width:22px}
div.facebook .pp_arrow_previous.disabled{background-position:0 -96px;cursor:default}
div.facebook .pp_arrow_next{background:url(../img/prettyPhoto/facebook/sprite.png) -32px -71px no-repeat;height:22px;margin-top:0;width:22px}
div.facebook .pp_arrow_next.disabled{background-position:-32px -96px;cursor:default}
div.facebook .pp_nav{margin-top:0}
div.facebook .pp_nav p{font-size:15px;padding:0 3px 0 4px}
div.facebook .pp_nav .pp_play{background:url(../img/prettyPhoto/facebook/sprite.png) -1px -123px no-repeat;height:22px;width:22px}
div.facebook .pp_nav .pp_pause{background:url(../img/prettyPhoto/facebook/sprite.png) -32px -123px no-repeat;height:22px;width:22px}
div.facebook .pp_next:hover{background:url(../img/prettyPhoto/facebook/btnNext.png) center right no-repeat;cursor:pointer}
div.facebook .pp_previous:hover{background:url(../img/prettyPhoto/facebook/btnPrevious.png) center left no-repeat;cursor:pointer}
div.facebook .pp_bottom .pp_left{background:url(../img/prettyPhoto/facebook/sprite.png) -88px -80px no-repeat}
div.facebook .pp_bottom .pp_middle{background:url(../img/prettyPhoto/facebook/contentPatternBottom.png) top left repeat-x}
div.facebook .pp_bottom .pp_right{background:url(../img/prettyPhoto/facebook/sprite.png) -110px -80px no-repeat}
div.pp_pic_holder a:focus{outline:none}
div.pp_overlay{background:#000;display:none;left:0;position:absolute;top:0;width:100%;z-index:9500}
div.pp_pic_holder{display:none;position:absolute;width:100px;z-index:10000}
.pp_content{height:40px;min-width:40px}
* html .pp_content{width:40px}
.pp_content_container{position:relative;text-align:left;width:100%}
.pp_content_container .pp_left{padding-left:20px}
.pp_content_container .pp_right{padding-right:20px}
.pp_content_container .pp_details{float:left;margin:10px 0 2px}
.pp_description{display:none;margin:0}
.pp_social{float:left;margin:0}
.pp_social .facebook{float:left;margin-left:5px;width:55px;overflow:hidden}
.pp_social .twitter{float:left}
.pp_nav{clear:right;float:left;margin:3px 10px 0 0}
.pp_nav p{float:left;white-space:nowrap;margin:2px 4px}
.pp_nav .pp_play,.pp_nav .pp_pause{float:left;margin-right:4px;text-indent:-10000px}
a.pp_arrow_previous,a.pp_arrow_next{display:block;float:left;height:15px;margin-top:3px;overflow:hidden;text-indent:-10000px;width:14px}
.pp_hoverContainer{position:absolute;top:0;width:100%;z-index:2000}
.pp_gallery{display:none;left:50%;margin-top:-50px;position:absolute;z-index:10000}
.pp_gallery div{float:left;overflow:hidden;position:relative}
.pp_gallery ul{float:left;height:35px;position:relative;white-space:nowrap;margin:0 0 0 5px;padding:0}
.pp_gallery ul a{border:1px rgba(0,0,0,0.5) solid;display:block;float:left;height:33px;overflow:hidden}
.pp_gallery ul a img{border:0}
.pp_gallery li{display:block;float:left;margin:0 5px 0 0;padding:0}
.pp_gallery li.default a{background:url(../img/prettyPhoto/facebook/default_thumbnail.gif) 0 0 no-repeat;display:block;height:33px;width:50px}
.pp_gallery .pp_arrow_previous,.pp_gallery .pp_arrow_next{margin-top:7px!important}
a.pp_next{background:url(../img/prettyPhoto/light_rounded/btnNext.png) 10000px 10000px no-repeat;display:block;float:right;height:100%;text-indent:-10000px;width:49%}
a.pp_previous{background:url(../img/prettyPhoto/light_rounded/btnNext.png) 10000px 10000px no-repeat;display:block;float:left;height:100%;text-indent:-10000px;width:49%}
a.pp_expand,a.pp_contract{cursor:pointer;display:none;height:20px;position:absolute;right:30px;text-indent:-10000px;top:10px;width:20px;z-index:20000}
a.pp_close{position:absolute;right:5px;top:10px;display:block;line-height:22px;text-indent:-10000px}
.pp_loaderIcon{display:block;height:24px;left:50%;position:absolute;top:50%;width:24px;margin:-12px 0 0 -12px}
#pp_full_res{line-height:1!important}
#pp_full_res .pp_inline{text-align:left}
#pp_full_res .pp_inline p{margin:0 0 15px}
div.ppt{color:#fff;display:none;font-size:17px;z-index:9999;margin:0 0 5px 15px}
div.pp_default .pp_content,div.light_rounded .pp_content{background-color:#fff}
div.pp_default #pp_full_res .pp_inline,div.light_rounded .pp_content .ppt,div.light_rounded #pp_full_res .pp_inline,div.light_square .pp_content .ppt,div.light_square #pp_full_res .pp_inline,div.facebook .pp_content .ppt,div.facebook #pp_full_res .pp_inline{color:#000}
div.pp_default .pp_gallery ul li a:hover,div.pp_default .pp_gallery ul li.selected a,.pp_gallery ul a:hover,.pp_gallery li.selected a{border-color:#fff}
div.pp_default .pp_details,div.light_rounded .pp_details,div.dark_rounded .pp_details,div.dark_square .pp_details,div.light_square .pp_details,div.facebook .pp_details{position:relative}
div.light_rounded .pp_top .pp_middle,div.light_rounded .pp_content_container .pp_left,div.light_rounded .pp_content_container .pp_right,div.light_rounded .pp_bottom .pp_middle,div.light_square .pp_left,div.light_square .pp_middle,div.light_square .pp_right,div.light_square .pp_content,div.facebook .pp_content{background:#fff}
div.light_rounded .pp_description,div.light_square .pp_description{margin-right:85px}
div.light_rounded .pp_gallery a.pp_arrow_previous,div.light_rounded .pp_gallery a.pp_arrow_next,div.dark_rounded .pp_gallery a.pp_arrow_previous,div.dark_rounded .pp_gallery a.pp_arrow_next,div.dark_square .pp_gallery a.pp_arrow_previous,div.dark_square .pp_gallery a.pp_arrow_next,div.light_square .pp_gallery a.pp_arrow_previous,div.light_square .pp_gallery a.pp_arrow_next{margin-top:12px!important}
div.light_rounded .pp_arrow_previous.disabled,div.dark_rounded .pp_arrow_previous.disabled,div.dark_square .pp_arrow_previous.disabled,div.light_square .pp_arrow_previous.disabled{background-position:0 -87px;cursor:default}
div.light_rounded .pp_arrow_next.disabled,div.dark_rounded .pp_arrow_next.disabled,div.dark_square .pp_arrow_next.disabled,div.light_square .pp_arrow_next.disabled{background-position:-22px -87px;cursor:default}
div.light_rounded .pp_loaderIcon,div.light_square .pp_loaderIcon{background:url(../img/prettyPhoto/light_rounded/loader.gif) center center no-repeat}
div.dark_rounded .pp_top .pp_middle,div.dark_rounded .pp_content,div.dark_rounded .pp_bottom .pp_middle{background:url(../img/prettyPhoto/dark_rounded/contentPattern.png) top left repeat}
div.dark_rounded .currentTextHolder,div.dark_square .currentTextHolder{color:#c4c4c4}
div.dark_rounded #pp_full_res .pp_inline,div.dark_square #pp_full_res .pp_inline{color:#fff}
.pp_top,.pp_bottom{height:20px;position:relative}
* html .pp_top,* html .pp_bottom{padding:0 20px}
.pp_top .pp_left,.pp_bottom .pp_left{height:20px;left:0;position:absolute;width:20px}
.pp_top .pp_middle,.pp_bottom .pp_middle{height:20px;left:20px;position:absolute;right:20px}
* html .pp_top .pp_middle,* html .pp_bottom .pp_middle{left:0;position:static}
.pp_top .pp_right,.pp_bottom .pp_right{height:20px;left:auto;position:absolute;right:0;top:0;width:20px}
.pp_fade,.pp_gallery li.default a img{display:none}

13
docs/src/main/resources/ctycontribute.md
View File

@@ -1,13 +0,0 @@
---
layout: default
title: "Contributing"
date: "2015-04-03T04:30:17+08:00"
series : "homepagebottom"
sequence: "contribute"
imagename : "fa fa-link fa-4x"
style: "team"
accesslink: "https://wiki.eclipse.org/Development_Resources/Contributing_via_Git"
---
An overview of the **contribution process** is <a href="https://wiki.eclipse.org/Development_Resources/Contributing_via_Git" target="_blank">here.</a>
Checkout the *CONTRIBUTION.md* on the <a href="https://github.com/eclipse/hawkbit" target="_blank">Eclipse hawkBit GIT Repository</a>

11
docs/src/main/resources/ctygitter.md
View File

@@ -1,11 +0,0 @@
---
layout: default
title: "Gitter Chat"
series : "homepagebottom"
sequence: "gitter"
imagename : "fa fa-users fa-4x"
style: "team"
accesslink: "https://gitter.im/eclipse/hawkbit"
---
Questions? Problems? Searching for a quick response from the team behind hawkBit and from the hawkBit community, join the <a href="https://gitter.im/eclipse/hawkbit" target="_blank">Gitter chat.</a>

12
docs/src/main/resources/ctyhudson.md
View File

@@ -1,12 +0,0 @@
---
layout: default
title: "Hudson Build"
series : "homepagebottom"
sequence: "hudson"
imagename : "fa fa-gear fa-4x"
style: "team"
accesslink: "https://hudson.eclipse.org/hawkbit"
---
{% include base.html %}
Checkout the builds of hawkBit on the Hudson CI <a href="https://hudson.eclipse.org/hawkbit" target="_blank">here.</a>

10
docs/src/main/resources/ctyissuetracker.md
View File

@@ -1,10 +0,0 @@
---
layout: default
title: "Issue Tracker"
series : "homepagebottom"
sequence: "issuetracker"
imagename : "fa fa-bug fa-4x"
style: "team"
accesslink: "https://github.com/eclipse/hawkbit/issues"
---
Issues and bugs related to hawkBit are tracked with the **Github Issue** tracking system. If you find any issues, please report them <a href="https://github.com/eclipse/hawkbit/issues" target="_blank">here.</a>

12
docs/src/main/resources/ctymailingllist.md
View File

@@ -1,12 +0,0 @@
---
layout: default
title: "Mailing List"
series : "homepagebottom"
sequence: "mailinglist"
imagename : "fa fa-envelope fa-4x"
style: "team"
accesslink: "https://dev.eclipse.org/mailman/listinfo/hawkbit-dev"
---
{% include base.html %}
A great way to stay up to date with hawkBit activity is to subscribe to the **Mailing list** provided by Eclipse. Sign up for the mailing list <a href="https://dev.eclipse.org/mailman/listinfo/hawkbit-dev" target="_blank">here.</a>

9
docs/src/main/resources/documentation/architecture/architecture.md
View File

@@ -1,9 +0,0 @@
---
layout: documentation
title: Architecture Overview
---
{% include base.html %}
Overview of hawkBit modules and used 3rd party technology:
![](../images/architecture/architecture.png){:width="100%" .image-center}

BIN
docs/src/main/resources/documentation/images/gettingStartedResult.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 128 KiB

4
docs/src/main/resources/documentation/index.md
View File

@@ -1,4 +0,0 @@
---
layout: documentation
title: Documentation
---

29
docs/src/main/resources/documentation/interfaces/interfaces.md
View File

@@ -1,29 +0,0 @@
---
layout: documentation
title: Interfaces
---
{% include base.html %}
![](../images/hawkBit_overview.jpeg){:width="100%"}
# Graphical User Interface
To get started _hawkBit_ offers a [Management UI](management-ui.html) that allows operators to manage the repository and trigger provisioning operations.
In addition Eclipse _hawkBit_ offers developers multiple options to integrate.
# Application Integration
The _hawkBit_ [Management API](management-api.html) allows applications to manage the repository and trigger provisioning operations. It is in general feature compliant with the _Management UI_. However, small differences may occur here and there. The authentication and authorization structure is identical, i.e. a user can login both at Management API and UI with the same credentials and has the same permissions available.
# Device Integration
For device integration two options exist.
The [Direct Device Integration API](ddi-api.html) allows direct integration from the device to the _hawkBit_ server. It has been designed with simplicity in mind as its is fully focused on software update. It allows device integrators to separate concerns by means of having distinguished channels for business data and general device management tasks on one side and software update on the other. As a result it is possible to keep the _lifesaving_ provisioning process controller on the device separate from the more complex business functionality. A benefit of such an architecture should not be underestimated.
As result of such a simple HTTP/REST/JSON based API even a major back-end migration or disaster can be covered with simple web server hosting a text file that contains only the command to update one more time to execute a migration on the device. The API was designed on purpose in way to have that last resort even if the plan is that this will never be necessary.
The [Device Management Federation API](dmf-api.html) however allows to combine the business data and _hawkBit_ connectivity. This is especially usefull if a constrained device cannot handle a TLS/HTTP connection, is supporting a standard device management protocol that covers also the software update part (e.g. TR-069, OMA-DM, LWM2M) or the device is already connected and _hawkBit_ is introduced later on.
The decision for the right device integration path is up to the integration party.

6
docs/src/main/resources/documentation/interfaces/managementapi/distributionsets.md
View File

@@ -1,6 +0,0 @@
---
layout: documentation
title: Management-API
---
<iframe src="../../rest-api/distributionsets-api-guide.html"></iframe>

6
docs/src/main/resources/documentation/interfaces/managementapi/distributionsettag.md
View File

@@ -1,6 +0,0 @@
---
layout: documentation
title: Management-API
---
<iframe src="../../rest-api/distributionsettag-api-guide.html"></iframe>

7
docs/src/main/resources/documentation/interfaces/managementapi/distributionsettypes.md
View File

@@ -1,7 +0,0 @@
---
layout: documentation
title: Management-API
---
<iframe src="../../rest-api/distributionsettypes-api-guide.html"></iframe>

6
docs/src/main/resources/documentation/interfaces/managementapi/rollouts.md
View File

@@ -1,6 +0,0 @@
---
layout: documentation
title: Management-API
---
<iframe src="../../rest-api/rollout-api-guide.html"></iframe>

6
docs/src/main/resources/documentation/interfaces/managementapi/softwaremodules.md
View File

@@ -1,6 +0,0 @@
---
layout: documentation
title: Management-API
---
<iframe src="../../rest-api/softwaremodules-api-guide.html"></iframe>

6
docs/src/main/resources/documentation/interfaces/managementapi/softwaremoduletypes.md
View File

@@ -1,6 +0,0 @@
---
layout: documentation
title: Management-API
---
<iframe src="../../rest-api/softwaremoduletypes-api-guide.html"></iframe>

6
docs/src/main/resources/documentation/interfaces/managementapi/targetfilters.md
View File

@@ -1,6 +0,0 @@
---
layout: documentation
title: Management-API
---
<iframe src="../../rest-api/targetfilters-api-guide.html"></iframe>

6
docs/src/main/resources/documentation/interfaces/managementapi/targets.md
View File

@@ -1,6 +0,0 @@
---
layout: documentation
title: Management-API
---
<iframe src="../../rest-api/targets-api-guide.html"></iframe>

Some files were not shown because too many files have changed in this diff Show More