alexellis/k3sup
K3sup
k3sup is a command-line tool that installs and manages lightweight Kubernetes clusters entirely over SSH, without requiring any pre-installed software on the target machines. It bootstraps clusters on remote hosts using a single statically-linked binary, then provides immediate kubectl access by fetching and merging the cluster's admin credentials into the local configuration. The tool supports plan-driven cluster topology, allowing users to define node roles and configuration in a YAML file for automated multi-node deployment.
The tool distinguishes itself by enabling parallel execution of installation and management commands across all specified hosts, minimizing setup time for multi-node clusters. It supports building highly available clusters with multi-master control planes using embedded etcd or external SQL datastores, and can add worker nodes to an existing cluster over SSH. k3sup also handles cluster teardown in the correct order, and can run arbitrary shell commands simultaneously on every node in a cluster.
Beyond cluster lifecycle management, the tool includes capabilities for verifying cluster readiness by checking that all nodes report a Ready status. The project provides cross-platform binary compilation for Linux, macOS, and Windows across multiple architectures, along with automated code quality checks including formatting verification and unit test coverage reporting.
Features
- Lightweight Cluster Provisioning - Command-line tool that installs and manages lightweight Kubernetes clusters over SSH with a single command.
- SSH-Based Cluster Orchestrators - Installs Kubernetes by executing commands over SSH on remote hosts without requiring any pre-installed software.
- Idempotent Installers - Ensures repeated runs produce the same cluster state without duplicating resources.
- Parallel Command Execution - Runs installation and management commands concurrently across all specified hosts.
- Cluster Bootstrapping - Bootstraps lightweight Kubernetes clusters on remote VMs over SSH with immediate kubectl access.
- Cluster Lifecycle Management - Command-line utility that installs, joins workers, retrieves kubeconfig, and uninstalls K3s clusters over SSH.
- YAML Plan-Driven Topologies - Defines a cluster topology in a YAML plan file and applies it in parallel across multiple hosts.
- Parallel Multi-Node Operations - Adds workers, builds HA control planes, and uninstalls clusters across many hosts in parallel.
- SSH-Based Kubeconfig Retrievals - Fetches the cluster's admin credentials over SSH and merges them into the local kubectl configuration.
- Kubernetes Cluster Deployments - Reads a JSON host definition and a YAML plan to install or update a Kubernetes cluster in parallel.
- SSH-Based Kubeconfig Retrievals - Fetches the kubeconfig file from a running K3s installation and merges it into the local configuration.
- Lightweight Kubernetes Distributions - CLI that deploys, scales, and removes K3s clusters with embedded etcd or external SQL datastores.
- Installation Script Invocations - Directly invokes the K3s installation script and configuration tools over SSH.
- SSH-Based Node Provisioning - Bootstraps, joins, and manages Kubernetes nodes entirely through SSH without a local Kubernetes client.
- Kubernetes SSH Installers - Bootstraps K3s nodes and joins workers entirely over SSH without manual configuration.
- Cluster Credential Exports - Fetches the kubeconfig from a running Kubernetes installation and merges it into the local configuration file.
- Cluster Node Joins - Joins additional machines as agents to an existing Kubernetes server over SSH, expanding compute capacity.
- Single-Binary Distributions - Delivers the entire tool as a single statically-linked Go binary with no runtime dependencies.
- Orderly Cluster Removals - Removes K3s from every node in a cluster in the correct order, using a plan file or direct parameters.
- High Availability Clustering - Sets up multi-master Kubernetes clusters with embedded etcd or external SQL datastores for resilience.
- Embedded Datastore High Availability - Creates a multi-master K3s cluster using embedded etcd or an external SQL datastore for resilience.
- Automatic Kubeconfig Injections - Automatically fetches and merges the kubeconfig from a running K3s installation for immediate kubectl access.
- SSH-Based Cluster Teardowns - Removes K3s from all nodes in the correct order using SSH credentials or plan files.
- Plan-Driven Provisioners - Reads a YAML plan to install or update K3s across many servers in parallel over SSH.
- Remote Command Execution - Executes a specified command on every server or agent in the cluster simultaneously over SSH.
- Cluster-Wide Command Executions - Executes a shell command on every server or agent in a cluster simultaneously over SSH.
- Automated Node Joining - Adds worker nodes to an existing K3s cluster by connecting over SSH to each new host.
Star history
How this analysis was created: This summary and feature list are AI-generated from collected project material and can contain mistakes. Stars, license and language are imported from GitHub. Inclusion does not mean that we have tested or audited this project. Check the source documentation for any feature you depend on. Learn more on our About page.
