Skip to main content

Fleet

note

We recommend reading Does this meet your needs and What are the sessions. Fleet are currently only supported with session-based deployment

What are the fleets#

A fleet is a tool to facilitate the creation of session-based deployments. It automatically creates deployments worldwide based on simple but powerful settings. This way, you can ensure that you have at least what you need regarding server capacity. It can also delete them fully automatically with some more in-depth configuration. We will soon see how to create your first fleet.

What it does?#

  • Automatically creates a new deployment when a certain capacity threshold is reached on the currently running deployments.
  • Allows always to have a minimum number of deployments ready to receive sessions.
  • It makes it possible to set a maximum number of simultaneous deployments.
  • It is bound to a region, so it allows controlling the number of servers running in a given region at any time.

How it helps?#

Below are a few examples of how it can be helpful to you:

  • It can save you money.
    By setting a maximum number of deployments, along with an acceptable threshold, you can be sure that a new deployment will be made only when necessary and only up to the maximum number set.
  • It can improve the user's experience.
    The threshold allows you to control the density on the servers. Take a survival game, for example. Some people might prefer very dense servers, while others would prefer a fresh experience. With a lower threshold, you could make sure a new server spawns whenever the last one becomes too crowded so players can choose a more or less populated server according to their preferences.
  • It makes your life easier.
    Once correctly set up, along with a reasonable empty time to live, the deployments will be created and terminated as the users join and leave the servers, and you won't even have to think about it! Connect and disconnect the sessions; there will always be just the right amount of servers waiting.

How to create a fleet#

We will now create your first fleet with examples from the dashboard and the API. Feel free to choose your favorite way to do it, but using the dashboard at least once may help you understand the structure of the fleets.

In our example, we will create a fleet to manage our deployments in the North American continent. Note that the name will not filter your deployment location. For that, we will add policies in the next section.


Once created, you will be redirected to the detail page of your new fleet.

img

img

Name: The name of your fleet. It must be unique.

Enabled: If your fleet is enabled or not. We strongly recommend only enabling your fleet when it's completely configured. If not, the fleet might automatically create deployments that you do not want.

That's all for the creation of the fleet itself! Of course, we will need to do a bit more to make our fleet work correctly. That's what we will do in the next section.