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

Add documentation for container checkpointing feature (KEP 2008) #34940

Conversation

adrianreber
Copy link
Contributor

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jul 11, 2022
@netlify
Copy link

netlify bot commented Jul 11, 2022

👷 Deploy Preview for kubernetes-io-vnext-staging processing.

Name Link
🔨 Latest commit df55ed5
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/62cee5afea519a0008f4a42e

@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jul 11, 2022
@k8s-ci-robot k8s-ci-robot added language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. labels Jul 11, 2022
@adrianreber
Copy link
Contributor Author

CC: @mikebrow

Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

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

Based on:

TODO: Add more information about return codes once CRI implementation have checkpoint/restore.

/retitle [WIP] Add documentation for container checkpointing feature (KEP 2008)

@k8s-ci-robot k8s-ci-robot changed the title Add documentation for container checkpointing feature (KEP 2008) [WIP] Add documentation for container checkpointing feature (KEP 2008) Jul 12, 2022
@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 12, 2022
@adrianreber
Copy link
Contributor Author

Based on:

TODO: Add more information about return codes once CRI implementation have checkpoint/restore.

/retitle [WIP] Add documentation for container checkpointing feature (KEP 2008)

We will not be able to fix this TODO before the release. Without the release the new CRI API is not available and cannot be implemented by the CRI implementation. This TODO can only be fixed after the release.

Copy link
Contributor

@chrisnegus chrisnegus left a comment

Choose a reason for hiding this comment

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

This reads really well. I was hoping you could add a bit more in your return codes comment.

@adrianreber adrianreber force-pushed the 2022-07-11-forensic-container-checkpointing-documentation branch from af02da6 to 3a563bd Compare July 13, 2022 15:31
@k8s-ci-robot k8s-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. language/ko Issues or PRs related to Korean language language/zh Issues or PRs related to Chinese language and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jul 13, 2022
@adrianreber adrianreber force-pushed the 2022-07-11-forensic-container-checkpointing-documentation branch from 3a563bd to 3b992d3 Compare July 13, 2022 15:32
Co-authored-by: Tim Bannister <tim@scalefactory.com>
Signed-off-by: Adrian Reber <areber@redhat.com>
@adrianreber adrianreber force-pushed the 2022-07-11-forensic-container-checkpointing-documentation branch from 3b992d3 to df55ed5 Compare July 13, 2022 15:33
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Jul 13, 2022
@jihoon-seo
Copy link
Member

/remove-language ko zh

@k8s-ci-robot k8s-ci-robot removed language/ko Issues or PRs related to Korean language language/zh Issues or PRs related to Chinese language labels Jul 19, 2022
@reylejano
Copy link
Member

@adrianreber , when this PR is ready for review, please remove [WIP] from the title
/milestone 1.25
/assign @sethmccombs
/cc @kcmartin

@k8s-ci-robot k8s-ci-robot added this to the 1.25 milestone Aug 4, 2022
@k8s-ci-robot k8s-ci-robot requested a review from kcmartin August 4, 2022 05:08
@adrianreber adrianreber changed the title [WIP] Add documentation for container checkpointing feature (KEP 2008) Add documentation for container checkpointing feature (KEP 2008) Aug 4, 2022
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Aug 4, 2022
Comment on lines +91 to +96
{{< comment >}}
TODO: Add more information about return codes once CRI implementation have checkpoint/restore.
This TODO cannot be fixed before the release, because the CRI implementation need
the Kubernetes changes to be merged to implement the new CheckpointContainer CRI API
call. We need to wait after the 1.25 release to fix this.
{{< /comment >}}
Copy link
Member

Choose a reason for hiding this comment

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

I suggest removing this section and create a GitHub issue to track this

Suggested change
{{< comment >}}
TODO: Add more information about return codes once CRI implementation have checkpoint/restore.
This TODO cannot be fixed before the release, because the CRI implementation need
the Kubernetes changes to be merged to implement the new CheckpointContainer CRI API
call. We need to wait after the 1.25 release to fix this.
{{< /comment >}}

@reylejano
Copy link
Member

Hi @adrianreber , the 1.25 Docs complete deadline passed.
Please address comments and feedback on this PR as soon as possible

@reylejano
Copy link
Member

I can address my comment in a follow-up PR
/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: reylejano

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 19, 2022
@krol3
Copy link
Contributor

krol3 commented Aug 22, 2022

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 22, 2022
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: a32cde75059bab4efaa4add4cd2d680f9d976f47

@k8s-ci-robot k8s-ci-robot merged commit dfd0880 into kubernetes:dev-1.25 Aug 22, 2022
@adrianreber
Copy link
Contributor Author

Sorry. I was away for some time and not able to react in a timely manner. I can do any fixup needed if you let me know what you would like to have changed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants