k3s-e2e workflow (eldadru/ksniff)
The k3s-e2e workflow from eldadru/ksniff, explained and optimized by Latchkey.
CI health: C - fair
Point runs-on at Latchkey and get run de-duplication, job timeouts, SHA-pinned actions, self-healing for flaky steps, and up to 58% lower cost, applied automatically.
What it does
This is the k3s-e2e workflow from the eldadru/ksniff repository, a real project running GitHub Actions. It is shown here with attribution under its Apache-2.0 license.
Below, Latchkey shows a faster, safer version produced by its optimization engine.
The workflow
# This is a basic workflow to help you get started with Actions
name: k3s-e2e
# Controls when the workflow will run
on:
# Triggers the workflow on push or pull request events but only for the master branch
push:
branches: [ master ]
pull_request:
branches: [ master ]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
jobs:
build:
runs-on: ubuntu-latest
steps:
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
- uses: actions/checkout@v2
- uses: AbsaOSS/k3d-action@v1.5.0
name: "Create Single Cluster"
with:
cluster-name: "test-cluster-1"
args: --agents 1
- name: Deploy test pod
run: |
kubectl config use-context k3d-test-cluster-1
kubectl create -f .github/workflows/assets/busybox-pod.yaml
kubectl wait --for=condition=Ready pod/busybox-sleep
- name: Build
run: |
make
- name: Run ksniff privileged
run: |
kubectl config use-context k3d-test-cluster-1
sleep 60 && pkill kubectl-sniff &
set +e
./kubectl-sniff busybox-sleep --privileged --namespace default --socket /run/k3s/containerd/containerd.sock --output-file /tmp/output.pcap
set -e
if [ ! -f /tmp/output.pcap ]; then
echo "PCAP not created"
exit 1
fi
- if: failure()
name: Check pod and events
run: |
kubectl get pods
kubectl get events
- name: Build static-tcpdmp
run: |
sudo apt-get install libpcap-dev
make static-tcpdump
make install
- name: Run ksniff with static tcpdump
run: |
kubectl config use-context k3d-test-cluster-1
sleep 60 && pkill kubectl-sniff &
set +e
./kubectl-sniff busybox-sleep --namespace default --output-file /tmp/output.pcap
set -e
if [ ! -f /tmp/output.pcap ]; then
echo "PCAP not created"
exit 1
fi
The same workflow, on Latchkey
Removes redundant runs and caps runaway jobs. Added and changed lines are highlighted.
# This is a basic workflow to help you get started with Actions name: k3s-e2e # Controls when the workflow will run on: # Triggers the workflow on push or pull request events but only for the master branch push: branches: [ master ] pull_request: branches: [ master ] # Allows you to run this workflow manually from the Actions tab workflow_dispatch: concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true jobs: build: timeout-minutes: 30 runs-on: latchkey-small steps: # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it - uses: actions/checkout@v2 - uses: AbsaOSS/k3d-action@v1.5.0 name: "Create Single Cluster" with: cluster-name: "test-cluster-1" args: --agents 1 - name: Deploy test pod run: | kubectl config use-context k3d-test-cluster-1 kubectl create -f .github/workflows/assets/busybox-pod.yaml kubectl wait --for=condition=Ready pod/busybox-sleep - name: Build run: | make - name: Run ksniff privileged run: | kubectl config use-context k3d-test-cluster-1 sleep 60 && pkill kubectl-sniff & set +e ./kubectl-sniff busybox-sleep --privileged --namespace default --socket /run/k3s/containerd/containerd.sock --output-file /tmp/output.pcap set -e if [ ! -f /tmp/output.pcap ]; then echo "PCAP not created" exit 1 fi - if: failure() name: Check pod and events run: | kubectl get pods kubectl get events - name: Build static-tcpdmp run: | sudo apt-get install libpcap-dev make static-tcpdump make install - name: Run ksniff with static tcpdump run: | kubectl config use-context k3d-test-cluster-1 sleep 60 && pkill kubectl-sniff & set +e ./kubectl-sniff busybox-sleep --namespace default --output-file /tmp/output.pcap set -e if [ ! -f /tmp/output.pcap ]; then echo "PCAP not created" exit 1 fi
What changed
- Run on Latchkey managed runners with one line (
runs-on), which apply the fixes below automatically and self-heal transient failures. This example useslatchkey-small; pick the runner size that fits the job. - Cancel superseded runs when a branch or PR gets a newer push.
- Add a job timeout so a hung step cannot burn hours of runner time.
1 third-party action is referenced by a movable tag. Pin it to the commit SHA (Latchkey resolves and applies this automatically) so a repointed tag cannot change what runs.
What Latchkey heals here
This workflow has steps that commonly fail on transient issues (network, registries, flaky browsers). On Latchkey managed runners they are detected, retried, and self-healed instead of failing your build:
- Dependency installs
- End-to-end and browser tests
This workflow runs 1 job per trigger. On Latchkey the same minutes cost up to 58% less than GitHub-hosted, with zero queue time.