Repolode
alexellis

alexellis/k3sup

SSH経由でリモートまたはローカルのVMにK3s Kubernetesをインストールし、kubectl用のkubeconfigを取得できるコマンドラインツール。

スター
7,439
フォーク
432
未解決の Issue
34
最終コミット
2 か月前

これは何?

k3supは、LinuxマシンにK3s Kubernetesクラスターをゼロから構築する、小さなGo製コマンドラインユーティリティです。自分のコンピューターから実行し、SSHで接続できるホストを指定すると、そのホストにK3sをインストールし、kubectlをすぐに使えるようにkubeconfigを自分のマシンへコピーします。追加のLinuxホストをK3s agentとしてクラスターに参加させることもでき、SSHを使わないローカルインストールモードにも対応しています。

対象はクラウドVM、ベアメタルサーバー、Raspberry PiデバイスなどのLinuxホストで、バイナリはLinux、Windows、macOS向けにクロスコンパイルされています。K3sのバージョンやチャンネルの指定、SSHポートや鍵の設定、traefikなど同梱コンポーネントの無効化、組み込みetcdまたは外部SQLデータストアを使う複数サーバー構成のHAセットアップ、生成したkubeconfigを名前付きコンテキストで既存ファイルにマージする設定などが可能です。

リポジトリでは商用エディションのk3sup Proについても説明されており、多数のノードに対する並列のGitOpsスタイルのインストールを行うplanコマンドとapplyコマンドに加え、exec、uninstall、get-configコマンドが利用できます。コアとなるCEツールはMITライセンスです。

主な機能

  • 01SSH経由でリモートのLinuxホストにK3sをワンコマンドでインストールできます。
  • 02kubeconfigを自分のマシンに取得し、名前付きコンテキストで既存ファイルにマージできます。
  • 03追加のLinuxホストをK3s agentとしてクラスターに参加させられます。
  • 04組み込みetcdまたは外部SQLデータストアを使ったHAサーバー構成に対応しています。
  • 05現在のマシンへのインストールでは、SSHを使わないローカルモードで実行できます。
  • 06Linux、Windows、macOS向けの静的バイナリとして提供されています。

ユースケース

  • クラウドVM上にシングルノードまたはマルチノードのK3sクラスターを構築する。
  • Raspberry Piデバイスでホームラボ用のKubernetesクラスターを構築する。
  • CIジョブやcloud-initスクリプトからK3sをブートストラップする。
  • 複数のサーバーで高可用性のK3sコントロールプレーンを構築する。

クイックスタート

  1. 1

    READMEに記載されている公式インストールスクリプトで、k3supバイナリをインストールする

  2. 2

    バイナリをPATHに配置する

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

    SSHを使わずにローカルマシンへK3sをインストールする

    k3sup install --local

使う前に知っておきたいこと

  • クラウドイメージですでに許可されている場合を除き、対象ホストではパスワードなしのsudoが必要です。
  • K3sup Proの利用にはGitHub Sponsorshipまたは商用ライセンスが必要で、EULAが適用されます。
  • メタデータ上、ライセンスは明確に示されていません(NOASSERTION)。商用利用の前にLICENSEファイルを確認してください。

トピック

よくある質問

k3sup とは?
SSH経由でリモートまたはローカルのVMにK3s Kubernetesをインストールし、kubectl用のkubeconfigを取得できるコマンドラインツール。 k3supは、LinuxマシンにK3s Kubernetesクラスターをゼロから構築する、小さなGo製コマンドラインユーティリティです。自分のコンピューターから実行し、SSHで接続できるホストを指定すると、そのホストにK3sをインストールし、kubectlをすぐに使えるようにkubeconfigを自分のマシンへコピーします。追加のLinuxホストをK3s agentとしてクラスターに参加させることもでき、SSHを使わないローカルインストールモードにも対応しています。
k3sup は無料で使えますか?ライセンスは?
k3sup は Other ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。
k3sup は今もメンテナンスされていますか?
半年以内に更新あり。k3sup の最終コミットは 2026年9月3日 です。
k3sup は何に使えますか?
クラウドVM上にシングルノードまたはマルチノードのK3sクラスターを構築する。 Raspberry Piデバイスでホームラボ用のKubernetesクラスターを構築する。 CIジョブやcloud-initスクリプトからK3sをブートストラップする。 複数のサーバーで高可用性のK3sコントロールプレーンを構築する。
k3sup のインストール方法は?
READMEに記載されている公式インストールスクリプトで、k3supバイナリをインストールする バイナリをPATHに配置する: sudo install k3sup /usr/local/bin/ SSHを使わずにローカルマシンへK3sをインストールする: k3sup install --local
k3sup はどこで入手できますか?
ソースコードとインストール手順は GitHub にあります:https://github.com/alexellis/k3sup

概要はプロジェクトの README をもとに AI が生成しています。GitHub の数値は毎日更新されます。

関連プロジェクト