restapi

Documentation

Index

• Constants
• type AgentState
• type ErrorResponse
• type InterceptInfo
• type Server
  • func NewServer(agent AgentState) Server

Constants

const (
	HeaderCallerInterceptID = "x-telepresence-caller-intercept-id"
	HeaderInterceptID       = "x-telepresence-intercept-id"
	EndPointConsumeHere     = "/consume-here"
	EndPointInterceptInfo   = "/intercept-info"
)

Types

type AgentState

type AgentState interface {
	// InterceptInfo returns information about an ongoing intercept that matches
	// the given arguments.
	InterceptInfo(ctx context.Context, callerID, path string, containerPort uint16, headers http.Header) (*InterceptInfo, error)
}

type ErrorResponse

type ErrorResponse struct {
	Error string `json:"error,omitempty"`
}

type InterceptInfo

type InterceptInfo struct {
	// True if the service is being intercepted
	Intercepted bool `json:"intercepted"`

	// True when queried on the workstation side, false if it is the cluster side agent.
	ClientSide bool `json:"clientSide"`

	// Metadata associated with the intercept. Only available on when Intercepted == ClientSide
	Metadata map[string]string `json:"metadata,omitempty"`
}

type Server

type Server interface {
	ListenAndServe(context.Context, int) error
	Serve(context.Context, net.Listener) error
}

func NewServer

func NewServer(agent AgentState) Server