diff --git a/README.md b/README.md index 50c16b7..0fc9fda 100644 --- a/README.md +++ b/README.md @@ -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: @@ -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].