{ "description": "CiliumNode represents a node managed by Cilium. It contains a specification\nto control various node specific configuration aspects and a status section\nto represent the status of the node.", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", "type": "string" }, "kind": { "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", "type": "string" }, "metadata": { "type": "object" }, "spec": { "description": "Spec defines the desired specification/configuration of the node.", "properties": { "addresses": { "description": "Addresses is the list of all node addresses.", "items": { "description": "NodeAddress is a node address.", "properties": { "ip": { "description": "IP is an IP of a node", "type": "string" }, "type": { "description": "Type is the type of the node address", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "alibaba-cloud": { "description": "AlibabaCloud is the AlibabaCloud IPAM specific configuration.", "properties": { "availability-zone": { "description": "AvailabilityZone is the availability zone to use when allocating\nENIs.", "type": "string" }, "cidr-block": { "description": "CIDRBlock is vpc ipv4 CIDR", "type": "string" }, "instance-type": { "description": "InstanceType is the ECS instance type, e.g. \"ecs.g6.2xlarge\"", "type": "string" }, "security-group-tags": { "additionalProperties": { "type": "string" }, "description": "SecurityGroupTags is the list of tags to use when evaluating which\nsecurity groups to use for the ENI.", "type": "object" }, "security-groups": { "description": "SecurityGroups is the list of security groups to attach to any ENI\nthat is created and attached to the instance.", "items": { "type": "string" }, "type": "array" }, "vpc-id": { "description": "VPCID is the VPC ID to use when allocating ENIs.", "type": "string" }, "vswitch-tags": { "additionalProperties": { "type": "string" }, "description": "VSwitchTags is the list of tags to use when evaluating which\nvSwitch to use for the ENI.", "type": "object" }, "vswitches": { "description": "VSwitches is the ID of vSwitch available for ENI", "items": { "type": "string" }, "type": "array" } }, "type": "object", "additionalProperties": false }, "azure": { "description": "Azure is the Azure IPAM specific configuration.", "properties": { "interface-name": { "description": "InterfaceName is the name of the interface the cilium-operator\nwill use to allocate all the IPs on", "type": "string" } }, "type": "object", "additionalProperties": false }, "bootid": { "description": "BootID is a unique node identifier generated on boot", "type": "string" }, "encryption": { "description": "Encryption is the encryption configuration of the node.", "properties": { "key": { "description": "Key is the index to the key to use for encryption or 0 if encryption is\ndisabled.", "type": "integer" } }, "type": "object", "additionalProperties": false }, "eni": { "description": "ENI is the AWS ENI specific configuration.", "properties": { "availability-zone": { "description": "AvailabilityZone is the availability zone to use when allocating\nENIs.", "type": "string" }, "delete-on-termination": { "description": "DeleteOnTermination defines that the ENI should be deleted when the\nassociated instance is terminated. If the parameter is not set the\ndefault behavior is to delete the ENI on instance termination.", "type": "boolean" }, "disable-prefix-delegation": { "description": "DisablePrefixDelegation determines whether ENI prefix delegation should be\ndisabled on this node.", "type": "boolean" }, "exclude-interface-tags": { "additionalProperties": { "type": "string" }, "description": "ExcludeInterfaceTags is the list of tags to use when excluding ENIs for\nCilium IP allocation. Any interface matching this set of tags will not\nbe managed by Cilium.", "type": "object" }, "first-interface-index": { "description": "FirstInterfaceIndex is the index of the first ENI to use for IP\nallocation, e.g. if the node has eth0, eth1, eth2 and\nFirstInterfaceIndex is set to 1, then only eth1 and eth2 will be\nused for IP allocation, eth0 will be ignored for PodIP allocation.", "minimum": 0, "type": "integer" }, "instance-id": { "description": "InstanceID is the AWS InstanceId of the node. The InstanceID is used\nto retrieve AWS metadata for the node.\n\nOBSOLETE: This field is obsolete, please use Spec.InstanceID", "type": "string" }, "instance-type": { "description": "InstanceType is the AWS EC2 instance type, e.g. \"m5.large\"", "type": "string" }, "max-above-watermark": { "description": "MaxAboveWatermark is the maximum number of addresses to allocate\nbeyond the addresses needed to reach the PreAllocate watermark.\nGoing above the watermark can help reduce the number of API calls to\nallocate IPs, e.g. when a new ENI is allocated, as many secondary\nIPs as possible are allocated. Limiting the amount can help reduce\nwaste of IPs.\n\nOBSOLETE: This field is obsolete, please use Spec.IPAM.MaxAboveWatermark", "minimum": 0, "type": "integer" }, "min-allocate": { "description": "MinAllocate is the minimum number of IPs that must be allocated when\nthe node is first bootstrapped. It defines the minimum base socket\nof addresses that must be available. After reaching this watermark,\nthe PreAllocate and MaxAboveWatermark logic takes over to continue\nallocating IPs.\n\nOBSOLETE: This field is obsolete, please use Spec.IPAM.MinAllocate", "minimum": 0, "type": "integer" }, "node-subnet-id": { "description": "NodeSubnetID is the subnet of the primary ENI the instance was brought up\nwith. It is used as a sensible default subnet to create ENIs in.", "type": "string" }, "pre-allocate": { "description": "PreAllocate defines the number of IP addresses that must be\navailable for allocation in the IPAMspec. It defines the buffer of\naddresses available immediately without requiring cilium-operator to\nget involved.\n\nOBSOLETE: This field is obsolete, please use Spec.IPAM.PreAllocate", "minimum": 0, "type": "integer" }, "security-group-tags": { "additionalProperties": { "type": "string" }, "description": "SecurityGroupTags is the list of tags to use when evaliating what\nAWS security groups to use for the ENI.", "type": "object" }, "security-groups": { "description": "SecurityGroups is the list of security groups to attach to any ENI\nthat is created and attached to the instance.", "items": { "type": "string" }, "type": "array" }, "subnet-ids": { "description": "SubnetIDs is the list of subnet ids to use when evaluating what AWS\nsubnets to use for ENI and IP allocation.", "items": { "type": "string" }, "type": "array" }, "subnet-tags": { "additionalProperties": { "type": "string" }, "description": "SubnetTags is the list of tags to use when evaluating what AWS\nsubnets to use for ENI and IP allocation.", "type": "object" }, "use-primary-address": { "description": "UsePrimaryAddress determines whether an ENI's primary address\nshould be available for allocations on the node", "type": "boolean" }, "vpc-id": { "description": "VpcID is the VPC ID to use when allocating ENIs.", "type": "string" } }, "type": "object", "additionalProperties": false }, "health": { "description": "HealthAddressing is the addressing information for health connectivity\nchecking.", "properties": { "ipv4": { "description": "IPv4 is the IPv4 address of the IPv4 health endpoint.", "type": "string" }, "ipv6": { "description": "IPv6 is the IPv6 address of the IPv4 health endpoint.", "type": "string" } }, "type": "object", "additionalProperties": false }, "ingress": { "description": "IngressAddressing is the addressing information for Ingress listener.", "properties": { "ipv4": { "type": "string" }, "ipv6": { "type": "string" } }, "type": "object", "additionalProperties": false }, "instance-id": { "description": "InstanceID is the identifier of the node. This is different from the\nnode name which is typically the FQDN of the node. The InstanceID\ntypically refers to the identifier used by the cloud provider or\nsome other means of identification.", "type": "string" }, "ipam": { "description": "IPAM is the address management specification. This section can be\npopulated by a user or it can be automatically populated by an IPAM\noperator.", "properties": { "ipv6-pool": { "additionalProperties": { "description": "AllocationIP is an IP which is available for allocation, or already\nhas been allocated", "properties": { "owner": { "description": "Owner is the owner of the IP. This field is set if the IP has been\nallocated. It will be set to the pod name or another identifier\nrepresenting the usage of the IP\n\nThe owner field is left blank for an entry in Spec.IPAM.Pool and\nfilled out as the IP is used and also added to Status.IPAM.Used.", "type": "string" }, "resource": { "description": "Resource is set for both available and allocated IPs, it represents\nwhat resource the IP is associated with, e.g. in combination with\nAWS ENI, this will refer to the ID of the ENI", "type": "string" } }, "type": "object", "additionalProperties": false }, "description": "IPv6Pool is the list of IPv6 addresses available to the node for allocation.\nWhen an IPv6 address is used, it will remain on this list but will be added to\nStatus.IPAM.IPv6Used", "type": "object" }, "max-above-watermark": { "description": "MaxAboveWatermark is the maximum number of addresses to allocate\nbeyond the addresses needed to reach the PreAllocate watermark.\nGoing above the watermark can help reduce the number of API calls to\nallocate IPs, e.g. when a new ENI is allocated, as many secondary\nIPs as possible are allocated. Limiting the amount can help reduce\nwaste of IPs.", "minimum": 0, "type": "integer" }, "max-allocate": { "description": "MaxAllocate is the maximum number of IPs that can be allocated to the\nnode. When the current amount of allocated IPs will approach this value,\nthe considered value for PreAllocate will decrease down to 0 in order to\nnot attempt to allocate more addresses than defined.", "minimum": 0, "type": "integer" }, "min-allocate": { "description": "MinAllocate is the minimum number of IPs that must be allocated when\nthe node is first bootstrapped. It defines the minimum base socket\nof addresses that must be available. After reaching this watermark,\nthe PreAllocate and MaxAboveWatermark logic takes over to continue\nallocating IPs.", "minimum": 0, "type": "integer" }, "podCIDRs": { "description": "PodCIDRs is the list of CIDRs available to the node for allocation.\nWhen an IP is used, the IP will be added to Status.IPAM.Used", "items": { "type": "string" }, "type": "array" }, "pool": { "additionalProperties": { "description": "AllocationIP is an IP which is available for allocation, or already\nhas been allocated", "properties": { "owner": { "description": "Owner is the owner of the IP. This field is set if the IP has been\nallocated. It will be set to the pod name or another identifier\nrepresenting the usage of the IP\n\nThe owner field is left blank for an entry in Spec.IPAM.Pool and\nfilled out as the IP is used and also added to Status.IPAM.Used.", "type": "string" }, "resource": { "description": "Resource is set for both available and allocated IPs, it represents\nwhat resource the IP is associated with, e.g. in combination with\nAWS ENI, this will refer to the ID of the ENI", "type": "string" } }, "type": "object", "additionalProperties": false }, "description": "Pool is the list of IPv4 addresses available to the node for allocation.\nWhen an IPv4 address is used, it will remain on this list but will be added to\nStatus.IPAM.Used", "type": "object" }, "pools": { "description": "Pools contains the list of assigned IPAM pools for this node.", "properties": { "allocated": { "description": "Allocated contains the list of pooled CIDR assigned to this node. The\noperator will add new pod CIDRs to this field, whereas the agent will\nremove CIDRs it has released.", "items": { "description": "IPAMPoolAllocation describes an allocation of an IPAM pool from the operator to the\nnode. It contains the assigned PodCIDRs allocated from this pool", "properties": { "cidrs": { "description": "CIDRs contains a list of pod CIDRs currently allocated from this pool", "items": { "description": "IPAMPodCIDR is a pod CIDR", "format": "cidr", "type": "string" }, "type": "array" }, "pool": { "description": "Pool is the name of the IPAM pool backing this allocation", "minLength": 1, "type": "string" } }, "required": [ "pool" ], "type": "object", "additionalProperties": false }, "type": "array" }, "requested": { "description": "Requested contains a list of IPAM pool requests, i.e. indicates how many\naddresses this node requests out of each pool listed here. This field\nis owned and written to by cilium-agent and read by the operator.", "items": { "properties": { "needed": { "description": "Needed indicates how many IPs out of the above Pool this node requests\nfrom the operator. The operator runs a reconciliation loop to ensure each\nnode always has enough PodCIDRs allocated in each pool to fulfill the\nrequested number of IPs here.", "properties": { "ipv4-addrs": { "description": "IPv4Addrs contains the number of requested IPv4 addresses out of a given\npool", "type": "integer" }, "ipv6-addrs": { "description": "IPv6Addrs contains the number of requested IPv6 addresses out of a given\npool", "type": "integer" } }, "type": "object", "additionalProperties": false }, "pool": { "description": "Pool is the name of the IPAM pool backing this request", "minLength": 1, "type": "string" } }, "required": [ "pool" ], "type": "object", "additionalProperties": false }, "type": "array" } }, "type": "object", "additionalProperties": false }, "pre-allocate": { "description": "PreAllocate defines the number of IP addresses that must be\navailable for allocation in the IPAMspec. It defines the buffer of\naddresses available immediately without requiring cilium-operator to\nget involved.", "minimum": 0, "type": "integer" }, "static-ip-tags": { "additionalProperties": { "type": "string" }, "description": "StaticIPTags are used to determine the pool of IPs from which to\nattribute a static IP to the node. For example in AWS this is used to\nfilter Elastic IP Addresses.", "type": "object" } }, "type": "object", "additionalProperties": false }, "nodeidentity": { "description": "NodeIdentity is the Cilium numeric identity allocated for the node, if any.", "format": "int64", "type": "integer" } }, "type": "object", "additionalProperties": false }, "status": { "description": "Status defines the realized specification/configuration and status\nof the node.", "properties": { "alibaba-cloud": { "description": "AlibabaCloud is the AlibabaCloud specific status of the node.", "properties": { "enis": { "additionalProperties": { "description": "ENI represents an AlibabaCloud Elastic Network Interface", "properties": { "instance-id": { "description": "InstanceID is the InstanceID using this ENI", "type": "string" }, "mac-address": { "description": "MACAddress is the mac address of the ENI", "type": "string" }, "network-interface-id": { "description": "NetworkInterfaceID is the ENI id", "type": "string" }, "primary-ip-address": { "description": "PrimaryIPAddress is the primary IP on ENI", "type": "string" }, "private-ipsets": { "description": "PrivateIPSets is the list of all IPs on the ENI, including PrimaryIPAddress", "items": { "description": "PrivateIPSet is a nested struct in ecs response", "properties": { "primary": { "type": "boolean" }, "private-ip-address": { "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "security-groupids": { "description": "SecurityGroupIDs is the security group ids used by this ENI", "items": { "type": "string" }, "type": "array" }, "tags": { "additionalProperties": { "type": "string" }, "description": "Tags is the tags on this ENI", "type": "object" }, "type": { "description": "Type is the ENI type Primary or Secondary", "type": "string" }, "vpc": { "description": "VPC is the vpc to which the ENI belongs", "properties": { "cidr": { "description": "CIDRBlock is the VPC IPv4 CIDR", "type": "string" }, "ipv6-cidr": { "description": "IPv6CIDRBlock is the VPC IPv6 CIDR", "type": "string" }, "secondary-cidrs": { "description": "SecondaryCIDRs is the list of Secondary CIDRs associated with the VPC", "items": { "type": "string" }, "type": "array" }, "vpc-id": { "description": "VPCID is the vpc to which the ENI belongs", "type": "string" } }, "type": "object", "additionalProperties": false }, "vswitch": { "description": "VSwitch is the vSwitch the ENI is using", "properties": { "cidr": { "description": "CIDRBlock is the vSwitch IPv4 CIDR", "type": "string" }, "ipv6-cidr": { "description": "IPv6CIDRBlock is the vSwitch IPv6 CIDR", "type": "string" }, "vswitch-id": { "description": "VSwitchID is the vSwitch to which the ENI belongs", "type": "string" } }, "type": "object", "additionalProperties": false }, "zone-id": { "description": "ZoneID is the zone to which the ENI belongs", "type": "string" } }, "type": "object", "additionalProperties": false }, "description": "ENIs is the list of ENIs on the node", "type": "object" } }, "type": "object", "additionalProperties": false }, "azure": { "description": "Azure is the Azure specific status of the node.", "properties": { "interfaces": { "description": "Interfaces is the list of interfaces on the node", "items": { "description": "AzureInterface represents an Azure Interface", "properties": { "GatewayIP": { "description": "GatewayIP is the interface's subnet's default route\n\nOBSOLETE: This field is obsolete, please use Gateway field instead.", "type": "string" }, "addresses": { "description": "Addresses is the list of all IPs associated with the interface,\nincluding all secondary addresses", "items": { "description": "AzureAddress is an IP address assigned to an AzureInterface", "properties": { "ip": { "description": "IP is the ip address of the address", "type": "string" }, "state": { "description": "State is the provisioning state of the address", "type": "string" }, "subnet": { "description": "Subnet is the subnet the address belongs to", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "cidr": { "description": "CIDR is the range that the interface belongs to.", "type": "string" }, "gateway": { "description": "Gateway is the interface's subnet's default route", "type": "string" }, "id": { "description": "ID is the identifier", "type": "string" }, "mac": { "description": "MAC is the mac address", "type": "string" }, "name": { "description": "Name is the name of the interface", "type": "string" }, "security-group": { "description": "SecurityGroup is the security group associated with the interface", "type": "string" }, "state": { "description": "State is the provisioning state", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" } }, "type": "object", "additionalProperties": false }, "eni": { "description": "ENI is the AWS ENI specific status of the node.", "properties": { "enis": { "additionalProperties": { "description": "ENI represents an AWS Elastic Network Interface\n\nMore details:\nhttps://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html", "properties": { "addresses": { "description": "Addresses is the list of all secondary IPs associated with the ENI", "items": { "type": "string" }, "type": "array" }, "availability-zone": { "description": "AvailabilityZone is the availability zone of the ENI", "type": "string" }, "description": { "description": "Description is the description field of the ENI", "type": "string" }, "id": { "description": "ID is the ENI ID", "type": "string" }, "ip": { "description": "IP is the primary IP of the ENI", "type": "string" }, "mac": { "description": "MAC is the mac address of the ENI", "type": "string" }, "number": { "description": "Number is the interface index, it used in combination with\nFirstInterfaceIndex", "type": "integer" }, "prefixes": { "description": "Prefixes is the list of all /28 prefixes associated with the ENI", "items": { "type": "string" }, "type": "array" }, "public-ip": { "description": "PublicIP is the public IP associated with the ENI", "type": "string" }, "security-groups": { "description": "SecurityGroups are the security groups associated with the ENI", "items": { "type": "string" }, "type": "array" }, "subnet": { "description": "Subnet is the subnet the ENI is associated with", "properties": { "cidr": { "description": "CIDR is the CIDR range associated with the subnet", "type": "string" }, "id": { "description": "ID is the ID of the subnet", "type": "string" } }, "type": "object", "additionalProperties": false }, "tags": { "additionalProperties": { "type": "string" }, "description": "Tags is the set of tags of the ENI. Used to detect ENIs which should\nnot be managed by Cilium", "type": "object" }, "vpc": { "description": "VPC is the VPC information to which the ENI is attached to", "properties": { "cidrs": { "description": "CIDRs is the list of CIDR ranges associated with the VPC", "items": { "type": "string" }, "type": "array" }, "id": { "description": "/ ID is the ID of a VPC", "type": "string" }, "primary-cidr": { "description": "PrimaryCIDR is the primary CIDR of the VPC", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "description": "ENIs is the list of ENIs on the node", "type": "object" } }, "type": "object", "additionalProperties": false }, "ipam": { "description": "IPAM is the IPAM status of the node.", "properties": { "assigned-static-ip": { "description": "AssignedStaticIP is the static IP assigned to the node (ex: public Elastic IP address in AWS)", "type": "string" }, "ipv6-used": { "additionalProperties": { "description": "AllocationIP is an IP which is available for allocation, or already\nhas been allocated", "properties": { "owner": { "description": "Owner is the owner of the IP. This field is set if the IP has been\nallocated. It will be set to the pod name or another identifier\nrepresenting the usage of the IP\n\nThe owner field is left blank for an entry in Spec.IPAM.Pool and\nfilled out as the IP is used and also added to Status.IPAM.Used.", "type": "string" }, "resource": { "description": "Resource is set for both available and allocated IPs, it represents\nwhat resource the IP is associated with, e.g. in combination with\nAWS ENI, this will refer to the ID of the ENI", "type": "string" } }, "type": "object", "additionalProperties": false }, "description": "IPv6Used lists all IPv6 addresses out of Spec.IPAM.IPv6Pool which have been\nallocated and are in use.", "type": "object" }, "operator-status": { "description": "Operator is the Operator status of the node", "properties": { "error": { "description": "Error is the error message set by cilium-operator.", "type": "string" } }, "type": "object", "additionalProperties": false }, "pod-cidrs": { "additionalProperties": { "properties": { "status": { "description": "Status describes the status of a pod CIDR", "enum": [ "released", "depleted", "in-use" ], "type": "string" } }, "type": "object", "additionalProperties": false }, "description": "PodCIDRs lists the status of each pod CIDR allocated to this node.", "type": "object" }, "release-ips": { "additionalProperties": { "description": "IPReleaseStatus defines the valid states in IP release handshake", "enum": [ "marked-for-release", "ready-for-release", "do-not-release", "released" ], "type": "string" }, "description": "ReleaseIPs tracks the state for every IPv4 address considered for release.\nThe value can be one of the following strings:\n* marked-for-release : Set by operator as possible candidate for IP\n* ready-for-release : Acknowledged as safe to release by agent\n* do-not-release : IP already in use / not owned by the node. Set by agent\n* released : IP successfully released. Set by operator", "type": "object" }, "release-ipv6s": { "additionalProperties": { "description": "IPReleaseStatus defines the valid states in IP release handshake", "enum": [ "marked-for-release", "ready-for-release", "do-not-release", "released" ], "type": "string" }, "description": "ReleaseIPv6s tracks the state for every IPv6 address considered for release.\nThe value can be one of the following strings:\n* marked-for-release : Set by operator as possible candidate for IP\n* ready-for-release : Acknowledged as safe to release by agent\n* do-not-release : IP already in use / not owned by the node. Set by agent\n* released : IP successfully released. Set by operator", "type": "object" }, "used": { "additionalProperties": { "description": "AllocationIP is an IP which is available for allocation, or already\nhas been allocated", "properties": { "owner": { "description": "Owner is the owner of the IP. This field is set if the IP has been\nallocated. It will be set to the pod name or another identifier\nrepresenting the usage of the IP\n\nThe owner field is left blank for an entry in Spec.IPAM.Pool and\nfilled out as the IP is used and also added to Status.IPAM.Used.", "type": "string" }, "resource": { "description": "Resource is set for both available and allocated IPs, it represents\nwhat resource the IP is associated with, e.g. in combination with\nAWS ENI, this will refer to the ID of the ENI", "type": "string" } }, "type": "object", "additionalProperties": false }, "description": "Used lists all IPv4 addresses out of Spec.IPAM.Pool which have been allocated\nand are in use.", "type": "object" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false } }, "required": [ "metadata", "spec" ], "type": "object" }