GitHub Actions Kubernetes

A collection of Kubernetes related GitHub actions.

Actions

Setup kubectl and Helm

Setup kubectl and Helm using kubeconfig file.

Example

  - uses: aboutbits/github-actions-kubernetes/setup-kubectl-and-helm@v3
    with:
      kubeconfig: ${{ secrets.KUBECONFIG }}

Inputs

The following inputs can be used as step.with keys:

Name	Required/Default	Description
kubeconfig	required	The kubeconfig file content
kube-version	v1.33.1	The version of kubectl
helm-version	v3.17.3	The version of Helm

Deploy to Kubernetes using kubectl

Deploy application to a Kubernetes Cluster. Requires Kubernetes to be configured first.

Example

  - uses: aboutbits/github-actions-kubernetes/kubectl-deploy@v3
    with:
      deployment-file: 'infrastructure/kubernetes.prod.yml'
      namespace-name: ${{ env.NAMESPACE_NAME }}
      deployment-name: ${{ env.DEPLOYMENT_NAME }}

Inputs

The following inputs can be used as step.with keys:

Name	Required/Default	Description
deployment-file	required	Deployment file for kubectl to apply
namespace-name	required	Kubernetes namespace name
deployment-name	required	Kubernetes deployment name
working-directory	.	The working directory

Deploy to Kubernetes using Helm

Deploy an application to a Kubernetes cluster using its Helm chart. Requires Kubernetes to be configured first.

Example

  - uses: aboutbits/github-actions-kubernetes/helm-deploy@v3
    with:
      helm-chart-version: "1.0.0"
      helm-package: "my-app-chart"
      helm-username: ${{ secrets.HELM_USERNAME }}
      helm-password: ${{ secrets.HELM_PASSWORD }}
      release-name: my-app
      values-file: environments/values-test.yaml
      image-tag: "1.0.42"
      timeout: 5m
      working-directory: ./infrastructure

Inputs

The following inputs can be used as step.with keys:

Name	Required/Default	Description
helm-chart-version	required	The version of the Helm chart to pull
helm-registry-url	required	The URL of the Helm OCI registry
helm-package	required	The name of the Helm package to pull
helm-username	required	The username for authenticating with the Helm registry
helm-password	required	The password for authenticating with the Helm registry
helm-protocol	oci://	The protocol for pulling Helm charts (e.g., oci://)
release-name	required	The name of the Helm release
namespace	required	The namespace in which to deploy the Helm chart and application.
values-file	required	Path to the Helm values file for customization
image-tag	latest	The tag of the container image to set
timeout	5m	The timeout for the Helm command
working-directory	.	The working directory where the action commands will operate

Versioning

In order to have a versioning in place and working, create lightweight tags that point to the appropriate minor release versions.

Creating a new minor release:

git tag v4
git push --tags

Replacing an already existing minor release:

git tag -d v4
git push origin :refs/tags/v4
git tag v4
git push --tags

Information

About Bits is a company based in South Tyrol, Italy. You can find more information about us on our website.

Support

For support, please contact info@aboutbits.it.

Credits

• All Contributors

License

The MIT License (MIT). Please see the license file for more information.