Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Ganchos de presentación

Los enlaces de envío te permiten ejecutar scripts personalizados durante el flujo de trabajo de envío de trabajos de Deadline Cloud. Los Hooks se ejecutan localmente en la estación de trabajo que envía el trabajo, antes de que el trabajo llegue al servicio de Deadline Cloud. Los Hooks no se ejecutan en los trabajadores ni en la AWS nube. Como los ganchos se ejecutan en tu máquina, tienen acceso a los archivos locales, las variables de entorno y los recursos de red disponibles para el usuario que los envía.

Puede usar los ganchos para validar las configuraciones de los trabajos, descubrir recursos adicionales, modificar los parámetros de envío o integrarlos con sistemas externos, como el software de seguimiento de la producción. Para ver otros puntos de integración que se ejecutan en los trabajadores o en la nube, consulte. Ganchos, eventos y puntos de integración para puestos de trabajo

Hay dos formas de configurar los ganchos:

Ambas fuentes pueden estar activas al mismo tiempo. Cuando ambas están presentes, los ganchos de entorno se ejecutan primero y, después, los de agrupamiento.

Tipos de ganchos

Deadline Cloud admite tres tipos de ganchos que corresponden a diferentes puntos del flujo de trabajo de envío.

Pre-GUI ganchos

Pre-GUI los ganchos se ejecutan antes de que se abra el cuadro de diálogo de envío. Puede utilizar ganchos anteriores a la interfaz gráfica de usuario para las siguientes tareas:

Pre-GUI Los ganchos bloquean la apertura del cuadro de diálogo si fallan (código de salida distinto de cero o tiempo de espera).

Transmite JSON a stdout para modificar el estado inicial del diálogo. El siguiente ejemplo muestra el formato de salida:

import json

output = {
    "name": "My Render - v042",
    "description": "Submitted via pipeline",
    "parameters": {
        "SceneFile": "/resolved/path/to/scene.ma",
        "OutputPath": "/shots/sh010/renders/",
        "deadline:priority": 75,
        "deadline:maxFailedTasksCount": 5,
        "deadline:maxRetriesPerTask": 3,
        "deadline:maxWorkerCount": 10,
        "deadline:targetTaskRunStatus": "READY"
    }
}
print(json.dumps(output))

En la siguiente tabla se describen los campos de salida de los enlaces anteriores a la GUI.

En la siguiente tabla se describen las propiedades del trabajo compartido que se pueden establecer con el deadline: prefijo del parameters objeto.

Pre-submission ganchos

Pre-submission los ganchos se ejecutan antes de procesar y cargar los archivos adjuntos de los trabajos. Puedes usar los ganchos previos al envío para las siguientes tareas:

Pre-submission Los ganchos bloquean el envío si fallan (código de salida distinto de cero o tiempo de espera).

Transfiera JSON a stdout para modificar el envío. La salida del enlace reemplaza las referencias a los activos en el nivel de clave anidada. Si sus salidas de ganchoinputFilenames, la salida de gancho reemplazará a toda la inputFilenames lista. Deadline Cloud conserva las claves que no incluyes en tu salida.

En el siguiente ejemplo, se añaden los archivos de textura descubiertos al envío:

import json
import os
import sys

metadata = json.load(sys.stdin)
bundle_dir = metadata["jobBundleDir"]

textures = []
for root, _, files in os.walk(bundle_dir):
    for f in files:
        if f.endswith(('.exr', '.png', '.jpg', '.tx')):
            textures.append(os.path.join(root, f))

if textures:
    print(json.dumps({
        "attachments": {
            "assetReferences": {
                "inputFilenames": textures
            }
        }
    }))

Pre-submission Los ganchos también pueden modificar los valores de los parámetros de la plantilla de trabajo emitiendo un parameters mapa en formato stdout:

print(json.dumps({"parameters": {"SceneFile": "/resolved/scene.ma", "Quality": "high"}}))

Las claves de parámetros son nombres de parámetros de plantillas de trabajos. Los valores de un gancho se aplican sobre los valores de los parámetros del paquete, pero los CLI-supplied --parameter valores siguen teniendo prioridad sobre los valores proporcionados por el gancho.

Post-submission ganchos

Post-submission los ganchos se ejecutan después de que la llamada a la CreateJob API se devuelva correctamente. El trabajo ha sido aceptado por Deadline Cloud en este momento. Puedes usar los ganchos posteriores a la presentación para las siguientes tareas:

Post-submission Los errores de enlace se registran como advertencias, pero no afectan al trabajo enviado.

Configure los ganchos de envío

Defina los ganchos en un hooks.json archivo hooks.yaml o. Coloque el archivo en el directorio del paquete de tareas al lado template.yaml o en el directorio especificado porDEADLINE_HOOKS_DIR. Si ambos formatos se encuentran en el mismo directorio, el remitente informa de un error.

El version campo es obligatorio y debe serlo. "1.0"

El siguiente ejemplo muestra una hooks.yaml configuración:

version: "1.0"
preGUI:
  - command: python3
    args: [scripts/prefill_from_shotgrid.py]
    timeout: 10

preSubmission:
  - command: python3
    args: [scripts/validate_assets.py]
    timeout: 60
    env:
      VALIDATION_LEVEL: strict

  - command: python3
    args: [scripts/discover_textures.py]

postSubmission:
  - command: python3
    args: [scripts/notify_slack.py]
    timeout: 15
    env:
      SLACK_WEBHOOK: https://hooks.slack.com/...

Campos de definición de ganchos

Cada entrada de gancho acepta los siguientes campos.

Resolución de la ruta de acceso

Los scripts de ganchos se resuelven de acuerdo con las siguientes reglas:

Entrada de gancho

Los Hooks reciben los metadatos del trabajo a través de JSON en stdin y a través de variables de entorno prácticas.

Variables de entorno

Las siguientes variables de entorno están disponibles para todos los ganchos.

JSON en stdin

Los metadatos completos se proporcionan como JSON en stdin. En el siguiente ejemplo, se muestra la estructura:

{
  "jobName": "My Render Job",
  "priority": 50,
  "farmId": "farm-abc123",
  "queueId": "queue-def456",
  "jobBundleDir": "/path/to/bundle",
  "parameters": {"SceneFile": "/path/to/scene.ma"},
  "submitterName": "Maya",
  "assetReferences": {
    "inputFilenames": ["/path/to/texture.exr"],
    "inputDirectories": [],
    "outputDirectories": ["/path/to/output"],
    "referencedPaths": []
  },
  "submissionPayload": {}
}

Seguridad

Los ganchos están deshabilitados de forma predeterminada. Cada fuente de ganchos tiene su propia configuración que debes activar.

Habilitar paquetes de ganchos

Para permitir que los ganchos estén definidos hooks.yaml en los paquetes de trabajos, habilite la configuración de los ganchos de paquete.

Habilitar los ganchos del entorno

Para permitir los enlaces desde un directorio especificado porDEADLINE_HOOKS_DIR, habilite la configuración de ganchos del entorno y establezca la ruta del directorio.

Pregunta de confirmación

Al habilitar los enlaces, el remitente le pide que los confirme antes de que se ejecuten los enlaces. Pre-GUI Los ganchos muestran el mensaje antes de que se abra el cuadro de diálogo. Pre-submission y los ganchos posteriores al envío muestran el mensaje al seleccionar Enviar.

El mensaje muestra qué comandos se ejecutarán, lo que te permitirá revisarlos antes de continuar:

This job bundle contains submission hooks that will execute on your machine:

  Pre-GUI hooks:
    [1] python3 prefill_from_shotgrid.py

  Pre-submission hooks:
    [1] python3 validate_assets.py

  Post-submission hooks:
    [1] python3 notify.py

  Bundle: /path/to/bundle

Do you want to run these hooks? [Y/n]

Para omitir las solicitudes de confirmación de los CI/automation flujos de trabajo, ejecute el siguiente comando:

deadline config set settings.auto_accept true

Resumen de los ajustes de configuración

Implementación en estudio

Los directores técnicos de Pipeline pueden configurar los enlaces para que se ejecuten automáticamente para todos los artistas mediante la implementación de enlaces de entorno en todas las estaciones de trabajo. Utilice este procedimiento cuando su estudio tenga una ubicación de red compartida para los scripts de enlaces y tenga acceso administrativo para configurar las estaciones de trabajo de los artistas.

Gestión de errores

Cuando se produce un error en un enlace previo al envío o a la interfaz gráfica de usuario, el resultado del error incluye la siguiente información:

El remitente bloquea el envío hasta que resuelvas el problema. Post-submission Los errores de enlace se registran como advertencias, pero no afectan al trabajo enviado.

Prácticas recomendadas

Métodos de envío

Los Hooks funcionan con los siguientes métodos de envío:

La GUI independiente copia hooks.yaml en el paquete del historial de trabajos y resuelve las rutas de los scripts para devolverlas al directorio del paquete original.

Recursos adicionales

Para obtener más información sobre los puntos de integración y los temas relacionados, consulte lo siguiente: