Packages:

policy.openservicemesh.io/v1alpha1

Package v1alpha1 is the v1alpha1 version of the API.

Resource Types:

BackendSpec

(Appears on:IngressBackendSpec)

BackendSpec is the type used to represent a Backend specified in the IngressBackend policy specification.

FieldDescription
name
string

Name defines the name of the backend.

port
PortSpec

Port defines the specification for the backend’s port.

tls
TLSSpec
(Optional)

TLS defines the specification for the backend’s TLS configuration.

ConnectionSettingsSpec

(Appears on:UpstreamTrafficSettingSpec)

ConnectionSettingsSpec defines the connection settings for an upstream host.

FieldDescription
tcp
TCPConnectionSettings
(Optional)

TCP specifies the TCP level connection settings. Applies to both TCP and HTTP connections.

http
HTTPConnectionSettings
(Optional)

HTTP specifies the HTTP level connection settings.

Egress

Egress is the type used to represent an Egress traffic policy. An Egress policy allows applications to access endpoints external to the service mesh or cluster based on the specified rules in the policy.

FieldDescription
metadata
Kubernetes meta/v1.ObjectMeta
(Optional)

Object’s metadata

Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
EgressSpec
(Optional)

Spec is the Egress policy specification



sources
[]EgressSourceSpec

Sources defines the list of sources the Egress policy applies to.

hosts
[]string
(Optional)

Hosts defines the list of external hosts the Egress policy will allow access to.

  • For HTTP traffic, the HTTP Host/Authority header is matched against the list of Hosts specified.

  • For HTTPS traffic, the Server Name Indication (SNI) indicated by the client in the TLS handshake is matched against the list of Hosts specified.

  • For non-HTTP(s) based protocols, the Hosts field is ignored.

ipAddresses
[]string
(Optional)

IPAddresses defines the list of external IP address ranges the Egress policy applies to. The destination IP address of the traffic is matched against the list of IPAddresses specified as a CIDR range.

ports
[]PortSpec

Ports defines the list of ports the Egress policy is applies to. The destination port of the traffic is matched against the list of Ports specified.

matches
[]Kubernetes core/v1.TypedLocalObjectReference
(Optional)

Matches defines the list of object references the Egress policy should match on.

EgressSourceSpec

(Appears on:EgressSpec)

EgressSourceSpec is the type used to represent the Source in the list of Sources specified in an Egress policy specification.

FieldDescription
kind
string

Kind defines the kind for the source in the Egress policy, ex. ServiceAccount.

name
string

Name defines the name of the source for the given Kind.

namespace
string

Namespace defines the namespace for the given source.

EgressSpec

(Appears on:Egress)

EgressSpec is the type used to represent the Egress policy specification.

FieldDescription
sources
[]EgressSourceSpec

Sources defines the list of sources the Egress policy applies to.

hosts
[]string
(Optional)

Hosts defines the list of external hosts the Egress policy will allow access to.

  • For HTTP traffic, the HTTP Host/Authority header is matched against the list of Hosts specified.

  • For HTTPS traffic, the Server Name Indication (SNI) indicated by the client in the TLS handshake is matched against the list of Hosts specified.

  • For non-HTTP(s) based protocols, the Hosts field is ignored.

ipAddresses
[]string
(Optional)

IPAddresses defines the list of external IP address ranges the Egress policy applies to. The destination IP address of the traffic is matched against the list of IPAddresses specified as a CIDR range.

ports
[]PortSpec

Ports defines the list of ports the Egress policy is applies to. The destination port of the traffic is matched against the list of Ports specified.

matches
[]Kubernetes core/v1.TypedLocalObjectReference
(Optional)

Matches defines the list of object references the Egress policy should match on.

HTTPConnectionSettings

(Appears on:ConnectionSettingsSpec)

HTTPConnectionSettings defines the HTTP connection settings for an upstream host.

FieldDescription
maxRequests
uint32
(Optional)

MaxRequests specifies the maximum number of parallel requests allowed to the upstream host. Defaults to 4294967295 (2^32 - 1) if not specified.

maxRequestsPerConnection
uint32
(Optional)

MaxRequestsPerConnection specifies the maximum number of requests per connection allowed to the upstream host. Defaults to unlimited if not specified.

maxPendingRequests
uint32
(Optional)

MaxPendingRequests specifies the maximum number of pending HTTP requests allowed to the upstream host. For HTTP/2 connections, if maxRequestsPerConnection is not configured, all requests will be multiplexed over the same connection so this circuit breaker will only be hit when no connection is already established. Defaults to 4294967295 (2^32 - 1) if not specified.

maxRetries
uint32
(Optional)

MaxRetries specifies the maximum number of parallel retries allowed to the upstream host. Defaults to 4294967295 (2^32 - 1) if not specified.

IngressBackend

IngressBackend is the type used to represent an Ingress backend policy. An Ingress backend policy authorizes one or more backends to accept ingress traffic from one or more sources.

FieldDescription
metadata
Kubernetes meta/v1.ObjectMeta
(Optional)

Object’s metadata

Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
IngressBackendSpec
(Optional)

Spec is the Ingress backend policy specification



backends
[]BackendSpec

Backends defines the list of backends the IngressBackend policy applies to.

sources
[]IngressSourceSpec

Sources defines the list of sources the IngressBackend policy applies to.

matches
[]Kubernetes core/v1.TypedLocalObjectReference
(Optional)

Matches defines the list of object references the IngressBackend policy should match on.

status
IngressBackendStatus
(Optional)

Status is the status of the IngressBackend configuration.

IngressBackendSpec

(Appears on:IngressBackend)

IngressBackendSpec is the type used to represent the IngressBackend policy specification.

FieldDescription
backends
[]BackendSpec

Backends defines the list of backends the IngressBackend policy applies to.

sources
[]IngressSourceSpec

Sources defines the list of sources the IngressBackend policy applies to.

matches
[]Kubernetes core/v1.TypedLocalObjectReference
(Optional)

Matches defines the list of object references the IngressBackend policy should match on.

IngressBackendStatus

(Appears on:IngressBackend)

IngressBackendStatus is the type used to represent the status of an IngressBackend resource.

FieldDescription
currentStatus
string
(Optional)

CurrentStatus defines the current status of an IngressBackend resource.

reason
string
(Optional)

Reason defines the reason for the current status of an IngressBackend resource.

IngressSourceSpec

(Appears on:IngressBackendSpec)

IngressSourceSpec is the type used to represent the Source in the list of Sources specified in an IngressBackend policy specification.

FieldDescription
kind
string

Kind defines the kind for the source in the IngressBackend policy. Must be one of: Service, AuthenticatedPrincipal, IPRange

name
string

Name defines the name of the source for the given Kind.

namespace
string
(Optional)

Namespace defines the namespace for the given source.

PortSpec

(Appears on:BackendSpec, EgressSpec)

PortSpec is the type used to represent the Port in the list of Ports specified in an Egress policy specification.

FieldDescription
number
int

Number defines the port number.

protocol
string

Protocol defines the protocol served by the port.

Retry

Retry is the type used to represent a Retry policy. A Retry policy authorizes retries to failed attempts for outbound traffic from one service source to one or more destination services.

FieldDescription
metadata
Kubernetes meta/v1.ObjectMeta
(Optional)

Object’s metadata

Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
RetrySpec
(Optional)

Spec is the Retry policy specification



source
RetrySrcDstSpec

Source defines the source the Retry policy applies to.

destinations
[]RetrySrcDstSpec

Destinations defines the list of destinations the Retry policy applies to.

retryPolicy
RetryPolicySpec

RetryPolicy defines the retry policy the Retry policy applies.

RetryPolicySpec

(Appears on:RetrySpec)

RetryPolicySpec is the type used to represent the retry policy specified in the Retry policy specification.

FieldDescription
retryOn
string

RetryOn defines the policies to retry on, delimited by comma.

perTryTimeout
string

PerTryTimeout defines the time allowed for a retry before it’s considered a failed attempt.

numRetries
int

NumRetries defines the max number of retries to attempt.

retryBackoffInterval
string

RetryBackoffBaseInterval defines the base interval for exponential retry backoff.

RetrySpec

(Appears on:Retry)

RetrySpec is the type used to represent the Retry policy specification.

FieldDescription
source
RetrySrcDstSpec

Source defines the source the Retry policy applies to.

destinations
[]RetrySrcDstSpec

Destinations defines the list of destinations the Retry policy applies to.

retryPolicy
RetryPolicySpec

RetryPolicy defines the retry policy the Retry policy applies.

RetrySrcDstSpec

(Appears on:RetrySpec)

RetrySrcDstSpec is the type used to represent the Destination in the list of Destinations and the Source specified in the Retry policy specification.

FieldDescription
kind
string

Kind defines the kind for the Src/Dst in the Retry policy.

name
string

Name defines the name of the Src/Dst for the given Kind.

namespace
string

Namespace defines the namespace for the given Src/Dst.

TCPConnectionSettings

(Appears on:ConnectionSettingsSpec)

TCPConnectionSettings defines the TCP connection settings for an upstream host.

FieldDescription
maxConnections
uint32
(Optional)

MaxConnections specifies the maximum number of TCP connections allowed to the upstream host. Defaults to 4294967295 (2^32 - 1) if not specified.

connectTimeout
Kubernetes meta/v1.Duration
(Optional)

ConnectTimeout specifies the TCP connection timeout. Defaults to 5s if not specified.

TLSSpec

(Appears on:BackendSpec)

TLSSpec is the type used to represent the backend’s TLS configuration.

FieldDescription
skipClientCertValidation
bool

SkipClientCertValidation defines whether the backend should skip validating the certificate presented by the client.

sniHosts
[]string
(Optional)

SNIHosts defines the SNI hostnames that the backend allows the client to connect to.

UpstreamTrafficSetting

UpstreamTrafficSetting defines the settings applicable to traffic destined to an upstream host.

FieldDescription
metadata
Kubernetes meta/v1.ObjectMeta
(Optional)

Object’s metadata

Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
UpstreamTrafficSettingSpec
(Optional)

Spec is the UpstreamTrafficSetting policy specification



host
string

Host the upstream traffic is directed to. Must either be an FQDN corresponding to the upstream service or the name of the upstream service. If only the service name is specified, the FQDN is derived from the service name and the namespace of the UpstreamTrafficSetting rule.

connectionSettings
ConnectionSettingsSpec
(Optional)

ConnectionSettings specifies the connection settings for traffic directed to the upstream host.

status
UpstreamTrafficSettingStatus
(Optional)

Status is the status of the UpstreamTrafficSetting resource.

UpstreamTrafficSettingSpec

(Appears on:UpstreamTrafficSetting)

UpstreamTrafficSettingSpec defines the upstream traffic setting specification.

FieldDescription
host
string

Host the upstream traffic is directed to. Must either be an FQDN corresponding to the upstream service or the name of the upstream service. If only the service name is specified, the FQDN is derived from the service name and the namespace of the UpstreamTrafficSetting rule.

connectionSettings
ConnectionSettingsSpec
(Optional)

ConnectionSettings specifies the connection settings for traffic directed to the upstream host.

UpstreamTrafficSettingStatus

(Appears on:UpstreamTrafficSetting)

UpstreamTrafficSettingStatus defines the status of an UpstreamTrafficSetting resource.

FieldDescription
currentStatus
string
(Optional)

CurrentStatus defines the current status of an UpstreamTrafficSetting resource.

reason
string
(Optional)

Reason defines the reason for the current status of an UpstreamTrafficSetting resource.


Generated with gen-crd-api-reference-docs on git commit 407bbedd5.