This repository has been archived by the owner on Mar 31, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 55
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update installation instuctions to use release binary (#20)
* Update installation instructions to use release binary
- Loading branch information
Showing
1 changed file
with
10 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,18 +2,22 @@ | |
|
||
The `wksctl` command 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. | ||
|
||
## Install wksctl binary | ||
|
||
## Install `wksctl` | ||
1. Download the OS specific `wksctl` release package from the [release page](https://github.com/weaveworks/wksctl/releases) | ||
1. Unpack and add the `wksctl` binary to your path | ||
|
||
```console | ||
git clone [email protected]:weaveworks/wksctl.git | ||
cd wksctl | ||
make install | ||
For example: | ||
``` | ||
cd <download dir> | ||
tar xf wksctl-0.7.0-linux-x86_64.tar.gz | ||
chmod +x wksctl | ||
sudo mv wksctl /usr/local/bin/ | ||
``` | ||
|
||
## Quick start | ||
|
||
The [examples](examples) folder contains guides to get you up and running with [Footloose](https://github.com/weaveworks/footloose), [Vagrant](https://www.vagrantup.com) and others! | ||
The [examples](examples) folder (also included in the release package download) contains guides to get you up and running with [Footloose](https://github.com/weaveworks/footloose), [Vagrant](https://www.vagrantup.com) and others! | ||
|
||
## Modes of use | ||
|
||
|