Skip to content

Relationships

Schema relationships
graph LR
    KubernetesNodePools -->|"account"| Accounts
    KubernetesNodePools -->|"cluster"| KubernetesClusters
    KubernetesNodePools -->|"remote_access_source_rule_sets"| FirewallRuleSets
    KubernetesNodePools -->|"node_role"| WorkloadIdentities

Properties

idstring
required·

Truto's stable unified identifier for this object. Opaque; use provider_id to address the object in the provider's own console or API.

accountstring

The account, subscription or project this object belongs to.

References: Accounts → id
capacity_typestring

How the nodes are bought, normalised. spot: spare capacity the provider can take back at short notice (Azure Spot, GCP Spot VMs). reserved_capacity: capacity booked ahead for a fixed period (on AWS: EC2 Capacity Blocks, CAPACITY_BLOCK). provider_capacity_type has the value verbatim.

Possible values:
on_demandspotreserved_capacityunknown
clusterobject

The Kubernetes cluster the pool belongs to.

idstring

The target's id.

collected_atstring · date-time

When Truto actually read this object from the provider, in UTC ISO 8601 with the offset present — not the request time, and not a provider timestamp.

created_atstring · date-time

When the object was created at the provider, in UTC ISO 8601. Null when the provider does not record one - see unreadable_fields.

desired_sizeinteger

Desired node count.

disk_size_gbinteger

Root volume size in GiB. Null when a launch template sets the disk.

health_issue_codesstring[]

Codes of the provider's current health issues for the pool. Empty means healthy.

instance_typesstring[]

Instance types the pool launches.

kubernetes_versionstring

The Kubernetes version of the nodes, verbatim. It can lag the cluster's kubernetes_version after a control-plane upgrade.

launch_template_idstring

The launch template the pool uses, when one is set.

max_sizeinteger

Maximum node count.

min_sizeinteger

Minimum node count.

namestring

The node pool name, verbatim.

native_typestring

The provider's own type string, unmodified — for example 'AWS::S3::Bucket', 'aws_iam_role', 'Microsoft.Sql/servers'. Used for display and drill-down.

node_image_typestring

The node image family, verbatim (on AWS EKS: the AMI type, for example AL2023_x86_64_STANDARD, BOTTLEROCKET_ARM_64, CUSTOM).

node_image_versionstring

The node image release, verbatim (on AWS EKS: the AMI release version, for example 1.31.0-20241011).

node_roleobject

The role the nodes run as.

idstring

The target's id.

providerstring

Which cloud this object was read from.

Possible values:
awsazuregcp
provider_capacity_typestring

How the nodes are bought, verbatim (on AWS EKS: ON_DEMAND, SPOT or CAPACITY_BLOCK).

provider_idstring

The provider's own identifier, passed through verbatim — a full ARN, resource id, or self-link. Never truncated, prefixed, or normalized.

provider_statusstring

The provider's own state string, verbatim (on AWS EKS: CREATING, ACTIVE, UPDATING, DELETING, CREATE_FAILED, DELETE_FAILED, DEGRADED).

regionstring

Where the object is located. 'global' denotes genuinely global resources (e.g. IAM, GCP VPC networks) rather than a guessed region. A substituted region (when none is derivable) is flagged in unreadable_fields.

remote_access_enabledboolean

Whether SSH (RDP on Windows) access to the nodes is configured with a key.

remote_access_open_to_internetboolean

True when remote access is configured with a key but no source rule sets: the provider then opens the port to 0.0.0.0/0.

remote_access_source_rule_setsobject[]

The firewall rule sets (security groups) allowed to reach the nodes over SSH/RDP.

idstring

The target's id.

remote_dataRecord<string, any>

Raw data returned from the remote API call.

statusstring

State, normalised. failed: creating or deleting the pool failed (on AWS EKS: CREATE_FAILED, DELETE_FAILED). degraded: the pool runs but has a health issue - see health_issue_codes. provider_status has the provider's value verbatim.

Possible values:
creatingactiveupdatingdeletingfaileddegradedunknown
subnet_idsstring[]

Subnets the nodes are placed in.

tagsobject

Key-value pairs exactly as the customer set them: no case folding, key/value normalization, or merging of separate provider concepts. An empty object means no tags; tags that could not be read appear in unreadable_fields instead.

unreadable_fieldsobject[]

Fields on this object that could not be read, and why. An empty array means everything was read. Use this to tell a real value from a missing one.

detailstring

Explanation of the reason, where one adds anything.

fieldstring

The property on this resource that could not be read.

reasonstring

Why the field could not be read. available_on_get: Not read on list to keep the list fast; call GET for this resource's id to get it.

Possible values:
not_supported_by_providernot_configuredpermission_deniednot_collectedcollection_errorpartially_collectedavailable_on_get
updated_atstring · date-time

When the object was last modified at the provider, in UTC ISO 8601. Null when the provider does not record one - see unreadable_fields.