go-control-plane: github.com/envoyproxy/go-control-plane/envoy/extensions/filters/http/admission_control/v3alpha Index | Files

package envoy_extensions_filters_http_admission_control_v3alpha

import "github.com/envoyproxy/go-control-plane/envoy/extensions/filters/http/admission_control/v3alpha"

Index

Package Files

admission_control.pb.go admission_control.pb.validate.go

Variables

var File_envoy_extensions_filters_http_admission_control_v3alpha_admission_control_proto protoreflect.FileDescriptor

type AdmissionControl Uses

type AdmissionControl struct {

    // If set to false, the admission control filter will operate as a pass-through filter. If the
    // message is unspecified, the filter will be enabled.
    Enabled *v3.RuntimeFeatureFlag `protobuf:"bytes,1,opt,name=enabled,proto3" json:"enabled,omitempty"`
    // Defines how a request is considered a success/failure.
    //
    // Types that are assignable to EvaluationCriteria:
    //	*AdmissionControl_SuccessCriteria_
    EvaluationCriteria isAdmissionControl_EvaluationCriteria `protobuf_oneof:"evaluation_criteria"`
    // The sliding time window over which the success rate is calculated. The window is rounded to the
    // nearest second. Defaults to 30s.
    SamplingWindow *duration.Duration `protobuf:"bytes,3,opt,name=sampling_window,json=samplingWindow,proto3" json:"sampling_window,omitempty"`
    // Rejection probability is defined by the formula::
    //
    //     max(0, (rq_count -  rq_success_count / sr_threshold) / (rq_count + 1)) ^ (1 / aggression)
    //
    // The aggression dictates how heavily the admission controller will throttle requests upon SR
    // dropping at or below the threshold. A value of 1 will result in a linear increase in
    // rejection probability as SR drops. Any values less than 1.0, will be set to 1.0. If the
    // message is unspecified, the aggression is 1.0. See `the admission control documentation
    // <https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/admission_control_filter.html>`_
    // for a diagram illustrating this.
    Aggression *v3.RuntimeDouble `protobuf:"bytes,4,opt,name=aggression,proto3" json:"aggression,omitempty"`
    // Dictates the success rate at which the rejection probability is non-zero. As success rate drops
    // below this threshold, rejection probability will increase. Any success rate above the threshold
    // results in a rejection probability of 0. Defaults to 95%.
    SrThreshold *v3.RuntimePercent `protobuf:"bytes,5,opt,name=sr_threshold,json=srThreshold,proto3" json:"sr_threshold,omitempty"`
    // contains filtered or unexported fields
}

[#next-free-field: 6]

func (*AdmissionControl) Descriptor Uses

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

Deprecated: Use AdmissionControl.ProtoReflect.Descriptor instead.

func (*AdmissionControl) GetAggression Uses

func (x *AdmissionControl) GetAggression() *v3.RuntimeDouble

func (*AdmissionControl) GetEnabled Uses

func (x *AdmissionControl) GetEnabled() *v3.RuntimeFeatureFlag

func (*AdmissionControl) GetEvaluationCriteria Uses

func (m *AdmissionControl) GetEvaluationCriteria() isAdmissionControl_EvaluationCriteria

func (*AdmissionControl) GetSamplingWindow Uses

func (x *AdmissionControl) GetSamplingWindow() *duration.Duration

func (*AdmissionControl) GetSrThreshold Uses

func (x *AdmissionControl) GetSrThreshold() *v3.RuntimePercent

func (*AdmissionControl) GetSuccessCriteria Uses

func (x *AdmissionControl) GetSuccessCriteria() *AdmissionControl_SuccessCriteria

func (*AdmissionControl) ProtoMessage Uses

func (*AdmissionControl) ProtoMessage()

func (*AdmissionControl) ProtoReflect Uses

func (x *AdmissionControl) ProtoReflect() protoreflect.Message

func (*AdmissionControl) Reset Uses

func (x *AdmissionControl) Reset()

func (*AdmissionControl) String Uses

func (x *AdmissionControl) String() string

func (*AdmissionControl) Validate Uses

func (m *AdmissionControl) Validate() error

Validate checks the field values on AdmissionControl with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type AdmissionControlValidationError Uses

type AdmissionControlValidationError struct {
    // contains filtered or unexported fields
}

AdmissionControlValidationError is the validation error returned by AdmissionControl.Validate if the designated constraints aren't met.

func (AdmissionControlValidationError) Cause Uses

func (e AdmissionControlValidationError) Cause() error

Cause function returns cause value.

func (AdmissionControlValidationError) Error Uses

func (e AdmissionControlValidationError) Error() string

Error satisfies the builtin error interface

func (AdmissionControlValidationError) ErrorName Uses

func (e AdmissionControlValidationError) ErrorName() string

ErrorName returns error name.

func (AdmissionControlValidationError) Field Uses

func (e AdmissionControlValidationError) Field() string

Field function returns field value.

func (AdmissionControlValidationError) Key Uses

func (e AdmissionControlValidationError) Key() bool

Key function returns key value.

func (AdmissionControlValidationError) Reason Uses

func (e AdmissionControlValidationError) Reason() string

Reason function returns reason value.

type AdmissionControl_SuccessCriteria Uses

type AdmissionControl_SuccessCriteria struct {

    // If HTTP criteria are unspecified, all HTTP status codes below 500 are treated as successful
    // responses.
    //
    // .. note::
    //
    //    The default HTTP codes considered successful by the admission controller are done so due
    //    to the unlikelihood that sending fewer requests would change their behavior (for example:
    //    redirects, unauthorized access, or bad requests won't be alleviated by sending less
    //    traffic).
    HttpCriteria *AdmissionControl_SuccessCriteria_HttpCriteria `protobuf:"bytes,1,opt,name=http_criteria,json=httpCriteria,proto3" json:"http_criteria,omitempty"`
    // GRPC status codes to consider as request successes. If unspecified, defaults to: Ok,
    // Cancelled, Unknown, InvalidArgument, NotFound, AlreadyExists, Unauthenticated,
    // FailedPrecondition, OutOfRange, PermissionDenied, and Unimplemented.
    //
    // .. note::
    //
    //    The default gRPC codes that are considered successful by the admission controller are
    //    chosen because of the unlikelihood that sending fewer requests will change the behavior.
    GrpcCriteria *AdmissionControl_SuccessCriteria_GrpcCriteria `protobuf:"bytes,2,opt,name=grpc_criteria,json=grpcCriteria,proto3" json:"grpc_criteria,omitempty"`
    // contains filtered or unexported fields
}

Default method of specifying what constitutes a successful request. All status codes that indicate a successful request must be explicitly specified if not relying on the default values.

func (*AdmissionControl_SuccessCriteria) Descriptor Uses

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

Deprecated: Use AdmissionControl_SuccessCriteria.ProtoReflect.Descriptor instead.

func (*AdmissionControl_SuccessCriteria) GetGrpcCriteria Uses

func (x *AdmissionControl_SuccessCriteria) GetGrpcCriteria() *AdmissionControl_SuccessCriteria_GrpcCriteria

func (*AdmissionControl_SuccessCriteria) GetHttpCriteria Uses

func (x *AdmissionControl_SuccessCriteria) GetHttpCriteria() *AdmissionControl_SuccessCriteria_HttpCriteria

func (*AdmissionControl_SuccessCriteria) ProtoMessage Uses

func (*AdmissionControl_SuccessCriteria) ProtoMessage()

func (*AdmissionControl_SuccessCriteria) ProtoReflect Uses

func (x *AdmissionControl_SuccessCriteria) ProtoReflect() protoreflect.Message

func (*AdmissionControl_SuccessCriteria) Reset Uses

func (x *AdmissionControl_SuccessCriteria) Reset()

func (*AdmissionControl_SuccessCriteria) String Uses

func (x *AdmissionControl_SuccessCriteria) String() string

func (*AdmissionControl_SuccessCriteria) Validate Uses

func (m *AdmissionControl_SuccessCriteria) Validate() error

Validate checks the field values on AdmissionControl_SuccessCriteria with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type AdmissionControl_SuccessCriteriaValidationError Uses

type AdmissionControl_SuccessCriteriaValidationError struct {
    // contains filtered or unexported fields
}

AdmissionControl_SuccessCriteriaValidationError is the validation error returned by AdmissionControl_SuccessCriteria.Validate if the designated constraints aren't met.

func (AdmissionControl_SuccessCriteriaValidationError) Cause Uses

func (e AdmissionControl_SuccessCriteriaValidationError) Cause() error

Cause function returns cause value.

func (AdmissionControl_SuccessCriteriaValidationError) Error Uses

func (e AdmissionControl_SuccessCriteriaValidationError) Error() string

Error satisfies the builtin error interface

func (AdmissionControl_SuccessCriteriaValidationError) ErrorName Uses

func (e AdmissionControl_SuccessCriteriaValidationError) ErrorName() string

ErrorName returns error name.

func (AdmissionControl_SuccessCriteriaValidationError) Field Uses

func (e AdmissionControl_SuccessCriteriaValidationError) Field() string

Field function returns field value.

func (AdmissionControl_SuccessCriteriaValidationError) Key Uses

func (e AdmissionControl_SuccessCriteriaValidationError) Key() bool

Key function returns key value.

func (AdmissionControl_SuccessCriteriaValidationError) Reason Uses

func (e AdmissionControl_SuccessCriteriaValidationError) Reason() string

Reason function returns reason value.

type AdmissionControl_SuccessCriteria_ Uses

type AdmissionControl_SuccessCriteria_ struct {
    SuccessCriteria *AdmissionControl_SuccessCriteria `protobuf:"bytes,2,opt,name=success_criteria,json=successCriteria,proto3,oneof"`
}

type AdmissionControl_SuccessCriteria_GrpcCriteria Uses

type AdmissionControl_SuccessCriteria_GrpcCriteria struct {

    // Status codes that constitute a successful request.
    // Mappings can be found at: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md.
    GrpcSuccessStatus []uint32 `protobuf:"varint,1,rep,packed,name=grpc_success_status,json=grpcSuccessStatus,proto3" json:"grpc_success_status,omitempty"`
    // contains filtered or unexported fields
}

func (*AdmissionControl_SuccessCriteria_GrpcCriteria) Descriptor Uses

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

Deprecated: Use AdmissionControl_SuccessCriteria_GrpcCriteria.ProtoReflect.Descriptor instead.

func (*AdmissionControl_SuccessCriteria_GrpcCriteria) GetGrpcSuccessStatus Uses

func (x *AdmissionControl_SuccessCriteria_GrpcCriteria) GetGrpcSuccessStatus() []uint32

func (*AdmissionControl_SuccessCriteria_GrpcCriteria) ProtoMessage Uses

func (*AdmissionControl_SuccessCriteria_GrpcCriteria) ProtoMessage()

func (*AdmissionControl_SuccessCriteria_GrpcCriteria) ProtoReflect Uses

func (x *AdmissionControl_SuccessCriteria_GrpcCriteria) ProtoReflect() protoreflect.Message

func (*AdmissionControl_SuccessCriteria_GrpcCriteria) Reset Uses

func (x *AdmissionControl_SuccessCriteria_GrpcCriteria) Reset()

func (*AdmissionControl_SuccessCriteria_GrpcCriteria) String Uses

func (x *AdmissionControl_SuccessCriteria_GrpcCriteria) String() string

func (*AdmissionControl_SuccessCriteria_GrpcCriteria) Validate Uses

func (m *AdmissionControl_SuccessCriteria_GrpcCriteria) Validate() error

Validate checks the field values on AdmissionControl_SuccessCriteria_GrpcCriteria with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type AdmissionControl_SuccessCriteria_GrpcCriteriaValidationError Uses

type AdmissionControl_SuccessCriteria_GrpcCriteriaValidationError struct {
    // contains filtered or unexported fields
}

AdmissionControl_SuccessCriteria_GrpcCriteriaValidationError is the validation error returned by AdmissionControl_SuccessCriteria_GrpcCriteria.Validate if the designated constraints aren't met.

func (AdmissionControl_SuccessCriteria_GrpcCriteriaValidationError) Cause Uses

func (e AdmissionControl_SuccessCriteria_GrpcCriteriaValidationError) Cause() error

Cause function returns cause value.

func (AdmissionControl_SuccessCriteria_GrpcCriteriaValidationError) Error Uses

func (e AdmissionControl_SuccessCriteria_GrpcCriteriaValidationError) Error() string

Error satisfies the builtin error interface

func (AdmissionControl_SuccessCriteria_GrpcCriteriaValidationError) ErrorName Uses

func (e AdmissionControl_SuccessCriteria_GrpcCriteriaValidationError) ErrorName() string

ErrorName returns error name.

func (AdmissionControl_SuccessCriteria_GrpcCriteriaValidationError) Field Uses

func (e AdmissionControl_SuccessCriteria_GrpcCriteriaValidationError) Field() string

Field function returns field value.

func (AdmissionControl_SuccessCriteria_GrpcCriteriaValidationError) Key Uses

func (e AdmissionControl_SuccessCriteria_GrpcCriteriaValidationError) Key() bool

Key function returns key value.

func (AdmissionControl_SuccessCriteria_GrpcCriteriaValidationError) Reason Uses

func (e AdmissionControl_SuccessCriteria_GrpcCriteriaValidationError) Reason() string

Reason function returns reason value.

type AdmissionControl_SuccessCriteria_HttpCriteria Uses

type AdmissionControl_SuccessCriteria_HttpCriteria struct {

    // Status code ranges that constitute a successful request. Configurable codes are in the
    // range [100, 600).
    HttpSuccessStatus []*v31.Int32Range `protobuf:"bytes,1,rep,name=http_success_status,json=httpSuccessStatus,proto3" json:"http_success_status,omitempty"`
    // contains filtered or unexported fields
}

func (*AdmissionControl_SuccessCriteria_HttpCriteria) Descriptor Uses

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

Deprecated: Use AdmissionControl_SuccessCriteria_HttpCriteria.ProtoReflect.Descriptor instead.

func (*AdmissionControl_SuccessCriteria_HttpCriteria) GetHttpSuccessStatus Uses

func (x *AdmissionControl_SuccessCriteria_HttpCriteria) GetHttpSuccessStatus() []*v31.Int32Range

func (*AdmissionControl_SuccessCriteria_HttpCriteria) ProtoMessage Uses

func (*AdmissionControl_SuccessCriteria_HttpCriteria) ProtoMessage()

func (*AdmissionControl_SuccessCriteria_HttpCriteria) ProtoReflect Uses

func (x *AdmissionControl_SuccessCriteria_HttpCriteria) ProtoReflect() protoreflect.Message

func (*AdmissionControl_SuccessCriteria_HttpCriteria) Reset Uses

func (x *AdmissionControl_SuccessCriteria_HttpCriteria) Reset()

func (*AdmissionControl_SuccessCriteria_HttpCriteria) String Uses

func (x *AdmissionControl_SuccessCriteria_HttpCriteria) String() string

func (*AdmissionControl_SuccessCriteria_HttpCriteria) Validate Uses

func (m *AdmissionControl_SuccessCriteria_HttpCriteria) Validate() error

Validate checks the field values on AdmissionControl_SuccessCriteria_HttpCriteria with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type AdmissionControl_SuccessCriteria_HttpCriteriaValidationError Uses

type AdmissionControl_SuccessCriteria_HttpCriteriaValidationError struct {
    // contains filtered or unexported fields
}

AdmissionControl_SuccessCriteria_HttpCriteriaValidationError is the validation error returned by AdmissionControl_SuccessCriteria_HttpCriteria.Validate if the designated constraints aren't met.

func (AdmissionControl_SuccessCriteria_HttpCriteriaValidationError) Cause Uses

func (e AdmissionControl_SuccessCriteria_HttpCriteriaValidationError) Cause() error

Cause function returns cause value.

func (AdmissionControl_SuccessCriteria_HttpCriteriaValidationError) Error Uses

func (e AdmissionControl_SuccessCriteria_HttpCriteriaValidationError) Error() string

Error satisfies the builtin error interface

func (AdmissionControl_SuccessCriteria_HttpCriteriaValidationError) ErrorName Uses

func (e AdmissionControl_SuccessCriteria_HttpCriteriaValidationError) ErrorName() string

ErrorName returns error name.

func (AdmissionControl_SuccessCriteria_HttpCriteriaValidationError) Field Uses

func (e AdmissionControl_SuccessCriteria_HttpCriteriaValidationError) Field() string

Field function returns field value.

func (AdmissionControl_SuccessCriteria_HttpCriteriaValidationError) Key Uses

func (e AdmissionControl_SuccessCriteria_HttpCriteriaValidationError) Key() bool

Key function returns key value.

func (AdmissionControl_SuccessCriteria_HttpCriteriaValidationError) Reason Uses

func (e AdmissionControl_SuccessCriteria_HttpCriteriaValidationError) Reason() string

Reason function returns reason value.

Package envoy_extensions_filters_http_admission_control_v3alpha imports 24 packages (graph) and is imported by 5 packages. Updated 2021-01-08. Refresh now. Tools for package owners.