feat: upgrade the appconfiguration generator framework (#573)

Author: Wenfeng-GAO

pkg/cmd/spec/generator_test.go

@@ -94,6 +94,28 @@ resources:
 			},
 		},
 	}
+
+	specModel3 = &models.Spec{
+		Resources: []models.Resource{
+			{
+				ID:   "v1:Namespace:default",
+				Type: "Kubernetes",
+				Attributes: map[string]interface{}{
+					"apiVersion": "v1",
+					"kind":       "Namespace",
+					"spec":       make(map[string]interface{}),
+					"status":     make(map[string]interface{}),
+					"metadata": map[string]interface{}{
+						"name":              "default",
+						"creationTimestamp": nil,
+					},
+				},
+				Extensions: map[string]interface{}{
+					"GVK": "/v1, Kind=Namespace",
+				},
+			},
+		},
+	}
 )
 
 func TestGenerateSpecFromFile(t *testing.T) {
@@ -212,7 +234,7 @@ func TestGenerateSpec(t *testing.T) {
 					Documents: []kclgo.KCLResult{apcMap},
 				}, nil),
 			},
-			want: specModel1,
+			want: specModel3,
 		},
 	}
 

pkg/engine/runtime/terraform/tfops/test_data/plan.out

@@ -150,6 +150,9 @@ func TestGenerate(t *testing.T) {
 						"username":    database.Username,
 					},
 				},
+				Extensions: map[string]interface{}{
+					"GVK": "/v1, Kind=Secret",
+				},
 			},
 		},
 	}

pkg/generator/appconfiguration/generator/accessories/database/database_generator_test.go

@@ -6,8 +6,11 @@ import (
 	"kusionstack.io/kusion/pkg/generator"
 	"kusionstack.io/kusion/pkg/generator/appconfiguration"
 	accessories "kusionstack.io/kusion/pkg/generator/appconfiguration/generator/accessories/database"
+	"kusionstack.io/kusion/pkg/generator/appconfiguration/generator/monitoring"
 	"kusionstack.io/kusion/pkg/generator/appconfiguration/generator/trait"
 	"kusionstack.io/kusion/pkg/generator/appconfiguration/generator/workload"
+	patmonitoring "kusionstack.io/kusion/pkg/generator/appconfiguration/patcher/monitoring"
+	pattrait "kusionstack.io/kusion/pkg/generator/appconfiguration/patcher/trait"
 	"kusionstack.io/kusion/pkg/models"
 	appmodel "kusionstack.io/kusion/pkg/models/appconfiguration"
 	"kusionstack.io/kusion/pkg/projectstack"
@@ -90,19 +93,28 @@ func (g *appConfigurationGenerator) Generate(spec *models.Spec) error {
 		spec.Resources = make(models.Resources, 0)
 	}
 
+	// Generate resources
 	gfs := []appconfiguration.NewGeneratorFunc{
 		NewNamespaceGeneratorFunc(g.project.Name),
 		accessories.NewDatabaseGeneratorFunc(g.project, g.stack, g.appName, g.app.Workload, g.app.Database),
-		workload.NewWorkloadGeneratorFunc(g.project, g.stack, g.appName, g.app.Workload, g.app.Monitoring, g.app.OpsRule),
+		workload.NewWorkloadGeneratorFunc(g.project, g.stack, g.appName, g.app.Workload),
 		trait.NewOpsRuleGeneratorFunc(g.project, g.stack, g.appName, g.app),
-		NewMonitoringGeneratorFunc(g.project, g.app.Monitoring, g.appName),
+		monitoring.NewMonitoringGeneratorFunc(g.project, g.app.Monitoring, g.appName),
 		// The OrderedResourcesGenerator should be executed after all resources are generated.
 		NewOrderedResourcesGeneratorFunc(),
 	}
-
 	if err := appconfiguration.CallGenerators(spec, gfs...); err != nil {
 		return err
 	}
 
+	// Patcher logic patches generated resources
+	pfs := []appconfiguration.NewPatcherFunc{
+		pattrait.NewOpsRulePatcherFunc(g.app),
+		patmonitoring.NewMonitoringPatcherFunc(g.appName, g.app, g.project),
+	}
+	if err := appconfiguration.CallPatchers(spec.Resources.GVKIndex(), pfs...); err != nil {
+		return err
+	}
+
 	return nil
 }

pkg/generator/appconfiguration/generator/app_configurations_generator.go

@@ -1,4 +1,4 @@
-package generator
+package monitoring
 
 import (
 	"fmt"

…ration/generator/monitoring_generator.go …rator/monitoring/monitoring_generator.gopkg/generator/appconfiguration/generator/monitoring_generator.go renamed to pkg/generator/appconfiguration/generator/monitoring/monitoring_generator.go pkg/generator/appconfiguration/generator/monitoring_generator.go renamed to pkg/generator/appconfiguration/generator/monitoring/monitoring_generator.go

@@ -1,4 +1,4 @@
-package generator
+package monitoring
 
 import (
 	"fmt"
@@ -82,8 +82,10 @@ func BuildMonitoringTestCase(
 						},
 					},
 				},
-				DependsOn:  nil,
-				Extensions: nil,
+				DependsOn: nil,
+				Extensions: map[string]interface{}{
+					"GVK": fmt.Sprintf("monitoring.coreos.com/v1, Kind=%s", string(monitorKind)),
+				},
 			},
 		}
 	}

…n/generator/monitoring_generator_test.go …/monitoring/monitoring_generator_test.gopkg/generator/appconfiguration/generator/monitoring_generator_test.go renamed to pkg/generator/appconfiguration/generator/monitoring/monitoring_generator_test.go pkg/generator/appconfiguration/generator/monitoring_generator_test.go renamed to pkg/generator/appconfiguration/generator/monitoring/monitoring_generator_test.go

@@ -45,8 +45,10 @@ func Test_namespaceGenerator_Generate(t *testing.T) {
 							"spec":   make(map[string]interface{}),
 							"status": make(map[string]interface{}),
 						},
-						DependsOn:  nil,
-						Extensions: nil,
+						DependsOn: nil,
+						Extensions: map[string]interface{}{
+							"GVK": "/v1, Kind=Namespace",
+						},
 					},
 				},
 			},

pkg/generator/appconfiguration/generator/namespace_generator_test.go

@@ -111,7 +111,11 @@ func Test_opsRuleGenerator_Generate(t *testing.T) {
 									},
 								},
 							}, "status": map[string]interface{}{},
-						}, DependsOn: []string(nil), Extensions: map[string]interface{}(nil),
+						},
+						DependsOn: []string(nil),
+						Extensions: map[string]interface{}{
+							"GVK": "apps.kusionstack.io/v1alpha1, Kind=RuleSet",
+						},
 					},
 				},
 			},

pkg/generator/appconfiguration/generator/trait/ops_rule_generator_test.go

@@ -58,8 +58,10 @@ func BuildSecretTestCase(
 				"immutable": immutable,
 				"type":      string(secretType),
 			},
-			DependsOn:  nil,
-			Extensions: nil,
+			DependsOn: nil,
+			Extensions: map[string]interface{}{
+				"GVK": "/v1, Kind=Secret",
+			},
 		},
 	}
 	testCase := &TestCase{

pkg/generator/appconfiguration/generator/workload/secret_generator_test.go

@@ -8,25 +8,19 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"kusionstack.io/kube-api/apps/v1alpha1"
 
-	"k8s.io/apimachinery/pkg/util/intstr"
-
 	"kusionstack.io/kusion/pkg/generator/appconfiguration"
 	"kusionstack.io/kusion/pkg/generator/appconfiguration/generator/workload/network"
 	"kusionstack.io/kusion/pkg/models"
-	"kusionstack.io/kusion/pkg/models/appconfiguration/monitoring"
-	"kusionstack.io/kusion/pkg/models/appconfiguration/trait"
 	"kusionstack.io/kusion/pkg/models/appconfiguration/workload"
 	"kusionstack.io/kusion/pkg/projectstack"
 )
 
 // workloadServiceGenerator is a struct for generating service workload resources.
 type workloadServiceGenerator struct {
-	project    *projectstack.Project
-	stack      *projectstack.Stack
-	appName    string
-	service    *workload.Service
-	monitoring *monitoring.Monitor
-	opsRule    *trait.OpsRule
+	project *projectstack.Project
+	stack   *projectstack.Stack
+	appName string
+	service *workload.Service
 }
 
 // NewWorkloadServiceGenerator returns a new workloadServiceGenerator instance.
@@ -35,8 +29,6 @@ func NewWorkloadServiceGenerator(
 	stack *projectstack.Stack,
 	appName string,
 	service *workload.Service,
-	monitoring *monitoring.Monitor,
-	opsRule *trait.OpsRule,
 ) (appconfiguration.Generator, error) {
 	if len(project.Name) == 0 {
 		return nil, fmt.Errorf("project name must not be empty")
@@ -51,12 +43,10 @@ func NewWorkloadServiceGenerator(
 	}
 
 	return &workloadServiceGenerator{
-		project:    project,
-		stack:      stack,
-		appName:    appName,
-		service:    service,
-		monitoring: monitoring,
-		opsRule:    opsRule,
+		project: project,
+		stack:   stack,
+		appName: appName,
+		service: service,
 	}, nil
 }
 
@@ -66,11 +56,9 @@ func NewWorkloadServiceGeneratorFunc(
 	stack *projectstack.Stack,
 	appName string,
 	service *workload.Service,
-	monitoring *monitoring.Monitor,
-	opsRule *trait.OpsRule,
 ) appconfiguration.NewGeneratorFunc {
 	return func() (appconfiguration.Generator, error) {
-		return NewWorkloadServiceGenerator(project, stack, appName, service, monitoring, opsRule)
+		return NewWorkloadServiceGenerator(project, stack, appName, service)
 	}
 }
 
@@ -109,36 +97,8 @@ func (g *workloadServiceGenerator) Generate(spec *models.Spec) error {
 		}
 	}
 
-	// If Prometheus runs as an operator, it relies on Custom Resources to
-	// manage the scrape configs. CRs (ServiceMonitors and PodMonitors) rely on
-	// corresponding resources (Services and Pods) to have labels that can be
-	// used as part of the label selector for the CR to determine which
-	// service/pods to scrape from.
-	// Here we choose the label name kusion_monitoring_appname for two reasons:
-	// 1. Unlike the label validation in Kubernetes, the label name accepted by
-	// Prometheus cannot contain non-alphanumeric characters except underscore:
-	// https://github.com/prometheus/common/blob/main/model/labels.go#L94
-	// 2. The name should be unique enough that is only created by Kusion and
-	// used to identify a certain application
-	monitoringLabels := make(map[string]string)
-	monitoringAnnotations := make(map[string]string)
-	if g.monitoring != nil {
-		if g.project.ProjectConfiguration.Prometheus != nil && g.project.ProjectConfiguration.Prometheus.OperatorMode {
-			monitoringLabels["kusion_monitoring_appname"] = g.appName
-		} else if g.project.ProjectConfiguration.Prometheus != nil && !g.project.ProjectConfiguration.Prometheus.OperatorMode {
-			// If Prometheus doesn't run as an operator, kusion will generate the
-			// most widely-known annotation for workloads that can be consumed by
-			// the out-of-the-box community version of Prometheus server
-			// installation shown as below:
-			monitoringAnnotations["prometheus.io/scrape"] = "true"
-			monitoringAnnotations["prometheus.io/scheme"] = g.monitoring.Scheme
-			monitoringAnnotations["prometheus.io/path"] = g.monitoring.Path
-			monitoringAnnotations["prometheus.io/port"] = g.monitoring.Port
-		}
-	}
-
-	labels := appconfiguration.MergeMaps(appconfiguration.UniqueAppLabels(g.project.Name, g.appName), g.service.Labels, monitoringLabels)
-	annotations := appconfiguration.MergeMaps(g.service.Annotations, monitoringAnnotations)
+	labels := appconfiguration.MergeMaps(appconfiguration.UniqueAppLabels(g.project.Name, g.appName), g.service.Labels)
+	annotations := appconfiguration.MergeMaps(g.service.Annotations)
 	selector := appconfiguration.UniqueAppLabels(g.project.Name, g.appName)
 
 	// Create a K8s workload object based on the app's configuration.
@@ -174,15 +134,6 @@ func (g *workloadServiceGenerator) Generate(spec *models.Spec) error {
 			Selector: &metav1.LabelSelector{MatchLabels: selector},
 			Template: podTemplateSpec,
 		}
-		if g.opsRule != nil && g.opsRule.MaxUnavailable != "" {
-			maxUnavailable := intstr.Parse(g.opsRule.MaxUnavailable)
-			spec.Strategy = appsv1.DeploymentStrategy{
-				Type: appsv1.RollingUpdateDeploymentStrategyType,
-				RollingUpdate: &appsv1.RollingUpdateDeployment{
-					MaxUnavailable: &maxUnavailable,
-				},
-			}
-		}
 		resource = &appsv1.Deployment{
 			TypeMeta:   typeMeta,
 			ObjectMeta: objectMeta,