Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #6

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
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
32 changes: 26 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,12 @@ To get started with Orka Desktop, click the 'Create New VM', choose 'Pull from I
ghcr.io/macstadium/orka-images/sonoma:latest
```

## Using with Orka Engine
To get started with Orka Engine, run:
```sh
orka-engine vm run latest-sonoma --image ghcr.io/macstadium/orka-images/sequoia:latest
```

## Using with Orka Cluster
To get started with Orka Cluster, run:

Expand All @@ -30,17 +36,23 @@ spec:
image: ghcr.io/macstadium/orka-images/sonoma:latest
```

## Sequoia Beta (Orka Desktop only)
## Sequoia

To deploy a Sequoia Beta VM with Orka Desktop:
1. Click + Create New VM button
1. Select Pull from OCI registry
1. Name VM and set parameters (CPUs, Memory, HD size)
1. In OCI Image Name field enter: `ghcr.io/macstadium/orka-images/sequoia:latest`
To deploy a Sequoia VM:
1. Ensure you have a host OS of macOS 14.6 or higher. You may also require a recent beta of Xcode 16 Beta (see https://forums.developer.apple.com/forums/thread/756693)
2. Deploy Sequoia with the following image label:
```sh
ghcr.io/macstadium/orka-images/sequoia:latest
```

## Sonoma
To deploy a Sonoma VM, deploy with the following image label:

```sh
orka3 vm deploy --image ghcr.io/macstadium/orka-images/sonoma:latest
```


## SIP Disabled Sonoma

To deploy a Sonoma VM with SIP (system integrity protection) disabled, deploy with the following image label:
Expand All @@ -49,6 +61,14 @@ To deploy a Sonoma VM with SIP (system integrity protection) disabled, deploy wi
orka3 vm deploy --image ghcr.io/macstadium/orka-images/sonoma:latest-no-sip
```

## Ventura

To deploy a Ventura VM, deploy with the following image label:

```sh
orka3 vm deploy --image ghcr.io/macstadium/orka-images/ventura
```

## SIP Diabled Ventura

To deploy a Ventura VM with SIP disabled, run:
Expand Down