# NetworkPolicy

NetworkPolicyNetworkPolicy describes what network traffic is allowed for a set of Pods.apiVersion: networking.k8s.io/v1import "k8s.io/api/networking/v1"NetworkPolicyNetworkPolicy describes what network traffic is allowed for a set of PodsapiVersion: networking.k8s.io/v1kind: NetworkPolicymetadata (ObjectMeta)Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadataspec (NetworkPolicySpec)spec represents the specification of the desired behavior for this NetworkPolicy.NetworkPolicySpecNetworkPolicySpec provides the specification of a NetworkPolicypodSelector (LabelSelector)podSelector selects the pods to which this NetworkPolicy object applies. The array of rules is applied to any pods selected by this field. An empty selector matches all pods in the policy's namespace. Multiple network policies can select the same set of pods. In this case, the ingress rules for each are combined additively. This field is optional. If it is not specified, it defaults to an empty selector.policyTypes ([]string)Atomic: will be replaced during a mergepolicyTypes is a 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.8ingress ([]NetworkPolicyIngressRule)Atomic: will be replaced during a mergeingress is a 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)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.ingress.from ([]NetworkPolicyPeer)Atomic: will be replaced during a mergefrom is a 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.NetworkPolicyPeer describes a peer to allow traffic to/from. Only certain combinations of fields are allowedingress.from.ipBlock (IPBlock)ipBlock defines policy on a particular IPBlock. If this field is set then neither of the other fields can be.IPBlock describes a particular CIDR (Ex. "192.168.1.0/24","2001:db8::/64") 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.ingress.from.ipBlock.cidr (string), requiredcidr is a string representing the IPBlock Valid examples are "192.168.1.0/24" or "2001:db8::/64"ingress.from.ipBlock.except ([]string)Atomic: will be replaced during a mergeexcept is a slice of CIDRs that should not be included within an IPBlock Valid examples are "192.168.1.0/24" or "2001:db8::/64" Except values will be rejected if they are outside the cidr rangeingress.from.namespaceSelector (LabelSelector)namespaceSelector 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.ingress.from.podSelector (LabelSelector)podSelector 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.ingress.ports ([]NetworkPolicyPort)Atomic: will be replaced during a mergeports is a 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.NetworkPolicyPort describes a port to allow traffic oningress.ports.port (IntOrString)port represents 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. If present, only traffic on the specified protocol AND port will be matched.IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.ingress.ports.endPort (int32)endPort indicates that the range of ports from port to endPort if set, inclusive, should be allowed by the policy. This field cannot be defined if the port field is not defined or if the port field is defined as a named (string) port. The endPort must be equal or greater than port.ingress.ports.protocol (string)protocol represents the protocol (TCP, UDP, or SCTP) which traffic must match. If not specified, this field defaults to TCP.egress ([]NetworkPolicyEgressRule)Atomic: will be replaced during a mergeegress is a 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.8NetworkPolicyEgressRule 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.8egress.to ([]NetworkPolicyPeer)Atomic: will be replaced during a mergeto is a 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.NetworkPolicyPeer describes a peer to allow traffic to/from. Only certain combinations of fields are allowedegress.to.ipBlock (IPBlock)ipBlock defines policy on a particular IPBlock. If this field is set then neither of the other fields can be.IPBlock describes a particular CIDR (Ex. "192.168.1.0/24","2001:db8::/64") 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.egress.to.ipBlock.cidr (string), requiredcidr is a string representing the IPBlock Valid examples are "192.168.1.0/24" or "2001:db8::/64"egress.to.ipBlock.except ([]string)Atomic: will be replaced during a mergeexcept is a slice of CIDRs that should not be included within an IPBlock Valid examples are "192.168.1.0/24" or "2001:db8::/64" Except values will be rejected if they are outside the cidr rangeegress.to.namespaceSelector (LabelSelector)namespaceSelector 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.egress.to.podSelector (LabelSelector)podSelector 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.egress.ports ([]NetworkPolicyPort)Atomic: will be replaced during a mergeports is a 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.NetworkPolicyPort describes a port to allow traffic onegress.ports.port (IntOrString)port represents 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. If present, only traffic on the specified protocol AND port will be matched.IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.egress.ports.endPort (int32)endPort indicates that the range of ports from port to endPort if set, inclusive, should be allowed by the policy. This field cannot be defined if the port field is not defined or if the port field is defined as a named (string) port. The endPort must be equal or greater than port.egress.ports.protocol (string)protocol represents the protocol (TCP, UDP, or SCTP) which traffic must match. If not specified, this field defaults to TCP.NetworkPolicyListNetworkPolicyList is a list of NetworkPolicy objects.apiVersion: networking.k8s.io/v1kind: NetworkPolicyListmetadata (ListMeta)Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadataitems ([]NetworkPolicy), requireditems is a list of schema objects.Operationsget read the specified NetworkPolicyHTTP RequestGET /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name}Parametersname (in path): string, requiredname of the NetworkPolicynamespace (in path): string, requirednamespacepretty (in query): stringprettyResponse200 (NetworkPolicy): OK401: Unauthorizedlist list or watch objects of kind NetworkPolicyHTTP RequestGET /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpoliciesParametersnamespace (in path): string, requirednamespaceallowWatchBookmarks (in query): booleanallowWatchBookmarkscontinue (in query): stringcontinuefieldSelector (in query): stringfieldSelectorlabelSelector (in query): stringlabelSelectorlimit (in query): integerlimitpretty (in query): stringprettyresourceVersion (in query): stringresourceVersionresourceVersionMatch (in query): stringresourceVersionMatchsendInitialEvents (in query): booleansendInitialEventstimeoutSeconds (in query): integertimeoutSecondswatch (in query): booleanwatchResponse200 (NetworkPolicyList): OK401: Unauthorizedlist list or watch objects of kind NetworkPolicyHTTP RequestGET /apis/networking.k8s.io/v1/networkpoliciesParametersallowWatchBookmarks (in query): booleanallowWatchBookmarkscontinue (in query): stringcontinuefieldSelector (in query): stringfieldSelectorlabelSelector (in query): stringlabelSelectorlimit (in query): integerlimitpretty (in query): stringprettyresourceVersion (in query): stringresourceVersionresourceVersionMatch (in query): stringresourceVersionMatchsendInitialEvents (in query): booleansendInitialEventstimeoutSeconds (in query): integertimeoutSecondswatch (in query): booleanwatchResponse200 (NetworkPolicyList): OK401: Unauthorizedcreate create a NetworkPolicyHTTP RequestPOST /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpoliciesParametersnamespace (in path): string, requirednamespacebody: NetworkPolicy, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationpretty (in query): stringprettyResponse200 (NetworkPolicy): OK201 (NetworkPolicy): Created202 (NetworkPolicy): Accepted401: Unauthorizedupdate replace the specified NetworkPolicyHTTP RequestPUT /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name}Parametersname (in path): string, requiredname of the NetworkPolicynamespace (in path): string, requirednamespacebody: NetworkPolicy, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationpretty (in query): stringprettyResponse200 (NetworkPolicy): OK201 (NetworkPolicy): Created401: Unauthorizedpatch partially update the specified NetworkPolicyHTTP RequestPATCH /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name}Parametersname (in path): string, requiredname of the NetworkPolicynamespace (in path): string, requirednamespacebody: Patch, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationforce (in query): booleanforcepretty (in query): stringprettyResponse200 (NetworkPolicy): OK201 (NetworkPolicy): Created401: Unauthorizeddelete delete a NetworkPolicyHTTP RequestDELETE /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name}Parametersname (in path): string, requiredname of the NetworkPolicynamespace (in path): string, requirednamespacebody: DeleteOptionsdryRun (in query): stringdryRungracePeriodSeconds (in query): integergracePeriodSecondsignoreStoreReadErrorWithClusterBreakingPotential (in query): booleanignoreStoreReadErrorWithClusterBreakingPotentialpretty (in query): stringprettypropagationPolicy (in query): stringpropagationPolicyResponse200 (Status): OK202 (Status): Accepted401: Unauthorizeddeletecollection delete collection of NetworkPolicyHTTP RequestDELETE /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpoliciesParametersnamespace (in path): string, requirednamespacebody: DeleteOptionscontinue (in query): stringcontinuedryRun (in query): stringdryRunfieldSelector (in query): stringfieldSelectorgracePeriodSeconds (in query): integergracePeriodSecondsignoreStoreReadErrorWithClusterBreakingPotential (in query): booleanignoreStoreReadErrorWithClusterBreakingPotentiallabelSelector (in query): stringlabelSelectorlimit (in query): integerlimitpretty (in query): stringprettypropagationPolicy (in query): stringpropagationPolicyresourceVersion (in query): stringresourceVersionresourceVersionMatch (in query): stringresourceVersionMatchsendInitialEvents (in query): booleansendInitialEventstimeoutSeconds (in query): integertimeoutSecondsResponse200 (Status): OK401: UnauthorizedThis page is automatically generated.If you plan to report an issue with this page, mention that the page is auto-generated in your issue description. The fix may need to happen elsewhere in the Kubernetes project.