Skip to content

feat: consistent labeling of all resources #5

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
merged 1 commit into from
May 29, 2025
Merged

feat: consistent labeling of all resources #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
45 changes: 27 additions & 18 deletions pkg/builder/builder.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,12 @@ func NewBuilder(ctx *pulumi.Context, args BuilderComponentArgs, opts ...pulumi.R
}

// Create service account
sa, err := corev1.NewServiceAccount(ctx, fmt.Sprintf("%s-sa", args.Name), &corev1.ServiceAccountArgs{
serviceAccountName := fmt.Sprintf("%s-sa", args.Name)
sa, err := corev1.NewServiceAccount(ctx, serviceAccountName, &corev1.ServiceAccountArgs{
Metadata: &metav1.ObjectMetaArgs{
Name: pulumi.String(fmt.Sprintf("%s-sa", args.Name)),
Name: pulumi.String(serviceAccountName),
Namespace: pulumi.String(args.Namespace),
Labels: utils.CreateResourceLabels(args.Name, serviceAccountName, args.Name, nil),
},
}, pulumi.Parent(component))
if err != nil {
Expand All @@ -52,39 +54,42 @@ func NewBuilder(ctx *pulumi.Context, args BuilderComponentArgs, opts ...pulumi.R
component.ServiceAccount = sa

// Create ConfigMap for environment variables
configMapName := fmt.Sprintf("%s-env", args.Name)
configMap, err := utils.CreateConfigMap(
ctx,
fmt.Sprintf("%s-configmap", args.Name),
configMapName,
pulumi.String(args.Namespace),
pulumi.StringMap{
"app": pulumi.String(args.Name),
"app.kubernetes.io/name": pulumi.String(args.Name),
"app.kubernetes.io/part-of": pulumi.String(args.Name),
},
utils.CreateResourceLabels(args.Name, configMapName, args.Name, nil),
args.BuilderEnv,
)
if err != nil {
return nil, fmt.Errorf("failed to create environment ConfigMap: %w", err)
}
component.ConfigMap = configMap

// Create pod labels with app label for routing
podLabels := utils.CreateResourceLabels(args.Name, args.Name, args.Name, args.AppLabels.Labels)
podLabels["app"] = pulumi.String(args.Name)

// Create deployment
deployment, err := appsv1.NewDeployment(ctx, fmt.Sprintf("%s-deployment", args.Name), &appsv1.DeploymentArgs{
deploymentName := fmt.Sprintf("%s-deployment", args.Name)
deployment, err := appsv1.NewDeployment(ctx, deploymentName, &appsv1.DeploymentArgs{
Metadata: &metav1.ObjectMetaArgs{
Name: pulumi.String(fmt.Sprintf("%s-deployment", args.Name)),
Name: pulumi.String(deploymentName),
Namespace: pulumi.String(args.Namespace),
Labels: utils.CreateResourceLabels(args.Name, deploymentName, args.Name, nil),
},
Spec: &appsv1.DeploymentSpecArgs{
Replicas: pulumi.Int(DefaultReplicas),
Selector: &metav1.LabelSelectorArgs{
MatchLabels: args.AppLabels.Labels,
MatchLabels: podLabels,
},
Template: &corev1.PodTemplateSpecArgs{
Metadata: &metav1.ObjectMetaArgs{
Labels: args.AppLabels.Labels,
Labels: podLabels,
},
Spec: &corev1.PodSpecArgs{
ServiceAccountName: pulumi.String(fmt.Sprintf("%s-sa", args.Name)),
ServiceAccountName: pulumi.String(serviceAccountName),
Containers: corev1.ContainerArray{
&corev1.ContainerArgs{
Name: pulumi.String(args.Name),
Expand Down Expand Up @@ -144,18 +149,20 @@ func NewBuilder(ctx *pulumi.Context, args BuilderComponentArgs, opts ...pulumi.R
component.Deployment = deployment

// Create service
service, err := corev1.NewService(ctx, fmt.Sprintf("%s-service", args.Name), &corev1.ServiceArgs{
serviceName := fmt.Sprintf("%s-service", args.Name)
service, err := corev1.NewService(ctx, serviceName, &corev1.ServiceArgs{
Metadata: &metav1.ObjectMetaArgs{
Name: pulumi.String(fmt.Sprintf("%s-service", args.Name)),
Name: pulumi.String(serviceName),
Namespace: pulumi.String(args.Namespace),
Labels: utils.CreateResourceLabels(args.Name, serviceName, args.Name, nil),
Annotations: pulumi.StringMap{
"prometheus.io/scrape": pulumi.String("true"),
"prometheus.io/port": pulumi.Sprintf("%d", MetricsPort),
"prometheus.io/path": pulumi.String("/metrics"),
},
},
Spec: &corev1.ServiceSpecArgs{
Selector: args.AppLabels.Labels,
Selector: podLabels,
Ports: corev1.ServicePortArray{
&corev1.ServicePortArgs{
Port: parseBuilderPort(args.BuilderEnv.BuilderPort),
Expand All @@ -176,17 +183,19 @@ func NewBuilder(ctx *pulumi.Context, args BuilderComponentArgs, opts ...pulumi.R
component.Service = service

// Create pod monitor
podMonitorName := fmt.Sprintf("%s-pod-monitor", args.Name)
_, err = crd.NewCustomResource(ctx, fmt.Sprintf("%s-svcmon", args.Name), &crd.CustomResourceArgs{
ApiVersion: pulumi.String("monitoring.coreos.com/v1"),
Kind: pulumi.String("PodMonitor"),
Metadata: &metav1.ObjectMetaArgs{
Name: pulumi.String(fmt.Sprintf("%s-pod-monitor", args.Name)),
Name: pulumi.String(podMonitorName),
Namespace: pulumi.String(args.Namespace),
Labels: utils.CreateResourceLabels(args.Name, podMonitorName, args.Name, nil),
},
OtherFields: map[string]interface{}{
"spec": map[string]interface{}{
"selector": map[string]interface{}{
"matchLabels": args.AppLabels.Labels,
"matchLabels": podLabels,
},
"namespaceSelector": map[string]interface{}{
"any": true,
Expand Down
12 changes: 12 additions & 0 deletions pkg/builder/helpers.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,13 @@
package builder

import (
"github.com/init4tech/signet-infra-components/pkg/utils"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

// NewAppLabels creates a new AppLabels instance with consistent Kubernetes labels
func NewAppLabels(app, name, partOf string, additionalLabels pulumi.StringMap) AppLabels {
return AppLabels{
Labels: utils.CreateResourceLabels(app, name, partOf, additionalLabels),
}
}
9 changes: 0 additions & 9 deletions pkg/signet_node/helpers.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,15 +52,6 @@ func CreatePersistentVolumeClaim(
return pvc, nil
}

// CreateResourceLabels creates a consistent set of Kubernetes labels for resources
func CreateResourceLabels(name string) pulumi.StringMap {
return pulumi.StringMap{
"app": pulumi.String(name),
"app.kubernetes.io/name": pulumi.String(name),
"app.kubernetes.io/part-of": pulumi.String(name),
}
}

// ResourceRequirements returns consistent resource requirements for pods
func NewResourceRequirements(cpuLimit, memoryLimit, cpuRequest, memoryRequest string) *corev1.ResourceRequirementsArgs {
if cpuLimit == "" {
Expand Down
9 changes: 1 addition & 8 deletions pkg/signet_node/helpers_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,7 @@ import (
"github.com/stretchr/testify/assert"
)

func TestCreateResourceLabels(t *testing.T) {
name := "test-resource"
labels := CreateResourceLabels(name)

assert.Equal(t, pulumi.String(name), labels["app"])
assert.Equal(t, pulumi.String(name), labels["app.kubernetes.io/name"])
assert.Equal(t, pulumi.String(name), labels["app.kubernetes.io/part-of"])
}
// TestCreateResourceLabels moved to pkg/utils/labels_test.go since the function was moved there

func TestResourceRequirements(t *testing.T) {
// Test with default values
Expand Down
Loading
Loading