cilium.v2.ciliumNode

"CiliumNode represents a node managed by Cilium. It contains a specification to control various node specific configuration aspects and a status section to represent the status of the node."

Index

fn new(name)
obj metadata
obj spec

Fields

fn new

new(name)

new returns an instance of CiliumNode

obj metadata

"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."

fn metadata.withAnnotations

withAnnotations(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

fn metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

Note: This function appends passed data to existing values

fn metadata.withClusterName

withClusterName(clusterName)

"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."

fn metadata.withCreationTimestamp

withCreationTimestamp(creationTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withDeletionGracePeriodSeconds

withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)

"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."

fn metadata.withDeletionTimestamp

withDeletionTimestamp(deletionTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withFinalizers

withFinalizers(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

fn metadata.withFinalizersMixin

withFinalizersMixin(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

Note: This function appends passed data to existing values

fn metadata.withGenerateName

withGenerateName(generateName)

"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"

fn metadata.withGeneration

withGeneration(generation)

"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."

fn metadata.withLabels

withLabels(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

fn metadata.withLabelsMixin

withLabelsMixin(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

Note: This function appends passed data to existing values

fn metadata.withName

withName(name)

"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"

fn metadata.withNamespace

withNamespace(namespace)

"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"

fn metadata.withOwnerReferences

withOwnerReferences(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

fn metadata.withOwnerReferencesMixin

withOwnerReferencesMixin(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

Note: This function appends passed data to existing values

fn metadata.withResourceVersion

withResourceVersion(resourceVersion)

"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

fn metadata.withSelfLink

withSelfLink(selfLink)

"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."

fn metadata.withUid

withUid(uid)

"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"

obj spec

"Spec defines the desired specification/configuration of the node."

fn spec.withAddresses

withAddresses(addresses)

"Addresses is the list of all node addresses."

fn spec.withAddressesMixin

withAddressesMixin(addresses)

"Addresses is the list of all node addresses."

Note: This function appends passed data to existing values

fn spec.withBootid

withBootid(bootid)

"BootID is a unique node identifier generated on boot"

fn spec.withInstance-Id

withInstance-Id(instance_id)

"InstanceID is the identifier of the node. This is different from the node name which is typically the FQDN of the node. The InstanceID typically refers to the identifier used by the cloud provider or some other means of identification."

fn spec.withNodeidentity

withNodeidentity(nodeidentity)

"NodeIdentity is the Cilium numeric identity allocated for the node, if any."

obj spec.addresses

"Addresses is the list of all node addresses."

fn spec.addresses.withIp

withIp(ip)

"IP is an IP of a node"

fn spec.addresses.withType

withType(type)

"Type is the type of the node address"

obj spec.alibaba-cloud

"AlibabaCloud is the AlibabaCloud IPAM specific configuration."

fn spec.alibaba-cloud.withAvailability-Zone

withAvailability-Zone(availability_zone)

"AvailabilityZone is the availability zone to use when allocating ENIs."

fn spec.alibaba-cloud.withCidr-Block

withCidr-Block(cidr_block)

"CIDRBlock is vpc ipv4 CIDR"

fn spec.alibaba-cloud.withInstance-Type

withInstance-Type(instance_type)

"InstanceType is the ECS instance type, e.g. \"ecs.g6.2xlarge\

fn spec.alibaba-cloud.withSecurity-Group-Tags

withSecurity-Group-Tags(security_group_tags)

"SecurityGroupTags is the list of tags to use when evaluating which security groups to use for the ENI."

fn spec.alibaba-cloud.withSecurity-Group-TagsMixin

withSecurity-Group-TagsMixin(security_group_tags)

"SecurityGroupTags is the list of tags to use when evaluating which security groups to use for the ENI."

Note: This function appends passed data to existing values

fn spec.alibaba-cloud.withSecurity-Groups

withSecurity-Groups(security_groups)

"SecurityGroups is the list of security groups to attach to any ENI that is created and attached to the instance."

fn spec.alibaba-cloud.withSecurity-GroupsMixin

withSecurity-GroupsMixin(security_groups)

"SecurityGroups is the list of security groups to attach to any ENI that is created and attached to the instance."

Note: This function appends passed data to existing values

fn spec.alibaba-cloud.withVpc-Id

withVpc-Id(vpc_id)

"VPCID is the VPC ID to use when allocating ENIs."

fn spec.alibaba-cloud.withVswitch-Tags

withVswitch-Tags(vswitch_tags)

"VSwitchTags is the list of tags to use when evaluating which vSwitch to use for the ENI."

fn spec.alibaba-cloud.withVswitch-TagsMixin

withVswitch-TagsMixin(vswitch_tags)

"VSwitchTags is the list of tags to use when evaluating which vSwitch to use for the ENI."

Note: This function appends passed data to existing values

fn spec.alibaba-cloud.withVswitches

withVswitches(vswitches)

"VSwitches is the ID of vSwitch available for ENI"

fn spec.alibaba-cloud.withVswitchesMixin

withVswitchesMixin(vswitches)

"VSwitches is the ID of vSwitch available for ENI"

Note: This function appends passed data to existing values

obj spec.azure

"Azure is the Azure IPAM specific configuration."

fn spec.azure.withInterface-Name

withInterface-Name(interface_name)

"InterfaceName is the name of the interface the cilium-operator will use to allocate all the IPs on"

obj spec.encryption

"Encryption is the encryption configuration of the node."

fn spec.encryption.withKey

withKey(key)

"Key is the index to the key to use for encryption or 0 if encryption is disabled."

obj spec.eni

"ENI is the AWS ENI specific configuration."

fn spec.eni.withAvailability-Zone

withAvailability-Zone(availability_zone)

"AvailabilityZone is the availability zone to use when allocating ENIs."

fn spec.eni.withDelete-On-Termination

withDelete-On-Termination(delete_on_termination)

"DeleteOnTermination defines that the ENI should be deleted when the associated instance is terminated. If the parameter is not set the default behavior is to delete the ENI on instance termination."

fn spec.eni.withDisable-Prefix-Delegation

withDisable-Prefix-Delegation(disable_prefix_delegation)

"DisablePrefixDelegation determines whether ENI prefix delegation should be disabled on this node."

fn spec.eni.withExclude-Interface-Tags

withExclude-Interface-Tags(exclude_interface_tags)

"ExcludeInterfaceTags is the list of tags to use when excluding ENIs for Cilium IP allocation. Any interface matching this set of tags will not be managed by Cilium."

fn spec.eni.withExclude-Interface-TagsMixin

withExclude-Interface-TagsMixin(exclude_interface_tags)

"ExcludeInterfaceTags is the list of tags to use when excluding ENIs for Cilium IP allocation. Any interface matching this set of tags will not be managed by Cilium."

Note: This function appends passed data to existing values

fn spec.eni.withFirst-Interface-Index

withFirst-Interface-Index(first_interface_index)

"FirstInterfaceIndex is the index of the first ENI to use for IP allocation, e.g. if the node has eth0, eth1, eth2 and FirstInterfaceIndex is set to 1, then only eth1 and eth2 will be used for IP allocation, eth0 will be ignored for PodIP allocation."

fn spec.eni.withInstance-Id

withInstance-Id(instance_id)

"InstanceID is the AWS InstanceId of the node. The InstanceID is used to retrieve AWS metadata for the node. \n OBSOLETE: This field is obsolete, please use Spec.InstanceID"

fn spec.eni.withInstance-Type

withInstance-Type(instance_type)

"InstanceType is the AWS EC2 instance type, e.g. \"m5.large\

fn spec.eni.withMax-Above-Watermark

withMax-Above-Watermark(max_above_watermark)

"MaxAboveWatermark is the maximum number of addresses to allocate beyond the addresses needed to reach the PreAllocate watermark. Going above the watermark can help reduce the number of API calls to allocate IPs, e.g. when a new ENI is allocated, as many secondary IPs as possible are allocated. Limiting the amount can help reduce waste of IPs. \n OBSOLETE: This field is obsolete, please use Spec.IPAM.MaxAboveWatermark"

fn spec.eni.withMin-Allocate

withMin-Allocate(min_allocate)

"MinAllocate is the minimum number of IPs that must be allocated when the node is first bootstrapped. It defines the minimum base socket of addresses that must be available. After reaching this watermark, the PreAllocate and MaxAboveWatermark logic takes over to continue allocating IPs. \n OBSOLETE: This field is obsolete, please use Spec.IPAM.MinAllocate"

fn spec.eni.withNode-Subnet-Id

withNode-Subnet-Id(node_subnet_id)

"NodeSubnetID is the subnet of the primary ENI the instance was brought up with. It is used as a sensible default subnet to create ENIs in."

fn spec.eni.withPre-Allocate

withPre-Allocate(pre_allocate)

"PreAllocate defines the number of IP addresses that must be available for allocation in the IPAMspec. It defines the buffer of addresses available immediately without requiring cilium-operator to get involved. \n OBSOLETE: This field is obsolete, please use Spec.IPAM.PreAllocate"

fn spec.eni.withSecurity-Group-Tags

withSecurity-Group-Tags(security_group_tags)

"SecurityGroupTags is the list of tags to use when evaliating what AWS security groups to use for the ENI."

fn spec.eni.withSecurity-Group-TagsMixin

withSecurity-Group-TagsMixin(security_group_tags)

"SecurityGroupTags is the list of tags to use when evaliating what AWS security groups to use for the ENI."

Note: This function appends passed data to existing values

fn spec.eni.withSecurity-Groups

withSecurity-Groups(security_groups)

"SecurityGroups is the list of security groups to attach to any ENI that is created and attached to the instance."

fn spec.eni.withSecurity-GroupsMixin

withSecurity-GroupsMixin(security_groups)

"SecurityGroups is the list of security groups to attach to any ENI that is created and attached to the instance."

Note: This function appends passed data to existing values

fn spec.eni.withSubnet-Ids

withSubnet-Ids(subnet_ids)

"SubnetIDs is the list of subnet ids to use when evaluating what AWS subnets to use for ENI and IP allocation."

fn spec.eni.withSubnet-IdsMixin

withSubnet-IdsMixin(subnet_ids)

"SubnetIDs is the list of subnet ids to use when evaluating what AWS subnets to use for ENI and IP allocation."

Note: This function appends passed data to existing values

fn spec.eni.withSubnet-Tags

withSubnet-Tags(subnet_tags)

"SubnetTags is the list of tags to use when evaluating what AWS subnets to use for ENI and IP allocation."

fn spec.eni.withSubnet-TagsMixin

withSubnet-TagsMixin(subnet_tags)

"SubnetTags is the list of tags to use when evaluating what AWS subnets to use for ENI and IP allocation."

Note: This function appends passed data to existing values

fn spec.eni.withUse-Primary-Address

withUse-Primary-Address(use_primary_address)

"UsePrimaryAddress determines whether an ENI's primary address should be available for allocations on the node"

fn spec.eni.withVpc-Id

withVpc-Id(vpc_id)

"VpcID is the VPC ID to use when allocating ENIs."

obj spec.health

"HealthAddressing is the addressing information for health connectivity checking."

fn spec.health.withIpv4

withIpv4(ipv4)

"IPv4 is the IPv4 address of the IPv4 health endpoint."

fn spec.health.withIpv6

withIpv6(ipv6)

"IPv6 is the IPv6 address of the IPv4 health endpoint."

obj spec.ingress

"IngressAddressing is the addressing information for Ingress listener."

fn spec.ingress.withIpv4

withIpv4(ipv4)

fn spec.ingress.withIpv6

withIpv6(ipv6)

obj spec.ipam

"IPAM is the address management specification. This section can be populated by a user or it can be automatically populated by an IPAM operator."

fn spec.ipam.withIpv6-Pool

withIpv6-Pool(ipv6_pool)

"IPv6Pool is the list of IPv6 addresses available to the node for allocation. When an IPv6 address is used, it will remain on this list but will be added to Status.IPAM.IPv6Used"

fn spec.ipam.withIpv6-PoolMixin

withIpv6-PoolMixin(ipv6_pool)

"IPv6Pool is the list of IPv6 addresses available to the node for allocation. When an IPv6 address is used, it will remain on this list but will be added to Status.IPAM.IPv6Used"

Note: This function appends passed data to existing values

fn spec.ipam.withMax-Above-Watermark

withMax-Above-Watermark(max_above_watermark)

"MaxAboveWatermark is the maximum number of addresses to allocate beyond the addresses needed to reach the PreAllocate watermark. Going above the watermark can help reduce the number of API calls to allocate IPs, e.g. when a new ENI is allocated, as many secondary IPs as possible are allocated. Limiting the amount can help reduce waste of IPs."

fn spec.ipam.withMax-Allocate

withMax-Allocate(max_allocate)

"MaxAllocate is the maximum number of IPs that can be allocated to the node. When the current amount of allocated IPs will approach this value, the considered value for PreAllocate will decrease down to 0 in order to not attempt to allocate more addresses than defined."

fn spec.ipam.withMin-Allocate

withMin-Allocate(min_allocate)

"MinAllocate is the minimum number of IPs that must be allocated when the node is first bootstrapped. It defines the minimum base socket of addresses that must be available. After reaching this watermark, the PreAllocate and MaxAboveWatermark logic takes over to continue allocating IPs."

fn spec.ipam.withPodCIDRs

withPodCIDRs(podCIDRs)

"PodCIDRs is the list of CIDRs available to the node for allocation. When an IP is used, the IP will be added to Status.IPAM.Used"

fn spec.ipam.withPodCIDRsMixin

withPodCIDRsMixin(podCIDRs)

"PodCIDRs is the list of CIDRs available to the node for allocation. When an IP is used, the IP will be added to Status.IPAM.Used"

Note: This function appends passed data to existing values

fn spec.ipam.withPool

withPool(pool)

"Pool is the list of IPv4 addresses available to the node for allocation. When an IPv4 address is used, it will remain on this list but will be added to Status.IPAM.Used"

fn spec.ipam.withPoolMixin

withPoolMixin(pool)

"Pool is the list of IPv4 addresses available to the node for allocation. When an IPv4 address is used, it will remain on this list but will be added to Status.IPAM.Used"

Note: This function appends passed data to existing values

fn spec.ipam.withPre-Allocate

withPre-Allocate(pre_allocate)

"PreAllocate defines the number of IP addresses that must be available for allocation in the IPAMspec. It defines the buffer of addresses available immediately without requiring cilium-operator to get involved."

obj spec.ipam.pools

"Pools contains the list of assigned IPAM pools for this node."

fn spec.ipam.pools.withAllocated

withAllocated(allocated)

"Allocated contains the list of pooled CIDR assigned to this node. The operator will add new pod CIDRs to this field, whereas the agent will remove CIDRs it has released."

fn spec.ipam.pools.withAllocatedMixin

withAllocatedMixin(allocated)

"Allocated contains the list of pooled CIDR assigned to this node. The operator will add new pod CIDRs to this field, whereas the agent will remove CIDRs it has released."

Note: This function appends passed data to existing values

fn spec.ipam.pools.withRequested

withRequested(requested)

"Requested contains a list of IPAM pool requests, i.e. indicates how many addresses this node requests out of each pool listed here. This field is owned and written to by cilium-agent and read by the operator."

fn spec.ipam.pools.withRequestedMixin

withRequestedMixin(requested)

"Requested contains a list of IPAM pool requests, i.e. indicates how many addresses this node requests out of each pool listed here. This field is owned and written to by cilium-agent and read by the operator."

Note: This function appends passed data to existing values

obj spec.ipam.pools.allocated

"Allocated contains the list of pooled CIDR assigned to this node. The operator will add new pod CIDRs to this field, whereas the agent will remove CIDRs it has released."

fn spec.ipam.pools.allocated.withCidrs

withCidrs(cidrs)

"CIDRs contains a list of pod CIDRs currently allocated from this pool"

fn spec.ipam.pools.allocated.withCidrsMixin

withCidrsMixin(cidrs)

"CIDRs contains a list of pod CIDRs currently allocated from this pool"

Note: This function appends passed data to existing values

fn spec.ipam.pools.allocated.withPool

withPool(pool)

"Pool is the name of the IPAM pool backing this allocation"

obj spec.ipam.pools.requested

"Requested contains a list of IPAM pool requests, i.e. indicates how many addresses this node requests out of each pool listed here. This field is owned and written to by cilium-agent and read by the operator."

fn spec.ipam.pools.requested.withPool

withPool(pool)

"Pool is the name of the IPAM pool backing this request"

obj spec.ipam.pools.requested.needed

"Needed indicates how many IPs out of the above Pool this node requests from the operator. The operator runs a reconciliation loop to ensure each node always has enough PodCIDRs allocated in each pool to fulfill the requested number of IPs here."

fn spec.ipam.pools.requested.needed.withIpv4-Addrs

withIpv4-Addrs(ipv4_addrs)

"IPv4Addrs contains the number of requested IPv4 addresses out of a given pool"

fn spec.ipam.pools.requested.needed.withIpv6-Addrs

withIpv6-Addrs(ipv6_addrs)

"IPv6Addrs contains the number of requested IPv6 addresses out of a given pool"