wksctl Documentation

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/

Table of contents

• Get started
• WKS and Firekube
• WKS and Footloose
• WKS and Vagrant
• WKS on GCE
• FAQ
• Development
• Releasing

Getting Help

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

• Invite yourself to the Weave Users Slack.
• Ask a question on the #wksctl slack channel.
• File an issue.

Your feedback is always welcome!