Shaken Fist k3s client plugin

This is a plugin for sf-client, the command line client for the Shaken Fist minimal cloud. It adds a k3s command group which orchestrates k3s Kubernetes clusters on Shaken Fist instances, including MetalLB for load balancer addresses and Longhorn for persistent storage. Cluster state is stored in Shaken Fist namespace metadata, so any authorized client can manage a cluster.

Installation

pip install shakenfist_client_k3s

The plugin registers itself with sf-client via an entry point, so once installed the commands appear automatically.

Cluster nodes communicate with Shaken Fist over the sf-agent2 side channel, so clusters require shakenfist_client >= 0.7.7 (installed automatically) and a Shaken Fist server and guest image recent enough to speak sf-agent2.

Usage

# Create a cluster with two workers and a highly available control plane
sf-client k3s create mycluster --worker-count 2 --control-plane-count 3

# Fetch a kubeconfig for the new cluster
sf-client k3s getconfig mycluster

# Grow the cluster later
sf-client k3s expand-workers mycluster --worker-count 2

# And clean up when you are done
sf-client k3s delete mycluster

sf-client k3s --help lists the full command set.

Documentation

• Using the k3s command group -- every command, its options, and where cluster state lives.
• The library API -- calling the same orchestration from Python, with no Click involved.
• Testing and CI -- how to run the tests, and what the two CI tiers cover.