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

Commit

Permalink
Merge pull request #344 from weaveworks/archive-docs
Browse files Browse the repository at this point in the history
Archive docs
  • Loading branch information
morancj authored Mar 31, 2023
2 parents 3657ff8 + fd2bf06 commit 25e3ed1
Show file tree
Hide file tree
Showing 13 changed files with 23 additions and 545 deletions.
1 change: 1 addition & 0 deletions .python-version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
3.10.10
71 changes: 0 additions & 71 deletions docs/cluster.md

This file was deleted.

46 changes: 0 additions & 46 deletions docs/development.md

This file was deleted.

18 changes: 0 additions & 18 deletions docs/faq.md

This file was deleted.

69 changes: 0 additions & 69 deletions docs/get-started.md

This file was deleted.

48 changes: 5 additions & 43 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,8 @@
# 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](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.
!!! important "Deprecation notice"
[Weave Kubernetes System has been retired](https://eol.weave.works/).
Please see the previous versions if you still need documentation for the
legacy `wksctl`.

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 <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](get-started.md)
- [WKS and Firekube](wks-and-firekube.md)
- [WKS and Footloose](wks-and-footloose.md)
- [WKS and Vagrant](wks-and-vagrant.md)
- [WKS on GCE](wks-on-gce.md)
- [FAQ](faq.md)
- [Development](development.md)
- [Releasing](releasing.md)


## Getting Help

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

- Invite yourself to the <a href="https://slack.weave.works/" target="_blank">Weave Users Slack</a>.
- 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!
Please see [Weave GitOps](https://www.weave.works/product/gitops/) and [ Weave GitOps Enterprise ](https://www.weave.works/product/gitops-enterprise/) for alternatives.
26 changes: 0 additions & 26 deletions docs/releasing.md

This file was deleted.

7 changes: 4 additions & 3 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
mkdocs == 1.1
mkdocs-material == 5.1.5
pymdown-extensions >= 7.1
mkdocs == 1.4.2
mkdocs-material == 9.1.5
pymdown-extensions == 9.10
mkdocs-redirects == 1.2.0
7 changes: 0 additions & 7 deletions docs/wks-and-firekube.md

This file was deleted.

Loading

0 comments on commit 25e3ed1

Please sign in to comment.