-
Notifications
You must be signed in to change notification settings - Fork 565
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[4x] [Doc] - Migration guides #7715
Merged
Merged
Changes from all commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
d7737d6
Migration guide 4. Initial commit.
dalexandrov 45e9131
Migration guide 4. Next steps.
dalexandrov 1844465
Extend Helidon SE migration doc.
dalexandrov d3df9c0
Extend migration docs
dalexandrov d5f28e8
Minor fixes
dalexandrov ad52d8a
Extend documentation
dalexandrov 0896d73
Minor fixes
dalexandrov 374fd4b
DOCS: 4x updates to the general doc (#7673)
ljamen 3a516c6
Migration guide 4. Initial commit.
dalexandrov 1e83381
Add Global Config
dalexandrov 422254d
MP Guide fix
dalexandrov e6af959
Add to sitegen
dalexandrov cdc0443
Migrate to upgrade
dalexandrov 42c4852
Copyright fix
dalexandrov c33b9df
Add security changed modules
dalexandrov File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| /////////////////////////////////////////////////////////////////////////////// | ||
|
|
||
| Copyright (c) 2023 Oracle and/or its affiliates. | ||
|
|
||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
|
|
||
| /////////////////////////////////////////////////////////////////////////////// | ||
|
|
||
| = Upgrading from 3.x | ||
| :description: Helidon Upgrade Guide | ||
| :keywords: helidon upgrade migration | ||
|
|
||
| include::../attributes.adoc[] | ||
|
|
||
| == Upgrade Guides | ||
|
|
||
| Helidon 4.x is not fully backwards compatible with Helidon 3.x. For information | ||
| concerning upgrading from Helidon 3.x to 4.x see the following upgrade guides: | ||
|
|
||
| * xref:../mp/guides/upgrade_4x.adoc[Helidon MP 4.x Upgrade Guide] | ||
| * xref:../se/guides/upgrade_4x.adoc[Helidon SE 4.x Upgrade Guide] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
docs/mp/guides/migration_3x.adoc → docs/mp/guides/upgrade_3x.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,191 @@ | ||
| /////////////////////////////////////////////////////////////////////////////// | ||
|
|
||
| Copyright (c) 2023 Oracle and/or its affiliates. | ||
|
|
||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
|
|
||
| /////////////////////////////////////////////////////////////////////////////// | ||
|
|
||
| = Helidon MP 4.x Upgrade Guide | ||
| :description: Helidon MP 4.x Upgrade Guide | ||
| :keywords: helidon, porting, migration, upgrade, incompatibilities, 3.x | ||
| :rootdir: {docdir}/../.. | ||
|
|
||
| include::{rootdir}/includes/mp.adoc[] | ||
|
|
||
|
|
||
| In Helidon 4.x we have made some changes to APIs and runtime behavior. This guide | ||
| will help you upgrade a Helidon MP 3.x application to 4.x. | ||
|
|
||
|
|
||
| == Java 21 Runtime | ||
|
|
||
| Java 17 is no longer supported in Helidon 4. Java 21 or newer is required. Please follow the instructions in xref:{rootdir}/about/prerequisites.adoc[Prerequisites] for proper installation. | ||
|
|
||
| Helidon 4 no longer uses Netty. Helidon MP is now running on Helidon WebServer which is based on Virtual threads technology, available in Java 21. | ||
|
|
||
|
|
||
| == MicroProfile 6.0 support | ||
|
|
||
| MicroProfile 6.0 enables MicroProfile APIs to be used together with Jakarta EE 10 Core Profile. | ||
|
|
||
| MicroProfile 6.0 is an umbrella for the following specifications and their corresponding versions: | ||
|
|
||
| * Open Telemetry {version-lib-microprofile-telemetry} | ||
| * MicroProfile Config {version-lib-microprofile-config} | ||
| * MicroProfile Fault Tolerance {version-lib-microprofile-fault-tolerance-api} | ||
| * MicroProfile Health {version-lib-microprofile-health} | ||
| * MicroProfile JWT Authentication {version-lib-microprofile-jwt} | ||
| * MicroProfile Metrics {version-lib-microprofile-metrics-api} | ||
| * MicroProfile OpenAPI {version-lib-microprofile-openapi-api} | ||
| * MicroProfile Rest Client {version-lib-microprofile-rest-client} | ||
|
|
||
| Includes: | ||
|
|
||
| * Jakarta EE Core Profile {version-lib-jakarta-core} | ||
|
|
||
| Helidon 4.x supports the following Jakarta EE specifications: | ||
|
|
||
| * CDI (Jakarta Contexts and Dependency Injection) {version-lib-jakarta-cdi} | ||
| * JAX-RS (Jakarta RESTful Web Services) {version-lib-jakarta-jaxrs-api} | ||
| * JSON-B (Jakarta JSON Binding) {version-lib-jakarta-jsonb-api} | ||
| * JSON-P (Jakarta JSON Processing) {version-lib-jakarta-jsonp-api} | ||
| * Jakarta Annotations {version-lib-jakarta-annotations-api} | ||
| * Jakarta Persistence API {version-lib-jakarta-persistence-api} | ||
| * Jakarta Transactions API {version-lib-jakarta-transaction-api} | ||
| * Jakarta WebSocket API {version-lib-jakarta-websockets-api} | ||
| * Jakarta Bean Validation {version-lib-jakarta-bean-validation} | ||
|
|
||
| Corresponding changes to Helidon code were made to support the corresponding specifications' versions. | ||
|
|
||
| === MicroProfile specifications | ||
|
|
||
| Most of the MicroProfile specifications had relatively minor changes. The exception is Metrics which had substantial changes. | ||
|
|
||
| * *MicroProfile Config {version-lib-microprofile-config}*: | ||
| + | ||
| Incompatible changes described in link:https://download.eclipse.org/microprofile/microprofile-config-3.0.1/microprofile-config-spec-3.0.1.html#_incompatible_changes[MicroProfile Config {version-lib-microprofile-config} Specification] | ||
|
|
||
| * *MicroProfile Fault Tolerance {version-lib-microprofile-fault-tolerance-api}*: | ||
| + | ||
| Incompatible changes described in link:https://download.eclipse.org/microprofile/microprofile-fault-tolerance-4.0.2/microprofile-fault-tolerance-spec-4.0.2.html#_backward_incompatible_changes=[MicroProfile Fault Tolerance {version-lib-microprofile-fault-tolerance-api} Specification] | ||
|
|
||
| * *MicroProfile Health {version-lib-microprofile-health}*: | ||
| + | ||
| Incompatible changes described in link:https://download.eclipse.org/microprofile/microprofile-health-4.0/microprofile-health-spec-4.0.html#_incompatible_changes[MicroProfile Health {version-lib-microprofile-health} Specification] | ||
|
|
||
| * *MicroProfile JWT Authentication {version-lib-microprofile-jwt}*: | ||
| + | ||
| Incompatible changes described in link:https://download.eclipse.org/microprofile/microprofile-jwt-auth-2.0/microprofile-jwt-auth-spec-2.0.html#_incompatible_changes[MicroProfile JWT Authentication {version-lib-microprofile-jwt} Specification] | ||
|
|
||
| * *MicroProfile Metrics {version-lib-microprofile-metrics-api}*: | ||
| + | ||
| Incompatible changes described in link:https://download.eclipse.org/microprofile/microprofile-metrics-5.0/microprofile-metrics-spec-5.0.html#_incompatible_changes[MicroProfile Metrics {version-lib-microprofile-metrics-api} Specification] | ||
|
|
||
| * *MicroProfile OpenAPI {version-lib-microprofile-openapi-api}*: | ||
| + | ||
| Incompatible changes described in link:https://download.eclipse.org/microprofile/microprofile-open-api-3.1/microprofile-openapi-spec-3.1.html#incompatible_changes_30[MicroProfile OpenAPI {version-lib-microprofile-openapi-api} Specification] | ||
|
|
||
| * *MicroProfile Rest Client {version-lib-microprofile-rest-client}*: | ||
| + | ||
| Incompatible changes described in link:https://download.eclipse.org/microprofile/microprofile-rest-client-3.0/microprofile-rest-client-spec-3.0.html#_incompatible_changes[MicroProfile Rest Client {version-lib-microprofile-rest-client} Specification] | ||
|
|
||
| === Supported Jakarta EE specifications | ||
|
|
||
| * *CDI (Jakarta Contexts and Dependency Injection) {version-lib-jakarta-cdi}*: | ||
| + | ||
| Changes described in link:https://jakarta.ee/specifications/cdi/4.0/jakarta-cdi-spec-4.0.html#architecture[CDI (Jakarta Contexts and Dependency Injection) {version-lib-jakarta-cdi} Specification] | ||
|
|
||
| * *JAX-RS (Jakarta RESTful Web Services) {version-lib-jakarta-jaxrs-api}*: | ||
| + | ||
| Changes described in link:https://download.eclipse.org/microprofile/microprofile-rest-client-3.0/microprofile-rest-client-spec-3.0.html#_incompatible_changes[JAX-RS (Jakarta RESTful Web Services) {version-lib-jakarta-jaxrs-api}Specification] | ||
|
|
||
| * *JSON-B (Jakarta JSON Binding) {version-lib-jakarta-jsonb-api}*: | ||
| + | ||
| Changes described in link:https://jakarta.ee/specifications/jsonb/2.0/jakarta-jsonb-spec-2.0.html#change-log[JSON-B (Jakarta JSON Binding) {version-lib-jakarta-jsonb-api} Specification] | ||
|
|
||
|
|
||
| * *Jakarta Annotations {version-lib-jakarta-annotations-api}*: | ||
| + | ||
| Full information in link:https://jakarta.ee/specifications/annotations/2.0/annotations-spec-2.0.html[Jakarta Annotations {version-lib-jakarta-annotations-api} Specification] | ||
|
|
||
| * *Jakarta Persistence API {version-lib-jakarta-persistence-api}*: | ||
| + | ||
| Changes described in link:https://jakarta.ee/specifications/persistence/3.0/jakarta-persistence-spec-3.0.html#revision-history[Jakarta Persistence API {version-lib-jakarta-persistence-api} Specification] | ||
|
|
||
| * *Jakarta Transactions API {version-lib-jakarta-transaction-api}*: | ||
| + | ||
| Changes described in link:https://jakarta.ee/specifications/transactions/2.0/jakarta-transactions-spec-2.0.html#revision-history[Jakarta Transactions API {version-lib-jakarta-transaction-api} Specification] | ||
|
|
||
| * *Jakarta WebSocket API {version-lib-jakarta-websockets-api}*: | ||
| + | ||
| Changes described in link:https://jakarta.ee/specifications/websocket/2.0/websocket-spec-2.0.html#changes[Jakarta WebSocket API {version-lib-jakarta-websockets-api} Specification] | ||
|
|
||
| * *Jakarta Bean Validation {version-lib-jakarta-bean-validation}*: | ||
| + | ||
| Changes described in link:https://jakarta.ee/specifications/bean-validation/2.0/bean-validation_2.0.html#changelog[Jakarta Bean Validation {version-lib-jakarta-bean-validation} Specification] | ||
|
|
||
| NOTE: Please, read each specification carefully for incompatible changes! | ||
|
|
||
| === Significant changes | ||
|
|
||
| ==== Smallrye | ||
|
|
||
| Smallrye group id was `org.jboss.jandex` and now is `io.smallrye`. | ||
|
|
||
| ==== Metrics and observability | ||
|
|
||
| The correct work of observability in quickstarts now requires dependencies: | ||
|
|
||
| [source, xml] | ||
| ---- | ||
| <dependency> | ||
| <groupId>io.helidon.webserver.observe</groupId> | ||
| <artifactId>helidon-webserver-observe-metrics</artifactId> | ||
| <scope>runtime</scope> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>io.helidon.metrics</groupId> | ||
| <artifactId>helidon-metrics-system-meters</artifactId> | ||
| <scope>runtime</scope> | ||
| </dependency> | ||
| ---- | ||
|
|
||
| ==== Testing | ||
|
|
||
| Testing is now in a new package. It was: | ||
|
|
||
| [source, xml] | ||
| ---- | ||
| <dependency> | ||
| <groupId>io.helidon.microprofile.tests</groupId> | ||
| <artifactId>helidon-microprofile-tests-junit5</artifactId> | ||
| <scope>test</scope> | ||
| </dependency> | ||
| ---- | ||
|
|
||
| Now is: | ||
|
|
||
| [source, xml] | ||
| ---- | ||
| <dependency> | ||
| <groupId>io.helidon.microprofile.testing</groupId> | ||
| <artifactId>helidon-microprofile-testing-junit5</artifactId> | ||
| <scope>test</scope> | ||
| </dependency> | ||
| ---- | ||
|
|
||
|
|
||
| == Conclusion | ||
|
|
||
| Please proceed to xref:../introduction.adoc[Helidon MP Introduction] to find more information and documentation about each module. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this where a new Security section would be added and David's info could be placed?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed