Skip to content

Commit 18852ec

Browse files
committed
Fixes in README
Signed-off-by: Alex Ellis (OpenFaaS Ltd) <alexellis2@gmail.com>
1 parent 7205b41 commit 18852ec

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ How do you say it? Ketchup, as in tomato.
1717
- [k3sup 🚀 (said 'ketchup')](#k3sup--said-ketchup)
1818
- [Contents:](#contents)
1919
- [What's this for? 💻](#whats-this-for-)
20-
- [Do you love `k3sup`?](#do-you-love-k3sup)
21-
- [Uses](#uses)
20+
- [Are you a `k3sup` user?](#are-you-a-k3sup-user)
21+
- [Use-cases](#use-cases)
2222
- [Bootstrapping Kubernetes](#bootstrapping-kubernetes)
2323
- [Download `k3sup` (tl;dr)](#download-k3sup-tldr)
2424
- [A note for Windows users](#a-note-for-windows-users)
@@ -45,7 +45,6 @@ How do you say it? Ketchup, as in tomato.
4545
- [Troubleshooting and support](#troubleshooting-and-support)
4646
- [Maybe the problem is with K3s?](#maybe-the-problem-is-with-k3s)
4747
- [Common issues](#common-issues)
48-
- [Support and k3sup for commercial use](#support-and-k3sup-for-commercial-use)
4948
- [Getting access to your KUBECONFIG](#getting-access-to-your-kubeconfig)
5049
- [Smart cards and 2FA](#smart-cards-and-2fa)
5150
- [Misc note on `iptables`](#misc-note-on-iptables)
@@ -58,7 +57,7 @@ You may wonder why a tool like this needs to exist when you can do this sort of
5857

5958
k3sup was developed to automate what can be a very manual and confusing process for many developers, who are already short on time. Once you've provisioned a VM with your favourite tooling, `k3sup` means you are only 60 seconds away from running `kubectl get pods` on your own computer. If you are a local computer, you can bypass SSH with `k3sup install --local`
6059

61-
## Do you use `k3sup`?
60+
## Are you a `k3sup` user?
6261

6362
`k3sup` was created by [Alex Ellis](https://github.com/users/alexellis/sponsorship) - the founder of [OpenFaaS &reg;](https://www.openfaas.com/) & [inlets](https://inlets.dev/).
6463

@@ -68,13 +67,16 @@ k3sup was developed to automate what can be a very manual and confusing process
6867

6968
Want to see continued development? [Sponsor alexellis on GitHub](https://github.com/users/alexellis/sponsorship)
7069

71-
### Uses
70+
### Use-cases
71+
72+
K3sup runs from your local machine, without ever having to log into a remote server.
7273

7374
* Bootstrap Kubernetes with k3s onto any VM with `k3sup install` - either manually, during CI or through `cloud-init`
74-
* Get from zero to `kubectl` with `k3s` on Raspberry Pi (RPi), VMs, AWS EC2, Packet bare-metal, DigitalOcean, Civo, Scaleway, and others
75-
* Build a HA, multi-master (server) cluster
76-
* Fetch the KUBECONFIG from an existing `k3s` cluster
75+
* Get from zero to `kubectl` with `k3s` on bare-metal, Raspberry Pi (RPi), VMs, AWS EC2, Google Cloud, DigitalOcean, Civo, Linode, Scaleway, and others
76+
* Build a Highly-Available (HA), multi-master (server) cluster
77+
* Fetch the KUBECONFIG from an existing cluster with `k3sup get-config`
7778
* Join nodes into an existing `k3s` cluster with `k3sup join`
79+
* Build a massive cluster for automation and scale-out testing using `k3sup plan` and a JSON file with IP addresses
7880

7981
### Bootstrapping Kubernetes
8082

0 commit comments

Comments
 (0)