Skip to content
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

[EAP7-1941] Add jaxrs-jwt quickstart to the EAP quickstarts repo #488

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
117 changes: 117 additions & 0 deletions quickstarts/EAP7-1941-add-jaxrs-jwt-to-EAP-quickstarts.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
= Add jaxrs-jwt to the EAP quickstarts
:author: Farah Juma
:email: [email protected]
:toc: left
:icons: font
:idprefix:
:idseparator: -

== Overview

The jaxrs-jwt quickstart is currently a community-only quickstart because it's not part of the EAP quickstarts repo.
Nothing else demonstrates how to configure this so it should be added to the EAP quickstarts as well.

== Issue Metadata

=== Issue

* https://issues.redhat.com/browse/EAP7-1940[EAP7-1940]
* https://issues.redhat.com/browse/WFLY-16472[WFLY-16472]

=== Related Issues


=== Dev Contacts

* mailto:{email}[{author}]

=== QE Contacts

=== 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
* [ ] Engineering

* [ ] QE

=== Affected Projects or Components

=== Other Interested Projects

=== Relevant Installation Types
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does are these mode corrects?

  • I don't see a Managed domain and bootable-jar instrusction in the WildFly QS. I think this isn't supported case.
  • OpenShift Instruction are there but the helm chart is missing in the WildFly QS.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.

Copy link
Contributor

@emmartins emmartins Sep 10, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@fjuma can you please revert the removal of OpenShift support? The OS support is there already, this was simply a bug that I am fixing now at WFLY-19719

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.

// 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

* [ ] Bootable jar

== Requirements

=== Hard Requirements

* The https://github.com/wildfly/quickstart/tree/main/jaxrs-jwt[jaxrs-jwt] quickstart will be added to the EAP 8 Quickstarts
deliverable, i.e. it will be included in the Quickstarts zip distribution and in the EAP 8 related branches and tags at the
public repo https://github.com/jboss-developer/jboss-eap-quickstarts.

* This quickstart's `configure-elytron.cli` script will need to be updated because it currently tries to add an
`application-security-domain` mapping called "other" in the Undertow subsystem that already exists in the out of the box
configuration. The script needs to be changed to update the existing resource instead.

=== Nice-to-Have Requirements

=== Non-Requirements

== Backwards Compatibility

// Does this enhancement affect backwards compatibility with previously released
// versions of WildFly?
// Can the identified incompatibility be avoided?

=== Default Configuration

=== Importing Existing Configuration

=== Deployments

=== Interoperability

//== Implementation Plan
////
Delete if not needed. The intent is if you have a complex feature which can
not be delivered all in one go to suggest the strategy. If your feature falls
into this category, please mention the Release Coordinators on the pull
request so they are aware.
////

== Security Considerations

////
Identification if any security implications that may need to be considered with this feature
or a confirmation that there are no security implications to consider.
////

== Test Plan

On the engineering side, manual verification will be done by following
the steps from the quickstart README.

== Community Documentation

The quickstart and its documentation is already in the community.

== Release Note Content
////
Draft verbiage for up to a few sentences on the feature for inclusion in the
Release Note blog article for the release that first includes this feature.
Example article: http://wildfly.org/news/2018/08/30/WildFly14-Final-Released/.
This content will be edited, so there is no need to make it perfect or discuss
what release it appears in. "See Overview" is acceptable if the overview is
suitable. For simple features best covered as an item in a bullet-point list
of features containing a few words on each, use "Bullet point: <The few words>"
////
A new jaxrs-jwt quickstart that demonstrates a JAX-RS secured application using
JSON Web Tokens (JWT) has been added to the EAP quickstarts.