Staged Global Network Policy
A staged global network policy resource (StagedGlobalNetworkPolicy
) represents an ordered set of rules which are applied
to a collection of endpoints that match a label selector. These rules are used to preview network behavior and do
not to enforce network traffic. For enforcing network traffic, see global network policy resource.
StagedGlobalNetworkPolicy
is not a namespaced resource. StagedGlobalNetworkPolicy
applies to workload endpoint resources in all namespaces, and to host endpoint resources.
Select a namespace in a StagedGlobalNetworkPolicy
in the standard selector by using
projectcalico.org/namespace
as the label name and a namespace
name as the
value to compare against, e.g., projectcalico.org/namespace == "default"
.
See staged network policy resource for staged namespaced network policy.
StagedGlobalNetworkPolicy
resources can be used to define network connectivity rules between groups of Calico Enterprise endpoints and host endpoints, and
take precedence over Profile resources if any are defined.
StagedGlobalNetworkPolicies are organized into tiers, which provide an additional layer of orderingβin particular, note that the Pass
action skips to the
next tier, to enable hierarchical security policy.
For kubectl
commands, the following case-insensitive aliases
may be used to specify the resource type on the CLI:
stagedglobalnetworkpolicy.projectcalico.org
, stagedglobalnetworkpolicies.projectcalico.org
and abbreviations such as
stagedglobalnetworkpolicy.p
and stagedglobalnetworkpolicies.p
.
Sample YAMLβ
This sample policy allows TCP traffic from frontend
endpoints to port 6379 on
database
endpoints.
apiVersion: projectcalico.org/v3
kind: StagedGlobalNetworkPolicy
metadata:
name: internal-access.allow-tcp-6379
spec:
tier: internal-access
selector: role == 'database'
types:
- Ingress
- Egress
ingress:
- action: Allow
protocol: TCP
source:
selector: role == 'frontend'
destination:
ports:
- 6379
egress:
- action: Allow
Definitionβ
Metadataβ
Field | Description | Accepted Values | Schema | Default |
---|---|---|---|---|
name | The name of the network policy. Required. | Alphanumeric string with optional . , _ , or - . | string |
Specβ
Field | Description | Accepted Values | Schema | Default |
---|---|---|---|---|
order | Controls the order of precedence. Calico Enterprise applies the policy with the lowest value first. | float | ||
tier | Name of the tier this policy belongs to. | string | default | |
selector | Selects the endpoints to which this policy applies. | selector | all() | |
serviceAccountSelector | Selects the service account(s) to which this policy applies. Select all service accounts in the cluster with a specific name using the projectcalico.org/name label. | selector | all() | |
namespaceSelector | Selects the namespace(s) to which this policy applies. Select a specific namespace by name using the projectcalico.org/name label. | selector | all() | |
types | Applies the policy based on the direction of the traffic. To apply the policy to inbound traffic, set to Ingress . To apply the policy to outbound traffic, set to Egress . To apply the policy to both, set to Ingress, Egress . | Ingress , Egress | List of strings | Depends on presence of ingress/egress rules* |
ingress | Ordered list of ingress rules applied by policy. | List of Rule | ||
egress | Ordered list of egress rules applied by this policy. | List of Rule | ||
doNotTrack** | Indicates to apply the rules in this policy before any data plane connection tracking, and that packets allowed by these rules should not be tracked. | true, false | boolean | false |
preDNAT** | Indicates to apply the rules in this policy before any DNAT. | true, false | boolean | false |
applyOnForward** | Indicates to apply the rules in this policy on forwarded traffic as well as to locally terminated traffic. | true, false | boolean | false |
performanceHints | Contains a list of hints to Calico's policy engine to help process the policy more efficiently. Hints never change the enforcement behaviour of the policy. The available hints are described below. | AssumeNeededOnEveryNode | List of strings |
* If types
has no value, Calico Enterprise defaults as follows.
Ingress Rules Present Egress Rules Present Types
valueNo No Ingress
Yes No Ingress
No Yes Egress
Yes Yes Ingress, Egress
** The doNotTrack
and preDNAT
and applyOnForward
fields are meaningful
only when applying policy to a host endpoint.
Only one of doNotTrack
and preDNAT
may be set to true
(in a given policy). If they are both false
, or when applying the policy to a
workload endpoint,
the policy is enforced after connection tracking and any DNAT.
applyOnForward
must be set to true
if either doNotTrack
or preDNAT
is
true
because for a given policy, any untracked rules or rules before DNAT will
in practice apply to forwarded traffic.
See Using Calico Enterprise to Secure Host Interfaces
for how doNotTrack
and preDNAT
and applyOnForward
can be useful for host endpoints.
Ruleβ
A single rule matches a set of packets and applies some action to them. When multiple rules are specified, they are executed in order.
Field | Description | Accepted Values | Schema | Default |
---|---|---|---|---|
metadata | Per-rule metadata. | RuleMetadata | ||
action | Action to perform when matching this rule. | Allow , Deny , Log , Pass | string | |
protocol | Positive protocol match. | TCP , UDP , ICMP , ICMPv6 , SCTP , UDPLite , 1 -255 | string | integer | |
notProtocol | Negative protocol match. | TCP , UDP , ICMP , ICMPv6 , SCTP , UDPLite , 1 -255 | string | integer | |
icmp | ICMP match criteria. | ICMP | ||
notICMP | Negative match on ICMP. | ICMP | ||
ipVersion | Positive IP version match. | 4 , 6 | integer | |
source | Source match parameters. | EntityRule | ||
destination | Destination match parameters. | EntityRule | ||
http | Match HTTP request parameters. Application layer policy must be enabled to use this field. | HTTPMatch |
After a Log
action, processing continues with the next rule; Allow
and Deny
are immediate
and final and no further rules are processed.
An action
of Pass
in a NetworkPolicy
or GlobalNetworkPolicy
will skip over the remaining policies and jump to the
first profile assigned to the endpoint, applying the policy configured in the
profile; if there are no Profiles configured for the endpoint the default applied action is Deny
.
RuleMetadataβ
Metadata associated with a specific rule (rather than the policy as a whole). The contents of the metadata does not affect how a rule is interpreted or enforced; it is simply a way to store additional information for use by operators or applications that interact with Calico Enterprise.
Field | Description | Schema | Default |
---|---|---|---|
annotations | Arbitrary non-identifying metadata. | map of string to string |
Example:
metadata:
annotations:
app: database
owner: devops
Annotations follow the same rules as Kubernetes for valid syntax and character set.
On Linux with the iptables dataplane, rule annotations are rendered as comments in the form -m comment --comment "<key>=<value>"
on the iptables rule(s) that correspond
to the Calico Enterprise rule.
ICMPβ
Field | Description | Accepted Values | Schema | Default |
---|---|---|---|---|
type | Match on ICMP type. | Can be integer 0-254 | integer | |
code | Match on ICMP code. | Can be integer 0-255 | integer |
EntityRuleβ
Entity rules specify the attributes of the source or destination of a packet that must match for the rule as a whole to match. Packets can be matched on combinations of:
- Identity of the source/destination, by using Selectors or by specifying a particular
Kubernetes
Service
. Selectors can match workload endpoints, host endpoints and (namespaced or global) network sets. - Source/destination IP address, protocol and port.
If the rule contains multiple match criteria (for example, an IP and a port) then all match criteria must match for the rule as a whole to match a packet.
Field | Description | Accepted Values | Schema | Default |
---|---|---|---|---|
nets | Match packets with IP in any of the listed CIDRs. | List of valid IPv4 CIDRs or list of valid IPv6 CIDRs (IPv4 and IPv6 CIDRs shouldn't be mixed in one rule) | list of cidrs | |
notNets | Negative match on CIDRs. Match packets with IP not in any of the listed CIDRs. | List of valid IPv4 CIDRs or list of valid IPv6 CIDRs (IPv4 and IPv6 CIDRs shouldn't be mixed in one rule) | list of cidrs | |
selector | Positive match on selected endpoints. If a namespaceSelector is also defined, the set of endpoints this applies to is limited to the endpoints in the selected namespaces. | Valid selector | selector | |
notSelector | Negative match on selected endpoints. If a namespaceSelector is also defined, the set of endpoints this applies to is limited to the endpoints in the selected namespaces. | Valid selector | selector | |
namespaceSelector | Positive match on selected namespaces. If specified, only workload endpoints in the selected Kubernetes namespaces are matched. Matches namespaces based on the labels that have been applied to the namespaces. Defines the scope that selectors will apply to, if not defined then selectors apply to the NetworkPolicy's namespace. Match a specific namespace by name using the projectcalico.org/name label. Select the non-namespaced resources like GlobalNetworkSet(s), host endpoints to which this policy applies by using global() selector. | Valid selector | selector | |
ports | Positive match on the specified ports | list of ports | ||
domains | Positive match on domain names. | List of exact or wildcard domain names | list of strings | |
notPorts | Negative match on the specified ports | list of ports | ||
serviceAccounts | Match endpoints running under service accounts. If a namespaceSelector is also defined, the set of service accounts this applies to is limited to the service accounts in the selected namespaces. | ServiceAccountMatch | ||
services | Match the specified service(s). If specified on egress rule destinations, no other selection criteria can be set. If specified on ingress rule sources, only positive or negative matches on ports can be specified. | ServiceMatch |
You cannot mix IPv4 and IPv6 CIDRs in a single rule using nets
or notNets
. If you need to match both, create 2 rules.
Selector performance in EntityRulesβ
When rendering policy into the dataplane, Calico Enterprise must identify the endpoints that match the selectors in all active rules. This calculation is optimized for certain common selector types. Using the optimized selector types reduces CPU usage (and policy rendering time) by orders of magnitude. This becomes important at high scale (hundreds of active rules, hundreds of thousands of endpoints).
The optimized operators are as follows:
label == "value"
label in { 'v1', 'v2' }
has(label)
<expression 1> && <expression 2>
is optimized if either<expression 1>
or<expression 2>
is optimized.
The following perform like has(label)
. All endpoints with the label will be scanned to find matches:
label contains 's'
label starts with 's'
label ends with 's'
The other operators, and in particular, all()
, !
, ||
and !=
are not optimized.
Examples:
a == 'b'
- optimizeda == 'b' && has(c)
- optimizeda == 'b' || has(c)
- not optimized due to use of||
c != 'd'
- not optimized due to use of!=
!has(a)
- not optimized due to use of!
a == 'b' && c != 'd'
- optimized,a =='b'
is optimized soa == 'b' && <anything>
is optimized.c != 'd' && a == 'b'
- optimized,a =='b'
is optimized so<anything> && a == 'b'
is optimized.
Exact and wildcard domain namesβ
The domains
field is only valid for egress Allow rules. It restricts the
rule to apply only to traffic to one of the specified domains. If this field is specified, the
parent Rule's action
must be Allow
, and nets
and selector
must both be left empty.
When a configured domain name has no wildcard (*
), it matches exactly that domain name. For example:
microsoft.com
tigera.io
With a single asterisk in any part of the domain name, it matches 1 or more path components at that position. For example:
*.google.com
matcheswww.google.com
andwww.ipv6.google.com
, but notgoogle.com
www.*.com
matcheswww.sun.com
andwww.apple.com
, but notwww.com
update.*.mycompany.com
matchesupdate.tools.mycompany.com
,update.secure.suite.mycompany.com
, and so on
Not supported are:
- Multiple wildcards in the same domain, for example:
*.*.mycompany.com
- Asterisks that are not the entire component, for example:
www.g*.com
- More general wildcards, such as regular expressions
Calico Enterprise implements policy for domain names by learning the corresponding IPs from DNS, then programming rules to allow those IPs. This means that if multiple domain names A, B and C all map to the same IP, and there is domain-based policy to allow A, traffic to B and C will be allowed as well.
Selectorβ
A label selector is an expression which either matches or does not match a resource based on its labels.
Calico Enterprise label selectors support a number of operators, which can be combined into larger expressions using the boolean operators and parentheses.
Expression | Meaning |
---|---|
Logical operators | |
( <expression> ) | Matches if and only if <expression> matches. (Parentheses are used for grouping expressions.) |
! <expression> | Matches if and only if <expression> does not match. Tip: ! is a special character at the start of a YAML string, if you need to use ! at the start of a YAML string, enclose the string in quotes. |
<expression 1> && <expression 2> | "And": matches if and only if both <expression 1> , and, <expression 2> matches |
\<expression 1> || \<expression 2> | "Or": matches if and only if either <expression 1> , or, <expression 2> matches. |
Match operators | |
all() | Match all in-scope resources. To match no resources, combine this operator with ! to form !all() . |
global() | Match all non-namespaced resources. Useful in a namespaceSelector to select global resources such as global network sets. |
k == 'v' | Matches resources with the label 'k' and value 'v'. |
k != 'v' | Matches resources without label 'k' or with label 'k' and value not equal to v |
has(k) | Matches resources with label 'k', independent of value. To match pods that do not have label k , combine this operator with ! to form !has(k) |
k in { 'v1', 'v2' } | Matches resources with label 'k' and value in the given set |
k not in { 'v1', 'v2' } | Matches resources without label 'k' or with label 'k' and value not in the given set |
k contains 's' | Matches resources with label 'k' and value containing the substring 's' |
k starts with 's' | Matches resources with label 'k' and value starting with the substring 's' |
k ends with 's' | Matches resources with label 'k' and value ending with the substring 's' |
Operators have the following precedence:
- Highest: all the match operators
- Parentheses
( ... )
- Negation with
!
- Conjunction with
&&
- Lowest: Disjunction with
||
For example, the expression
! has(my-label) || my-label starts with 'prod' && role in {'frontend','business'}
Would be "bracketed" like this:
((!(has(my-label)) || ((my-label starts with 'prod') && (role in {'frontend','business'}))
It would match:
- Any resource that did not have label "my-label".
- Any resource that both:
- Has a value for
my-label
that starts with "prod", and, - Has a role label with value either "frontend", or "business".
- Has a value for
Portsβ
Calico Enterprise supports the following syntaxes for expressing ports.
Syntax | Example | Description |
---|---|---|
int | 80 | The exact (numeric) port specified |
start:end | 6040:6050 | All (numeric) ports within the range start β€ x β€ end |
string | named-port | A named port, as defined in the ports list of one or more endpoints |
An individual numeric port may be specified as a YAML/JSON integer. A port range or named port must be represented as a string. For example, this would be a valid list of ports:
ports: [8080, '1234:5678', 'named-port']
Named portsβ
Using a named port in an EntityRule
, instead of a numeric port, gives a layer of indirection,
allowing for the named port to map to different numeric values for each endpoint.
For example, suppose you have multiple HTTP servers running as workloads; some exposing their HTTP
port on port 80 and others on port 8080. In each workload, you could create a named port called
http-port
that maps to the correct local port. Then, in a rule, you could refer to the name
http-port
instead of writing a different rule for each type of server.
Since each named port may refer to many endpoints (and Calico Enterprise has to expand a named port into a set of endpoint/port combinations), using a named port is considerably more expensive in terms of CPU than using a simple numeric port. We recommend that they are used sparingly, only where the extra indirection is required.
ServiceAccountMatchβ
A ServiceAccountMatch matches service accounts in an EntityRule.
Field | Description | Schema |
---|---|---|
names | Match service accounts by name | list of strings |
selector | Match service accounts by label | selector |
ServiceMatchβ
A ServiceMatch matches a service in an EntityRule.
Field | Description | Schema |
---|---|---|
name | The service's name. | string |
namespace | The service's namespace. | string |
Performance Hintsβ
Performance hints provide a way to tell Calico Enterprise about the intended use of the policy so that it may process it more efficiently. Currently only one hint is defined:
AssumeNeededOnEveryNode
: normally, Calico Enterprise only calculates a policy's rules and selectors on nodes where the policy is actually in use (i.e. its selector matches a local endpoint). This saves work in most cases. TheAssumeNeededOnEveryNode
hint tells Calico Enterprise to treat the policy as "in use" on every node. This is useful for large policy sets that are known to apply to all (or nearly all) endpoints. It effectively "preloads" the policy on every node so that there is less work to do when the first endpoint matching the policy shows up. It also prevents work from being done to tear down the policy when the last endpoint is drained.
Supported operationsβ
Datastore type | Create/Delete | Update | Get/List | Notes |
---|---|---|---|---|
Kubernetes API datastore | Yes | Yes | Yes |
List filtering on tiersβ
List and watch operations may specify label selectors or field selectors to filter StagedGlobalNetworkPolicy
resources on tiers returned by the API server.
When no selector is specified, the API server returns all StagedGlobalNetworkPolicy
resources from all tiers that the user has access to.
Field selectorβ
When using the field selector, supported operators are =
and ==
The following example shows how to retrieve all StagedGlobalNetworkPolicy
resources in the default tier:
kubectl get stagedglobalnetworkpolicy --field-selector spec.tier=default
Label selectorβ
When using the label selector, supported operators are =
, ==
and IN
.
The following example shows how to retrieve all StagedGlobalNetworkPolicy
resources in the default
and net-sec
tiers:
kubectl get stagedglobalnetworkpolicy -l 'projectcalico.org/tier in (default, net-sec)'