Usar una secuencia de comandos de inicio en VMs de Windows

Una secuencia de comandos de inicio realiza tareas durante el proceso de inicio de una máquina virtual (VM). En este documento se indican los pasos que debes seguir para usar secuencias de comandos de inicio en instancias de VM.

Una secuencia de comandos de inicio es una herramienta de automatización que realiza tareas durante el proceso de inicio de la VM. Usa secuencias de comandos de inicio para automatizar las tareas de configuración y despliegue de máquinas virtuales en instancias nuevas o ya creadas, lo que te ahorrará tiempo y reducirá el esfuerzo de configuración manual.

Este documento está dirigido a desarrolladores de grupos de administradores de plataformas u operadores de aplicaciones que quieran usar secuencias de comandos de inicio para VMs en un entorno de Distributed Cloud. Para obtener más información, consulta la documentación sobre las audiencias de GDC aislado.

Antes de empezar

Para usar los comandos de la interfaz de línea de comandos (CLI) de gdcloud, asegúrate de haber descargado, instalado y configurado la CLI de gdcloud. Todos los comandos de Distributed Cloud usan la CLI gdcloud o kubectl y requieren un entorno de sistema operativo (SO).

Obtener la ruta del archivo kubeconfig

Para ejecutar comandos en el servidor de la API Management, asegúrate de que tienes los siguientes recursos:

  1. Inicia sesión y genera el archivo kubeconfig para el servidor de la API Management si no tienes uno.

  2. Usa la ruta al archivo kubeconfig del servidor de la API Management para sustituir MANAGEMENT_API_SERVER en estas instrucciones.

Solicitar roles de gestión de identidades y accesos

Para usar secuencias de comandos de inicio en una VM, ponte en contacto con el administrador de proyectos de gestión de identidades y accesos para solicitar los siguientes roles en tu proyecto:

  • Administrador de proyectos de máquinas virtuales (project-vm-admin): crea, modifica, muestra y elimina máquinas virtuales en el espacio de nombres del proyecto.

  • Administrador de secretos (secret-admin): obtiene, muestra, crea, actualiza, elimina, corrige y supervisa los secretos de Kubernetes en el espacio de nombres del proyecto. Usa este rol para especificar secretos de secuencias de comandos de inicio. No necesitas este rol para especificar secuencias de comandos de inicio de texto sin formato.

Todos los roles de VM deben vincularse al espacio de nombres del proyecto en el que reside la VM. Sigue los pasos para verificar tu acceso.

Formato de los nombres de las secuencias de comandos de inicio de Windows

Las secuencias de comandos de inicio de las VMs de Windows deben seguir un formato de nombre específico, con el nombre de la secuencia de comandos y la extensión de archivo añadidos y separados por guiones. Por ejemplo, create-directory-ps1, donde create-directory es el nombre de la secuencia de comandos y ps1 es la extensión de archivo. Entre los formatos incorrectos se incluyen el uso de puntos en lugar de guiones y la omisión de la extensión de archivo, como create-directory.ps1 y create-directory.

A continuación se muestran las extensiones de archivo que se deben usar en las secuencias de comandos de inicio de Windows:

  • ps1: contiene comandos de PowerShell.
  • cmd: contiene comandos por lotes para el intérprete de la petición de comando.
  • bat: contiene comandos por lotes.

Ejecutar las secuencias de comandos de inicio de Windows en orden

Puedes usar varias secuencias de comandos de inicio. El tipo de archivo que contiene la secuencia de comandos influye en el orden en que se ejecuta cada secuencia de comandos. En la siguiente tabla se muestra el orden de ejecución de las secuencias de comandos de inicio de Windows:

Script de Windows Orden de ejecución
Secuencia de comandos de PowerShell Primero, en cada arranque.
Secuencia de comandos por lotes Segundo en cada arranque.
Guion de comandos Tercero en cada arranque.

Si dos secuencias de comandos de inicio tienen la misma extensión de archivo, se ejecutan según la extensión y el nombre del archivo en orden alfabético. Por ejemplo, si los nombres de tus secuencias de comandos de inicio son alpha-script-ps1 y beta-script-ps1, alpha-script-ps1 se ejecutará antes que beta-script-ps1.

En el siguiente ejemplo de especificación de VM se muestra el orden y la estructura de la secuencia de comandos de inicio de Windows en el campo startupScripts:

# …
  startupScripts:
  - name: create-directory-ps1
    script: |-
      New-Item -ItemType Directory -Path C:\ -Name NewDir
      Get-ChildItem -Path C:\
  - name: hello-world-bat
    script: |-
      ECHO "Hello World!"
  - name: list-directories-cmd
    script: |-
      dir C:\Windows  > files.txt
# …

Pasar una secuencia de comandos de inicio

Distributed Cloud ejecuta las secuencias de comandos de inicio en orden alfabético, según el nombre de cada secuencia de comandos de inicio.

En la siguiente tabla se muestra el formato de guion que debes usar en función del tamaño del guion:

Tamaño de la secuencia de comandos Formato de guion
Guiones de hasta 2048 bytes Borrar texto
Secuencias de comandos de más de 2048 bytes Secreto de Kubernetes

Definir una secuencia de comandos de inicio

Para usar una secuencia de comandos de inicio, debes añadir el campo startupScripts al campo spec de la VM. En este campo puedes especificar varias secuencias de comandos de inicio como texto sin formato o como un secreto de Kubernetes.

En el siguiente ejemplo se especifican las secuencias de comandos de inicio como texto sin cifrar y un secreto de Kubernetes:

apiVersion: virtualmachine.gdc.goog/v1
kind: VirtualMachine
metadata:
  name: "vm-test"
spec:
  # …
  startupScripts:
  - name: create-directory-ps1
    script: |-
      New-Item -ItemType Directory -Path C:\ -Name NewDir
      Get-ChildItem -Path C:\
  - name: list-directories-cmd
    scriptSecretRef:
      name: list-directories
---
apiVersion: v1
kind: Secret
type: Opaque
metadata:
  name: list-directories
data:
  script:
    ZGlyIEM6XFdpbmRvd3MgID4gZmlsZXMudHh0Cg==

Ten en cuenta lo siguiente:

  • La secuencia de comandos de inicio se ejecuta en cada arranque.
  • La secuencia de comandos de inicio tiene privilegios de administrador predeterminados.
  • En el secreto de Kubernetes, el nombre de scriptSecretRef en la VM spec debe coincidir con el campo metadata.name.
  • En el secreto de Kubernetes, especifica el contenido de la secuencia de comandos de inicio añadiendo una clave script al campo data.

Crear una nueva VM con una secuencia de comandos de inicio de Windows

Para crear una VM con una secuencia de comandos de inicio de Windows, sigue los pasos que se indican en Crear una VM con una secuencia de comandos de inicio.