Create Node Pool

Arbitrary, user-specified metadata. Keys and values must adhere to Kubernetes constraints: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#syntax-and-character-set Additionally, the "fireworks.ai/" prefix is reserved.

Human-readable display name of the node pool. e.g. "My Node Pool" Must be fewer than 64 characters long.

A fake node pool to be used with FakeCluster.

Maximum number of nodes in this node pool. Must be a positive integer greater than or equal to min_node_count. If not specified, the default is 1.

Minimum number of nodes in this node pool. Must be a non-negative integer less than or equal to max_node_count. If not specified, the default is 0.

Live statistics of the node pool.

The number of nodes to overprovision by the autoscaler. Must be a non-negative integer and less than or equal to min_node_count and max_node_count-min_node_count. If not specified, the default is 0.

The current state of the node pool.

Contains detailed message when the last node pool operation fails, e.g. when node pool is in FAILED state or when last node pool update fails.

The type of instance used in this node pool. See https://aws.amazon.com/ec2/instance-types/ for a list of valid instance types.

Launch template to create for this node group.

The name of the node group. If not specified, the default is the node pool ID.

If not specified, the parent cluster's system_node_group_role will be used.

Cluster placement group to colocate hosts in this pool.

A list of subnet IDs for nodes in this node pool. If not specified, the parent cluster's default subnet IDs that matches the zone will be used. Note that all the subnets will need to be in the same zone.

Zone for the node pool. If not specified, a random zone in the cluster's region will be selected.

The key is the string representation of BatchJob.State (e.g. "RUNNING"). The value is the number of batch jobs in that state allocated to this node pool.

The key is the string representation of BatchJob.State (e.g. "RUNNING"). The value is the number of ranks allocated to batch jobs in that state in this node pool.

The number of environments connected to this node pool.

The number of ranks in this node pool that are currently allocated to environment connections.

The number of nodes currently available in this pool.

The number of ranks available per node. This is determined by the machine type of the nodes in this node pool.

The status code.

A developer-facing error message in English.