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

InstantOn Standalone MP features #7005

Closed
mbroz2 opened this issue Oct 27, 2023 · 4 comments · Fixed by #7048
Closed

InstantOn Standalone MP features #7005

mbroz2 opened this issue Oct 27, 2023 · 4 comments · Fixed by #7048
Assignees
Labels
doc bug Something isn't working.
Milestone

Comments

@mbroz2
Copy link
Member

mbroz2 commented Oct 27, 2023

Document: Faster startup for containerized applications with Open Liberty InstantOn
http://openliberty.io/docs/latest/instanton.html

It may not be clear to end users that standalone MP features do not currently have InstantOn support (for example, MP Reactive Messaging). A suggestion would be to alter the wording to something like 'InstantOn supports the features that these [MP/Jakarta] convenience features make available.'
or maybe something like 'Note that standalone MicroProfile features, which are not part of the convenience features, are currently not supported for InstantOn'

Also, there's an instance of "ae" in the doc that should be "are":

You can individually enable the Open Liberty public features that ae enabled by the Jakarta EE Web Profile and MicroProfile features, depending on the needs of your application.

@tjwatson
Copy link
Member

I think it would be more clear if we did the work to auto-generate a table of InstantOn supported features based on the value of the WLP-InstantOn-Enabled feature header.

WLP-InstantOn-Enabled: true

vs this for features that are enabled when running the beta image:

WLP-InstantOn-Enabled: true; type:=beta

@mbroz2
Copy link
Member Author

mbroz2 commented Oct 27, 2023

I agree, but that seems like a more long-term solution vs updating the current wording for this case.

@dmuelle dmuelle added this to the 23.0.0.11 milestone Oct 27, 2023
@dmuelle dmuelle self-assigned this Oct 27, 2023
@dmuelle dmuelle added the doc bug Something isn't working. label Oct 27, 2023
dmuelle added a commit that referenced this issue Oct 30, 2023
@dmuelle
Copy link
Member

dmuelle commented Oct 30, 2023

Hi @mbroz2 @tjwatson - I've fixed the typo and added the following text to clarify that MP standalone features are not currently supported by InstantOn (new text in italics):

InstantOn supports a subset of Open Liberty features. If a feature is enabled that InstantOn does not support, a failure occurs when you try to perform a checkpoint of an application process. InstantOn supports the following Jakarta EE and MicroProfile convenience features:

  • Jakarta EE Web Profile versions 8.0 and later

  • MicroProfile versions 4.1 and later

You can individually enable the Open Liberty public features that are enabled by the Jakarta EE Web Profile and MicroProfile features, depending on the needs of your application. This option avoids enabling the complete set of features that are enabled by the convenience features. However, InstantOn currently does not support standalone MicroProfile features, which are MicroProfile features that are not enabled by any of the convenience features.

https://docs-draft-openlibertyio.mqj6zf7jocq.us-south.codeengine.appdomain.cloud/docs/latest/instanton.html#supported-features

If any further edits are needed, just let me know. Thanks!

@mbroz2
Copy link
Member Author

mbroz2 commented Oct 31, 2023

@cbridgha any idea what level of effort it would take to have the generated docs reflect Tom's comment?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc bug Something isn't working.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants