forked from shotgunsoftware/tk-flame
-
Notifications
You must be signed in to change notification settings - Fork 0
/
info.yml
121 lines (103 loc) · 5.07 KB
/
info.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
# Copyright (c) 2014 Shotgun Software Inc.
#
# CONFIDENTIAL AND PROPRIETARY
#
# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
# Source Code License included in this distribution package. See LICENSE.
# By accessing, using, copying or modifying this work you indicate your
# agreement to the Shotgun Pipeline Toolkit Source Code License. All rights
# not expressly granted therein are reserved by Shotgun Software Inc.
# Metadata defining the behaviour and requirements for this engine
# expected fields in the configuration file for this engine
configuration:
debug_logging:
type: bool
description: Controls whether debug messages should be emitted to the logger
default_value: false
project_switching:
type: bool
description: Hint about the possibility to switch project
default_value: false
project_startup_hook:
type: hook
default_value: "{self}/project_startup.py"
description: Contains the logic for determining and creating the workspace and
users to use when launching into a Flame project.
backburner_hooks:
type: hook
default_value: "{self}/backburner_hooks.py"
description: Contains the Backburner background job logic
flame_batch_publish_type:
type: tank_type
description: The publish type associated with Flame batch scripts. This parameter is used
to help the Flare launch process auto-load a batch script from Shotgun at startup.
default_value: "Flame Batch File"
backburner_manager:
type: str
default_value: ""
description: The host where the backburner manager is located. All backburner
jobs generated by the flame engine will be dispatched to this server.
This setting is only supported on Flame 2016.1 and above. If this
value is not specified, the system default will be used.
backburner_shared_tmp:
type: str
default_value: "/tmp"
description: A folder where the Flame engine can put temporary files. This folder
needs to be accessible from all backburner nodes, so if you are running
a larger backburner setup, this path must be some sort of shared network
location.
backburner_servers:
type: str
default_value: ""
description: Comma separated list of servers to use when submitting a backburner job.
(Ignored if a group is used)
backburner_server_group:
type: str
default_value: ""
description: The group name of the servers to use when submitting a backburner job.
use_builtin_plugin:
type: bool
description: Whether to prepare the launch of Flame to make use of its builtin Toolkit
plugin or not. If false, the classic-style Toolkit integration will be
initialized when Flame is launched.
default_value: False
run_at_startup:
type: list
description: "Controls what apps will run on startup. This is a list where each element
is a dictionary with two keys: 'app_instance' and 'name'. The app_instance
value connects this entry to a particular app instance defined in the
environment configuration file. The name is the menu name of the command
to run when flame starts up. If name is '' then all commands from the
given app instance are started."
allows_empty: True
default_value: []
values:
type: dict
items:
name: { type: str }
app_instance: { type: str }
context_menu:
type: list
description: "Controls the commands that show up in Flame's context menu. This is a list
where each element is a dictionary with three keys: 'app_instance', 'name' and 'display_name'.
The app_instance value connects this entry to a particular app instance defined
in the environment configuration file. The name value is name of the registered command in the
engine. The display_name value is the name that Flame should show in the menu.
If name is '' then all commands from the given app instance are started.
If display_name is not present, name will be used instead"
allows_empty: True
default_value: []
values:
type: dict
items:
name: { type: str }
app_instance: { type: str }
#display_name: { type: str } (optional)
# the Shotgun fields that this engine needs in order to operate correctly
requires_shotgun_fields:
# More verbose description of this item
display_name: "Shotgun Engine for Flame"
description: "Shotgun Integration in Flame"
# Required minimum versions for this item to run
requires_shotgun_version:
requires_core_version: "v0.14.76"