Skip to content

Port Orka 3.x docs changes (Sept-Oct 2026) - #20

Draft
celanthe wants to merge 1 commit into
update/fold-in-orka-agent-skillsfrom
update/port-3x-docs-oct
Draft

celanthe wants to merge 1 commit into
update/fold-in-orka-agent-skillsfrom
update/port-3x-docs-oct

Conversation

@celanthe

Copy link
Copy Markdown
Collaborator

What changed

Ports the remaining Orka 3.x documentation changes from docs.macstadium.com into the skill. Commands stay orka3 (3.x content). Version tables, compatibility data, and known-issue lists are summarized with a link to the docs page instead of copied in full.

  • Component versions (upgrade-workflows.md, config-commands.md, SKILL.md): how to read orka3 version and orka3 node list -o wide, orka3 version --client, patch releases only bump changed components (3.6.4 runs API server and Engine at 3.6.3), link to the matrix, on-prem orka-ansible-onprem:3.6.4 installer re-pull note
  • macOS guest compatibility (image-workflows.md, SKILL.md): macOS 27 Golden Gate needs Orka 3.6+, a 26.6.2+ host, and more than 2 GB of RAM; macOS 27 isn't signed off as a host OS; latest on MacStadium images means latest published
  • In-place upgrade known issue (image-issues.md): 15.x and 26.x failures, the sysctl check, and the installer workaround with commands copied from the docs
  • Hosted-cluster admin limits (admin-commands.md, auth-issues.md): customer admins can't edit orka-admin RoleBinding on hosted clusters; managed orka-admin service account via support, orka3 sa token orka-admin
  • NFS-to-Harbor migration (migration-workflows.md): full flow and CI/CD repointing; --memory is a number of GB
  • Node disk sizing and storage usage (scaling-workflows.md)
  • config set --api-url doesn't change the kubeconfig server entry (config-commands.md)
  • Emulator REST API (rest-api.md, 3.7.0-alpha)
  • Play Store emulator images reject ADB (emulator-commands.md, SKILL.md)
  • Hardened image tagging and pre-caching, VM Tools needs macOS 13+ (image-workflows.md)
  • Placeholders converted to <UPPER_SNAKE> matching orka3 help across integrations and workflows
  • "IP plan" is now My Cloud (monitoring.md)
  • CHANGELOG entry under [Unreleased] - 1.6.0; SKILL.md reference table updated

Fixed from drift check

From skill PR #19 (drift check against the 3.7.0-alpha and 3.6.4 CLIs):

  • image-commands.md: removed orka3 image list --arch amd64. image list has no --arch flag (confirmed with orka3 image list --help).
  • Already correct on this branch, no change needed: orka3 regcred remove in SKILL.md, no --namespace on vm-config create in cicd-workflows.md (with the "configs live in orka-default" note), and the --display-dpi/--display-height/--display-width/--legacy-io (and --node for vm-config create) options in vm-commands.md and vm-config-commands.md.

Why

The docs changed a lot in September and October 2026 (component matrix, macOS 27, DI-754 upgrade issue, DI-730 namespace order, Harbor guide fixes). Agents using the skill were missing these facts, and some placeholders didn't match orka3 help.

Sources

All from macstadium-docs origin/main:

  • Component versions: orka-component-versions.mdx (d734f0f, 98a359d, dff6d80, d024f40; PR #391); orka3-cli-overview-configuration.mdx for orka3 version
  • macOS 27 guests and host status: compatibility-matrix.mdx (b7840da, eef26f7, 37eeef0; PR #412)
  • In-place upgrade issue: compatibility-matrix.mdx (5339d0f, f106202, 84efb7c; PR #403, DI-754)
  • Hosted admin limits: orka-authentication-and-rbac.mdx, external-custom-domains.mdx (eaf73cd; PR #407)
  • Harbor migration: orka-self-service-migrating-nfs-images-to-oci-with-harbor.mdx (477b283, 24a3776, b638b0f; PR #387)
  • Storage and disk sizing: shared-vm-storage.mdx (06c9a20, PR #366), resiliency-high-availability-and-disaster-recovery.mdx (48b0676, PR #338)
  • --api-url vs kubeconfig: orka3-cli-overview-configuration.mdx (d259de1, PR #392)
  • Emulator REST API: android-emulators.mdx (61a7703)
  • Play Store ADB: android-emulators.mdx, emulator-management.mdx (87ac26b)
  • Hardened image: building-a-hardened-custom-image.mdx (PR #337); latest tag: oci-images-deploy-vms.mdx (6d5029f)
  • My Cloud: macstadium/macstadium-overview/ip-plan.mdx; VM Tools macOS 13+: vm-tools.mdx
  • Placeholders: orka3 <cmd> --help (3.6.1 CLI)
  • Drift check fix: skill PR Add a CI check for CLI drift in the skill #19

For review

🤖 Generated with Claude Code

Component versions, macOS 27 guest rules, in-place upgrade known issue
and workaround, hosted-cluster admin limits, NFS-to-Harbor migration,
node disk sizing and storage usage, api-url vs kubeconfig, emulator
REST API, Play Store ADB limitation, hardened image and latest tag
notes, UPPER_SNAKE placeholders, My Cloud naming. Removes the
nonexistent `image list --arch` flag found by the drift check.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
celanthe added a commit that referenced this pull request Oct 23, 2026
Restacks the 4.0 work on #20 so it carries #15, #16, and #20's
corrected 3.x content. Conflicts resolved in favor of the corrected
emulator flags (--device-profile, required --platform and
--image-type, no --device, --cpu, --memory, or list --vm) while
keeping the 4.0 additions.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@celanthe celanthe self-assigned this Oct 23, 2026
@celanthe celanthe added the documentation Improvements or additions to documentation label Oct 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant