GuidesAPI ReferenceDiscussions
GuidesAPI ReferenceJoin the Mailing List

Orka Upgrades

All Orka upgrades require a scheduled maintenance window. Some Orka upgrades might require additional preparation on your side.

Requesting an upgrade

  1. Check the release notes for the version that you want to upgrade to. Complete the suggested preparation, if any.
  2. Submit a ticket through the MacStadium portal.
  3. Schedule a time for the maintenance window that works for you through the link provided in the ticket.
    The suggested time(s) must be Monday through Thursday, 6am or 10pm PST (9am or 1pm EST), depending on availability in the MacStadium Global Operations calendar.
  4. After the upgrade is complete, you might need to download and install a new Orka CLI version and/or restore any missing resources (based on the type of upgrade).

Types of upgrades

New Orka releases

This is the most common type of Orka upgrade. Orka releases bring new CLI and API versions with new features, improved functionality, and critical bug fixes.

πŸ“˜

Preparing for the upgrade

  • Make sure that during the maintenance window there are no running workflows (for example, deploying a VM and running a build.)
  • As part of this upgrade, you might need to download and install a new Orka CLI version.
AspectNotes
Maintenance windowUp to 3 hours.

Must be scheduled with the MacStadium support team.
Access to the environmentDuring the maintenance window, the environment is inaccessible.

After the maintenance window, the access to the environment is restored. You can reach your environment at the original IP, Orka domain, or external custom domain.
Orka usersOrka users persist.
Service AccountsYour custom service accounts persist.
VMs and VM configsVMs and VM configs persist.
Images and ISOsImages and ISOs persist.
Image cache (Apple silicon nodes)The image cache is removed from each node.
NamespacesYour custom namespaces persist.
RoleBindingsYour custom permissions persist.
Kubernetes Pods and servicesYour custom Pods and services persist.

Virtualization and orchestration layer upgrades (Kubernetes, Docker, or Linux)

Occasionally, the Orka team upgrades the components of the virtualization and orchestration layer to a newer version. The version in Orka might run a few versions behind the latest and greatest release to ensure that the virtualization layer and orchestration layer is stable and bug-free.

πŸ“˜

Preparing for the upgrade

  • Make sure that during the maintenance window there are no running workflows (for example, deploying a VM and running a build.)
  • If this is a Kubernetes upgrade and you are working with the Kubernetes layer directly, make sure to address any deprecated APIs.
AspectNotes
Maintenance windowUp to 3 hours

Must be scheduled with the MacStadium support team.
Access to the environmentDuring the maintenance window, the environment is inaccessible.

After the maintenance window, the access to the environment is restored. You can reach your environment at the original IP, Orka domain, or external custom domain.
Orka usersOrka users persist.
Service AccountsYour custom service accounts persist.
VMs and VM configsVM configs persist.

VMs are deleted. After the upgrade completes, you can redeploy them from the respective VM configs.
Images & ISOsImages and ISOs persist.
Image cache (Apple silicon nodes)The image cache is removed from each node.
NamespacesYour custom namespaces persist.
RoleBindingsYour custom permissions persist.
Kubernetes Pods and servicesYour custom Pods and services are lost.

You need to recreate them.

Β© 2019-2023 Copyright MacStadium, Inc. – Documentation built with readme.com. Orka is a registered trademark of MacStadium, Inc.