diff --git a/calico-enterprise/reference/resources/bgpconfig.mdx b/calico-enterprise/reference/resources/bgpconfig.mdx index dd6ff1b4cf..1c67ca8717 100644 --- a/calico-enterprise/reference/resources/bgpconfig.mdx +++ b/calico-enterprise/reference/resources/bgpconfig.mdx @@ -4,8 +4,8 @@ description: Reference for the BGPConfiguration resource in Calico Enterprise th # BGP configuration -A BGP configuration resource (`BGPConfiguration`) represents BGP specific configuration options for the cluster or a -specific node. +A Border Gateway Protocol (BGP) configuration resource (`BGPConfiguration`) represents BGP configuration options +for the cluster or a specific node. For `kubectl` commands, the following case-insensitive aliases may be used to specify the resource type on the CLI: `bgpconfiguration.projectcalico.org`, `bgpconfigurations.projectcalico.org` as well as abbreviations such as `bgpconfiguration.p` and `bgpconfigurations.p`. diff --git a/calico-enterprise/reference/resources/bgpfilter.mdx b/calico-enterprise/reference/resources/bgpfilter.mdx index 38ba677042..289229049f 100644 --- a/calico-enterprise/reference/resources/bgpfilter.mdx +++ b/calico-enterprise/reference/resources/bgpfilter.mdx @@ -2,11 +2,11 @@ description: Reference for the BGPFilter resource in Calico Enterprise that filters routes imported from or exported to BGP peers. --- -# BGP Filter +# BGP filter -A BGP filter resource (`BGPFilter`) represents a way to control -routes imported by and exported to BGP peers specified using a -BGP peer resource (`BGPPeer`). +A Border Gateway Protocol (BGP) filter resource (`BGPFilter`) represents a way to control +routes imported by and exported to BGP peers +specified by a [BGP peer resource](bgppeer.mdx) (`BGPPeer`). The BGPFilter rules are applied sequentially: the `action` for the **first** rule that matches is executed immediately. diff --git a/calico-enterprise/reference/resources/bgppeer.mdx b/calico-enterprise/reference/resources/bgppeer.mdx index 8159e2a2ad..0849174e58 100644 --- a/calico-enterprise/reference/resources/bgppeer.mdx +++ b/calico-enterprise/reference/resources/bgppeer.mdx @@ -6,10 +6,10 @@ description: Reference for the BGPPeer resource in Calico Enterprise that define import Selectors from '@site/calico-enterprise/_includes/content/_selectors.mdx'; -A BGP peer resource (`BGPPeer`) represents a remote BGP peer with -which the node(s) in a $[prodname] cluster will peer. +A Border Gateway Protocol (BGP) peer resource (`BGPPeer`) represents a remote BGP peer +with which one or more nodes in a $[prodname] cluster exchange routes. Configuring BGP peers allows you to peer a $[prodname] network -with your datacenter fabric (e.g. ToR). For more +with your data center fabric, such as a top-of-rack (ToR) router. For more information on cluster layouts, see $[prodname]'s documentation on [$[prodname] over IP fabrics](../architecture/design/l3-interconnect-fabric.mdx). diff --git a/calico-enterprise/reference/resources/blockaffinity.mdx b/calico-enterprise/reference/resources/blockaffinity.mdx index ce13e63459..14fe953360 100644 --- a/calico-enterprise/reference/resources/blockaffinity.mdx +++ b/calico-enterprise/reference/resources/blockaffinity.mdx @@ -4,7 +4,8 @@ description: Reference for the BlockAffinity resource in Calico Enterprise that # Block affinity -A block affinity resource (`BlockAffinity`) represents the affinity for an IPAM block. These are managed by Calico IPAM. +A block affinity resource (`BlockAffinity`) represents the affinity between a node and an IP address management (IPAM) block. +$[prodname] IPAM creates and manages these resources automatically; you don't normally need to create or modify them. ## Block affinity definition diff --git a/calico-enterprise/reference/resources/caliconodestatus.mdx b/calico-enterprise/reference/resources/caliconodestatus.mdx index 1d35af5cf7..dcdcd0b9dd 100644 --- a/calico-enterprise/reference/resources/caliconodestatus.mdx +++ b/calico-enterprise/reference/resources/caliconodestatus.mdx @@ -4,14 +4,15 @@ description: Reference for the CalicoNodeStatus resource in Calico Enterprise th # Calico node status -A Calico node status resource (`CalicoNodeStatus`) represents a collection of status information for a node that $[prodname] reports back to the user for use during troubleshooting. +A Calico node status resource (`CalicoNodeStatus`) reports status information for a node, for use during troubleshooting. +You create a `CalicoNodeStatus` resource for the node you want to inspect, and $[prodname] periodically writes the collected information to the resource's `status` field. -As of today, status of BGP agents, BGP sessions and routes exposed to BGP agents are collected from Linux nodes only. **Windows nodes are not supported at this time.** -Calico node status resource is only valid when $[prodname] BGP networking is in use. +Status of Border Gateway Protocol (BGP) agents, BGP sessions, and routes exposed to BGP agents is collected from Linux nodes only. **Windows nodes are not supported at this time.** +The resource is valid only when $[prodname] BGP networking is in use. -### Notes +## Notes -The updating of `CalicoNodeStatus` will have a small performance impact on CPU/Memory usage of the node as well as adding load to kubernetes apiserver. +Updating `CalicoNodeStatus` has a small performance impact on CPU and memory usage of the node, and adds load to the Kubernetes API server. In our testing on a ten node, full mesh cluster, a `CalicoNodeStatus` resource was created for each node where the update interval was set to ten seconds. On each node, this resulted in an increase in CPU use of 5% of a vCPU and an increase of 4MB of memory. The control plane node recorded an increase in CPU usage of 5% of a vCPU for these 10 nodes. diff --git a/calico-enterprise/reference/resources/globalnetworkset.mdx b/calico-enterprise/reference/resources/globalnetworkset.mdx index 9e71f562fd..38c51607f2 100644 --- a/calico-enterprise/reference/resources/globalnetworkset.mdx +++ b/calico-enterprise/reference/resources/globalnetworkset.mdx @@ -6,7 +6,7 @@ description: Reference for the GlobalNetworkSet resource in Calico Enterprise th import DomainNames from '@site/calico-enterprise/_includes/content/_domain-names.mdx'; -A global network set resource (GlobalNetworkSet) represents an arbitrary set of IP subnetworks/CIDRs, +A global network set resource (`GlobalNetworkSet`) represents an arbitrary set of IP subnetworks/CIDRs, allowing it to be matched by $[prodname] policy. Network sets are useful for applying policy to traffic coming from (or going to) external, non-$[prodname], networks. diff --git a/calico-enterprise/reference/resources/ipamconfig.mdx b/calico-enterprise/reference/resources/ipamconfig.mdx index beb907cf45..1a4fd0425d 100644 --- a/calico-enterprise/reference/resources/ipamconfig.mdx +++ b/calico-enterprise/reference/resources/ipamconfig.mdx @@ -4,7 +4,7 @@ description: Reference for the IP address management configuration resource in C # IPAM configuration -An IPAM configuration resource (`IPAMConfiguration`) represents global IPAM configuration options. +An IP address management (IPAM) configuration resource (`IPAMConfiguration`) represents global IPAM configuration options. ## Sample YAML diff --git a/calico-enterprise/reference/resources/networkset.mdx b/calico-enterprise/reference/resources/networkset.mdx index 8b8b724b6a..a0739f658c 100644 --- a/calico-enterprise/reference/resources/networkset.mdx +++ b/calico-enterprise/reference/resources/networkset.mdx @@ -6,11 +6,11 @@ description: Reference for the NetworkSet resource in Calico Enterprise that def import DomainNames from '@site/calico-enterprise/_includes/content/_domain-names.mdx'; -A network set resource (NetworkSet) represents an arbitrary set of IP subnetworks/CIDRs, +A network set resource (`NetworkSet`) represents an arbitrary set of IP subnetworks/CIDRs, allowing it to be matched by $[prodname] policy. Network sets are useful for applying policy to traffic coming from (or going to) external, non-$[prodname], networks. -`NetworkSet` is a namespaced resource. `NetworkSets` in a specific namespace +`NetworkSet` is a namespaced resource. A `NetworkSet` in a specific namespace only applies to [network policies](networkpolicy.mdx) in that namespace. Two resources are in the same namespace if the `namespace` value is set the same on both. (See [GlobalNetworkSet](globalnetworkset.mdx) for non-namespaced network sets.) diff --git a/calico-enterprise/reference/resources/stagedkubernetesnetworkpolicy.mdx b/calico-enterprise/reference/resources/stagedkubernetesnetworkpolicy.mdx index a54338cbcc..78e651a447 100644 --- a/calico-enterprise/reference/resources/stagedkubernetesnetworkpolicy.mdx +++ b/calico-enterprise/reference/resources/stagedkubernetesnetworkpolicy.mdx @@ -4,7 +4,7 @@ description: Reference for the StagedKubernetesNetworkPolicy resource in Calico # Staged Kubernetes network policy -A staged kubernetes network policy resource (`StagedKubernetesNetworkPolicy`) represents a staged version +A staged Kubernetes network policy resource (`StagedKubernetesNetworkPolicy`) represents a staged version of [Kubernetes network policy](https://kubernetes.io/docs/concepts/services-networking/network-policies). This is used to preview network behavior before actually enforcing the network policy. Once persisted, this will create a Kubernetes network policy backed by a $[prodname] diff --git a/calico-enterprise/reference/resources/tier.mdx b/calico-enterprise/reference/resources/tier.mdx index 821b37012d..d898df606f 100644 --- a/calico-enterprise/reference/resources/tier.mdx +++ b/calico-enterprise/reference/resources/tier.mdx @@ -8,7 +8,7 @@ A tier resource (`Tier`) represents an ordered collection of [NetworkPolicies](n and/or [GlobalNetworkPolicies](globalnetworkpolicy.mdx). Tiers are used to divide these policies into groups of different priorities. These policies are ordered within a Tier: the additional hierarchy of Tiers provides more flexibility -because the `Pass` `action` in a Rule jumps to the next Tier. Some example use cases for this are. +because the `Pass` `action` in a Rule jumps to the next Tier. Some example use cases for this are: - Allowing privileged users to define security policy that takes precedence over other users. - Translating hierarchies of physical firewalls directly into $[prodname] policy. diff --git a/calico-enterprise_versioned_docs/version-3.21-2/reference/resources/bgpconfig.mdx b/calico-enterprise_versioned_docs/version-3.21-2/reference/resources/bgpconfig.mdx index 095b4b537a..965ad84364 100644 --- a/calico-enterprise_versioned_docs/version-3.21-2/reference/resources/bgpconfig.mdx +++ b/calico-enterprise_versioned_docs/version-3.21-2/reference/resources/bgpconfig.mdx @@ -4,8 +4,8 @@ description: API for this Calico Enterprise resource. # BGP configuration -A BGP configuration resource (`BGPConfiguration`) represents BGP specific configuration options for the cluster or a -specific node. +A Border Gateway Protocol (BGP) configuration resource (`BGPConfiguration`) represents BGP configuration options +for the cluster or a specific node. For `kubectl` commands, the following case-insensitive aliases may be used to specify the resource type on the CLI: `bgpconfiguration.projectcalico.org`, `bgpconfigurations.projectcalico.org` as well as abbreviations such as `bgpconfiguration.p` and `bgpconfigurations.p`. diff --git a/calico-enterprise_versioned_docs/version-3.21-2/reference/resources/bgpfilter.mdx b/calico-enterprise_versioned_docs/version-3.21-2/reference/resources/bgpfilter.mdx index 7d45d10692..35c31c837e 100644 --- a/calico-enterprise_versioned_docs/version-3.21-2/reference/resources/bgpfilter.mdx +++ b/calico-enterprise_versioned_docs/version-3.21-2/reference/resources/bgpfilter.mdx @@ -2,11 +2,11 @@ description: API for this Calico Enterprise resource. --- -# BGP Filter +# BGP filter -A BGP filter resource (`BGPFilter`) represents a way to control -routes imported by and exported to BGP peers specified using a -BGP peer resource (`BGPPeer`). +A Border Gateway Protocol (BGP) filter resource (`BGPFilter`) represents a way to control +routes imported by and exported to BGP peers +specified by a [BGP peer resource](bgppeer.mdx) (`BGPPeer`). The BGPFilter rules are applied sequentially: the `action` for the **first** rule that matches is executed immediately. diff --git a/calico-enterprise_versioned_docs/version-3.21-2/reference/resources/bgppeer.mdx b/calico-enterprise_versioned_docs/version-3.21-2/reference/resources/bgppeer.mdx index 8b9a4e906b..960b24a8c3 100644 --- a/calico-enterprise_versioned_docs/version-3.21-2/reference/resources/bgppeer.mdx +++ b/calico-enterprise_versioned_docs/version-3.21-2/reference/resources/bgppeer.mdx @@ -6,10 +6,10 @@ description: API for this Calico Enterprise resource. import Selectors from '@site/calico-enterprise_versioned_docs/version-3.21-2/_includes/content/_selectors.mdx'; -A BGP peer resource (`BGPPeer`) represents a remote BGP peer with -which the node(s) in a $[prodname] cluster will peer. +A Border Gateway Protocol (BGP) peer resource (`BGPPeer`) represents a remote BGP peer +with which one or more nodes in a $[prodname] cluster exchange routes. Configuring BGP peers allows you to peer a $[prodname] network -with your datacenter fabric (e.g. ToR). For more +with your data center fabric, such as a top-of-rack (ToR) router. For more information on cluster layouts, see $[prodname]'s documentation on [$[prodname] over IP fabrics](../architecture/design/l3-interconnect-fabric.mdx). diff --git a/calico-enterprise_versioned_docs/version-3.21-2/reference/resources/blockaffinity.mdx b/calico-enterprise_versioned_docs/version-3.21-2/reference/resources/blockaffinity.mdx index 451a6bad29..c8fd459a6d 100644 --- a/calico-enterprise_versioned_docs/version-3.21-2/reference/resources/blockaffinity.mdx +++ b/calico-enterprise_versioned_docs/version-3.21-2/reference/resources/blockaffinity.mdx @@ -4,7 +4,8 @@ description: IP address management block affinity # Block affinity -A block affinity resource (`BlockAffinity`) represents the affinity for an IPAM block. These are managed by Calico IPAM. +A block affinity resource (`BlockAffinity`) represents the affinity between a node and an IP address management (IPAM) block. +$[prodname] IPAM creates and manages these resources automatically; you don't normally need to create or modify them. ## Block affinity definition diff --git a/calico-enterprise_versioned_docs/version-3.21-2/reference/resources/caliconodestatus.mdx b/calico-enterprise_versioned_docs/version-3.21-2/reference/resources/caliconodestatus.mdx index 69fdb137eb..465fbda56f 100644 --- a/calico-enterprise_versioned_docs/version-3.21-2/reference/resources/caliconodestatus.mdx +++ b/calico-enterprise_versioned_docs/version-3.21-2/reference/resources/caliconodestatus.mdx @@ -4,14 +4,15 @@ description: API for this Calico resource. # Calico node status -A Calico node status resource (`CalicoNodeStatus`) represents a collection of status information for a node that $[prodname] reports back to the user for use during troubleshooting. +A Calico node status resource (`CalicoNodeStatus`) reports status information for a node, for use during troubleshooting. +You create a `CalicoNodeStatus` resource for the node you want to inspect, and $[prodname] periodically writes the collected information to the resource's `status` field. -As of today, status of BGP agents, BGP sessions and routes exposed to BGP agents are collected from Linux nodes only. **Windows nodes are not supported at this time.** -Calico node status resource is only valid when $[prodname] BGP networking is in use. +Status of Border Gateway Protocol (BGP) agents, BGP sessions, and routes exposed to BGP agents is collected from Linux nodes only. **Windows nodes are not supported at this time.** +The resource is valid only when $[prodname] BGP networking is in use. -### Notes +## Notes -The updating of `CalicoNodeStatus` will have a small performance impact on CPU/Memory usage of the node as well as adding load to kubernetes apiserver. +Updating `CalicoNodeStatus` has a small performance impact on CPU and memory usage of the node, and adds load to the Kubernetes API server. In our testing on a ten node, full mesh cluster, a `CalicoNodeStatus` resource was created for each node where the update interval was set to ten seconds. On each node, this resulted in an increase in CPU use of 5% of a vCPU and an increase of 4MB of memory. The control plane node recorded an increase in CPU usage of 5% of a vCPU for these 10 nodes. diff --git a/calico-enterprise_versioned_docs/version-3.21-2/reference/resources/globalnetworkset.mdx b/calico-enterprise_versioned_docs/version-3.21-2/reference/resources/globalnetworkset.mdx index efdb635b49..aa9add68a8 100644 --- a/calico-enterprise_versioned_docs/version-3.21-2/reference/resources/globalnetworkset.mdx +++ b/calico-enterprise_versioned_docs/version-3.21-2/reference/resources/globalnetworkset.mdx @@ -6,7 +6,7 @@ description: API for this Calico Enterprise resource. import DomainNames from '@site/calico-enterprise_versioned_docs/version-3.21-2/_includes/content/_domain-names.mdx'; -A global network set resource (GlobalNetworkSet) represents an arbitrary set of IP subnetworks/CIDRs, +A global network set resource (`GlobalNetworkSet`) represents an arbitrary set of IP subnetworks/CIDRs, allowing it to be matched by $[prodname] policy. Network sets are useful for applying policy to traffic coming from (or going to) external, non-$[prodname], networks. diff --git a/calico-enterprise_versioned_docs/version-3.21-2/reference/resources/ipamconfig.mdx b/calico-enterprise_versioned_docs/version-3.21-2/reference/resources/ipamconfig.mdx index b7b7720d70..8a95d7e52c 100644 --- a/calico-enterprise_versioned_docs/version-3.21-2/reference/resources/ipamconfig.mdx +++ b/calico-enterprise_versioned_docs/version-3.21-2/reference/resources/ipamconfig.mdx @@ -4,7 +4,7 @@ description: IP address management global configuration # IPAM configuration -An IPAM configuration resource (`IPAMConfiguration`) represents global IPAM configuration options. +An IP address management (IPAM) configuration resource (`IPAMConfiguration`) represents global IPAM configuration options. ## Sample YAML diff --git a/calico-enterprise_versioned_docs/version-3.21-2/reference/resources/networkset.mdx b/calico-enterprise_versioned_docs/version-3.21-2/reference/resources/networkset.mdx index 23437f40d0..4bc8c63fe7 100644 --- a/calico-enterprise_versioned_docs/version-3.21-2/reference/resources/networkset.mdx +++ b/calico-enterprise_versioned_docs/version-3.21-2/reference/resources/networkset.mdx @@ -6,11 +6,11 @@ description: API for this Calico Enterprise resource. import DomainNames from '@site/calico-enterprise_versioned_docs/version-3.21-2/_includes/content/_domain-names.mdx'; -A network set resource (NetworkSet) represents an arbitrary set of IP subnetworks/CIDRs, +A network set resource (`NetworkSet`) represents an arbitrary set of IP subnetworks/CIDRs, allowing it to be matched by $[prodname] policy. Network sets are useful for applying policy to traffic coming from (or going to) external, non-$[prodname], networks. -`NetworkSet` is a namespaced resource. `NetworkSets` in a specific namespace +`NetworkSet` is a namespaced resource. A `NetworkSet` in a specific namespace only applies to [network policies](networkpolicy.mdx) in that namespace. Two resources are in the same namespace if the `namespace` value is set the same on both. (See [GlobalNetworkSet](globalnetworkset.mdx) for non-namespaced network sets.) diff --git a/calico-enterprise_versioned_docs/version-3.21-2/reference/resources/stagedkubernetesnetworkpolicy.mdx b/calico-enterprise_versioned_docs/version-3.21-2/reference/resources/stagedkubernetesnetworkpolicy.mdx index 793a587a8d..1b411889e8 100644 --- a/calico-enterprise_versioned_docs/version-3.21-2/reference/resources/stagedkubernetesnetworkpolicy.mdx +++ b/calico-enterprise_versioned_docs/version-3.21-2/reference/resources/stagedkubernetesnetworkpolicy.mdx @@ -4,7 +4,7 @@ description: API for this Calico Enterprise resource. # Staged Kubernetes network policy -A staged kubernetes network policy resource (`StagedKubernetesNetworkPolicy`) represents a staged version +A staged Kubernetes network policy resource (`StagedKubernetesNetworkPolicy`) represents a staged version of [Kubernetes network policy](https://kubernetes.io/docs/concepts/services-networking/network-policies). This is used to preview network behavior before actually enforcing the network policy. Once persisted, this will create a Kubernetes network policy backed by a $[prodname] diff --git a/calico-enterprise_versioned_docs/version-3.21-2/reference/resources/tier.mdx b/calico-enterprise_versioned_docs/version-3.21-2/reference/resources/tier.mdx index 071cfd0f2c..6ef04cc7e1 100644 --- a/calico-enterprise_versioned_docs/version-3.21-2/reference/resources/tier.mdx +++ b/calico-enterprise_versioned_docs/version-3.21-2/reference/resources/tier.mdx @@ -8,7 +8,7 @@ A tier resource (`Tier`) represents an ordered collection of [NetworkPolicies](n and/or [GlobalNetworkPolicies](globalnetworkpolicy.mdx). Tiers are used to divide these policies into groups of different priorities. These policies are ordered within a Tier: the additional hierarchy of Tiers provides more flexibility -because the `Pass` `action` in a Rule jumps to the next Tier. Some example use cases for this are. +because the `Pass` `action` in a Rule jumps to the next Tier. Some example use cases for this are: - Allowing privileged users to define security policy that takes precedence over other users. - Translating hierarchies of physical firewalls directly into $[prodname] policy. diff --git a/calico-enterprise_versioned_docs/version-3.22-2/reference/resources/bgpconfig.mdx b/calico-enterprise_versioned_docs/version-3.22-2/reference/resources/bgpconfig.mdx index 14e57d6771..c869c95f5d 100644 --- a/calico-enterprise_versioned_docs/version-3.22-2/reference/resources/bgpconfig.mdx +++ b/calico-enterprise_versioned_docs/version-3.22-2/reference/resources/bgpconfig.mdx @@ -4,8 +4,8 @@ description: Reference for the BGPConfiguration resource in Calico Enterprise th # BGP configuration -A BGP configuration resource (`BGPConfiguration`) represents BGP specific configuration options for the cluster or a -specific node. +A Border Gateway Protocol (BGP) configuration resource (`BGPConfiguration`) represents BGP configuration options +for the cluster or a specific node. For `kubectl` commands, the following case-insensitive aliases may be used to specify the resource type on the CLI: `bgpconfiguration.projectcalico.org`, `bgpconfigurations.projectcalico.org` as well as abbreviations such as `bgpconfiguration.p` and `bgpconfigurations.p`. diff --git a/calico-enterprise_versioned_docs/version-3.22-2/reference/resources/bgpfilter.mdx b/calico-enterprise_versioned_docs/version-3.22-2/reference/resources/bgpfilter.mdx index 845b90000b..e34734a144 100644 --- a/calico-enterprise_versioned_docs/version-3.22-2/reference/resources/bgpfilter.mdx +++ b/calico-enterprise_versioned_docs/version-3.22-2/reference/resources/bgpfilter.mdx @@ -2,11 +2,11 @@ description: Reference for the BGPFilter resource in Calico Enterprise that filters routes imported from or exported to BGP peers. --- -# BGP Filter +# BGP filter -A BGP filter resource (`BGPFilter`) represents a way to control -routes imported by and exported to BGP peers specified using a -BGP peer resource (`BGPPeer`). +A Border Gateway Protocol (BGP) filter resource (`BGPFilter`) represents a way to control +routes imported by and exported to BGP peers +specified by a [BGP peer resource](bgppeer.mdx) (`BGPPeer`). The BGPFilter rules are applied sequentially: the `action` for the **first** rule that matches is executed immediately. diff --git a/calico-enterprise_versioned_docs/version-3.22-2/reference/resources/bgppeer.mdx b/calico-enterprise_versioned_docs/version-3.22-2/reference/resources/bgppeer.mdx index 23bec373db..175207a8f9 100644 --- a/calico-enterprise_versioned_docs/version-3.22-2/reference/resources/bgppeer.mdx +++ b/calico-enterprise_versioned_docs/version-3.22-2/reference/resources/bgppeer.mdx @@ -6,10 +6,10 @@ description: Reference for the BGPPeer resource in Calico Enterprise that define import Selectors from '@site/calico-enterprise_versioned_docs/version-3.22-2/_includes/content/_selectors.mdx'; -A BGP peer resource (`BGPPeer`) represents a remote BGP peer with -which the node(s) in a $[prodname] cluster will peer. +A Border Gateway Protocol (BGP) peer resource (`BGPPeer`) represents a remote BGP peer +with which one or more nodes in a $[prodname] cluster exchange routes. Configuring BGP peers allows you to peer a $[prodname] network -with your datacenter fabric (e.g. ToR). For more +with your data center fabric, such as a top-of-rack (ToR) router. For more information on cluster layouts, see $[prodname]'s documentation on [$[prodname] over IP fabrics](../architecture/design/l3-interconnect-fabric.mdx). diff --git a/calico-enterprise_versioned_docs/version-3.22-2/reference/resources/blockaffinity.mdx b/calico-enterprise_versioned_docs/version-3.22-2/reference/resources/blockaffinity.mdx index ce13e63459..14fe953360 100644 --- a/calico-enterprise_versioned_docs/version-3.22-2/reference/resources/blockaffinity.mdx +++ b/calico-enterprise_versioned_docs/version-3.22-2/reference/resources/blockaffinity.mdx @@ -4,7 +4,8 @@ description: Reference for the BlockAffinity resource in Calico Enterprise that # Block affinity -A block affinity resource (`BlockAffinity`) represents the affinity for an IPAM block. These are managed by Calico IPAM. +A block affinity resource (`BlockAffinity`) represents the affinity between a node and an IP address management (IPAM) block. +$[prodname] IPAM creates and manages these resources automatically; you don't normally need to create or modify them. ## Block affinity definition diff --git a/calico-enterprise_versioned_docs/version-3.22-2/reference/resources/caliconodestatus.mdx b/calico-enterprise_versioned_docs/version-3.22-2/reference/resources/caliconodestatus.mdx index 1d35af5cf7..dcdcd0b9dd 100644 --- a/calico-enterprise_versioned_docs/version-3.22-2/reference/resources/caliconodestatus.mdx +++ b/calico-enterprise_versioned_docs/version-3.22-2/reference/resources/caliconodestatus.mdx @@ -4,14 +4,15 @@ description: Reference for the CalicoNodeStatus resource in Calico Enterprise th # Calico node status -A Calico node status resource (`CalicoNodeStatus`) represents a collection of status information for a node that $[prodname] reports back to the user for use during troubleshooting. +A Calico node status resource (`CalicoNodeStatus`) reports status information for a node, for use during troubleshooting. +You create a `CalicoNodeStatus` resource for the node you want to inspect, and $[prodname] periodically writes the collected information to the resource's `status` field. -As of today, status of BGP agents, BGP sessions and routes exposed to BGP agents are collected from Linux nodes only. **Windows nodes are not supported at this time.** -Calico node status resource is only valid when $[prodname] BGP networking is in use. +Status of Border Gateway Protocol (BGP) agents, BGP sessions, and routes exposed to BGP agents is collected from Linux nodes only. **Windows nodes are not supported at this time.** +The resource is valid only when $[prodname] BGP networking is in use. -### Notes +## Notes -The updating of `CalicoNodeStatus` will have a small performance impact on CPU/Memory usage of the node as well as adding load to kubernetes apiserver. +Updating `CalicoNodeStatus` has a small performance impact on CPU and memory usage of the node, and adds load to the Kubernetes API server. In our testing on a ten node, full mesh cluster, a `CalicoNodeStatus` resource was created for each node where the update interval was set to ten seconds. On each node, this resulted in an increase in CPU use of 5% of a vCPU and an increase of 4MB of memory. The control plane node recorded an increase in CPU usage of 5% of a vCPU for these 10 nodes. diff --git a/calico-enterprise_versioned_docs/version-3.22-2/reference/resources/globalnetworkset.mdx b/calico-enterprise_versioned_docs/version-3.22-2/reference/resources/globalnetworkset.mdx index dbaa3a5805..f2f5359d1a 100644 --- a/calico-enterprise_versioned_docs/version-3.22-2/reference/resources/globalnetworkset.mdx +++ b/calico-enterprise_versioned_docs/version-3.22-2/reference/resources/globalnetworkset.mdx @@ -6,7 +6,7 @@ description: Reference for the GlobalNetworkSet resource in Calico Enterprise th import DomainNames from '@site/calico-enterprise_versioned_docs/version-3.22-2/_includes/content/_domain-names.mdx'; -A global network set resource (GlobalNetworkSet) represents an arbitrary set of IP subnetworks/CIDRs, +A global network set resource (`GlobalNetworkSet`) represents an arbitrary set of IP subnetworks/CIDRs, allowing it to be matched by $[prodname] policy. Network sets are useful for applying policy to traffic coming from (or going to) external, non-$[prodname], networks. diff --git a/calico-enterprise_versioned_docs/version-3.22-2/reference/resources/ipamconfig.mdx b/calico-enterprise_versioned_docs/version-3.22-2/reference/resources/ipamconfig.mdx index d8b3323a85..1f433493bc 100644 --- a/calico-enterprise_versioned_docs/version-3.22-2/reference/resources/ipamconfig.mdx +++ b/calico-enterprise_versioned_docs/version-3.22-2/reference/resources/ipamconfig.mdx @@ -4,7 +4,7 @@ description: Reference for the IP address management configuration resource in C # IPAM configuration -An IPAM configuration resource (`IPAMConfiguration`) represents global IPAM configuration options. +An IP address management (IPAM) configuration resource (`IPAMConfiguration`) represents global IPAM configuration options. ## Sample YAML diff --git a/calico-enterprise_versioned_docs/version-3.22-2/reference/resources/networkset.mdx b/calico-enterprise_versioned_docs/version-3.22-2/reference/resources/networkset.mdx index 4bcd774899..80a004f6a9 100644 --- a/calico-enterprise_versioned_docs/version-3.22-2/reference/resources/networkset.mdx +++ b/calico-enterprise_versioned_docs/version-3.22-2/reference/resources/networkset.mdx @@ -6,11 +6,11 @@ description: Reference for the NetworkSet resource in Calico Enterprise that def import DomainNames from '@site/calico-enterprise_versioned_docs/version-3.22-2/_includes/content/_domain-names.mdx'; -A network set resource (NetworkSet) represents an arbitrary set of IP subnetworks/CIDRs, +A network set resource (`NetworkSet`) represents an arbitrary set of IP subnetworks/CIDRs, allowing it to be matched by $[prodname] policy. Network sets are useful for applying policy to traffic coming from (or going to) external, non-$[prodname], networks. -`NetworkSet` is a namespaced resource. `NetworkSets` in a specific namespace +`NetworkSet` is a namespaced resource. A `NetworkSet` in a specific namespace only applies to [network policies](networkpolicy.mdx) in that namespace. Two resources are in the same namespace if the `namespace` value is set the same on both. (See [GlobalNetworkSet](globalnetworkset.mdx) for non-namespaced network sets.) diff --git a/calico-enterprise_versioned_docs/version-3.22-2/reference/resources/stagedkubernetesnetworkpolicy.mdx b/calico-enterprise_versioned_docs/version-3.22-2/reference/resources/stagedkubernetesnetworkpolicy.mdx index a54338cbcc..78e651a447 100644 --- a/calico-enterprise_versioned_docs/version-3.22-2/reference/resources/stagedkubernetesnetworkpolicy.mdx +++ b/calico-enterprise_versioned_docs/version-3.22-2/reference/resources/stagedkubernetesnetworkpolicy.mdx @@ -4,7 +4,7 @@ description: Reference for the StagedKubernetesNetworkPolicy resource in Calico # Staged Kubernetes network policy -A staged kubernetes network policy resource (`StagedKubernetesNetworkPolicy`) represents a staged version +A staged Kubernetes network policy resource (`StagedKubernetesNetworkPolicy`) represents a staged version of [Kubernetes network policy](https://kubernetes.io/docs/concepts/services-networking/network-policies). This is used to preview network behavior before actually enforcing the network policy. Once persisted, this will create a Kubernetes network policy backed by a $[prodname] diff --git a/calico-enterprise_versioned_docs/version-3.22-2/reference/resources/tier.mdx b/calico-enterprise_versioned_docs/version-3.22-2/reference/resources/tier.mdx index 821b37012d..d898df606f 100644 --- a/calico-enterprise_versioned_docs/version-3.22-2/reference/resources/tier.mdx +++ b/calico-enterprise_versioned_docs/version-3.22-2/reference/resources/tier.mdx @@ -8,7 +8,7 @@ A tier resource (`Tier`) represents an ordered collection of [NetworkPolicies](n and/or [GlobalNetworkPolicies](globalnetworkpolicy.mdx). Tiers are used to divide these policies into groups of different priorities. These policies are ordered within a Tier: the additional hierarchy of Tiers provides more flexibility -because the `Pass` `action` in a Rule jumps to the next Tier. Some example use cases for this are. +because the `Pass` `action` in a Rule jumps to the next Tier. Some example use cases for this are: - Allowing privileged users to define security policy that takes precedence over other users. - Translating hierarchies of physical firewalls directly into $[prodname] policy. diff --git a/calico-enterprise_versioned_docs/version-3.23-2/reference/resources/bgpconfig.mdx b/calico-enterprise_versioned_docs/version-3.23-2/reference/resources/bgpconfig.mdx index dd6ff1b4cf..1c67ca8717 100644 --- a/calico-enterprise_versioned_docs/version-3.23-2/reference/resources/bgpconfig.mdx +++ b/calico-enterprise_versioned_docs/version-3.23-2/reference/resources/bgpconfig.mdx @@ -4,8 +4,8 @@ description: Reference for the BGPConfiguration resource in Calico Enterprise th # BGP configuration -A BGP configuration resource (`BGPConfiguration`) represents BGP specific configuration options for the cluster or a -specific node. +A Border Gateway Protocol (BGP) configuration resource (`BGPConfiguration`) represents BGP configuration options +for the cluster or a specific node. For `kubectl` commands, the following case-insensitive aliases may be used to specify the resource type on the CLI: `bgpconfiguration.projectcalico.org`, `bgpconfigurations.projectcalico.org` as well as abbreviations such as `bgpconfiguration.p` and `bgpconfigurations.p`. diff --git a/calico-enterprise_versioned_docs/version-3.23-2/reference/resources/bgpfilter.mdx b/calico-enterprise_versioned_docs/version-3.23-2/reference/resources/bgpfilter.mdx index 38ba677042..289229049f 100644 --- a/calico-enterprise_versioned_docs/version-3.23-2/reference/resources/bgpfilter.mdx +++ b/calico-enterprise_versioned_docs/version-3.23-2/reference/resources/bgpfilter.mdx @@ -2,11 +2,11 @@ description: Reference for the BGPFilter resource in Calico Enterprise that filters routes imported from or exported to BGP peers. --- -# BGP Filter +# BGP filter -A BGP filter resource (`BGPFilter`) represents a way to control -routes imported by and exported to BGP peers specified using a -BGP peer resource (`BGPPeer`). +A Border Gateway Protocol (BGP) filter resource (`BGPFilter`) represents a way to control +routes imported by and exported to BGP peers +specified by a [BGP peer resource](bgppeer.mdx) (`BGPPeer`). The BGPFilter rules are applied sequentially: the `action` for the **first** rule that matches is executed immediately. diff --git a/calico-enterprise_versioned_docs/version-3.23-2/reference/resources/bgppeer.mdx b/calico-enterprise_versioned_docs/version-3.23-2/reference/resources/bgppeer.mdx index c3af3de311..dac5fbb712 100644 --- a/calico-enterprise_versioned_docs/version-3.23-2/reference/resources/bgppeer.mdx +++ b/calico-enterprise_versioned_docs/version-3.23-2/reference/resources/bgppeer.mdx @@ -6,10 +6,10 @@ description: Reference for the BGPPeer resource in Calico Enterprise that define import Selectors from '@site/calico-enterprise_versioned_docs/version-3.23-2/_includes/content/_selectors.mdx'; -A BGP peer resource (`BGPPeer`) represents a remote BGP peer with -which the node(s) in a $[prodname] cluster will peer. +A Border Gateway Protocol (BGP) peer resource (`BGPPeer`) represents a remote BGP peer +with which one or more nodes in a $[prodname] cluster exchange routes. Configuring BGP peers allows you to peer a $[prodname] network -with your datacenter fabric (e.g. ToR). For more +with your data center fabric, such as a top-of-rack (ToR) router. For more information on cluster layouts, see $[prodname]'s documentation on [$[prodname] over IP fabrics](../architecture/design/l3-interconnect-fabric.mdx). diff --git a/calico-enterprise_versioned_docs/version-3.23-2/reference/resources/blockaffinity.mdx b/calico-enterprise_versioned_docs/version-3.23-2/reference/resources/blockaffinity.mdx index ce13e63459..14fe953360 100644 --- a/calico-enterprise_versioned_docs/version-3.23-2/reference/resources/blockaffinity.mdx +++ b/calico-enterprise_versioned_docs/version-3.23-2/reference/resources/blockaffinity.mdx @@ -4,7 +4,8 @@ description: Reference for the BlockAffinity resource in Calico Enterprise that # Block affinity -A block affinity resource (`BlockAffinity`) represents the affinity for an IPAM block. These are managed by Calico IPAM. +A block affinity resource (`BlockAffinity`) represents the affinity between a node and an IP address management (IPAM) block. +$[prodname] IPAM creates and manages these resources automatically; you don't normally need to create or modify them. ## Block affinity definition diff --git a/calico-enterprise_versioned_docs/version-3.23-2/reference/resources/caliconodestatus.mdx b/calico-enterprise_versioned_docs/version-3.23-2/reference/resources/caliconodestatus.mdx index 1d35af5cf7..dcdcd0b9dd 100644 --- a/calico-enterprise_versioned_docs/version-3.23-2/reference/resources/caliconodestatus.mdx +++ b/calico-enterprise_versioned_docs/version-3.23-2/reference/resources/caliconodestatus.mdx @@ -4,14 +4,15 @@ description: Reference for the CalicoNodeStatus resource in Calico Enterprise th # Calico node status -A Calico node status resource (`CalicoNodeStatus`) represents a collection of status information for a node that $[prodname] reports back to the user for use during troubleshooting. +A Calico node status resource (`CalicoNodeStatus`) reports status information for a node, for use during troubleshooting. +You create a `CalicoNodeStatus` resource for the node you want to inspect, and $[prodname] periodically writes the collected information to the resource's `status` field. -As of today, status of BGP agents, BGP sessions and routes exposed to BGP agents are collected from Linux nodes only. **Windows nodes are not supported at this time.** -Calico node status resource is only valid when $[prodname] BGP networking is in use. +Status of Border Gateway Protocol (BGP) agents, BGP sessions, and routes exposed to BGP agents is collected from Linux nodes only. **Windows nodes are not supported at this time.** +The resource is valid only when $[prodname] BGP networking is in use. -### Notes +## Notes -The updating of `CalicoNodeStatus` will have a small performance impact on CPU/Memory usage of the node as well as adding load to kubernetes apiserver. +Updating `CalicoNodeStatus` has a small performance impact on CPU and memory usage of the node, and adds load to the Kubernetes API server. In our testing on a ten node, full mesh cluster, a `CalicoNodeStatus` resource was created for each node where the update interval was set to ten seconds. On each node, this resulted in an increase in CPU use of 5% of a vCPU and an increase of 4MB of memory. The control plane node recorded an increase in CPU usage of 5% of a vCPU for these 10 nodes. diff --git a/calico-enterprise_versioned_docs/version-3.23-2/reference/resources/globalnetworkset.mdx b/calico-enterprise_versioned_docs/version-3.23-2/reference/resources/globalnetworkset.mdx index 207466d8b7..f69c07ea4d 100644 --- a/calico-enterprise_versioned_docs/version-3.23-2/reference/resources/globalnetworkset.mdx +++ b/calico-enterprise_versioned_docs/version-3.23-2/reference/resources/globalnetworkset.mdx @@ -6,7 +6,7 @@ description: Reference for the GlobalNetworkSet resource in Calico Enterprise th import DomainNames from '@site/calico-enterprise_versioned_docs/version-3.23-2/_includes/content/_domain-names.mdx'; -A global network set resource (GlobalNetworkSet) represents an arbitrary set of IP subnetworks/CIDRs, +A global network set resource (`GlobalNetworkSet`) represents an arbitrary set of IP subnetworks/CIDRs, allowing it to be matched by $[prodname] policy. Network sets are useful for applying policy to traffic coming from (or going to) external, non-$[prodname], networks. diff --git a/calico-enterprise_versioned_docs/version-3.23-2/reference/resources/ipamconfig.mdx b/calico-enterprise_versioned_docs/version-3.23-2/reference/resources/ipamconfig.mdx index beb907cf45..1a4fd0425d 100644 --- a/calico-enterprise_versioned_docs/version-3.23-2/reference/resources/ipamconfig.mdx +++ b/calico-enterprise_versioned_docs/version-3.23-2/reference/resources/ipamconfig.mdx @@ -4,7 +4,7 @@ description: Reference for the IP address management configuration resource in C # IPAM configuration -An IPAM configuration resource (`IPAMConfiguration`) represents global IPAM configuration options. +An IP address management (IPAM) configuration resource (`IPAMConfiguration`) represents global IPAM configuration options. ## Sample YAML diff --git a/calico-enterprise_versioned_docs/version-3.23-2/reference/resources/networkset.mdx b/calico-enterprise_versioned_docs/version-3.23-2/reference/resources/networkset.mdx index d7aea7ac49..05ac23dd60 100644 --- a/calico-enterprise_versioned_docs/version-3.23-2/reference/resources/networkset.mdx +++ b/calico-enterprise_versioned_docs/version-3.23-2/reference/resources/networkset.mdx @@ -6,11 +6,11 @@ description: Reference for the NetworkSet resource in Calico Enterprise that def import DomainNames from '@site/calico-enterprise_versioned_docs/version-3.23-2/_includes/content/_domain-names.mdx'; -A network set resource (NetworkSet) represents an arbitrary set of IP subnetworks/CIDRs, +A network set resource (`NetworkSet`) represents an arbitrary set of IP subnetworks/CIDRs, allowing it to be matched by $[prodname] policy. Network sets are useful for applying policy to traffic coming from (or going to) external, non-$[prodname], networks. -`NetworkSet` is a namespaced resource. `NetworkSets` in a specific namespace +`NetworkSet` is a namespaced resource. A `NetworkSet` in a specific namespace only applies to [network policies](networkpolicy.mdx) in that namespace. Two resources are in the same namespace if the `namespace` value is set the same on both. (See [GlobalNetworkSet](globalnetworkset.mdx) for non-namespaced network sets.) diff --git a/calico-enterprise_versioned_docs/version-3.23-2/reference/resources/stagedkubernetesnetworkpolicy.mdx b/calico-enterprise_versioned_docs/version-3.23-2/reference/resources/stagedkubernetesnetworkpolicy.mdx index a54338cbcc..78e651a447 100644 --- a/calico-enterprise_versioned_docs/version-3.23-2/reference/resources/stagedkubernetesnetworkpolicy.mdx +++ b/calico-enterprise_versioned_docs/version-3.23-2/reference/resources/stagedkubernetesnetworkpolicy.mdx @@ -4,7 +4,7 @@ description: Reference for the StagedKubernetesNetworkPolicy resource in Calico # Staged Kubernetes network policy -A staged kubernetes network policy resource (`StagedKubernetesNetworkPolicy`) represents a staged version +A staged Kubernetes network policy resource (`StagedKubernetesNetworkPolicy`) represents a staged version of [Kubernetes network policy](https://kubernetes.io/docs/concepts/services-networking/network-policies). This is used to preview network behavior before actually enforcing the network policy. Once persisted, this will create a Kubernetes network policy backed by a $[prodname] diff --git a/calico-enterprise_versioned_docs/version-3.23-2/reference/resources/tier.mdx b/calico-enterprise_versioned_docs/version-3.23-2/reference/resources/tier.mdx index 821b37012d..d898df606f 100644 --- a/calico-enterprise_versioned_docs/version-3.23-2/reference/resources/tier.mdx +++ b/calico-enterprise_versioned_docs/version-3.23-2/reference/resources/tier.mdx @@ -8,7 +8,7 @@ A tier resource (`Tier`) represents an ordered collection of [NetworkPolicies](n and/or [GlobalNetworkPolicies](globalnetworkpolicy.mdx). Tiers are used to divide these policies into groups of different priorities. These policies are ordered within a Tier: the additional hierarchy of Tiers provides more flexibility -because the `Pass` `action` in a Rule jumps to the next Tier. Some example use cases for this are. +because the `Pass` `action` in a Rule jumps to the next Tier. Some example use cases for this are: - Allowing privileged users to define security policy that takes precedence over other users. - Translating hierarchies of physical firewalls directly into $[prodname] policy. diff --git a/calico-enterprise_versioned_docs/version-3.24-2/reference/resources/bgpconfig.mdx b/calico-enterprise_versioned_docs/version-3.24-2/reference/resources/bgpconfig.mdx index dd6ff1b4cf..1c67ca8717 100644 --- a/calico-enterprise_versioned_docs/version-3.24-2/reference/resources/bgpconfig.mdx +++ b/calico-enterprise_versioned_docs/version-3.24-2/reference/resources/bgpconfig.mdx @@ -4,8 +4,8 @@ description: Reference for the BGPConfiguration resource in Calico Enterprise th # BGP configuration -A BGP configuration resource (`BGPConfiguration`) represents BGP specific configuration options for the cluster or a -specific node. +A Border Gateway Protocol (BGP) configuration resource (`BGPConfiguration`) represents BGP configuration options +for the cluster or a specific node. For `kubectl` commands, the following case-insensitive aliases may be used to specify the resource type on the CLI: `bgpconfiguration.projectcalico.org`, `bgpconfigurations.projectcalico.org` as well as abbreviations such as `bgpconfiguration.p` and `bgpconfigurations.p`. diff --git a/calico-enterprise_versioned_docs/version-3.24-2/reference/resources/bgpfilter.mdx b/calico-enterprise_versioned_docs/version-3.24-2/reference/resources/bgpfilter.mdx index 38ba677042..289229049f 100644 --- a/calico-enterprise_versioned_docs/version-3.24-2/reference/resources/bgpfilter.mdx +++ b/calico-enterprise_versioned_docs/version-3.24-2/reference/resources/bgpfilter.mdx @@ -2,11 +2,11 @@ description: Reference for the BGPFilter resource in Calico Enterprise that filters routes imported from or exported to BGP peers. --- -# BGP Filter +# BGP filter -A BGP filter resource (`BGPFilter`) represents a way to control -routes imported by and exported to BGP peers specified using a -BGP peer resource (`BGPPeer`). +A Border Gateway Protocol (BGP) filter resource (`BGPFilter`) represents a way to control +routes imported by and exported to BGP peers +specified by a [BGP peer resource](bgppeer.mdx) (`BGPPeer`). The BGPFilter rules are applied sequentially: the `action` for the **first** rule that matches is executed immediately. diff --git a/calico-enterprise_versioned_docs/version-3.24-2/reference/resources/bgppeer.mdx b/calico-enterprise_versioned_docs/version-3.24-2/reference/resources/bgppeer.mdx index 795ca9d6fa..c485c0ad13 100644 --- a/calico-enterprise_versioned_docs/version-3.24-2/reference/resources/bgppeer.mdx +++ b/calico-enterprise_versioned_docs/version-3.24-2/reference/resources/bgppeer.mdx @@ -6,10 +6,10 @@ description: Reference for the BGPPeer resource in Calico Enterprise that define import Selectors from '@site/calico-enterprise_versioned_docs/version-3.24-2/_includes/content/_selectors.mdx'; -A BGP peer resource (`BGPPeer`) represents a remote BGP peer with -which the node(s) in a $[prodname] cluster will peer. +A Border Gateway Protocol (BGP) peer resource (`BGPPeer`) represents a remote BGP peer +with which one or more nodes in a $[prodname] cluster exchange routes. Configuring BGP peers allows you to peer a $[prodname] network -with your datacenter fabric (e.g. ToR). For more +with your data center fabric, such as a top-of-rack (ToR) router. For more information on cluster layouts, see $[prodname]'s documentation on [$[prodname] over IP fabrics](../architecture/design/l3-interconnect-fabric.mdx). diff --git a/calico-enterprise_versioned_docs/version-3.24-2/reference/resources/blockaffinity.mdx b/calico-enterprise_versioned_docs/version-3.24-2/reference/resources/blockaffinity.mdx index ce13e63459..14fe953360 100644 --- a/calico-enterprise_versioned_docs/version-3.24-2/reference/resources/blockaffinity.mdx +++ b/calico-enterprise_versioned_docs/version-3.24-2/reference/resources/blockaffinity.mdx @@ -4,7 +4,8 @@ description: Reference for the BlockAffinity resource in Calico Enterprise that # Block affinity -A block affinity resource (`BlockAffinity`) represents the affinity for an IPAM block. These are managed by Calico IPAM. +A block affinity resource (`BlockAffinity`) represents the affinity between a node and an IP address management (IPAM) block. +$[prodname] IPAM creates and manages these resources automatically; you don't normally need to create or modify them. ## Block affinity definition diff --git a/calico-enterprise_versioned_docs/version-3.24-2/reference/resources/caliconodestatus.mdx b/calico-enterprise_versioned_docs/version-3.24-2/reference/resources/caliconodestatus.mdx index 1d35af5cf7..dcdcd0b9dd 100644 --- a/calico-enterprise_versioned_docs/version-3.24-2/reference/resources/caliconodestatus.mdx +++ b/calico-enterprise_versioned_docs/version-3.24-2/reference/resources/caliconodestatus.mdx @@ -4,14 +4,15 @@ description: Reference for the CalicoNodeStatus resource in Calico Enterprise th # Calico node status -A Calico node status resource (`CalicoNodeStatus`) represents a collection of status information for a node that $[prodname] reports back to the user for use during troubleshooting. +A Calico node status resource (`CalicoNodeStatus`) reports status information for a node, for use during troubleshooting. +You create a `CalicoNodeStatus` resource for the node you want to inspect, and $[prodname] periodically writes the collected information to the resource's `status` field. -As of today, status of BGP agents, BGP sessions and routes exposed to BGP agents are collected from Linux nodes only. **Windows nodes are not supported at this time.** -Calico node status resource is only valid when $[prodname] BGP networking is in use. +Status of Border Gateway Protocol (BGP) agents, BGP sessions, and routes exposed to BGP agents is collected from Linux nodes only. **Windows nodes are not supported at this time.** +The resource is valid only when $[prodname] BGP networking is in use. -### Notes +## Notes -The updating of `CalicoNodeStatus` will have a small performance impact on CPU/Memory usage of the node as well as adding load to kubernetes apiserver. +Updating `CalicoNodeStatus` has a small performance impact on CPU and memory usage of the node, and adds load to the Kubernetes API server. In our testing on a ten node, full mesh cluster, a `CalicoNodeStatus` resource was created for each node where the update interval was set to ten seconds. On each node, this resulted in an increase in CPU use of 5% of a vCPU and an increase of 4MB of memory. The control plane node recorded an increase in CPU usage of 5% of a vCPU for these 10 nodes. diff --git a/calico-enterprise_versioned_docs/version-3.24-2/reference/resources/globalnetworkset.mdx b/calico-enterprise_versioned_docs/version-3.24-2/reference/resources/globalnetworkset.mdx index 61eec23b91..a036126b65 100644 --- a/calico-enterprise_versioned_docs/version-3.24-2/reference/resources/globalnetworkset.mdx +++ b/calico-enterprise_versioned_docs/version-3.24-2/reference/resources/globalnetworkset.mdx @@ -6,7 +6,7 @@ description: Reference for the GlobalNetworkSet resource in Calico Enterprise th import DomainNames from '@site/calico-enterprise_versioned_docs/version-3.24-2/_includes/content/_domain-names.mdx'; -A global network set resource (GlobalNetworkSet) represents an arbitrary set of IP subnetworks/CIDRs, +A global network set resource (`GlobalNetworkSet`) represents an arbitrary set of IP subnetworks/CIDRs, allowing it to be matched by $[prodname] policy. Network sets are useful for applying policy to traffic coming from (or going to) external, non-$[prodname], networks. diff --git a/calico-enterprise_versioned_docs/version-3.24-2/reference/resources/ipamconfig.mdx b/calico-enterprise_versioned_docs/version-3.24-2/reference/resources/ipamconfig.mdx index beb907cf45..1a4fd0425d 100644 --- a/calico-enterprise_versioned_docs/version-3.24-2/reference/resources/ipamconfig.mdx +++ b/calico-enterprise_versioned_docs/version-3.24-2/reference/resources/ipamconfig.mdx @@ -4,7 +4,7 @@ description: Reference for the IP address management configuration resource in C # IPAM configuration -An IPAM configuration resource (`IPAMConfiguration`) represents global IPAM configuration options. +An IP address management (IPAM) configuration resource (`IPAMConfiguration`) represents global IPAM configuration options. ## Sample YAML diff --git a/calico-enterprise_versioned_docs/version-3.24-2/reference/resources/networkset.mdx b/calico-enterprise_versioned_docs/version-3.24-2/reference/resources/networkset.mdx index 782a0f56cc..79b3c71c3c 100644 --- a/calico-enterprise_versioned_docs/version-3.24-2/reference/resources/networkset.mdx +++ b/calico-enterprise_versioned_docs/version-3.24-2/reference/resources/networkset.mdx @@ -6,11 +6,11 @@ description: Reference for the NetworkSet resource in Calico Enterprise that def import DomainNames from '@site/calico-enterprise_versioned_docs/version-3.24-2/_includes/content/_domain-names.mdx'; -A network set resource (NetworkSet) represents an arbitrary set of IP subnetworks/CIDRs, +A network set resource (`NetworkSet`) represents an arbitrary set of IP subnetworks/CIDRs, allowing it to be matched by $[prodname] policy. Network sets are useful for applying policy to traffic coming from (or going to) external, non-$[prodname], networks. -`NetworkSet` is a namespaced resource. `NetworkSets` in a specific namespace +`NetworkSet` is a namespaced resource. A `NetworkSet` in a specific namespace only applies to [network policies](networkpolicy.mdx) in that namespace. Two resources are in the same namespace if the `namespace` value is set the same on both. (See [GlobalNetworkSet](globalnetworkset.mdx) for non-namespaced network sets.) diff --git a/calico-enterprise_versioned_docs/version-3.24-2/reference/resources/stagedkubernetesnetworkpolicy.mdx b/calico-enterprise_versioned_docs/version-3.24-2/reference/resources/stagedkubernetesnetworkpolicy.mdx index a54338cbcc..78e651a447 100644 --- a/calico-enterprise_versioned_docs/version-3.24-2/reference/resources/stagedkubernetesnetworkpolicy.mdx +++ b/calico-enterprise_versioned_docs/version-3.24-2/reference/resources/stagedkubernetesnetworkpolicy.mdx @@ -4,7 +4,7 @@ description: Reference for the StagedKubernetesNetworkPolicy resource in Calico # Staged Kubernetes network policy -A staged kubernetes network policy resource (`StagedKubernetesNetworkPolicy`) represents a staged version +A staged Kubernetes network policy resource (`StagedKubernetesNetworkPolicy`) represents a staged version of [Kubernetes network policy](https://kubernetes.io/docs/concepts/services-networking/network-policies). This is used to preview network behavior before actually enforcing the network policy. Once persisted, this will create a Kubernetes network policy backed by a $[prodname] diff --git a/calico-enterprise_versioned_docs/version-3.24-2/reference/resources/tier.mdx b/calico-enterprise_versioned_docs/version-3.24-2/reference/resources/tier.mdx index 821b37012d..d898df606f 100644 --- a/calico-enterprise_versioned_docs/version-3.24-2/reference/resources/tier.mdx +++ b/calico-enterprise_versioned_docs/version-3.24-2/reference/resources/tier.mdx @@ -8,7 +8,7 @@ A tier resource (`Tier`) represents an ordered collection of [NetworkPolicies](n and/or [GlobalNetworkPolicies](globalnetworkpolicy.mdx). Tiers are used to divide these policies into groups of different priorities. These policies are ordered within a Tier: the additional hierarchy of Tiers provides more flexibility -because the `Pass` `action` in a Rule jumps to the next Tier. Some example use cases for this are. +because the `Pass` `action` in a Rule jumps to the next Tier. Some example use cases for this are: - Allowing privileged users to define security policy that takes precedence over other users. - Translating hierarchies of physical firewalls directly into $[prodname] policy.