Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions calico-cloud/reference/resources/bgpconfig.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ description: Reference for the BGPConfiguration resource in Calico Cloud connect

# 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`.

Expand Down
8 changes: 4 additions & 4 deletions calico-cloud/reference/resources/bgpfilter.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
description: Reference for the BGPFilter resource in Calico Cloud connected clusters 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`).
Comment on lines +7 to +9

The BGPFilter rules are applied sequentially: the `action` for
the **first** rule that matches is executed immediately.
Expand Down
6 changes: 3 additions & 3 deletions calico-cloud/reference/resources/bgppeer.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ description: Reference for the BGPPeer resource in Calico Cloud connected cluste

import Selectors from '@site/calico-cloud/_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).

Expand Down
3 changes: 2 additions & 1 deletion calico-cloud/reference/resources/blockaffinity.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ description: Reference for the BlockAffinity resource in Calico Cloud connected

# 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

Expand Down
11 changes: 6 additions & 5 deletions calico-cloud/reference/resources/caliconodestatus.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,15 @@ description: Reference for the CalicoNodeStatus resource in Calico Cloud connect

# 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.

Expand Down
2 changes: 1 addition & 1 deletion calico-cloud/reference/resources/globalnetworkset.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: Reference for the GlobalNetworkSet resource in Calico Cloud connect

import DomainNames from '@site/calico-cloud/_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.

Expand Down
2 changes: 1 addition & 1 deletion calico-cloud/reference/resources/ipamconfig.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions calico-cloud/reference/resources/networkset.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ description: Reference for the NetworkSet resource in Calico Cloud connected clu

import DomainNames from '@site/calico-cloud/_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.)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
2 changes: 1 addition & 1 deletion calico-cloud/reference/resources/tier.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ description: Reference for the BGPConfiguration resource in Calico Cloud connect

# 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`.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
description: Reference for the BGPFilter resource in Calico Cloud connected clusters 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`).
Comment on lines +7 to +9

The BGPFilter rules are applied sequentially: the `action` for
the **first** rule that matches is executed immediately.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ description: Reference for the BGPPeer resource in Calico Cloud connected cluste

import Selectors from '@site/calico-cloud_versioned_docs/version-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).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ description: Reference for the BlockAffinity resource in Calico Cloud connected

# 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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,15 @@ description: Reference for the CalicoNodeStatus resource in Calico Cloud connect

# 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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: Reference for the GlobalNetworkSet resource in Calico Cloud connect

import DomainNames from '@site/calico-cloud_versioned_docs/version-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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ description: Reference for the NetworkSet resource in Calico Cloud connected clu

import DomainNames from '@site/calico-cloud_versioned_docs/version-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.)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -620,6 +620,7 @@
"reference/resources/networkset",
"reference/resources/node",
"reference/resources/packetcapture",
"reference/resources/policyrecommendations",
"reference/resources/remoteclusterconfiguration",
"reference/resources/securityeventwebhook",
"reference/resources/stagedglobalnetworkpolicy",
Expand Down
1 change: 1 addition & 0 deletions sidebars-calico-cloud.js
Original file line number Diff line number Diff line change
Expand Up @@ -490,6 +490,7 @@ module.exports = {
'reference/resources/networkset',
'reference/resources/node',
'reference/resources/packetcapture',
'reference/resources/policyrecommendations',
'reference/resources/remoteclusterconfiguration',
'reference/resources/securityeventwebhook',
'reference/resources/stagedglobalnetworkpolicy',
Expand Down