zeuz Multiplayer Operations documentation

Welcome to the zeuz Multiplayer Operations documentation. Here, you'll find the zeuz User Manual and API reference. You can also check out the Helpdesk and Knowledge Base.

User Manual    API Reference

Scaling rules

You define scaling rules as part of creating an allocation. In the zeuz control panel go to Orchestration > Allocations and click +ADD ALLOCATION. See Create an allocation for more information.

Scaling rules control how the zeuz scaler increases and decreases server resources in line with your game’s requirements.

Scaling rules

The zeuz scaler allocates bare-metal machines or cloud servers to your game’s hosting provision and adds or removes them as the game server workload changes.

The scaler uses your settings to allocate bare-metal machines or cloud servers to your game’s hosting provision, and add or remove them as the game server workload changes.

You edit the scaler settings in the zeuz control panel. The settings include scaling rules and hardware configuration requirements that determine how many payloads run on a bare-metal machine or cloud server. Payloads are instances of your game server’s software that run as containerized services.

When a payload is about to start, if none of the bare-metal machines or cloud servers currently running the game have enough capacity to run the new payload, the scaler runs it on a new bare-metal machine or cloud server. The scaler selects bare-metal machines over cloud servers where possible.

For more information on how the scaler allocates bare-metal machine and cloud server resources, see Payload scaling.

Define the scaling rules

In zeuz control panel > Allocation : Create > Scaling Rules, specify the following:

  • Free payload capacity: The minimum and maximum amount of unused and available capacity that you want to maintain at all times, measured in payloads (available payload slots). Use a higher free payload capacity range to allow for machines to warm up before zeuz assigns payloads to them. By doing this, you can minimize the delay that can occur when zeuz allocates payloads to machines.

    • The scaler ensures that the amount of available capacity is always within this range.
    • The possible range is between 1 and 128 payloads.
    • The amount of server allocation never exceeds the limits that you set in Max amount of bare-metal machines and Max amount of cloud machines below.
  • Unreserved payloads: The number of active payloads you want started and pre-running but not connected to players (used payload slots). Unreserved payloads are ready for when a new game server is needed for your game. They can start accepting players very quickly.

    • Enter any number of payloads between 1 and 64.
    • When your game is running and you unreserve one or more payloads, the scaler removes unreserved payloads that exceed the maximum number that you specify here.
    • Control manually: Enable this option to to change the number of unreserved payloads with the payload_create endpoint in the API.
  • Use All Available Bare-Metal Machines: If you configure the allocation to assign bare-metal machines, you can use this option to prioritise bare-metal machines for a specific allocation in a region that has other active allocations. We recommend that you create a separate allocation per region, in preference to using this setting. For advice on configuring your allocations for multiple regions, contact zeuz support.

  • Max amount of bare-metal machines: The maximum number of bare-metal machines that you want the zeuz scaler to allocate.

    • Enter any number between 0 and 10,000.
    • The figure you enter here is applied per region. For example, if you configure your allocation with two regions and a maximum of five bare-metal machines, the scaler allocates a maximum of ten bare-metal machines in total (five per region).
      Note: We recommend that you create a separate allocation for each region in which you have players. See Create an allocation for information on selecting regions for your allocation.
  • Max amount of cloud machines: The maximum number of cloud servers that you want the zeuz scaler to allocate.

    • Enter any number between 0 and 10,000.

See the Payload scaling page for examples of setting Scaling Rules.

Other sections

Ensure you have completed the other sections on the page, to finish configuring your allocation:

Save

Click the SAVE button at the top of the page to save the allocation. You can click CANCEL to return to the main Allocations page.


2021-sep-08 Page updated with editorial review: added Use All Available Bare-Metal Machines.
2021-aug-24 Page updated with editorial review: updated Define the scaling rules.
2021-jan-22 Page updated with editorial review: changed maximum number of allowed of bare-metal machines and cloud machines.

Updated about a month ago


Scaling rules


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.