Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

RevisionName templating and substitution. #84

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
+107 −0
Draft

RevisionName templating and substitution. #84

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6f54184
add revision name substitution, add sprig dependency
muscionig Nov 20, 2024
545ac35
Remove sprig function and dependency update
muscionig Nov 25, 2024
10ae1a5
Add test case for revisionName substitution
muscionig Nov 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions pkg/reconciler/autoscaling/hpa/resources/keda.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,13 @@ limitations under the License.
package resources

import (
"bytes"
"context"
"encoding/json"
"fmt"
"log"
"math"
"text/template"

autoscalingv2 "k8s.io/api/autoscaling/v2"
"k8s.io/apimachinery/pkg/api/resource"
Expand Down Expand Up @@ -128,6 +130,20 @@ func DesiredScaledObject(ctx context.Context, pa *autoscalingv1alpha1.PodAutosca
return nil, fmt.Errorf("query is missing for custom metric: %w", err)
}

tmpl, err := template.New("query").Parse(query)
if err != nil {
return nil, fmt.Errorf("template initialization failed: %w", err)
}
values := map[string]string{
"revisionName": pa.Name,
Copy link
Contributor

@skonto skonto Nov 22, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As a side note Serving supports byo revision names instead of being auto-generated.

kind: Service
metadata:
  name: hello
spec:
  template:
    metadata:
      name: hello-1

If you want to change that service above, then you need to manually change hello-1 to something else. PA name is always the same as with revision name.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! I think it would be helpful to include this, along with the other points we've discussed, in a "Usage Recommendations" document. Should we log an issue to capture these notes? That way, we can reference it and update it with new considerations as they come up.

}
var output bytes.Buffer
if err := tmpl.Execute(&output, values); err != nil {
return nil, fmt.Errorf("template execution failed: %w", err)
}
log.Printf("PrometheusQuery rendered: %s\n", output.String())
query = output.String()

if v, ok := pa.Annotations[KedaAutoscaleAnnotationPrometheusAddress]; ok {
if err := helpers.ParseServerAddress(v); err != nil {
return nil, fmt.Errorf("invalid prometheus address: %w", err)
Expand Down
24 changes: 24 additions & 0 deletions pkg/reconciler/autoscaling/hpa/resources/keda_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ func TestDesiredScaledObject(t *testing.T) {
AutoscalerKeda: autoscalerKedaConfig})
extraTrigger := fmt.Sprintf("[{\"name\": \"trigger2\", \"type\": \"prometheus\", \"metadata\": { \"serverAddress\": \"%s\" , \"namespace\": \"%s\", \"query\": \"sum(rate(http_requests_total{}[1m]))\", \"threshold\": \"5\"}}]", hpaconfig.DefaultPrometheusAddress, helpers.TestNamespace)
scalingModifiers := `{"formula": "(trigger1 + trigger2)/2", "target": "5", "activationTarget": "1", "metricType": "AverageValue"}`
queryRevisionName := fmt.Sprintf("sum(rate(http_requests_total{pod=~\"%s.*\"}[1m]))", helpers.TestRevision)

scaledObjectTests := []struct {
name string
Expand Down Expand Up @@ -313,6 +314,29 @@ func TestDesiredScaledObject(t *testing.T) {
"authModes": "bearer",
}, "keda-trigger-auth-prometheus", "TriggerAuthentication"),
WithHorizontalPodAutoscalerConfig(helpers.TestRevision)),
}, {
name: "custom metric with revision name substitution",
paAnnotations: map[string]string{
autoscaling.MinScaleAnnotationKey: "1",
autoscaling.MaxScaleAnnotationKey: "10",
autoscaling.MetricAnnotationKey: "http_requests_total",
KedaAutoscaleAnnotationPrometheusQuery: "sum(rate(http_requests_total{pod=~\"{{ .revisionName }}.*\"}[1m]))",
autoscaling.TargetAnnotationKey: "5",
},
wantScaledObject: ScaledObject(helpers.TestNamespace,
helpers.TestRevision, WithAnnotations(map[string]string{
autoscaling.MinScaleAnnotationKey: "1",
autoscaling.MaxScaleAnnotationKey: "10",
autoscaling.MetricAnnotationKey: "http_requests_total",
KedaAutoscaleAnnotationPrometheusQuery: "sum(rate(http_requests_total{pod=~\"{{ .revisionName }}.*\"}[1m]))",
autoscaling.TargetAnnotationKey: "5",
autoscaling.ClassAnnotationKey: autoscaling.HPA,
}), WithMaxScale(10), WithMinScale(1), WithTrigger("default-trigger-custom", "prometheus", autoscalingv2.AverageValueMetricType, map[string]string{
"namespace": helpers.TestNamespace,
"query": queryRevisionName,
"threshold": "5",
"serverAddress": "http://prometheus-operated.default.svc:9090",
}), WithScaleTargetRef(helpers.TestRevision+"-deployment"), WithHorizontalPodAutoscalerConfig(helpers.TestRevision)),
}}

for _, tt := range scaledObjectTests {
Expand Down
67 changes: 67 additions & 0 deletions test/test_images/metrics-test/service_revision_name_template.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
# Copyright 2024 The Knative Authors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
---
apiVersion: serving.knative.dev/v1
kind: Service
metadata:
name: metrics-test
spec:
template:
metadata:
labels:
app: metrics-test
annotations:
autoscaling.knative.dev/minScale: "1"
autoscaling.knative.dev/maxScale: "10"
autoscaling.knative.dev/target: "5"
autoscaling.knative.dev/class: "hpa.autoscaling.knative.dev"
autoscaling.knative.dev/metric: "http_requests_total"
autoscaling.knative.dev/prometheus-query: "sum(rate(http_requests_total{pod=~\"{{ .revisionName }}.*\"}[1m]))"
spec:
containers:
- image: ko://knative.dev/autoscaler-keda/test/test_images/metrics-test/
imagePullPolicy: Always
ports:
- name: http1
containerPort: 8080
---
apiVersion: monitoring.coreos.com/v1
kind: ServiceMonitor
metadata:
labels:
name: metrics-test-sm
spec:
endpoints:
- port: metrics
scheme: http
namespaceSelector: {}
selector:
matchLabels:
name: metrics-test-sm
---
apiVersion: v1
kind: Service
metadata:
labels:
name: metrics-test-sm
name: metrics-test-sm
spec:
ports:
- name: metrics
port: 9096
protocol: TCP
targetPort: 9096
selector:
serving.knative.dev/service: metrics-test
type: ClusterIP