https://github.com/controlplaneio/kubesec-action

Runs Kubesec as GitHub action
https://github.com/controlplaneio/kubesec-action

Last synced: 26 days ago
JSON representation

Runs Kubesec as GitHub action

• Host: GitHub
• URL: https://github.com/controlplaneio/kubesec-action
• Owner: controlplaneio
• License: apache-2.0
• Created: 2020-12-17T15:47:34.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-04-21T17:38:44.000Z (over 3 years ago)
• Last Synced: 2024-11-15T03:17:04.790Z (29 days ago)
• Language: Dockerfile
• Size: 10.7 KB
• Stars: 17
• Watchers: 24
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Kubesec Action

> [GitHub Action](https://github.com/features/actions) for [kubesec](https://github.com/controlplaneio/kubesec)

[![GitHub Release][release_badge]][release]

[![GitHub Marketplace][marketplace_badge]][marketplace]

![kubesec_logo](images/kubesec_logo.svg)

## Table of Contents

- [Usage](#usage)

  - [Workflow](#workflow)

- [Customizing](#customizing)

  - [Inputs](#inputs)

## Usage

### Workflow

```yaml

name: lint

on:

  push:

    branches:

      - master

  pull_request:

jobs:

  lint:

    name: Lint

    runs-on: ubuntu-20.04

    steps:

      - name: Checkout code

        uses: actions/checkout@v2

      - name: Run kubesec scanner

        uses: controlplaneio/kubesec-action@master

        with:

          input: file.yaml

```

### Using kubesec with GitHub Code Scanning

If you have [GitHub code scanning][code_scanning] available you can use kubesec as a scanning tool as follows:

```yaml

name: lint

on:

  push:

    branches:

      - master

  pull_request:

jobs:

  lint:

    name: Lint

    runs-on: ubuntu-20.04

    steps:

      - name: Checkout code

        uses: actions/checkout@v2

      - name: Run kubesec scanner

        uses: controlplaneio/kubesec-action@master

        with:

          input: file.yaml

          exit-code: "0"

          format: template

          template: template/sarif.tpl

          output: kubesec-results.sarif

      - name: Upload Kubesec scan results to GitHub Security tab

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

        with:

          sarif_file: kubesec-results.sarif

```

## Customising

### inputs

Following inputs can be used as `step.with` keys:

| Name        | Type   | Default | Description                              |

| ----------- | ------ | ------- | ---------------------------------------- |

| `input`     | String |         | File to scan                             |

| `format`    | String | `json`  | Output format (`json`, `template`)       |

| `template`  | String |         | Output template (`/templates/sarif.tpl`) |

| `output`    | String |         | Save results to a file                   |

| `exit-code` | String | `"2"`   | Override the exit-code                   |

[release]: https://github.com/controlplaneio/kubesec-action/releases/latest

[release_badge]: https://img.shields.io/github/release/controlplaneio/kubesec-action.svg?logo=github

[marketplace]: https://github.com/marketplace/actions

[marketplace_badge]: https://img.shields.io/badge/marketplace-kubesec--action-blue?logo=github

[license]: https://github.com/controlplaneio/kubesec-action/blob/master/LICENSE

[code_scanning]: https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning