diff --git a/MIGRATION.md b/MIGRATION.md index 903edc1b7..67c847269 100644 --- a/MIGRATION.md +++ b/MIGRATION.md @@ -1,40 +1,56 @@ - # hawkBit Migration Guides + ## Release 0.2 + ### Configuration Property changes -- hawkbit.server.controller._ have changed to hawkbit.server.ddi._ -- info.build._ have changed to hawkbit.server.build._ -- hawkbit.server.demo._ have changed to hawkbit.server.ui.demo._ -- hawkbit.server.email.support has changed to hawkbit.server.ui.links.support -- hawkbit.server.email.request.account has changed to hawkbit.server.ui.links.requestAccount -- hawkbit.server.im.login.url has changed to hawkbit.server.ui.links.userManagement + +- `hawkbit.server.controller._` have changed to `hawkbit.server.ddi._` +- `info.build._` have changed to `hawkbit.server.build._` +- `hawkbit.server.demo._` have changed to `hawkbit.server.ui.demo._` +- `hawkbit.server.email.support` has changed to `hawkbit.server.ui.links.support` +- `hawkbit.server.email.request.account` has changed to `hawkbit.server.ui.links.requestAccount` +- `hawkbit.server.im.login.url` has changed to `hawkbit.server.ui.links.userManagement` ### REST API model changes for clients -- ENTITYPagedList classes have been removed; generic PagedList used instead (e.g. PagedList instead of TargetPagedList). -- ENTITYsrest classes have been removed; List used instead (e.g. List instead of TargetsRest) + +- ENTITYPagedList classes have been removed; generic `PagedList` used instead (e.g. `PagedList` instead of `TargetPagedList`). +- ENTITYsrest classes have been removed; `List` used instead (e.g. `List` instead of `TargetsRest`) ### Renamed api annotations + - Annotation `org.eclipse.hawkbit.rest.resource.EnableRestResources` has changed to `org.eclipse.hawkbit.mgmt.annotation.EnableMgmtApi` - Annotation `org.eclipse.hawkbit.ddi.resource.EnableDirectDeviceApi` has changed to `org.eclipse.hawkbit.ddi.annotation.EnableDdiApi` ### Renamed maven modules -- Module hawkbit-mgmt-api-client has changed to hawkbit-example-mgmt-simulator + +- Module `hawkbit-mgmt-api-client` has changed to `hawkbit-example-mgmt-simulator` ## Milestone 0.3.0M6 + ### Configuration Property changes -- hawkbit.server.security.dos.maxTargetsPerManualAssignment has changed to hawkbit.server.security.dos.maxTargetDistributionSetAssignmentsPerManualAssignment + +- `hawkbit.server.security.dos.maxTargetsPerManualAssignment` has changed to `hawkbit.server.security.dos.maxTargetDistributionSetAssignmentsPerManualAssignment` + +## Milestone 0.3.0M7 + +### Configuration Property changes + +- Due to Spring Boot version upgrade (see [spring boot 2.2 deprecations](https://github.com/spring-projects/spring-boot/wiki/Spring-Boot-2.2-Release-Notes#deprecations-in-spring-boot-22)) `server.use-forward-headers` has changed to `server.forward-headers-strategy` ## Upgrade from Master Branch (after 0.3.0M6) to 0.3.0M7 + Due to changes in the DB migration scripts within PR [#1017](https://github.com/eclipse/hawkbit/pull/1017) the Hawkbit will not start up if one of the following cases is true: + - DB2 database is used -- MSSQL database is used and the sp_action table is not empty -- PostgreSql database is used and the sp_action table is not empty +- MSSQL database is used and the `sp_action` table is not empty +- PostgreSql database is used and the `sp_action` table is not empty The script was fixed with PR [#1061](https://github.com/eclipse/hawkbit/pull/1061). In case you upgrade from 0.3.0M6 to 0.3.0M7 there is no issue. But if you have built the Hawkbit from the master branch between PR [#1017](https://github.com/eclipse/hawkbit/pull/1017) and PR [#1061](https://github.com/eclipse/hawkbit/pull/1061), use PostgreSQL or MSSQL and upgrade to 0.3.0M7, it will fail at startup with the message: `Validate failed: Migration checksum mismatch for migration version 1.12.16` This can be fixed by adapting the schema_version table of the database. The checksum field of the entry with the version 1.12.16 has to be changed (mind the minus): + - -1684307461 for MSSQL - -596342656 for PostgreSql diff --git a/README.md b/README.md index c36f960d1..83abca18b 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ Next to the hawkBit core hosted here the project maintains as well [examples](ht We offer a sandbox installation that is free for everyone to try out hawkBit. However, keep in mind that the sandbox database will be reset from time to time. It is also not possible to upload any artifacts into the sandbox. But you can use it to try out the Management UI, Management API and DDI API. Keep in mind as well that you are not permitted to store any kind of personal data in the sandbox. -[https://hawkbit.eclipse.org](https://hawkbit.eclipse.org) +[https://hawkbit.eclipseprojects.io/UI/login](https://hawkbit.eclipseprojects.io/UI/login) In addition the following vendors offer free trial accounts for their hawkBit compatible products: @@ -38,6 +38,7 @@ In addition the following vendors offer free trial accounts for their hawkBit co - [Kynetics Update Factory](https://www.kynetics.com/iot-platform-update-factory) # Device Integration + hawkBit exposes HTTP/JSon based [Direct Device Integration (API) API](https://www.eclipse.org/hawkbit/apis/ddi_api/) that allow any update client to integrate quite easily. The [Eclipse Hara subproject](https://projects.eclipse.org/projects/iot.hawkbit.hara) aims to provide a reference agent software implementation of the Eclipse hawkBit device API. At the moment the project provides the [hara-ddiclient](https://github.com/eclipse/hara-ddiclient) Kotlin library that facilitates and speeds up the development of DDI API clients running on the JVM. The library is expected to soon see its first release under the Eclipse umbrella, and has been successfully used in production for years under its previous guise. @@ -57,14 +58,14 @@ There are clients outside of the Eclipse IoT eco system as well, e.g.: ## SQL database -| Database | H2 | MySQL/MariaDB | MS SQL Server | PostgreSQL | IBM DB2 | +| Database | H2 | MySQL/MariaDB | MS SQL Server | PostgreSQL | IBM DB2 | | --------------------------------- | :----------------------------------------------------: | :-------------------------------------------------------------------------: | :--------------------------------------------------------------: | :----------------------------------------------------------------: | :----------------: | -| DDLs maintained by project | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | -| Test dependencies defined | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | | -| Versions tested | 1.4 | MySQL 5.6/5.7, AWS Aurora | MS SQL Server 2017/2019 | PostgreSQL 12/13 | DB2 Server v11.1 | -| Docker image with driver provided | :white_check_mark: | :white_check_mark: (Tag: "-mysql") | :white_check_mark: | :white_check_mark: | | +| DDLs maintained by project | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | +| Test dependencies defined | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | | +| Versions tested | 1.4 | MySQL 5.6/5.7, AWS Aurora | MS SQL Server 2017/2019 | PostgreSQL 12/13 | DB2 Server v11.1 | +| Docker image with driver provided | :white_check_mark: | :white_check_mark: (Tag: "-mysql") | :white_check_mark: | :white_check_mark: | | | JDBC driver | [H2 1.4.200](https://github.com/h2database/h2database) | [MariaDB Connector/J 2.6.2](https://github.com/MariaDB/mariadb-connector-j) | [MSSQL-JDBC 7.4.1.jre8](https://github.com/Microsoft/mssql-jdbc) | [PostgreSQL JDBC Driver 42.2.14](https://github.com/pgjdbc/pgjdbc) | | -| Status | Test, Dev | Production grade | Production grade | Test, Dev | Test, Dev | +| Status | Test, Dev | Production grade | Production grade | Test, Dev | Test, Dev | ## (Optional) RabbitMQ: 3.6,3.7,3.8