ghcr.io/k3d-io/k3d-tools:sha-934b3c8

Docker中的k3s

k3s 是 Rancher 推出的轻量级 Kubernetes 发行版：https://github.com/k3s-io/k3s

k3d 可创建容器化的 k3s 集群。这意味着，您可以在单台机器上使用 docker 快速搭建多节点 k3s 集群。

[!NOTE] k3d 是一个社区驱动项目，但并非 Rancher (SUSE) 的官方产品。 赞助：为了投入足够时间改进 k3d，我们依赖于赞助：

学习资源

• 带文档的网站：k3d.io
• Rancher 线上meetup - 2020年5月 - 使用K3s、K3c和K3d简化云原生开发工作流（***）
• k3d 演示仓库：https://github.com/k3d-io/k3d-demo

要求

• docker

[!NOTE] k3d v5.x.x 至少需要 Docker v20.10.5（runc >= v1.0.0-rc93）才能正常工作（参见 https://github.com/k3d-io/k3d/issues/807%EF%BC%89

版本发布

• 2020年5月：v1.7.x -> v3.0.0（重写）
• 2021年1月：v3.x.x -> v4.0.0（不兼容变更）
• 2021年9月：v4.4.8 -> v5.0.0（不兼容变更）

获取

您有以下几种获取方式：

• 使用安装脚本获取最新版本：
  • wget：shell wget -q -O - https://raw.githubusercontent.com/k3d-io/k3d/main/install.sh | bash
• curl：shell curl -s https://raw.githubusercontent.com/k3d-io/k3d/main/install.sh | bash
• 使用安装脚本获取特定版本（通过 TAG 环境变量）：
  • wget：shell wget -q -O - https://raw.githubusercontent.com/k3d-io/k3d/main/install.sh | TAG=v5.0.0 bash
• curl：shell curl -s https://raw.githubusercontent.com/k3d-io/k3d/main/install.sh | TAG=v5.0.0 bash
• 使用 Homebrew：shell brew install k3d（Homebrew 适用于 MacOS 和 Linux）
  • 配方可在 https://github.com/Homebrew/homebrew-core/blob/master/Formula/k3d.rb 找到，并同步到 https://github.com/Homebrew/linuxbrew-core/blob/master/Formula/k3d.rb
• 通过 MacPorts 安装：shell sudo port selfupdate && sudo port install k3d（MacPorts 适用于 MacOS）
• 通过 AUR 包 rancher-k3d-bin 安装：shell yay -S rancher-k3d-bin
• 从 https://github.com/k3d-io/k3d/releases 获取发行版并手动安装。
• 通过 go 安装：shell go install github.com/k3d-io/k3d/v5@latest（> [!NOTE] 这将获取未发布/前沿变更）
• 使用 Chocolatey：shell choco install k3d（Chocolatey 包管理器适用于 Windows）
  • 包源可在 https://github.com/erwinkersten/chocolatey-packages/tree/master/automatic/k3d 找到
• 使用 Scoop：shell scoop install k3d（Scoop 包管理器适用于 Windows）
  • 包源可在 https://github.com/ScoopInstaller/Main/blob/master/bucket/k3d.json 找到

或者...

构建

1. 克隆此仓库，例如通过 git clone git@github.com:k3d-io/k3d.git 或 go get github.com/k3d-io/k3d/v5@main
2. 在仓库内运行
   • make install-tools 以确保安装所需的 go 包

3. 在仓库内运行以下命令之一

make build```
为当前系统构建
   -
```shell
go install```
安装到您的 `GOPATH`（> [!NOTE] 这将获取未发布/前沿变更）
   -
```shell
make build-cross```
为所有系统构建

## 使用

通过 `k3d help` 查看可用功能，或查阅文档 @ k3d.io

示例工作流：创建新集群并使用 `kubectl`

1.
```shell
k3d cluster create CLUSTER_NAME```
创建一个新的单节点集群（= 1 个运行 k3s 的容器 + 1 个负载均衡器容器）
2. [可选，集群创建时已包含]
```shell
k3d kubeconfig merge CLUSTER_NAME --kubeconfig-switch-context```
更新默认 kubeconfig 并将当前上下文切换到新集群
3. 执行一些命令，如
```shell
kubectl get pods --all-namespaces```
4.
```shell
k3d cluster delete CLUSTER_NAME```
删除默认集群

## 交流

1. 通过 slack.rancher.io 加入 Rancher 社区 Slack
2. 访问 rancher-users.*** 并加入我们的 #k3d 频道
3. 开始交流

## 历史

## 相关项目

- https://github.com/inercia/k3x：k3d 的 GUI（Linux）
- https://github.com/inercia/vscode-k3d：k3d 的 vscode 插件
- https://github.com/AbsaOSS/k3d-action：完全可定制的 GitHub Action，用于运行轻量级 Kubernetes 集群。
- https://github.com/cnrancher/autok3s：轻量级工具，帮助在任何地方运行 K3s，包括 k3d 提供程序。
- https://github.com/nolar/setup-k3d-k3s：为 GitHub Actions 设置 K3d/K3s。

## 贡献

k3d 是一个社区驱动项目，因此我们欢迎任何形式的贡献，无论是代码、逻辑、文档、示例、请求、错误报告、想法还是其他推动项目发展的内容。

请阅读我们的 **贡献指南** 和相关的 **行为准则**。

您可以在文档中找到 k3d 项目的概述（例如解释和仓库指南）：k3d.io/stable/design/project/

## 贡献者 ✨

感谢这些优秀的贡献者（emoji 含义）：

Thorsten Klein 💻 📖 🤔 🚧
Rishabh Gupta 🤔 💻
Louis Tournayre 📖
Lionel Nicolas 💻
Toon Sevrin 💻
Dennis Hoppe 📖 💡
Jonas Dellinger 🚇

markrexwinkel 📖
Alvaro 💻 🤔 🔌
Nuno do Carmo 🖋 ✅ 💬
Erwin Kersten 📖
Alex Sears 📖
Mateusz Urbanek 💻
Benjamin Blattberg 💻

Simon Baier 💻
Ambrose Chua 💻
Erik Godding Boye 💻
York Wong 💻
Raul Gonzales 💻 📖
Sunghoon Kang 💻
Kamesh Sampath 💻

Arik Maor 💻 ✅ 💡
Danny Gershman 💻
stopanko 💵
Danny Breyfogle 📖
Ahmed AbouZaid 🤔 💻 📖
Pierre Roudier 💻
Adrien Horgnies 📖

## 赞助商

**感谢我们出色的赞助商！** 🙏
```css
.grid {
display: grid;
grid-template-columns: repeat(auto-fill, minmax(150px, 1fr));
gap: 8px;
}

.grid-item {
padding: 20px;
text-align: center;
}

Johnathan W Stackable