k3d/v5.6.0/search/search_index.json

{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Overview","text":""},{"location":"#what-is-k3d","title":"What is k3d?","text":"<p>k3d is a lightweight wrapper to run k3s (Rancher Lab\u2019s minimal Kubernetes distribution) in docker.</p> <p>k3d makes it very easy to create single- and multi-node k3s clusters in docker, e.g. for local development on Kubernetes.</p> <p>Note: k3d is a community-driven project but it\u2019s not an official Rancher (SUSE) product. Sponsoring: To spend any significant amount of time improving k3d, we rely on sponsorships:</p> <p>- GitHub Sponsors:    - LiberaPay:    - IssueHunt: https://issuehunt.io/r/k3d-io/k3d</p> View a quick demo <p></p>"},{"location":"#learning","title":"Learning","text":"<p>k3d demo repository: iwilltry42/k3d-demo</p> <p>Featured use-cases include:</p> <ul> <li>hot-reloading of code when developing on k3d (Python Flask App)</li> <li>build-deploy-test cycle using Tilt</li> <li>full cluster lifecycle for simple and multi-server clusters</li> <li>Proof of Concept of using k3d as a service in Drone CI</li> </ul> <ul> <li>Rancher Meetup - May 2020 - Simplifying Your Cloud-Native Development Workflow With K3s, K3c and K3d (YouTube)</li> </ul>"},{"location":"#requirements","title":"Requirements","text":"<ul> <li>docker to be able to use k3d at all<ul> <li>Note: k3d v5.x.x requires at least Docker v20.10.5 (runc &gt;= v1.0.0-rc93) to work properly (see #807)</li> </ul> </li> <li>kubectl to interact with the Kubernetes cluster</li> </ul>"},{"location":"#releases","title":"Releases","text":"Platform Stage Version Release Date Downloads so far GitHub Releases stable GitHub Releases latest Homebrew stable - - Chocolatey stable - -"},{"location":"#installation","title":"Installation","text":"<p>You have several options there:</p>"},{"location":"#install-script","title":"Install Script","text":""},{"location":"#install-current-latest-release","title":"Install current latest release","text":"<ul> <li>wget:<pre><code>wget -q -O - https://raw.githubusercontent.com/k3d-io/k3d/main/install.sh | bash\n</code></pre> </li> </ul> <ul> <li>curl:<pre><code>curl -s https://raw.githubusercontent.com/k3d-io/k3d/main/install.sh | bash\n</code></pre> </li> </ul>"},{"location":"#install-specific-release","title":"Install specific release","text":"<p>Use the install script to grab a specific release (via <code>TAG</code> environment variable):</p> <ul> <li>wget:<pre><code>wget -q -O - https://raw.githubusercontent.com/k3d-io/k3d/main/install.sh | TAG=v5.0.0 bash\n</code></pre> </li> </ul> <ul> <li>curl:<pre><code>curl -s https://raw.githubusercontent.com/k3d-io/k3d/main/install.sh | TAG=v5.0.0 bash\n</code></pre> </li> </ul>"},{"location":"#other-installers","title":"Other Installers","text":"Other Installation Methods <ul> <li> <p>:fontawesome-solid-beer: Homebrew (MacOS/Linux):     <pre><code>brew install k3d\n</code></pre></p> <p>Note: The formula can be found in homebrew/homebrew-core and is mirrored to homebrew/linuxbrew-core</p> </li> </ul> <ul> <li> <p> AUR (Arch Linux User Repository):     <pre><code>yay -S rancher-k3d-bin\n</code></pre></p> <p>Package rancher-k3d-bin</p> </li> </ul> <ul> <li> <p> Download GitHub Release</p> <p>Grab a release binary from the release tab and install it yourself</p> </li> </ul> <ul> <li> <p> Chocolatey (Windows): <code>choco install k3d</code></p> <p>Note: package source can be found in erwinkersten/chocolatey-packages</p> </li> </ul> <ul> <li>arkade: <code>arkade get k3d</code></li> </ul> <ul> <li> <p>asdf: <code>asdf plugin-add k3d &amp;&amp; asdf install k3d latest</code></p> <p>Note: <code>asdf plugin-add k3d</code>, then <code>asdf install k3d &lt;tag&gt;</code> with <code>&lt;tag&gt; = latest</code> or <code>5.x.x</code> for a specific version (maintained by spencergilbert/asdf-k3d)</p> </li> </ul> <ul> <li>Others<ul> <li>install via go: <code>go install github.com/k3d-io/k3d/v5@latest</code> (Note: this will give you unreleased/bleeding-edge changes)</li> </ul> </li> </ul>"},{"location":"#qui