Skip to content

Task Page for Verifying Signed Images #32184

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

Merged

Conversation

PushkarJ
Copy link
Member

@PushkarJ PushkarJ commented Mar 10, 2022

Supersedes #31611
In support of kubernetes/release#2383
Relevant KEP: kubernetes/enhancements#3031
/sig security release docs
Notes:

  • All images in a release are assumed to be signed
  • The script points to the latest release by default
  • List of images is pulled from SBOM

/cc @saschagrunert @puerco @sftim

@k8s-ci-robot k8s-ci-robot requested a review from puerco March 10, 2022 23:20
@k8s-ci-robot k8s-ci-robot added this to the 1.24 milestone Mar 10, 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 Mar 10, 2022
@k8s-ci-robot k8s-ci-robot requested a review from sftim March 10, 2022 23:20
@k8s-ci-robot k8s-ci-robot added sig/security Categorizes an issue or PR as relevant to SIG Security. sig/release Categorizes an issue or PR as relevant to SIG Release. sig/docs Categorizes an issue or PR as relevant to SIG Docs. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Mar 10, 2022
@netlify
Copy link

netlify bot commented Mar 10, 2022

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

Name Link
🔨 Latest commit a93833c
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/62545a4b95cf6a0009c3ace4

@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. area/release-eng Issues or PRs related to the Release Engineering subproject language/en Issues or PRs related to English language labels Mar 10, 2022
@PushkarJ
Copy link
Member Author

Fixes #31420
(forgot this earlier)

@PushkarJ PushkarJ force-pushed the task-kep-3031-verify-signed-images branch 2 times, most recently from fed4e4b to 748af80 Compare March 10, 2022 23:57
Copy link
Member

@jihoon-seo jihoon-seo left a comment

Choose a reason for hiding this comment

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

Some nits. PTAL 😊

@PushkarJ PushkarJ force-pushed the task-kep-3031-verify-signed-images branch 5 times, most recently from f7fd5e8 to e1d1f29 Compare March 15, 2022 20:47
@PushkarJ
Copy link
Member Author

@saschagrunert @jihoon-seo updated as per your feedback

Copy link
Member

@saschagrunert saschagrunert left a comment

Choose a reason for hiding this comment

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

/lgtm

Thanks for working on this @PushkarJ!

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

LGTM label has been added.

Git tree hash: 5e19f3a9de514ef0f36d65f316ed3ce1e22ee44e

@PushkarJ PushkarJ changed the title [WIP] Task Page and examples for Verifying Signed Images Task Page and examples for Verifying Signed Images Mar 16, 2022
@PushkarJ
Copy link
Member Author

PushkarJ commented Apr 7, 2022

For components that aren't available as container images, do we provide an official way to verify those yet? If not, I recommend mentioning that no official mechanism is available there, so that people don't have to read source code etc to answer that question.

I think the MVP issue documents the scope is restricted to images only. Will let @saschagrunert chime in on if this would be useful to document as current limitation.

@sftim I have also addressed all the rest of the comments.

@PushkarJ PushkarJ changed the title Task Page and examples for Verifying Signed Images Task Page for Verifying Signed Images Apr 7, 2022
@puerco
Copy link
Member

puerco commented Apr 8, 2022

@sftim: @PushkarJ is right, it's probable we will not get the other artifacts signed for 1.24. It makes sense to leave out the other verification types for now.

@sftim
Copy link
Contributor

sftim commented Apr 8, 2022

leave out the other verification types for now

From a docs point of view, it's useful to let people know what things aren't covered. When we explain that, we try to avoid statements about the future.

Phrasing like

For Kubernetes v{{< skew currentVersion >}}, the only kind of code artifact that you can verify integrity for is a container image, using the experimental signing support.

for example (using v{{< skew currentVersion >}} so that if eg nothing changes for the v1.25 release, the docs remain relevant).

saschagrunert and others added 5 commits April 11, 2022 09:41
Updates based on PR review

Apply suggestions from code review

Co-authored-by: Tim Bannister <[email protected]>
Apply suggestions from code review

Co-authored-by: Qiming Teng <[email protected]>
Co-authored-by: Chris Negus <[email protected]>
@PushkarJ PushkarJ force-pushed the task-kep-3031-verify-signed-images branch from 6b5c560 to a93833c Compare April 11, 2022 16:41
@PushkarJ
Copy link
Member Author

Updated the download.md file with the text suggested by @sftim

@chrisnegus
Copy link
Contributor

Hello, this is a friendly reminder from the 1.24 docs release team that the Docs’ complete deadline — All PRs reviewed and ready to merge — is EOD Tuesday, April 12th, 2022. Please finish up any remaining technical reviews and edits, and reach out if you need any help.

Copy link
Member

@saschagrunert saschagrunert left a comment

Choose a reason for hiding this comment

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

/lgtm

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

LGTM label has been added.

Git tree hash: 9abcb47d41c4749f5556ee2f848efaa1f8e34984

@nate-double-u
Copy link
Contributor

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: nate-double-u, saschagrunert

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 Apr 12, 2022
@saschagrunert
Copy link
Member

@sftim can we lift the hold?

@chrisnegus
Copy link
Contributor

/unhold

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Apr 12, 2022
@k8s-ci-robot k8s-ci-robot merged commit ba6776b into kubernetes:dev-1.24 Apr 12, 2022
@sftim
Copy link
Contributor

sftim commented Apr 13, 2022

@PushkarJ did you try this out with the beta release? How did it go?

@@ -3,6 +3,8 @@ title: Download Kubernetes
type: docs
---

# Core Kubernetes components
Copy link
Contributor

Choose a reason for hiding this comment

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

We shouldn't have merged this - level 1 headings aren't allowed in our Markdown.

Copy link
Member

Choose a reason for hiding this comment

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

Follow-up in #32895

Copy link
Member

Choose a reason for hiding this comment

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

Now I saw #32896

saschagrunert added a commit to saschagrunert/website that referenced this pull request Apr 13, 2022
As per kubernetes#32184 (comment),
level 1 headers are not allowed in the website markdown. Means we now
increase the level by 1.

Signed-off-by: Sascha Grunert <[email protected]>
@sftim sftim mentioned this pull request Apr 13, 2022
@PushkarJ
Copy link
Member Author

@PushkarJ did you try this out with the beta release? How did it go?

I did not get a chance to test it before this was unheld and merged, since rc.0 is going to be first release with signed images ETA April 19 :( Either way seems unlikely we may need major overhaul of the script or guide.

@PushkarJ
Copy link
Member Author

@sftim just confirmed that the shell script works, but I think adding | jq is giving better looking results. Is it still possible to update this page? Demo: https://asciinema.org/a/488826

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. area/release-eng Issues or PRs related to the Release Engineering subproject 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. sig/release Categorizes an issue or PR as relevant to SIG Release. sig/security Categorizes an issue or PR as relevant to SIG Security. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges.
Projects
None yet
Development

Successfully merging this pull request may close these issues.