Documentation ¶
Overview ¶
Package edge is a generated protocol buffer package.
The `edge` template represents an edge in the mesh graph.
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: edge metadata:
name: default namespace: istio-system
spec:
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"
```
It is generated from these files:
mixer/template/edge/template_handler_service.proto
It has these top-level messages:
HandleEdgeRequest InstanceMsg Type InstanceParam
Index ¶
- Constants
- Variables
- func RegisterHandleEdgeServiceServer(s *grpc.Server, srv HandleEdgeServiceServer)
- type HandleEdgeRequest
- func (*HandleEdgeRequest) Descriptor() ([]byte, []int)
- func (m *HandleEdgeRequest) Marshal() (dAtA []byte, err error)
- func (m *HandleEdgeRequest) MarshalTo(dAtA []byte) (int, error)
- func (*HandleEdgeRequest) ProtoMessage()
- func (m *HandleEdgeRequest) Reset()
- func (m *HandleEdgeRequest) Size() (n int)
- func (this *HandleEdgeRequest) String() string
- func (m *HandleEdgeRequest) Unmarshal(dAtA []byte) error
- type HandleEdgeServiceClient
- type HandleEdgeServiceServer
- type Handler
- type HandlerBuilder
- type Instance
- type InstanceMsg
- func (*InstanceMsg) Descriptor() ([]byte, []int)
- func (m *InstanceMsg) Marshal() (dAtA []byte, err error)
- func (m *InstanceMsg) MarshalTo(dAtA []byte) (int, error)
- func (*InstanceMsg) ProtoMessage()
- func (m *InstanceMsg) Reset()
- func (m *InstanceMsg) Size() (n int)
- func (this *InstanceMsg) String() string
- func (m *InstanceMsg) Unmarshal(dAtA []byte) error
- type InstanceParam
- func (*InstanceParam) Descriptor() ([]byte, []int)
- func (m *InstanceParam) Marshal() (dAtA []byte, err error)
- func (m *InstanceParam) MarshalTo(dAtA []byte) (int, error)
- func (*InstanceParam) ProtoMessage()
- func (m *InstanceParam) Reset()
- func (m *InstanceParam) Size() (n int)
- func (this *InstanceParam) String() string
- func (m *InstanceParam) Unmarshal(dAtA []byte) error
- type Type
- func (*Type) Descriptor() ([]byte, []int)
- func (m *Type) Marshal() (dAtA []byte, err error)
- func (m *Type) MarshalTo(dAtA []byte) (int, error)
- func (*Type) ProtoMessage()
- func (m *Type) Reset()
- func (m *Type) Size() (n int)
- func (this *Type) String() string
- func (m *Type) Unmarshal(dAtA []byte) error
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") )
Functions ¶
func RegisterHandleEdgeServiceServer ¶
func RegisterHandleEdgeServiceServer(s *grpc.Server, srv HandleEdgeServiceServer)
Types ¶
type HandleEdgeRequest ¶
type HandleEdgeRequest struct { // 'edge' instances. Instances []*InstanceMsg `protobuf:"bytes,1,rep,name=instances" 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 *google_protobuf1.Any `protobuf:"bytes,2,opt,name=adapter_config,json=adapterConfig" 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 ¶
func (*HandleEdgeRequest) Descriptor() ([]byte, []int)
func (*HandleEdgeRequest) Marshal ¶
func (m *HandleEdgeRequest) Marshal() (dAtA []byte, err error)
func (*HandleEdgeRequest) MarshalTo ¶
func (m *HandleEdgeRequest) MarshalTo(dAtA []byte) (int, error)
func (*HandleEdgeRequest) ProtoMessage ¶
func (*HandleEdgeRequest) ProtoMessage()
func (*HandleEdgeRequest) Reset ¶
func (m *HandleEdgeRequest) Reset()
func (*HandleEdgeRequest) Size ¶
func (m *HandleEdgeRequest) Size() (n int)
func (*HandleEdgeRequest) String ¶
func (this *HandleEdgeRequest) String() string
func (*HandleEdgeRequest) Unmarshal ¶
func (m *HandleEdgeRequest) Unmarshal(dAtA []byte) error
type HandleEdgeServiceClient ¶
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) (*istio_mixer_adapter_model_v1beta11.ReportResult, error) }
func NewHandleEdgeServiceClient ¶
func NewHandleEdgeServiceClient(cc *grpc.ClientConn) HandleEdgeServiceClient
type HandleEdgeServiceServer ¶
type HandleEdgeServiceServer interface { // HandleEdge is called by Mixer at request-time to deliver 'edge' instances to the backend. HandleEdge(context.Context, *HandleEdgeRequest) (*istio_mixer_adapter_model_v1beta11.ReportResult, error) }
type Handler ¶
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 ¶
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 ¶
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: edge metadata:
name: default namespace: istio-system
spec:
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 ¶
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 *istio_policy_v1beta1.TimeStamp `protobuf:"bytes,1,opt,name=timestamp" json:"timestamp,omitempty"` // Namespace of the source workload SourceWorkloadNamespace string `` /* 133-byte string literal not displayed */ // 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 `` /* 148-byte string literal not displayed */ // Name of the destination workload DestinationWorkloadName string `` /* 133-byte string literal not displayed */ // 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 `` /* 145-byte string literal not displayed */ // Name of the destination Service DestinationServiceName string `` /* 130-byte string literal not displayed */ // 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 ¶
func (*InstanceMsg) Descriptor() ([]byte, []int)
func (*InstanceMsg) Marshal ¶
func (m *InstanceMsg) Marshal() (dAtA []byte, err error)
func (*InstanceMsg) ProtoMessage ¶
func (*InstanceMsg) ProtoMessage()
func (*InstanceMsg) Reset ¶
func (m *InstanceMsg) Reset()
func (*InstanceMsg) Size ¶
func (m *InstanceMsg) Size() (n int)
func (*InstanceMsg) String ¶
func (this *InstanceMsg) String() string
func (*InstanceMsg) Unmarshal ¶
func (m *InstanceMsg) Unmarshal(dAtA []byte) error
type InstanceParam ¶
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 `` /* 133-byte string literal not displayed */ // 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 `` /* 148-byte string literal not displayed */ // Name of the destination workload DestinationWorkloadName string `` /* 133-byte string literal not displayed */ // 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 `` /* 145-byte string literal not displayed */ // Name of the destination Service DestinationServiceName string `` /* 130-byte string literal not displayed */ // 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 ¶
func (*InstanceParam) Descriptor() ([]byte, []int)
func (*InstanceParam) Marshal ¶
func (m *InstanceParam) Marshal() (dAtA []byte, err error)
func (*InstanceParam) ProtoMessage ¶
func (*InstanceParam) ProtoMessage()
func (*InstanceParam) Reset ¶
func (m *InstanceParam) Reset()
func (*InstanceParam) Size ¶
func (m *InstanceParam) Size() (n int)
func (*InstanceParam) String ¶
func (this *InstanceParam) String() string
func (*InstanceParam) Unmarshal ¶
func (m *InstanceParam) Unmarshal(dAtA []byte) error
type Type ¶
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 ¶
func (*Type) ProtoMessage ¶
func (*Type) ProtoMessage()