​

Ejecución de un script personalizado durante la creación de la VM: VmStartupScript (versión preliminar)

​

Introducción

​

Cómo usar VmStartupScript

​

Creación de un script

• Cree un archivo llamado PF_StartupScript.sh para las VM de Linux o PF_StartupScript.ps1 para las VM de Windows.
• Agregue comandos de configuración y ejecución en el archivo. Si los necesita, aquí tiene algunas variables de entorno de uso común que puede usar en el script. Algunas acciones no se admiten o harían que las VM no se iniciaran correctamente, lo que generaría cargos no deseados. Para obtener más información, consulte la sección Qué no se admite.

​

Creación y carga del archivo comprimido

1. Reúna en una carpeta todo el software pertinente que su script vaya a usar o llamar. Si su script instala software de terceros, el script puede descargarlo durante la ejecución, o el software puede incluirse en el archivo comprimido. Omita este paso si no va a instalar nada.
2. Cree un archivo comprimido (.zip) con el script (.sh o .ps1) que creó en la sección anterior y el software que reunió en el paso anterior, si es necesario. El archivo de script debe estar en la raíz del archivo comprimido y no dentro de un directorio. Además, si su archivo de script no se llama PF_StartupScript.sh (Linux) o PF_StartupScript.ps1 (Windows), no se ejecutará y los servidores de juego no se iniciarán.
3. Cargue el archivo comprimido con uno de los métodos siguientes:

• Use PlayFab Game Manager
• Emita una solicitud PUT con el encabezado {“x-ms-blob-type”: “BlockBlob”} en la dirección URL devuelta por la llamada a la API GetAssetUploadUrl.
• Use los cmdlets de PowerShell.

​

Aplicación del script personalizado a las compilaciones nuevas

• Agregue la propiedad VmStartupScriptConfiguration.VmStartupScriptAssetReference, que incluye una referencia al archivo de recursos cargado. Esta propiedad forma parte de todas las API relacionadas con “CreateBuild”, como CreateBuildWithCustomContainer, CreateBuildWithManagedContainer y CreateBuildWithProcessBasedServer.
• Agregue un valor válido para la propiedad VmStartupScriptAssetReference.FileName. Este valor debe ser el mismo que el nombre de su archivo de recursos, por ejemplo vmstartupscriptassets.zip.
• La propiedad VmStartupScriptAssetReference.MountPath debe estar vacía, ya que no se admite para la característica 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);

​

Consideraciones especiales

​

En Linux, ¿es necesario marcar el archivo PF_StartupScript.sh como ejecutable?

​

Variables de entorno

​

Qué no se admite

• No se bloquee durante la ejecución del script de inicio. El script debe terminar correctamente para que se creen los servidores de juego. Si necesita que algo se ejecute en segundo plano, puede instalarlo como un servicio systemd en Linux o como un servicio de Windows.
• No use puertos a partir del número 30000, ya que se usan para los servidores de juego, ni el puerto 56001, ya que lo usa el proceso VmAgent (el ejecutable orquestador de servidores de juego de MPS).
• No modifique ninguno de los archivos de las rutas D: (Windows) o /mnt (Linux), ya que estos archivos son necesarios para el funcionamiento de VmAgent (aparte de las carpetas que contienen contenido editable, como PF_SHARED_CONTENT_FOLDER_VM).
• No debe usar el GSDK desde el VmStartupScript ni desde una aplicación iniciada por él. El GSDK solo debe usarse desde los servidores de juego.
• No debe reiniciar manualmente la máquina virtual, ya que esta operación creará problemas en la comunicación con el plano de control de MPS.

​

Puertos

​

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

​

Desarrollo/depuración

​

Flujo de trabajo de desarrollo recomendado

​

Soporte técnico