azure/k8s-lint

GitHub Action to validate Kubernetes manifest files

Kubernetes lint action

Use this action to lint/validate your manifest files. Refer to the action metadata file for details about all the inputs action.yml.

Lint using kubeconform

- uses: azure/k8s-lint@v1
  with:
     manifests: |
        manifests/deployment.yml
        manifests/service.yml
     kubeconformOpts: -summary

Lint using kubernetes server dryrun

Requires Kubectl to be installed (you can use the Azure/setup-kubectl action). Server dryrun will communicate with the kuberenetes server, so ensure that KUBECONFIG is available in the context. This works only for kubernetes versions >=1.12

- uses: azure/[email protected]
- uses: azure/k8s-lint@v1
  with:
     lintType: dryrun
     manifests: |
        manifests/deployment.yml
        manifests/service.yml

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

Support

k8s-lint is an open source project that is not covered by the Microsoft Azure support policy. Please search open issues here, and if your issue isn't already represented please open a new one. The project maintainers will respond to the best of their abilities.

k8s-lint's Issues

Update to Node 16+

What happened?

Node.js 12 actions are deprecated. More info here: https://github.blog/changelog/2022-09-22-github-actions-all-actions-will-begin-running-on-node16-instead-of-node12/.

Please update this action to use Node.js 16 to make these annoying annotations go away! 🤣

Version

• I am using the latest version

Runner

ubuntu-latest

Relevant log output

Feature Request: Support for HELM Linting

Feature request

Hi, I wonder why this action doesn't support Helm Lint? To validate the Helm charts?

https://helm.sh/docs/helm/helm_lint/

how to add flag skip-kinds to kubeval in action

Hi, wondering if k8s-lint supports passing flags, like "skip-kinds" in the github action? Thanks

Feature Request: lint directory

Feature request

Hi, Since usually we have multiple Kubernetes manifest for a project ( Deployment, Service, Configmap ... ) . It would be great if we could also specify a directory of the manifests when linting

Example action.yaml file

     - uses: azure/k8s-lint@v1
        with:
          manifests: |
              kubernetes/*

/home/runner/work/_temp/56c63f42-beac-4e20-8df8-3eee92e0b1d7/kubeval kubernetes/*
ERR  - Could not open file kubernetes/*