feat(controlplane): add unique name to registered integrations (#643)

Signed-off-by: Miguel Martinez Trivino <[email protected]>

Author: migmartri

app/cli/cmd/registered_integration_add.go

@@ -1,5 +1,5 @@
 //
-// Copyright 2023 The Chainloop Authors.
+// Copyright 2024 The Chainloop Authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -29,12 +29,12 @@ import (
 
 func newRegisteredIntegrationAddCmd() *cobra.Command {
 	var options []string
-	var integrationDescription string
+	var integrationDescription, integrationName string
 
 	cmd := &cobra.Command{
-		Use:     "add INTEGRATION_ID --options key=value,key=value",
+		Use:     "add INTEGRATION_ID --name [registration-name] --options key=value,key=value",
 		Short:   "Register a new instance of an integration",
-		Example: `  chainloop integration registered add dependencytrack --opt instance=https://deptrack.company.com,apiKey=1234567890 --opt username=chainloop`,
+		Example: `  chainloop integration registered add dependencytrack --name send-to-prod --opt instance=https://deptrack.company.com,apiKey=1234567890 --opt username=chainloop`,
 		Args:    cobra.ExactArgs(1),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			// Retrieve schema for validation and options marshaling
@@ -57,7 +57,7 @@ func newRegisteredIntegrationAddCmd() *cobra.Command {
 				return err
 			}
 
-			res, err := action.NewRegisteredIntegrationAdd(actionOpts).Run(args[0], integrationDescription, opts)
+			res, err := action.NewRegisteredIntegrationAdd(actionOpts).Run(args[0], integrationName, integrationDescription, opts)
 			if err != nil {
 				return err
 			}
@@ -66,6 +66,10 @@ func newRegisteredIntegrationAddCmd() *cobra.Command {
 		},
 	}
 
+	cmd.Flags().StringVar(&integrationName, "name", "", "unique registration name, i.e my-registration, sboms-to-prod, etc.")
+	err := cmd.MarkFlagRequired("name")
+	cobra.CheckErr(err)
+
 	cmd.Flags().StringVar(&integrationDescription, "description", "", "integration registration description")
 	// StringSlice seems to struggle with comma-separated values such as p12 jsonKeys provided as passwords
 	// So we need to use StringArrayVar instead

app/cli/cmd/registered_integration_list.go

@@ -53,13 +53,13 @@ func registeredIntegrationListTableOutput(items []*action.RegisteredIntegrationI
 	}
 
 	t := newTableWriter()
-	t.AppendHeader(table.Row{"ID", "Description", "Kind", "Config", "Created At"})
+	t.AppendHeader(table.Row{"ID", "Name", "Description", "Kind", "Config", "Created At"})
 	for _, i := range items {
 		var options []string
 		for k, v := range i.Config {
 			options = append(options, fmt.Sprintf("%s: %v", k, v))
 		}
-		t.AppendRow(table.Row{i.ID, i.Description, i.Kind, strings.Join(options, "\n"), i.CreatedAt.Format(time.RFC822)})
+		t.AppendRow(table.Row{i.ID, i.Name, i.Description, i.Kind, strings.Join(options, "\n"), i.CreatedAt.Format(time.RFC822)})
 		t.AppendSeparator()
 	}
 

app/cli/internal/action/registered_integration_add.go

@@ -31,7 +31,7 @@ func NewRegisteredIntegrationAdd(cfg *ActionsOpts) *RegisteredIntegrationAdd {
 	return &RegisteredIntegrationAdd{cfg}
 }
 
-func (action *RegisteredIntegrationAdd) Run(pluginID, description string, options map[string]any) (*RegisteredIntegrationItem, error) {
+func (action *RegisteredIntegrationAdd) Run(pluginID, name, description string, options map[string]any) (*RegisteredIntegrationItem, error) {
 	// Transform to structpb for transport
 	requestConfig, err := structpb.NewStruct(options)
 	if err != nil {
@@ -40,6 +40,7 @@ func (action *RegisteredIntegrationAdd) Run(pluginID, description string, option
 
 	client := pb.NewIntegrationsServiceClient(action.cfg.CPConnection)
 	i, err := client.Register(context.Background(), &pb.IntegrationsServiceRegisterRequest{
+		Name:        name,
 		PluginId:    pluginID,
 		Config:      requestConfig,
 		Description: description,

app/cli/internal/action/registered_integration_list.go

@@ -30,8 +30,10 @@ type RegisteredIntegrationList struct {
 
 type RegisteredIntegrationItem struct {
 	ID string `json:"id"`
+	// Registration name used for declarative configuration
+	Name string `json:"name"`
 	// Integration backend kind, i.e slack, pagerduty, etc
-	Kind string `json:"name"`
+	Kind string `json:"kind"`
 	// Integration description for display and differentiation purposes
 	Description string                 `json:"description"`
 	CreatedAt   *time.Time             `json:"createdAt"`
@@ -68,7 +70,7 @@ func pbRegisteredIntegrationItemToAction(in *pb.RegisteredIntegrationItem) (*Reg
 	}
 
 	i := &RegisteredIntegrationItem{
-		Kind: in.GetKind(), ID: in.GetId(),
+		Kind: in.GetKind(), ID: in.GetId(), Name: in.GetName(),
 		Description: in.GetDescription(),
 		CreatedAt:   toTimePtr(in.GetCreatedAt().AsTime()),
 	}

app/controlplane/api/controlplane/v1/integrations.pb.go

@@ -17,137 +17,142 @@ syntax = "proto3";
 
 package controlplane.v1;
 
-option go_package = "github.com/chainloop-dev/chainloop/app/controlplane/api/controlplane/v1;v1";
-import "validate/validate.proto";
-import "google/protobuf/timestamp.proto";
-import "google/protobuf/struct.proto";
 import "controlplane/v1/response_messages.proto";
+import "google/protobuf/struct.proto";
+import "google/protobuf/timestamp.proto";
+import "validate/validate.proto";
+
+option go_package = "github.com/chainloop-dev/chainloop/app/controlplane/api/controlplane/v1;v1";
 
 service IntegrationsService {
-	// Integrations available and loaded in the controlplane ready to be used during registration
-	rpc ListAvailable (IntegrationsServiceListAvailableRequest) returns (IntegrationsServiceListAvailableResponse);
-
-	// Registration Related operations
-	// Register a new integration in the organization
-	rpc Register (IntegrationsServiceRegisterRequest) returns (IntegrationsServiceRegisterResponse);
-	// Delete registered integrations
-	rpc Deregister (IntegrationsServiceDeregisterRequest) returns (IntegrationsServiceDeregisterResponse);
-	// List registered integrations
-	rpc ListRegistrations (IntegrationsServiceListRegistrationsRequest) returns (IntegrationsServiceListRegistrationsResponse);
-	// View registered integration
-	rpc DescribeRegistration (IntegrationsServiceDescribeRegistrationRequest) returns (IntegrationsServiceDescribeRegistrationResponse);
-
-	// Attachment Related operations
-	// Attach an integration to a workflow
-	rpc Attach (IntegrationsServiceAttachRequest) returns (IntegrationsServiceAttachResponse);
-	// Detach integration from a workflow
-	rpc Detach (IntegrationsServiceDetachRequest) returns (IntegrationsServiceDetachResponse);
-	// List attachments
-	rpc ListAttachments (ListAttachmentsRequest) returns (ListAttachmentsResponse);
+  // Integrations available and loaded in the controlplane ready to be used during registration
+  rpc ListAvailable(IntegrationsServiceListAvailableRequest) returns (IntegrationsServiceListAvailableResponse);
+
+  // Registration Related operations
+  // Register a new integration in the organization
+  rpc Register(IntegrationsServiceRegisterRequest) returns (IntegrationsServiceRegisterResponse);
+  // Delete registered integrations
+  rpc Deregister(IntegrationsServiceDeregisterRequest) returns (IntegrationsServiceDeregisterResponse);
+  // List registered integrations
+  rpc ListRegistrations(IntegrationsServiceListRegistrationsRequest) returns (IntegrationsServiceListRegistrationsResponse);
+  // View registered integration
+  rpc DescribeRegistration(IntegrationsServiceDescribeRegistrationRequest) returns (IntegrationsServiceDescribeRegistrationResponse);
+
+  // Attachment Related operations
+  // Attach an integration to a workflow
+  rpc Attach(IntegrationsServiceAttachRequest) returns (IntegrationsServiceAttachResponse);
+  // Detach integration from a workflow
+  rpc Detach(IntegrationsServiceDetachRequest) returns (IntegrationsServiceDetachResponse);
+  // List attachments
+  rpc ListAttachments(ListAttachmentsRequest) returns (ListAttachmentsResponse);
 }
 
 message IntegrationsServiceRegisterRequest {
-	// Kind of integration to register
-	// This should match the ID of an existing plugin
-	string plugin_id = 1 [(validate.rules).string.min_len = 1];
-	// Arbitrary configuration for the integration
-	google.protobuf.Struct config = 3 [(validate.rules).message.required = true];
-	// Description of the registration, used for display purposes
-	string description = 4;
+  // unique, DNS-like name for the registration
+  string name = 5 [(validate.rules).string = {min_len: 1}];
+  // Kind of integration to register
+  // This should match the ID of an existing plugin
+  string plugin_id = 1 [(validate.rules).string.min_len = 1];
+  // Arbitrary configuration for the integration
+  google.protobuf.Struct config = 3 [(validate.rules).message.required = true];
+  // Description of the registration, used for display purposes
+  string description = 4;
 }
 
 message IntegrationsServiceRegisterResponse {
-	RegisteredIntegrationItem result = 1;
+  RegisteredIntegrationItem result = 1;
 }
 
-message IntegrationsServiceAttachRequest{
-	// UUID of the workflow to attach
-	string workflow_id = 1 [(validate.rules).string.uuid = true];
-	// UUID of the integration registration to attach
-	string integration_id = 2 [(validate.rules).string.uuid = true];
-	// Arbitrary configuration for the integration
-	google.protobuf.Struct config = 4 [(validate.rules).message.required = true];
+message IntegrationsServiceAttachRequest {
+  // UUID of the workflow to attach
+  string workflow_id = 1 [(validate.rules).string.uuid = true];
+  // UUID of the integration registration to attach
+  string integration_id = 2 [(validate.rules).string.uuid = true];
+  // Arbitrary configuration for the integration
+  google.protobuf.Struct config = 4 [(validate.rules).message.required = true];
 }
 
-message IntegrationsServiceAttachResponse{
-	IntegrationAttachmentItem result = 1;
+message IntegrationsServiceAttachResponse {
+  IntegrationAttachmentItem result = 1;
 }
 
-message IntegrationsServiceListAvailableRequest{}
-message IntegrationsServiceListAvailableResponse{
-	repeated IntegrationAvailableItem result = 1;
+message IntegrationsServiceListAvailableRequest {}
+message IntegrationsServiceListAvailableResponse {
+  repeated IntegrationAvailableItem result = 1;
 }
 
 message IntegrationAvailableItem {
-	// Integration identifier
-	string id = 1;
-	string version = 2;
-	string description = 3;
+  // Integration identifier
+  string id = 1;
+  string version = 2;
+  string description = 3;
 
-	oneof type {
-		PluginFanout fanout = 4;
-	}
+  oneof type {
+    PluginFanout fanout = 4;
+  }
 }
 
 // PluginFanout describes a plugin that can be used to fanout attestation and materials to multiple integrations
 message PluginFanout {
-	// Registration JSON schema
-	bytes registration_schema = 4;
-	// Attachment JSON schema
-	bytes attachment_schema = 5;
-	// List of materials that the integration is subscribed to
-	repeated string subscribed_materials = 6;
+  // Registration JSON schema
+  bytes registration_schema = 4;
+  // Attachment JSON schema
+  bytes attachment_schema = 5;
+  // List of materials that the integration is subscribed to
+  repeated string subscribed_materials = 6;
 }
 
-message IntegrationsServiceListRegistrationsRequest{}
-message IntegrationsServiceListRegistrationsResponse{
-	repeated RegisteredIntegrationItem result = 1;
+message IntegrationsServiceListRegistrationsRequest {}
+message IntegrationsServiceListRegistrationsResponse {
+  repeated RegisteredIntegrationItem result = 1;
 }
 
-message IntegrationsServiceDescribeRegistrationRequest{
+message IntegrationsServiceDescribeRegistrationRequest {
   string id = 1 [(validate.rules).string.uuid = true];
 }
 
-message IntegrationsServiceDescribeRegistrationResponse{
-	RegisteredIntegrationItem result = 1;
+message IntegrationsServiceDescribeRegistrationResponse {
+  RegisteredIntegrationItem result = 1;
 }
 
-message IntegrationsServiceDetachRequest{
+message IntegrationsServiceDetachRequest {
   string id = 1 [(validate.rules).string.uuid = true];
 }
 
 message IntegrationsServiceDetachResponse {}
 
-message ListAttachmentsRequest{
+message ListAttachmentsRequest {
   // Filter by workflow
   string workflow_id = 1;
 }
 
-message ListAttachmentsResponse{
-	repeated IntegrationAttachmentItem result = 1;
+message ListAttachmentsResponse {
+  repeated IntegrationAttachmentItem result = 1;
 }
 
 message RegisteredIntegrationItem {
-	string id = 1;
-	string kind = 2;
-	// Description of the registration, used for display purposes
-	string description = 4;
-	google.protobuf.Timestamp created_at = 3;
-	// Arbitrary configuration for the integration
-	bytes config = 5;
+  string id = 1;
+  // unique, DNS-like name for the registration
+  string name = 6;
+  string kind = 2;
+  // Description of the registration, used for display purposes
+  string description = 4;
+  google.protobuf.Timestamp created_at = 3;
+  // Arbitrary configuration for the integration
+  bytes config = 5;
 }
 
 message IntegrationAttachmentItem {
-	string id = 1;
-	google.protobuf.Timestamp created_at = 2;
-	// Arbitrary configuration for the attachment
-	bytes config = 3;
-	RegisteredIntegrationItem integration = 4;
-	WorkflowItem workflow = 5;
+  string id = 1;
+  google.protobuf.Timestamp created_at = 2;
+  // Arbitrary configuration for the attachment
+  bytes config = 3;
+  RegisteredIntegrationItem integration = 4;
+  WorkflowItem workflow = 5;
 }
 
 message IntegrationsServiceDeregisterRequest {
   string id = 1 [(validate.rules).string.uuid = true];
 }
 
-message IntegrationsServiceDeregisterResponse {}
+message IntegrationsServiceDeregisterResponse {}