kubernetes: k8s.io/kubernetes/pkg/apis/networking Index | Files | Directories

package networking

import "k8s.io/kubernetes/pkg/apis/networking"

Index

Package Files

doc.go register.go types.go zz_generated.deepcopy.go

Constants

const GroupName = "networking.k8s.io"

GroupName is the group name use in this package

Variables

var (
    // SchemeBuilder points to a list of functions added to Scheme.
    SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
    // AddToScheme applies all the stored functions to the scheme.
    AddToScheme = SchemeBuilder.AddToScheme
)
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: runtime.APIVersionInternal}

SchemeGroupVersion is group version used to register these objects

func Kind Uses

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns a Group qualified GroupKind

func Resource Uses

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

type HTTPIngressPath Uses

type HTTPIngressPath struct {
    // Path is an extended POSIX regex as defined by IEEE Std 1003.1,
    // (i.e this follows the egrep/unix syntax, not the perl syntax)
    // matched against the path of an incoming request. Currently it can
    // contain characters disallowed from the conventional "path"
    // part of a URL as defined by RFC 3986. Paths must begin with
    // a '/'. If unspecified, the path defaults to a catch all sending
    // traffic to the backend.
    // +optional
    Path string

    // Backend defines the referenced service endpoint to which the traffic
    // will be forwarded to.
    Backend IngressBackend
}

HTTPIngressPath associates a path regex with a backend. Incoming urls matching the path are forwarded to the backend.

func (*HTTPIngressPath) DeepCopy Uses

func (in *HTTPIngressPath) DeepCopy() *HTTPIngressPath

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HTTPIngressPath.

func (*HTTPIngressPath) DeepCopyInto Uses

func (in *HTTPIngressPath) DeepCopyInto(out *HTTPIngressPath)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type HTTPIngressRuleValue Uses

type HTTPIngressRuleValue struct {
    // A collection of paths that map requests to backends.
    Paths []HTTPIngressPath
}

HTTPIngressRuleValue is a list of http selectors pointing to backends. In the example: http://<host>/<path>?<searchpart> -> backend where where parts of the url correspond to RFC 3986, this resource will be used to match against everything after the last '/' and before the first '?' or '#'.

func (*HTTPIngressRuleValue) DeepCopy Uses

func (in *HTTPIngressRuleValue) DeepCopy() *HTTPIngressRuleValue

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HTTPIngressRuleValue.

func (*HTTPIngressRuleValue) DeepCopyInto Uses

func (in *HTTPIngressRuleValue) DeepCopyInto(out *HTTPIngressRuleValue)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type IPBlock Uses

type IPBlock struct {
    // CIDR is a string representing the IP Block
    // Valid examples are "192.168.1.1/24"
    CIDR string
    // Except is a slice of CIDRs that should not be included within an IP Block
    // Valid examples are "192.168.1.1/24"
    // Except values will be rejected if they are outside the CIDR range
    // +optional
    Except []string
}

IPBlock describes a particular CIDR (Ex. "192.168.1.1/24") that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs that should not be included within this rule.

func (*IPBlock) DeepCopy Uses

func (in *IPBlock) DeepCopy() *IPBlock

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IPBlock.

func (*IPBlock) DeepCopyInto Uses

func (in *IPBlock) DeepCopyInto(out *IPBlock)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Ingress Uses

type Ingress struct {
    metav1.TypeMeta
    // Standard object's metadata.
    // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    // +optional
    metav1.ObjectMeta

    // Spec is the desired state of the Ingress.
    // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
    // +optional
    Spec IngressSpec

    // Status is the current state of the Ingress.
    // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
    // +optional
    Status IngressStatus
}

Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend. An Ingress can be configured to give services externally-reachable urls, load balance traffic, terminate SSL, offer name based virtual hosting etc.

func (*Ingress) DeepCopy Uses

func (in *Ingress) DeepCopy() *Ingress

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Ingress.

func (*Ingress) DeepCopyInto Uses

func (in *Ingress) DeepCopyInto(out *Ingress)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Ingress) DeepCopyObject Uses

func (in *Ingress) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type IngressBackend Uses

type IngressBackend struct {
    // Specifies the name of the referenced service.
    ServiceName string

    // Specifies the port of the referenced service.
    ServicePort intstr.IntOrString
}

IngressBackend describes all endpoints for a given service and port.

func (*IngressBackend) DeepCopy Uses

func (in *IngressBackend) DeepCopy() *IngressBackend

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IngressBackend.

func (*IngressBackend) DeepCopyInto Uses

func (in *IngressBackend) DeepCopyInto(out *IngressBackend)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type IngressList Uses

type IngressList struct {
    metav1.TypeMeta
    // Standard object's metadata.
    // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    // +optional
    metav1.ListMeta

    // Items is the list of Ingress.
    Items []Ingress
}

IngressList is a collection of Ingress.

func (*IngressList) DeepCopy Uses

func (in *IngressList) DeepCopy() *IngressList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IngressList.

func (*IngressList) DeepCopyInto Uses

func (in *IngressList) DeepCopyInto(out *IngressList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*IngressList) DeepCopyObject Uses

func (in *IngressList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type IngressRule Uses

type IngressRule struct {
    // Host is the fully qualified domain name of a network host, as defined
    // by RFC 3986. Note the following deviations from the "host" part of the
    // URI as defined in the RFC:
    // 1. IPs are not allowed. Currently an IngressRuleValue can only apply to the
    //	  IP in the Spec of the parent Ingress.
    // 2. The `:` delimiter is not respected because ports are not allowed.
    //	  Currently the port of an Ingress is implicitly :80 for http and
    //	  :443 for https.
    // Both these may change in the future.
    // Incoming requests are matched against the host before the IngressRuleValue.
    // If the host is unspecified, the Ingress routes all traffic based on the
    // specified IngressRuleValue.
    // +optional
    Host string
    // IngressRuleValue represents a rule to route requests for this IngressRule.
    // If unspecified, the rule defaults to a http catch-all. Whether that sends
    // just traffic matching the host to the default backend or all traffic to the
    // default backend, is left to the controller fulfilling the Ingress. Http is
    // currently the only supported IngressRuleValue.
    // +optional
    IngressRuleValue
}

IngressRule represents the rules mapping the paths under a specified host to the related backend services. Incoming requests are first evaluated for a host match, then routed to the backend associated with the matching IngressRuleValue.

func (*IngressRule) DeepCopy Uses

func (in *IngressRule) DeepCopy() *IngressRule

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IngressRule.

func (*IngressRule) DeepCopyInto Uses

func (in *IngressRule) DeepCopyInto(out *IngressRule)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type IngressRuleValue Uses

type IngressRuleValue struct {

    // +optional
    HTTP *HTTPIngressRuleValue
}

IngressRuleValue represents a rule to apply against incoming requests. If the rule is satisfied, the request is routed to the specified backend. Currently mixing different types of rules in a single Ingress is disallowed, so exactly one of the following must be set.

func (*IngressRuleValue) DeepCopy Uses

func (in *IngressRuleValue) DeepCopy() *IngressRuleValue

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IngressRuleValue.

func (*IngressRuleValue) DeepCopyInto Uses

func (in *IngressRuleValue) DeepCopyInto(out *IngressRuleValue)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type IngressSpec Uses

type IngressSpec struct {
    // A default backend capable of servicing requests that don't match any
    // rule. At least one of 'backend' or 'rules' must be specified. This field
    // is optional to allow the loadbalancer controller or defaulting logic to
    // specify a global default.
    // +optional
    Backend *IngressBackend

    // TLS configuration. Currently the Ingress only supports a single TLS
    // port, 443. If multiple members of this list specify different hosts, they
    // will be multiplexed on the same port according to the hostname specified
    // through the SNI TLS extension, if the ingress controller fulfilling the
    // ingress supports SNI.
    // +optional
    TLS []IngressTLS

    // A list of host rules used to configure the Ingress. If unspecified, or
    // no rule matches, all traffic is sent to the default backend.
    // +optional
    Rules []IngressRule
}

IngressSpec describes the Ingress the user wishes to exist.

func (*IngressSpec) DeepCopy Uses

func (in *IngressSpec) DeepCopy() *IngressSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IngressSpec.

func (*IngressSpec) DeepCopyInto Uses

func (in *IngressSpec) DeepCopyInto(out *IngressSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type IngressStatus Uses

type IngressStatus struct {
    // LoadBalancer contains the current status of the load-balancer.
    // +optional
    LoadBalancer api.LoadBalancerStatus
}

IngressStatus describe the current state of the Ingress.

func (*IngressStatus) DeepCopy Uses

func (in *IngressStatus) DeepCopy() *IngressStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IngressStatus.

func (*IngressStatus) DeepCopyInto Uses

func (in *IngressStatus) DeepCopyInto(out *IngressStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type IngressTLS Uses

type IngressTLS struct {
    // Hosts are a list of hosts included in the TLS certificate. The values in
    // this list must match the name/s used in the tlsSecret. Defaults to the
    // wildcard host setting for the loadbalancer controller fulfilling this
    // Ingress, if left unspecified.
    // +optional
    Hosts []string
    // SecretName is the name of the secret used to terminate SSL traffic on 443.
    // Field is left optional to allow SSL routing based on SNI hostname alone.
    // If the SNI host in a listener conflicts with the "Host" header field used
    // by an IngressRule, the SNI host is used for termination and value of the
    // Host header is used for routing.
    // +optional
    SecretName string
}

IngressTLS describes the transport layer security associated with an Ingress.

func (*IngressTLS) DeepCopy Uses

func (in *IngressTLS) DeepCopy() *IngressTLS

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IngressTLS.

func (*IngressTLS) DeepCopyInto Uses

func (in *IngressTLS) DeepCopyInto(out *IngressTLS)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type NetworkPolicy Uses

type NetworkPolicy struct {
    metav1.TypeMeta
    // +optional
    metav1.ObjectMeta

    // Specification of the desired behavior for this NetworkPolicy.
    // +optional
    Spec NetworkPolicySpec
}

NetworkPolicy describes what network traffic is allowed for a set of Pods

func (*NetworkPolicy) DeepCopy Uses

func (in *NetworkPolicy) DeepCopy() *NetworkPolicy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NetworkPolicy.

func (*NetworkPolicy) DeepCopyInto Uses

func (in *NetworkPolicy) DeepCopyInto(out *NetworkPolicy)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*NetworkPolicy) DeepCopyObject Uses

func (in *NetworkPolicy) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type NetworkPolicyEgressRule Uses

type NetworkPolicyEgressRule struct {
    // List of destination ports for outgoing traffic.
    // Each item in this list is combined using a logical OR. If this field is
    // empty or missing, this rule matches all ports (traffic not restricted by port).
    // If this field is present and contains at least one item, then this rule allows
    // traffic only if the traffic matches at least one port in the list.
    // +optional
    Ports []NetworkPolicyPort

    // List of destinations for outgoing traffic of pods selected for this rule.
    // Items in this list are combined using a logical OR operation. If this field is
    // empty or missing, this rule matches all destinations (traffic not restricted by
    // destination). If this field is present and contains at least one item, this rule
    // allows traffic only if the traffic matches at least one item in the to list.
    // +optional
    To  []NetworkPolicyPeer
}

NetworkPolicyEgressRule describes a particular set of traffic that is allowed out of pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and to. This type is beta-level in 1.8

func (*NetworkPolicyEgressRule) DeepCopy Uses

func (in *NetworkPolicyEgressRule) DeepCopy() *NetworkPolicyEgressRule

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NetworkPolicyEgressRule.

func (*NetworkPolicyEgressRule) DeepCopyInto Uses

func (in *NetworkPolicyEgressRule) DeepCopyInto(out *NetworkPolicyEgressRule)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type NetworkPolicyIngressRule Uses

type NetworkPolicyIngressRule struct {
    // List of ports which should be made accessible on the pods selected for this
    // rule. Each item in this list is combined using a logical OR. If this field is
    // empty or missing, this rule matches all ports (traffic not restricted by port).
    // If this field is present and contains at least one item, then this rule allows
    // traffic only if the traffic matches at least one port in the list.
    // +optional
    Ports []NetworkPolicyPort

    // List of sources which should be able to access the pods selected for this rule.
    // Items in this list are combined using a logical OR operation. If this field is
    // empty or missing, this rule matches all sources (traffic not restricted by
    // source). If this field is present and contains at least one item, this rule
    // allows traffic only if the traffic matches at least one item in the from list.
    // +optional
    From []NetworkPolicyPeer
}

NetworkPolicyIngressRule describes a particular set of traffic that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and from.

func (*NetworkPolicyIngressRule) DeepCopy Uses

func (in *NetworkPolicyIngressRule) DeepCopy() *NetworkPolicyIngressRule

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NetworkPolicyIngressRule.

func (*NetworkPolicyIngressRule) DeepCopyInto Uses

func (in *NetworkPolicyIngressRule) DeepCopyInto(out *NetworkPolicyIngressRule)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type NetworkPolicyList Uses

type NetworkPolicyList struct {
    metav1.TypeMeta
    // +optional
    metav1.ListMeta

    Items []NetworkPolicy
}

NetworkPolicyList is a list of NetworkPolicy objects.

func (*NetworkPolicyList) DeepCopy Uses

func (in *NetworkPolicyList) DeepCopy() *NetworkPolicyList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NetworkPolicyList.

func (*NetworkPolicyList) DeepCopyInto Uses

func (in *NetworkPolicyList) DeepCopyInto(out *NetworkPolicyList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*NetworkPolicyList) DeepCopyObject Uses

func (in *NetworkPolicyList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type NetworkPolicyPeer Uses

type NetworkPolicyPeer struct {
    // This is a label selector which selects Pods. This field follows standard label
    // selector semantics; if present but empty, it selects all pods.
    //
    // If NamespaceSelector is also set, then the NetworkPolicyPeer as a whole selects
    // the Pods matching PodSelector in the Namespaces selected by NamespaceSelector.
    // Otherwise it selects the Pods matching PodSelector in the policy's own Namespace.
    // +optional
    PodSelector *metav1.LabelSelector

    // Selects Namespaces using cluster-scoped labels. This field follows standard label
    // selector semantics; if present but empty, it selects all namespaces.
    //
    // If PodSelector is also set, then the NetworkPolicyPeer as a whole selects
    // the Pods matching PodSelector in the Namespaces selected by NamespaceSelector.
    // Otherwise it selects all Pods in the Namespaces selected by NamespaceSelector.
    // +optional
    NamespaceSelector *metav1.LabelSelector

    // IPBlock defines policy on a particular IPBlock. If this field is set then
    // neither of the other fields can be.
    // +optional
    IPBlock *IPBlock
}

NetworkPolicyPeer describes a peer to allow traffic from.

func (*NetworkPolicyPeer) DeepCopy Uses

func (in *NetworkPolicyPeer) DeepCopy() *NetworkPolicyPeer

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NetworkPolicyPeer.

func (*NetworkPolicyPeer) DeepCopyInto Uses

func (in *NetworkPolicyPeer) DeepCopyInto(out *NetworkPolicyPeer)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type NetworkPolicyPort Uses

type NetworkPolicyPort struct {
    // The protocol (TCP, UDP, or SCTP) which traffic must match. If not specified, this
    // field defaults to TCP.
    // +optional
    Protocol *api.Protocol

    // The port on the given protocol. This can either be a numerical or named port on
    // a pod. If this field is not provided, this matches all port names and numbers.
    // +optional
    Port *intstr.IntOrString
}

NetworkPolicyPort describes a port to allow traffic on

func (*NetworkPolicyPort) DeepCopy Uses

func (in *NetworkPolicyPort) DeepCopy() *NetworkPolicyPort

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NetworkPolicyPort.

func (*NetworkPolicyPort) DeepCopyInto Uses

func (in *NetworkPolicyPort) DeepCopyInto(out *NetworkPolicyPort)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type NetworkPolicySpec Uses

type NetworkPolicySpec struct {
    // Selects the pods to which this NetworkPolicy object applies. The array of
    // ingress rules is applied to any pods selected by this field. Multiple network
    // policies can select the same set of pods. In this case, the ingress rules for
    // each are combined additively. This field is NOT optional and follows standard
    // label selector semantics. An empty podSelector matches all pods in this
    // namespace.
    PodSelector metav1.LabelSelector

    // List of ingress rules to be applied to the selected pods. Traffic is allowed to
    // a pod if there are no NetworkPolicies selecting the pod
    // (and cluster policy otherwise allows the traffic), OR if the traffic source is
    // the pod's local node, OR if the traffic matches at least one ingress rule
    // across all of the NetworkPolicy objects whose podSelector matches the pod. If
    // this field is empty then this NetworkPolicy does not allow any traffic (and serves
    // solely to ensure that the pods it selects are isolated by default)
    // +optional
    Ingress []NetworkPolicyIngressRule

    // List of egress rules to be applied to the selected pods. Outgoing traffic is
    // allowed if there are no NetworkPolicies selecting the pod (and cluster policy
    // otherwise allows the traffic), OR if the traffic matches at least one egress rule
    // across all of the NetworkPolicy objects whose podSelector matches the pod. If
    // this field is empty then this NetworkPolicy limits all outgoing traffic (and serves
    // solely to ensure that the pods it selects are isolated by default).
    // This field is beta-level in 1.8
    // +optional
    Egress []NetworkPolicyEgressRule

    // List of rule types that the NetworkPolicy relates to.
    // Valid options are "Ingress", "Egress", or "Ingress,Egress".
    // If this field is not specified, it will default based on the existence of Ingress or Egress rules;
    // policies that contain an Egress section are assumed to affect Egress, and all policies
    // (whether or not they contain an Ingress section) are assumed to affect Ingress.
    // If you want to write an egress-only policy, you must explicitly specify policyTypes [ "Egress" ].
    // Likewise, if you want to write a policy that specifies that no egress is allowed,
    // you must specify a policyTypes value that include "Egress" (since such a policy would not include
    // an Egress section and would otherwise default to just [ "Ingress" ]).
    // This field is beta-level in 1.8
    // +optional
    PolicyTypes []PolicyType
}

NetworkPolicySpec provides the specification of a NetworkPolicy

func (*NetworkPolicySpec) DeepCopy Uses

func (in *NetworkPolicySpec) DeepCopy() *NetworkPolicySpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NetworkPolicySpec.

func (*NetworkPolicySpec) DeepCopyInto Uses

func (in *NetworkPolicySpec) DeepCopyInto(out *NetworkPolicySpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type PolicyType Uses

type PolicyType string

PolicyType describes the NetworkPolicy type This type is beta-level in 1.8

const (
    // PolicyTypeIngress is a NetworkPolicy that affects ingress traffic on selected pods
    PolicyTypeIngress PolicyType = "Ingress"
    // PolicyTypeEgress is a NetworkPolicy that affects egress traffic on selected pods
    PolicyTypeEgress PolicyType = "Egress"
)

Directories

PathSynopsis
fuzzer
installPackage install installs the experimental API group, making it available as an option to all of the API encoding/decoding machinery.
v1
v1beta1
validation

Package networking imports 5 packages (graph) and is imported by 148 packages. Updated 2019-08-31. Refresh now. Tools for package owners.