Skip to content
This repository has been archived by the owner on Mar 31, 2023. It is now read-only.


Repository files navigation

⚠️ Weave Kubernetes System has been retired. This repo is now archived. ⚠️

Please see and for alternatives.

Weave Kubernetes System Control - wksctl

Please note that the code has recently updated from ClusterAPI v1alpha1 to v1alpha3 and as a result Everything Has Changed While this note is in the README you may find inconsistencies in the code, and between the code, examples and documentation. Sorry about that. Feel free to still open issues and/or ask questions as below.

wksctl allows simple creation of a Kubernetes cluster given a set of IP addresses and an SSH key. It can be run in a standalone environment but is best used via a GitOps approach in which cluster and machine descriptions are stored in Git and the state of the cluster tracks changes to the descriptions.

Its features include:

  • simple creation of Kubernetes clusters
  • manage cluster and machine descriptions using Git
  • manage addons like Weave Net or Flux
  • Sealed Secret integration

Install wksctl binary

  1. Download the OS specific wksctl release package from the release page
  2. Unpack and add the wksctl binary to your path

For example:

cd <download dir>
tar xfz wksctl-0.7.0-linux-x86_64.tar.gz
chmod +x wksctl
sudo mv wksctl /usr/local/bin/

Check out our Get Started doc to dive deeper into the different ways to operate wksctl.

Quick start

We put together a couple of guides to get you up and running with WKS in combination with Footloose, Vagrant and others!


Please see and our Code Of Conduct.

Other interesting resources include:

More Documentation

Getting Help

If you have any questions about, feedback for or problems with wksctl:

Your feedback is always welcome!


Apache 2.0