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

cleanup: use pkg/platforms instead of containerd/platforms to … #8579

Merged
merged 2 commits into from
Feb 20, 2025

Conversation

jkhelil
Copy link
Member

@jkhelil jkhelil commented Feb 19, 2025

…avoid crypto dependency

Context

To make Tekton Pipelines FIPS compliant, the entrypoint command is a key step in this effort. Since it is statically compiled, we must ensure that cryptographic symbols are removed from the entrypoint binary.

This PR removes the indirect dependency on the crypto package from the entrypoint command by replacing github.com/containerd/containerd/platforms with github.com/tektoncd/pipeline/pkg/platforms, which does not rely on crypto

Using
go list -f '{{.ImportPath}} {{.Imports}}' -deps ./cmd/entrypoint
I identified a dependency cycle leading to crypto:
entrypoint -> containerd/platforms -> image-spec -> go-digest -> crypto
Since containerd/platforms was only needed for platform-related logic, I replaced it with github.com/tektoncd/pipeline/pkg/platforms, which provides the same functionality without pulling in crypto.

Changes

  • Removed github.com/containerd/containerd/platforms from cmd/entrypoint/main.go
  • Used github.com/tektoncd/pipeline/pkg/platforms instead

Submitter Checklist

As the author of this PR, please check off the items in this checklist:

  • Has Docs if any changes are user facing, including updates to minimum requirements e.g. Kubernetes version bumps
  • Has Tests included if any functionality added or changed
  • pre-commit Passed
  • Follows the commit message standard
  • Meets the Tekton contributor standards (including functionality, content, code)
  • Has a kind label. You can add one by adding a comment on this PR that contains /kind <type>. Valid types are bug, cleanup, design, documentation, feature, flake, misc, question, tep
  • Release notes block below has been updated with any user facing changes (API changes, bug fixes, changes requiring upgrade notices or deprecation warnings). See some examples of good release notes.
  • Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

NONE

@tekton-robot tekton-robot added the release-note-none Denotes a PR that doesnt merit a release note. label Feb 19, 2025
@tekton-robot tekton-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Feb 19, 2025
@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/entrypoint/platforms/platforms.go Do not exist 51.9%

@jkhelil
Copy link
Member Author

jkhelil commented Feb 19, 2025

/kind cleanup

@tekton-robot tekton-robot added the kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. label Feb 19, 2025
@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/entrypoint/platforms/platforms.go Do not exist 50.0%

@waveywaves
Copy link
Member

waveywaves commented Feb 19, 2025

@jkhelil thank you for finding this. This doesn't require doc notes as well as the functionality is simple as we are just getting the runtime platform information. Maybe it makes sense to check if other tekton binaries are pulling in unused transitve deps like this as well and how can we clean the code up further.

/approve

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Feb 19, 2025
@tekton-robot tekton-robot removed the lgtm Indicates that a PR is ready to be merged. label Feb 19, 2025
@jkhelil jkhelil changed the title cleanup: use entrypoint/platforms instead of containerd/platforms to … cleanup: use pkg/platforms instead of containerd/platforms to … Feb 19, 2025
@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/platforms/platforms.go Do not exist 50.0%
pkg/pod/entrypoint_lookup_impl.go 74.2% 75.4% 1.1

@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/platforms/platforms.go Do not exist 50.0%
pkg/pod/entrypoint_lookup_impl.go 74.2% 75.4% 1.1

@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: vdemeester, waveywaves

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

@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 19, 2025
@waveywaves
Copy link
Member

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Feb 19, 2025
@tekton-robot tekton-robot merged commit af7aa94 into tektoncd:main Feb 20, 2025
21 checks passed
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. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. lgtm Indicates that a PR is ready to be merged. release-note-none Denotes a PR that doesnt merit a release note. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants