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

Commit

Permalink
Put a note in the README
Browse files Browse the repository at this point in the history
  • Loading branch information
bboreham committed Jun 24, 2020
1 parent fb82932 commit 550d9da
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# 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](#getting-help).

`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](https://www.weave.works/technologies/gitops/) in which cluster and machine descriptions are stored in Git and the state of the cluster tracks changes to the descriptions.

Its features include:
Expand Down

0 comments on commit 550d9da

Please sign in to comment.