Skip to content
Open Source Weaveworks Kubernetes System
Go Shell Jsonnet Makefile Other
Branch: master
Clone or download
chanwit Merge pull request #101 from weaveworks/doc_ssh
doc: add how to ssh into a machine
Latest commit 53e4e88 Oct 14, 2019
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Adds link to tests dashboard! Sep 27, 2019
addons Fix the weave-net addon and remove the ingress addon from the footloo… Aug 23, 2019
bin initial commit Aug 14, 2019
build standarizes usage of tar commands Sep 13, 2019
cmd Footloose scaling (#94) Oct 9, 2019
docs doc: add how to ssh into a machine Oct 14, 2019
environments/local-docker-registry Remove redundant instructions/comments for local-docker-registry Sep 26, 2019
examples Update examples/gce/generate-machines-manifest.js Oct 10, 2019
pkg Footloose scaling (#94) Oct 9, 2019
test container-test, integration-test: retire sshKeyPath as a clusterapi f… Oct 3, 2019
tools Return git tag instead of branch+hash if commit is tagged. Sep 6, 2019
.gitignore add initial rtd support Sep 18, 2019
.goreleaser.yml release: Update the location of the Version and ImageTag variables Sep 20, 2019
.readthedocs.yaml rename .yml to .yaml - that's supported too Sep 18, 2019 add some basic community information, link to resources Sep 10, 2019 change links to Sep 18, 2019
DEPENDENCIES initial commit Aug 14, 2019
LICENSE LICENSE is a more common file name than Sep 13, 2019
Makefile build: Do not publish the docs Docker image Sep 24, 2019 change to #wksctl slack (#86) Sep 30, 2019
go.mod Footloose scaling (#94) Oct 9, 2019
go.sum implement profile enabile and disable Oct 9, 2019

Weave Kubernetes System Control - wksctl

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

You can’t perform that action at this time.