Ejecución de comandos en una instancia

La función de ejecución de comando está soportada en instancias informáticas que utilizan las siguientes imágenes de plataforma:

• Oracle Autonomous Linux
• Oracle Linux
• CentOS
• Windows Server

Las imágenes personalizadas basadas en una imagen de plataforma soportada también soportan la función de ejecución de comando.

La función de ejecución de comando está soportada en todas las regiones del dominio comercial de Oracle Cloud Infrastructure.

• En instancias de Linux, el script se ejecuta por defecto en un shell bash. Para ejecutar el script con un programa diferente, utilice #!/<path_to_program> como la primera línea del script.

• En instancias de Windows, el script se ejecuta por defecto en un shell por lotes. Para ejecutar el script con PowerShell, utilice #ps1 como la primera línea del script.

  Consulte un script de PowerShell de ejemplo

  En el siguiente ejemplo, se utiliza PowerShell para consultar el servicio de metadatos de instancia e imprimir el OCID de instancia:

  #ps1
  $instance = Invoke-RestMethod -Headers @{'Authorization' = 'Bearer Oracle'} -Uri http://169.254.169.254/opc/v2/instance/
  Write-Host ('Instance OCID is ' + $($instance.id))

• El tamaño máximo de un archivo de script que cargue directamente a una instancia en texto sin formato es de 4 KB. Para proporcionar un archivo más grande, guarde el archivo en una ubicación de Object Storage.
• La salida de un script cuando se devuelve como texto sin formato se limita al último 1 KB. Para guardar una respuesta más grande, guarde la salida en una ubicación de Object Storage.
• Al utilizar una ubicación de Object Storage para guardar el archivo de script o la respuesta, la instancia debe tener conectividad saliente, como un gateway de traducción de acceso a red (NAT), un gateway de servicio o un gateway de Internet. La instancia también debe permitir el tráfico de salida en el puerto 443 para el software Oracle Cloud Agent, Object Storage e IAM.

• Dos scripts se pueden ejecutar a la vez por defecto. Para cambiar el valor por defecto, actualice el archivo de configuración de ejecución de comando:

  cat /etc/oracle-cloud-agent/plugins/runcommand/config.yml

  Defina los siguientes parámetros:

  logDir: /var/log/oracle-cloud-agent/plugins/runcommand
  commandExecutionMaxWorkers: <number-of-parallel-scripts>

• Un máximo de cinco scripts pueden estar en ejecución a la vez. Se considera que un script está en ejecución si el plugin Compute Instance Run Command lo ha recibido, pero aún no lo ha suprimido de la cola.
• Para realizar tareas de larga ejecución, utilice la función de ejecución de comando para programar un trabajo cron en la instancia. La orquestación de comandos no está soportada.
• Cada script se ejecuta una vez. Si desea que un script se ejecute varias veces, utilice cron para configurar un programa para el script.
• Los scripts que solicitan información no están soportados. Sin embargo, puede utilizar el servicio de metadatos de instancia (IMDS) para recuperar mediante programación la información sobre la instancia en la que se ejecuta el script.
• Al crear una instancia a partir de una imagen personalizada que ya tiene permisos para el plugin Comando de ejecución de la instancia informática configurado, sustituya 101-oracle-cloud-agent-run-command por 100-oracle-cloud-agent-run-command en el archivo de configuración.
• Los códigos de salida que se devuelven son códigos de error de Linux estándar. Un código de salida 0 indica que la operación se ha realizado correctamente.
• Si aplica un timeout opcional para un script, el valor por defecto será de una hora. El máximo es de 24 horas.
• El tiempo máximo durante el que se puede ejecutar un script es de un día.
• Para supervisar los recursos que consumen los scripts, como la utilización de CPU, utilice métricas.
• Cancelar un script es un intento válido. Los comandos no se pueden cancelar después de que hayan terminado de ejecutarse o si han caducado.
• Los archivos de script y las respuestas que se guardan en texto sin formato se conservan durante siete días. Los archivos de script y las respuestas que se guardan en una ubicación de Object Storage se conservan hasta que los suprime.
• No ejecute un script que haga que se pare el software Oracle Cloud Agent o el plugin Compute Instance Run Command.

Si un comando requiere permisos de administrador, debe otorgar permisos de administrador al plugin Compute Instance Run Command para poder ejecutar el comando. El plugin se ejecuta como usuario ocarun.

Puede utilizar cloud-init (cloudbase-init en Windows) para configurar permisos al iniciar la instancia o conectarse a una instancia después de que haya iniciado y configurado permisos de forma manual. Los pasos para otorgar permisos de administrador dependen del sistema operativo.

• El plugin Compute Instance Run Command debe estar activado en la instancia y los plugins deben estar en ejecución. Para obtener más información sobre cómo activar y ejecutar plugins, consulte Oracle Cloud Agent.
• Ha preparado el script que desea ejecutar. Recomendamos que pruebe el comando en un entorno de no producción antes de desplegarlo en instancias que ejecutan flujos de trabajo de producción.
• Para proporcionar el archivo de script desde una ubicación de Object Storage, cargue el archivo de imagen en un cubo de Object Storage en la misma región que la instancia de destino. Anote el nombre del cubo y del archivo, o la URL de Object Storage para el archivo. Para utilizar el mismo comando en todos los arrendamientos, cree una URL de solicitud autenticada previamente que apunte al archivo.
• Para guardar la salida de comando en una ubicación de Object Storage, cree un cubo para guardarla, en la misma región que la instancia de destino. Anote el nombre del cubo o la URL de Object Storage para el cubo. Opcionalmente, puede guardar la salida de comando mediante una solicitud autenticada previamente que apunte a una ubicación de Object Storage.
• Para las imágenes de plataforma publicadas antes de octubre de 2020, el software Oracle Cloud Agent se debe actualizar a una versión que soporte el plugin Compute Instance Run Command (versión 1.5.1 o posterior).

Para obtener más información sobre el uso de la API y la firma de solicitudes, consulte la documentación de la API de REST y Credenciales de seguridad. Para obtener información sobre los SDK, consulte Los SDK y la CLI.

Utilice estas operaciones de API para trabajar con la función de ejecución de comando:

• CreateInstanceAgentCommand
• GetInstanceAgentCommand
• GetInstanceAgentCommandExecution
• ListInstanceAgentCommands
• ListInstanceAgentCommandExecutions
• CancelInstanceAgentCommand

Para solucionar problemas del plugin Compute Instance Run Command, puede ver los logs que genera el plugin. Conéctese a la instancia y, a continuación, utilice lo siguiente:

tail -f /var/log/oracle-cloud-agent/plugins/runcommand/runcommand.log

Para una visibilidad más fácil de las operaciones del plugin sin tener que conectarse a la instancia, puede crear logs personalizados mediante el servicio Oracle Cloud Infrastructure Logging.