refactor!: fold promotion policies into project crd (#1417)

Signed-off-by: Kent Rancourt <kent.rancourt@gmail.com>
akuity · Feb 1, 2024 · f492e47 · f492e47
1 parent 79d788d
commit f492e47
Show file tree

Hide file tree

Showing 43 changed files with 1,623 additions and 4,156 deletions.
diff --git a/Tiltfile b/Tiltfile
@@ -168,7 +168,6 @@ k8s_resource(
   objects = [
     'freights.kargo.akuity.io:customresourcedefinition',
     'projects.kargo.akuity.io:customresourcedefinition',
-    'promotionpolicies.kargo.akuity.io:customresourcedefinition',
     'promotions.kargo.akuity.io:customresourcedefinition',
     'stages.kargo.akuity.io:customresourcedefinition',
     'warehouses.kargo.akuity.io:customresourcedefinition'

diff --git a/api/service/v1alpha1/service.proto b/api/service/v1alpha1/service.proto
@@ -41,20 +41,12 @@ service KargoService {
   rpc GetPromotion(GetPromotionRequest) returns (GetPromotionResponse);
   rpc WatchPromotion(WatchPromotionRequest) returns (stream WatchPromotionResponse);
 
-  /* PromotionPolicy APIs */
-
-  rpc SetAutoPromotionForStage(SetAutoPromotionForStageRequest) returns (SetAutoPromotionForStageResponse);
-  rpc CreatePromotionPolicy(CreatePromotionPolicyRequest) returns (CreatePromotionPolicyResponse);
-  rpc ListPromotionPolicies(ListPromotionPoliciesRequest) returns (ListPromotionPoliciesResponse);
-  rpc GetPromotionPolicy(GetPromotionPolicyRequest) returns (GetPromotionPolicyResponse);
-  rpc UpdatePromotionPolicy(UpdatePromotionPolicyRequest) returns (UpdatePromotionPolicyResponse);
-  rpc DeletePromotionPolicy(DeletePromotionPolicyRequest) returns (DeletePromotionPolicyResponse);
-
   /* Project APIs */
 
   rpc CreateProject(CreateProjectRequest) returns (CreateProjectResponse);
   rpc ListProjects(ListProjectsRequest) returns (ListProjectsResponse);
   rpc DeleteProject(DeleteProjectRequest) returns (DeleteProjectResponse);
+  rpc SetAutoPromotionForStage(SetAutoPromotionForStageRequest) returns (SetAutoPromotionForStageResponse);
 
   /* Freight APIs */
 
@@ -334,54 +326,6 @@ message SetAutoPromotionForStageRequest {
 }
 
 message SetAutoPromotionForStageResponse {
-  git.luolix.top.akuity.kargo.pkg.api.v1alpha1.PromotionPolicy promotion_policy = 1;
-}
-
-message CreatePromotionPolicyRequest {
-  oneof promotion_policy {
-    TypedPromotionPolicySpec typed = 1;
-    string yaml = 2;
-  }
-}
-
-message CreatePromotionPolicyResponse {
-  git.luolix.top.akuity.kargo.pkg.api.v1alpha1.PromotionPolicy promotion_policy = 1;
-}
-
-message ListPromotionPoliciesRequest {
-  string project = 1;
-}
-
-message ListPromotionPoliciesResponse {
-  repeated git.luolix.top.akuity.kargo.pkg.api.v1alpha1.PromotionPolicy promotion_policies = 1;
-}
-
-message GetPromotionPolicyRequest {
-  string project = 1;
-  string name = 2;
-}
-
-message GetPromotionPolicyResponse {
-  git.luolix.top.akuity.kargo.pkg.api.v1alpha1.PromotionPolicy promotion_policy = 1;
-}
-
-message UpdatePromotionPolicyRequest {
-  oneof promotion_policy {
-    TypedPromotionPolicySpec typed = 1;
-    string yaml = 2;
-  }
-}
-
-message UpdatePromotionPolicyResponse {
-  git.luolix.top.akuity.kargo.pkg.api.v1alpha1.PromotionPolicy promotion_policy = 1;
-}
-
-message DeletePromotionPolicyRequest {
-  string project = 1;
-  string name = 2;
-}
-
-message DeletePromotionPolicyResponse {
   /* explicitly empty */
 }
 

diff --git a/api/v1alpha1/groupversion_info.go b/api/v1alpha1/groupversion_info.go
@@ -35,8 +35,6 @@ func addKnownTypes(scheme *runtime.Scheme) error {
 		&ProjectList{},
 		&Promotion{},
 		&PromotionList{},
-		&PromotionPolicy{},
-		&PromotionPolicyList{},
 		&Warehouse{},
 		&WarehouseList{},
 	)

diff --git a/api/v1alpha1/project_types.go b/api/v1alpha1/project_types.go
@@ -50,7 +50,25 @@ func (p *Project) GetStatus() *ProjectStatus {
 
 // ProjectSpec describes a Project.
 type ProjectSpec struct {
-	// TODO: Figure out the attributes of a ProjectSpec.
+	// PromotionPolicies defines policies governing the promotion of Freight to
+	// specific Stages within this Project.
+	PromotionPolicies []PromotionPolicy `json:"promotionPolicies,omitempty"`
+}
+
+// PromotionPolicy defines policies governing the promotion of Freight to a
+// specific Stage.
+type PromotionPolicy struct {
+	//+kubebuilder:validation:MinLength=1
+	//+kubebuilder:validation:Pattern=^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
+	Stage string `json:"stage"`
+	// AutoPromotionEnabled indicates whether new Freight can automatically be
+	// promoted into the Stage referenced by the Stage field. Note: There are may
+	// be other conditions also required for an auto-promotion to occur. This
+	// field defaults to false, but is commonly set to true for Stages that
+	// subscribe to Warehouses instead of other, upstream Stages. This allows
+	// users to define Stages that are automatically updated as soon as new
+	// artifacts are detected.
+	AutoPromotionEnabled bool `json:"autoPromotionEnabled,omitempty"`
 }
 
 // ProjectStatus describes a Project's current status.

diff --git a/api/v1alpha1/promotion_policy_helpers.go b/api/v1alpha1/promotion_policy_helpers.go
diff --git a/api/v1alpha1/promotion_policy_helpers_test.go b/api/v1alpha1/promotion_policy_helpers_test.go
diff --git a/api/v1alpha1/promotionpolicy_types.go b/api/v1alpha1/promotionpolicy_types.go
diff --git a/api/v1alpha1/types.proto b/api/v1alpha1/types.proto
@@ -189,16 +189,8 @@ message PromotionMechanisms {
 }
 
 message PromotionPolicy {
-  string api_version = 1 [json_name = "apiVersion"];
-  string kind = 2 [json_name = "kind"];
-  git.luolix.top.akuity.kargo.pkg.api.metav1.ObjectMeta metadata = 3 [json_name = "metadata"];
   string stage = 4 [json_name = "stage"];
-  bool enable_auto_promotion = 5 [json_name = "enableAutoPromotion"];
-}
-
-message PromotionPolicyList {
-  git.luolix.top.akuity.kargo.pkg.api.metav1.ListMeta metadata = 1 [json_name = "metadata"];
-  repeated PromotionPolicy items = 2 [json_name = "items"];
+  bool auto_promotion_enabled = 5 [json_name = "autoPromotionEnabled"];
 }
 
 message PromotionSpec {

diff --git a/api/v1alpha1/zz_generated.deepcopy.go b/api/v1alpha1/zz_generated.deepcopy.go
diff --git a/charts/kargo/crds/kargo.akuity.io_projects.yaml b/charts/kargo/crds/kargo.akuity.io_projects.yaml
@@ -41,6 +41,32 @@ spec:
             type: object
           spec:
             description: Spec describes a Project.
+            properties:
+              promotionPolicies:
+                description: PromotionPolicies defines policies governing the promotion
+                  of Freight to specific Stages within this Project.
+                items:
+                  description: PromotionPolicy defines policies governing the promotion
+                    of Freight to a specific Stage.
+                  properties:
+                    autoPromotionEnabled:
+                      description: 'AutoPromotionEnabled indicates whether new Freight
+                        can automatically be promoted into the Stage referenced by
+                        the Stage field. Note: There are may be other conditions also
+                        required for an auto-promotion to occur. This field defaults
+                        to false, but is commonly set to true for Stages that subscribe
+                        to Warehouses instead of other, upstream Stages. This allows
+                        users to define Stages that are automatically updated as soon
+                        as new artifacts are detected.'
+                      type: boolean
+                    stage:
+                      minLength: 1
+                      pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
+                      type: string
+                  required:
+                  - stage
+                  type: object
+                type: array
             type: object
           status:
             description: Status describes the Project's current status.