Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Kait pengajuan

Kait pengiriman memungkinkan Anda menjalankan skrip kustom selama alur kerja pengiriman pekerjaan Deadline Cloud. Hooks berjalan secara lokal di workstation yang mengirimkan pekerjaan, sebelum pekerjaan mencapai layanan Deadline Cloud. Kait tidak berjalan pada pekerja atau di AWS Cloud. Karena kait dijalankan pada mesin Anda, mereka memiliki akses ke file lokal, variabel lingkungan, dan sumber daya jaringan yang tersedia untuk pengguna yang mengirimkan.

Anda dapat menggunakan hook untuk memvalidasi konfigurasi pekerjaan, menemukan aset tambahan, memodifikasi parameter pengiriman, atau mengintegrasikan dengan sistem eksternal seperti perangkat lunak pelacak produksi. Untuk poin integrasi lain yang berjalan pada pekerja atau di cloud, lihatKait, acara, dan titik integrasi untuk pekerjaan.

Ada dua cara untuk mengkonfigurasi kait:

Kedua sumber dapat aktif pada saat yang bersamaan. Saat keduanya ada, kait lingkungan berjalan lebih dulu, lalu kait bundel.

Jenis kait

Deadline Cloud mendukung tiga jenis hook yang sesuai dengan poin berbeda dalam alur kerja pengiriman.

Pre-GUI kait

Pre-GUI hook berjalan sebelum dialog pengiriman terbuka. Anda dapat menggunakan kait pra-GUI untuk tugas-tugas berikut:

Pre-GUI kait memblokir dialog agar tidak terbuka jika gagal (kode keluar bukan nol atau batas waktu).

Output JSON ke stdout untuk memodifikasi status dialog awal. Contoh berikut menunjukkan format output:

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

Tabel berikut menjelaskan bidang output untuk kait pra-GUI.

Tabel berikut menjelaskan properti pekerjaan bersama yang dapat Anda atur dengan deadline: awalan di parameters objek.

Pre-submission kait

Pre-submission kait dijalankan sebelum lampiran pekerjaan di-hash dan diunggah. Anda dapat menggunakan kait pra-pengiriman untuk tugas-tugas berikut:

Pre-submission hook memblokir pengiriman jika gagal (kode keluar bukan nol atau batas waktu).

Output JSON ke stdout untuk memodifikasi kiriman. Output hook menggantikan referensi aset pada level kunci bersarang. Jika output hook AndainputFilenames, output hook menggantikan seluruh inputFilenames daftar. Deadline Cloud mempertahankan kunci yang tidak Anda sertakan dalam output Anda.

Contoh berikut menambahkan file tekstur yang ditemukan ke kiriman:

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 hook juga dapat memodifikasi nilai parameter template pekerjaan dengan memancarkan parameters peta di stdout:

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

Kunci parameter adalah nama parameter template pekerjaan. Nilai dari hook diterapkan di atas nilai parameter bundel, tetapi CLI-supplied --parameter nilai masih diutamakan daripada yang disediakan kait.

Post-submission kait

Post-submission hook berjalan setelah panggilan CreateJob API berhasil kembali. Pekerjaan telah diterima oleh Deadline Cloud pada saat ini. Anda dapat menggunakan kait pasca-pengiriman untuk tugas-tugas berikut:

Post-submission kegagalan hook dicatat sebagai peringatan tetapi tidak mempengaruhi pekerjaan yang dikirimkan.

Konfigurasikan kait pengiriman

Tentukan kait dalam hooks.json file hooks.yaml atau. Tempatkan file di direktori bundel pekerjaan Anda di sampingtemplate.yaml, atau di direktori yang ditentukan olehDEADLINE_HOOKS_DIR. Jika kedua format ada di direktori yang sama, pengirim melaporkan kesalahan.

versionBidang diperlukan dan harus"1.0".

Contoh berikut menunjukkan hooks.yaml konfigurasi:

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

Bidang definisi kait

Setiap entri hook menerima bidang berikut.

Resolusi jalur

Skrip kait diselesaikan sesuai dengan aturan berikut:

Masukan kait

Hooks menerima metadata pekerjaan melalui JSON di stdin dan melalui variabel lingkungan kenyamanan.

Variabel-variabel lingkungan

Variabel lingkungan berikut tersedia untuk semua kait.

JSON di stdin

Metadata lengkap disediakan sebagai JSON di stdin. Contoh berikut menunjukkan struktur:

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

Keamanan

Kait dinonaktifkan secara default. Setiap sumber kait memiliki pengaturannya sendiri yang harus Anda aktifkan.

Mengaktifkan kait bundel

Untuk mengizinkan kait yang ditentukan di hooks.yaml dalam bundel pekerjaan, aktifkan pengaturan kait bundel.

Mengaktifkan kait lingkungan

Untuk mengizinkan kait dari direktori yang ditentukan olehDEADLINE_HOOKS_DIR, aktifkan pengaturan kait lingkungan dan atur jalur direktori.

Prompt konfirmasi

Saat Anda mengaktifkan kait, pengirim meminta Anda untuk mengonfirmasi sebelum kait dijalankan. Pre-GUI kait menunjukkan prompt sebelum dialog terbuka. Pre-submission dan kait pasca-pengiriman menunjukkan prompt saat Anda memilih Kirim.

Prompt menunjukkan perintah mana yang akan dijalankan, memungkinkan Anda untuk meninjau sebelum melanjutkan:

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]

Untuk melewati konfirmasi konfirmasi CI/automation alur kerja, jalankan perintah berikut:

deadline config set settings.auto_accept true

Ringkasan pengaturan konfigurasi

Penyebaran studio

Direktur teknis pipeline dapat mengonfigurasi kait agar berjalan secara otomatis untuk semua artis dengan menerapkan kait lingkungan di seluruh workstation. Gunakan prosedur ini ketika studio Anda memiliki lokasi jaringan bersama untuk skrip hook dan Anda memiliki akses administratif untuk mengonfigurasi workstation artis.

Penanganan kesalahan

Ketika pengait pra-pengiriman atau pra-GUI gagal, output kesalahan mencakup informasi berikut:

Pengirim memblokir pengiriman sampai Anda menyelesaikan masalah. Post-submission kegagalan hook dicatat sebagai peringatan tetapi tidak mempengaruhi pekerjaan yang dikirimkan.

Praktik terbaik

Metode pengiriman

Hooks bekerja dengan metode pengiriman berikut:

GUI mandiri menyalin hooks.yaml ke bundel riwayat pekerjaan dan menyelesaikan jalur skrip kembali ke direktori bundel asli Anda.

Sumber daya tambahan

Untuk informasi selengkapnya tentang titik integrasi dan topik terkait, lihat berikut ini: