From 33d0c5c56a839f1014391a3a4d6ef18333cf31bc Mon Sep 17 00:00:00 2001
From: csabca83 <54415375+csabca83@users.noreply.github.com>
Date: Tue, 6 Aug 2024 19:35:57 +0200
Subject: [PATCH] Update documentation - autoscaling requirements (#317)

---
 README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/README.md b/README.md
index 010432f..3feee99 100644
--- a/README.md
+++ b/README.md
@@ -244,6 +244,28 @@ rules:
   verbs: ["watch","list","get","update"]
 ```
 
+Make sure to set `StatefulSet.metadata.name` and `StatefulSet.spec.serviceName` to the same value;
+otherwise, autoscaling will not trigger:
+
+```yaml
+apiVersion: v1
+kind: Service
+metadata:
+  name: mc-forge
+spec:
+  type: ClusterIP
+  annotations:
+    "mc-router.itzg.me/defaultServer": "true"
+    "mc-router.itzg.me/externalServerName": "external.host.name"
+---
+apiVersion: apps/v1
+kind: StatefulSet
+metadata:
+  name: mc-forge
+spec:
+  serviceName: mc-forge
+```
+
 ## REST API
 
 * `GET /routes` (with `Accept: application/json`)