From c90eb8c6d3ce901db681df89e208677adadbbdfa Mon Sep 17 00:00:00 2001 From: Robin Opletal Date: Mon, 6 Nov 2023 14:53:26 +0100 Subject: [PATCH] chore(README): slightly adjust README to warn about osko's maturity Signed-off-by: Robin Opletal --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 504b79d..39d7fc4 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,13 @@ This operator aims to provide it's users with simple management of SLIs, SLOs, a See the [design document](DESIGN.md) for more details on what `osko` aims to do. +## Here be dragons! + +`osko` is in very active development, hardly functional and definitelly not stable. Until a `v1` release comes around, use at your own risk. + ## Test It Out -1. You’ll need a Kubernetes cluster to run against. You can use [KIND](https://sigs.k8s.io/kind) to get a local cluster for testing, or run against a remote cluster. +1. You’ll need a Kubernetes cluster to run `osko`. You can use [KIND](https://sigs.k8s.io/kind) to get a local cluster for testing, or run against a remote cluster. - refer to the [Installation and usage](https://github.com/kubernetes-sigs/kind#installation-and-usage) section of the [KIND](https://sigs.k8s.io/kind) README to use KIND. **Note:** Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster `kubectl cluster-info` shows).