Policy Attachment v1alpha1 API Reference

Policy v1alpha1 API reference documentation.

Packages:

gateway.flomesh.io/v1alpha1

Package v1alpha1 is the v1alpha3 version of the API.

Resource Types:

AccessControlPolicy

AccessControlPolicy is the Schema for the AccessControlPolicy API

FieldDescription
apiVersion
string
gateway.flomesh.io/v1alpha1
kind
string
AccessControlPolicy
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
AccessControlPolicySpec


targetRef
sigs.k8s.io/gateway-api/apis/v1alpha2.PolicyTargetReference

TargetRef is the reference to the target resource to which the policy is applied

ports
[]PortAccessControl
(Optional)

Ports is the access control configuration for ports

hostnames
[]HostnameAccessControl
(Optional)

Hostnames is the access control configuration for hostnames

http
[]HTTPAccessControl
(Optional)

HTTPAccessControls is the access control configuration for HTTP routes

grpc
[]GRPCAccessControl
(Optional)

GRPCAccessControls is the access control configuration for GRPC routes

config
AccessControlConfig
(Optional)

DefaultConfig is the default access control for all ports, routes and hostnames

status
AccessControlPolicyStatus

CircuitBreakingPolicy

CircuitBreakingPolicy is the Schema for the CircuitBreakingPolicy API

FieldDescription
apiVersion
string
gateway.flomesh.io/v1alpha1
kind
string
CircuitBreakingPolicy
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
CircuitBreakingPolicySpec


targetRef
sigs.k8s.io/gateway-api/apis/v1alpha2.PolicyTargetReference

TargetRef is the reference to the target resource to which the policy is applied

ports
[]PortCircuitBreaking

Ports is the circuit breaking configuration for ports

config
CircuitBreakingConfig
(Optional)

DefaultConfig is the default circuit breaking configuration for all ports

status
CircuitBreakingPolicyStatus

FaultInjectionPolicy

FaultInjectionPolicy is the Schema for the FaultInjectionPolicy API

FieldDescription
apiVersion
string
gateway.flomesh.io/v1alpha1
kind
string
FaultInjectionPolicy
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
FaultInjectionPolicySpec


targetRef
sigs.k8s.io/gateway-api/apis/v1alpha2.PolicyTargetReference

TargetRef is the reference to the target resource to which the policy is applied

hostnames
[]HostnameFaultInjection
(Optional)

Hostnames is the access control configuration for hostnames

http
[]HTTPFaultInjection
(Optional)

HTTPFaultInjections is the access control configuration for HTTP routes

grpc
[]GRPCFaultInjection
(Optional)

GRPCFaultInjections is the access control configuration for GRPC routes

config
FaultInjectionConfig
(Optional)

DefaultConfig is the default access control for all ports, routes and hostnames

unit
string
(Optional)

Unit is the unit of delay duration, default Unit is ms

status
FaultInjectionPolicyStatus

GatewayTLSPolicy

GatewayTLSPolicy is the Schema for the GatewayTLSPolicy API

FieldDescription
apiVersion
string
gateway.flomesh.io/v1alpha1
kind
string
GatewayTLSPolicy
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
GatewayTLSPolicySpec


targetRef
sigs.k8s.io/gateway-api/apis/v1alpha2.PolicyTargetReference

TargetRef is the reference to the target resource to which the policy is applied

ports
[]PortGatewayTLS

Ports is the Gateway TLS configuration for ports

config
GatewayTLSConfig
(Optional)

DefaultConfig is the default Gateway TLS configuration for all ports

status
GatewayTLSPolicyStatus

HealthCheckPolicy

HealthCheckPolicy is the Schema for the HealthCheckPolicy API

FieldDescription
apiVersion
string
gateway.flomesh.io/v1alpha1
kind
string
HealthCheckPolicy
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
HealthCheckPolicySpec


targetRef
sigs.k8s.io/gateway-api/apis/v1alpha2.PolicyTargetReference

TargetRef is the reference to the target resource to which the policy is applied

ports
[]PortHealthCheck

Ports is the health check configuration for ports

config
HealthCheckConfig
(Optional)

DefaultConfig is the default health check configuration for all ports

status
HealthCheckPolicyStatus

LoadBalancerPolicy

LoadBalancerPolicy is the Schema for the LoadBalancerPolicy API

FieldDescription
apiVersion
string
gateway.flomesh.io/v1alpha1
kind
string
LoadBalancerPolicy
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
LoadBalancerPolicySpec


targetRef
sigs.k8s.io/gateway-api/apis/v1alpha2.PolicyTargetReference

TargetRef is the reference to the target resource to which the policy is applied

ports
[]PortLoadBalancer

Ports is the load balancer configuration for ports

type
LoadBalancerType
(Optional)

DefaultType is the default type of the load balancer for all ports

status
LoadBalancerPolicyStatus

RateLimitPolicy

RateLimitPolicy is the Schema for the RateLimitPolicy API

FieldDescription
apiVersion
string
gateway.flomesh.io/v1alpha1
kind
string
RateLimitPolicy
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
RateLimitPolicySpec


targetRef
sigs.k8s.io/gateway-api/apis/v1alpha2.PolicyTargetReference

TargetRef is the reference to the target resource to which the policy is applied

ports
[]PortRateLimit
(Optional)

Ports is the rate limit configuration for ports

bps
int64
(Optional)

DefaultBPS is the default rate limit for all ports

hostnames
[]HostnameRateLimit
(Optional)

Hostnames is the rate limit configuration for hostnames

http
[]HTTPRateLimit
(Optional)

HTTPRateLimits is the rate limit configuration for HTTP routes

grpc
[]GRPCRateLimit
(Optional)

GRPCRateLimits is the rate limit configuration for GRPC routes

config
L7RateLimit
(Optional)

DefaultConfig is the default rate limit for all routes and hostnames

status
RateLimitPolicyStatus

RetryPolicy

RetryPolicy is the Schema for the RetryPolicy API

FieldDescription
apiVersion
string
gateway.flomesh.io/v1alpha1
kind
string
RetryPolicy
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
RetryPolicySpec


targetRef
sigs.k8s.io/gateway-api/apis/v1alpha2.PolicyTargetReference

TargetRef is the reference to the target resource to which the policy is applied

ports
[]PortRetry

Ports is the retry configuration for ports

config
RetryConfig
(Optional)

DefaultConfig is the default retry configuration for all ports

status
RetryPolicyStatus

SessionStickyPolicy

SessionStickyPolicy is the Schema for the SessionStickyPolicy API

FieldDescription
apiVersion
string
gateway.flomesh.io/v1alpha1
kind
string
SessionStickyPolicy
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
SessionStickyPolicySpec


targetRef
sigs.k8s.io/gateway-api/apis/v1alpha2.PolicyTargetReference

TargetRef is the reference to the target resource to which the policy is applied

ports
[]PortSessionSticky

Ports is the session sticky configuration for ports

config
SessionStickyConfig
(Optional)

DefaultConfig is the default session sticky configuration for all ports

status
SessionStickyPolicyStatus

UpstreamTLSPolicy

UpstreamTLSPolicy is the Schema for the UpstreamTLSPolicy API

FieldDescription
apiVersion
string
gateway.flomesh.io/v1alpha1
kind
string
UpstreamTLSPolicy
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
UpstreamTLSPolicySpec


targetRef
sigs.k8s.io/gateway-api/apis/v1alpha2.PolicyTargetReference

TargetRef is the reference to the target resource to which the policy is applied

ports
[]PortUpstreamTLS

Ports is the session sticky configuration for ports

config
UpstreamTLSConfig
(Optional)

DefaultConfig is the default session sticky configuration for all ports

status
UpstreamTLSPolicyStatus

AccessControlConfig

(Appears on:AccessControlPolicySpec, GRPCAccessControl, HTTPAccessControl, HostnameAccessControl, PortAccessControl)

AccessControlConfig defines the access control configuration for a route

FieldDescription
blacklist
[]string
(Optional)

Blacklist is the list of IP addresses to be blacklisted

whitelist
[]string
(Optional)

Whitelist is the list of IP addresses to be whitelisted

enableXFF
bool
(Optional)

EnableXFF is the flag to enable X-Forwarded-For header

statusCode
int32
(Optional)

StatusCode is the response status code to be returned when the access control is exceeded

message
string
(Optional)

Message is the response message to be returned when the access control is exceeded

AccessControlPolicySpec

(Appears on:AccessControlPolicy)

AccessControlPolicySpec defines the desired state of AccessControlPolicy

FieldDescription
targetRef
sigs.k8s.io/gateway-api/apis/v1alpha2.PolicyTargetReference

TargetRef is the reference to the target resource to which the policy is applied

ports
[]PortAccessControl
(Optional)

Ports is the access control configuration for ports

hostnames
[]HostnameAccessControl
(Optional)

Hostnames is the access control configuration for hostnames

http
[]HTTPAccessControl
(Optional)

HTTPAccessControls is the access control configuration for HTTP routes

grpc
[]GRPCAccessControl
(Optional)

GRPCAccessControls is the access control configuration for GRPC routes

config
AccessControlConfig
(Optional)

DefaultConfig is the default access control for all ports, routes and hostnames

AccessControlPolicyStatus

(Appears on:AccessControlPolicy)

AccessControlPolicyStatus defines the observed state of AccessControlPolicy

FieldDescription
conditions
[]Kubernetes meta/v1.Condition
(Optional)

Conditions describe the current conditions of the AccessControlPolicy.

CircuitBreakingConfig

(Appears on:CircuitBreakingPolicySpec, PortCircuitBreaking)

FieldDescription
minRequestAmount
int32

MinRequestAmount is the minimum number of requests in the StatTimeWindow

statTimeWindow
int32

StatTimeWindow is the time window in seconds to collect statistics

slowTimeThreshold
float32
(Optional)

SlowTimeThreshold is the threshold in seconds to determine a slow request

slowAmountThreshold
int32
(Optional)

SlowAmountThreshold is the threshold of slow requests in the StatTimeWindow to trigger circuit breaking

slowRatioThreshold
float32
(Optional)

SlowRatioThreshold is the threshold of slow requests ratio in the StatTimeWindow to trigger circuit breaking

errorAmountThreshold
int32
(Optional)

ErrorAmountThreshold is the threshold of error requests in the StatTimeWindow to trigger circuit breaking

errorRatioThreshold
float32
(Optional)

ErrorRatioThreshold is the threshold of error requests ratio in the StatTimeWindow to trigger circuit breaking

degradedTimeWindow
int32

DegradedTimeWindow is the time window in seconds to degrade the service

degradedStatusCode
int32

DegradedStatusCode is the status code to return when the service is degraded

degradedResponseContent
string
(Optional)

DegradedResponseContent is the response content to return when the service is degraded

CircuitBreakingPolicySpec

(Appears on:CircuitBreakingPolicy)

CircuitBreakingPolicySpec defines the desired state of CircuitBreakingPolicy

FieldDescription
targetRef
sigs.k8s.io/gateway-api/apis/v1alpha2.PolicyTargetReference

TargetRef is the reference to the target resource to which the policy is applied

ports
[]PortCircuitBreaking

Ports is the circuit breaking configuration for ports

config
CircuitBreakingConfig
(Optional)

DefaultConfig is the default circuit breaking configuration for all ports

CircuitBreakingPolicyStatus

(Appears on:CircuitBreakingPolicy)

CircuitBreakingPolicyStatus defines the observed state of CircuitBreakingPolicy

FieldDescription
conditions
[]Kubernetes meta/v1.Condition
(Optional)

Conditions describe the current conditions of the CircuitBreakingPolicy.

FaultInjectionAbort

(Appears on:FaultInjectionConfig)

FaultInjectionAbort defines the abort configuration

FieldDescription
percent
int32

Percent is the percentage of requests to abort

statusCode
int32
(Optional)

StatusCode is the HTTP status code to return for the aborted request

message
string
(Optional)

Message is the HTTP status message to return for the aborted request

FaultInjectionConfig

(Appears on:FaultInjectionPolicySpec, GRPCFaultInjection, HTTPFaultInjection, HostnameFaultInjection)

FaultInjectionConfig defines the access control configuration for a route

FieldDescription
delay
FaultInjectionDelay
(Optional)

Delay defines the delay configuration

abort
FaultInjectionAbort
(Optional)

Abort defines the abort configuration

FaultInjectionDelay

(Appears on:FaultInjectionConfig)

FaultInjectionDelay defines the delay configuration

FieldDescription
percent
int32

Percent is the percentage of requests to delay

fixed
int64
(Optional)

Fixed is the fixed delay duration, default Unit is ms

range
FaultInjectionRange
(Optional)

Range is the range of delay duration

unit
string
(Optional)

Unit is the unit of delay duration, default Unit is ms

FaultInjectionPolicySpec

(Appears on:FaultInjectionPolicy)

FaultInjectionPolicySpec defines the desired state of FaultInjectionPolicy

FieldDescription
targetRef
sigs.k8s.io/gateway-api/apis/v1alpha2.PolicyTargetReference

TargetRef is the reference to the target resource to which the policy is applied

hostnames
[]HostnameFaultInjection
(Optional)

Hostnames is the access control configuration for hostnames

http
[]HTTPFaultInjection
(Optional)

HTTPFaultInjections is the access control configuration for HTTP routes

grpc
[]GRPCFaultInjection
(Optional)

GRPCFaultInjections is the access control configuration for GRPC routes

config
FaultInjectionConfig
(Optional)

DefaultConfig is the default access control for all ports, routes and hostnames

unit
string
(Optional)

Unit is the unit of delay duration, default Unit is ms

FaultInjectionPolicyStatus

(Appears on:FaultInjectionPolicy)

FaultInjectionPolicyStatus defines the observed state of FaultInjectionPolicy

FieldDescription
conditions
[]Kubernetes meta/v1.Condition
(Optional)

Conditions describe the current conditions of the FaultInjectionPolicy.

FaultInjectionRange

(Appears on:FaultInjectionDelay)

FieldDescription
min
int64

Min is the minimum value of the range, default Unit is ms

max
int64

Max is the maximum value of the range, default Unit is ms

GRPCAccessControl

(Appears on:AccessControlPolicySpec)

GRPCAccessControl defines the access control configuration for a GRPC route

FieldDescription
match
sigs.k8s.io/gateway-api/apis/v1alpha2.GRPCRouteMatch

Match is the match condition for the GRPC route

config
AccessControlConfig
(Optional)

Config is the access control configuration for the GRPC route

GRPCFaultInjection

(Appears on:FaultInjectionPolicySpec)

GRPCFaultInjection defines the access control configuration for a GRPC route

FieldDescription
match
sigs.k8s.io/gateway-api/apis/v1alpha2.GRPCRouteMatch

Match is the match condition for the GRPC route

config
FaultInjectionConfig
(Optional)

Config is the access control configuration for the GRPC route

GRPCRateLimit

(Appears on:RateLimitPolicySpec)

GRPCRateLimit defines the rate limit configuration for a GRPC route

FieldDescription
match
sigs.k8s.io/gateway-api/apis/v1alpha2.GRPCRouteMatch

Match is the match condition for the GRPC route

config
L7RateLimit
(Optional)

Config is the rate limit configuration for the GRPC route

GatewayTLSConfig

(Appears on:GatewayTLSPolicySpec, PortGatewayTLS)

GatewayTLSConfig defines the Gateway TLS configuration

FieldDescription
mTLS
bool
(Optional)

MTLS defines if the gateway port should use mTLS or not

GatewayTLSPolicySpec

(Appears on:GatewayTLSPolicy)

GatewayTLSPolicySpec defines the desired state of GatewayTLSPolicy

FieldDescription
targetRef
sigs.k8s.io/gateway-api/apis/v1alpha2.PolicyTargetReference

TargetRef is the reference to the target resource to which the policy is applied

ports
[]PortGatewayTLS

Ports is the Gateway TLS configuration for ports

config
GatewayTLSConfig
(Optional)

DefaultConfig is the default Gateway TLS configuration for all ports

GatewayTLSPolicyStatus

(Appears on:GatewayTLSPolicy)

GatewayTLSPolicyStatus defines the observed state of GatewayTLSPolicy

FieldDescription
conditions
[]Kubernetes meta/v1.Condition
(Optional)

Conditions describe the current conditions of the GatewayTLSPolicy.

HTTPAccessControl

(Appears on:AccessControlPolicySpec)

HTTPAccessControl defines the access control configuration for a HTTP route

FieldDescription
match
sigs.k8s.io/gateway-api/apis/v1beta1.HTTPRouteMatch

Match is the match condition for the HTTP route

config
AccessControlConfig
(Optional)

Config is the access control configuration for the HTTP route

HTTPFaultInjection

(Appears on:FaultInjectionPolicySpec)

HTTPFaultInjection defines the access control configuration for a HTTP route

FieldDescription
match
sigs.k8s.io/gateway-api/apis/v1beta1.HTTPRouteMatch

Match is the match condition for the HTTP route

config
FaultInjectionConfig
(Optional)

Config is the access control configuration for the HTTP route

HTTPRateLimit

(Appears on:RateLimitPolicySpec)

HTTPRateLimit defines the rate limit configuration for a HTTP route

FieldDescription
match
sigs.k8s.io/gateway-api/apis/v1beta1.HTTPRouteMatch

Match is the match condition for the HTTP route

config
L7RateLimit
(Optional)

Config is the rate limit configuration for the HTTP route

HealthCheckConfig

(Appears on:HealthCheckPolicySpec, PortHealthCheck)

FieldDescription
interval
int32

Interval is the interval in seconds to check the health of the service

maxFails
int32

MaxFails is the maximum number of consecutive failed health checks before considering the service as unhealthy

failTimeout
int32
(Optional)

FailTimeout is the time in seconds before considering the service as healthy if it’s marked as unhealthy, even if it’s already healthy

path
string
(Optional)

Path is the path to check the health of the HTTP service, if it’s not set, the health check will be TCP based

matches
[]HealthCheckMatch
(Optional)

Matches is the list of health check match conditions of HTTP service

HealthCheckMatch

(Appears on:HealthCheckConfig)

FieldDescription
statusCodes
[]int32
(Optional)

StatusCodes is the list of status codes to match

body
string
(Optional)

Body is the content of response body to match

headers
[]sigs.k8s.io/gateway-api/apis/v1beta1.HTTPHeader
(Optional)

Headers is the list of response headers to match

HealthCheckPolicySpec

(Appears on:HealthCheckPolicy)

HealthCheckPolicySpec defines the desired state of HealthCheckPolicy

FieldDescription
targetRef
sigs.k8s.io/gateway-api/apis/v1alpha2.PolicyTargetReference

TargetRef is the reference to the target resource to which the policy is applied

ports
[]PortHealthCheck

Ports is the health check configuration for ports

config
HealthCheckConfig
(Optional)

DefaultConfig is the default health check configuration for all ports

HealthCheckPolicyStatus

(Appears on:HealthCheckPolicy)

HealthCheckPolicyStatus defines the observed state of HealthCheckPolicy

FieldDescription
conditions
[]Kubernetes meta/v1.Condition
(Optional)

Conditions describe the current conditions of the HealthCheckPolicy.

HostnameAccessControl

(Appears on:AccessControlPolicySpec)

HostnameAccessControl defines the access control configuration for a hostname

FieldDescription
hostname
sigs.k8s.io/gateway-api/apis/v1beta1.Hostname

Hostname is the hostname for matching the access control

config
AccessControlConfig
(Optional)

Config is the access control configuration for the hostname

HostnameFaultInjection

(Appears on:FaultInjectionPolicySpec)

HostnameFaultInjection defines the access control configuration for a hostname

FieldDescription
hostname
sigs.k8s.io/gateway-api/apis/v1beta1.Hostname

Hostname is the hostname for matching the access control

config
FaultInjectionConfig
(Optional)

Config is the access control configuration for the hostname

HostnameRateLimit

(Appears on:RateLimitPolicySpec)

HostnameRateLimit defines the rate limit configuration for a hostname

FieldDescription
hostname
sigs.k8s.io/gateway-api/apis/v1beta1.Hostname

Hostname is the hostname for matching the rate limit

config
L7RateLimit
(Optional)

Config is the rate limit configuration for the hostname

L7RateLimit

(Appears on:GRPCRateLimit, HTTPRateLimit, HostnameRateLimit, RateLimitPolicySpec)

L7RateLimit defines the rate limit configuration for a route

FieldDescription
mode
RateLimitPolicyMode
(Optional)

Mode is the mode of the rate limit policy, Local or Global, default is Local

backlog
int32
(Optional)

Backlog is the number of requests allowed to wait in the queue

requests
int32

Requests is the number of requests allowed per statTimeWindow

burst
int32
(Optional)

Burst is the number of requests allowed to be bursted, if not specified, it will be the same as Requests

statTimeWindow
int32

StatTimeWindow is the time window in seconds

responseStatusCode
int32
(Optional)

ResponseStatusCode is the response status code to be returned when the rate limit is exceeded

responseHeadersToAdd
[]sigs.k8s.io/gateway-api/apis/v1beta1.HTTPHeader
(Optional)

ResponseHeadersToAdd is the response headers to be added when the rate limit is exceeded

LoadBalancerPolicySpec

(Appears on:LoadBalancerPolicy)

LoadBalancerPolicySpec defines the desired state of LoadBalancerPolicy

FieldDescription
targetRef
sigs.k8s.io/gateway-api/apis/v1alpha2.PolicyTargetReference

TargetRef is the reference to the target resource to which the policy is applied

ports
[]PortLoadBalancer

Ports is the load balancer configuration for ports

type
LoadBalancerType
(Optional)

DefaultType is the default type of the load balancer for all ports

LoadBalancerPolicyStatus

(Appears on:LoadBalancerPolicy)

LoadBalancerPolicyStatus defines the observed state of LoadBalancerPolicy

FieldDescription
conditions
[]Kubernetes meta/v1.Condition
(Optional)

Conditions describe the current conditions of the LoadBalancerPolicy.

LoadBalancerType (string alias)

(Appears on:LoadBalancerPolicySpec, PortLoadBalancer)

ValueDescription

"HashingLoadBalancer"

"LeastConnectionLoadBalancer"

"RoundRobinLoadBalancer"

PortAccessControl

(Appears on:AccessControlPolicySpec)

PortAccessControl defines the access control configuration for a port

FieldDescription
port
sigs.k8s.io/gateway-api/apis/v1beta1.PortNumber

Port is the port number for matching the access control

config
AccessControlConfig
(Optional)

Config is the access control configuration for the port

PortCircuitBreaking

(Appears on:CircuitBreakingPolicySpec)

FieldDescription
port
sigs.k8s.io/gateway-api/apis/v1beta1.PortNumber

Port is the port number of the target service

config
CircuitBreakingConfig
(Optional)

Config is the circuit breaking configuration for the port

PortGatewayTLS

(Appears on:GatewayTLSPolicySpec)

PortGatewayTLS defines the Gateway TLS configuration for a port

FieldDescription
port
sigs.k8s.io/gateway-api/apis/v1beta1.PortNumber

Port is the port number of the target service

config
GatewayTLSConfig
(Optional)

Config is the Gateway TLS configuration for the port

PortHealthCheck

(Appears on:HealthCheckPolicySpec)

FieldDescription
port
sigs.k8s.io/gateway-api/apis/v1beta1.PortNumber

Port is the port number of the target service

config
HealthCheckConfig
(Optional)

Config is the health check configuration for the port

PortLoadBalancer

(Appears on:LoadBalancerPolicySpec)

PortLoadBalancer defines the load balancer configuration for a port

FieldDescription
port
sigs.k8s.io/gateway-api/apis/v1beta1.PortNumber

Port is the port number for matching the load balancer

type
LoadBalancerType
(Optional)

Type is the type of the load balancer

PortRateLimit

(Appears on:RateLimitPolicySpec)

PortRateLimit defines the rate limit configuration for a port

FieldDescription
port
sigs.k8s.io/gateway-api/apis/v1beta1.PortNumber

Port is the port number for matching the rate limit

bps
int64
(Optional)

BPS is the rate limit in bytes per second for the port

PortRetry

(Appears on:RetryPolicySpec)

PortRetry defines the retry configuration for a port

FieldDescription
port
sigs.k8s.io/gateway-api/apis/v1beta1.PortNumber

Port is the port number of the target service

config
RetryConfig
(Optional)

Config is the retry configuration for the port

PortSessionSticky

(Appears on:SessionStickyPolicySpec)

PortSessionSticky defines the session sticky configuration for a port

FieldDescription
port
sigs.k8s.io/gateway-api/apis/v1beta1.PortNumber

Port is the port number of the target service

config
SessionStickyConfig
(Optional)

Config is the session sticky configuration for the port

PortUpstreamTLS

(Appears on:UpstreamTLSPolicySpec)

PortUpstreamTLS defines the session sticky configuration for a port

FieldDescription
port
sigs.k8s.io/gateway-api/apis/v1beta1.PortNumber

Port is the port number of the target service

config
UpstreamTLSConfig
(Optional)

Config is the session sticky configuration for the port

RateLimitPolicyMode (string alias)

(Appears on:L7RateLimit)

ValueDescription

"Global"

RateLimitPolicyModeGlobal is the global mode

"Local"

RateLimitPolicyModeLocal is the local mode

RateLimitPolicySpec

(Appears on:RateLimitPolicy)

RateLimitPolicySpec defines the desired state of RateLimitPolicy

FieldDescription
targetRef
sigs.k8s.io/gateway-api/apis/v1alpha2.PolicyTargetReference

TargetRef is the reference to the target resource to which the policy is applied

ports
[]PortRateLimit
(Optional)

Ports is the rate limit configuration for ports

bps
int64
(Optional)

DefaultBPS is the default rate limit for all ports

hostnames
[]HostnameRateLimit
(Optional)

Hostnames is the rate limit configuration for hostnames

http
[]HTTPRateLimit
(Optional)

HTTPRateLimits is the rate limit configuration for HTTP routes

grpc
[]GRPCRateLimit
(Optional)

GRPCRateLimits is the rate limit configuration for GRPC routes

config
L7RateLimit
(Optional)

DefaultConfig is the default rate limit for all routes and hostnames

RateLimitPolicyStatus

(Appears on:RateLimitPolicy)

RateLimitPolicyStatus defines the observed state of RateLimitPolicy

FieldDescription
conditions
[]Kubernetes meta/v1.Condition
(Optional)

Conditions describe the current conditions of the RateLimitPolicy.

RetryConfig

(Appears on:PortRetry, RetryPolicySpec)

RetryConfig defines the retry configuration

FieldDescription
retryOn
[]string

RetryOn is the list of retryable response codes, e.g. 5xx matches 500-599, or 500 matches just 500

numRetries
int32
(Optional)

NumRetries is the number of retries

backoffBaseInterval
float32
(Optional)

BackoffBaseInterval is the base interval for computing backoff in seconds

RetryPolicySpec

(Appears on:RetryPolicy)

RetryPolicySpec defines the desired state of RetryPolicy

FieldDescription
targetRef
sigs.k8s.io/gateway-api/apis/v1alpha2.PolicyTargetReference

TargetRef is the reference to the target resource to which the policy is applied

ports
[]PortRetry

Ports is the retry configuration for ports

config
RetryConfig
(Optional)

DefaultConfig is the default retry configuration for all ports

RetryPolicyStatus

(Appears on:RetryPolicy)

RetryPolicyStatus defines the observed state of RetryPolicy

FieldDescription
conditions
[]Kubernetes meta/v1.Condition
(Optional)

Conditions describe the current conditions of the RetryPolicy.

SessionStickyConfig

(Appears on:PortSessionSticky, SessionStickyPolicySpec)

SessionStickyConfig defines the session sticky configuration

FieldDescription
cookieName
string
(Optional)

CookieName is the name of the cookie used for sticky session

expires
int32
(Optional)

Expires is the expiration time of the cookie in seconds

SessionStickyPolicySpec

(Appears on:SessionStickyPolicy)

SessionStickyPolicySpec defines the desired state of SessionStickyPolicy

FieldDescription
targetRef
sigs.k8s.io/gateway-api/apis/v1alpha2.PolicyTargetReference

TargetRef is the reference to the target resource to which the policy is applied

ports
[]PortSessionSticky

Ports is the session sticky configuration for ports

config
SessionStickyConfig
(Optional)

DefaultConfig is the default session sticky configuration for all ports

SessionStickyPolicyStatus

(Appears on:SessionStickyPolicy)

SessionStickyPolicyStatus defines the observed state of SessionStickyPolicy

FieldDescription
conditions
[]Kubernetes meta/v1.Condition
(Optional)

Conditions describe the current conditions of the SessionStickyPolicy.

UpstreamTLSConfig

(Appears on:PortUpstreamTLS, UpstreamTLSPolicySpec)

UpstreamTLSConfig defines the session sticky configuration

FieldDescription
certificateRef
sigs.k8s.io/gateway-api/apis/v1beta1.SecretObjectReference

CertificateRef is the reference to the certificate used for TLS connection to upstream

mTLS
bool
(Optional)

MTLS is the flag to enable mutual TLS to upstream

UpstreamTLSPolicySpec

(Appears on:UpstreamTLSPolicy)

UpstreamTLSPolicySpec defines the desired state of UpstreamTLSPolicy

FieldDescription
targetRef
sigs.k8s.io/gateway-api/apis/v1alpha2.PolicyTargetReference

TargetRef is the reference to the target resource to which the policy is applied

ports
[]PortUpstreamTLS

Ports is the session sticky configuration for ports

config
UpstreamTLSConfig
(Optional)

DefaultConfig is the default session sticky configuration for all ports

UpstreamTLSPolicyStatus

(Appears on:UpstreamTLSPolicy)

UpstreamTLSPolicyStatus defines the observed state of UpstreamTLSPolicy

FieldDescription
conditions
[]Kubernetes meta/v1.Condition
(Optional)

Conditions describe the current conditions of the UpstreamTLSPolicy.


Generated with gen-crd-api-reference-docs on git commit 8abe9ab.

Feedback

Was this page helpful?