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

github action for kubeaudit to generate sarif results #462

Open
2 of 3 tasks
dani-santos-code opened this issue Jul 26, 2022 · 1 comment
Open
2 of 3 tasks

github action for kubeaudit to generate sarif results #462

dani-santos-code opened this issue Jul 26, 2022 · 1 comment

Comments

@dani-santos-code
Copy link
Contributor

ISSUE TYPE
  • Bug Report
  • Feature Idea
SUMMARY

the idea here is to offer open source users the convenience of uploading a sarif result as a step in their github action
Some ideas for this suggested by @thepwagner:

Make Shopify/kubeaudit an action

We add a action.yml file to the Shopify/kubeaudit, turning it into either a Docker container action or composite action.

This would mean users enable it like:

- uses: actions/checkout@v3

- uses: Shopify/kubeaudit@v0.19.0
- uses: Shopify/kubeaudit@v0.20.0 # or a different version

- uses: github/codeql-action/upload-sarif@v2

Depending on the implementation, it can result in compiling the kubeaudit binary each run (and be slow).

Make a Shopify/kubeaudit-action action

This is a common pattern when an action is wrapping a tool with its own release process, that doesn't want to pollute the original tool by Actions-izing it. https://github.com/golangci/golangci-lint-action is a good example.

TypeScript is pretty dope for building actions that do this:

This would mean users enable like:

- uses: actions/checkout@v3

- uses: Shopify/kubeaudit-action@v1.0.0
  with:
    version: v0.19.0
- uses: Shopify/kubeaudit-action@v1.0.0
  with:
    version: v0.20.0

- uses: github/codeql-action/upload-sarif@v2

Since TypeScript runs without container overhead, and this pattern downloads pre-compiled binaries I think this would have the fastest runtimes.

FEATURE IDEA

  • If the maintainers agree with the feature as described here, I intend to submit a Pull Request myself.1

Proposal:

1 This is the quickest way to get a new feature! We reserve the right to close feature requests, even ones we like, if the proposer does not intend to contribute to the feature and it doesn't fit in our current roadmap.

@thepwagner thepwagner changed the title github action for kubeaudit to upload sarif results github action for kubeaudit to generate sarif results Jul 27, 2022
@thepwagner
Copy link
Contributor

This could also just be documentation: we can write a sample workflow that fetches kubeaudit via curl and invokes it via bash.

Wrapping the functionality as an Action(TM) is just an added convenience.

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

No branches or pull requests

2 participants