Skip to content

Commit

Permalink
fix(docs): improve DX by promoting quickstart
Browse files Browse the repository at this point in the history
  • Loading branch information
nicklasfrahm committed May 1, 2022
1 parent 523d3fa commit 7c2322b
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,7 @@

A lightweight Kubernetes engine that deploys `k3s` clusters declaratively based on a cluster configuration file. The name is a hommage to the German word for cheese, _Käse [ˈkɛːzə]_.

## Requirements 📝

The nodes have to be accessible via SSH, either directly or via a bastion host. Further, the user on the remote nodes needs to have passwordless `sudo` set up. If this is not yet the case, you may manually do so via the following command:

```bash
$ echo "$(whoami) ALL=(ALL) NOPASSWD: ALL" | sudo tee /etc/sudoers.d/$(whoami)
```

## Testing 🧪
## Quickstart 💡

If you want to test `k3se` you can use [Vagrant][website-vagrant]. All examples in the `examples/` folder can be used with the provided `Vagrantfile` that provisions 3 Ubuntu VMs. To bring up the VMs you can run the following command:

Expand All @@ -24,6 +16,14 @@ Once you are done testing, you can destroy the VMs with the following command:
$ make vagrant-down
```

## Prerequisites 📝

The nodes have to be accessible via SSH, either directly or via a bastion host. Further, the user on the remote nodes needs to have passwordless `sudo` set up. If this is not yet the case, you may manually do so via the following command:

```bash
$ echo "$(whoami) ALL=(ALL) NOPASSWD: ALL" | sudo tee /etc/sudoers.d/$(whoami)
```

## License 📄

This project is and will always be licensed under the terms of the [MIT license][file-license].
Expand Down

0 comments on commit 7c2322b

Please sign in to comment.