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.

    Field Description
    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.

    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.

    Field Description
    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.

    Field Description
    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.

    Field Description
    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.

    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.

    Field Description
    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.

    Field Description
    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.

    Field Description
    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.

    Field Description
    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.

    Field Description
    number
    int

    Number defines the port number.
    protocol
    string

    Protocol defines the protocol served by the port.

    TLSSpec

    (Appears on:BackendSpec)

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

    Field Description
    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.

    Generated with gen-crd-api-reference-docs on git commit 26886c4f.