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
4 changes: 1 addition & 3 deletions orka/orka-desktop/welcome-to-orka-desktop-30.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@
zendesk_id: 28396626048667
---

## Orka Desktop by MacStadium

Check warning on line 7 in orka/orka-desktop/welcome-to-orka-desktop-30.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-desktop/welcome-to-orka-desktop-30.mdx#L7

Use 'macstadium' instead of 'MacStadium'.

**Orka Desktop** is a free, no-obligation virtualization tool designed for individual macOS workstations. These workstations can be a local MacBook, a hosted Mac mini or Studio by MacStadium, AWS, or an on-premises solution. Once deployed, **Orka Desktop** lets you create a seamless workflow for running the same image on any device. You can build and test an image locally, then upload it to the cloud. This is much easier than needing bespoke technologies and individual processes to test, share, and configure virtualized images.

Check warning on line 9 in orka/orka-desktop/welcome-to-orka-desktop-30.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-desktop/welcome-to-orka-desktop-30.mdx#L9

Use 'macstadium' instead of 'MacStadium'.

**Orka Desktop** integrates with other cloud-based, licensed MacStadium products, like **Orka**. For example, you can upload an image built and tested with **Orka Desktop** to a container repository shared with an Orka cloud instance. Publishing local images to the Orka cloud means you can develop locally and deploy globally, offering flexibility, scalability, and an on-ramp to use MacStadium products more effectively.

Check warning on line 11 in orka/orka-desktop/welcome-to-orka-desktop-30.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-desktop/welcome-to-orka-desktop-30.mdx#L11

Use 'macstadium' instead of 'MacStadium'.

Check warning on line 11 in orka/orka-desktop/welcome-to-orka-desktop-30.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-desktop/welcome-to-orka-desktop-30.mdx#L11

Use 'macstadium' instead of 'MacStadium'.

<Note>
You can publish any image to a container registry, for example, GitHub Packages or DockerHub, and then pull it into the **Orka Cluster**.
Expand All @@ -27,9 +27,7 @@

Apple M1 with 8GB RAM, and 50GB disk space

macOS X 14.0+ (Sonoma)

macOS X 13.0+ (Ventura)
macOS 15.0+ (Sequoia)
</Note>

<Note>
Expand All @@ -42,13 +40,13 @@
</Note>


All registries conforming to this specification must support all APIs in the Pull category.

Check warning on line 43 in orka/orka-desktop/welcome-to-orka-desktop-30.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-desktop/welcome-to-orka-desktop-30.mdx#L43

Did you really mean 'APIs'?

Registries should also support the Push, Content Discovery, and Content Management categories. A registry claiming conformance with one of these specification categories must implement all APIs in the claimed category.

Check warning on line 45 in orka/orka-desktop/welcome-to-orka-desktop-30.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-desktop/welcome-to-orka-desktop-30.mdx#L45

Did you really mean 'APIs'?

## OCI Image Overview

The Open Container Initiative (OCI) is an open governance structure for the express purpose of creating open industry standards around container formats and runtimes.

Check warning on line 49 in orka/orka-desktop/welcome-to-orka-desktop-30.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-desktop/welcome-to-orka-desktop-30.mdx#L49

Use 'Runtimes' instead of 'runtimes'.

You can deploy a VM using a compatible image from a private or public registry, and store images in your own registry.

Expand All @@ -75,8 +73,8 @@

## Downloading Orka Desktop

* MacStadium website: [macstadium.com](https://www.macstadium.com/)

Check warning on line 76 in orka/orka-desktop/welcome-to-orka-desktop-30.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-desktop/welcome-to-orka-desktop-30.mdx#L76

Use 'macstadium' instead of 'MacStadium'.
* MacStadium GitHub repo: [macstadium/orka-desktop](https://github.com/macstadium/orka-desktop/releases)

Check warning on line 77 in orka/orka-desktop/welcome-to-orka-desktop-30.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-desktop/welcome-to-orka-desktop-30.mdx#L77

Use 'macstadium' instead of 'MacStadium'.

Check warning on line 77 in orka/orka-desktop/welcome-to-orka-desktop-30.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-desktop/welcome-to-orka-desktop-30.mdx#L77

Use 'Orka' instead of 'orka'.
* Brew package manager: `brew install orka-desktop`

![Orka Desktop main interface showing system information and VM list](/images/attachments/28396594761627.png)
Expand Down Expand Up @@ -177,7 +175,7 @@

## Starting the VM

1. Click an existing VM on the left-hand side. In this example, the VM is Orka3.

Check warning on line 178 in orka/orka-desktop/welcome-to-orka-desktop-30.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-desktop/welcome-to-orka-desktop-30.mdx#L178

Use 'orka3' instead of 'Orka3'.
2. Click Start.
![Start button for a selected VM in Orka Desktop](/images/attachments/28396625987099.png)
3. A separate window opens and the VM starts.
Expand Down Expand Up @@ -259,7 +257,7 @@

* Node Info (Contains system details, for example, chip, cores, memory, OS version, and so on).
* Image Info (Lists images, creates new image, deploys new VM based on an image).
* VM Details (For each running VM, there are actions like, Open Screenshare, Open SSH, Stop, Save, Save As, View Log actions).

Check warning on line 260 in orka/orka-desktop/welcome-to-orka-desktop-30.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-desktop/welcome-to-orka-desktop-30.mdx#L260

Did you really mean 'Screenshare'?
* Logs (Running logs, and any other useful information for debugging.)

![Orka Desktop log file view with Node Info, Image Info, VM Details, and Logs sections](/images/attachments/28396626024987.png)
Expand Down
4 changes: 2 additions & 2 deletions orka/orka-engine/orka-engine-30.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

* A host (or node) is a physical computer with a host macOS and an installation of Orka Engine.
* An image is the bits on disk representing a VM that can be used for saving state and sharing.
* MacStadium base VM Orka images are macOS OCI-compatible VM images stored in the public GitHub Container Registry at [ghcr.io/macstadium/orka-images](https://ghcr.io/macstadium/orka-images). No credentials are required to pull from this registry.

Check warning on line 13 in orka/orka-engine/orka-engine-30.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-engine/orka-engine-30.mdx#L13

Use 'macstadium' instead of 'MacStadium'.

Check warning on line 13 in orka/orka-engine/orka-engine-30.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-engine/orka-engine-30.mdx#L13

Use 'Orka' instead of 'orka'.



Expand Down Expand Up @@ -39,7 +39,7 @@

* Apple silicon Mac (M1 or later) with 8 GB RAM and 50 GB disk space

* macOS 13.0 (Ventura) or later
* macOS 15.0 (Sequoia) or later



Expand All @@ -48,7 +48,7 @@

Orka Engine requires a valid license key to operate. To request a license key:

1. Contact your MacStadium account representative

Check warning on line 51 in orka/orka-engine/orka-engine-30.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-engine/orka-engine-30.mdx#L51

Use 'macstadium' instead of 'MacStadium'.

2. Provide your organization name, deployment details, and use case

Expand All @@ -62,11 +62,11 @@

## Installation

To install Orka Engine on any Apple silicon Mac (M1 or later) running macOS 13 (Ventura) or later, download and run the installer package.
To install Orka Engine on any Apple silicon Mac (M1 or later) running macOS 15.0 (Sequoia) or later, download and run the installer package.

The Orka Engine installer is self-guided and takes less than a minute to install successfully. Simply double click or right click open the **orka-engine.pkg** file from the source download directory and follow the prompts.

Check warning on line 67 in orka/orka-engine/orka-engine-30.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-engine/orka-engine-30.mdx#L67

Use 'Orka' instead of 'orka'.

![macOS installer window for orka-engine showing the Introduction step](/images/attachments/39594591423515.png)

Check warning on line 69 in orka/orka-engine/orka-engine-30.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-engine/orka-engine-30.mdx#L69

Use 'Orka' instead of 'orka'.

![Orka Engine app icon showing an orca whale with a terminal prompt symbol](/images/attachments/39594527742107.png)

Expand All @@ -81,7 +81,7 @@
* Save that VM as an image using `orka-engine vm save`
* Listing images available on disk with `orka-engine image list`
* Stop a VM with **ctrl-c** in terminal window bound to running VM or by closing the Dock item
* Run a base template VM image hosted from MacStadium using `orka-engine vm run`

Check warning on line 84 in orka/orka-engine/orka-engine-30.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-engine/orka-engine-30.mdx#L84

Use 'macstadium' instead of 'MacStadium'.
* `orka-engine vm run latest-sonoma --image ghcr.io/macstadium/orka-images/sonoma:latest`
* Pulling remote images locally using `orka-engine image pull`
* Starting a VM in the stopped state with `orka-engine vm start`
Expand All @@ -93,7 +93,7 @@

After Orka Engine is installed, open a terminal window. The command `orka-engine` is installed at `/usr/local/bin/orka-engine` \- this should be in the $PATH for most users by default.

## Using orka-engine --help

Check warning on line 96 in orka/orka-engine/orka-engine-30.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-engine/orka-engine-30.mdx#L96

Use 'Orka' instead of 'orka'.

The `orka-engine --help` command lists the three subcommands, `vm`to manage VMs, `image` to manage images, and `host` to see information about the host.

Expand All @@ -111,7 +111,7 @@
```
orka-engine vm run latest-ipsw --ipsw latest --disk-size 90
```
`orka-engine vm run` is a blocking function. Open another terminal window to interface with orka-engine for other functions while the VM is running. Stop a VM with **ctrl-c** or via the UI window **Menu - > Quit**.

Check warning on line 114 in orka/orka-engine/orka-engine-30.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-engine/orka-engine-30.mdx#L114

Use 'Orka' instead of 'orka'.

## Common Options when Running a VM

Expand Down Expand Up @@ -158,7 +158,7 @@

Orka engine can list the name and resource consumption of VMs that are currently running or stopped on a local host.

![Terminal output of orka-engine vm list showing a VM named latest-ipsw with 2 CPUs, 4096M memory, in running state](/images/attachments/39594527745947.png)

Check warning on line 161 in orka/orka-engine/orka-engine-30.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-engine/orka-engine-30.mdx#L161

Use 'Orka' instead of 'orka'.

Check warning on line 161 in orka/orka-engine/orka-engine-30.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-engine/orka-engine-30.mdx#L161

Use 'VM' instead of 'vm'.

Check warning on line 161 in orka/orka-engine/orka-engine-30.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-engine/orka-engine-30.mdx#L161

Use 'IPSW' instead of 'ipsw'.

## Saving a VM as an Image

Expand All @@ -166,7 +166,7 @@

For example,`orka-engine vm save latest-ipsw sonoma146-vanilla` saves the VM called `latest-ipsw` as an image with the name **sonoma146-vanilla**

![Terminal confirmation: The image 'sonoma146-vanilla' for VM 'latest-ipsw' has been successfully saved](/images/attachments/39594591426971.png)

Check warning on line 169 in orka/orka-engine/orka-engine-30.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-engine/orka-engine-30.mdx#L169

Use 'IPSW' instead of 'ipsw'.

## Listing Images Available on Disk

Expand All @@ -176,9 +176,9 @@

Stop a headless VM or VM with a display console enter **ctrl-c**(from the terminal window VM was started with) or if deployed with a display console, by choosing the apple icon in the VM and selecting Shut Down… .

## Running a VM Based on a MacStadium Hosted Image

Check warning on line 179 in orka/orka-engine/orka-engine-30.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-engine/orka-engine-30.mdx#L179

Use 'macstadium' instead of 'MacStadium'.

MacStadium hosts a number of Sequoia, Sonoma, and Ventura images on [GitHub - macstadium/orka-images: Public images for Apple silicon-based Orka virtual machines](https://github.com/macstadium/orka-images/) In `orka-engine vm ,` specify an `--image` option to be the URL of an image coming from an OCI registry,

Check warning on line 181 in orka/orka-engine/orka-engine-30.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-engine/orka-engine-30.mdx#L181

Use 'macstadium' instead of 'MacStadium'.

Check warning on line 181 in orka/orka-engine/orka-engine-30.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-engine/orka-engine-30.mdx#L181

Use 'Orka' instead of 'orka'.

```bash
orka-engine vm run sonoma-latest --image ghcr.io/macstadium/orka-images/sonoma:latest
Expand All @@ -195,7 +195,7 @@



## Reviewing Current List of VMs (in VMs orka-engine)

Check warning on line 198 in orka/orka-engine/orka-engine-30.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-engine/orka-engine-30.mdx#L198

Use 'Orka' instead of 'orka'.

It is now possible to start a second terminal and run `orka-engine vm list`, and the following output appears, (which indicates that the previously running `latest-ipsw` VM has been stopped), and the recent `sonoma-latest` is now running.

Expand Down Expand Up @@ -229,7 +229,7 @@

## Pulling Remote Images Locally

In previous examples, `orka-engine vm run` was used to both _pull_ (or download) a remote image to the local device and to _run_ the vm. There are cases where users may just want to download an image, and `orka-engine image pull` supports this.

Check warning on line 232 in orka/orka-engine/orka-engine-30.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-engine/orka-engine-30.mdx#L232

Use 'VM' instead of 'vm'.

`orka-engine image pull ghcr.io/macstadium/orka-images/ventura:no-sip`

Expand All @@ -239,9 +239,9 @@

## Pushing local Images to Registry

If the previously run sonoma-latest image has been modified and saved with the necessary CI tools, then the image can be shared with team members by storing it on the team OCI repo and naming it **sequoiaCI**; on the repo, use the `orka-engine image push` command.

Check warning on line 242 in orka/orka-engine/orka-engine-30.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-engine/orka-engine-30.mdx#L242

Use 'Sonoma' instead of 'sonoma'.

The default local Orka Engine VM image files system path is `/Users/<host_username>/.local/share/orka/data/` where the host_username is **admin** in this example and the container registry is [ghcr.io](http://ghcr.io/) and the repo credentials are username=**dev1** and password=**repo**.

Check warning on line 244 in orka/orka-engine/orka-engine-30.mdx

View check run for this annotation

Mintlify / Mintlify Validation (macstadiuminc) - vale-spellcheck

orka/orka-engine/orka-engine-30.mdx#L244

Did you really mean 'host_username'?

`orka-engine image push --username dev1 --password repo /Users/admin/.local/share/orka/data/sonoma-latest ghcr.io/images/sequoiaCI:latest `

Expand Down