Merge pull request #533 from xstefank/WFLY-18383

WFLY-18383 Quickstart for MicroProfile LRA

microprofile/WFLY-18383_EAP7-2105_quickstart-for-microprofile-lra.adoc

@@ -0,0 +1,83 @@
+= WFLY-18383 / EAP7-2105 Quickstart for MP LRA 2.0
+:author:            Martin Stefanko
+:email:             [email protected]
+:toc:               left
+:icons:             font
+:idprefix:
+:idseparator:       -
+
+== Overview
+
+This RFE provides a new quickstart and guide for https://github.com/eclipse/microprofile-lra/tree/2.0[MicroProfile
+LRA 2.0]
+use in WildFly / JBoss EAP. The example will cover all basic functionalities of
+MicroProfile LRA 2.0, namely: The starting and ending of LRA, enlistment in the LRA, and the LRA propagation between
+different services.
+
+== Issue Metadata
+
+=== Issue
+
+* https://issues.redhat.com/browse/EAP7-2105[EAP7-2105]
+* https://issues.redhat.com/browse/WFLY-18383[WFLY-18383]
+
+=== Related Issues
+
+* https://issues.redhat.com/browse/EAP7-1496
+* https://issues.redhat.com/browse/EAP7-2092
+
+=== Dev Contacts
+
+* mailto:[email protected][Martin Stefanko]
+
+=== QE Contacts
+
+* TBD
+
+=== Testing By
+// Put an x in the relevant field to indicate if testing will be done by Engineering or QE.
+// Discuss with QE during the Kickoff state to decide this
+[x] Engineering
+
+[ ] QE
+
+=== Affected Projects or Components
+
+* Quickstarts
+
+=== Other Interested Projects
+
+=== Relevant Installation Types
+// Remove the x next to the relevant field if the feature in question is not relevant
+// to that kind of WildFly installation
+* [x] Traditional standalone server (unzipped or provisioned by Galleon)
+
+* [] Managed domain
+
+* [x] OpenShift s2i
+
+* [x] Bootable jar
+
+
+== Requirements
+
+=== Hard Requirements
+
+* Starting an LRA
+* Closing an LRA successfully
+* Canceling an LRA on failure
+* Definition of compensation and completion callbacks
+* Propagation of LRA between different JAX-RS resources
+* Consuming LRA ID and recovery ID headers
+
+=== Non-Requirements
+
+== Test Plan
+
+* The quickstart will have integration tests verifying the returned 
+values throught the REST API exposed by the quickstart. The endpoints will be
+invoked through the JAX-RS client (resteasy-client test dependency).
+
+== Community Documentation
+
+Covered by the quickstart README file.