GuidesDiscussions
GuidesAPI ReferenceJoin the Mailing List

Networking: Boost Network Performance

(Intel-only) How to boost the network performance of your Orka VMs

πŸ“˜

Known limitation

This guide is applicable only to Intel-based VMs. Network boost is always enabled on Apple silicon VMs and cannot be disabled.

For more information, see Feature Parity: Apple Hardware and Compatibility: Performance Improving Features.

🚧

Quick navigation

Jump to: Defaults | Limitations | Enable Network Boost for existing VM configurations | Disable Network Boost for new VM configurations

🚧

Quick command summary

orka vm create-config --net-boost [yes/no]
orka vm create --net-boost [yes/no]
POST /resources/vm/create

By default, Network Boost is enabled on the environment level for both Intel- and Apple silicon-based nodes. For Intel-based VM configurations, you can choose to disable the net boost setting.

Starting with Orka 2.3.0, newly created VM configurations and VMs get the Network Boost option enabled. This setting improves the network performance of Orka VMs. The upgraded Network Interface Controller (NIC) allows Maximum Link Speed of 10 GB/s, compared to 1 GB/s when not using the Network Boost option.

Before you begin, make sure that your Orka environment is updated to Orka 2.3.0 or later.

Defaults

  • For environments running orka 2.3.0 and later, Network Boost is always enabled on the environment level (for Intel-based, Apple silicon-based, and mixed clustesrs.
  • For VM configurations created with Orka 2.2.0 and earlier, this setting is disabled. If you want to enable Network Boost for these configurations, you need to re-create them.

Limitations

  • Network Boost is compatible with macOS 11 (Big Sur) and later. For Intel-based VMs running earlier macOS versions, you need to manually disable the setting when creating the VM configuration.
  • Network Boost is always enabled for Apple silicon-based VMs and you cannot disable it.
  • You can enable or disable Network Boost only in direct mode for the Orka CLI, or with the Orka API.
  • You cannot override this setting during deployment.

Enable Network Boost for existing VM configurations

For VM configurations created with Orka 2.2.0 and earlier, Network Boost is disabled. The setting cannot be changed. You need to re-create your existing VM configurations to enable the feature. You don't need to enable Network Boost explicitly. Orka will enable the feature when you run the create operation.

orka vm create-config -v <VM_NAME> -b <IMAGE> -c <CPU_AMOUNT> -C <VCPU_AMOUNT> [other options as needed] -y

OR

orka vm create -v <VM_NAME> -b <IMAGE> -c <CPU_AMOUNT> -C <VCPU_AMOUNT> [other options as needed] -y
curl --location 'http://<ORKA_API_IP>/resources/vm/create' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <TOKEN>' \
--data '{
    "orka_vm_name": "<VM_NAME>",
    "orka_base_image": "<IMAGE>",
    "orka_image": "<VM_NAME>",
    "orka_cpu_core": <CPU_AMOUNT>,
    "vcpu_count": <VCPU_AMOUNT>,
  <other options as needed>,
}'

Disable Network Boost for new VM configurations

Sometimes, you might need to create a VM configuration with disabled Network Boost. For example, if you want to create an Intel-based VM running an incompatible macOS version.

orka vm create-config -v <VM_NAME> -b <IMAGE> -c <CPU_AMOUNT> -C <VCPU_AMOUNT> --net-boost no -y

OR

orka vm create -v <VM_NAME> -b <IMAGE> -c <CPU_AMOUNT> -C <VCPU_AMOUNT> --net-boost no -y
curl --location 'http://<ORKA_API_IP>/resources/vm/create' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <TOKEN>' \
--data '{
    "orka_vm_name": "<VM_NAME>",
    "orka_base_image": "<IMAGE>",
    "orka_image": "<VM_NAME>",
    "orka_cpu_core": <CPU_AMOUNT>,
    "vcpu_count": <VCPU_AMOUNT>,
    "io_boost": false
}'

See also


Β© 2019-2023 Copyright MacStadium, Inc. – Documentation built with readme.com. Orka is a registered trademark of MacStadium, Inc.