docs: update README format

Signed-off-by: Loc Mai <[email protected]>

README.md

@@ -265,8 +265,8 @@ Kubernetes: `^1.19.0-0`
 | distributor.​affinity.​podAntiAffinity.​preferredDuringSchedulingIgnoredDuringExecution[0].​weight | int | `100` |  |
 | distributor.​annotations | object | `{}` |  |
 | distributor.​autoscaling.​behavior | object | `{}` | Ref: https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/#support-for-configurable-scaling-behavior |
-| distributor.​autoscaling.​customMetrics | list | `[]` | Optional custom and external metrics for the distributor pods to scale on In order to use this option , define a list of of specific following either: - https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale-walkthrough/#autoscaling-on-multiple-metrics-and-custom-metrics - https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale-walkthrough/#autoscaling-on-metrics-not-related-to-kubernetes-objects  For example:  - type: External   external:     metric:       name: queue_messages_ready       selector:         matchLabels:           queue: "worker_tasks"     target:       type: AverageValue       averageValue: 30 |
 | distributor.​autoscaling.​enabled | bool | `false` | Creates a HorizontalPodAutoscaler for the distributor pods. |
+| distributor.&ZeroWidthSpace;autoscaling.&ZeroWidthSpace;extraMetrics | list | `[]` | Optional custom and external metrics for the distributor pods to scale on In order to use this option , define a list of of specific following either: - https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale-walkthrough/#autoscaling-on-multiple-metrics-and-custom-metrics - https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale-walkthrough/#autoscaling-on-metrics-not-related-to-kubernetes-objects  For example: <br>  <code> - type: External <br> &nbsp; external: <br> &nbsp; &nbsp; metric:<br/> &nbsp; &nbsp; &nbsp; name: queue_messages_ready <br> &nbsp; &nbsp; &nbsp; selector:<br/> &nbsp; &nbsp; &nbsp; &nbsp; matchLabels:<br/> &nbsp; &nbsp; &nbsp; &nbsp; queue: "worker_tasks"<br/> &nbsp; &nbsp; target:<br/> &nbsp; &nbsp; &nbsp; type: AverageValue<br/> &nbsp; &nbsp; &nbsp; averageValue: 30<br/> </code> |
 | distributor.&ZeroWidthSpace;autoscaling.&ZeroWidthSpace;maxReplicas | int | `30` |  |
 | distributor.&ZeroWidthSpace;autoscaling.&ZeroWidthSpace;minReplicas | int | `2` |  |
 | distributor.&ZeroWidthSpace;autoscaling.&ZeroWidthSpace;targetCPUUtilizationPercentage | int | `80` |  |
@@ -327,8 +327,8 @@ Kubernetes: `^1.19.0-0`
 | ingester.&ZeroWidthSpace;autoscaling.&ZeroWidthSpace;behavior.&ZeroWidthSpace;scaleDown.&ZeroWidthSpace;policies | list | `[{"periodSeconds":1800,"type":"Pods","value":1}]` | see https://cortexmetrics.io/docs/guides/ingesters-scaling-up-and-down/#scaling-down for scaledown details |
 | ingester.&ZeroWidthSpace;autoscaling.&ZeroWidthSpace;behavior.&ZeroWidthSpace;scaleDown.&ZeroWidthSpace;stabilizationWindowSeconds | int | `3600` | uses metrics from the past 1h to make scaleDown decisions |
 | ingester.&ZeroWidthSpace;autoscaling.&ZeroWidthSpace;behavior.&ZeroWidthSpace;scaleUp.&ZeroWidthSpace;policies | list | `[{"periodSeconds":1800,"type":"Pods","value":1}]` | This default scaleup policy allows adding 1 pod every 30 minutes. Ref: https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/#support-for-configurable-scaling-behavior |
-| ingester.&ZeroWidthSpace;autoscaling.&ZeroWidthSpace;customMetrics | list | `[]` | Optional custom and external metrics for the ingester pods to scale on In order to use this option , define a list of of specific following either: - https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale-walkthrough/#autoscaling-on-multiple-metrics-and-custom-metrics - https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale-walkthrough/#autoscaling-on-metrics-not-related-to-kubernetes-objects  For example:  - type: External   external:     metric:       name: queue_messages_ready       selector:         matchLabels:           queue: "worker_tasks"     target:       type: AverageValue       averageValue: 30 |
 | ingester.&ZeroWidthSpace;autoscaling.&ZeroWidthSpace;enabled | bool | `false` |  |
+| ingester.&ZeroWidthSpace;autoscaling.&ZeroWidthSpace;extraMetrics | list | `[]` | Optional custom and external metrics for the ingester pods to scale on In order to use this option , define a list of of specific following either: - https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale-walkthrough/#autoscaling-on-multiple-metrics-and-custom-metrics - https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale-walkthrough/#autoscaling-on-metrics-not-related-to-kubernetes-objects  For example: <br>  <code> - type: External <br> &nbsp; external: <br> &nbsp; &nbsp; metric:<br/> &nbsp; &nbsp; &nbsp; name: queue_messages_ready <br> &nbsp; &nbsp; &nbsp; selector:<br/> &nbsp; &nbsp; &nbsp; &nbsp; matchLabels:<br/> &nbsp; &nbsp; &nbsp; &nbsp; queue: "worker_tasks"<br/> &nbsp; &nbsp; target:<br/> &nbsp; &nbsp; &nbsp; type: AverageValue<br/> &nbsp; &nbsp; &nbsp; averageValue: 30<br/> </code> |
 | ingester.&ZeroWidthSpace;autoscaling.&ZeroWidthSpace;maxReplicas | int | `30` |  |
 | ingester.&ZeroWidthSpace;autoscaling.&ZeroWidthSpace;minReplicas | int | `3` |  |
 | ingester.&ZeroWidthSpace;autoscaling.&ZeroWidthSpace;targetMemoryUtilizationPercentage | int | `80` |  |
@@ -426,8 +426,8 @@ Kubernetes: `^1.19.0-0`
 | nginx.&ZeroWidthSpace;affinity | object | `{}` |  |
 | nginx.&ZeroWidthSpace;annotations | object | `{}` |  |
 | nginx.&ZeroWidthSpace;autoscaling.&ZeroWidthSpace;behavior | object | `{}` | Ref: https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/#support-for-configurable-scaling-behavior |
-| nginx.&ZeroWidthSpace;autoscaling.&ZeroWidthSpace;customMetrics | list | `[]` | Optional custom and external metrics for the nginx pods to scale on In order to use this option , define a list of of specific following either: - https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale-walkthrough/#autoscaling-on-multiple-metrics-and-custom-metrics - https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale-walkthrough/#autoscaling-on-metrics-not-related-to-kubernetes-objects  For example:  - type: External   external:     metric:       name: queue_messages_ready       selector:         matchLabels:           queue: "worker_tasks"     target:       type: AverageValue       averageValue: 30 |
 | nginx.&ZeroWidthSpace;autoscaling.&ZeroWidthSpace;enabled | bool | `false` | Creates a HorizontalPodAutoscaler for the nginx pods. |
+| nginx.&ZeroWidthSpace;autoscaling.&ZeroWidthSpace;extraMetrics | list | `[]` | Optional custom and external metrics for the nginx pods to scale on In order to use this option , define a list of of specific following either: - https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale-walkthrough/#autoscaling-on-multiple-metrics-and-custom-metrics - https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale-walkthrough/#autoscaling-on-metrics-not-related-to-kubernetes-objects  For example: <br>  <code> - type: External <br> &nbsp; external: <br> &nbsp; &nbsp; metric:<br/> &nbsp; &nbsp; &nbsp; name: queue_messages_ready <br> &nbsp; &nbsp; &nbsp; selector:<br/> &nbsp; &nbsp; &nbsp; &nbsp; matchLabels:<br/> &nbsp; &nbsp; &nbsp; &nbsp; queue: "worker_tasks"<br/> &nbsp; &nbsp; target:<br/> &nbsp; &nbsp; &nbsp; type: AverageValue<br/> &nbsp; &nbsp; &nbsp; averageValue: 30<br/> </code> |
 | nginx.&ZeroWidthSpace;autoscaling.&ZeroWidthSpace;maxReplicas | int | `30` |  |
 | nginx.&ZeroWidthSpace;autoscaling.&ZeroWidthSpace;minReplicas | int | `2` |  |
 | nginx.&ZeroWidthSpace;autoscaling.&ZeroWidthSpace;targetCPUUtilizationPercentage | int | `80` |  |
@@ -574,8 +574,8 @@ Kubernetes: `^1.19.0-0`
 | querier.&ZeroWidthSpace;affinity.&ZeroWidthSpace;podAntiAffinity.&ZeroWidthSpace;preferredDuringSchedulingIgnoredDuringExecution[0].&ZeroWidthSpace;weight | int | `100` |  |
 | querier.&ZeroWidthSpace;annotations | object | `{}` |  |
 | querier.&ZeroWidthSpace;autoscaling.&ZeroWidthSpace;behavior | object | `{}` | Ref: https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/#support-for-configurable-scaling-behavior |
-| querier.&ZeroWidthSpace;autoscaling.&ZeroWidthSpace;customMetrics | list | `[]` | Optional custom and external metrics for the querier pods to scale on In order to use this option , define a list of of specific following either: - https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale-walkthrough/#autoscaling-on-multiple-metrics-and-custom-metrics - https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale-walkthrough/#autoscaling-on-metrics-not-related-to-kubernetes-objects  For example:  - type: External   external:     metric:       name: queue_messages_ready       selector:         matchLabels:           queue: "worker_tasks"     target:       type: AverageValue       averageValue: 30 |
 | querier.&ZeroWidthSpace;autoscaling.&ZeroWidthSpace;enabled | bool | `false` | Creates a HorizontalPodAutoscaler for the querier pods. |
+| querier.&ZeroWidthSpace;autoscaling.&ZeroWidthSpace;extraMetrics | list | `[]` | Optional custom and external metrics for the querier pods to scale on In order to use this option , define a list of of specific following either: - https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale-walkthrough/#autoscaling-on-multiple-metrics-and-custom-metrics - https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale-walkthrough/#autoscaling-on-metrics-not-related-to-kubernetes-objects  For example: <br>  <code> - type: External <br> &nbsp; external: <br> &nbsp; &nbsp; metric:<br/> &nbsp; &nbsp; &nbsp; name: queue_messages_ready <br> &nbsp; &nbsp; &nbsp; selector:<br/> &nbsp; &nbsp; &nbsp; &nbsp; matchLabels:<br/> &nbsp; &nbsp; &nbsp; &nbsp; queue: "worker_tasks"<br/> &nbsp; &nbsp; target:<br/> &nbsp; &nbsp; &nbsp; type: AverageValue<br/> &nbsp; &nbsp; &nbsp; averageValue: 30<br/> </code> |
 | querier.&ZeroWidthSpace;autoscaling.&ZeroWidthSpace;maxReplicas | int | `30` |  |
 | querier.&ZeroWidthSpace;autoscaling.&ZeroWidthSpace;minReplicas | int | `2` |  |
 | querier.&ZeroWidthSpace;autoscaling.&ZeroWidthSpace;targetCPUUtilizationPercentage | int | `80` |  |
@@ -717,8 +717,8 @@ Kubernetes: `^1.19.0-0`
 | ruler.&ZeroWidthSpace;affinity | object | `{}` |  |
 | ruler.&ZeroWidthSpace;annotations | object | `{}` |  |
 | ruler.&ZeroWidthSpace;autoscaling.&ZeroWidthSpace;behavior | object | `{}` | Ref: https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/#support-for-configurable-scaling-behavior |
-| ruler.&ZeroWidthSpace;autoscaling.&ZeroWidthSpace;customMetrics | list | `[]` | Optional custom and external metrics for the ruler pods to scale on In order to use this option , define a list of of specific following either: - https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale-walkthrough/#autoscaling-on-multiple-metrics-and-custom-metrics - https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale-walkthrough/#autoscaling-on-metrics-not-related-to-kubernetes-objects  For example:  - type: External   external:     metric:       name: queue_messages_ready       selector:         matchLabels:           queue: "worker_tasks"     target:       type: AverageValue       averageValue: 30 |
 | ruler.&ZeroWidthSpace;autoscaling.&ZeroWidthSpace;enabled | bool | `false` | Creates a HorizontalPodAutoscaler for the ruler. |
+| ruler.&ZeroWidthSpace;autoscaling.&ZeroWidthSpace;extraMetrics | list | `[]` | Optional custom and external metrics for the ruler pods to scale on In order to use this option , define a list of of specific following either: - https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale-walkthrough/#autoscaling-on-multiple-metrics-and-custom-metrics - https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale-walkthrough/#autoscaling-on-metrics-not-related-to-kubernetes-objects  For example: <br>  <code> - type: External <br> &nbsp; external: <br> &nbsp; &nbsp; metric:<br/> &nbsp; &nbsp; &nbsp; name: queue_messages_ready <br> &nbsp; &nbsp; &nbsp; selector:<br/> &nbsp; &nbsp; &nbsp; &nbsp; matchLabels:<br/> &nbsp; &nbsp; &nbsp; &nbsp; queue: "worker_tasks"<br/> &nbsp; &nbsp; target:<br/> &nbsp; &nbsp; &nbsp; type: AverageValue<br/> &nbsp; &nbsp; &nbsp; averageValue: 30<br/> </code> |
 | ruler.&ZeroWidthSpace;autoscaling.&ZeroWidthSpace;maxReplicas | int | `30` |  |
 | ruler.&ZeroWidthSpace;autoscaling.&ZeroWidthSpace;minReplicas | int | `2` |  |
 | ruler.&ZeroWidthSpace;autoscaling.&ZeroWidthSpace;targetCPUUtilizationPercentage | int | `80` |  |
@@ -796,8 +796,8 @@ Kubernetes: `^1.19.0-0`
 | store_gateway.&ZeroWidthSpace;affinity.&ZeroWidthSpace;podAntiAffinity.&ZeroWidthSpace;preferredDuringSchedulingIgnoredDuringExecution[0].&ZeroWidthSpace;weight | int | `100` |  |
 | store_gateway.&ZeroWidthSpace;annotations | object | `{}` |  |
 | store_gateway.&ZeroWidthSpace;autoscaling.&ZeroWidthSpace;behavior | object | `{}` | Ref: https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/#support-for-configurable-scaling-behavior |
-| store_gateway.&ZeroWidthSpace;autoscaling.&ZeroWidthSpace;customMetrics | list | `[]` | Optional custom and external metrics for the store gateway pods to scale on In order to use this option , define a list of of specific following either: - https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale-walkthrough/#autoscaling-on-multiple-metrics-and-custom-metrics - https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale-walkthrough/#autoscaling-on-metrics-not-related-to-kubernetes-objects  For example:  - type: External   external:     metric:       name: queue_messages_ready       selector:         matchLabels:           queue: "worker_tasks"     target:       type: AverageValue       averageValue: 30 |
 | store_gateway.&ZeroWidthSpace;autoscaling.&ZeroWidthSpace;enabled | bool | `false` |  |
+| store_gateway.&ZeroWidthSpace;autoscaling.&ZeroWidthSpace;extraMetrics | list | `[]` | Optional custom and external metrics for the store gateway pods to scale on In order to use this option , define a list of of specific following either: - https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale-walkthrough/#autoscaling-on-multiple-metrics-and-custom-metrics - https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale-walkthrough/#autoscaling-on-metrics-not-related-to-kubernetes-objects  For example: <br>  <code> - type: External <br> &nbsp; external: <br> &nbsp; &nbsp; metric:<br/> &nbsp; &nbsp; &nbsp; name: queue_messages_ready <br> &nbsp; &nbsp; &nbsp; selector:<br/> &nbsp; &nbsp; &nbsp; &nbsp; matchLabels:<br/> &nbsp; &nbsp; &nbsp; &nbsp; queue: "worker_tasks"<br/> &nbsp; &nbsp; target:<br/> &nbsp; &nbsp; &nbsp; type: AverageValue<br/> &nbsp; &nbsp; &nbsp; averageValue: 30<br/> </code> |
 | store_gateway.&ZeroWidthSpace;autoscaling.&ZeroWidthSpace;maxReplicas | int | `30` |  |
 | store_gateway.&ZeroWidthSpace;autoscaling.&ZeroWidthSpace;minReplicas | int | `3` |  |
 | store_gateway.&ZeroWidthSpace;autoscaling.&ZeroWidthSpace;targetMemoryUtilizationPercentage | int | `80` |  |

templates/distributor/distributor-hpa.yaml

@@ -31,7 +31,7 @@ spec:
           type: Utilization
           averageUtilization: {{ . }}
   {{- end }}
-  {{- with .customMetrics }}
+  {{- with .extraMetrics }}
     {{- toYaml . | nindent 4 }}
   {{- end }}
   {{- with .behavior }}

templates/ingester/ingester-hpa.yaml

@@ -21,7 +21,7 @@ spec:
         target:
           type: Utilization
           averageUtilization: {{ .targetMemoryUtilizationPercentage }}
-  {{- with .customMetrics }}
+  {{- with .extraMetrics }}
     {{- toYaml . | nindent 4 }}
   {{- end }}
   {{- with .behavior }}

templates/nginx/nginx-hpa.yaml

@@ -31,7 +31,7 @@ spec:
           type: Utilization
           averageUtilization: {{ . }}
   {{- end }}
-  {{- with .customMetrics }}
+  {{- with .extraMetrics }}
     {{- toYaml . | nindent 4 }}
   {{- end }}
   {{- with .behavior }}

templates/querier/querier-hpa.yaml

@@ -31,7 +31,7 @@ spec:
           type: Utilization
           averageUtilization: {{ . }}
   {{- end }}
-  {{- with .customMetrics }}
+  {{- with .extraMetrics }}
     {{- toYaml . | nindent 4 }}
   {{- end }}
   {{- with .behavior }}

templates/ruler/ruler-hpa.yaml

@@ -31,7 +31,7 @@ spec:
           type: Utilization
           averageUtilization: {{ . }}
   {{- end }}
-  {{- with .customMetrics }}
+  {{- with .extraMetrics }}
     {{- toYaml . | nindent 4 }}
   {{- end }}
   {{- with .behavior }}

templates/store-gateway/store-gateway-hpa.yaml

@@ -21,7 +21,7 @@ spec:
         target:
           type: Utilization
           averageUtilization: {{ .targetMemoryUtilizationPercentage }}
-  {{- with .customMetrics }}
+  {{- with .extraMetrics }}
     {{- toYaml . | nindent 4 }}
   {{- end }}
   {{- with .behavior }}