k3d.io Open in urlscan Pro
2606:50c0:8001::153  Public Scan

Form analysis
2 forms found in the DOM

<form class="md-header__option" data-md-component="palette">
  <input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="black" data-md-color-accent="grey" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
  <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2">
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
      <path d="M17 6H7c-3.31 0-6 2.69-6 6s2.69 6 6 6h10c3.31 0 6-2.69 6-6s-2.69-6-6-6zm0 10H7c-2.21 0-4-1.79-4-4s1.79-4 4-4h10c2.21 0 4 1.79 4 4s-1.79 4-4 4zM7 9c-1.66 0-3 1.34-3 3s1.34 3 3 3 3-1.34 3-3-1.34-3-3-3z"></path>
    </svg>
  </label>
  <input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="light-blue" data-md-color-accent="indigo" aria-label="Switch to light mode" type="radio" name="__palette"
    id="__palette_2">
  <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden="">
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
      <path d="M17 7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h10a5 5 0 0 0 5-5 5 5 0 0 0-5-5m0 8a3 3 0 0 1-3-3 3 3 0 0 1 3-3 3 3 0 0 1 3 3 3 3 0 0 1-3 3Z"></path>
    </svg>
  </label>
</form>

Name: search —

<form class="md-search__form" name="search">
  <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required="">
  <label class="md-search__icon md-icon" for="__search">
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
      <path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"></path>
    </svg>
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
      <path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"></path>
    </svg>
  </label>
  <nav class="md-search__options" aria-label="Search">
    <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
        <path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"></path>
      </svg>
    </button>
  </nav>
  <div class="md-search__suggest" data-md-component="search-suggest"></div>
</form>

Text Content

Skip to content


k3d
v5.7.4
 * v5.7.4
 * v5.7.3
 * v5.7.2
 * v5.7.1
 * v5.7.0
 * v5.6.3
 * v5.6.2
 * v5.6.1
 * v5.6.0
 * v5.5.2
 * v5.5.1
 * v5.5.0
 * v5.4.9
 * v5.4.8
 * v5.4.7
 * v5.4.6
 * v5.4.4
 * v5.4.3
 * v5.4.2
 * v5.4.1
 * v5.4.0
 * v5.3.0
 * v5.2.2
 * v5.2.1
 * v5.2.0
 * v5.1.0
 * v5.0.3
 * v5.0.2
 * v5.0.1
 * v5.0.0
 * v4.4.8

Overview

Type to start searching
k3d-io/k3d
 * v5.7.4
 * 5.4k
 * 460

 * Overview
 * Guides
 * Design
 * FAQ

k3d
k3d-io/k3d
 * v5.7.4
 * 5.4k
 * 460

 * Overview Overview
   Table of contents
    * What is k3d?
    * Learning
    * Requirements
    * Releases
    * Installation
       * Install Script
          * Install current latest release
          * Install specific release
      
       * Other Installers
   
    * Quick Start
    * Connect
    * Related Projects

 * Guides
   Guides
    * Using Config Files
    * Handling Kubeconfigs
    * Creating multi-server clusters
    * Using Image Registries
    * Exposing Services
    * Importing modes
    * K3s Features in k3d
    * Advanced Guides
      Advanced Guides
       * Use Calico instead of Flannel
       * Running CUDA workloads
       * Using Podman instead of Docker
   
    * Commands
      Commands
       * K3d
       * K3d cluster
       * K3d cluster create
       * K3d cluster delete
       * K3d cluster edit
       * K3d cluster list
       * K3d cluster start
       * K3d cluster stop
       * K3d completion
       * K3d config
       * K3d config init
       * K3d config migrate
       * K3d image
       * K3d image import
       * K3d kubeconfig
       * K3d kubeconfig get
       * K3d kubeconfig merge
       * K3d node
       * K3d node create
       * K3d node delete
       * K3d node edit
       * K3d node list
       * K3d node start
       * K3d node stop
       * K3d registry
       * K3d registry create
       * K3d registry delete
       * K3d registry list
       * K3d version
       * K3d version list

 * Design
   Design
    * Project Overview
    * Concepts
    * Defaults
    * Networking

 * FAQ
   FAQ
    * FAQ
    * Compatibility

Table of contents
 * What is k3d?
 * Learning
 * Requirements
 * Releases
 * Installation
    * Install Script
       * Install current latest release
       * Install specific release
   
    * Other Installers

 * Quick Start
 * Connect
 * Related Projects


OVERVIEW¶




WHAT IS K3D?¶

k3d is a lightweight wrapper to run k3s (Rancher Lab’s minimal Kubernetes
distribution) in docker.

k3d makes it very easy to create single- and multi-node k3s clusters in docker,
e.g. for local development on Kubernetes.

Note: k3d is a community-driven project but it’s not an official Rancher (SUSE)
product. Sponsoring: To spend any significant amount of time improving k3d, we
rely on sponsorships:

- GitHub Sponsors: - LiberaPay: - IssueHunt: https://issuehunt.io/r/k3d-io/k3d

View a quick demo

00:00-00:00



LEARNING¶

k3d demo repository: iwilltry42/k3d-demo

Featured use-cases include:

 * hot-reloading of code when developing on k3d (Python Flask App)
 * build-deploy-test cycle using Tilt
 * full cluster lifecycle for simple and multi-server clusters
 * Proof of Concept of using k3d as a service in Drone CI

 * Rancher Meetup - May 2020 - Simplifying Your Cloud-Native Development
   Workflow With K3s, K3c and K3d (YouTube)


REQUIREMENTS¶

 * docker to be able to use k3d at all
   * Note: k3d v5.x.x requires at least Docker v20.10.5 (runc >= v1.0.0-rc93) to
     work properly (see #807)
 * kubectl to interact with the Kubernetes cluster


RELEASES¶

Platform Stage Version Release Date Downloads so far GitHub Releases stable
GitHub Releases latest Homebrew stable - - Chocolatey stable - - Scoop stable -
-


INSTALLATION¶

You have several options there:


INSTALL SCRIPT¶

INSTALL CURRENT LATEST RELEASE¶

 * wget:
   
   wget -q -O - https://raw.githubusercontent.com/k3d-io/k3d/main/install.sh | bash
   

 * curl:
   
   curl -s https://raw.githubusercontent.com/k3d-io/k3d/main/install.sh | bash
   

INSTALL SPECIFIC RELEASE¶

Use the install script to grab a specific release (via TAG environment
variable):

 * wget:
   
   wget -q -O - https://raw.githubusercontent.com/k3d-io/k3d/main/install.sh | TAG=v5.0.0 bash
   

 * curl:
   
   curl -s https://raw.githubusercontent.com/k3d-io/k3d/main/install.sh | TAG=v5.0.0 bash
   


OTHER INSTALLERS¶

Other Installation Methods

 * :fontawesome-solid-beer: Homebrew (MacOS/Linux):
   
   brew install k3d
   
   
   
   
   Note: The formula can be found in homebrew/homebrew-core and is mirrored to
   homebrew/linuxbrew-core

 * AUR (Arch Linux User Repository):
   
   yay -S rancher-k3d-bin
   
   
   
   
   Package rancher-k3d-bin

 * Download GitHub Release
   
   Grab a release binary from the release tab and install it yourself

 * Chocolatey (Windows): choco install k3d
   
   Note: package source can be found in erwinkersten/chocolatey-packages

 * Scoop (Windows): scoop install k3d
   
   Note: package source can be found in ScoopInstaller/Main

 * arkade: arkade get k3d

 * asdf: asdf plugin-add k3d && asdf install k3d latest
   
   Note: asdf plugin-add k3d, then asdf install k3d <tag> with <tag> = latest or
   5.x.x for a specific version (maintained by spencergilbert/asdf-k3d)

 * Others
   * install via go: go install github.com/k3d-io/k3d/v5@latest (Note: this will
     give you unreleased/bleeding-edge changes)


QUICK START¶

Create a cluster named mycluster with just a single server node:

k3d cluster create mycluster


Use the new cluster with kubectl, e.g.:

kubectl get nodes


Getting the cluster’s kubeconfig (included in k3d cluster create)

Get the new cluster’s connection details merged into your default kubeconfig
(usually specified using the KUBECONFIG environment variable or the default path
$HOME/.kube/config) and directly switch to the new context:

k3d kubeconfig merge mycluster --kubeconfig-switch-context



CONNECT¶

 1. Join the Rancher community on slack via slack.rancher.io
 2. Go to rancher-users.slack.com and join our channel #k3d
 3. Start chatting


RELATED PROJECTS¶

 * vscode-k3d: VSCode Extension to handle k3d clusters from within VSCode
 * k3x: a graphics interface (for Linux) to k3d.
 * AbsaOSS/k3d-action: fully customizable GitHub Action to run lightweight
   Kubernetes clusters.
 * AutoK3s: a lightweight tool to help run K3s everywhere including k3d
   provider.
 * nolar/setup-k3d-k3s: setup K3d/K3s for GitHub Actions.

--------------------------------------------------------------------------------

Last update: January 2, 2024
Back to top
Copyright © 2020-2023 k3d Authors
Made with Material for MkDocs