Upload a dedicated server build using the AMS CLI

Introduction

AccelByte Multiplayer Servers (AMS) helps you manage and deploy your dedicated server builds so you can serve game sessions to your players around the world. Before you can create a fleet of servers you need to upload the dedicated server build to an AMS account.

This article walks you through how to:

• Use the AMS command line interface (CLI) to upload a dedicated server image
• Create an upload command

Prerequisites

Before you begin this guide, you must have:

• Integrated the dedicated server with the AGS SDK.

• Downloaded the AMS CLI.

• Created an IAM client for uploading dedicated servers with the following permission:

  Permission name	Action
  AMS:UPLOAD	Create, Update

  We recommend that you create an API client specifically for uploading dedicated servers. The IAM client will be used to verify the identity of the uploader. To learn how to create an IAM client, see Create an IAM client.

AGS Starter

If you are an AGS Starter customer, you can create an IAM client with all the necessary permissions for dedicated server uploading by clicking Create DS Uploader IAM Client under the Create New button on the IAM Clients page. A client that is capable of uploading a dedicated server has the DS Uploader tag.

• Stored the dedicated server executables and any supporting files within a folder.

Server image requirements

• The dedicated server images must be built for either x86 or x64. ARM is currently not supported.

• The dedicated server images must be built for Linux.

The upload process

The AMS CLI packages your dedicated server files and uploads the package to cloud storage. Once the upload completes successfully, you can deploy dedicated servers with this image using AMS fleets.

注記

All dedicated server images are stored at the account level, meaning that all namespaces that link to the same AMS account will have access to all the dedicated server images that are uploaded to it.

Using the dedicated server uploader

The general base command would be similar to this:

> ams upload -H <host> -c <iam_client_id> -s <iam_client_secret> -n <image_name> -p <path_to_server_folder> -e <exec_command>

You can view detailed help for the upload AMS CLI command by running ams upload –help.

upload command flags

• -c, --clientId

  The IAM client ID to be used for the uploader to authenticate.

• -e, --executable

  Relative path to the executable that starts your dedicated server. The specified path must be relative to the directory specified in the --path argument.

• -H, --hostURL

  Specify the host name of the environment that you want to upload to. The host name is the base URL of the environment, without the https://.

• -n, --imageName

  Name of the image that is going to be built.

• -p, --path

  The local path to the directory with your dedicated server files to be uploaded. This can either be an absolute path or a relative path but must be a directory containing all the files needed to run your dedicated server.

• -s, --secret

  Specify the IAM client secret to be used for the uploader, to authenticate if the IAM client in use is a confidential client. Otherwise this option can be skipped.

• -f, --symbolFiles (Optional)

  Use this option if you want your debug symbols to be uploaded alongside the server files. The default is false.

What's next

Now that you have uploaded your dedicated server build to AMS, you are ready to create a fleet to deploy dedicated servers using the uploaded image.