From fc12a2bed3cc188012b801dcaeba15770d0966e9 Mon Sep 17 00:00:00 2001
From: Tobi Nehrlich <tobi@vshn.ch>
Date: Thu, 2 Mar 2023 15:55:25 +0100
Subject: [PATCH] Document local dev setup (#50)

* Document local dev setup
---
 README.md | 40 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)

diff --git a/README.md b/README.md
index f5c38f5..9e505a3 100644
--- a/README.md
+++ b/README.md
@@ -23,3 +23,43 @@ make autorest
 [releases]: https://github.com/vshn/stardog-userrole-operator/releases
 [license]: https://github.com/vshn/stardog-userrole-operator/blob/master/LICENSE
 [dockerhub]: https://hub.docker.com/r/vshn/stardog-userrole-operator
+
+## Local Development
+
+### Prerequisites
+
+- minikube
+- helm
+- kubectl
+- Stardog image registry credentials
+- Stardog license
+
+See [the VSHN wiki (internal)](https://wiki.vshn.net/x/PIuVEw) for details on how to retrieve registry credentials and licenses for Stardog.
+
+### Init local dev environment
+
+```
+minikube start
+
+# Create values.yaml (fill in actual image registry credentials)
+cat <<EOF > values.yaml
+image:
+  username: "foo"
+  password: "supersecret"
+
+stardog:
+  adminPassword: "admin"
+
+replicaCount: 1
+
+zookeeper:
+  enabled: false
+EOF
+
+# Provide Stardog license key
+kubectl create secret generic stardog-license --from-file stardog-license-key.bin=stardog-license-key.bin
+
+# Install Stardog
+helm repo add appuio https://charts.appuio.ch
+helm install stardog appuio/stardog -f values.yaml
+```