diff --git a/chart/keda/templates/deployment.yaml b/chart/keda/templates/deployment.yaml index e1ea111f670..4566d3573ef 100644 --- a/chart/keda/templates/deployment.yaml +++ b/chart/keda/templates/deployment.yaml @@ -36,3 +36,14 @@ spec: name: https - containerPort: 8080 name: http + {{- if .Values.grpcTLSCertsSecret }} + volumeMounts: + - name: grpc-certs + mountPath: /grpccerts + {{- end }} + {{- if .Values.grpcTLSCertsSecret }} + volumes: + - name: grpc-certs + secret: + secretName: {{ .Values.grpcTLSCertsSecret }} + {{- end }} \ No newline at end of file diff --git a/chart/keda/values.yaml b/chart/keda/values.yaml index 0d6efcc9ee2..bfad5eb51b4 100644 --- a/chart/keda/values.yaml +++ b/chart/keda/values.yaml @@ -25,4 +25,9 @@ glogLevel: 2 # Set to the value of the Azure Active Directory Pod Identity # This will be set as a label on the Keda Pod(s) -aadPodIdentity: "" \ No newline at end of file +aadPodIdentity: "" + +# Set this if you are using an external scaler and want to communicate +# over TLS (recommended). This variable holds the name of the secret that +# will be mounted to the /grpccerts path on the Pod +grpcTLSCertsSecret: "" diff --git a/examples/externalscaler_scaledobject.yaml b/examples/externalscaler_scaledobject.yaml new file mode 100644 index 00000000000..43b9ae86e63 --- /dev/null +++ b/examples/externalscaler_scaledobject.yaml @@ -0,0 +1,18 @@ +apiVersion: keda.k8s.io/v1alpha1 +kind: ScaledObject +metadata: + name: redis-scaledobject + namespace: keda-redis-test + labels: + deploymentName: keda-redis-node +spec: + scaleTargetRef: + deploymentName: keda-redis-node + triggers: + - type: external + metadata: + scalerAddress: redis-external-scaler-service:8080 + address: REDIS_HOST # Required host:port format + password: REDIS_PASSWORD + listName: mylist # Required + listLength: "5" # Required diff --git a/pkg/handler/scale_handler.go b/pkg/handler/scale_handler.go index 15d5644e683..0264323a28d 100644 --- a/pkg/handler/scale_handler.go +++ b/pkg/handler/scale_handler.go @@ -595,7 +595,7 @@ func (h *ScaleHandler) getScalers(scaledObject *keda_v1alpha1.ScaledObject) ([]s } for i, trigger := range scaledObject.Spec.Triggers { - scaler, err := h.getScaler(trigger, resolvedEnv) + scaler, err := h.getScaler(scaledObject, trigger, resolvedEnv) if err != nil { return scalers, nil, fmt.Errorf("error getting scaler for trigger #%d: %s", i, err) } @@ -606,7 +606,7 @@ func (h *ScaleHandler) getScalers(scaledObject *keda_v1alpha1.ScaledObject) ([]s return scalers, deployment, nil } -func (h *ScaleHandler) getScaler(trigger keda_v1alpha1.ScaleTriggers, resolvedEnv map[string]string) (scalers.Scaler, error) { +func (h *ScaleHandler) getScaler(scaledObject *keda_v1alpha1.ScaledObject, trigger keda_v1alpha1.ScaleTriggers, resolvedEnv map[string]string) (scalers.Scaler, error) { switch trigger.Type { case "azure-queue": return scalers.NewAzureQueueScaler(resolvedEnv, trigger.Metadata) @@ -628,6 +628,8 @@ func (h *ScaleHandler) getScaler(trigger keda_v1alpha1.ScaleTriggers, resolvedEn return scalers.NewRedisScaler(resolvedEnv, trigger.Metadata) case "gcp-pubsub": return scalers.NewPubSubScaler(resolvedEnv, trigger.Metadata) + case "external": + return scalers.NewExternalScaler(scaledObject, resolvedEnv, trigger.Metadata) case "liiklus": return scalers.NewLiiklusScaler(resolvedEnv, trigger.Metadata) default: diff --git a/pkg/scalers/external_scaler.go b/pkg/scalers/external_scaler.go new file mode 100644 index 00000000000..8408f5f1d2b --- /dev/null +++ b/pkg/scalers/external_scaler.go @@ -0,0 +1,218 @@ +package scalers + +import ( + "context" + "fmt" + + log "github.com/Sirupsen/logrus" + keda_v1alpha1 "github.com/kedacore/keda/pkg/apis/keda/v1alpha1" + pb "github.com/kedacore/keda/pkg/scalers/externalscaler" + "google.golang.org/grpc" + "google.golang.org/grpc/credentials" + v2beta1 "k8s.io/api/autoscaling/v2beta1" + "k8s.io/apimachinery/pkg/api/resource" + metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" + "k8s.io/apimachinery/pkg/labels" + "k8s.io/metrics/pkg/apis/external_metrics" +) + +type externalScaler struct { + metadata *externalScalerMetadata + scaledObjectRef pb.ScaledObjectRef + grpcClient pb.ExternalScalerClient + grpcConnection *grpc.ClientConn +} + +type externalScalerMetadata struct { + scalerAddress string + tlsCertFile string + metadata map[string]string +} + +// NewExternalScaler creates a new external scaler - calls the GRPC interface +// to create a new scaler +func NewExternalScaler(scaledObject *keda_v1alpha1.ScaledObject, resolvedEnv, metadata map[string]string) (Scaler, error) { + + meta, err := parseExternalScalerMetadata(metadata, resolvedEnv) + if err != nil { + return nil, fmt.Errorf("error parsing external scaler metadata: %s", err) + } + + scaler := &externalScaler{ + metadata: meta, + scaledObjectRef: pb.ScaledObjectRef{ + Name: scaledObject.Name, + Namespace: scaledObject.Namespace, + }, + } + + // TODO: Pass Context + ctx := context.Background() + + // Call GRPC Interface to parse metadata + err = scaler.getGRPCClient() + if err != nil { + return nil, err + } + + request := &pb.NewRequest{ + ScaledObjectRef: &scaler.scaledObjectRef, + Metadata: scaler.metadata.metadata, + } + + _, err = scaler.grpcClient.New(ctx, request) + if err != nil { + return nil, err + } + + return scaler, nil +} + +func parseExternalScalerMetadata(metadata, resolvedEnv map[string]string) (*externalScalerMetadata, error) { + meta := externalScalerMetadata{} + + // Check if scalerAddress is present + if val, ok := metadata["scalerAddress"]; ok && val != "" { + meta.scalerAddress = val + } else { + return nil, fmt.Errorf("Scaler Address is a required field") + } + + if val, ok := metadata["tlsCertFile"]; ok && val != "" { + meta.tlsCertFile = val + } + + meta.metadata = make(map[string]string) + + // Add elements to metadata + for key, value := range metadata { + // Check if key is in resolved environment and resolve + if val, ok := resolvedEnv[value]; ok && val != "" { + meta.metadata[key] = val + } else { + meta.metadata[key] = value + } + } + + return &meta, nil +} + +// IsActive checks if there are any messages in the subscription +func (s *externalScaler) IsActive(ctx context.Context) (bool, error) { + + // Call GRPC Interface to check if active + response, err := s.grpcClient.IsActive(ctx, &s.scaledObjectRef) + if err != nil { + log.Errorf("error %s", err) + return false, err + } + + return response.Result, nil +} + +func (s *externalScaler) Close() error { + // Call GRPC Interface to close connection + + // TODO: Pass Context + ctx := context.Background() + + _, err := s.grpcClient.Close(ctx, &s.scaledObjectRef) + if err != nil { + log.Errorf("error %s", err) + return err + } + defer s.grpcConnection.Close() + + return nil +} + +// GetMetricSpecForScaling returns the metric spec for the HPA +func (s *externalScaler) GetMetricSpecForScaling() []v2beta1.MetricSpec { + + // TODO: Pass Context + ctx := context.Background() + + // Call GRPC Interface to get metric specs + response, err := s.grpcClient.GetMetricSpec(ctx, &s.scaledObjectRef) + if err != nil { + log.Errorf("error %s", err) + return nil + } + + var result []v2beta1.MetricSpec + + for _, spec := range response.MetricSpecs { + // Construct the target subscription size as a quantity + qty := resource.NewQuantity(int64(spec.TargetSize), resource.DecimalSI) + + externalMetric := &v2beta1.ExternalMetricSource{ + MetricName: spec.MetricName, + TargetAverageValue: qty, + } + + // Create the metric spec for the HPA + metricSpec := v2beta1.MetricSpec{ + External: externalMetric, + Type: externalMetricType, + } + + result = append(result, metricSpec) + } + + return result +} + +// GetMetrics connects calls the gRPC interface to get the metrics with a specific name +func (s *externalScaler) GetMetrics(ctx context.Context, metricName string, metricSelector labels.Selector) ([]external_metrics.ExternalMetricValue, error) { + + var metrics []external_metrics.ExternalMetricValue + // Call GRPC Interface to get metric specs + + request := &pb.GetMetricsRequest{ + MetricName: metricName, + ScaledObjectRef: &s.scaledObjectRef, + } + + response, err := s.grpcClient.GetMetrics(ctx, request) + if err != nil { + log.Errorf("error %s", err) + return []external_metrics.ExternalMetricValue{}, err + } + + for _, metricResult := range response.MetricValues { + metric := external_metrics.ExternalMetricValue{ + MetricName: metricResult.MetricName, + Value: *resource.NewQuantity(metricResult.MetricValue, resource.DecimalSI), + Timestamp: metav1.Now(), + } + + metrics = append(metrics, metric) + } + + return metrics, nil +} + +// getGRPCClient creates a new gRPC client +func (s *externalScaler) getGRPCClient() error { + + var err error + + if s.metadata.tlsCertFile != "" { + certFile := fmt.Sprintf("/grpccerts/%s", s.metadata.tlsCertFile) + creds, err := credentials.NewClientTLSFromFile(certFile, "") + if err != nil { + return err + } + s.grpcConnection, err = grpc.Dial(s.metadata.scalerAddress, grpc.WithTransportCredentials(creds)) + } else { + s.grpcConnection, err = grpc.Dial(s.metadata.scalerAddress, grpc.WithInsecure()) + } + + if err != nil { + return fmt.Errorf("cannot connect to external scaler over grpc interface: %s", err) + } + + s.grpcClient = pb.NewExternalScalerClient(s.grpcConnection) + + return nil +} diff --git a/pkg/scalers/external_scaler_test.go b/pkg/scalers/external_scaler_test.go new file mode 100644 index 00000000000..f8e948e2024 --- /dev/null +++ b/pkg/scalers/external_scaler_test.go @@ -0,0 +1,32 @@ +package scalers + +import ( + "testing" +) + +var testExternalScalerResolvedEnv map[string]string + +type parseExternalScalerMetadataTestData struct { + metadata map[string]string + isError bool +} + +var testExternalScalerMetadata = []parseExternalScalerMetadataTestData{ + {map[string]string{}, true}, + // all properly formed + {map[string]string{"scalerAddress": "myservice", "test1": "7", "test2": "SAMPLE_CREDS"}, false}, + // missing scalerAddress + {map[string]string{"test1": "1", "test2": "SAMPLE_CREDS"}, true}, +} + +func TestExternalScalerParseMetadata(t *testing.T) { + for _, testData := range testExternalScalerMetadata { + _, err := parseExternalScalerMetadata(testData.metadata, testExternalScalerResolvedEnv) + if err != nil && !testData.isError { + t.Error("Expected success but got error", err) + } + if testData.isError && err == nil { + t.Error("Expected error but got success") + } + } +} diff --git a/pkg/scalers/externalscaler/externalscaler.pb.go b/pkg/scalers/externalscaler/externalscaler.pb.go new file mode 100644 index 00000000000..6263daec943 --- /dev/null +++ b/pkg/scalers/externalscaler/externalscaler.pb.go @@ -0,0 +1,651 @@ +// Code generated by protoc-gen-go. DO NOT EDIT. +// source: externalscaler.proto + +package externalscaler + +import ( + context "context" + fmt "fmt" + proto "github.com/golang/protobuf/proto" + empty "github.com/golang/protobuf/ptypes/empty" + grpc "google.golang.org/grpc" + codes "google.golang.org/grpc/codes" + status "google.golang.org/grpc/status" + math "math" +) + +// Reference imports to suppress errors if they are not otherwise used. +var _ = proto.Marshal +var _ = fmt.Errorf +var _ = math.Inf + +// This is a compile-time assertion to ensure that this generated file +// is compatible with the proto package it is being compiled against. +// A compilation error at this line likely means your copy of the +// proto package needs to be updated. +const _ = proto.ProtoPackageIsVersion3 // please upgrade the proto package + +type ScaledObjectRef struct { + Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` + Namespace string `protobuf:"bytes,2,opt,name=namespace,proto3" json:"namespace,omitempty"` + XXX_NoUnkeyedLiteral struct{} `json:"-"` + XXX_unrecognized []byte `json:"-"` + XXX_sizecache int32 `json:"-"` +} + +func (m *ScaledObjectRef) Reset() { *m = ScaledObjectRef{} } +func (m *ScaledObjectRef) String() string { return proto.CompactTextString(m) } +func (*ScaledObjectRef) ProtoMessage() {} +func (*ScaledObjectRef) Descriptor() ([]byte, []int) { + return fileDescriptor_3d382708546499d1, []int{0} +} + +func (m *ScaledObjectRef) XXX_Unmarshal(b []byte) error { + return xxx_messageInfo_ScaledObjectRef.Unmarshal(m, b) +} +func (m *ScaledObjectRef) XXX_Marshal(b []byte, deterministic bool) ([]byte, error) { + return xxx_messageInfo_ScaledObjectRef.Marshal(b, m, deterministic) +} +func (m *ScaledObjectRef) XXX_Merge(src proto.Message) { + xxx_messageInfo_ScaledObjectRef.Merge(m, src) +} +func (m *ScaledObjectRef) XXX_Size() int { + return xxx_messageInfo_ScaledObjectRef.Size(m) +} +func (m *ScaledObjectRef) XXX_DiscardUnknown() { + xxx_messageInfo_ScaledObjectRef.DiscardUnknown(m) +} + +var xxx_messageInfo_ScaledObjectRef proto.InternalMessageInfo + +func (m *ScaledObjectRef) GetName() string { + if m != nil { + return m.Name + } + return "" +} + +func (m *ScaledObjectRef) GetNamespace() string { + if m != nil { + return m.Namespace + } + return "" +} + +type NewRequest struct { + ScaledObjectRef *ScaledObjectRef `protobuf:"bytes,1,opt,name=scaledObjectRef,proto3" json:"scaledObjectRef,omitempty"` + Metadata map[string]string `protobuf:"bytes,2,rep,name=metadata,proto3" json:"metadata,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"` + XXX_NoUnkeyedLiteral struct{} `json:"-"` + XXX_unrecognized []byte `json:"-"` + XXX_sizecache int32 `json:"-"` +} + +func (m *NewRequest) Reset() { *m = NewRequest{} } +func (m *NewRequest) String() string { return proto.CompactTextString(m) } +func (*NewRequest) ProtoMessage() {} +func (*NewRequest) Descriptor() ([]byte, []int) { + return fileDescriptor_3d382708546499d1, []int{1} +} + +func (m *NewRequest) XXX_Unmarshal(b []byte) error { + return xxx_messageInfo_NewRequest.Unmarshal(m, b) +} +func (m *NewRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error) { + return xxx_messageInfo_NewRequest.Marshal(b, m, deterministic) +} +func (m *NewRequest) XXX_Merge(src proto.Message) { + xxx_messageInfo_NewRequest.Merge(m, src) +} +func (m *NewRequest) XXX_Size() int { + return xxx_messageInfo_NewRequest.Size(m) +} +func (m *NewRequest) XXX_DiscardUnknown() { + xxx_messageInfo_NewRequest.DiscardUnknown(m) +} + +var xxx_messageInfo_NewRequest proto.InternalMessageInfo + +func (m *NewRequest) GetScaledObjectRef() *ScaledObjectRef { + if m != nil { + return m.ScaledObjectRef + } + return nil +} + +func (m *NewRequest) GetMetadata() map[string]string { + if m != nil { + return m.Metadata + } + return nil +} + +type IsActiveResponse struct { + Result bool `protobuf:"varint,1,opt,name=result,proto3" json:"result,omitempty"` + XXX_NoUnkeyedLiteral struct{} `json:"-"` + XXX_unrecognized []byte `json:"-"` + XXX_sizecache int32 `json:"-"` +} + +func (m *IsActiveResponse) Reset() { *m = IsActiveResponse{} } +func (m *IsActiveResponse) String() string { return proto.CompactTextString(m) } +func (*IsActiveResponse) ProtoMessage() {} +func (*IsActiveResponse) Descriptor() ([]byte, []int) { + return fileDescriptor_3d382708546499d1, []int{2} +} + +func (m *IsActiveResponse) XXX_Unmarshal(b []byte) error { + return xxx_messageInfo_IsActiveResponse.Unmarshal(m, b) +} +func (m *IsActiveResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error) { + return xxx_messageInfo_IsActiveResponse.Marshal(b, m, deterministic) +} +func (m *IsActiveResponse) XXX_Merge(src proto.Message) { + xxx_messageInfo_IsActiveResponse.Merge(m, src) +} +func (m *IsActiveResponse) XXX_Size() int { + return xxx_messageInfo_IsActiveResponse.Size(m) +} +func (m *IsActiveResponse) XXX_DiscardUnknown() { + xxx_messageInfo_IsActiveResponse.DiscardUnknown(m) +} + +var xxx_messageInfo_IsActiveResponse proto.InternalMessageInfo + +func (m *IsActiveResponse) GetResult() bool { + if m != nil { + return m.Result + } + return false +} + +type GetMetricSpecResponse struct { + MetricSpecs []*MetricSpec `protobuf:"bytes,1,rep,name=metricSpecs,proto3" json:"metricSpecs,omitempty"` + XXX_NoUnkeyedLiteral struct{} `json:"-"` + XXX_unrecognized []byte `json:"-"` + XXX_sizecache int32 `json:"-"` +} + +func (m *GetMetricSpecResponse) Reset() { *m = GetMetricSpecResponse{} } +func (m *GetMetricSpecResponse) String() string { return proto.CompactTextString(m) } +func (*GetMetricSpecResponse) ProtoMessage() {} +func (*GetMetricSpecResponse) Descriptor() ([]byte, []int) { + return fileDescriptor_3d382708546499d1, []int{3} +} + +func (m *GetMetricSpecResponse) XXX_Unmarshal(b []byte) error { + return xxx_messageInfo_GetMetricSpecResponse.Unmarshal(m, b) +} +func (m *GetMetricSpecResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error) { + return xxx_messageInfo_GetMetricSpecResponse.Marshal(b, m, deterministic) +} +func (m *GetMetricSpecResponse) XXX_Merge(src proto.Message) { + xxx_messageInfo_GetMetricSpecResponse.Merge(m, src) +} +func (m *GetMetricSpecResponse) XXX_Size() int { + return xxx_messageInfo_GetMetricSpecResponse.Size(m) +} +func (m *GetMetricSpecResponse) XXX_DiscardUnknown() { + xxx_messageInfo_GetMetricSpecResponse.DiscardUnknown(m) +} + +var xxx_messageInfo_GetMetricSpecResponse proto.InternalMessageInfo + +func (m *GetMetricSpecResponse) GetMetricSpecs() []*MetricSpec { + if m != nil { + return m.MetricSpecs + } + return nil +} + +type MetricSpec struct { + MetricName string `protobuf:"bytes,1,opt,name=metricName,proto3" json:"metricName,omitempty"` + TargetSize int64 `protobuf:"varint,2,opt,name=targetSize,proto3" json:"targetSize,omitempty"` + XXX_NoUnkeyedLiteral struct{} `json:"-"` + XXX_unrecognized []byte `json:"-"` + XXX_sizecache int32 `json:"-"` +} + +func (m *MetricSpec) Reset() { *m = MetricSpec{} } +func (m *MetricSpec) String() string { return proto.CompactTextString(m) } +func (*MetricSpec) ProtoMessage() {} +func (*MetricSpec) Descriptor() ([]byte, []int) { + return fileDescriptor_3d382708546499d1, []int{4} +} + +func (m *MetricSpec) XXX_Unmarshal(b []byte) error { + return xxx_messageInfo_MetricSpec.Unmarshal(m, b) +} +func (m *MetricSpec) XXX_Marshal(b []byte, deterministic bool) ([]byte, error) { + return xxx_messageInfo_MetricSpec.Marshal(b, m, deterministic) +} +func (m *MetricSpec) XXX_Merge(src proto.Message) { + xxx_messageInfo_MetricSpec.Merge(m, src) +} +func (m *MetricSpec) XXX_Size() int { + return xxx_messageInfo_MetricSpec.Size(m) +} +func (m *MetricSpec) XXX_DiscardUnknown() { + xxx_messageInfo_MetricSpec.DiscardUnknown(m) +} + +var xxx_messageInfo_MetricSpec proto.InternalMessageInfo + +func (m *MetricSpec) GetMetricName() string { + if m != nil { + return m.MetricName + } + return "" +} + +func (m *MetricSpec) GetTargetSize() int64 { + if m != nil { + return m.TargetSize + } + return 0 +} + +type GetMetricsRequest struct { + ScaledObjectRef *ScaledObjectRef `protobuf:"bytes,1,opt,name=scaledObjectRef,proto3" json:"scaledObjectRef,omitempty"` + MetricName string `protobuf:"bytes,2,opt,name=metricName,proto3" json:"metricName,omitempty"` + XXX_NoUnkeyedLiteral struct{} `json:"-"` + XXX_unrecognized []byte `json:"-"` + XXX_sizecache int32 `json:"-"` +} + +func (m *GetMetricsRequest) Reset() { *m = GetMetricsRequest{} } +func (m *GetMetricsRequest) String() string { return proto.CompactTextString(m) } +func (*GetMetricsRequest) ProtoMessage() {} +func (*GetMetricsRequest) Descriptor() ([]byte, []int) { + return fileDescriptor_3d382708546499d1, []int{5} +} + +func (m *GetMetricsRequest) XXX_Unmarshal(b []byte) error { + return xxx_messageInfo_GetMetricsRequest.Unmarshal(m, b) +} +func (m *GetMetricsRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error) { + return xxx_messageInfo_GetMetricsRequest.Marshal(b, m, deterministic) +} +func (m *GetMetricsRequest) XXX_Merge(src proto.Message) { + xxx_messageInfo_GetMetricsRequest.Merge(m, src) +} +func (m *GetMetricsRequest) XXX_Size() int { + return xxx_messageInfo_GetMetricsRequest.Size(m) +} +func (m *GetMetricsRequest) XXX_DiscardUnknown() { + xxx_messageInfo_GetMetricsRequest.DiscardUnknown(m) +} + +var xxx_messageInfo_GetMetricsRequest proto.InternalMessageInfo + +func (m *GetMetricsRequest) GetScaledObjectRef() *ScaledObjectRef { + if m != nil { + return m.ScaledObjectRef + } + return nil +} + +func (m *GetMetricsRequest) GetMetricName() string { + if m != nil { + return m.MetricName + } + return "" +} + +type GetMetricsResponse struct { + MetricValues []*MetricValue `protobuf:"bytes,1,rep,name=metricValues,proto3" json:"metricValues,omitempty"` + XXX_NoUnkeyedLiteral struct{} `json:"-"` + XXX_unrecognized []byte `json:"-"` + XXX_sizecache int32 `json:"-"` +} + +func (m *GetMetricsResponse) Reset() { *m = GetMetricsResponse{} } +func (m *GetMetricsResponse) String() string { return proto.CompactTextString(m) } +func (*GetMetricsResponse) ProtoMessage() {} +func (*GetMetricsResponse) Descriptor() ([]byte, []int) { + return fileDescriptor_3d382708546499d1, []int{6} +} + +func (m *GetMetricsResponse) XXX_Unmarshal(b []byte) error { + return xxx_messageInfo_GetMetricsResponse.Unmarshal(m, b) +} +func (m *GetMetricsResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error) { + return xxx_messageInfo_GetMetricsResponse.Marshal(b, m, deterministic) +} +func (m *GetMetricsResponse) XXX_Merge(src proto.Message) { + xxx_messageInfo_GetMetricsResponse.Merge(m, src) +} +func (m *GetMetricsResponse) XXX_Size() int { + return xxx_messageInfo_GetMetricsResponse.Size(m) +} +func (m *GetMetricsResponse) XXX_DiscardUnknown() { + xxx_messageInfo_GetMetricsResponse.DiscardUnknown(m) +} + +var xxx_messageInfo_GetMetricsResponse proto.InternalMessageInfo + +func (m *GetMetricsResponse) GetMetricValues() []*MetricValue { + if m != nil { + return m.MetricValues + } + return nil +} + +type MetricValue struct { + MetricName string `protobuf:"bytes,1,opt,name=metricName,proto3" json:"metricName,omitempty"` + MetricValue int64 `protobuf:"varint,2,opt,name=metricValue,proto3" json:"metricValue,omitempty"` + XXX_NoUnkeyedLiteral struct{} `json:"-"` + XXX_unrecognized []byte `json:"-"` + XXX_sizecache int32 `json:"-"` +} + +func (m *MetricValue) Reset() { *m = MetricValue{} } +func (m *MetricValue) String() string { return proto.CompactTextString(m) } +func (*MetricValue) ProtoMessage() {} +func (*MetricValue) Descriptor() ([]byte, []int) { + return fileDescriptor_3d382708546499d1, []int{7} +} + +func (m *MetricValue) XXX_Unmarshal(b []byte) error { + return xxx_messageInfo_MetricValue.Unmarshal(m, b) +} +func (m *MetricValue) XXX_Marshal(b []byte, deterministic bool) ([]byte, error) { + return xxx_messageInfo_MetricValue.Marshal(b, m, deterministic) +} +func (m *MetricValue) XXX_Merge(src proto.Message) { + xxx_messageInfo_MetricValue.Merge(m, src) +} +func (m *MetricValue) XXX_Size() int { + return xxx_messageInfo_MetricValue.Size(m) +} +func (m *MetricValue) XXX_DiscardUnknown() { + xxx_messageInfo_MetricValue.DiscardUnknown(m) +} + +var xxx_messageInfo_MetricValue proto.InternalMessageInfo + +func (m *MetricValue) GetMetricName() string { + if m != nil { + return m.MetricName + } + return "" +} + +func (m *MetricValue) GetMetricValue() int64 { + if m != nil { + return m.MetricValue + } + return 0 +} + +func init() { + proto.RegisterType((*ScaledObjectRef)(nil), "externalscaler.ScaledObjectRef") + proto.RegisterType((*NewRequest)(nil), "externalscaler.NewRequest") + proto.RegisterMapType((map[string]string)(nil), "externalscaler.NewRequest.MetadataEntry") + proto.RegisterType((*IsActiveResponse)(nil), "externalscaler.IsActiveResponse") + proto.RegisterType((*GetMetricSpecResponse)(nil), "externalscaler.GetMetricSpecResponse") + proto.RegisterType((*MetricSpec)(nil), "externalscaler.MetricSpec") + proto.RegisterType((*GetMetricsRequest)(nil), "externalscaler.GetMetricsRequest") + proto.RegisterType((*GetMetricsResponse)(nil), "externalscaler.GetMetricsResponse") + proto.RegisterType((*MetricValue)(nil), "externalscaler.MetricValue") +} + +func init() { proto.RegisterFile("externalscaler.proto", fileDescriptor_3d382708546499d1) } + +var fileDescriptor_3d382708546499d1 = []byte{ + // 484 bytes of a gzipped FileDescriptorProto + 0x1f, 0x8b, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0xff, 0xb4, 0x53, 0x4d, 0x6f, 0xd3, 0x40, + 0x10, 0x8d, 0x63, 0x5a, 0xa5, 0x13, 0xfa, 0xc1, 0xa8, 0x54, 0x91, 0x8b, 0x20, 0xac, 0x84, 0x14, + 0x71, 0x70, 0xa5, 0x70, 0x41, 0x14, 0x09, 0x41, 0x89, 0x50, 0x25, 0x9a, 0x48, 0x1b, 0xa5, 0x12, + 0xc7, 0x8d, 0x3b, 0x8d, 0x02, 0x4e, 0x6c, 0xbc, 0xeb, 0x96, 0x70, 0xe0, 0x57, 0xf0, 0xeb, 0xf8, + 0x35, 0xc8, 0xeb, 0xef, 0x55, 0x43, 0xb8, 0xf4, 0x64, 0xef, 0xbc, 0x37, 0xb3, 0xf3, 0xde, 0xcc, + 0xc2, 0x21, 0xfd, 0x50, 0x14, 0x2d, 0x85, 0x2f, 0x3d, 0xe1, 0x53, 0xe4, 0x86, 0x51, 0xa0, 0x02, + 0xdc, 0xab, 0x47, 0x9d, 0xe3, 0x59, 0x10, 0xcc, 0x7c, 0x3a, 0xd1, 0xe8, 0x34, 0xbe, 0x3e, 0xa1, + 0x45, 0xa8, 0x56, 0x29, 0x99, 0x9d, 0xc1, 0xfe, 0x38, 0xa1, 0x5d, 0x8d, 0xa6, 0x5f, 0xc9, 0x53, + 0x9c, 0xae, 0x11, 0xe1, 0xc1, 0x52, 0x2c, 0xa8, 0x63, 0x75, 0xad, 0xde, 0x0e, 0xd7, 0xff, 0xf8, + 0x04, 0x76, 0x92, 0xaf, 0x0c, 0x85, 0x47, 0x9d, 0xa6, 0x06, 0xca, 0x00, 0xfb, 0x63, 0x01, 0x0c, + 0xe9, 0x96, 0xd3, 0xf7, 0x98, 0xa4, 0xc2, 0x73, 0xd8, 0x97, 0xf5, 0x9a, 0xba, 0x56, 0xbb, 0xff, + 0xcc, 0x35, 0x1a, 0x36, 0xae, 0xe6, 0x66, 0x1e, 0x7e, 0x84, 0xd6, 0x82, 0x94, 0xb8, 0x12, 0x4a, + 0x74, 0x9a, 0x5d, 0xbb, 0xd7, 0xee, 0xf7, 0xcc, 0x1a, 0xe5, 0xc5, 0xee, 0x45, 0x46, 0x1d, 0x2c, + 0x55, 0xb4, 0xe2, 0x45, 0xa6, 0x73, 0x0a, 0xbb, 0x35, 0x08, 0x0f, 0xc0, 0xfe, 0x46, 0xab, 0x4c, + 0x61, 0xf2, 0x8b, 0x87, 0xb0, 0x75, 0x23, 0xfc, 0x38, 0x17, 0x97, 0x1e, 0xde, 0x34, 0x5f, 0x5b, + 0xec, 0x25, 0x1c, 0x9c, 0xcb, 0xf7, 0x9e, 0x9a, 0xdf, 0x10, 0x27, 0x19, 0x06, 0x4b, 0x49, 0x78, + 0x04, 0xdb, 0x11, 0xc9, 0xd8, 0x57, 0xba, 0x44, 0x8b, 0x67, 0x27, 0x36, 0x81, 0xc7, 0x9f, 0x48, + 0x5d, 0x90, 0x8a, 0xe6, 0xde, 0x38, 0x24, 0xaf, 0x48, 0x78, 0x0b, 0xed, 0x45, 0x11, 0x95, 0x1d, + 0x4b, 0x4b, 0x71, 0x4c, 0x29, 0x95, 0xc4, 0x2a, 0x9d, 0x7d, 0x06, 0x28, 0x21, 0x7c, 0x0a, 0x90, + 0x82, 0xc3, 0x72, 0x4a, 0x95, 0x48, 0x82, 0x2b, 0x11, 0xcd, 0x48, 0x8d, 0xe7, 0x3f, 0x53, 0x3d, + 0x36, 0xaf, 0x44, 0xd8, 0x2f, 0x78, 0x54, 0x34, 0x29, 0xef, 0x61, 0x66, 0xf5, 0xfe, 0x9a, 0x66, + 0x7f, 0x6c, 0x02, 0x58, 0xbd, 0x3f, 0x73, 0xe8, 0x1d, 0x3c, 0x4c, 0x39, 0x97, 0x89, 0xf3, 0xb9, + 0x45, 0xc7, 0x77, 0x5b, 0xa4, 0x39, 0xbc, 0x96, 0xc0, 0x46, 0xd0, 0xae, 0x80, 0x1b, 0x5d, 0xea, + 0xe6, 0x13, 0xb9, 0x2c, 0xc6, 0x6e, 0xf3, 0x6a, 0xa8, 0xff, 0xdb, 0x86, 0xbd, 0x41, 0x76, 0xbb, + 0x16, 0x1d, 0xe1, 0x29, 0xd8, 0x43, 0xba, 0x45, 0x67, 0xfd, 0x0e, 0x3a, 0x47, 0x6e, 0xfa, 0xdc, + 0xdc, 0xfc, 0xb9, 0xb9, 0x83, 0xe4, 0xb9, 0xb1, 0x06, 0x8e, 0xa0, 0x95, 0x2f, 0x12, 0x6e, 0x72, + 0xd5, 0xe9, 0x9a, 0x04, 0x73, 0x07, 0x59, 0x03, 0xbf, 0xc0, 0x6e, 0x6d, 0xdb, 0x36, 0x57, 0x7d, + 0x61, 0x12, 0xee, 0xdc, 0x56, 0xd6, 0xc0, 0x09, 0x40, 0x39, 0x23, 0x7c, 0xbe, 0x36, 0x2d, 0xdf, + 0x1f, 0x87, 0xfd, 0x8b, 0x52, 0x94, 0xfd, 0x00, 0x5b, 0x67, 0x7e, 0x20, 0xff, 0x43, 0xff, 0x5a, + 0x1b, 0xa7, 0xdb, 0x3a, 0xf2, 0xea, 0x6f, 0x00, 0x00, 0x00, 0xff, 0xff, 0x69, 0x62, 0xa3, 0x07, + 0xfd, 0x04, 0x00, 0x00, +} + +// Reference imports to suppress errors if they are not otherwise used. +var _ context.Context +var _ grpc.ClientConn + +// This is a compile-time assertion to ensure that this generated file +// is compatible with the grpc package it is being compiled against. +const _ = grpc.SupportPackageIsVersion4 + +// ExternalScalerClient is the client API for ExternalScaler service. +// +// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream. +type ExternalScalerClient interface { + New(ctx context.Context, in *NewRequest, opts ...grpc.CallOption) (*empty.Empty, error) + IsActive(ctx context.Context, in *ScaledObjectRef, opts ...grpc.CallOption) (*IsActiveResponse, error) + GetMetricSpec(ctx context.Context, in *ScaledObjectRef, opts ...grpc.CallOption) (*GetMetricSpecResponse, error) + GetMetrics(ctx context.Context, in *GetMetricsRequest, opts ...grpc.CallOption) (*GetMetricsResponse, error) + Close(ctx context.Context, in *ScaledObjectRef, opts ...grpc.CallOption) (*empty.Empty, error) +} + +type externalScalerClient struct { + cc *grpc.ClientConn +} + +func NewExternalScalerClient(cc *grpc.ClientConn) ExternalScalerClient { + return &externalScalerClient{cc} +} + +func (c *externalScalerClient) New(ctx context.Context, in *NewRequest, opts ...grpc.CallOption) (*empty.Empty, error) { + out := new(empty.Empty) + err := c.cc.Invoke(ctx, "/externalscaler.ExternalScaler/New", in, out, opts...) + if err != nil { + return nil, err + } + return out, nil +} + +func (c *externalScalerClient) IsActive(ctx context.Context, in *ScaledObjectRef, opts ...grpc.CallOption) (*IsActiveResponse, error) { + out := new(IsActiveResponse) + err := c.cc.Invoke(ctx, "/externalscaler.ExternalScaler/IsActive", in, out, opts...) + if err != nil { + return nil, err + } + return out, nil +} + +func (c *externalScalerClient) GetMetricSpec(ctx context.Context, in *ScaledObjectRef, opts ...grpc.CallOption) (*GetMetricSpecResponse, error) { + out := new(GetMetricSpecResponse) + err := c.cc.Invoke(ctx, "/externalscaler.ExternalScaler/GetMetricSpec", in, out, opts...) + if err != nil { + return nil, err + } + return out, nil +} + +func (c *externalScalerClient) GetMetrics(ctx context.Context, in *GetMetricsRequest, opts ...grpc.CallOption) (*GetMetricsResponse, error) { + out := new(GetMetricsResponse) + err := c.cc.Invoke(ctx, "/externalscaler.ExternalScaler/GetMetrics", in, out, opts...) + if err != nil { + return nil, err + } + return out, nil +} + +func (c *externalScalerClient) Close(ctx context.Context, in *ScaledObjectRef, opts ...grpc.CallOption) (*empty.Empty, error) { + out := new(empty.Empty) + err := c.cc.Invoke(ctx, "/externalscaler.ExternalScaler/Close", in, out, opts...) + if err != nil { + return nil, err + } + return out, nil +} + +// ExternalScalerServer is the server API for ExternalScaler service. +type ExternalScalerServer interface { + New(context.Context, *NewRequest) (*empty.Empty, error) + IsActive(context.Context, *ScaledObjectRef) (*IsActiveResponse, error) + GetMetricSpec(context.Context, *ScaledObjectRef) (*GetMetricSpecResponse, error) + GetMetrics(context.Context, *GetMetricsRequest) (*GetMetricsResponse, error) + Close(context.Context, *ScaledObjectRef) (*empty.Empty, error) +} + +// UnimplementedExternalScalerServer can be embedded to have forward compatible implementations. +type UnimplementedExternalScalerServer struct { +} + +func (*UnimplementedExternalScalerServer) New(ctx context.Context, req *NewRequest) (*empty.Empty, error) { + return nil, status.Errorf(codes.Unimplemented, "method New not implemented") +} +func (*UnimplementedExternalScalerServer) IsActive(ctx context.Context, req *ScaledObjectRef) (*IsActiveResponse, error) { + return nil, status.Errorf(codes.Unimplemented, "method IsActive not implemented") +} +func (*UnimplementedExternalScalerServer) GetMetricSpec(ctx context.Context, req *ScaledObjectRef) (*GetMetricSpecResponse, error) { + return nil, status.Errorf(codes.Unimplemented, "method GetMetricSpec not implemented") +} +func (*UnimplementedExternalScalerServer) GetMetrics(ctx context.Context, req *GetMetricsRequest) (*GetMetricsResponse, error) { + return nil, status.Errorf(codes.Unimplemented, "method GetMetrics not implemented") +} +func (*UnimplementedExternalScalerServer) Close(ctx context.Context, req *ScaledObjectRef) (*empty.Empty, error) { + return nil, status.Errorf(codes.Unimplemented, "method Close not implemented") +} + +func RegisterExternalScalerServer(s *grpc.Server, srv ExternalScalerServer) { + s.RegisterService(&_ExternalScaler_serviceDesc, srv) +} + +func _ExternalScaler_New_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) { + in := new(NewRequest) + if err := dec(in); err != nil { + return nil, err + } + if interceptor == nil { + return srv.(ExternalScalerServer).New(ctx, in) + } + info := &grpc.UnaryServerInfo{ + Server: srv, + FullMethod: "/externalscaler.ExternalScaler/New", + } + handler := func(ctx context.Context, req interface{}) (interface{}, error) { + return srv.(ExternalScalerServer).New(ctx, req.(*NewRequest)) + } + return interceptor(ctx, in, info, handler) +} + +func _ExternalScaler_IsActive_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) { + in := new(ScaledObjectRef) + if err := dec(in); err != nil { + return nil, err + } + if interceptor == nil { + return srv.(ExternalScalerServer).IsActive(ctx, in) + } + info := &grpc.UnaryServerInfo{ + Server: srv, + FullMethod: "/externalscaler.ExternalScaler/IsActive", + } + handler := func(ctx context.Context, req interface{}) (interface{}, error) { + return srv.(ExternalScalerServer).IsActive(ctx, req.(*ScaledObjectRef)) + } + return interceptor(ctx, in, info, handler) +} + +func _ExternalScaler_GetMetricSpec_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) { + in := new(ScaledObjectRef) + if err := dec(in); err != nil { + return nil, err + } + if interceptor == nil { + return srv.(ExternalScalerServer).GetMetricSpec(ctx, in) + } + info := &grpc.UnaryServerInfo{ + Server: srv, + FullMethod: "/externalscaler.ExternalScaler/GetMetricSpec", + } + handler := func(ctx context.Context, req interface{}) (interface{}, error) { + return srv.(ExternalScalerServer).GetMetricSpec(ctx, req.(*ScaledObjectRef)) + } + return interceptor(ctx, in, info, handler) +} + +func _ExternalScaler_GetMetrics_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) { + in := new(GetMetricsRequest) + if err := dec(in); err != nil { + return nil, err + } + if interceptor == nil { + return srv.(ExternalScalerServer).GetMetrics(ctx, in) + } + info := &grpc.UnaryServerInfo{ + Server: srv, + FullMethod: "/externalscaler.ExternalScaler/GetMetrics", + } + handler := func(ctx context.Context, req interface{}) (interface{}, error) { + return srv.(ExternalScalerServer).GetMetrics(ctx, req.(*GetMetricsRequest)) + } + return interceptor(ctx, in, info, handler) +} + +func _ExternalScaler_Close_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) { + in := new(ScaledObjectRef) + if err := dec(in); err != nil { + return nil, err + } + if interceptor == nil { + return srv.(ExternalScalerServer).Close(ctx, in) + } + info := &grpc.UnaryServerInfo{ + Server: srv, + FullMethod: "/externalscaler.ExternalScaler/Close", + } + handler := func(ctx context.Context, req interface{}) (interface{}, error) { + return srv.(ExternalScalerServer).Close(ctx, req.(*ScaledObjectRef)) + } + return interceptor(ctx, in, info, handler) +} + +var _ExternalScaler_serviceDesc = grpc.ServiceDesc{ + ServiceName: "externalscaler.ExternalScaler", + HandlerType: (*ExternalScalerServer)(nil), + Methods: []grpc.MethodDesc{ + { + MethodName: "New", + Handler: _ExternalScaler_New_Handler, + }, + { + MethodName: "IsActive", + Handler: _ExternalScaler_IsActive_Handler, + }, + { + MethodName: "GetMetricSpec", + Handler: _ExternalScaler_GetMetricSpec_Handler, + }, + { + MethodName: "GetMetrics", + Handler: _ExternalScaler_GetMetrics_Handler, + }, + { + MethodName: "Close", + Handler: _ExternalScaler_Close_Handler, + }, + }, + Streams: []grpc.StreamDesc{}, + Metadata: "externalscaler.proto", +} diff --git a/pkg/scalers/externalscaler/externalscaler.proto b/pkg/scalers/externalscaler/externalscaler.proto new file mode 100644 index 00000000000..b72d2242c10 --- /dev/null +++ b/pkg/scalers/externalscaler/externalscaler.proto @@ -0,0 +1,50 @@ +syntax = "proto3"; + +package externalscaler; + +import "google/protobuf/empty.proto"; + +service ExternalScaler { + rpc New(NewRequest) returns (google.protobuf.Empty) {} + rpc IsActive(ScaledObjectRef) returns (IsActiveResponse) {} + rpc GetMetricSpec(ScaledObjectRef) returns (GetMetricSpecResponse) {} + rpc GetMetrics(GetMetricsRequest) returns (GetMetricsResponse) {} + rpc Close(ScaledObjectRef) returns (google.protobuf.Empty) {} +} + +message ScaledObjectRef { + string name = 1; + string namespace = 2; +} + +message NewRequest { + ScaledObjectRef scaledObjectRef = 1; + map metadata = 2; +} + +message IsActiveResponse { + bool result = 1; +} + +message GetMetricSpecResponse { + repeated MetricSpec metricSpecs = 1; +} + +message MetricSpec { + string metricName = 1; + int64 targetSize = 2; +} + +message GetMetricsRequest { + ScaledObjectRef scaledObjectRef = 1; + string metricName = 2; +} + +message GetMetricsResponse { + repeated MetricValue metricValues = 1; +} + +message MetricValue { + string metricName = 1; + int64 metricValue = 2; +}