Skip to content

Add labels from annotations #39

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

Merged
mmcgarr merged 5 commits into from
Nov 14, 2025
Merged

Add labels from annotations #39

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4f17693
add priority labeling
w0ng952 Oct 17, 2025
5a41bb3
tidy up
w0ng952 Oct 17, 2025
6df0ca0
add to deployments
w0ng952 Oct 17, 2025
848c379
make labels generic
w0ng952 Nov 6, 2025
45834c5
fix mistake
w0ng952 Nov 14, 2025
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
3 changes: 3 additions & 0 deletions kube/config/templates/5xx-rate.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,3 +45,6 @@ spec:
{{if .Sensitivity}}
sensitivity: {{.Sensitivity}}
{{end}}
{{range $key, $value := .CustomLabels}}
{{$key}}: {{$value}}
{{end}}
3 changes: 3 additions & 0 deletions kube/config/templates/replicas-availability-deployment.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,6 @@ spec:
{{if .Sensitivity}}
sensitivity: {{.Sensitivity}}
{{end}}
{{range $key, $value := .CustomLabels}}
{{$key}}: {{$value}}
{{end}}
7 changes: 7 additions & 0 deletions pkg/templates/deployment.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ type templateParameterDeployment struct {
Criticality string
Sensitivity string
Deployment *apps.Deployment
CustomLabels map[string]string
}

// CreateFromDeployment
Expand Down Expand Up @@ -68,12 +69,18 @@ func (a *PrometheusRuleTemplateManager) CreateFromDeployment(deployment *apps.De

prometheusRules := map[string]*monitoringv1.PrometheusRule{}
annotations := params.Deployment.GetAnnotations()
params.CustomLabels = extractCustomLabels(annotations)

for k, v := range annotations {
if !strings.HasPrefix(k, heimPrefix) {
continue
}

// Skip label-* annotations as they are not templates
if strings.HasPrefix(k, labelPrefix) {
continue
}

templateName := strings.TrimLeft(k, fmt.Sprintf("%s/", heimPrefix))
logger.Infow("template selected", "template", templateName)
template, ok := a.templates[templateName]
Expand Down
45 changes: 45 additions & 0 deletions pkg/templates/deployment_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,32 @@ var (
environmentAnnotation: "testing",
criticalityAnnotation: "low",
sensitivityAnnotation: "public",
priorityAnnotation: "p1",
"com.uswitch.heimdall/replicas-availability-deployment": "1",
},
OwnerReferences: []metav1.OwnerReference{},
},
Spec: appsv1.DeploymentSpec{
Replicas: new(int32),
Selector: &metav1.LabelSelector{},
},
}

testDeploymentMultiLabel = &appsv1.Deployment{
ObjectMeta: metav1.ObjectMeta{
Name: "testAppMulti",
Namespace: "testNamespace",
Labels: map[string]string{
"app": "testAppMulti",
},
Annotations: map[string]string{
ownerAnnotation: "testDeploymentOwner",
environmentAnnotation: "testing",
criticalityAnnotation: "low",
sensitivityAnnotation: "public",
"com.uswitch.heimdall/label-priority": "p3",
"com.uswitch.heimdall/label-channel": "testing",
"com.uswitch.heimdall/label-team": "platform",
"com.uswitch.heimdall/replicas-availability-deployment": "1",
},
OwnerReferences: []metav1.OwnerReference{},
Expand Down Expand Up @@ -51,4 +77,23 @@ kube_deployment_spec_replicas{namespace="testNamespace", deployment="testApp"} <
assert.Assert(t, is.Len(promrules, 1))
assert.Equal(t, promrules[0].Spec.Groups[0].Rules[0].Expr.StrVal, expr)
assert.Equal(t, promrules[0].Spec.Groups[0].Rules[0].Labels["owner"], "testDeploymentOwner")
assert.Equal(t, promrules[0].Spec.Groups[0].Rules[0].Labels["environment"], "testing")
assert.Equal(t, promrules[0].Spec.Groups[0].Rules[0].Labels["criticality"], "low")
assert.Equal(t, promrules[0].Spec.Groups[0].Rules[0].Labels["sensitivity"], "public")
assert.Equal(t, promrules[0].Spec.Groups[0].Rules[0].Labels["priority"], "p1")
}

func TestDeploymentMultipleCustomLabels(t *testing.T) {
log.Setup(log.DEBUG_LEVEL)

client := fake.NewSimpleClientset()

template, err := NewPrometheusRuleTemplateManager("../../kube/config/templates", client)

promrules, err := template.CreateFromDeployment(testDeploymentMultiLabel, "testNamespace")
assert.Assert(t, is.Nil(err))
assert.Assert(t, is.Len(promrules, 1))
assert.Equal(t, promrules[0].Spec.Groups[0].Rules[0].Labels["priority"], "p3")
assert.Equal(t, promrules[0].Spec.Groups[0].Rules[0].Labels["channel"], "testing")
assert.Equal(t, promrules[0].Spec.Groups[0].Rules[0].Labels["team"], "platform")
}
7 changes: 7 additions & 0 deletions pkg/templates/ingress.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ type templateParameterIngress struct {
Criticality string
Sensitivity string
BackendService string
CustomLabels map[string]string
}

// CreateFromIngress
Expand All @@ -50,12 +51,18 @@ func (a *PrometheusRuleTemplateManager) CreateFromIngress(ingress *networkingv1.

prometheusRules := map[string]*monitoringv1.PrometheusRule{}
annotations := ingress.GetAnnotations()
params.CustomLabels = extractCustomLabels(annotations)

for k, v := range annotations {
if !strings.HasPrefix(k, heimPrefix) {
continue
}

// Skip label-* annotations as they are not templates
if strings.HasPrefix(k, labelPrefix) {
continue
}

templateName := strings.TrimLeft(k, fmt.Sprintf("%s/", heimPrefix))
template, ok := a.templates[templateName]
if !ok {
Expand Down
48 changes: 48 additions & 0 deletions pkg/templates/ingress_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ var (
environmentAnnotation: "testing",
criticalityAnnotation: "low",
sensitivityAnnotation: "public",
priorityAnnotation: "p1",
},
},
Spec: networkingv1.IngressSpec{
Expand Down Expand Up @@ -119,6 +120,33 @@ var (
},
},
}

testIngressMultiLabel = &networkingv1.Ingress{
ObjectMeta: metav1.ObjectMeta{
Name: "testMultiLabel",
Namespace: "testNamespace",
Annotations: map[string]string{
"com.uswitch.heimdall/5xx-rate": "0.001",
ownerAnnotation: "testIngressOwner",
environmentAnnotation: "testing",
criticalityAnnotation: "low",
sensitivityAnnotation: "public",
"com.uswitch.heimdall/label-priority": "p2",
"com.uswitch.heimdall/label-channel": "testing",
"com.uswitch.heimdall/label-region": "eu-west-1",
},
},
Spec: networkingv1.IngressSpec{
DefaultBackend: &networkingv1.IngressBackend{
Service: &networkingv1.IngressServiceBackend{
Name: "testService",
Port: networkingv1.ServiceBackendPort{
Number: 80,
},
},
},
},
}
)

func TestIngressAnnotationsDefaultBackend(t *testing.T) {
Expand Down Expand Up @@ -147,6 +175,10 @@ func TestIngressAnnotationsDefaultBackend(t *testing.T) {
assert.Assert(t, is.Len(promrules, 1))
assert.Equal(t, promrules[0].Spec.Groups[0].Rules[0].Expr.StrVal, expr)
assert.Equal(t, promrules[0].Spec.Groups[0].Rules[0].Labels["owner"], "testIngressOwner")
assert.Equal(t, promrules[0].Spec.Groups[0].Rules[0].Labels["environment"], "testing")
assert.Equal(t, promrules[0].Spec.Groups[0].Rules[0].Labels["criticality"], "low")
assert.Equal(t, promrules[0].Spec.Groups[0].Rules[0].Labels["sensitivity"], "public")
assert.Equal(t, promrules[0].Spec.Groups[0].Rules[0].Labels["priority"], "p1")
}

func TestIngressAnnotationsRuleBackend(t *testing.T) {
Expand Down Expand Up @@ -186,3 +218,19 @@ func TestNamesMatch(t *testing.T) {
service = checkNamesMatch(services)
assert.Equal(t, "", service)
}

func TestIngressMultipleCustomLabels(t *testing.T) {
log.Setup(log.DEBUG_LEVEL)

client := fake.NewSimpleClientset(testService, testDeployment, testReplicaset, testPod)

template, err := NewPrometheusRuleTemplateManager("../../kube/config/templates", client)

promrules, err := template.CreateFromIngress(testIngressMultiLabel)
assert.Assert(t, is.Nil(err))
assert.Assert(t, is.Len(promrules, 1))
assert.Equal(t, promrules[0].Spec.Groups[0].Rules[0].Labels["priority"], "p2")
assert.Equal(t, promrules[0].Spec.Groups[0].Rules[0].Labels["channel"], "testing")
assert.Equal(t, promrules[0].Spec.Groups[0].Rules[0].Labels["region"], "eu-west-1")
}

20 changes: 19 additions & 1 deletion pkg/templates/promrules.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,17 @@ import (
corev1 "k8s.io/client-go/kubernetes/typed/core/v1"
)

var heimPrefix = "com.uswitch.heimdall"
var (
heimPrefix = "com.uswitch.heimdall"
labelPrefix = "com.uswitch.heimdall/label-"
)

const (
ownerAnnotation = "service.rvu.co.uk/owner"
environmentAnnotation = "service.rvu.co.uk/environment"
criticalityAnnotation = "service.rvu.co.uk/criticality"
sensitivityAnnotation = "service.rvu.co.uk/sensitivity"
priorityAnnotation = "com.uswitch.heimdall/label-priority"
)

// ClientSetI
Expand Down Expand Up @@ -79,3 +83,17 @@ func collectPrometheusRules(prometheusRules map[string]*monitoringv1.PrometheusR

return ret
}

// com.uswitch.heimdall/label-priority: p3 -> map["priority"] = "p3"
func extractCustomLabels(annotations map[string]string) map[string]string {
customLabels := make(map[string]string)

for k, v := range annotations {
if strings.HasPrefix(k, labelPrefix) {
labelName := strings.TrimPrefix(k, labelPrefix)
customLabels[labelName] = v
}
}

return customLabels
}