Skip to main content
Starting with Orka 4.0, the CLI command is orka. On Orka 3.6, it’s orka3: replace orka with orka3 in the examples on this page.

​
Understanding cluster upgrades

The orka upgrade commands drive Orka Upgrade Service. An upgrade is a run that moves Upgrade Service and its agents, then Mac node components, then the control plane and remaining Orka services to a target release, in that order. Only one run is active at a time. Upgrade Service keeps the 10 most recent completed runs, including failed ones, and you retry a failed upgrade by starting a new run. For when to use Upgrade Service, how to install it on your deployment, and how to troubleshoot a run, see Orka Upgrade Service.

​
Starting an upgrade

​
orka upgrade run

Start an upgrade by creating a run for the target release. Run names are timestamped, so a retry never collides with an earlier run. Admin only: Starting an upgrade requires administrative privileges.
Upgrade Service doesn’t perform the upgrade from Orka 3.6 to 4.0. To upgrade to 4.0, contact MacStadium support to schedule it.
Syntax:
Options:
Examples:
latest resolves to the highest release marked available in the MacStadium release index, which can be a newer release line than your cluster’s. To stay on a specific release, pass its exact version.

​
Checking upgrades

​
orka upgrade versions

Show the cluster’s current Orka release and any active upgrade run. Until a cluster completes its first successful run, the current version shows as unknown. Syntax:
Options:
Examples:

​
orka upgrade status

Show the step list and per-node counts of the latest upgrade run, or of the run you name. Syntax:
Options:
Examples:

​
orka upgrade history

List retained upgrade runs, newest first, with each run’s target, source version, phase, duration, and age. Upgrade Service keeps the 10 most recent completed runs, so export any older ones you need for your records. Syntax:
Options:
Examples:

​
Inspecting Upgrade Service

The orka upgrade service commands always default to the orka-default namespace. They ignore the ORKA_DEFAULT_NAMESPACE environment variable and the kubeconfig context. See Namespace management.

​
orka upgrade service status

Show Upgrade Service’s operator version and status. Syntax:
Options:
Examples:

​
orka upgrade service agents

List the per-node upgrade agents with each agent’s installed version, status, and lease age. Unhealthy agents (MISSING or STALE) are listed first. Syntax:
Options:
Examples: