avionix.kube.networking¶
-
class
avionix.kube.networking.IPBlock(cidr, except_)¶ - Parameters
cidr (
str) – CIDR is a string representing the IP Block Valid examples are “192.168.1.1/24” or “2001:db9::/64”except – Except is a slice of CIDRs that should not be included within an IP Block Valid examples are “192.168.1.1/24” or “2001:db9::/64” Except values will be rejected if they are outside the CIDR range
-
class
avionix.kube.networking.IngressClass(metadata, spec, api_version=None)¶ - Parameters
metadata (
ObjectMeta) – Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata # noqaspec (
IngressClassSpec) – Spec is the desired state of the IngressClass. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status # noqaapi_version (
Optional[str]) – APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources # noqa
-
class
avionix.kube.networking.IngressClassList(metadata, items, api_version=None)¶ - Parameters
metadata (
ListMeta) – Standard list metadata.items (
List[IngressClass]) – Items is the list of IngressClasses.api_version (
Optional[str]) – APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources # noqa
-
class
avionix.kube.networking.IngressClassSpec(controller, parameters=None)¶ - Parameters
controller (
str) – Controller refers to the name of the controller that should handle this class. This allows for different “flavors” that are controlled by the same controller. For example, you may have different Parameters for the same implementing controller. This should be specified as a domain-prefixed path no more than 250 characters in length, e.g. “acme.io/ingress-controller”. This field is immutable.parameters (
Optional[TypedLocalObjectReference]) – Parameters is a link to a custom resource containing additional configuration for the controller. This is optional if the controller does not require extra parameters.
-
class
avionix.kube.networking.NetworkPolicy(metadata, spec, api_version=None)¶ - Parameters
metadata (
ObjectMeta) – Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata # noqaspec (
NetworkPolicySpec) – Specification of the desired behavior for this NetworkPolicy.api_version (
Optional[str]) – APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources # noqa
-
class
avionix.kube.networking.NetworkPolicyEgressRule(ports, to)¶ - Parameters
ports (
List[NetworkPolicyPort]) – 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.to (
List[NetworkPolicyPeer]) – 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.
-
class
avionix.kube.networking.NetworkPolicyIngressRule(from_, ports)¶ - Parameters
from – 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.
ports (
List[NetworkPolicyPort]) – 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.
-
class
avionix.kube.networking.NetworkPolicyList(metadata, items, api_version=None)¶ - Parameters
metadata (
ListMeta) – Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata # noqaitems (
List[NetworkPolicy]) – Items is a list of schema objects.api_version (
Optional[str]) – APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources # noqa
-
class
avionix.kube.networking.NetworkPolicyPeer(ip_block, namespace_selector, pod_selector)¶ - Parameters
ip_block (
IPBlock) – IPBlock defines policy on a particular IPBlock. If this field is set then neither of the other fields can be.namespace_selector (
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.pod_selector (
LabelSelector) – 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.
-
class
avionix.kube.networking.NetworkPolicyPort(port=None, protocol=None)¶ - Parameters
port (
Optional[int]) – 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.protocol (
Optional[str]) – The protocol (TCP, UDP, or SCTP) which traffic must match. If not specified, this field defaults to TCP.
-
class
avionix.kube.networking.NetworkPolicySpec(egress, ingress, pod_selector, policy_types)¶ - Parameters
egress (
List[NetworkPolicyEgressRule]) – 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.8ingress (
List[NetworkPolicyIngressRule]) – 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)pod_selector (
LabelSelector) – 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.policy_types (
List[str]) – 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