​

Executando um script personalizado durante a criação da VM - VmStartupScript (versão prévia)

​

Introdução

​

Como usar o VmStartupScript

​

Criar um script

• Crie um arquivo chamado PF_StartupScript.sh para VMs Linux ou PF_StartupScript.ps1 para VMs Windows.
• Adicione comandos de configuração/execução ao arquivo. Se precisar, veja algumas variáveis de ambiente usadas com frequência que você pode usar no script. Algumas ações não têm suporte ou fariam com que as VMs não iniciassem com êxito, gerando cobranças indesejadas. Para obter detalhes, consulte a seção O que não tem suporte.

​

Criar e carregar o arquivo zip

1. Reúna em uma pasta todo o software relevante que seu script planeja usar ou chamar. Se o seu script instalar software de terceiros, ele poderá baixá-lo durante a execução, ou o software pode ser incluído no arquivo zip. Ignore esta etapa se não for instalar nada.
2. Crie um arquivo zip (.zip) com o script (.sh ou .ps1) que você criou na seção anterior e com o software reunido na etapa anterior, se necessário. O arquivo de script deve estar na raiz do arquivo zip, e não dentro de um diretório. Além disso, se o arquivo de script não se chamar PF_StartupScript.sh (Linux) ou PF_StartupScript.ps1 (Windows), ele não será executado, e os servidores de jogo não iniciarão.
3. Carregue o arquivo zip usando um dos seguintes métodos:

• Use o PlayFab Game Manager
• Emita uma solicitação PUT com o cabeçalho {“x-ms-blob-type”: “BlockBlob”} na URL retornada pela chamada à API GetAssetUploadUrl.
• Use os cmdlets do PowerShell.

​

Aplicar o script personalizado a novos builds

• Adicione a propriedade VmStartupScriptConfiguration.VmStartupScriptAssetReference, que inclui uma referência ao arquivo de ativos carregado. Essa propriedade faz parte de todas as APIs relacionadas a “CreateBuild”, como CreateBuildWithCustomContainer, CreateBuildWithManagedContainer e CreateBuildWithProcessBasedServer.
• Adicione um valor válido para a propriedade VmStartupScriptAssetReference.FileName. Esse valor deve ser igual ao nome do seu arquivo de ativos, por exemplo, vmstartupscriptassets.zip.
• A propriedade VmStartupScriptAssetReference.MountPath deve estar vazia, pois não tem suporte no recurso 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);

​

Considerações especiais

​

No Linux, preciso marcar o arquivo PF_StartupScript.sh como executável?

​

Variáveis de ambiente

​

O que não tem suporte

• Não bloqueie durante a execução do script de inicialização. O script deve terminar com êxito para que os servidores de jogo sejam criados. Se precisar que algo seja executado em segundo plano, você pode instalá-lo como um serviço systemd no Linux ou como um serviço do Windows.
• Não use portas a partir de 30000, pois elas são usadas pelos servidores de jogo, nem a porta 56001, pois ela é usada pelo processo VmAgent (o executável orquestrador de servidores de jogo do MPS).
• Não modifique nenhum dos arquivos nos caminhos D: (Windows) ou /mnt (Linux), pois esses arquivos são necessários para a operação do VmAgent (exceto as pastas com conteúdo editável, como PF_SHARED_CONTENT_FOLDER_VM).
• Você não deve usar o GSDK de dentro do VmStartupScript ou de um aplicativo iniciado por ele. O GSDK só deve ser usado a partir dos GameServers.
• Você não deve reiniciar manualmente a máquina virtual, pois essa operação criará problemas na comunicação com o plano de controle do MPS.

​

Portas

​

Uso

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

​

Desenvolvimento/depuração

​

Fluxo de trabalho de desenvolvimento recomendado

​

Suporte