-
Notifications
You must be signed in to change notification settings - Fork 616
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鈥檒l occasionally send you account related emails.
Already on GitHub? Sign in to your account
Quarkus Embedded Docs #10746
Merged
domiborges
merged 3 commits into
infinispan:main
from
ryanemerson:add_quarkus_modules_to_bom
Apr 21, 2023
Merged
Quarkus Embedded Docs #10746
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
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
13 changes: 13 additions & 0 deletions
13
documentation/src/main/asciidoc/stories/assembly_quarkus_embedded.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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
[id='quarkus_embedded'] | ||
:context: quarkus | ||
= Using the Quarkus extension | ||
{brandname} provides an extension that integrates with the Quarkus framework. | ||
The extension lets you create natively compiled {brandname} applications. | ||
|
||
include::{topics}/ref_quarkus_dependencies.adoc[leveloffset=+1] | ||
include::{topics}/proc_quarkus_injecting_embedded.adoc[leveloffset=+1] | ||
include::{topics}/proc_quarkus_native_compilation.adoc[leveloffset=+1] | ||
|
||
// Restore the parent context. | ||
ifdef::parent-context[:context: {parent-context}] | ||
ifndef::parent-context[:!context:] |
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
4 changes: 4 additions & 0 deletions
4
documentation/src/main/asciidoc/topics/dependencies_maven/cdi_embedded_quarkus.xml
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,4 @@ | ||
<dependency> | ||
<groupId>org.infinispan</groupId> | ||
<artifactId>infinispan-quarkus-embedded</artifactId> | ||
</dependency> |
26 changes: 26 additions & 0 deletions
26
documentation/src/main/asciidoc/topics/proc_quarkus_injecting_embedded.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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
[id='quarkus_inject_embedded'] | ||
= Injecting Embedded Caches | ||
Inject a `EmbeddedCacheManager` instance into your Quarkus application to interact with {brandname} caches.. | ||
|
||
.Procedure | ||
|
||
. Optional: Use the `quarkus.infinispan-embedded.xml-config` property to set the path to an XML file that includes the configuration of the injected instance. | ||
+ | ||
[source,java] | ||
---- | ||
quarkus.infinispan-embedded.xml-config=/example/path/to/config.xml | ||
---- | ||
. Add the `@Inject` annotation to an uninitialized `EmbeddedCacheManager` class variable. | ||
+ | ||
[source,java] | ||
---- | ||
import javax.inject.Inject; | ||
import org.infinispan.manager.EmbeddedCacheManager; | ||
... | ||
@Path("/example") | ||
public class ExampleResource { | ||
|
||
@Inject | ||
EmbeddedCacheManager emc; | ||
} | ||
---- |
15 changes: 15 additions & 0 deletions
15
documentation/src/main/asciidoc/topics/proc_quarkus_native_compilation.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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
[id='quarkus_native_compilation'] | ||
= Compiling Quarkus {brandname} application | ||
Generate a native executable for Quarkus {brandname} application. | ||
|
||
.Prerequisites | ||
|
||
* Have a Quarkus based project. For a complete list of prerequisites, see link:https://quarkus.io/guides/building-native-image#prerequisites[Quarkus native prerequisites]. | ||
|
||
.Procedure | ||
* Natively compile your Quarkus {brandname} application: | ||
+ | ||
[source] | ||
---- | ||
mvn clean package -Pnative | ||
---- |
8 changes: 8 additions & 0 deletions
8
documentation/src/main/asciidoc/topics/ref_quarkus_dependencies.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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
[id='quarkus_embedded_dependencies'] | ||
= Quarkus dependencies | ||
Include the {brandname} Quarkus extension in your `pom.xml`: | ||
|
||
.Embedded mode | ||
---- | ||
include::dependencies_maven/cdi_embedded_quarkus.xml[] | ||
---- |
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.
Maybe "Getting started with {brandname} Quarkus embedded extension"?