Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Crochets de soumission

Les hooks de soumission vous permettent d'exécuter des scripts personnalisés pendant le flux de travail de soumission des tâches de Deadline Cloud. Les hooks s'exécutent localement sur le poste de travail qui soumet la tâche, avant que celle-ci n'atteigne le service Deadline Cloud. Les Hooks ne s'exécutent pas sur les ordinateurs de bureau ou dans le AWS cloud. Comme les hooks s'exécutent sur votre machine, ils ont accès aux fichiers locaux, aux variables d'environnement et aux ressources réseau disponibles pour l'utilisateur soumissionnaire.

Vous pouvez utiliser des hooks pour valider les configurations des tâches, découvrir des actifs supplémentaires, modifier les paramètres de soumission ou intégrer des systèmes externes tels que des logiciels de suivi de production. Pour les autres points d'intégration qui s'exécutent sur des serveurs ou dans le cloud, consultezHooks, événements et points d'intégration pour les jobs.

Il existe deux manières de configurer les hooks :

Les deux sources peuvent être actives en même temps. Lorsque les deux sont présents, les hooks d'environnement s'exécutent en premier, puis les bundles hooks.

Types d'hameçons

Deadline Cloud prend en charge trois types de crochets correspondant à différents points du flux de travail de soumission.

Pre-GUI crochets

Pre-GUI les hooks s'exécutent avant l'ouverture de la boîte de dialogue de soumission. Vous pouvez utiliser des hooks pré-GUI pour les tâches suivantes :

Pre-GUI les crochets bloquent l'ouverture de la boîte de dialogue en cas d'échec (code de sortie différent de zéro ou délai d'attente).

Expédiez le JSON vers stdout pour modifier l'état initial du dialogue. L'exemple suivant montre le format de sortie :

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))

Le tableau suivant décrit les champs de sortie pour les hooks pré-GUI.

Le tableau suivant décrit les propriétés de travail partagées que vous pouvez définir à l'aide du deadline: préfixe de l'parametersobjet.

Pre-submission crochets

Pre-submission les hooks s'exécutent avant que les pièces jointes aux tâches ne soient hachées et téléchargées. Vous pouvez utiliser des crochets de pré-soumission pour les tâches suivantes :

Pre-submission les hooks bloquent la soumission en cas d'échec (code de sortie ou délai d'attente différent de zéro).

Expédiez le JSON vers stdout pour modifier la soumission. La sortie hook remplace les références aux actifs au niveau des clés imbriquées. Si votre hook sortinputFilenames, la sortie hook remplace la inputFilenames liste complète. Deadline Cloud préserve les clés que vous n'incluez pas dans votre sortie.

L'exemple suivant ajoute les fichiers de texture découverts à la soumission :

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 les hooks peuvent également modifier les valeurs des paramètres du modèle de tâche en émettant une parameters carte sur stdout :

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

Les clés de paramètres sont des noms de paramètres de modèles de tâches. Les valeurs d'un hook sont appliquées au-dessus des valeurs des paramètres du bundle, mais CLI-supplied --parameter les valeurs ont toujours la priorité sur celles fournies par le hook.

Post-submission crochets

Post-submission les hooks s'exécutent après le retour réussi de CreateJob l'appel d'API. Le poste a été accepté par Deadline Cloud à ce stade. Vous pouvez utiliser des crochets post-soumission pour les tâches suivantes :

Post-submission les échecs de crochet sont enregistrés sous forme d'avertissements mais n'affectent pas le travail soumis.

Configurer les crochets de soumission

Définissez les crochets dans un hooks.json fichier hooks.yaml or. Placez le fichier dans le répertoire de votre offre de tâches à côté template.yaml ou dans le répertoire spécifié parDEADLINE_HOOKS_DIR. Si les deux formats existent dans le même répertoire, l'expéditeur signale une erreur.

Le version champ est obligatoire et doit l'être"1.0".

L'exemple suivant montre une hooks.yaml configuration :

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/...

Champs de définition du crochet

Chaque entrée de hook accepte les champs suivants.

Résolution du chemin

Les scripts Hook sont résolus conformément aux règles suivantes :

Entrée Hook

Les hooks reçoivent les métadonnées des tâches via JSON sur stdin et via des variables d'environnement pratiques.

Variables d’environnement

Les variables d'environnement suivantes sont disponibles pour tous les hooks.

JSON sur stdin

Les métadonnées complètes sont fournies au format JSON sur stdin. L'exemple suivant illustre la structure :

{
  "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": {}
}

Sécurité

Les Hooks sont désactivés par défaut. Chaque source de hook possède son propre paramètre que vous devez activer.

Activation des bundles hooks

Pour autoriser les hooks définis hooks.yaml dans les ensembles de tâches, activez le paramètre des crochets de bundle.

Crochets liés à un environnement favorable

Pour autoriser les hooks provenant d'un répertoire spécifié parDEADLINE_HOOKS_DIR, activez le paramètre des crochets d'environnement et définissez le chemin du répertoire.

Invite de confirmation

Lorsque vous activez les hooks, l'émetteur vous invite à confirmer avant que les hooks ne s'exécutent. Pre-GUI les crochets affichent l'invite avant l'ouverture de la boîte de dialogue. Pre-submission et les crochets postérieurs à la soumission affichent l'invite lorsque vous sélectionnez Soumettre.

L'invite indique les commandes qui seront exécutées, ce qui vous permet de les vérifier avant de continuer :

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]

Pour ignorer les demandes de confirmation relatives aux CI/automation flux de travail, exécutez la commande suivante :

deadline config set settings.auto_accept true

Récapitulatif des paramètres de configuration

Déploiement en studio

Les directeurs techniques du pipeline peuvent configurer les hooks pour qu'ils s'exécutent automatiquement pour tous les artistes en déployant des hooks d'environnement sur les postes de travail. Utilisez cette procédure lorsque votre studio dispose d'un emplacement réseau partagé pour les scripts Hook et que vous disposez d'un accès administratif pour configurer les postes de travail des artistes.

Gestion des erreurs

Lorsqu'un hook préalable à la soumission ou à l'interface graphique échoue, le résultat d'erreur inclut les informations suivantes :

L'expéditeur bloque la soumission jusqu'à ce que vous résolviez le problème. Post-submission les échecs de crochet sont enregistrés sous forme d'avertissements mais n'affectent pas le travail soumis.

Bonnes pratiques

Méthodes de soumission

Les Hooks fonctionnent avec les méthodes de soumission suivantes :

L'interface graphique autonome copie hooks.yaml les données dans le bundle d'historique des tâches et résout les chemins de script vers le répertoire du bundle d'origine.

Ressources supplémentaires

Pour plus d'informations sur les points d'intégration et les sujets connexes, consultez les rubriques suivantes :