Kubernetes canary action

An action to handle kubectl interaction for canary deploys and deploy lock/unlock

This will be used to provide functionality like:

• Determine if a deploy is locked after canary
• Lock a deployment
• Unlock a deployment

Requirements

• Requires kubectl to be installed and available on the PATH.
• Requires https://github.com/smartlyio/kubernetes-auth-action to have been run first

Inputs

Name	Default	Required	Description
kubernetesContext		yes	Kubernetes context name. Usually the name of the cluster, but can be random.
serviceName		yes	Name of the kubernetes service to operate on.
command		yes	Canary support command to run. One of `[lock
user		no	User locking the deployment. Only used in lock command.

Outputs

Name	Description
CURRENT_IMAGE_SHA	Current docker image tag running in the cluster
LOCKED	Is deployment currently locked [true/false]

Example usage

name: Is Locked
on:
  pull_request:
    branches:
      - master
  push:
    branches:
      - master

jobs:
  is_locked:
    runs-on: ubuntu-24.04
    id: is_locked
    steps:
      - uses: actions/checkout@v4
      - name: Authenticate with the cluster
        env:
          KUBERNETES_AUTH_TOKEN: ${{ secrets.KUBERNETES_AUTH_TOKEN }}
        uses: smartlyio/kubernetes-auth-action@v1
        with:
          kubernetesClusterDomain: my-kubernetes-server.example.com
          kubernetesContext: test-context
          kubernetesNamespace: test-service
      - name: Check if deployment is locked
        uses: smartlyio/kubernetes-canary-action@v1
        with: 
          serviceName: test-service
          kubernetesContext: test-context
          command: isLocked

Development

Install the dependencies

$ npm install

Build the typescript and package it for distribution

$ npm run build && npm run package

Run the tests ✔️

$ npm test

 PASS  ./index.test.js
  ✓ ...

...