Check Kubernetes upgrade readiness (browser session)

Runs the read-only upgrade preflight for a hop to target_version: the hop plan per node, running operations and the operations block, PodDisruptionBudgets that would park a drain, CloudNativePG stopDelay and single-instance clusters, control-plane memory headroom from the cluster’s metrics source, restore points, control-plane SSH reachability and, on k3s, the address pin. Nothing is changed. The Kubernetes version upgrade runs the same preflight first and refuses on a block. Browser session authentication; RBAC permission clusters.read. PAT mutations support wait=false where implemented; browser mutations require CSRF. Answers 404 while the organisation’s aws_provider feature flag is off.

GET /org/clusters/aws/{cluster_id}/upgrade-preflight

Check Kubernetes upgrade readiness (browser session)

Python

import requests

url = "https://api.platform.ankra.app/org/clusters/aws/{cluster_id}/upgrade-preflight"

headers = {"cookie": "ankra_session="}

response = requests.get(url, headers=headers)

print(response.text)

200

{
  "blocks": 123,
  "checked_at": "2023-11-07T05:31:56Z",
  "checks": [
    {
      "check": "<string>",
      "evidence": {},
      "message": "<string>",
      "overridable_with_force": true,
      "status": "pass"
    }
  ],
  "cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "distribution": "<string>",
  "requested_target_version": "<string>",
  "target_version": "<string>",
  "verdict": "ready",
  "warnings": 123
}

Authorizations

ankra_session · string · cookie · required

Browser session. Mutations also require X-Ankra-CSRF.

Path Parameters

cluster_id · string<uuid> · required

Query Parameters

target_version · string · required

The Kubernetes version to check a hop to, e.g. v1.31.4 or v1.31.4+k3s1.

Response

200

application/json

The preflight report

The read-only Kubernetes upgrade preflight of a cluster for one target version. verdict is blocked when any check blocks, otherwise ready; a warning or a skipped check whose evidence could not be read was not checked, not passed.

blocks · integer · required

checked_at · string<date-time> · required

checks · UpgradePreflightFinding · object[] · required

Show child attributes

cluster_id · string<uuid> · required

distribution · string · required

requested_target_version · string · required

target_version · string · required

The catalogue build the hop would install.

verdict · enum<string> · required

Available options: ready, blocked

warnings · integer · required