backend: add tags support to pipelines (#1657)

Author: weeco

backend/pkg/protogen/redpanda/api/dataplane/v1/pipeline.pb.go

@@ -4,7 +4,7 @@
 // @ts-nocheck
 
 import type { BinaryReadOptions, FieldList, JsonReadOptions, JsonValue, PartialMessage, PlainMessage } from "@bufbuild/protobuf";
-import { Message, proto3 } from "@bufbuild/protobuf";
+import { FieldMask, Message, proto3 } from "@bufbuild/protobuf";
 
 /**
  * Defines the pipeline resource.
@@ -68,6 +68,14 @@ export class Pipeline extends Message<Pipeline> {
    */
   url = "";
 
+  /**
+   * Tags are key-value pairs that can be assigned to a pipeline resource.
+   * They help organize pipelines and enable filtering when listing them.
+   *
+   * @generated from field: map<string, string> tags = 11;
+   */
+  tags: { [key: string]: string } = {};
+
   constructor(data?: PartialMessage<Pipeline>) {
     super();
     proto3.util.initPartial(data, this);
@@ -84,6 +92,7 @@ export class Pipeline extends Message<Pipeline> {
     { no: 7, name: "state", kind: "enum", T: proto3.getEnumType(Pipeline_State) },
     { no: 8, name: "status", kind: "message", T: Pipeline_Status },
     { no: 10, name: "url", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 11, name: "tags", kind: "map", K: 9 /* ScalarType.STRING */, V: {kind: "scalar", T: 9 /* ScalarType.STRING */} },
   ]);
 
   static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): Pipeline {
@@ -553,6 +562,13 @@ export class ListPipelinesRequest_Filter extends Message<ListPipelinesRequest_Fi
    */
   nameContains = "";
 
+  /**
+   * Filter pipelines that contain all of these key/value pairs.
+   *
+   * @generated from field: map<string, string> tags = 2;
+   */
+  tags: { [key: string]: string } = {};
+
   constructor(data?: PartialMessage<ListPipelinesRequest_Filter>) {
     super();
     proto3.util.initPartial(data, this);
@@ -562,6 +578,7 @@ export class ListPipelinesRequest_Filter extends Message<ListPipelinesRequest_Fi
   static readonly typeName = "redpanda.api.dataplane.v1.ListPipelinesRequest.Filter";
   static readonly fields: FieldList = proto3.util.newFieldList(() => [
     { no: 1, name: "name_contains", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 2, name: "tags", kind: "map", K: 9 /* ScalarType.STRING */, V: {kind: "scalar", T: 9 /* ScalarType.STRING */} },
   ]);
 
   static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): ListPipelinesRequest_Filter {
@@ -656,6 +673,14 @@ export class PipelineUpdate extends Message<PipelineUpdate> {
    */
   resources?: Pipeline_Resources;
 
+  /**
+   * A map of tags to add, update or delete.
+   * If a tag's value is empty, the server interprets that as a deletion.
+   *
+   * @generated from field: map<string, string> tags = 7;
+   */
+  tags: { [key: string]: string } = {};
+
   constructor(data?: PartialMessage<PipelineUpdate>) {
     super();
     proto3.util.initPartial(data, this);
@@ -668,6 +693,7 @@ export class PipelineUpdate extends Message<PipelineUpdate> {
     { no: 2, name: "description", kind: "scalar", T: 9 /* ScalarType.STRING */ },
     { no: 3, name: "config_yaml", kind: "scalar", T: 9 /* ScalarType.STRING */ },
     { no: 6, name: "resources", kind: "message", T: Pipeline_Resources },
+    { no: 7, name: "tags", kind: "map", K: 9 /* ScalarType.STRING */, V: {kind: "scalar", T: 9 /* ScalarType.STRING */} },
   ]);
 
   static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): PipelineUpdate {
@@ -703,6 +729,14 @@ export class UpdatePipelineRequest extends Message<UpdatePipelineRequest> {
    */
   pipeline?: PipelineUpdate;
 
+  /**
+   * Specifies which fields should be updated. If not provided,
+   * all fields will be updated.
+   *
+   * @generated from field: google.protobuf.FieldMask update_mask = 3;
+   */
+  updateMask?: FieldMask;
+
   constructor(data?: PartialMessage<UpdatePipelineRequest>) {
     super();
     proto3.util.initPartial(data, this);
@@ -713,6 +747,7 @@ export class UpdatePipelineRequest extends Message<UpdatePipelineRequest> {
   static readonly fields: FieldList = proto3.util.newFieldList(() => [
     { no: 1, name: "id", kind: "scalar", T: 9 /* ScalarType.STRING */ },
     { no: 2, name: "pipeline", kind: "message", T: PipelineUpdate },
+    { no: 3, name: "update_mask", kind: "message", T: FieldMask },
   ]);
 
   static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): UpdatePipelineRequest {

backend/pkg/protogen/redpanda/api/dataplane/v1/pipeline.pb.gw.go

@@ -4259,7 +4259,7 @@ paths:
         content:
           multipart/form-data:
             schema:
-              example: '{"name":"redact-orders", "input_topic_name":"orders", "output_topic_names":["orders-redacted"], "environment_variables":[{"key":"LOGGER_LEVEL", "value":"DEBUG"}]}'
+              example: '{"name":"redact-orders","input_topic_name":"orders","output_topic_names":["orders-redacted"],"environment_variables":[{"key":"LOGGER_LEVEL","value":"DEBUG"}]}'
               properties:
                 metadata:
                   $ref: '#/components/schemas/DeployTransformRequest'

frontend/src/protogen/redpanda/api/dataplane/v1/pipeline_pb.ts

@@ -5,6 +5,7 @@ package redpanda.api.dataplane.v1;
 import "buf/validate/validate.proto";
 import "google/api/annotations.proto";
 import "google/api/field_behavior.proto";
+import "google/protobuf/field_mask.proto";
 import "protoc-gen-openapiv2/options/annotations.proto";
 import "redpanda/api/auth/v1/authorization.proto";
 
@@ -52,6 +53,15 @@ message Pipeline {
   // May be empty if no http_server is used.
   string url = 10;
 
+  // Tags are key-value pairs that can be assigned to a pipeline resource.
+  // They help organize pipelines and enable filtering when listing them.
+  map<string, string> tags = 11 [(buf.validate.field).map = {
+    max_pairs: 16
+    values: {
+      string: {pattern: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"}
+    }
+  }];
+
   message Resources {
     // `memory_shares` is a string specifying the amount of memory to allocate for
     // the pipeline.
@@ -452,6 +462,14 @@ message ListPipelinesRequest {
       (buf.validate.field).string.pattern = "^[A-Za-z0-9-_ /]+$",
       (buf.validate.field).string.max_len = 128
     ];
+
+    // Filter pipelines that contain all of these key/value pairs.
+    map<string, string> tags = 2 [(buf.validate.field).map = {
+      max_pairs: 16
+      values: {
+        string: {pattern: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"}
+      }
+    }];
   }
 }
 
@@ -486,6 +504,15 @@ message PipelineUpdate {
 
   // The number of resources that are guaranteed to be assigned to the pipeline.
   Pipeline.Resources resources = 6;
+
+  // A map of tags to add, update or delete.
+  // If a tag's value is empty, the server interprets that as a deletion.
+  map<string, string> tags = 7 [(buf.validate.field).map = {
+    max_pairs: 16
+    values: {
+      string: {pattern: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"}
+    }
+  }];
 }
 
 message UpdatePipelineRequest {
@@ -495,10 +522,15 @@ message UpdatePipelineRequest {
     (buf.validate.field).required = true,
     (buf.validate.field).string.pattern = "^[A-Za-z0-9-_/]+$"
   ];
+
   PipelineUpdate pipeline = 2 [
     (google.api.field_behavior) = REQUIRED,
     (buf.validate.field).required = true
   ];
+
+  // Specifies which fields should be updated. If not provided,
+  // all fields will be updated.
+  google.protobuf.FieldMask update_mask = 3;
 }
 
 message UpdatePipelineResponse {