OCI Images: Deploy VMs

Using an OCI image in your workloads is as simple as just deploying a VM and specifying the address of the image in the registry. If you are working with a private registry, you need to have the registry credentials configured in the respective namespace before attempting to deploy.

orka3 vm deploy --image <SERVER_ADDRESS>/<IMAGE>[:<TAG>]


orka3 vm deploy --image <SERVER_ADDRESS>/<IMAGE>[:<TAG>] --namespace <NAMESPACE>
curl -X 'POST' \
  '<ORKA_API_URL>/api/v1/namespaces/<NAMESPACE>/vms' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <TOKEN>'
  -H 'Content-Type: application/json' \
  -d '{
  "image": "<SERVER_ADDRESS>/<IMAGE>[:<TAG>]"

Note that you need to provide the registry path to the image name and optionally its tag. For example: ghcr.io/my-organization/orka-images/orka-arm:latest.

You can add as many or as few configuration options as you need, including a user-specified name. If you are using the Orka3 CLI, run orka3 vm deploy --help for more information. If you are using the Orka3 API, see Deploy a VM.


Did you know?

You can find MacStadium's public vanilla macOS images at https://github.com/macstadium/orka-images

See also

ยฉ 2019-2023 Copyright MacStadium, Inc. โ€“ Documentation built with readme.com. Orka is a registered trademark of MacStadium, Inc.