K3d Versions Save

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 https://github.com/k3d-io/k3d/pull/1081
• @gonzalesraul made their first contribution in https://github.com/k3d-io/k3d/pull/1084
• @Regrau made their first contribution in https://github.com/k3d-io/k3d/pull/1091
• @devholic made their first contribution in https://github.com/k3d-io/k3d/pull/1094

Full Changelog: https://github.com/k3d-io/k3d/compare/v5.4.3...v5.4.4

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 https://github.com/k3d-io/k3d/pull/1075

Full Changelog: https://github.com/k3d-io/k3d/compare/v5.4.2...v5.4.3

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 https://github.com/k3d-io/k3d/pull/1056
• @tczhao made their first contribution in https://github.com/k3d-io/k3d/pull/1064
• @MrSimonEmms made their first contribution in https://github.com/k3d-io/k3d/pull/1054
• @vadorovsky made their first contribution in https://github.com/k3d-io/k3d/pull/1038

Full Changelog: https://github.com/k3d-io/k3d/compare/v5.4.1...v5.4.2

Full Changelog: https://github.com/k3d-io/k3d/compare/v5.4.0...v5.4.1

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 https://github.com/rancher/k3d/issues/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 https://github.com/k3d-io/k3d/pull/985
• @gbonnefille made their first contribution in https://github.com/k3d-io/k3d/pull/988
• @olix0r made their first contribution in https://github.com/k3d-io/k3d/pull/999

Full Changelog: https://github.com/k3d-io/k3d/compare/v5.3.0...v5.4.0

Full Changelog: https://github.com/k3d-io/k3d/compare/v5.4.0-dev.2...v5.4.0-dev.3

v5.3.0 - 03.02.2022

Note: Now trying to follow a standard scheme defined by https://keepachangelog.com/en/1.0.0/

Added

• new config options to configure extra hosts by @iwilltry42 in https://github.com/rancher/k3d/pull/938
• host pid mode support for k3s-server and k3s-agent by @hlts2 in https://github.com/rancher/k3d/pull/929
• SimpleConfig v1alpha4 by @iwilltry42 in https://github.com/rancher/k3d/pull/944
• add env var LOG_COLORS=[1|true|0|false] to toggle colored log output (enabled by default) by @iwilltry42 in https://github.com/rancher/k3d/pull/951
• Compatibility Tests by @iwilltry42 in https://github.com/rancher/k3d/pull/956
• Volume Shortcuts and k3d-managed volumes by @iwilltry42 in https://github.com/rancher/k3d/pull/916
  • Use some destination shortcuts with the --volume/-v flag that k3d automatically expands
    • k3s-storage -> /var/lib/rancher/k3s/storage
    • k3s-manifests -> /var/lib/rancher/k3s/server/manifests
    • k3s-manifests-custom -> /var/lib/rancher/k3s/server/manifests/custom (not K3s default: this is just some sub-directory inside the auto-deploy manifests directory which will also be parsed)
    • k3s-containerd -> /var/lib/rancher/k3s/agent/etc/containerd/config.toml (use with caution, K3s generates this file!)
    • k3s-containerd-tmpl -> /var/lib/rancher/k3s/agent/etc/containerd/config.toml.tmpl (used by K3s to generate the real config above)
    • k3s-registry-config -> /etc/rancher/k3s/registries.yaml (or just use --registry-config)
  • k3d-managed volumes
    • non-existing named volumes starting with a k3d- prefix will now be created and managed by k3d
• JSON schema versions in-repo to link to from schemastore.org by @iwilltry42 in https://github.com/rancher/k3d/pull/942

Changed

• Config file compatible with Kustomize by @erikgb in https://github.com/rancher/k3d/pull/945
• chore: update direct dependencies by @iwilltry42 in https://github.com/rancher/k3d/pull/935

Fixed

• serverlb should be created before using and restarted unless stopped by @wymli in https://github.com/rancher/k3d/pull/948
• fix typo in node.go by @eltociear in https://github.com/rancher/k3d/pull/949
• mutex on ensureToolsNode to avoid duplicate container name causing error by @iwilltry42 in https://github.com/rancher/k3d/pull/952
• detect '--disable=coredns' and conditionally disable injection by @iwilltry42 in https://github.com/rancher/k3d/pull/955
• invert logic for LOG_LEVEL parsing by @myitcv in https://github.com/rancher/k3d/pull/958

Deprecated

• SimpleConfig API version k3d.io/v1alpha3 is now deprecated in favor of k3d.io/v1alpha4

Removed

• unused volume validation functionality in cmd/util, does not affect the CLI (#916)

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 https://github.com/rancher/k3d/issues/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

• @hlts2 made their first contribution in https://github.com/rancher/k3d/pull/929
• @erikgb made their first contribution in https://github.com/rancher/k3d/pull/945
• @wymli made their first contribution in https://github.com/rancher/k3d/pull/948
• @eltociear made their first contribution in https://github.com/rancher/k3d/pull/949
• @myitcv made their first contribution in https://github.com/rancher/k3d/pull/958

Full Changelog: https://github.com/rancher/k3d/compare/v5.2.2...v5.3.0

v5.2.2

Fixes

• mitigate issue when importing images from multiple tars (#881, @sbaier1)
• fix: cluster delete should not fail if no cluster was found by config file (#886, @kuritka)

Misc

• docs: new page about k3d concepts, incl. nodefilters (#888)
  • https://k3d.io/v5.2.1/design/concepts/#nodefilters

Full Changelog: https://github.com/rancher/k3d/compare/v5.2.1...v5.2.2