Skip to content

Commit

Permalink
chore(README): slightly adjust README to warn about osko's maturity
Browse files Browse the repository at this point in the history
Signed-off-by: Robin Opletal <[email protected]>
  • Loading branch information
fourstepper committed Nov 6, 2023
1 parent dd1c4b5 commit 92a08e4
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 definitely 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).
Expand Down

0 comments on commit 92a08e4

Please sign in to comment.