action-setup-kube-tools

A GitHub Action that setup Kubernetes tools (kubectl, kustomize, helm, kubeconform, conftest, yq, rancher, tilt, skaffold, kube-score) and cache them on the runner. It is like a typescript version of stefanprodan/kube-tools with no command input param, but as compared with it, it's very fast as it installs the tools asynchronously.

Usage

Inputs

Parameter	Required	Default Value	Description
`fail-fast`	`false`	`true`	the action immediately fails when it fails to download (ie. due to a bad version)
`setup-tools`	`false`	`""`	List of tool name to setup. By default, the action download and setup all supported Kubernetes tools. By specifying `setup-tools` you can choose which tools the action setup. Supported separator is `return` in multi-line string. Supported tools are `kubectl`, `kustomize`, `helm`, `helmv3`, `kubeval`, `conftest`, `yq`, `rancher`, `tilt`, `skaffold`, `kube-score`
`kubectl`	`false`	`1.20.2`	kubectl version. kubectl vesion can be found here
`kustomize`	`false`	`4.5.7`	kustomize version. kustomize vesion can be found here
`helm`	`false`	`3.6.3`	helm v3 version. helm vesion can be found here
`helmv2`	`false`	`2.17.0`	helm v2 version. helm v3 vesion can be found here
`kubeval`	`false`	`0.16.1`	kubeval version (must be 0.16.1+). kubeval vesion can be found here. NOTE: this parameter is deprecating as `kubeval` is no longer maintained. A good replacement is kubeconform. See also this for more details.
`kubeconform`	`false`	`0.5.0`	kubeconform version. kubeconform vesion can be found here
`conftest`	`false`	`0.19.0`	conftest version. conftest vesion can be found here
`yq`	`false`	`4.7.1`	yq version. yq vesion can be found here
`rancher`	`false`	`2.4.10`	Rancher CLI version. Rancher CLI vesion can be found here
`tilt`	`false`	`0.18.11`	Tilt version. Tilt vesion can be found here
`skaffold`	`false`	`1.20.0`	Skaffold version. Skaffold vesion can be found here
`kube-score`	`false`	`1.10.1`	kube-score version. kube-score vesion can be found here

Supported Environments: Linux

From v0.7.0, the action supports tool version 'v' prefix. Prior to v0.7.0, the action only accept the tool version without 'v' prefix but from v0.7.0 the action automatically add/remove the prefix as necessary

Outputs

Parameter	Description
`kubectl-path`	kubectl command path if the action setup the tool, otherwise empty string
`kustomize-path`	kustomize command path if the action setup the tool, otherwise empty string
`helm-path`	helm command path if the action setup the tool, otherwise empty string
`helmv2-path`	helm v2 command path if the action setup the tool, otherwise empty string
`kubeval-path`	kubeval command path if the action setup the tool, otherwise empty string
`kubeconform-path`	kubeconform command path if the action setup the tool, otherwise empty string
`conftest-path`	conftest command path if the action setup the tool, otherwise empty string
`yq-path`	yq command path if the action setup the tool, otherwise empty string
`rancher-path`	rancher command path if the action setup the tool, otherwise empty string
`tilt-path`	rancher command path if the action setup the tool, otherwise empty string
`skaffold-path`	rancher command path if the action setup the tool, otherwise empty string
`kube-score-path:`	rancher command path if the action setup the tool, otherwise empty string

Sample Workflow

Specific versions for the commands can be setup by adding inputs parameters like this:

  test: 
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - uses: yokawasa/[email protected]
      with:
        kubectl: '1.17.1'
        kustomize: '3.7.0'
        helm: '3.5.2'
        helmv2: '2.16.7'
        kubeconform: '0.5.0'
        conftest: '0.18.2'
        rancher: '2.4.10'
        tilt: '0.18.11'
        skaffold: '1.20.0'
        kube-score: '1.10.1'
    - run: |
        kubectl version --client
        kustomize version
        helm version
        helmv2 version --client
        kubeconform -v
        conftest --version
        yq --version
        rancher --version
        tilt version
        skaffold version
        kube-score version

Default versions for the commands will be setup if you don't give any inputs like this:

  test: 
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - uses: yokawasa/[email protected]
    - run: |
        kubectl version --client
        kustomize version
        helm version
        helmv2 version --client
        kubeconform -v
        conftest --version
        yq --version
        rancher --version
        tilt version
        skaffold version
        kube-score version

By specifying setup-tools you can choose which tools the action setup. Supported separator is return in multi-line string like this

  test: 
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - uses: yokawasa/[email protected]
      with:
        setup-tools: |
          kubectl
          helm
          kustomize
          skaffold
        kubectl: '1.17.1'
        helm: '3.5.2'
        kustomize: '3.7.0'
        skaffold: '1.20.0'
    - run: |
        kubectl version --client
        kustomize version
        helm version
        skaffold version

Developing the action

Install the dependencies

npm install

Build the typescript and package it for distribution by running ncc

npm run build && npm run format && npm run lint && npm run pack

Finally push the results

git add dist
git commit -a -m "prod dependencies"
git push origin releases/v0.9.2

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/yokawasa/action-setup-kube-tools

Cheap and reliable Node.js hosting starts at $3/month, and $1/month static HTML hosting

yokawasa / action-setup-kube-tools

Programming Languages

Labels