​

Exécution d’un script personnalisé lors de la création d’une machine virtuelle - VmStartupScript (préversion)

​

Introduction

​

Utiliser VmStartupScript

​

Créer un script

• Créez un fichier appelé PF_StartupScript.sh pour les machines virtuelles Linux ou PF_StartupScript.ps1 pour les machines virtuelles Windows.
• Ajoutez des commandes de configuration/d’exécution dans le fichier. Si nécessaire, voici quelques variables d’environnement couramment utilisées que vous pouvez utiliser dans le script. Certaines actions ne sont pas prises en charge ou empêcheraient les machines virtuelles de démarrer correctement, ce qui entraînerait des frais indésirables. Pour plus de détails, consultez la section Ce qui n’est pas pris en charge.

​

Créer et charger le fichier zip

1. Rassemblez dans un dossier tous les logiciels pertinents que votre script prévoit d’utiliser ou d’appeler. Si votre script installe des logiciels tiers, il peut les télécharger pendant son exécution, ou ceux-ci peuvent être fournis avec lui dans le fichier zip. Ignorez cette étape si vous n’installez rien.
2. Créez un fichier zip (.zip) contenant le script (.sh ou .ps1) créé dans la section précédente et, si nécessaire, les logiciels rassemblés à l’étape précédente. Le fichier de script doit se trouver à la racine du fichier zip et non dans un répertoire. En outre, si votre fichier de script ne s’appelle pas PF_StartupScript.sh (Linux) ou PF_StartupScript.ps1 (Windows), il ne sera pas exécuté et les serveurs de jeu ne démarreront pas.
3. Chargez le fichier zip à l’aide de l’une des méthodes suivantes :

• Utilisez PlayFab Game Manager
• Envoyez une requête PUT avec l’en-tête {“x-ms-blob-type”: “BlockBlob”} à l’URL renvoyée par l’appel de l’API GetAssetUploadUrl.
• Utilisez les cmdlets PowerShell.

​

Appliquer le script personnalisé aux nouvelles builds

• Ajoutez la propriété VmStartupScriptConfiguration.VmStartupScriptAssetReference, qui inclut une référence au fichier de ressources chargé. Cette propriété fait partie de toutes les API liées à “CreateBuild”, comme CreateBuildWithCustomContainer, CreateBuildWithManagedContainer et CreateBuildWithProcessBasedServer.
• Ajoutez une valeur valide pour la propriété VmStartupScriptAssetReference.FileName. Cette valeur doit être identique au nom de votre fichier de ressources, par exemple vmstartupscriptassets.zip.
• La propriété VmStartupScriptAssetReference.MountPath doit être vide, car elle n’est pas prise en charge pour la fonctionnalité VmStartupScript.

var request = new CreateBuildWithCustomContainerRequest()
{ 
    ContainerImageReference = new ContainerImageReference()
    {
         ImageName= "testimagename",
         Tag= "0.1"
    },
    ContainerFlavor = ContainerFlavor.CustomLinux,
    BuildName = "testbuildwithvmstartupscript",
    VmSize = AzureVmSize.Standard_D2as_v4,
    MultiplayerServerCountPerVm = 3,
    Ports= new List<Port>
    {
        new Port()
        {
            Name= "port",
            Num= 123,
            Protocol = ProtocolType.TCP   
        }
    },
    RegionConfigurations = new List<BuildRegionParams> { new BuildRegionParams()
    {
        Region = "EastUs",
        StandbyServers = 3,
        MaxServers = 6

    } 
    },
    VmStartupScriptConfiguration = new VmStartupScriptParams()
    {
        VmStartupScriptAssetReference = new AssetReferenceParams()
        {
            FileName = "vmstartupscriptassets.zip"
        }
    }
};
var result = await PlayFabMultiplayerAPI.CreateBuildWithCustomContainerAsync(request);

​

Considérations particulières

​

Sous Linux, le fichier PF_StartupScript.sh doit-il être marqué comme exécutable ?

​

Variables d’environnement

​

Ce qui n’est pas pris en charge

• Ne bloquez pas pendant l’exécution du script de démarrage. Le script doit se terminer avec succès pour que les serveurs de jeu soient créés. Si vous avez besoin que quelque chose s’exécute en arrière-plan, vous pouvez l’installer en tant que service systemd sous Linux ou en tant que service Windows.
• N’utilisez pas les ports à partir de 30000, car ils sont utilisés pour les serveurs de jeu, ni le port 56001, utilisé par le processus VmAgent (l’exécutable d’orchestration des serveurs de jeu MPS).
• Ne modifiez aucun des fichiers des chemins D: (Windows) ou /mnt (Linux), car ils sont nécessaires au fonctionnement de VmAgent (à l’exception des dossiers dont le contenu est modifiable, comme PF_SHARED_CONTENT_FOLDER_VM).
• Vous ne devez pas utiliser le GSDK depuis VmStartupScript ou depuis une application lancée par celui-ci. Le GSDK ne doit être utilisé que depuis les serveurs de jeu.
• Vous ne devez pas redémarrer manuellement la machine virtuelle, car cette opération pose des problèmes de communication avec le plan de contrôle MPS.

​

Ports

​

Utilisation

VmStartupScriptConfiguration = new VmStartupScriptParams()
{
    VmStartupScriptAssetReference = new AssetReferenceParams()
    {
        FileName = "vmstartupscriptassets.zip"
    },
    PortRequests = new List<VmStartupScriptPortRequest>()
        {
            new VmStartupScriptPortRequest()
            {
                Name = "port0",
                Protocol = ProtocolType.TCP
            },
            new VmStartupScriptPortRequest()
            {
                Name = "port1",
                Protocol = ProtocolType.UDP
            }
        }
}

PF_STARTUP_SCRIPT_PORT_COUNT

PF_STARTUP_SCRIPT_PORT_INTERNAL_0
PF_STARTUP_SCRIPT_PORT_EXTERNAL_0
PF_STARTUP_SCRIPT_PORT_NAME_0
PF_STARTUP_SCRIPT_PORT_PROTOCOL_0

PF_STARTUP_SCRIPT_PORT_INTERNAL_1
PF_STARTUP_SCRIPT_PORT_EXTERNAL_1
PF_STARTUP_SCRIPT_PORT_NAME_1
PF_STARTUP_SCRIPT_PORT_PROTOCOL_1

​

Développement/débogage

​

Flux de travail de développement recommandé

​

Support