Comprehensive documentation for how to package SwitchYard application in JAR, WAR, and EAR is missing.
You can find the community version at:
so at least productisation of this documentation is necessary, but also a more verbose and comprehensible one with working examples would be better.
Just noting this will also need to incorporate Karaf and Fabric for 6.1
The helpdesk quickstart mentioned in the community documentation is not included with the product. Do you know if any of the supplied product quickstarts demonstrate packaging as a WAR?
(This information will be best placed in our new Administration & Configuration Guide.)
(In reply to belong from comment #2)
> The helpdesk quickstart mentioned in the community documentation is not
> included with the product. Do you know if any of the supplied product
> quickstarts demonstrate packaging as a WAR?
The demos/orders and demos/multiApp/web quickstarts included in FSW are both WAR apps. I think demos/orders is better for the demonstrating purpose.
But maybe it should be better to confirm with SOA-PM why demos/helpdesk is omitted from the product and if they think demos/orders can be used instead for the documentation purposes.
Email sent to soa-pm-list. Waiting on response.
I have added topic 41611, Packaging for SwitchYard to the content spec for the FSW Admin and Config Guide 6.0.
This topic will also be added to the FSw Admin and Config Guide 6.1, but it will need to have the versions updated, and more information added for Karaf.
Thank you, Nichola!
Just a few suggestions:
Do you think it would be a good idea to split this into two topics: 'Packaging SwitchYard Applications' and 'Deploying SwitchYard Applications', with the content currently under 'Available Runtimes' in the latter?
"SwitchYard 1.0 supports deployment into JBoss EAP 6.1.": I think that in the community it is important to mention versions, but for the product, I don't think users should have to care about versions. I think we can assume the versions are those shipped with the product. The versions of community components used are provided elsewhere already if they really want to know. Also, perhaps we should not present this from the perspective of SwitchYard, but the perspective of the product or user. "You can deploy SwitchYard applications on the application server (JBoss EAP) using..."
"EAP": "JBoss EAP" is the shortest abbreviation we're supposed to use.
What do you think?
I think you're right! I'll split them and amend the focus.
Thank you, Tadayoshi. This is valuable feedback.
Although I agree that for 6.0 we can remove the heading 'Available Runtimes', I am not sure about changing the phrase "You can deploy SwitchYard applications into JBoss EAP using..."
The way I see it, applications are still deployed on JBoss EAP. I think it is confusing to say that they are deployed on FSW, since FSW is simply a set of components. This will be even more important to make clear in 6.2, in which applications will be deployed on either JBoss EAP or JBoss Fuse, depending on their installation.
I understand your point and it makes sense considering 6.2 supports both EAP and Fuse.
By the phrase "You can deploy SwitchYard applications into JBoss EAP using...", I just felt wary about readers misunderstanding that SY applications can literaly be deployed into JBoss EAP, not only FSW. Of course, users cannot deploy SY apps into a JBoss EAP distribution.
If you can think of any better phrases that make both points clear, that would be great.
Thank you for your input, Tadayoshi. Perhaps for 6.0, something like: "You can deploy SwitchYard applications on the server using..."
Thanks, Tadayoshi. I was on leave but I'll get straight on to these very useful contributions.
*** Bug 1152643 has been marked as a duplicate of this bug. ***
After consideration and discussion, I have made the changes suggested by Tadayoshi.
The following topics have been updated:
41611 revision 717993
41633 revision 711806
I've uncommented these topics in the Administration and Configuration Guide - Working Copy content spec under the title 'Packaging and Deployment for Switchyard'.
They are now ready for review.
41611 revision 719559
41633 revision 711806
I have created another bug (Bug 1157948) for fleshing out our content on packaging and deploying, but can you please verify these small additions in the meantime?
Verifying this bugzilla as additional documentation will be addressed in https://bugzilla.redhat.com/show_bug.cgi?id=1157948
Nichola, please proceed to follow 'BZ Process: VERIFIED 6.0 bugs' at .
I have uncommented the Packaging and Deployment for SwitchYard section and updated the revision numbers to those shown at comment 18 above in production content spec 22591 (Administration and Configuration Guide).
The revision number for this change is 719677.
Thanks, Nichola! And thank you much for the clear comment above.
Published to customer portal.