Repolode
alexellis

alexellis/k3sup

一个命令行工具,通过 SSH 在远程或本地虚拟机上安装 K3s,并获取 kubeconfig 以便使用 kubectl。

Star
7,439
Fork
432
未关闭 Issue
34
最近提交
2个月前

这是什么?

k3sup 是一个用 Go 编写的小型命令行工具,可以把一台 Linux 机器从零带到可用的 K3s Kubernetes 集群。你在自己的电脑上运行它,指定一台可通过 SSH 访问的主机,它就会在该主机上安装 K3s,并把 kubeconfig 复制回本地,让 kubectl 立即可用。它还可以把其他 Linux 主机作为 K3s agent 加入集群,也支持跳过 SSH 的本地安装模式。

该工具适用于云服务器、裸金属服务器和树莓派等 Linux 主机,二进制文件可交叉编译到 Linux、Windows 和 macOS。可选参数包括 K3s 版本或频道、SSH 端口和密钥、禁用 traefik 等附带组件、使用内嵌 etcd 或外部 SQL 数据存储的多 server 高可用部署,以及把生成的 kubeconfig 合并到已有文件的指定 context 中。

项目还提供商业版 k3sup Pro,增加 plan 和 apply 命令,用于在大量节点上并行、类 GitOps 方式安装,并提供 exec、uninstall、get-config 等命令。社区版核心工具采用 MIT 许可证。

核心功能

  • 01通过 SSH 一条命令在远程 Linux 主机上安装 K3s。
  • 02把 kubeconfig 拉取到本地,并可按指定 context 合并到已有文件。
  • 03将其他 Linux 主机作为 K3s agent 加入集群。
  • 04支持使用内嵌 etcd 或外部 SQL 数据存储的高可用多 server 部署。
  • 05在当前机器安装时可使用本地模式,无需 SSH。
  • 06以静态二进制形式分发,支持 Linux、Windows 和 macOS。

适用场景

  • 在云服务器上快速搭建单节点或多节点 K3s 集群。
  • 在树莓派上搭建家庭实验室 Kubernetes 集群。
  • 在 CI 任务或 cloud-init 脚本中自动引导 K3s。
  • 部署由多个 server 组成的高可用 K3s 控制平面。

快速上手

  1. 1

    使用 README 中的官方安装脚本安装 k3sup 二进制文件

  2. 2

    将二进制文件移动到 PATH 目录中

    sudo install k3sup /usr/local/bin/
  3. 3

    在本机上安装 K3s(无需 SSH)

    k3sup install --local

使用前须知

  • 除非云镜像已配置,目标主机需要免密码 sudo 权限。
  • K3sup Pro 需要 GitHub 赞助或商业许可,并受 EULA 约束。
  • 元数据未明确许可证(NOASSERTION),商业使用前请检查 LICENSE 文件。

标签

常见问题

k3sup 是什么?
一个命令行工具,通过 SSH 在远程或本地虚拟机上安装 K3s,并获取 kubeconfig 以便使用 kubectl。 k3sup 是一个用 Go 编写的小型命令行工具,可以把一台 Linux 机器从零带到可用的 K3s Kubernetes 集群。你在自己的电脑上运行它,指定一台可通过 SSH 访问的主机,它就会在该主机上安装 K3s,并把 kubeconfig 复制回本地,让 kubectl 立即可用。它还可以把其他 Linux 主机作为 K3s agent 加入集群,也支持跳过 SSH 的本地安装模式。
k3sup 可以免费使用吗?用的什么许可证?
k3sup 以 Other 许可证开源。用于商业产品前,请先确认许可证条款。
k3sup 还在维护吗?
半年内有更新。k3sup 最近一次提交是在 2026年9月3日。
k3sup 适合用来做什么?
在云服务器上快速搭建单节点或多节点 K3s 集群。 在树莓派上搭建家庭实验室 Kubernetes 集群。 在 CI 任务或 cloud-init 脚本中自动引导 K3s。 部署由多个 server 组成的高可用 K3s 控制平面。
k3sup 怎么安装和运行?
使用 README 中的官方安装脚本安装 k3sup 二进制文件 将二进制文件移动到 PATH 目录中: sudo install k3sup /usr/local/bin/ 在本机上安装 K3s(无需 SSH): k3sup install --local
在哪里获取 k3sup?
源代码和安装说明在 GitHub 上:https://github.com/alexellis/k3sup

概要由 AI 根据项目 README 生成;GitHub 数据每日更新。

相关项目