From fe9164b025e69c7cc1a39ddb4b51fc765f3f7228 Mon Sep 17 00:00:00 2001
From: Yusuke Kuoka <ykuoka@gmail.com>
Date: Sun, 14 Aug 2022 13:04:03 +0900
Subject: [PATCH] doc: Encourage everyone to explicitly set HRA scaleTargetRef
 kind (#1633)

Ref #1343
---
 README.md | 66 ++++++++++++++++++++++++++++++++-----------------------
 1 file changed, 39 insertions(+), 27 deletions(-)

diff --git a/README.md b/README.md
index bd80fa7..05a46cf 100644
--- a/README.md
+++ b/README.md
@@ -543,9 +543,10 @@ spec:
   # for 5 minutes instead of the default 10 minutes now
   scaleDownDelaySecondsAfterScaleOut: 300
   scaleTargetRef:
+    type: RunnerDeployment
+    # # In case the scale target is RunnerSet:
+    # kind: RunnerSet
     name: example-runner-deployment
-    # Uncomment the below in case the target is not RunnerDeployment but RunnerSet
-    #kind: RunnerSet
   minReplicas: 1
   maxReplicas: 5
   metrics:
@@ -571,10 +572,10 @@ metadata:
   name: example-runner-deployment-autoscaler
 spec:
   scaleTargetRef:
-    # Your RunnerDeployment Here
+    type: RunnerDeployment
+    # # In case the scale target is RunnerSet:
+    # kind: RunnerSet
     name: example-runner-deployment
-    # Uncomment the below in case the target is not RunnerDeployment but RunnerSet
-    #kind: RunnerSet
   minReplicas: 1
   maxReplicas: 5
   # Your chosen scaling metrics here
@@ -615,9 +616,10 @@ metadata:
   name: example-runner-deployment-autoscaler
 spec:
   scaleTargetRef:
+    type: RunnerDeployment
+    # # In case the scale target is RunnerSet:
+    # kind: RunnerSet
     name: example-runner-deployment
-    # IMPORTANT : If your HRA is targeting a RunnerSet you must specify the kind in the scaleTargetRef:, uncomment the below
-    #kind: RunnerSet
   minReplicas: 1
   maxReplicas: 5
   metrics:
@@ -650,9 +652,10 @@ metadata:
   name: example-runner-deployment-autoscaler
 spec:
   scaleTargetRef:
+    type: RunnerDeployment
+    # # In case the scale target is RunnerSet:
+    # kind: RunnerSet
     name: example-runner-deployment
-    # Uncomment the below in case the target is not RunnerDeployment but RunnerSet
-    #kind: RunnerSet
   minReplicas: 1
   maxReplicas: 5
   metrics:
@@ -671,9 +674,10 @@ metadata:
   name: example-runner-deployment-autoscaler
 spec:
   scaleTargetRef:
+    type: RunnerDeployment
+    # # In case the scale target is RunnerSet:
+    # kind: RunnerSet
     name: example-runner-deployment
-    # Uncomment the below in case the target is not RunnerDeployment but RunnerSet
-    #kind: RunnerSet
   minReplicas: 1
   maxReplicas: 5
   metrics:
@@ -700,9 +704,10 @@ More concretely, you can configure the targeted GitHub event types and the `N` i
 kind: HorizontalRunnerAutoscaler
 spec:
   scaleTargetRef:
+    type: RunnerDeployment
+    # # In case the scale target is RunnerSet:
+    # kind: RunnerSet
     name: example-runners
-    # Uncomment the below in case the target is not RunnerDeployment but RunnerSet
-    #kind: RunnerSet
   scaleUpTriggers:
   - githubEvent:
       checkRun:
@@ -910,9 +915,10 @@ spec:
   minReplicas: 1
   maxReplicas: 10
   scaleTargetRef:
+    type: RunnerDeployment
+    # # In case the scale target is RunnerSet:
+    # kind: RunnerSet
     name: example-runners
-    # Uncomment the below in case the target is not RunnerDeployment but RunnerSet
-    #kind: RunnerSet
   scaleUpTriggers:
   - githubEvent:
       workflowJob: {}
@@ -945,9 +951,10 @@ spec:
   minReplicas: 1
   maxReplicas: 10
   scaleTargetRef:
+    type: RunnerDeployment
+    # # In case the scale target is RunnerSet:
+    # kind: RunnerSet
     name: example-runners
-    # Uncomment the below in case the target is not RunnerDeployment but RunnerSet
-    #kind: RunnerSet
   scaleUpTriggers:
   - githubEvent:
       checkRun:
@@ -973,9 +980,10 @@ spec:
   minReplicas: 1
   maxReplicas: 10
   scaleTargetRef:
+    type: RunnerDeployment
+    # # In case the scale target is RunnerSet:
+    # kind: RunnerSet
     name: example-runners
-    # Uncomment the below in case the target is not RunnerDeployment but RunnerSet
-    #kind: RunnerSet
   scaleUpTriggers:
   - githubEvent:
       checkRun:
@@ -1005,9 +1013,10 @@ spec:
   minReplicas: 1
   maxReplicas: 10
   scaleTargetRef:
+    type: RunnerDeployment
+    # # In case the scale target is RunnerSet:
+    # kind: RunnerSet
     name: example-runners
-    # Uncomment the below in case the target is not RunnerDeployment but RunnerSet
-    #kind: RunnerSet
   scaleUpTriggers:
   - githubEvent:
       pullRequest:
@@ -1035,9 +1044,10 @@ spec:
   minReplicas: 1
   maxReplicas: 10
   scaleTargetRef:
+    type: RunnerDeployment
+    # # In case the scale target is RunnerSet:
+    # kind: RunnerSet
     name: example-runners
-    # Uncomment the below in case the target is not RunnerDeployment but RunnerSet
-    #kind: RunnerSet
   scaleUpTriggers:
   - githubEvent:
       push:
@@ -1082,9 +1092,10 @@ metadata:
   name: example-runner-deployment-autoscaler
 spec:
   scaleTargetRef:
+    type: RunnerDeployment
+    # # In case the scale target is RunnerSet:
+    # kind: RunnerSet
     name: example-runner-deployment
-    # Uncomment the below in case the target is not RunnerDeployment but RunnerSet
-    #kind: RunnerSet
   scheduledOverrides:
   # Override minReplicas to 100 only between 2021-06-01T00:00:00+09:00 and 2021-06-03T00:00:00+09:00
   - startTime: "2021-06-01T00:00:00+09:00"
@@ -1104,9 +1115,10 @@ metadata:
   name: example-runner-deployment-autoscaler
 spec:
   scaleTargetRef:
+    type: RunnerDeployment
+    # # In case the scale target is RunnerSet:
+    # kind: RunnerSet
     name: example-runner-deployment
-    # Uncomment the below in case the target is not RunnerDeployment but RunnerSet
-    #kind: RunnerSet
   scheduledOverrides:
   # Override minReplicas to 0 only between 0am sat to 0am mon
   - startTime: "2021-05-01T00:00:00+09:00"