Create Node Pool

curl --request POST \
  --url https://api.fireworks.ai/v1/accounts/{account_id}/nodePools \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "nodePool": {
    "displayName": "<string>",
    "minNodeCount": 123,
    "maxNodeCount": 123,
    "overprovisionNodeCount": 123,
    "eksNodePool": {
      "instanceType": "<string>",
      "nodeRole": "<string>",
      "spot": true,
      "nodeGroupName": "<string>",
      "subnetIds": [
        "<string>"
      ],
      "zone": "<string>",
      "placementGroup": "<string>",
      "launchTemplate": "<string>"
    },
    "fakeNodePool": {
      "machineType": "<string>",
      "numNodes": 123,
      "serviceAccount": "<string>"
    },
    "annotations": {}
  },
  "nodePoolId": "<string>"
}
'

{
  "name": "<string>",
  "displayName": "<string>",
  "createTime": "2023-11-07T05:31:56Z",
  "minNodeCount": 123,
  "maxNodeCount": 123,
  "overprovisionNodeCount": 123,
  "eksNodePool": {
    "instanceType": "<string>",
    "nodeRole": "<string>",
    "spot": true,
    "nodeGroupName": "<string>",
    "subnetIds": [
      "<string>"
    ],
    "zone": "<string>",
    "placementGroup": "<string>",
    "launchTemplate": "<string>"
  },
  "fakeNodePool": {
    "machineType": "<string>",
    "numNodes": 123,
    "serviceAccount": "<string>"
  },
  "annotations": {},
  "state": "STATE_UNSPECIFIED",
  "status": {
    "code": "OK",
    "message": "<string>"
  },
  "nodePoolStats": {
    "nodeCount": 123,
    "ranksPerNode": 123,
    "environmentCount": 123,
    "environmentRanks": 123,
    "batchJobCount": {},
    "batchJobRanks": {}
  },
  "updateTime": "2023-11-07T05:31:56Z"
}

POST

accounts

{account_id}

nodePools

Create Node Pool

curl --request POST \
  --url https://api.fireworks.ai/v1/accounts/{account_id}/nodePools \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "nodePool": {
    "displayName": "<string>",
    "minNodeCount": 123,
    "maxNodeCount": 123,
    "overprovisionNodeCount": 123,
    "eksNodePool": {
      "instanceType": "<string>",
      "nodeRole": "<string>",
      "spot": true,
      "nodeGroupName": "<string>",
      "subnetIds": [
        "<string>"
      ],
      "zone": "<string>",
      "placementGroup": "<string>",
      "launchTemplate": "<string>"
    },
    "fakeNodePool": {
      "machineType": "<string>",
      "numNodes": 123,
      "serviceAccount": "<string>"
    },
    "annotations": {}
  },
  "nodePoolId": "<string>"
}
'

{
  "name": "<string>",
  "displayName": "<string>",
  "createTime": "2023-11-07T05:31:56Z",
  "minNodeCount": 123,
  "maxNodeCount": 123,
  "overprovisionNodeCount": 123,
  "eksNodePool": {
    "instanceType": "<string>",
    "nodeRole": "<string>",
    "spot": true,
    "nodeGroupName": "<string>",
    "subnetIds": [
      "<string>"
    ],
    "zone": "<string>",
    "placementGroup": "<string>",
    "launchTemplate": "<string>"
  },
  "fakeNodePool": {
    "machineType": "<string>",
    "numNodes": 123,
    "serviceAccount": "<string>"
  },
  "annotations": {},
  "state": "STATE_UNSPECIFIED",
  "status": {
    "code": "OK",
    "message": "<string>"
  },
  "nodePoolStats": {
    "nodeCount": 123,
    "ranksPerNode": 123,
    "environmentCount": 123,
    "environmentRanks": 123,
    "batchJobCount": {},
    "batchJobRanks": {}
  },
  "updateTime": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

Bearer authentication using your Fireworks API key. Format: Bearer <API_KEY>

Path Parameters

account_id

string

required

The Account Id

Body

application/json

nodePool

Next ID: 16 · object

required

The properties of the NodePool being created.

Show child attributes

nodePool.displayName

string

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

nodePool.minNodeCount

integer<int32>

https://cloud.google.com/kubernetes-engine/quotas 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.

nodePool.maxNodeCount

integer<int32>

https://cloud.google.com/kubernetes-engine/quotas 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.

nodePool.overprovisionNodeCount

integer<int32>

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.

nodePool.eksNodePool

An Amazon Elastic Kubernetes Service node pool. Next ID: 10 · object

Show child attributes

nodePool.eksNodePool.instanceType

string

required

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

nodePool.eksNodePool.nodeRole

string

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

nodePool.eksNodePool.spot

boolean

nodePool.eksNodePool.nodeGroupName

string

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

nodePool.eksNodePool.subnetIds

string[]

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.

nodePool.eksNodePool.zone

string

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

nodePool.eksNodePool.placementGroup

string

Cluster placement group to colocate hosts in this pool.

nodePool.eksNodePool.launchTemplate

string

Launch template to create for this node group.

nodePool.fakeNodePool

object

A fake node pool to be used with FakeCluster.

Show child attributes

nodePool.fakeNodePool.machineType

string

nodePool.fakeNodePool.numNodes

integer<int32>

nodePool.fakeNodePool.serviceAccount

string

nodePool.annotations

object

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.

Show child attributes

nodePool.annotations.{key}

string

nodePoolId

string

required

Response

200 - application/json

A successful response.

name

string

displayName

string

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

createTime

string<date-time>

The creation time of the node pool.

minNodeCount

integer<int32>

https://cloud.google.com/kubernetes-engine/quotas 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.

maxNodeCount

integer<int32>

https://cloud.google.com/kubernetes-engine/quotas 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.

overprovisionNodeCount

integer<int32>

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.

eksNodePool

An Amazon Elastic Kubernetes Service node pool. Next ID: 10 · object

Show child attributes

eksNodePool.instanceType

string

required

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

eksNodePool.nodeRole

string

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

eksNodePool.spot

boolean

eksNodePool.nodeGroupName

string

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

eksNodePool.subnetIds

string[]

eksNodePool.zone

string

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

eksNodePool.placementGroup

string

Cluster placement group to colocate hosts in this pool.

eksNodePool.launchTemplate

string

Launch template to create for this node group.

fakeNodePool

object

A fake node pool to be used with FakeCluster.

Show child attributes

fakeNodePool.machineType

string

fakeNodePool.numNodes

integer<int32>

fakeNodePool.serviceAccount

string

annotations

object

Show child attributes

annotations.{key}

string

state

enum<string>

default:STATE_UNSPECIFIED

The current state of the node pool.

Available options:

STATE_UNSPECIFIED,

CREATING,

READY,

DELETING,

FAILED

status

Mimics [https://github.com/googleapis/googleapis/blob/master/google/rpc/status.proto] · object

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.

Show child attributes

status.code

enum<string>

default:OK

The status code.

Available options:

OK,

CANCELLED,

UNKNOWN,

INVALID_ARGUMENT,

DEADLINE_EXCEEDED,

NOT_FOUND,

ALREADY_EXISTS,

PERMISSION_DENIED,

UNAUTHENTICATED,

RESOURCE_EXHAUSTED,

FAILED_PRECONDITION,

ABORTED,

OUT_OF_RANGE,

UNIMPLEMENTED,

INTERNAL,

UNAVAILABLE,

DATA_LOSS

status.message

string

A developer-facing error message in English.

nodePoolStats

Next ID: 7 · object

Live statistics of the node pool.

Show child attributes

nodePoolStats.nodeCount

integer<int32>

The number of nodes currently available in this pool.

nodePoolStats.ranksPerNode

integer<int32>

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

nodePoolStats.environmentCount

integer<int32>

The number of environments connected to this node pool.

nodePoolStats.environmentRanks

integer<int32>

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

nodePoolStats.batchJobCount

object

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.

Show child attributes

nodePoolStats.batchJobCount.{key}

integer<int32>

nodePoolStats.batchJobRanks

object

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.

Show child attributes

nodePoolStats.batchJobRanks.{key}

integer<int32>

updateTime

string<date-time>

The update time for the node pool.

Get Node Pool

Update Node Pool

⌘I

Batch jobs

Clusters

Environments

Node pools

Node pool bindings

Snapshots

AWS IAM role bindings

Create Node Pool

Authorizations

Path Parameters

Body

Response