---
title: "Node"
description: "Reference for the Node resource in Calico Cloud connected clusters that represents a host running the cnx-node agent."
product: "Calico Cloud"
version: "v23.0.1"
section: "Reference"
canonical_url: "https://docs.tigera.io/calico-cloud/reference/resources/node"
---

# Node

A node resource (`Node`) represents a node running Calico Cloud. When adding a host to a Calico Cloud cluster, a node resource needs to be created which contains the configuration for the `cnx-node` instance running on the host.

When starting a `cnx-node` instance, the name supplied to the instance should match the name configured in the Node resource.

By default, starting a `cnx-node` instance will automatically create a node resource using the `hostname` of the compute host.

This resource is not supported in `kubectl`.

## Sample YAML

```yaml
apiVersion: projectcalico.org/v3
kind: Node
metadata:
  name: node-hostname
spec:
  bgp:
    asNumber: 64512
    ipv4Address: 10.244.0.1/24
    ipv6Address: 2001:db8:85a3::8a2e:370:7334/120
    ipv4IPIPTunnelAddr: 192.168.0.1
```

## Definition

### Metadata

| Field | Description                      | Accepted Values                                     | Schema |
| ----- | -------------------------------- | --------------------------------------------------- | ------ |
| name  | The name of this node. Required. | Alphanumeric string with optional `.`, `_`, or `-`. | string |

### Spec

| Field                | Description                                                                                                                                                                                        | Accepted Values | Schema                        | Default |
| -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------- | ----------------------------- | ------- |
| bgp                  | BGP configuration for this node. Omit if using Calico Cloud for policy only.                                                                                                                       |                 | [BGP](#bgp)                   |         |
| ipv4VXLANTunnelAddr  | IPv4 address of the VXLAN tunnel. This is system configured and should not be updated manually.                                                                                                    |                 | string                        |         |
| ipv6VXLANTunnelAddr  | IPv6 address of the VXLAN tunnel. This is system configured and should not be updated manually.                                                                                                    |                 | string                        |         |
| vxlanTunnelMACAddr   | MAC address of the VXLAN tunnel. This is system configured and should not be updated manually.                                                                                                     |                 | string                        |         |
| vxlanTunnelMACAddrV6 | MAC address of the IPv6 VXLAN tunnel. This is system configured and should not be updated manually.                                                                                                |                 | string                        |         |
| orchRefs             | Correlates this node to a node in another orchestrator.                                                                                                                                            |                 | list of [OrchRefs](#orchref)  |         |
| wireguard            | WireGuard configuration for this node. This is applicable only if WireGuard is enabled in [Felix Configuration](https://docs.tigera.io/calico-cloud/reference/resources/felixconfig.md).              |                 | [WireGuard](#wireguard)       |         |
| loadBalancer         | Load balancer configuration for this node. This is applicable only if the eBPF dataplane is enabled in [Felix Configuration](https://docs.tigera.io/calico-cloud/reference/resources/felixconfig.md). |                 | [LoadBalancer](#loadbalancer) |         |

### OrchRef

| Field        | Description                                      | Accepted Values | Schema | Default |
| ------------ | ------------------------------------------------ | --------------- | ------ | ------- |
| nodeName     | Name of this node according to the orchestrator. |                 | string |         |
| orchestrator | Name of the orchestrator.                        | k8s             | string |         |

### BGP

| Field                   | Description                                                                                        | Accepted Values                                                                                                                                                                                                 | Schema  | Default |
| ----------------------- | -------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | ------- |
| asNumber                | The AS Number of your `cnx-node`.                                                                  | Optional. If omitted the global value is used (see [example modifying Global BGP settings](https://docs.tigera.io/calico-cloud/networking/configuring/bgp.md) for details about modifying the `asNumber` setting). | integer |         |
| ipv4Address             | The IPv4 address and subnet exported as the next-hop for the Calico Cloud endpoints on the host    | The IPv4 address must be specified if BGP is enabled.                                                                                                                                                           | string  |         |
| ipv6Address             | The IPv6 address and subnet exported as the next-hop for the Calico Cloud endpoints on the host    | Optional                                                                                                                                                                                                        | string  |         |
| ipv4IPIPTunnelAddr      | IPv4 address of the IP-in-IP tunnel. This is system configured and should not be updated manually. | Optional IPv4 address                                                                                                                                                                                           | string  |         |
| routeReflectorClusterID | Enables this node as a route reflector within the given cluster                                    | Optional IPv4 address                                                                                                                                                                                           | string  |         |

### WireGuard

| Field                | Description                                                                               | Accepted Values | Schema | Default |
| -------------------- | ----------------------------------------------------------------------------------------- | --------------- | ------ | ------- |
| interfaceIPv4Address | The IP address and subnet for the IPv4 WireGuard interface created by Felix on this node. | Optional        | string |         |
| interfaceIPv6Address | The IP address and subnet for the IPv6 WireGuard interface created by Felix on this node. | Optional        | string |         |

### LoadBalancer

| Field       | Description                                                                                                                                                                                                                     | Accepted Values                                                                                                                    | Schema | Default |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ------ | ------- |
| maintenance | Indicates if the node is under maintenance, for the purposes of external traffic load balancing. eBPF dataplane only. This corresponds to the 'lb.projectcalico.org/maintenance' annotation added to Kubernetes node resources. | Optional: `ExcludeLocalBackends` (K8s node annotation value: `exclude-local-backends`), `None` (K8s node annotation value: `none`) | string |         |

## Supported operations

| Datastore type        | Create/Delete | Update | Get/List | Notes                                                     |
| --------------------- | ------------- | ------ | -------- | --------------------------------------------------------- |
| Kubernetes API server | No            | Yes    | Yes      | `cnx-node` data is directly tied to the Kubernetes nodes. |