Patch nodepool fields

PATCH

http://localhost:8080/api/v1/node-pools/:nodepoolId

PATCH

/api/v1/node-pools/:nodepoolId

curl -X PATCH http://localhost:8080/api/v1/node-pools/17 \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "name": "v100",
  "labelKey": "node-type",
  "labelValue": "type-x",
  "clusterId": "d73a738f-fab3-430a-8fa3-5241493d7128",
  "id": "5",
  "tenantId": 1,
  "clusterName": "prod-cluster",
  "createdBy": "user@lab.com",
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedBy": "user@lab.com",
  "updatedAt": "2024-01-15T09:30:00Z",
  "isDefault": false,
  "gpuNetworkAccelerationLabelKey": "string",
  "gpuNetworkAccelerationDetection": "Auto",
  "networkTopologyName": "default-topology",
  "networkTopologyId": "123e4567-e89b-12d3-a456-426614174000",
  "schedulingConfiguration": {
    "gpuPodsPlacementStrategy": {
      "node": "spread",
      "device": "spread"
    },
    "cpuPodsPlacementStrategy": {
      "node": "spread"
    },
    "minGuaranteedRuntime": "5d8h40m",
    "timeBasedFairShare": {
      "enabled": true,
      "historicalUsageWeight": 1.5,
      "decayHalfLife": "24h",
      "windowType": "tumbling",
      "windowDuration": "2d",
      "tumblingWindowStartTime": "2025-01-06T08:00:00Z"
    },
    "numaAwareScheduling": true,
    "placementStrategy": {
      "cpu": "spread",
      "gpu": "spread"
    }
  },
  "phase": "Creating",
  "phaseMessage": "all nodes are down",
  "status": {
    "labelKey": "node-type",
    "labelValue": "type-x",
    "gpuNetworkAccelerationLabelKey": "string",
    "gpuNetworkAccelerationDetection": "Auto",
    "gpuResourceOptimization": {
      "swapEnabled": true,
      "cpuSwapMemorySize": "10000M",
      "reservedGpuMemoryForSwapOperations": "10G",
      "nodeLevelSchedulerEnabled": true
    },
    "schedulingConfiguration": {
      "gpuPodsPlacementStrategy": {
        "node": "spread",
        "device": "spread"
      },
      "cpuPodsPlacementStrategy": {
        "node": "spread"
      },
      "minGuaranteedRuntime": "5d8h40m",
      "timeBasedFairShare": {
        "enabled": true,
        "historicalUsageWeight": 1.5,
        "decayHalfLife": "24h",
        "windowType": "tumbling",
        "windowDuration": "2d",
        "tumblingWindowStartTime": "2025-01-06T08:00:00Z"
      },
      "numaAwareScheduling": true,
      "placementStrategy": {
        "cpu": "spread",
        "gpu": "spread"
      }
    },
    "conditions": [
      {
        "type": "string",
        "reason": "TopologyMismatch",
        "message": "Network Topology labels mismatch",
        "status": "True",
        "nodes": [
          "node1",
          "node2"
        ]
      }
    ],
    "gpuNetworkAccelerationDetected": true,
    "nodes": [
      "node1"
    ],
    "placementStrategy": {
      "cpu": "spread",
      "gpu": "spread"
    },
    "overProvisioningRatio": 1
  },
  "deletedBy": "user@lab.com",
  "deletedAt": "2024-01-15T09:30:00Z"
}

Update only specific fields of a nodepool

Authentication

AuthorizationBearer

Bearer authentication

Path parameters

nodepoolIdstringRequired

The unique id identifying the Node Pool.

Request

Fields to update.

labelKeystring or nullOptional1-253 characters

Label key for associated nodes to the Node Pool (with value as in labelValue)

labelValuestring or nullOptionalformat: "^(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$"1-63 characters

Label value for associated nodes to the Node Pool (with key as in labelKey)

gpuNetworkAccelerationLabelKeystring or nullOptional

Label key by which to determine GPUNetworkAccelerationDetection nodes

gpuNetworkAccelerationDetectionenumOptionalDefaults to Auto

GPUNetworkAccelerationDetection is a strategy to use for GPU Network Acceleration detection

Allowed values:

schedulingConfigurationobjectOptional

networkTopologyIdstringOptionalformat: "uuid"

The unique identifier for the network topology

Response

Updated

namestring>=1 character

labelKeystring>=1 character

Label key for associated nodes to the Node Pool (with value as in labelValue)

labelValuestring>=1 character

Label value for associated nodes to the Node Pool (with key as in labelKey)

clusterIdstringformat: "uuid"

idstringRead-only

The NodePool id

tenantIdinteger

The id of the tenant.

clusterNamestring

createdBystring

createdAtdatetime

updatedBystring

updatedAtdatetime

isDefaultboolean

Is the Node Pool is the cluster default

gpuNetworkAccelerationLabelKeystringOptional

Label key by which to determine GPUNetworkAccelerationDetection nodes

gpuNetworkAccelerationDetectionenumOptionalDefaults to Auto

GPUNetworkAccelerationDetection is a strategy to use for GPU Network Acceleration detection

Allowed values:

networkTopologyNamestringOptionalformat: "^[a-z]([a-z0-9-]*[a-z0-9])?$"1-63 characters

Name of the network topology

networkTopologyIdstringOptionalformat: "uuid"

The unique identifier for the network topology

schedulingConfigurationobjectOptional

phaseenumOptional

Phase of Node Pool

phaseMessagestringOptional

Message for status of Node Pool

statusobjectOptional

deletedBystringOptional

deletedAtdatetime or nullOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

503

Service Unavailable Error