v5.5.0

v5.5.0 - 17.05.2023

Added

• Add support for ulimits (#1264)
  • new flag: k3d cluster create --runtime-ulimit NAME[=SOFT]:[HARD] (same for k3d node create)
• add: K3D_FIX_MOUNTS fix to make / rshared (e.g. to make Cilium work) (#1268)
  • new environment variable: K3D_FIX_MOUNTS=1
• add(docs): podman instructions for macOS (#1257)
• Adds json response of version info (#1262)
  • new flag: k3d version -o json

Changed

• change: allow full K3s registry configuration (#1215)
• change: update deps (manual + dependabot)
• change: set e2e test ghaction timeout
• change: improved help text for k3d version ls
• change: deprecate 'k3d version ls --format' in favor of '--output'
• change: golangci-lint fix whitespaces
• change: udpate docs

Fixed

• Fix panic when k3sURLEnvIndex is -1 (#1252)
• Fix spelling mistake in configfile.md (#1261)
• Correct typo: Inconsistent filename in registry documentation. (#1275)
• fix: k3d version ls (now via crane) (#1286)
• fix: registries.yaml file not marshalled correctly by k8s yaml package

Deprecated

• change: deprecate 'k3d version ls --format' in favor of '--output'

New Contributors

• @dan-ash made their first contribution in #1264
• @maxsargentdev made their first contribution in #1215
• @shoffmeister made their first contribution in #1261
• @aescaler-raft made their first contribution in #1257
• @bafzachris made their first contribution in #1275
• @dgershman made their first contribution in #1262

Full Changelog: v5.4.9...v5.5.0

v5.4.9

What's Changed

• docs: add arikmaor as a contributor for code by @allcontributors in #1240
• change: replace deprecated set-output command with environment file in Github Actions by @jongwooo in #1226
• fix: handle colima host by @thejan2009 in #1228

New Contributors

• @jongwooo made their first contribution in #1226
• @thejan2009 made their first contribution in #1228

Full Changelog: v5.4.8...v5.4.9

v5.4.8

v5.4.8 - 04.03.2023

Changed

• Go 1.20 and updated dependencies
• change: Use loadbalancer or any active server as K3S_URL (#1190)
• change: graceful shutdown drains node before k3d container stops (#1119)
• change: update docs to use quotes around extra args (#1218)
• changed: update podman service documentation around network dns (#1210)
• change: no whitespace in goflags in makefile
• change: fix build with go 1.20 (#1216)

Fixed

• fix: generate checksum for k3d binaries (#1209)
• fix: improved error handling when update.k3s.io returns a 5XX or invalid response (#1170)
• fix: install script on windows (#1168)
• fix: fix for link in doc (#1219)

New Contributors

• @chivalryq made their first contribution in #1191
• @4p00rv made their first contribution in #1190
• @nikhilsbhat made their first contribution in #1170
• @hdeadman made their first contribution in #1168
• @arikmaor made their first contribution in #1119
• @newbe36524 made their first contribution in #1218
• @s-fairchild made their first contribution in #1210
• @paper42 made their first contribution in #1216
• @TechRabb1t made their first contribution in #1219

Full Changelog: v5.4.7...v5.4.8

v5.4.7

v5.4.7 - 02.02.2023

Changed

• updated direct and transitive dependencies

Fixed

• fix: avoid appending existing volumes (#1154)
• fix: indentation for CoreDNS doc (#1166)
• fix: logs error shadowing exec error (#1172)
• docs: Add missing backtick to k3s-arg example command (#1192)
• Support reading in registries-config via env (#1199)

New Contributors

• @s7m4b4 made their first contribution in #1154
• @lionello made their first contribution in #1166
• @rhbuf made their first contribution in #1172
• @tkupari made their first contribution in #1192
• @padlar made their first contribution in #1199

Full Changelog: v5.4.6...v5.4.7

v5.4.6

v5.4.6 - 29.08.2022

Disclaimer

v5.4.5 was broken and rolled-back. It's not available on GitHub. Some package managers like brew offered it, because they updated based on the pushed tag, not the release. Please update to v5.4.6!

Added

• add: ability to load configuration from stdin (#1126)

Changed

• update dependencies
• introduce Go workspace mode
• updated docker/k3s version test-matrix
• Go 1.19
• More info on "node stopped returning log lines" error

Fixed

• tests/e2e: failing e2e tests for parsing config file from stdin
• ci: "random" failing GitHub Actions due to "too many open files"
• docs: fix code highlighting
• docs: beautify bash commands (#1103)

New Contributors

• @kameshsampath made their first contribution in #1126

Full Changelog: v5.4.4...v5.4.6

v5.4.4

v5.4.4 - 11.07.2022

Added

• Docs: Clarification of Network Policies in K3s (#1081)

Changed

• Sponsorship information and updated issue templates
• Switch to sigs.k8s.io/yaml everywhere in the project to allow for consistent json/yaml output (#1094)

Fixed

• Support running k3d with podman in rootless mode using cgroups v2 (#1084)
• k3d config init used the legacy config format (#1091)
• Properly handle image prefix "docker.io", etc during image import (#1096)

New Contributors

• @stianlagstad made their first contribution in #1081
• @gonzalesraul made their first contribution in #1084
• @Regrau made their first contribution in #1091
• @devholic made their first contribution in #1094

Full Changelog: v5.4.3...v5.4.4

v5.4.3

v5.4.3 - 07.06.2022

Added

• Support for pull-through registry (#1075)

  • In command k3d registry create

    • e.g. k3d registry create --proxy-remote-url https://registry-1.docker.io -p 5000 -v /tmp/registry:/var/lib/registry

  • In config file:

    # ...
    registries:
      create:
        name: docker-io # name of the registry container
        proxy:
          remoteURL: https://registry-1.docker.io # proxy DockerHub
        volumes:
          - /tmp/reg:/var/lib/registry # persist data locally in /tmp/reg
      config: | # tell K3s to use this registry when pulling from DockerHub
        mirrors:
          "docker.io":
            endpoint:
              - http://docker-io:5000

  • See registry documentation

New Contributors

• @ethinx made their first contribution in #1075

Full Changelog: v5.4.2...v5.4.3

v5.4.2

v5.4.2 - 04.06.2022

Added

• Docs: hostAliases in the config file
• New field registries.create.image (same as k3d registry create --image) in config v1alpha4 (no version bump) (#1056)

Changed

• Go 1.18

Fixed

• docs: fix defaults-networking href (#1064)
• fix deleting of cluster by config file (#1054)
• fix: DOCKER_HOST handling of unix sockets (#1045)
• make: Use go install instead of go get for installing tools (#1038)
• fix: e2e tests safe git directory

New Contributors

• @flaneur2020 made their first contribution in #1056
• @tczhao made their first contribution in #1064
• @mrsimonemms made their first contribution in #1054
• @vadorovsky made their first contribution in #1038

Full Changelog: v5.4.1...v5.4.2

v5.4.1

Full Changelog: v5.4.0...v5.4.1

v5.4.0

v5.4.0 - 26.03.2022

Note: This is the first independent release of k3d

• k3d moved from rancher/k3d to k3d-io/k3d
• k3d is fully community-owned
• k3d does not depend on any company's toolchain or accounts

Note 2: You can now fund the work on k3d using GitHub Sponsors (@iwilltry42) or IssueHunt (k3d-io/k3d)

Added

• GitHub Actions Release Workflow (#977 & #1024)
  • Replaces DroneCI
  • Now uses buildx & buildx bake for multiplatform builds (instead of VMs with the according architectures)
  • Now pushes to GHCR instead of DockerHub
• docs: added FAQ entry on using Longhorn in k3d
• docs: added config file tip that k3d expands environment variables
• docs: added section about using k3d with Podman (#987)
• docs: add connect section on homepage (#988)
• added k3d node create --k3s-arg flag (#1032)

Changed

• references to rancher/k3d updated to k3d-io/k3d (#976)
• reference to rancher/k3s updated to k3s-io/k3s (#985)
• explicitly set bridge mode for k3d-created networks for Podman compatibility (#986)
• use secure defaults for curl in install script (#999)
• chore: update docs requirements and re-run docgen for commands (#1033)
• change: no default image for node creation in local cluster where image should be copied from existing nodes (#1034)

Fixed

• fixed volume shortcuts not working because clusterconfig was not being processed
• fixed AUR Release pipeline with more relaxed version selection (#966)
• fixed ZSH completion output (#1014)
• Do not defer goroutine to delete tools node, as this leads to errors
• Hotfix: switch default for image import to original tools-node mode, as the new direct mode fails fairly often
• GetGatewayIP for host.k3d.internal should error out if there's no gateway defined (#1027)
• Store hostAliases in label to persist them across cluster stop/start (#1029)

Deprecated

• DockerHub Images: k3d's images will now be pushed to GHCR under https://github.com/orgs/k3d-io/packages?repo_name=k3d

Removed

• DroneCI Test & Release Pipeline

Compatibility

This release was automatically tested with the following setups:

Docker

• 20.10.5
• 20.10.12

Expected to Fail with the following versions:

• <= 20.10.4 (due to runc, see #807)

K3s

We test a full cluster lifecycle with different K3s channels, meaning that the following list refers to the current latest version released under the given channel:

• Channel v1.23
• Channel v1.22

Expected to Fail with the following versions:

• <= v1.18 (due to not included, but expected CoreDNS in K3s)

New Contributors

• @dereknola made their first contribution in #985
• @gbonnefille made their first contribution in #988
• @olix0r made their first contribution in #999

Full Changelog: v5.3.0...v5.4.0