Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -275,6 +275,7 @@
"group": "Upgrade Guides",
"pages": [
"orka/orka-upgrades-and-release-notes/orka-upgrades",
"orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws",
"orka/orka-upgrades-and-release-notes/kubernetes-upgrade-guide"
]
},
Expand Down
87 changes: 87 additions & 0 deletions orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
---
title: "Upgrading Orka on AWS"

Check warning on line 2 in orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx#L2

Use 'orka' instead of 'Orka'.
description: "Upgrade your Orka cluster on AWS from 3.5 to 3.6. Covers ARM node tooling updates, SSH requirements, and what changes with the new Ansible-based upgrade path."

Check warning on line 3 in orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx#L3

Use 'orka' instead of 'Orka'.

Check warning on line 3 in orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx#L3

Use 'ssh' instead of 'SSH'.
---

Upgrading Orka on AWS follows the same general process as MSDC-hosted upgrades: submit a support ticket, schedule a maintenance window, and MacStadium handles the upgrade. However, AWS deployments have specific requirements and a different upgrade mechanism for ARM Mac nodes.

Check warning on line 6 in orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx#L6

Use 'orka' instead of 'Orka'.

Check warning on line 6 in orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx#L6

Use 'macstadium' instead of 'MacStadium'.

## Before you upgrade

### Check your ARM node SSH configuration

Check warning on line 10 in orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx#L10

Use 'ssh' instead of 'SSH'.

Starting with the 3.5 to 3.6 upgrade, MacStadium uses an Ansible-based process to update tooling on your ARM Mac nodes rather than replacing the AMI. This approach is significantly faster and preserves your node names, namespaces, and custom tags.

Check warning on line 12 in orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx#L12

Use 'macstadium' instead of 'MacStadium'.

For this to work, your ARM EC2 Mac instances must have SSH enabled and accessible using MacStadium's key. If your nodes are configured for SSM-only access, the upgrade will still work but will take significantly longer (up to several hours per node vs. approximately 2 minutes with SSH).

Check warning on line 14 in orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx#L14

Use 'ssh' instead of 'SSH'.

Check warning on line 14 in orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx#L14

Use 'macstadium' instead of 'MacStadium'.

Check warning on line 14 in orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx#L14

Use 'ssh' instead of 'SSH'.

If you're unsure how your nodes are configured, check with your AWS administrator before scheduling the upgrade.

### Verify your node tags

MacStadium uses a dynamic Ansible inventory to identify your ARM nodes during the upgrade. Your ARM EC2 Mac instances must be tagged so that the inventory can select the correct nodes. Contact MacStadium support to confirm your nodes are tagged correctly before scheduling.

Check warning on line 20 in orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx#L20

Use 'macstadium' instead of 'MacStadium'.

Check warning on line 20 in orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx#L20

Use 'macstadium' instead of 'MacStadium'.

## Requesting an upgrade

1. Review the [3.6 release notes](/orka/orka-upgrades-and-release-notes/orka-36-release-notes) and complete any preparation steps listed there.
2. Submit a ticket through the MacStadium portal.

Check warning on line 25 in orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx#L25

Use 'macstadium' instead of 'MacStadium'.
3. Schedule a maintenance window via the link in your ticket.

## What changes in 3.5 to 3.6

### ARM node tooling updates no longer require AMI replacement

Previously, updating tooling on ARM nodes required replacing the EC2 Mac AMI: the instance had to be deleted, a new one provisioned (a ~2 hour process), and the node's name, namespace, and custom tags had to be manually reapplied.

Starting with the 3.5 to 3.6 upgrade path, MacStadium updates ARM node tooling in place using Ansible over SSH. The upgrade takes approximately 2 minutes per node. Your node names, namespaces, and tags are preserved.

Check warning on line 34 in orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx#L34

Use 'macstadium' instead of 'MacStadium'.

Check warning on line 34 in orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx#L34

Use 'ssh' instead of 'SSH'.

### Upgrade Service is installed

As part of the 3.6 upgrade, the Orka Upgrade Service is deployed to your cluster. This enables smoother tooling updates in future Orka releases without requiring AMI replacement.

Check warning on line 38 in orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx#L38

Use 'orka' instead of 'Orka'.

Check warning on line 38 in orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx#L38

Use 'orka' instead of 'Orka'.

### AWS credentials no longer required for artifact distribution

Orka binaries and container images are now distributed publicly via CloudFront. You no longer need AWS credentials configured to pull Orka artifacts during upgrades or deployments.

Check warning on line 42 in orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx#L42

Use 'orka' instead of 'Orka'.

Check warning on line 42 in orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx#L42

Use 'orka' instead of 'Orka'.

### cert-manager behavior change

Orka no longer installs its own cert-manager if one is already present in the cluster. If your cluster runs its own cert-manager and you previously experienced version or configuration conflicts with Orka's bundled installation, those conflicts are resolved in 3.6.

Check warning on line 46 in orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx#L46

Use 'orka' instead of 'Orka'.

Check warning on line 46 in orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx#L46

Use 'orka' instead of 'Orka'.

If your automation or tooling depends on Orka's cert-manager specifically, verify your setup before upgrading.

Check warning on line 48 in orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx#L48

Use 'orka' instead of 'Orka'.

### Credential scoping: action required

The permissions required for Orka to run have been tightened to least-privilege. Separate, minimal credential sets are now defined for:

Check warning on line 52 in orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx#L52

Use 'orka' instead of 'Orka'.

* Orka configuration

Check warning on line 54 in orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx#L54

Use 'orka' instead of 'Orka'.
* Virtual Kubelet

Check warning on line 55 in orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx#L55

Did you really mean 'Kubelet'?
* ECR access
* Backup operations

If your deployment uses broad IAM credentials for Orka, you will need to update your IAM policies to align with the new scoped credential sets before or as part of the upgrade. MacStadium support will provide the updated permission requirements when scheduling your maintenance window.

Check warning on line 59 in orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx#L59

Use 'orka' instead of 'Orka'.

Check warning on line 59 in orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx#L59

Use 'macstadium' instead of 'MacStadium'.

## During the maintenance window

| Aspect | Notes |
|--------|-------|
| Maintenance window | Up to 3 hours. Must be scheduled with MacStadium support. |

Check warning on line 65 in orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx#L65

Use 'macstadium' instead of 'MacStadium'.
| Access to the environment | Unavailable during the window. Restored at the original endpoint after completion. |
| Orka users | Persist. |

Check warning on line 67 in orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx#L67

Use 'orka' instead of 'Orka'.
| Service Accounts | Persist. Tokens must be regenerated after the upgrade. |
| VMs and VM configs | VM configs persist. VMs may be deleted. Redeploy from VM configs after the upgrade. |

Check warning on line 69 in orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx#L69

Did you really mean 'configs'?

Check warning on line 69 in orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx#L69

Did you really mean 'configs'?

Check warning on line 69 in orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx#L69

Did you really mean 'configs'?
| Images | Persist. |
| Image cache | Cleared from each node. |
| Namespaces and RoleBindings | Persist. |

Check warning on line 72 in orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx#L72

Use 'namespaces' instead of 'Namespaces'.
| ARM node names and tags | Preserved with the Ansible-based upgrade path. |

<Warning>
Service Account tokens must be regenerated after this upgrade. Any automated workflows using service account tokens will fail until tokens are regenerated with `orka3 serviceaccount token <name>`.
</Warning>

## After the upgrade

Once the upgrade is complete:

1. [Download and install](/orka/orka-overview/tools-integrations) the Orka 3.6 CLI if you haven't already.

Check warning on line 83 in orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-upgrades-and-release-notes/upgrading-orka-on-aws.mdx#L83

Use 'orka' instead of 'Orka'.
2. Regenerate Service Account tokens for any automated workflows.
3. Repopulate the image cache on your ARM nodes if needed: `orka3 imagecache add <image> --all`

{/* TODO: Add hybrid deployment upgrade section once confirmed with engineering. DI-623 */}