types.go

package types

import (
	"encoding/gob"

	"github.com/argoproj/argo-rollouts/pkg/apis/rollouts/v1alpha1"
)

func init() {
	gob.RegisterName("RpcError", new(RpcError))
}

// RpcError is a wrapper around the error type to allow for usage with net/rpc
// and empty ErrorString == "" is considered no error
type RpcError struct {
	ErrorString string
}

func (e RpcError) Error() string {
	return e.ErrorString
}

// HasError returns true if there is an error
func (e RpcError) HasError() bool {
	return e.ErrorString != ""
}

// RpcVerified is a wrapper around the *bool as used in VerifyWeight for traffic routers. This is needed because
// net/rpc does not support pointers.
type RpcVerified int32

const (
	NotVerified RpcVerified = iota
	Verified
	NotImplemented
)

func (v *RpcVerified) IsVerified() *bool {
	verified := true
	notVerified := false
	switch *v {
	case Verified:
		return &verified
	case NotVerified:
		return &notVerified
	case NotImplemented:
		return nil
	default:
		return &notVerified
	}
}

type RpcMetricProvider interface {
	// Run start a new external system call for a measurement
	// Should be idempotent and do nothing if a call has already been started
	Run(*v1alpha1.AnalysisRun, v1alpha1.Metric) v1alpha1.Measurement
	// Resume Checks if the external system call is finished and returns the current measurement
	Resume(*v1alpha1.AnalysisRun, v1alpha1.Metric, v1alpha1.Measurement) v1alpha1.Measurement
	// Terminate will terminate an in-progress measurement
	Terminate(*v1alpha1.AnalysisRun, v1alpha1.Metric, v1alpha1.Measurement) v1alpha1.Measurement
	// GarbageCollect is used to garbage collect completed measurements to the specified limit
	GarbageCollect(*v1alpha1.AnalysisRun, v1alpha1.Metric, int) RpcError
	// Type gets the provider type
	Type() string
	// GetMetadata returns any additional metadata which providers need to store/display as part
	// of the metric result. For example, Prometheus uses is to store the final resolved queries.
	GetMetadata(metric v1alpha1.Metric) map[string]string
}

type RpcTrafficRoutingReconciler interface {
	// UpdateHash informs a traffic routing reconciler about new canary, stable, and additionalDestination(s) pod hashes
	UpdateHash(rollout *v1alpha1.Rollout, canaryHash, stableHash string, additionalDestinations []v1alpha1.WeightDestination) RpcError
	// SetWeight sets the canary weight to the desired weight
	SetWeight(rollout *v1alpha1.Rollout, desiredWeight int32, additionalDestinations []v1alpha1.WeightDestination) RpcError
	// SetHeaderRoute sets the header routing step
	SetHeaderRoute(rollout *v1alpha1.Rollout, setHeaderRoute *v1alpha1.SetHeaderRoute) RpcError
	// SetMirrorRoute sets up the traffic router to mirror traffic to a service
	SetMirrorRoute(rollout *v1alpha1.Rollout, setMirrorRoute *v1alpha1.SetMirrorRoute) RpcError
	// VerifyWeight returns true if the canary is at the desired weight and additionalDestinations are at the weights specified
	// Returns nil if weight verification is not supported or not applicable
	VerifyWeight(rollout *v1alpha1.Rollout, desiredWeight int32, additionalDestinations []v1alpha1.WeightDestination) (RpcVerified, RpcError)
	// RemoveManagedRoutes Removes all routes that are managed by rollouts by looking at spec.strategy.canary.trafficRouting.managedRoutes
	RemoveManagedRoutes(ro *v1alpha1.Rollout) RpcError
	// Type returns the type of the traffic routing reconciler
	Type() string
}

type RpcStep interface {
	// Run executes a step plugin for the RpcStepContext and returns the result to the controller or an RpcError for unexpeted failures
	Run(*v1alpha1.Rollout, *RpcStepContext) (RpcStepResult, RpcError)
	// Terminate stops an uncompleted operation started by the Run operation
	Terminate(*v1alpha1.Rollout, *RpcStepContext) (RpcStepResult, RpcError)
	// Abort reverts the actions performed during the Run operation if necessary
	Abort(*v1alpha1.Rollout, *RpcStepContext) (RpcStepResult, RpcError)
	// Type returns the type of the step plugin
	Type() string
}

type TrafficRouterPlugins struct {
	// TrafficRouters is the list of plugin that implements a RpcTrafficRoutingReconciler
	TrafficRouters []PluginItem `json:"trafficRouterPlugins" yaml:"trafficRouterPlugins"`
}

type MetricProviderPlugins struct {
	// MetricProviders is the list of plugin that implements a RpcMetricProvider
	MetricProviders []PluginItem `json:"metricProviderPlugins" yaml:"metricProviderPlugins"`
}

type StepPlugins struct {
	// Steps is the list of plugin that implements a RpcStep
	Steps []PluginItem `json:"stepPlugins" yaml:"stepPlugins"`
}

// PluginType is a type of plugin
type PluginType string

const (
	// PluginTypeMetricProvider is the type for a MetricProvider plugin
	PluginTypeMetricProvider PluginType = "MetricProvider"
	// PluginTypeTrafficRouter is the type for a TrafficRouter plugin
	PluginTypeTrafficRouter PluginType = "TrafficRouter"
	// PluginTypeStep is the type for a Step plugin
	PluginTypeStep PluginType = "Step"
)

type PluginItem struct {
	// Name of the plugin to use in the Rollout custom resources
	Name string `json:"name" yaml:"name"`
	// Location of the plugin. Supports http(s):// urls and file:// prefix
	Location string `json:"location" yaml:"location"`
	// Sha256 is the checksum of the file specified at the provided Location
	Sha256 string `json:"sha256" yaml:"sha256"`
	// Type of the plugin
	Type PluginType
	// Disabled indicates if the plugin should be ignored when referenced in Rollout custom resources. Only valid for a plugin of type Step.
	Disabled bool `json:"disabled" yaml:"disabled"`
	// Args holds command line arguments to initialize the plugin
	Args []string `json:"args" yaml:"args"`
	// HeadersFrom holds the names of secrets where the headers should be pulled from
	HeadersFrom []HeadersFrom `json:"headersFrom" yaml:"headersFrom"`
}

type HeadersFrom struct {
	SecretRef SecretRef `json:"secretRef" yaml:"secretRef"`
}

type SecretRef struct {
	Name string `json:"name" yaml:"name"`
}