move mimir test setup to examples

This moves the mimir test setup to the examples directory, removing the
Makefile targets and describing the required steps in the examples
README.

Author: msvechla

Makefile

@@ -100,34 +100,3 @@ examples/openshift/manifests: examples/openshift/main.jsonnet jsonnet/controller
 	jsonnet -m examples/openshift/manifests examples/openshift/main.jsonnet | xargs -I{} sh -c 'cat {} | gojsontoyaml > {}.yaml' -- {}
 	find examples/openshift/manifests -type f ! -name '*.yaml' -delete
 
-KIND_CONFIG_FILE := testdata/kind-cluster.yaml
-
-kind:
-ifeq (, $(shell which kind))
-	go install sigs.k8s.io/[email protected]
-KIND=$(GOBIN)/kind
-else
-CONTROLLER_GEN=$(shell which kind)
-endif
-
-helm-repo-add:
-	helm repo add grafana https://grafana.github.io/helm-charts || true
-
-helm-repo-update: helm-repo-add
-	helm repo update grafana
-
-ensure-kind-cluster: kind
-	@if ! kind get clusters | grep -q "^mimir$$"; then \
-		kind create cluster --config $(KIND_CONFIG_FILE); \
-	else \
-		echo "Cluster is already configured"; \
-	fi
-
-setup-mimir-test-cluster: ensure-kind-cluster helm-repo-update
-	helm upgrade -i mimir grafana/mimir-distributed --version=5.4.0 -f ./testdata/mimir-values.yaml --wait
-	@echo "\n"
-	@echo "Mimir will be available at http://localhost:30950"
-	@echo "e.g. curl localhost:30950/prometheus/config/v1/rules/namespace"
-
-delete-mimir-test-cluster: kind
-	kind delete cluster --name mimir

examples/mimir/README.md

@@ -0,0 +1,94 @@
+# Mimir Example
+
+The following explains how to deploy a simple Mimir setup that can be used to test Pyrra.
+
+## Pre-Requisites
+
+- [Helm](https://helm.sh/)
+- Kubernetes Cluster (e.g. via [kind](https://kind.sigs.k8s.io/))
+
+## Setup
+
+Ensure the Pyrra CRDs are installed in your cluster:
+
+```sh
+kubectl apply -f ./examples/kubernetes/manifests/setup/pyrra-slo-CustomResourceDefinition.yaml
+```
+
+To setup a mimir test cluster for local development you can run:
+
+```sh
+helm upgrade -i mimir grafana/mimir-distributed --version=5.4.0 -n mimir --create-namespace -f ./examples/mimir/mimir-values.yaml --wait
+```
+
+This will install the [Mimir Helm Chart](https://github.com/grafana/mimir/tree/main/operations/helm/charts/mimir-distributed) in a minimal configuration.
+
+To access the mimir API we have to port-forrward the mimir-gateway service to our local machine:
+
+```sh
+kubectl port-forward -n mimir svc/mimir-gateway 8080:8080
+```
+
+In another terminal session we can verify that everything is working by running:
+
+```sh
+curl localhost:8080
+```
+
+which should return `OK`.
+
+## Running Pyrra
+
+To run the Pyrra Operator against Mimir we can use the following command:
+
+```sh
+./pyrra kubernetes --mimir-url=http://localhost:8080
+```
+
+Additionally, we can run the Pyrra API and connect it against Mimir and the Pyrra Operator:
+
+```sh
+./pyrra api --prometheus-url=http://localhost:8080/prometheus --api-url=http://localhost:9444
+```
+
+We can then access the Pyrra UI at `http://localhost:9099`.
+
+## Deploying a SLO
+
+Lets deploy a simple SLO to test the setup:
+
+```sh
+kubectl apply -f examples/mimir/example-slo.yaml
+```
+
+The Mimir Operator logs should now indicate that the related Mimir rules have been created.
+
+## Using Mimirtool
+
+We can use the `mimirtool` to interact with the Mimir API.
+
+For setup instructions, you can refer to: <https://grafana.com/docs/mimir/latest/manage/tools/mimirtool/#installation>
+
+We can then configure the `mimirtool` to use the Mimir API:
+
+```sh
+export MIMIR_ADDRESS=http://localhost:8080
+export MIMIR_TENANT_ID=anonymous
+```
+
+Now we can list the rules created by Pyrra:
+
+```sh
+mimirtool rules list
+```
+
+Which should return the following:
+
+```
+Namespace                      | Rule Group
+apiserver-read-cluster-latency | apiserver-read-cluster-latency
+```
+
+## Teardown
+
+You can run `helm uninstall mimir -n mimir` to remove the mimir deployment.

examples/mimir/example-slo.yaml

@@ -0,0 +1,18 @@
+apiVersion: pyrra.dev/v1alpha1
+kind: ServiceLevelObjective
+metadata:
+  labels:
+    prometheus: k8s
+    role: alert-rules
+  name: apiserver-read-cluster-latency
+  namespace: default
+spec:
+  description: ""
+  indicator:
+    latency:
+      success:
+        metric: apiserver_request_sli_duration_seconds_bucket{component="apiserver",scope=~"cluster|",verb=~"LIST|GET",le="5"}
+      total:
+        metric: apiserver_request_sli_duration_seconds_count{component="apiserver",scope=~"cluster|",verb=~"LIST|GET"}
+  target: "99"
+  window: 2w

testdata/mimir-values.yaml renamed to examples/mimir/mimir-values.yaml

@@ -54,6 +54,3 @@ nginx:
 gateway:
   enabledNonEnterprise: true
   replicas: 1
-  service:
-    type: "NodePort"
-    nodePort: 30950