ambassador

Documentation

Index

• Constants
• func GetAmbassadorConfigs(mlDep *machinelearningv1.SeldonDeployment, p *machinelearningv1.PredictorSpec, ...) (string, error)
• func GetV2AmbassadorConfigs(mlDep *machinelearningv1.SeldonDeployment, p *machinelearningv1.PredictorSpec, ...) ([]*v2.Mapping, []*v2.TLSContext, error)
• type AmbassadorCircuitBreakerConfig
• type AmbassadorConfig
• type AmbassadorRetryPolicy
• type AmbassadorTLSContextConfig

Constants

const (
	ANNOTATION_REST_TIMEOUT            = "seldon.io/rest-timeout"
	ANNOTATION_GRPC_TIMEOUT            = "seldon.io/grpc-timeout"
	ANNOTATION_AMBASSADOR_CUSTOM       = "seldon.io/ambassador-config"
	ANNOTATION_AMBASSADOR_SERVICE      = "seldon.io/ambassador-service-name"
	ANNOTATION_AMBASSADOR_HEADER       = "seldon.io/ambassador-header"
	ANNOTATION_AMBASSADOR_REGEX_HEADER = "seldon.io/ambassador-regex-header"
	ANNOTATION_AMBASSADOR_ID           = "seldon.io/ambassador-id"
	ANNOTATION_AMBASSADOR_RETRIES      = "seldon.io/ambassador-retries"

	ANNOTATION_AMBASSADOR_CIRCUIT_BREAKING_MAX_CONNECTIONS      = "seldon.io/ambassador-circuit-breakers-max-connections"
	ANNOTATION_AMBASSADOR_CIRCUIT_BREAKING_MAX_PENDING_REQUESTS = "seldon.io/ambassador-circuit-breakers-max-pending-requests"
	ANNOTATION_AMBASSADOR_CIRCUIT_BREAKING_MAX_REQUESTS         = "seldon.io/ambassador-circuit-breakers-max-requests"
	ANNOTATION_AMBASSADOR_CIRCUIT_BREAKING_MAX_RETRIES          = "seldon.io/ambassador-circuit-breakers-max-retries"

	YAML_SEP = "---\n"

	AMBASSADOR_IDLE_TIMEOUT    = 300000
	AMBASSADOR_DEFAULT_RETRIES = "0"
)

Functions

func GetAmbassadorConfigs

func GetAmbassadorConfigs(mlDep *machinelearningv1.SeldonDeployment, p *machinelearningv1.PredictorSpec, serviceName string, engine_http_port, engine_grpc_port int, isExplainer bool) (string, error)

Get the configuration for ambassador using the servce name serviceName. Up to 4 confgurations will be created covering REST, GRPC and cluster-wide and namespaced varieties. Annotations for Ambassador will be used to customize the configuration returned.

func GetV2AmbassadorConfigs

func GetV2AmbassadorConfigs(mlDep *machinelearningv1.SeldonDeployment, p *machinelearningv1.PredictorSpec, serviceName string, engine_http_port, engine_grpc_port int, isExplainer bool) ([]*v2.Mapping, []*v2.TLSContext, error)

Types

type AmbassadorCircuitBreakerConfig

type AmbassadorCircuitBreakerConfig struct {
	MaxConnections     int `yaml:"max_connections,omitempty"`
	MaxPendingRequests int `yaml:"max_pending_requests,omitempty"`
	MaxRequests        int `yaml:"max_requests,omitempty"`
	MaxRetries         int `yaml:"max_retries,omitempty"`
}

AmbassadorCircuitBreakerConfig - struct for ambassador circuit breaker

type AmbassadorConfig

type AmbassadorConfig struct {
	ApiVersion      string                            `yaml:"apiVersion"`
	Kind            string                            `yaml:"kind"`
	Name            string                            `yaml:"name"`
	Grpc            *bool                             `yaml:"grpc,omitempty"`
	Prefix          string                            `yaml:"prefix"`
	PrefixRegex     *bool                             `yaml:"prefix_regex,omitempty"`
	Rewrite         string                            `yaml:"rewrite"`
	Service         string                            `yaml:"service"`
	TimeoutMs       int                               `yaml:"timeout_ms"`
	IdleTimeoutMs   *int                              `yaml:"idle_timeout_ms,omitempty"`
	Headers         map[string]string                 `yaml:"headers,omitempty"`
	RegexHeaders    map[string]string                 `yaml:"regex_headers,omitempty"`
	Weight          int32                             `yaml:"weight,omitempty"`
	Shadow          *bool                             `yaml:"shadow,omitempty"`
	RetryPolicy     *AmbassadorRetryPolicy            `yaml:"retry_policy,omitempty"`
	InstanceId      string                            `yaml:"ambassador_id,omitempty"`
	CircuitBreakers []*AmbassadorCircuitBreakerConfig `yaml:"circuit_breakers,omitempty"`
	TLS             string                            `yaml:"tls,omitempty"`
}

Struct for Ambassador configuration

type AmbassadorRetryPolicy

type AmbassadorRetryPolicy struct {
	RetryOn    string `yaml:"retry_on,omitempty"`
	NumRetries int    `yaml:"num_retries,omitempty"`
}

type AmbassadorTLSContextConfig

type AmbassadorTLSContextConfig struct {
	ApiVersion string   `yaml:"apiVersion"`
	Kind       string   `yaml:"kind"`
	Name       string   `yaml:"name"`
	Hosts      []string `yaml:"hosts"`
	Secret     string   `yaml:"secret"`
}

Struct for Ambassador configuration