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

Document crac-1.4 feature and InstantOn support for springBoot-3.0 feature #7331

Closed
2 tasks done
tjwatson opened this issue May 15, 2024 · 5 comments
Closed
2 tasks done
Assignees
Labels
24.0.0.6 technical reviewed An SME reviewed and approved the documentation from a technical perspective.
Milestone

Comments

@tjwatson
Copy link
Member

tjwatson commented May 15, 2024

  • Add springBoot-3.0 to list of supported InstantOn features in the docs
  • Add a feature page doc for the new crac-1.4 feature

We need to add the springBoot-3.0 feature the list of additional features supported by InstantOn at https://openliberty.io/docs/latest/instanton.html#supported-features

We could consider adding something to https://openliberty.io/docs/latest/deploy-spring-boot.html to mention the InstantOn support for Spring Boot 3.0. But I think it is best left to the guide linked from that page. I have issue OpenLiberty/guide-spring-boot#169 open for that. Otherwise we would have to add doc for containerizing SpringBoot applications in order to document how to use InstantOn with it.

I suggest we do add something like the following to modules/reference/pages/feature/springBoot-3.0/description.adoc

The Spring Framework and Spring Boot support of Coordinated Restore at Checkpoint integrates with Liberty InstantOn when using the crac-1.4 feature. The Spring support for checkpointing and restoring an application manages the lifecycle of resources such as socket, files and thread pools used by the application. For more information see the Spring Boot documentation on Checkpoint and Restore and the Spring Framework Checkpoint and Restore support documentation.

We also need to add a feature page doc for the new crac-1.4 feature. Here is a draft to get started:

Coordinated Restore at Checkpoint 1.4

This feature enables the org.crac Coordinated Restore at Checkpoint APIs.

The Liberty crac-1.4 feature provides an implementation of the org.crac APIs that integrate with the Liberty InstantOn support.

The org.crac package provides APIs for receiving checkpoint/restore notifications. These notifications allow applications to perform actions before checkpointing an application process and after restoring the application process. For example, this allows Spring-based applications to support Checkpoint and Restore. The use of org.crac is not limited to Spring-based applications. Any application running on Liberty may choose to receive checkpoint/restore notifications by enabling the crac-1.4 feature.

@dmuelle dmuelle added this to the 24.0.0.6 milestone May 15, 2024
@dmuelle dmuelle self-assigned this May 15, 2024
@tjwatson
Copy link
Member Author

For Open Liberty epic OpenLiberty/open-liberty#25594

@tjwatson
Copy link
Member Author

One additional thing needs to be added to the crac-1.4 feature doc about limitations on the Core.checkpointRestore() method.

The Liberty InstantOn implementation of CRaC does not support the org.crac.Core.checkpointRestore() method. Applications that depend on CRaC to receive notifications of checkpoint/restore should use the Liberty InstantOn afterAppStart option to checkpoint a Liberty application process.

dmuelle added a commit that referenced this issue May 23, 2024
@dmuelle dmuelle mentioned this issue May 23, 2024
@dmuelle
Copy link
Member

dmuelle commented May 23, 2024

@dmuelle
Copy link
Member

dmuelle commented Jun 13, 2024

Hi @tjwatson the crac-1.4 draft page is now available for review

https://docs-draft-openlibertyio.mqj6zf7jocq.us-south.codeengine.appdomain.cloud/docs/latest/reference/feature/crac-1.4.html

other updates from this issue:

If any further edits are needed, just let me know. Otherwise, you can sign off by adding the technical reviewed label to this issue. Thanks!

@tjwatson tjwatson added the technical reviewed An SME reviewed and approved the documentation from a technical perspective. label Jun 13, 2024
@tjwatson
Copy link
Member Author

Thanks LGTM

@dmuelle dmuelle closed this as completed Jun 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
24.0.0.6 technical reviewed An SME reviewed and approved the documentation from a technical perspective.
Projects
None yet
Development

No branches or pull requests

2 participants