🆕 v4️⃣.0️⃣.0️⃣

🚀 Breaking Changes

📄 Module

If you're using k3d as a Go module, please have a look into the code to see all the changes!

• We're open for chats via Slack or GitHub discussions

• Module is now on github.com/rancher/k3d/v4 due to lots of breaking changes

• pkg/cluster is now pkg/client

• ClusterCreate and NodeCreate don't start the entities (containers) anymore

  • ClusterRun and NodeRun orchestrate the new Create and Start functionality

• NodeDelete/ClusterDelete now take an additional NodeDeleteOpts/ClusterDeleteOpts struct to toggle specific steps

• NodeSpec now features a list of networks (required for registries)

• New config flow: CLIConfig (SimpleConfig) -> ClusterConfig -> Cluster + Opts

💻 CLI

• Some flags changed to also use noun-action syntax
  • e.g. --switch-context --update-default-kubeconfig -> --kubeconfig-switch-context --kubeconfig-update-default
  • this eases grouping and visibility

➡️ Changes

🆕 Features

• Registry Support

  • k3d-managed registry like we had it in k3d v1.x
  • Option 1: default settings, paired with cluster creation
    • k3d cluster create --registry-create -> New registry for that cluster
    • k3d cluster create --registry-use -> Re-use existing registry
  • Option 2: customized, managed stand-alone
    • k3d registry [create/start/stop/delete]
    • Check the documentation, help text and tutorials for more details
  • Communicate managed registry using the LocalRegistryHostingV1 spec from KEP-1755
    • interesting especially for tools that reload images, like Tilt or Skaffold

• Config File Support

  • Put all your CLI-Arguments/Flags into a more readable config file and re-use it everywhere (keep it in your repo)

    • Note: this is not always a 1:1 matching in naming/syntax/semantics

  • k3d cluster create --config myconfig.yaml

    apiVersion: k3d.io/v1alpha1
    kind: Simple
    name: mycluster
    servers: 3
    agents: 2
    ports:
      - port: 8080:80
        nodeFilters:
          - loadbalancer

  • Check out our test cases in pkg/config/test_assets/ for more config file examples

  • Note: The config file format (& feature) might still be a little rough around the edges and it's prone to change quickly until we hit a stable release of the config

• [WIP] Support for Lifecycle Hooks

  • Run any executable at specific stages during the cluster and node lifecycles
    • e.g. we modify the registries.yaml in the preStart stage of nodes
    • Guides will follow

• Print container creation time (#431, @inercia)

• add output formats for cluster ls and node ls (#439, @inercia)

🛠️ Fixes

• import image: avoid nil pointer exception in specific cases
• cluster delete: properly handle node and network (#437)
• --port: fix bnil-pointer exception when exposing port on non-existent loadbalancer
• completion/zsh: source completion file

🧰 Misc

• Now building with Go 1.15
  • same for the k3d-tools code
• updated dependencies (including Docker v20.10)
• tests/e2e: add E2E_INCLUDE and rename E2E_SKIP to E2E_EXCLUDE
• tests/e2e: allow overriding the Helper Image Tag via E2E_HELPER_IMAGE_TAG
• docs: spell checking (#434, @jsoref)
• docs: add Chocolatey install option (#443, @erwinkersten)

More

There's probably much more that went into this release, which we forgot to mention here or just overlooked.
Just give it a try and let us know, what you think 😉

Get in touch via

• GitHub Issues
• GitHub Discussions
• Slack (Channel #k3d)+