From 2d18f57af405a8ac45f34f248d03f11f213cfbb4 Mon Sep 17 00:00:00 2001 From: antongisli Date: Sun, 21 Nov 2021 14:17:05 +0100 Subject: [PATCH] Update README.md --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6165cf0..a95080b 100644 --- a/README.md +++ b/README.md @@ -1 +1,16 @@ -# maas-baremetal-k8s-tutorial \ No newline at end of file +# Bare metal Kubernetes with MAAS, LXD, and Juju + +## Intro + +This is a series of commands and configuration files that will guide you to build your own emulated bare metal k8s cluster on a single machine. + +It is designed to be used in conjunction with an explanatory video tutorial. +TODO: add video link + +## How to use + +Read maas-setup.sh. The script is not fully automated and requires manual intervention at times. Read the comments to understand the process. + +## Requirements + +You need a reasonably powerful machine, 4 or more cores with 32 GB of RAM and 500GB of free disk space. Assumes a fresh install of Ubuntu server on the machine.