A GitHub Action for using Chkk to catch availability and security weaknesses in your Kubernetes manifests.
You can use the Action as follows:
name: Example workflow for Chkk Kubernetes Manifests Action
on: push
jobs:
kubernetes-manifests:
runs-on: ubuntu-latest
steps:
- name: Run Chkk to catch availability and security weaknesses in your Kubernetes manifests
uses: chkk-io/chkk-action@main
env:
CHKK_ACCESS_TOKEN: ${{ secrets.CHKK_ACCESS_TOKEN }}
with:
kubernetes-manifest: your/kubernetes-manifest.yamlThe Chkk Kubernetes Manifests Action has properties which are passed to the underlying CLI. These are passed to the action using with.
| Parameter | Default | Description |
|---|---|---|
| args | Override the default arguments to the Chkk CLI | |
| kubernetes-manifest | The path to the Kubernetes manifest file you want to check. | |
| skip-checks | A comma-separated list of checks you want to skip. | |
| enable-checks | A comma-separated list of specific checks you want to run instead of running all checks. |
List of supported args
| Argument | Default | Description |
|---|---|---|
| --hide-diff | false | Hide diff in result output |
- Go to the settings tab in your repository menu.
- From the side menu, select Secrets.
- Add Chkk access token as a secret, shown below.
on: [push]
jobs:
kubernetes-manifests:
runs-on: ubuntu-latest
name: Run Chkk to catch availability and security weaknesses in your Kubernetes manifests
steps:
- uses: actions/checkout@v2
- uses: chkk-io/chkk-action@main
env:
CHKK_ACCESS_TOKEN: ${{ secrets.CHKK_ACCESS_TOKEN }}
with:
kubernetes-manifest: 'k8s-manifest.yaml'If you'd like to skip some checks on purpose, you can do so using by setting the skip-checks to the list of checks (Check IDs) to skip.
on: [push]
jobs:
kubernetes-manifests:
runs-on: ubuntu-latest
name: Run Chkk to catch availability and security weaknesses in your Kubernetes manifests
steps:
- uses: actions/checkout@v2
- uses: chkk-io/chkk-action@main
env:
CHKK_ACCESS_TOKEN: ${{ secrets.CHKK_ACCESS_TOKEN }}
with:
kubernetes-manifest: 'k8s-manifest.yaml'
skip-checks: 'CHKK-K8S-59,CHKK-K8S-65'If you'd like to run some checks, you can do so using by setting the enable-checks to the list of checks (Check IDs) to run.
on: [push]
jobs:
kubernetes-manifests:
runs-on: ubuntu-latest
name: Run Chkk to catch availability and security weaknesses in your Kubernetes manifests
steps:
- uses: actions/checkout@v2
- uses: chkk-io/chkk-action@main
env:
CHKK_ACCESS_TOKEN: ${{ secrets.CHKK_ACCESS_TOKEN }}
with:
kubernetes-manifest: 'k8s-manifest.yaml'
enable-checks: 'CHKK-K8S-36,CHKK-K8S-23,CHKK-K8S-27,CHKK-K8S-41'on: [push]
jobs:
kubernetes-manifests:
runs-on: ubuntu-latest
name: Run Chkk to catch availability and security weaknesses in your Kubernetes manifests
steps:
- uses: actions/checkout@v2
- uses: chkk-io/chkk-action@main
env:
CHKK_ACCESS_TOKEN: ${{ secrets.CHKK_ACCESS_TOKEN }}
with:
kubernetes-manifest: 'k8s-manifest.yaml'
args: '--hide-diff'

