Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/weaveworks/wksctl
Open Source Weaveworks Kubernetes System
https://github.com/weaveworks/wksctl
Last synced: 2 months ago
JSON representation
Open Source Weaveworks Kubernetes System
- Host: GitHub
- URL: https://github.com/weaveworks/wksctl
- Owner: weaveworks
- License: apache-2.0
- Archived: true
- Created: 2019-08-14T21:48:47.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-31T12:32:52.000Z (almost 2 years ago)
- Last Synced: 2024-08-02T01:25:43.094Z (5 months ago)
- Language: Go
- Homepage:
- Size: 16.1 MB
- Stars: 397
- Watchers: 44
- Forks: 55
- Open Issues: 73
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-repositories - weaveworks/wksctl - Open Source Weaveworks Kubernetes System (Go)
- awesome-cloud-native - wksctl - Open Source Weaveworks Kubernetes System. (Cluster)
README
# ⚠️ [Weave Kubernetes System has been retired](https://eol.weave.works/). 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](#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:
- 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](https://github.com/weaveworks/wksctl/releases)
1. Unpack and add the `wksctl` binary to your path
For example:
```console
cd
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](https://wksctl.readthedocs.io/en/latest/get-started) 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](https://github.com/weaveworks/footloose), [Vagrant](https://www.vagrantup.com) and others!
- [Firekube](https://github.com/weaveworks/wks-quickstart-firekube) - use our WKS + Footloose + Ignite demo and be up and running in no time
- [WKS and Footloose](https://wksctl.readthedocs.io/en/latest/wks-and-footloose)
- [WKS and Vagrant](https://wksctl.readthedocs.io/en/latest/wks-and-vagrant)
- [WKS on GCE](https://wksctl.readthedocs.io/en/latest/wks-on-gce)
### Contributing
Please see [CONTRIBUTING.md](CONTRIBUTING.md) and our [Code Of Conduct](CODE_OF_CONDUCT.md).
Other interesting resources include:
- [The issue tracker](https://github.com/weaveworks/wksctl/issues)
- [Developing `wksctl`](https://wksctl.readthedocs.io/en/latest/development)
### More Documentation
- [Frequently asked questions](https://wksctl.readthedocs.io/en/latest/faq)
- [Developing `wksctl`](https://wksctl.readthedocs.io/en/latest/development)
### 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](https://weave-community.slack.com/messages/wksctl/) slack channel.
- [File an issue](https://github.com/weaveworks/wksctl/issues/new).
Your feedback is always welcome!
### License
[Apache 2.0](LICENSE)