yandex_kubernetes_node_group (DataSource)

Get information about a Yandex Kubernetes Node Group. For more information, see the official documentation.

Example usageExample usage

//
// Get information about existing Managed Kubernetes Node Group.
//
data "yandex_kubernetes_node_group" "my_node_group" {
  node_group_id = "some_k8s_node_group_id"
}

output "my_node_group.status" {
  value = data.yandex_kubernetes_node_group.my_node_group.status
}

Arguments & Attributes ReferenceArguments & Attributes Reference

• allocation_policy [Block]. This argument specify subnets (zones), that will be used by node group compute instances.
  • location [Block]. Repeated field, that specify subnets (zones), that will be used by node group compute instances. Subnet specified by subnet_id should be allocated in zone specified by 'zone' argument.
    • subnet_id (String). ID of the subnet, that will be used by one compute instance in node group.
    • zone (String). ID of the availability zone where for one compute instance in node group.
• allowed_unsafe_sysctls (List Of String). A list of allowed unsafe sysctl parameters for this node group. For more details see documentation.
• cluster_id (Required)(String). The ID of the Kubernetes cluster that this node group belongs to.
• created_at (Read-Only) (String). The creation timestamp of the resource.
• deploy_policy [Block]. Deploy policy of the node group.
  • max_expansion (Required)(Number). The maximum number of instances that can be temporarily allocated above the group's target size during the update.
  • max_unavailable (Required)(Number). The maximum number of running instances that can be taken offline during update.
• description (String). The resource description.
• folder_id (String). The folder identifier that resource belongs to. If it is not provided, the default provider folder-id is used.
• id (String).
• instance_group_id (Read-Only) (String). ID of instance group that is used to manage this Kubernetes node group.
• instance_template [Block]. Template used to create compute instances in this Kubernetes node group.
  • boot_disk [Block]. The specifications for boot disks that will be attached to the instance.
    • size (Number). The size of the disk in GB. Allowed minimal size: 64 GB.
    • type (String). The disk type.
  • container_network [Block]. Container network configuration.
    • pod_mtu (Number). MTU for pods.
  • container_runtime [Block]. Container runtime configuration.
    • type (Required)(String). Type of container runtime. Values: docker, containerd.
  • gpu_settings [Block]. GPU settings.
    • gpu_cluster_id (String). GPU cluster id.
    • gpu_environment (String). GPU environment. Values: runc, runc_drivers_cuda.
  • labels (Map Of String). Labels that will be assigned to compute nodes (instances), created by the Node Group.
  • metadata (Map Of String). The set of metadata key:value pairs assigned to this instance template. This includes custom metadata and predefined keys. Note: key user-data won't be provided into instances. It reserved for internal activity in kubernetes_node_group resource.
  • name (String). Name template of the instance. In order to be unique it must contain at least one of instance unique placeholders:

• `
• {instance.index}
• combination of {instance.zone_id} and {instance.index_in_zone}

Example: my-instance-{instance.index}.
If not set, default is used: {instance_group.id}-{instance.short_id}. It may also contain another placeholders, see Compute Instance group metadata doc for full list.

• nat (Bool). Enables NAT for node group compute instances.
• network_acceleration_type (String). Type of network acceleration. Values: standard, software_accelerated.
• network_interface [Block]. An array with the network interfaces that will be attached to the instance.
  • ipv4 (Bool). Allocate an IPv4 address for the interface. The default value is true.
  • ipv4_dns_records [Block]. List of configurations for creating ipv4 DNS records.
    • dns_zone_id (String). DNS zone ID (if not set, private zone is used).
    • fqdn (Required)(String). DNS record FQDN.
    • ptr (Bool). When set to true, also create a PTR DNS record.
    • ttl (Number). DNS record TTL (in seconds).
  • ipv6 (Bool). If true, allocate an IPv6 address for the interface. The address will be automatically assigned from the specified subnet.
  • ipv6_dns_records [Block]. List of configurations for creating ipv6 DNS records.
    • dns_zone_id (String). DNS zone ID (if not set, private zone is used).
    • fqdn (Required)(String). DNS record FQDN.
    • ptr (Bool). When set to true, also create a PTR DNS record.
    • ttl (Number). DNS record TTL (in seconds).
  • nat (Bool). A public address that can be used to access the internet over NAT.
  • security_group_ids (Set Of String). Security group IDs for network interface.
  • subnet_ids (Required)(Set Of String). The IDs of the subnets.
• placement_policy [Block]. The placement policy configuration.
  • placement_group_id (Required)(String). Specifies the id of the Placement Group to assign to the instances.
• platform_id (String). The ID of the hardware platform configuration for the node group compute instances.
• resources [Block].
  • core_fraction (Number). Baseline core performance as a percent.
  • cores (Number). Number of CPU cores allocated to the instance.
  • gpus (Number). Number of GPU cores allocated to the instance.
  • memory (Number). The memory size allocated to the instance.
• scheduling_policy [Block]. The scheduling policy for the instances in node group.
  • preemptible (Bool). Specifies if the instance is preemptible. Defaults to false.
• labels (Map Of String). A set of key/value label pairs which assigned to resource.
• maintenance_policy [Block]. Maintenance policy for this Kubernetes node group. If policy is omitted, automatic revision upgrades are enabled and could happen at any time. Revision upgrades are performed only within the same minor version, e.g. 1.29. Minor version upgrades (e.g. 1.29->1.30) should be performed manually.
  • auto_repair (Required)(Bool). Flag that specifies if node group can be repaired automatically. When omitted, default value is true.
  • auto_upgrade (Required)(Bool). Flag specifies if node group can be upgraded automatically. When omitted, default value is true.
  • maintenance_window [Block]. Set of day intervals, when maintenance is allowed for this node group. When omitted, it defaults to any time.

To specify time of day interval, for all days, one element should be provided, with two fields set, start_time and duration.

To allow maintenance only on specific days of week, please provide list of elements, with all fields set. Only one time interval is allowed for each day of week. Please see my_node_group config example.

- `day` (String). 
- `duration` (**Required**)(String). 
- `start_time` (**Required**)(String). 

• name (String). The resource name.
• node_group_id (String). ID of a specific Kubernetes node group.
• node_labels (Map Of String). A set of key/value label pairs, that are assigned to all the nodes of this Kubernetes node group.
• node_taints (List Of String). A list of Kubernetes taints, that are applied to all the nodes of this Kubernetes node group.
• scale_policy [Block]. Scale policy of the node group.
  • auto_scale [Block]. Scale policy for an autoscaled node group.
    • initial (Required)(Number). Initial number of instances in the node group.
    • max (Required)(Number). Maximum number of instances in the node group.
    • min (Required)(Number). Minimum number of instances in the node group.
  • fixed_scale [Block]. Scale policy for a fixed scale node group.
    • size (Number). The number of instances in the node group.
• status (Read-Only) (String). Status of the Kubernetes node group.
• version_info (Read-Only) (List Of Object). Information about Kubernetes node group version.
  • current_version .
  • new_revision_available .
  • new_revision_summary .
  • version_deprecated .