Updated README to indicate this repo is for beginners and demonstration only

This commit is contained in:
2025-02-21 16:24:06 -07:00
parent 3938d90977
commit 1d925cfa77
+6 -2
View File
@@ -1,5 +1,9 @@
# demo-k3s-cluster # k3s-demo-cluster
A demonstration k3s cluster with a full *arr suite. This repository houses an Ansible playbook to create a K3s cluster on Raspberry Pis. It will automatically create the master node and add as many worker nodes as you'd like. Then, once the cluster is created, you can deploy the *arr suite and a handful of other services into the cluster for testing.
The resource definitions for each service are generated using [kompose](https://kompose.io/), which is a tool for converting Docker Compose files into Kubernetes resource definitions.
This is done to make it easy for beginners to understand how Kubernetes works without needing to learn complex resource definitions.
To this end, all the original `docker-compose.yml` files are also available in each service's directory.
## Prerequisites ## Prerequisites
**Note:** All steps in this guide are performed on Ubuntu 22.04. User experience may differ. **Note:** All steps in this guide are performed on Ubuntu 22.04. User experience may differ.