Merge pull request #852 from kabir/glow-readme

Add Glow plugin examples
wildfly · Jan 18, 2024 · b410bbf · b410bbf
2 parents a04efd9 + c836648
commit b410bbf
Show file tree

Hide file tree

Showing 47 changed files with 200 additions and 8 deletions.
diff --git a/batch-processing/README.adoc b/batch-processing/README.adoc
@@ -5,6 +5,7 @@ include::../shared-doc/attributes.adoc[]
 :level: Intermediate
 :technologies: CDI, Batch 1.0, JSF
 :openshift: true
+:portedToGlow: true
 
 [abstract]
 The `batch-processing` quickstart shows how to use chunk oriented batch jobs to import a file to a database.

diff --git a/bmt/README.adoc b/bmt/README.adoc
@@ -5,6 +5,7 @@ include::../shared-doc/attributes.adoc[]
 :level: Intermediate
 :technologies: EJB, BMT
 :openshift: true
+:portedToGlow: true
 
 [abstract]
 The `bmt` quickstart demonstrates Bean-Managed Transactions (BMT), showing how to manually manage transaction demarcation while accessing JPA entities.

diff --git a/cmt/README.adoc b/cmt/README.adoc
@@ -5,6 +5,7 @@ include::../shared-doc/attributes.adoc[]
 :level: Intermediate
 :technologies: EJB, CMT, JMS
 :openshift: true
+:portedToGlow: true
 
 [abstract]
 The `cmt` quickstart demonstrates Container-Managed Transactions (CMT), showing how to use transactions managed by the container.

diff --git a/ee-security/README.adoc b/ee-security/README.adoc
@@ -5,6 +5,7 @@ include::../shared-doc/attributes.adoc[]
 :level: Intermediate
 :technologies: EE Security, Servlet, CDI
 :openshift: true
+:portedToGlow: true
 
 [abstract]
 The `ee-security` quickstart demonstrates Jakarta EE security.

diff --git a/ejb-remote/README.adoc b/ejb-remote/README.adoc
@@ -5,6 +5,7 @@ include::../shared-doc/attributes.adoc[]
 :level: Intermediate
 :technologies: EJB, JNDI
 :openshift: true
+:portedToGlow: true
 
 [abstract]
 The `ejb-remote` quickstart uses EJB and JNDI to demonstrate how to access an EJB, deployed to {productName}, from a remote Java client application.

diff --git a/ejb-security-context-propagation/README.adoc b/ejb-security-context-propagation/README.adoc
@@ -4,6 +4,7 @@ include::../shared-doc/attributes.adoc[]
 :author: Stefan Guilhen
 :level: Advanced
 :technologies: EJB, Security
+:portedToGlow: true
 
 [abstract]
 The `ejb-security-context-propagation` quickstart demonstrates how the security context can be propagated to a remote EJB using a remote outbound connection configuration

diff --git a/ejb-security-programmatic-auth/README.adoc b/ejb-security-programmatic-auth/README.adoc
@@ -4,6 +4,7 @@ include::../shared-doc/attributes.adoc[]
 :author: Stefan Guilhen
 :level: Intermediate
 :technologies: EJB, Security
+:portedToGlow: true
 
 [abstract]
 The `ejb-security-programmatic-auth` quickstart demonstrates how to programmatically setup different identities when invoking a remote secured EJB.

diff --git a/ejb-throws-exception/README.adoc b/ejb-throws-exception/README.adoc
@@ -5,6 +5,7 @@ include::../shared-doc/attributes.adoc[]
 :level: Intermediate
 :technologies: EJB, EAR
 :deploymentDir: ear
+:portedToGlow: true
 
 [abstract]
 The `ejb-throws-exception` quickstart demonstrates how to throw and handle exceptions across JARs in an EAR.

diff --git a/ejb-timer/README.adoc b/ejb-timer/README.adoc
@@ -5,6 +5,7 @@ include::../shared-doc/attributes.adoc[]
 :level: Beginner
 :technologies: EJB Timer
 :openshift: true
+:portedToGlow: true
 
 [abstract]
 The `ejb-timer` quickstart demonstrates how to use the Jakarta Enterprise Bean timer service `@Schedule` and `@Timeout` annotations with {productName}.

diff --git a/ejb-txn-remote-call/README.adoc b/ejb-txn-remote-call/README.adoc
@@ -5,6 +5,7 @@ include::../shared-doc/attributes.adoc[]
 :level: Intermediate
 :technologies: EJB, JTA, Clustering
 :openshift: true
+:portedToGlow: true
 
 [abstract]
 The `ejb-txn-remote-call` quickstart demonstrates remote transactional EJB calls over two application servers of {productName}.

diff --git a/helloworld-jms/README.adoc b/helloworld-jms/README.adoc
@@ -4,6 +4,7 @@ include::../shared-doc/attributes.adoc[]
 :author: Weston Price
 :level: Intermediate
 :technologies: JMS
+:portedToGlow: true
 
 [abstract]
 The `helloworld-jms` quickstart demonstrates the use of external JMS clients with {productName}.

diff --git a/helloworld-mdb/README.adoc b/helloworld-mdb/README.adoc
@@ -5,6 +5,7 @@ include::../shared-doc/attributes.adoc[]
 :level: Intermediate
 :technologies: JMS, EJB, MDB
 :openshift: true
+:portedToGlow: true
 
 [abstract]
 The `helloworld-mdb` quickstart uses JMS and EJB Message-Driven Bean (MDB) to create and deploy JMS topic and queue resources in {productName}.

diff --git a/helloworld-singleton/README.adoc b/helloworld-singleton/README.adoc
@@ -5,6 +5,7 @@ include::../shared-doc/attributes.adoc[]
 :level: Beginner
 :technologies: EJB, Singleton
 :openshift: true
+:portedToGlow: true
 
 [abstract]
 The `helloworld-singleton` quickstart demonstrates an EJB Singleton Bean that is instantiated once and maintains state for the life of the session.

diff --git a/helloworld-ws/README.adoc b/helloworld-ws/README.adoc
@@ -5,6 +5,7 @@ include::../shared-doc/attributes.adoc[]
 :level: Beginner
 :technologies: JAX-WS
 :openshift: true
+:portedToGlow: true
 
 [abstract]
 The `helloworld-ws` quickstart demonstrates a simple Hello World application, bundled and deployed as a WAR, that uses JAX-WS to say Hello.

diff --git a/helloworld/README.adoc b/helloworld/README.adoc
@@ -5,6 +5,7 @@ include::../shared-doc/attributes.adoc[]
 :level: Beginner
 :technologies: Servlet
 :openshift: true
+:portedToGlow: true
 
 [abstract]
 The `helloworld` quickstart demonstrates the use of Servlet 6 and is a good starting point to verify {productName} is configured correctly.

diff --git a/hibernate/README.adoc b/hibernate/README.adoc
@@ -5,6 +5,7 @@ include::../shared-doc/attributes.adoc[]
 :level: Intermediate
 :technologies: Hibernate
 :openshift: true
+:portedToGlow: true
 
 [abstract]
 The `hibernate` quickstart demonstrates how to use Hibernate ORM 6 over Persistence, using Bean Validation, and Enterprise Beans.

diff --git a/http-custom-mechanism/README.adoc b/http-custom-mechanism/README.adoc
@@ -4,6 +4,7 @@ include::../shared-doc/attributes.adoc[]
 :author: Darran Lofthouse
 :level: Intermediate
 :technologies: EJB, Security
+:portedToGlow: true
 
 [abstract]
 The `http-custom-mechanism` quickstart demonstrates how to implement a custom HTTP authentication mechanism that can be registered with Elytron.

diff --git a/jaxrs-client/README.adoc b/jaxrs-client/README.adoc
@@ -5,6 +5,7 @@ include::../shared-doc/attributes.adoc[]
 :level: Beginner
 :technologies: JAX-RS
 :openshift: true
+:portedToGlow: true
 
 [abstract]
 The `jaxrs-client` quickstart demonstrates Jakarta REST Client API, which interacts with a Jakarta REST Web service that runs on {productName}.

diff --git a/jaxrs-jwt/README.adoc b/jaxrs-jwt/README.adoc
@@ -4,6 +4,7 @@ include::../shared-doc/attributes.adoc[]
 :author: Martin Mazanek
 :level: Intermediate
 :technologies: JAX-RS, Security
+:portedToGlow: true
 
 [abstract]
 The `jaxrs-jwt` quickstart demonstrates a Jakarta REST secured application using JSON Web Tokens (JWT) with Elytron.

diff --git a/jaxws-ejb/README.adoc b/jaxws-ejb/README.adoc
@@ -4,6 +4,7 @@ include::../shared-doc/attributes.adoc[]
 :author: R Searls
 :level: Beginner
 :technologies: JAX-WS
+:portedToGlow: true
 
 [abstract]
 The `jaxws-ejb` quickstart is a working example of the web service endpoint created from an EJB.

diff --git a/jaxws-retail/README.adoc b/jaxws-retail/README.adoc
@@ -4,6 +4,7 @@ include::../shared-doc/attributes.adoc[]
 :author: R Searls
 :level: Beginner
 :technologies: JAX-WS
+:portedToGlow: true
 
 [abstract]
 The `jaxws-retail` quickstart is a working example of a simple web service endpoint.

diff --git a/jsonp/README.adoc b/jsonp/README.adoc
@@ -5,6 +5,7 @@ include::../shared-doc/attributes.adoc[]
 :level: Beginner
 :technologies: CDI, JSF, JSON-P
 :openshift: true
+:portedToGlow: true
 
 [abstract]
 The `jsonp` quickstart demonstrates how to use the JSON-P API to produce object-based structures and then parse and consume them as stream-based JSON strings.

diff --git a/kitchensink/README.adoc b/kitchensink/README.adoc
@@ -5,6 +5,7 @@ include::../shared-doc/attributes.adoc[]
 :level: Intermediate
 :technologies: CDI, JSF, JPA, EJB, JAX-RS, BV
 :openshift: true
+:portedToGlow: true
 
 [abstract]
 The `kitchensink` quickstart demonstrates a localized {javaVersion} web-enabled database application using JSF, CDI, EJB, JPA, and Bean Validation.

diff --git a/logging/README.adoc b/logging/README.adoc
@@ -4,6 +4,7 @@ include::../shared-doc/attributes.adoc[]
 :author: Joel Tosi
 :level: Intermediate
 :technologies: Logging
+:portedToGlow: true
 
 [abstract]
 The `logging` quickstart demonstrates how to configure different logging levels in {productName}.

diff --git a/mail/README.adoc b/mail/README.adoc
@@ -4,6 +4,7 @@ include::../shared-doc/attributes.adoc[]
 :author: Joel Tosi
 :level: Beginner
 :technologies: JavaMail, CDI, JSF
+:portedToGlow: true
 
 [abstract]
 The `mail` quickstart demonstrates how to send and receive emails using CDI and JSF and with custom Mail provider configured in {productName}.

diff --git a/microprofile-config/README.adoc b/microprofile-config/README.adoc
@@ -4,6 +4,7 @@ include::../shared-doc/attributes.adoc[]
 :author: Martin Stefanko
 :level: Beginner
 :technologies: MicroProfile Config
+:portedToGlow: true
 
 [abstract]
 The `microprofile-config` quickstart demonstrates the use of the MicroProfile Config specification in {productName}.

diff --git a/microprofile-fault-tolerance/README.adoc b/microprofile-fault-tolerance/README.adoc
@@ -6,6 +6,7 @@ https://github.com/quarkusio/quarkus/tree/master/docs/src/main/asciidoc
 // Needed to correctly render on GitHub
 :productName: WildFly
 :standalone-server-type: microprofile
+:portedToGlow: true
 
 include::../shared-doc/attributes.adoc[]
 

diff --git a/microprofile-health/README.adoc b/microprofile-health/README.adoc
@@ -8,6 +8,7 @@ include::../shared-doc/attributes.adoc[]
 :post-helm-install-actions: ../microprofile-health/expose-management-port.adoc
 :extra-openshift-testing-actions: ../microprofile-health/expose-management-port.adoc
 :extra-openshift-test-arguments: -Dserver.management.host=https://$(oc get route {artifactId}-management --template='{{ .spec.host }}')
+:portedToGlow: true
 
 [abstract]
 The `microprofile-health` quickstart demonstrates the use of the MicroProfile Health specification in {productName}.

diff --git a/microprofile-jwt/README.adoc b/microprofile-jwt/README.adoc
@@ -4,6 +4,7 @@ include::../shared-doc/attributes.adoc[]
 :author: Darran Lofthouse
 :level: Intermediate
 :technologies: JWT, Security, MicroProfile
+:portedToGlow: true
 
 [abstract]
 The `microprofile-jwt` quickstart demonstrates the use of the MicroProfile JWT specification in {productName}.

diff --git a/microprofile-lra/README.adoc b/microprofile-lra/README.adoc
@@ -4,6 +4,7 @@ include::../shared-doc/attributes.adoc[]
 :author: Martin Stefanko
 :level: Beginner
 :technologies: MicroProfile LRA
+:portedToGlow: true
 
 [abstract]
 The `microprofile-lra` quickstart demonstrates the use of the MicroProfile LRA specification in {productName}.

diff --git a/microprofile-openapi/README.adoc b/microprofile-openapi/README.adoc
@@ -4,6 +4,7 @@ include::../shared-doc/attributes.adoc[]
 :author: Paul Ferraro
 :level: Beginner
 :technologies: MicroProfile OpenAPI
+:portedToGlow: true
 
 [abstract]
 This guide demonstrate how to use the MicroProfile OpenAPI functionality in {productName} to expose an OpenAPI document for a simple REST application.

diff --git a/microprofile-reactive-messaging-kafka/README.adoc b/microprofile-reactive-messaging-kafka/README.adoc
@@ -4,6 +4,7 @@ include::../shared-doc/attributes.adoc[]
 :author: Kabir Khan
 :level: Beginner
 :technologies: MicroProfile Reactive Messaging
+:portedToGlow: true
 
 [abstract]
 The `microprofile-reactive-messaging-kafka` quickstart demonstrates the use of the MicroProfile Reactive Messaging specification backed by Apache Kafka in {productName}.

diff --git a/microprofile-rest-client/README.adoc b/microprofile-rest-client/README.adoc
@@ -4,6 +4,7 @@ include::../shared-doc/attributes.adoc[]
 :author: Martin Stefanko
 :level: Beginner
 :technologies: MicroProfile REST Client
+:portedToGlow: true
 
 [abstract]
 The `microprofile-rest-client` quickstart demonstrates the use of the MicroProfile REST Client specification in {productName}.

diff --git a/numberguess/README.adoc b/numberguess/README.adoc
@@ -5,6 +5,7 @@ include::../shared-doc/attributes.adoc[]
 :level: Beginner
 :technologies: CDI, JSF
 :openshift: true
+:portedToGlow: true
 
 [abstract]
 The `numberguess` quickstart demonstrates the use of CDI  (Contexts and Dependency Injection) and JSF (JavaServer Faces) in {productName}.

diff --git a/remote-helloworld-mdb/README.adoc b/remote-helloworld-mdb/README.adoc
@@ -5,6 +5,7 @@ include::../shared-doc/attributes.adoc[]
 :level: Intermediate
 :technologies: JMS, EJB, MDB
 :openshift: true
+:portedToGlow: true
 
 :standalone-server-type: full
 :archiveType: war

diff --git a/servlet-async/README.adoc b/servlet-async/README.adoc
@@ -5,6 +5,7 @@ include::../shared-doc/attributes.adoc[]
 :level: Intermediate
 :technologies: Asynchronous Servlet, CDI, EJB
 :openshift: true
+:portedToGlow: true
 
 [abstract]
 The `servlet-async` quickstart demonstrates how to use asynchronous servlets to detach long-running tasks and free up the request processing thread.

diff --git a/servlet-filterlistener/README.adoc b/servlet-filterlistener/README.adoc
@@ -5,6 +5,7 @@ include::../shared-doc/attributes.adoc[]
 :level: Intermediate
 :technologies: Servlet Filter, Servlet Listener
 :openshift: true
+:portedToGlow: true
 
 [abstract]
 The `servlet-filterlistener` quickstart demonstrates how to use Servlet filters and listeners in an application.

diff --git a/servlet-security/README.adoc b/servlet-security/README.adoc
@@ -5,6 +5,7 @@ include::../shared-doc/attributes.adoc[]
 :level: Intermediate
 :technologies: Servlet, Security
 :openshift: true
+:portedToGlow: true
 
 [abstract]
 The `servlet-security` quickstart demonstrates the use of Jakarta EE declarative security to control access to Servlets and Security in {productName}.

diff --git a/shared-doc/build-and-run-the-quickstart-with-bootable-jar.adoc b/shared-doc/build-and-run-the-quickstart-with-bootable-jar.adoc
@@ -5,6 +5,7 @@ You can use the WildFly JAR Maven plug-in to build a {productName} bootable JAR
 
 The quickstart `pom.xml` file contains a Maven profile named *bootable-jar* which configures the bootable JAR building:
 
+ifndef::portedToGlow[]
 [source,xml,subs="attributes+"]
 ----
       <profile>
@@ -34,6 +35,56 @@ The quickstart `pom.xml` file contains a Maven profile named *bootable-jar* whic
           </build>
       </profile>
 ----
+endif::portedToGlow[]
+ifdef::portedToGlow[]
+[source,xml,subs="attributes+"]
+----
+      <profile>
+          <id>bootable-jar</id>
+          <build>
+              <plugins>
+                  <plugin>
+                      <groupId>org.wildfly.plugins</groupId>
+                      <artifactId>wildfly-maven-plugin</artifactId>
+                      <configuration>
+                          <discover-provisioning-info>
+                              <version>${version.server}</version>
+                          </discover-provisioning-info>
+                          <bootable-jar>true</bootable-jar>
+                          <!--
+                            Rename the output war to ROOT.war before adding it to the server, so that the
+                            application is deployed in the root web context.
+                          -->
+                          <name>ROOT.war</name>
+                          <add-ons>...</add-ons>
+                      </configuration>
+                      <executions>
+                          <execution>
+                              <goals>
+                                  <goal>package</goal>
+                              </goals>
+                          </execution>
+                      </executions>
+                  </plugin>
+                  ...
+              </plugins>
+          </build>
+      </profile>
+----
+The plugin uses https://github.com/wildfly/wildfly-glow[WildFly Glow] to discover the feature packs and layers required to run the application, and provisions a server containing those layers.
+
+[NOTE]
+====
+This uses a pre-release of version 5.0.0 of the wildfly-maven-plugin providing the Glow functionality. The version is set in the pom's `pluginManagement` section.
+====
+
+If you get an error or the server is missing some functionality which cannot be auto-discovered, you can download the https://github.com/wildfly/wildfly-glow/releases/tag[WildFly Glow CLI] and run the following command to see more information about what add-ons are available:
+
+[source,shell]
+----
+wildfly-glow show-add-ons
+----
+endif::portedToGlow[]
 
 .Procedure