From dd02d113a97b8624b50d12c130c5b441202f5293 Mon Sep 17 00:00:00 2001 From: Gianluca Arbezzano Date: Wed, 2 Sep 2020 09:41:10 +0200 Subject: [PATCH] Add README --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index eb0c0f8..efb6268 100644 --- a/README.md +++ b/README.md @@ -1 +1,18 @@ -See [proposal/0007](https://github.com/tinkerbell/proposals/pull/11) +This repository is a quick way to get the Tinkerbell stack up and running. + +Currently it supports: + +1. Vagrant with vlib and VirtualBox +2. Terraform on Packet + +Tinkerbell is made of different components: osie, boots, tink-server, +tink-worker and so on. Currently they are under heavy development and we are +working around the release process for all the components. + +We need a way to serve a version of Tinkerbell that you can use and we know what +is running the hood. Sandbox runs a pinned version for all the components via +commit sha. In this way as a user you won't be effected (ideally) from new code +that will may change a bit how Tinkerbell works. + +We are keeping the number of bc break as low as possible but in the current +state they are expected.