istio: istio.io/istio/mixer/template/edge Index | Files

package edge

import "istio.io/istio/mixer/template/edge"

Index

Package Files

template_handler.gen.go template_handler_service.pb.go

Constants

const TemplateName = "edge"

Fully qualified name of the template

Variables

var (
    ErrInvalidLengthTemplateHandlerService = fmt.Errorf("proto: negative length found during unmarshaling")
    ErrIntOverflowTemplateHandlerService   = fmt.Errorf("proto: integer overflow")
)

func RegisterHandleEdgeServiceServer Uses

func RegisterHandleEdgeServiceServer(s *grpc.Server, srv HandleEdgeServiceServer)

type HandleEdgeRequest Uses

type HandleEdgeRequest struct {
    // 'edge' instances.
    Instances []*InstanceMsg `protobuf:"bytes,1,rep,name=instances,proto3" json:"instances,omitempty"`
    // Adapter specific handler configuration.
    //
    // Note: Backends can also implement [InfrastructureBackend][https://istio.io/docs/reference/config/mixer/istio.mixer.adapter.model.v1beta1.html#InfrastructureBackend]
    // service and therefore opt to receive handler configuration during session creation through [InfrastructureBackend.CreateSession][TODO: Link to this fragment]
    // call. In that case, adapter_config will have type_url as 'google.protobuf.Any.type_url' and would contain string
    // value of session_id (returned from InfrastructureBackend.CreateSession).
    AdapterConfig *types.Any `protobuf:"bytes,2,opt,name=adapter_config,json=adapterConfig,proto3" json:"adapter_config,omitempty"`
    // Id to dedupe identical requests from Mixer.
    DedupId string `protobuf:"bytes,3,opt,name=dedup_id,json=dedupId,proto3" json:"dedup_id,omitempty"`
}

Request message for HandleEdge method.

func (*HandleEdgeRequest) Descriptor Uses

func (*HandleEdgeRequest) Descriptor() ([]byte, []int)

func (*HandleEdgeRequest) Marshal Uses

func (m *HandleEdgeRequest) Marshal() (dAtA []byte, err error)

func (*HandleEdgeRequest) MarshalTo Uses

func (m *HandleEdgeRequest) MarshalTo(dAtA []byte) (int, error)

func (*HandleEdgeRequest) MarshalToSizedBuffer Uses

func (m *HandleEdgeRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*HandleEdgeRequest) ProtoMessage Uses

func (*HandleEdgeRequest) ProtoMessage()

func (*HandleEdgeRequest) Reset Uses

func (m *HandleEdgeRequest) Reset()

func (*HandleEdgeRequest) Size Uses

func (m *HandleEdgeRequest) Size() (n int)

func (*HandleEdgeRequest) String Uses

func (this *HandleEdgeRequest) String() string

func (*HandleEdgeRequest) Unmarshal Uses

func (m *HandleEdgeRequest) Unmarshal(dAtA []byte) error

func (*HandleEdgeRequest) XXX_DiscardUnknown Uses

func (m *HandleEdgeRequest) XXX_DiscardUnknown()

func (*HandleEdgeRequest) XXX_Marshal Uses

func (m *HandleEdgeRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*HandleEdgeRequest) XXX_Merge Uses

func (m *HandleEdgeRequest) XXX_Merge(src proto.Message)

func (*HandleEdgeRequest) XXX_Size Uses

func (m *HandleEdgeRequest) XXX_Size() int

func (*HandleEdgeRequest) XXX_Unmarshal Uses

func (m *HandleEdgeRequest) XXX_Unmarshal(b []byte) error

type HandleEdgeServiceClient Uses

type HandleEdgeServiceClient interface {
    // HandleEdge is called by Mixer at request-time to deliver 'edge' instances to the backend.
    HandleEdge(ctx context.Context, in *HandleEdgeRequest, opts ...grpc.CallOption) (*v1beta11.ReportResult, error)
}

HandleEdgeServiceClient is the client API for HandleEdgeService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewHandleEdgeServiceClient Uses

func NewHandleEdgeServiceClient(cc *grpc.ClientConn) HandleEdgeServiceClient

type HandleEdgeServiceServer Uses

type HandleEdgeServiceServer interface {
    // HandleEdge is called by Mixer at request-time to deliver 'edge' instances to the backend.
    HandleEdge(context.Context, *HandleEdgeRequest) (*v1beta11.ReportResult, error)
}

HandleEdgeServiceServer is the server API for HandleEdgeService service.

type Handler Uses

type Handler interface {
    adapter.Handler

    // HandleEdge is called by Mixer at request time to deliver instances to
    // to an adapter.
    HandleEdge(context.Context, []*Instance) error
}

Handler must be implemented by adapter code if it wants to process data associated with the 'edge' template.

Mixer uses this interface to call into the adapter at request time in order to dispatch created instances to the adapter. Adapters take the incoming instances and do what they need to achieve their primary function.

The name of each instance can be used as a key into the Type map supplied to the adapter at configuration time via the method 'SetEdgeTypes'. These Type associated with an instance describes the shape of the instance

type HandlerBuilder Uses

type HandlerBuilder interface {
    adapter.HandlerBuilder

    // SetEdgeTypes is invoked by Mixer to pass the template-specific Type information for instances that an adapter
    // may receive at runtime. The type information describes the shape of the instance.
    SetEdgeTypes(map[string]*Type)
}

HandlerBuilder must be implemented by adapters if they want to process data associated with the 'edge' template.

Mixer uses this interface to call into the adapter at configuration time to configure it with adapter-specific configuration as well as all template-specific type information.

type Instance Uses

type Instance struct {
    // Name of the instance as specified in configuration.
    Name string

    // Timestamp of the edge
    Timestamp time.Time

    // Namespace of the source workload
    SourceWorkloadNamespace string

    // Name of the source workload
    SourceWorkloadName string

    // Owner of the source workload (often k8s deployment)
    SourceOwner string

    // UID of the source workload
    SourceUid string

    // Namespace of the destination workload
    DestinationWorkloadNamespace string

    // Name of the destination workload
    DestinationWorkloadName string

    // Owner of the destination workload (often k8s deployment)
    DestinationOwner string

    // UID of the destination workload
    DestinationUid string

    // Namespace of the destination Service
    DestinationServiceNamespace string

    // Name of the destination Service
    DestinationServiceName string

    // Protocol used for communication (http, tcp)
    ContextProtocol string

    // The protocol type of the API call (http, https, grpc)
    ApiProtocol string
}

Instance is constructed by Mixer for the 'edge' template.

The `edge` template represents an edge in the mesh graph

When writing the configuration, the value for the fields associated with this template can either be a literal or an [expression](https://istio.io/docs/reference/config/policy-and-telemetry/expression-language/). Please note that if the datatype of a field is not istio.mixer.adapter.model.v1beta1.Value, then the expression's [inferred type](https://istio.io/docs/reference/config/policy-and-telemetry/expression-language/#type-checking) must match the datatype of the field.

Example config: “`yaml apiVersion: "config.istio.io/v1alpha2" kind: instance metadata:

name: default
namespace: istio-system

spec:

compiledTemplate: edge
params:
  timestamp: request.time
  sourceUid: source.uid | "Unknown"
  sourceOwner: source.owner | "Unknown"
  sourceWorkloadName: source.workload.name | "Unknown"
  sourceWorkloadNamespace: source.workload.namespace | "Unknown"
  destinationUid: destination.uid | "Unknown"
  destinationOwner: destination.owner | "Unknown"
  destinationWorkloadName: destination.workload.name | "Unknown"
  destinationWorkloadNamespace: destination.workload.namespace | "Unknown"
  destinationServiceName: destination.service.name | "Unknown"
  destinationServiceNamespace: destination.service.namespace | "Unknown"
  apiProtocol: api.protocol | "Unknown"
  contextProtocol: context.protocol | "Unknown"

“`

type InstanceMsg Uses

type InstanceMsg struct {
    // Name of the instance as specified in configuration.
    Name string `protobuf:"bytes,72295727,opt,name=name,proto3" json:"name,omitempty"`
    // Timestamp of the edge
    Timestamp *v1beta1.TimeStamp `protobuf:"bytes,1,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
    // Namespace of the source workload
    SourceWorkloadNamespace string `protobuf:"bytes,10,opt,name=source_workload_namespace,json=sourceWorkloadNamespace,proto3" json:"source_workload_namespace,omitempty"`
    // Name of the source workload
    SourceWorkloadName string `protobuf:"bytes,11,opt,name=source_workload_name,json=sourceWorkloadName,proto3" json:"source_workload_name,omitempty"`
    // Owner of the source workload (often k8s deployment)
    SourceOwner string `protobuf:"bytes,12,opt,name=source_owner,json=sourceOwner,proto3" json:"source_owner,omitempty"`
    // UID of the source workload
    SourceUid string `protobuf:"bytes,13,opt,name=source_uid,json=sourceUid,proto3" json:"source_uid,omitempty"`
    // Namespace of the destination workload
    DestinationWorkloadNamespace string `protobuf:"bytes,20,opt,name=destination_workload_namespace,json=destinationWorkloadNamespace,proto3" json:"destination_workload_namespace,omitempty"`
    // Name of the destination workload
    DestinationWorkloadName string `protobuf:"bytes,21,opt,name=destination_workload_name,json=destinationWorkloadName,proto3" json:"destination_workload_name,omitempty"`
    // Owner of the destination workload (often k8s deployment)
    DestinationOwner string `protobuf:"bytes,22,opt,name=destination_owner,json=destinationOwner,proto3" json:"destination_owner,omitempty"`
    // UID of the destination workload
    DestinationUid string `protobuf:"bytes,23,opt,name=destination_uid,json=destinationUid,proto3" json:"destination_uid,omitempty"`
    // Namespace of the destination Service
    DestinationServiceNamespace string `protobuf:"bytes,24,opt,name=destination_service_namespace,json=destinationServiceNamespace,proto3" json:"destination_service_namespace,omitempty"`
    // Name of the destination Service
    DestinationServiceName string `protobuf:"bytes,25,opt,name=destination_service_name,json=destinationServiceName,proto3" json:"destination_service_name,omitempty"`
    // Protocol used for communication (http, tcp)
    ContextProtocol string `protobuf:"bytes,30,opt,name=context_protocol,json=contextProtocol,proto3" json:"context_protocol,omitempty"`
    // The protocol type of the API call (http, https, grpc)
    ApiProtocol string `protobuf:"bytes,31,opt,name=api_protocol,json=apiProtocol,proto3" json:"api_protocol,omitempty"`
}

Contains instance payload for 'edge' template. This is passed to infrastructure backends during request-time through HandleEdgeService.HandleEdge.

func (*InstanceMsg) Descriptor Uses

func (*InstanceMsg) Descriptor() ([]byte, []int)

func (*InstanceMsg) Marshal Uses

func (m *InstanceMsg) Marshal() (dAtA []byte, err error)

func (*InstanceMsg) MarshalTo Uses

func (m *InstanceMsg) MarshalTo(dAtA []byte) (int, error)

func (*InstanceMsg) MarshalToSizedBuffer Uses

func (m *InstanceMsg) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*InstanceMsg) ProtoMessage Uses

func (*InstanceMsg) ProtoMessage()

func (*InstanceMsg) Reset Uses

func (m *InstanceMsg) Reset()

func (*InstanceMsg) Size Uses

func (m *InstanceMsg) Size() (n int)

func (*InstanceMsg) String Uses

func (this *InstanceMsg) String() string

func (*InstanceMsg) Unmarshal Uses

func (m *InstanceMsg) Unmarshal(dAtA []byte) error

func (*InstanceMsg) XXX_DiscardUnknown Uses

func (m *InstanceMsg) XXX_DiscardUnknown()

func (*InstanceMsg) XXX_Marshal Uses

func (m *InstanceMsg) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*InstanceMsg) XXX_Merge Uses

func (m *InstanceMsg) XXX_Merge(src proto.Message)

func (*InstanceMsg) XXX_Size Uses

func (m *InstanceMsg) XXX_Size() int

func (*InstanceMsg) XXX_Unmarshal Uses

func (m *InstanceMsg) XXX_Unmarshal(b []byte) error

type InstanceParam Uses

type InstanceParam struct {
    // Timestamp of the edge
    Timestamp string `protobuf:"bytes,1,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
    // Namespace of the source workload
    SourceWorkloadNamespace string `protobuf:"bytes,10,opt,name=source_workload_namespace,json=sourceWorkloadNamespace,proto3" json:"source_workload_namespace,omitempty"`
    // Name of the source workload
    SourceWorkloadName string `protobuf:"bytes,11,opt,name=source_workload_name,json=sourceWorkloadName,proto3" json:"source_workload_name,omitempty"`
    // Owner of the source workload (often k8s deployment)
    SourceOwner string `protobuf:"bytes,12,opt,name=source_owner,json=sourceOwner,proto3" json:"source_owner,omitempty"`
    // UID of the source workload
    SourceUid string `protobuf:"bytes,13,opt,name=source_uid,json=sourceUid,proto3" json:"source_uid,omitempty"`
    // Namespace of the destination workload
    DestinationWorkloadNamespace string `protobuf:"bytes,20,opt,name=destination_workload_namespace,json=destinationWorkloadNamespace,proto3" json:"destination_workload_namespace,omitempty"`
    // Name of the destination workload
    DestinationWorkloadName string `protobuf:"bytes,21,opt,name=destination_workload_name,json=destinationWorkloadName,proto3" json:"destination_workload_name,omitempty"`
    // Owner of the destination workload (often k8s deployment)
    DestinationOwner string `protobuf:"bytes,22,opt,name=destination_owner,json=destinationOwner,proto3" json:"destination_owner,omitempty"`
    // UID of the destination workload
    DestinationUid string `protobuf:"bytes,23,opt,name=destination_uid,json=destinationUid,proto3" json:"destination_uid,omitempty"`
    // Namespace of the destination Service
    DestinationServiceNamespace string `protobuf:"bytes,24,opt,name=destination_service_namespace,json=destinationServiceNamespace,proto3" json:"destination_service_namespace,omitempty"`
    // Name of the destination Service
    DestinationServiceName string `protobuf:"bytes,25,opt,name=destination_service_name,json=destinationServiceName,proto3" json:"destination_service_name,omitempty"`
    // Protocol used for communication (http, tcp)
    ContextProtocol string `protobuf:"bytes,30,opt,name=context_protocol,json=contextProtocol,proto3" json:"context_protocol,omitempty"`
    // The protocol type of the API call (http, https, grpc)
    ApiProtocol string `protobuf:"bytes,31,opt,name=api_protocol,json=apiProtocol,proto3" json:"api_protocol,omitempty"`
}

Represents instance configuration schema for 'edge' template.

func (*InstanceParam) Descriptor Uses

func (*InstanceParam) Descriptor() ([]byte, []int)

func (*InstanceParam) Marshal Uses

func (m *InstanceParam) Marshal() (dAtA []byte, err error)

func (*InstanceParam) MarshalTo Uses

func (m *InstanceParam) MarshalTo(dAtA []byte) (int, error)

func (*InstanceParam) MarshalToSizedBuffer Uses

func (m *InstanceParam) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*InstanceParam) ProtoMessage Uses

func (*InstanceParam) ProtoMessage()

func (*InstanceParam) Reset Uses

func (m *InstanceParam) Reset()

func (*InstanceParam) Size Uses

func (m *InstanceParam) Size() (n int)

func (*InstanceParam) String Uses

func (this *InstanceParam) String() string

func (*InstanceParam) Unmarshal Uses

func (m *InstanceParam) Unmarshal(dAtA []byte) error

func (*InstanceParam) XXX_DiscardUnknown Uses

func (m *InstanceParam) XXX_DiscardUnknown()

func (*InstanceParam) XXX_Marshal Uses

func (m *InstanceParam) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*InstanceParam) XXX_Merge Uses

func (m *InstanceParam) XXX_Merge(src proto.Message)

func (*InstanceParam) XXX_Size Uses

func (m *InstanceParam) XXX_Size() int

func (*InstanceParam) XXX_Unmarshal Uses

func (m *InstanceParam) XXX_Unmarshal(b []byte) error

type Type Uses

type Type struct {
}

Contains inferred type information about specific instance of 'edge' template. This is passed to infrastructure backends during configuration-time through [InfrastructureBackend.CreateSession][TODO: Link to this fragment].

func (*Type) Descriptor Uses

func (*Type) Descriptor() ([]byte, []int)

func (*Type) Marshal Uses

func (m *Type) Marshal() (dAtA []byte, err error)

func (*Type) MarshalTo Uses

func (m *Type) MarshalTo(dAtA []byte) (int, error)

func (*Type) MarshalToSizedBuffer Uses

func (m *Type) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Type) ProtoMessage Uses

func (*Type) ProtoMessage()

func (*Type) Reset Uses

func (m *Type) Reset()

func (*Type) Size Uses

func (m *Type) Size() (n int)

func (*Type) String Uses

func (this *Type) String() string

func (*Type) Unmarshal Uses

func (m *Type) Unmarshal(dAtA []byte) error

func (*Type) XXX_DiscardUnknown Uses

func (m *Type) XXX_DiscardUnknown()

func (*Type) XXX_Marshal Uses

func (m *Type) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Type) XXX_Merge Uses

func (m *Type) XXX_Merge(src proto.Message)

func (*Type) XXX_Size Uses

func (m *Type) XXX_Size() int

func (*Type) XXX_Unmarshal Uses

func (m *Type) XXX_Unmarshal(b []byte) error

type UnimplementedHandleEdgeServiceServer Uses

type UnimplementedHandleEdgeServiceServer struct {
}

UnimplementedHandleEdgeServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedHandleEdgeServiceServer) HandleEdge Uses

func (*UnimplementedHandleEdgeServiceServer) HandleEdge(ctx context.Context, req *HandleEdgeRequest) (*v1beta11.ReportResult, error)

Package edge imports 17 packages (graph) and is imported by 8 packages. Updated 2019-10-11. Refresh now. Tools for package owners.