Skip to content

docs: Scheduled checkpoints - #274

Open
danielvallance wants to merge 1 commit into
prod-stagingfrom
danielvallance/scheduled_checkpoints
Open

docs: Scheduled checkpoints#274
danielvallance wants to merge 1 commit into
prod-stagingfrom
danielvallance/scheduled_checkpoints

Conversation

@danielvallance

Copy link
Copy Markdown
Contributor

No description provided.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Documents recurring scheduled checkpoints and links them with existing checkpoint guidance.

Changes:

  • Adds the checkpoint scheduled action with an API example.
  • Documents constraints, failure behavior, naming, and history.
  • Adds cross-links between scheduling and checkpoint pages.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File Description
pages/features/cron-jobs.mdx Documents scheduled checkpoint configuration and behavior.
pages/features/checkpoints.mdx Adds scheduled-checkpoint references and limitations.

馃挕 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread pages/features/cron-jobs.mdx Outdated
Comment thread pages/features/cron-jobs.mdx
Comment thread pages/features/checkpoints.mdx Outdated
Comment thread pages/features/cron-jobs.mdx Outdated

* Scheduled checkpoints need a license that covers checkpointing.
The platform checks the license when you configure the schedule and again at every occurrence, so an expired or replaced license stops an existing schedule from taking further checkpoints.
* Scheduled checkpoints only work with block-based volumes (for example, `ext4`); occurrences fail for other volume types.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

馃摑 [vale] reported by reviewdog 馃惗
[Microsoft.Semicolon] Try to simplify this sentence.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

Suppressed comments (1)

pages/features/cron-jobs.mdx:281

  • The checkpoint history shown in the linked section contains names and creation times, not readiness state, so it cannot confirm that an asynchronous checkpoint finished successfully. Use history to discover the generated checkpoint, then tell readers to inspect it and verify that it reaches the checkpoint state before treating the occurrence as successful.
  Because the instance status reports only the next elapse of a schedule and not the result of past runs, use the checkpoint history to confirm that occurrences produce checkpoints.

Comment thread pages/features/cron-jobs.mdx
Signed-off-by: Daniel Vallance <daniel@unikraft.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants