Skip to content

main

Main settings for USD on AYON server.

AppPlatformURIModel

Bases: BaseSettingsModel

Application platform URI model.

Source code in server/settings/main.py 
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
class AppPlatformURIModel(BaseSettingsModel):
    """Application platform URI model."""

    _layout = "expanded"
    app_name: str = SettingsField(
        title="Application",
        description="Application name",
        enum_resolver=apps_enum,
    )
    # TODO: we need to take into account here different linux flavors
    platform: str = SettingsField(
        title="Platform",
        enum_resolver=platform_enum,
        description="windows / linux / darwin",
    )
    uri: str = SettingsField(
        title="Repository Object URI",
        description=(
            "Path to USD Asset Resolver plugin zip file on the LakeFs server, "
            "e.g: `lakefs://ayon-usd/V001/AyonUsdResolverBin/Hou/ayon-usd-resolver_hou19.5_linux_py37.zip`"  # noqa
        ),
    )

AyonResolverSettings

Bases: BaseSettingsModel

AYON USD resolver Settings

Source code in server/settings/main.py 
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
class AyonResolverSettings(BaseSettingsModel):
    """AYON USD resolver Settings"""

    _layout = "collapsed"

    ayon_log_lvl: str = SettingsField(
        "WARN",
        title="Resolver Log Level",
        enum_resolver=log_lvl_enum,
        description="Set verbosity of the AyonUsdResolver logger",
    )
    ayon_file_logger_enabled: str = SettingsField(
        "OFF",
        title="Resolver File Logger Enabled ",
        enum_resolver=file_logger_enum,
        description="Enable or disable AyonUsdResolver file logger",
    )
    file_logger_file_path: str = SettingsField(
        "",
        title="Resolver File logger file path",
        description=(
            "Allows you to set a custom location where the file logger will "
            "export to. This can be a relative or absolute path. This is only "
            "used if `ayon_file_logger_enabled` is enabled."
        ),
    )
    ayon_logger_logging_keys: str = SettingsField(
        "",
        title="AyonCppApi Logging Keys",
        enum_resolver=logger_logging_keys_enum,
        description="List of extra logging options for the AyonCppApi",
    )

BinaryDistributionSettings

Bases: BaseSettingsModel

Binary distribution of USD and AYON USD Resolver

Source code in server/settings/main.py 
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
class BinaryDistributionSettings(BaseSettingsModel):
    """Binary distribution of USD and AYON USD Resolver"""

    _layout = "collapsed"

    enabled: bool = SettingsField(False)
    type: str = SettingsField(
        title="Distribution type",
        enum_resolver=_binary_distribution_enum,
        conditional_enum=True,
        default="lake_fs",
    )
    lake_fs: LakeFSDistributionSettings = SettingsField(
        default_factory=LakeFSDistributionSettings,
        title="LakeFS Distribution Settings",
    )
    local: LocalBinaryDistributionSettings = SettingsField(
        default_factory=LocalBinaryDistributionSettings,
        title="Local Distribution Settings",
    )

LakeFSDistributionSettings

Bases: BaseSettingsModel

Settings specific to LakeFS distribution of USD binaries.

Source code in server/settings/main.py 
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
class LakeFSDistributionSettings(BaseSettingsModel):
    """Settings specific to LakeFS distribution of USD binaries."""

    server_uri: str = SettingsField(
        "https://lake.ayon.cloud",
        title="Server URL",
        description="The URL for the USD binary distribution LakeFs "
                    "server. It's recommended to keep the default "
                    "value to use the USD builds we provide.",
    )
    server_repo: str = SettingsField(
        "lakefs://ayon-usd/v1.2.1/",
        title="Repository URI",
        description="The repository tag or branch URI within the LakeFs server.",
    )
    access_key_id: str = SettingsField(
        "{AYON_Distribution_Key_Id}",
        title="Access Key ID",
        description="The LakeFs server access key ID.",
    )
    secret_access_key: str = SettingsField(
        "{AYON_Distribution_Access_Key}",
        title="Secret Access Key",
        description="The LakeFs server secret access key.",
    )

    asset_resolvers: list[AppPlatformPathModel] = SettingsField(
        title="Resolver Application Paths",
        description="Allows an admin to define a specific Resolver Zip for a specific Application",
        default=[
            AppPlatformPathModel(
                name="maya/2024",
                platform="linux",
                lake_fs_path="AyonUsdResolverBin/MayaLinux/Maya2024_2_Py310_Linux_Linux_x86_64.zip",
            ),
            AppPlatformPathModel(
                name="maya/2024",
                platform="windows",
                lake_fs_path="AyonUsdResolverBin/MayaWin/Maya2024_2_Py310_Win_Windows_AMD64.zip",
            ),
            AppPlatformPathModel(
                name="maya/2025",
                platform="linux",
                lake_fs_path="AyonUsdResolverBin/MayaLinux/Maya2025_Py311_Linux_Linux_x86_64.zip",
            ),
            AppPlatformPathModel(
                name="maya/2025",
                platform="windows",
                lake_fs_path="AyonUsdResolverBin/MayaWin/Maya2025_Py311_Win_Windows_AMD64.zip",
            ),
            AppPlatformPathModel(
                name="maya/2026",
                platform="linux",
                lake_fs_path="AyonUsdResolverBin/MayaLinux/Maya2026_Py311_Linux_Linux_x86_64.zip",
            ),
            AppPlatformPathModel(
                name="maya/2026",
                platform="windows",
                lake_fs_path="AyonUsdResolverBin/MayaWin/Maya2026_Py311_Win_Windows_AMD64.zip",
            ),
            AppPlatformPathModel(
                name="houdini/19-5Py37",
                platform="linux",
                lake_fs_path="AyonUsdResolverBin/HouLinux/Houdini195_Py37_Linux_Linux_x86_64.zip",
            ),
            AppPlatformPathModel(
                name="houdini/19-5",
                platform="linux",
                lake_fs_path="AyonUsdResolverBin/HouLinux/Houdini195_Py39_Linux_Linux_x86_64.zip",
            ),
            AppPlatformPathModel(
                name="houdini/19-5Py37",
                platform="windows",
                lake_fs_path="AyonUsdResolverBin/HouWin/Houdini195_Py37_Win_Windows_AMD64.zip",
            ),
            AppPlatformPathModel(
                name="houdini/19-5",
                platform="windows",
                lake_fs_path="AyonUsdResolverBin/HouWin/Houdini195_Py39_Win_Windows_AMD64.zip",
            ),
            AppPlatformPathModel(
                name="houdini/20-0",
                platform="linux",
                lake_fs_path="AyonUsdResolverBin/HouLinux/Houdini20_Py310_Linux_Linux_x86_64.zip",
            ),
            AppPlatformPathModel(
                name="houdini/20-0Py39",
                platform="linux",
                lake_fs_path="AyonUsdResolverBin/HouLinux/Houdini20_Py39_Linux_Linux_x86_64.zip",
            ),
            AppPlatformPathModel(
                name="houdini/20-0",
                platform="windows",
                lake_fs_path="AyonUsdResolverBin/HouWin/Houdini20_Py310_Win_Windows_AMD64.zip",
            ),
            AppPlatformPathModel(
                name="houdini/20-0Py39",
                platform="windows",
                lake_fs_path="AyonUsdResolverBin/HouWin/Houdini20_Py39_Win_Windows_AMD64.zip",
            ),
            AppPlatformPathModel(
                name="houdini/20-5",
                platform="linux",
                lake_fs_path="AyonUsdResolverBin/HouLinux/Houdini205_Py311_Linux_Linux_x86_64.zip",
            ),
            AppPlatformPathModel(
                name="houdini/20-5Py310",
                platform="linux",
                lake_fs_path="AyonUsdResolverBin/HouLinux/Houdini205_Py310_Linux_Linux_x86_64.zip",
            ),
            AppPlatformPathModel(
                name="houdini/21-0",
                platform="linux",
                lake_fs_path="AyonUsdResolverBin/HouLinux/Houdini21_Py311_Linux_Linux_x86_64.zip",
            ),
            AppPlatformPathModel(
                name="houdini/22-0",
                platform="linux",
                lake_fs_path="AyonUsdResolverBin/HouLinux/Houdini22_Py313_Linux_Linux_x86_64.zip",
            ),
            AppPlatformPathModel(
                name="houdini/20-5",
                platform="windows",
                lake_fs_path="AyonUsdResolverBin/HouWin/Houdini205_Py311_Win_Windows_AMD64.zip",
            ),
            AppPlatformPathModel(
                name="houdini/20-5Py310",
                platform="windows",
                lake_fs_path="AyonUsdResolverBin/HouWin/Houdini205_Py310_Win_Windows_AMD64.zip",
            ),
            AppPlatformPathModel(
                name="houdini/21-0",
                platform="windows",
                lake_fs_path="AyonUsdResolverBin/HouWin/Houdini21_Py311_Win_Windows_AMD64.zip",
            ),
            AppPlatformPathModel(
                name="houdini/22-0",
                platform="windows",
                lake_fs_path="AyonUsdResolverBin/HouWin/Houdini22_Py313_Win_Windows_AMD64.zip",
            ),
            AppPlatformPathModel(
                name="unreal/5-4",
                platform="windows",
                lake_fs_path="AyonUsdResolverBin/UnrealWin/Unreal5_4_Py39_Win_Windows_AMD64.zip",
            ),
        ],
    )
    lake_fs_overrides: list[AppPlatformURIModel] = SettingsField(
        title="Resolver Application Overrides",
        description=(
            "Allows to define a specific Resolver Zip for a specific Application"
        ),
        default_factory=list,
    )

LocalBinaryDistributionSettings

Bases: BaseSettingsModel

Settings for using a locally stored resolver binary distribution

Source code in server/settings/main.py 
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
class LocalBinaryDistributionSettings(BaseSettingsModel):
    """Settings for using a locally stored resolver binary distribution"""

    roots: list[ResolverRootModel] = SettingsField(
        title="Resolver Roots",
        description="Define named root paths usable as '{resolver_root}' in resolver paths.",
        default_factory=list,
    )
    asset_resolvers: list[LocalResolverPathModel] = SettingsField(
        title="Resolver Paths",
        description=(
            "Local filesystem paths to pre-installed resolver binaries."
        ),
        default_factory=list,
    )

LocalResolverPathModel

Bases: BaseSettingsModel

Local filesystem path to a pre-installed resolver.

Source code in server/settings/main.py 
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
class LocalResolverPathModel(BaseSettingsModel):
    """Local filesystem path to a pre-installed resolver."""

    _layout = "collapsed"
    name: str = SettingsField(
        title="Application",
        description="Application name",
        enum_resolver=apps_enum,
    )
    app_alias_list: list[str] = SettingsField(
        title="Application Alias",
        description="Define a list of App Names that use the same "
        "resolver as the parent application",
        default_factory=list,
    )
    platform: str = SettingsField(
        title="Platform",
        enum_resolver=platform_enum,
        description="windows / linux / darwin",
    )
    path: str = SettingsField(
        title="Resolver Directory Path",
        description=(
            "Local filesystem path to the resolver directory "
            "(the directory containing `ayonUsdResolver/`)"
        ),
    )

ResolverRootModel

Bases: BaseSettingsModel

Model for defining root paths for resolver search.

Source code in server/settings/main.py 
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
class ResolverRootModel(BaseSettingsModel):
    """Model for defining root paths for resolver search."""

    _layout = "expanded"

    name: str = SettingsField(
        ...,
        title="Root Name",
        description="Name of the root, e.g. 'resolver_root'",
        example="resolver_root",
    )
    windows: str = SettingsField(
        "",
        title="Windows",
        description="Path to use on Windows hosts.",
    )
    linux: str = SettingsField(
        "",
        title="Linux",
        description="Path to use on Linux hosts.",
    )
    darwin: str = SettingsField(
        "",
        title="Darwin",
        description="Path to use on macOS hosts.",
    )

UsdLibConfigSettings

Bases: BaseSettingsModel

Settings for USD

Source code in server/settings/main.py 
418
419
420
421
422
423
424
425
426
class UsdLibConfigSettings(BaseSettingsModel):
    """Settings for USD"""

    _layout = "collapsed"
    usd_tf_debug: str = SettingsField(
        "",
        title="Tf Debug Variable for Debugging USD",
        description="",
    )

file_logger_enum()

Return enumerator to enable or disable the file logger.

Source code in server/settings/main.py 
50
51
52
53
54
55
def file_logger_enum():
    """Return enumerator to enable or disable the file logger."""
    return [
        {"label": "Off", "value": "OFF"},
        {"label": "On", "value": "ON"},
    ]

log_lvl_enum()

Return enumerator for supported log levels.

Source code in server/settings/main.py 
38
39
40
41
42
43
44
45
46
def log_lvl_enum():
    """Return enumerator for supported log levels."""
    return [
        {"label": "Info", "value": "INFO"},
        {"label": "Error", "value": "ERROR"},
        {"label": "Warn", "value": "WARN"},
        {"label": "Critical", "value": "CRITICAL"},
        {"label": "Off", "value": "OFF"},
    ]

logger_logging_keys_enum()

Return enumerator for AyonCpp Logging Keys.

Source code in server/settings/main.py 
27
28
29
30
31
32
33
34
def logger_logging_keys_enum():
    """Return enumerator for AyonCpp Logging Keys."""
    return [
        {"label": "Off", "value": ""},
        {"label": "Api Debug", "value": "AyonApi/"},
        {"label": "Env Debug", "value": "AyonApiDebugEnvVars/"},
        {"label": "All", "value": "AyonApi/AyonApiDebugEnvVars/"},
    ]

platform_enum()

Return enumerator for supported platforms.

Source code in server/settings/main.py 
18
19
20
21
22
23
24
def platform_enum():
    """Return enumerator for supported platforms."""
    return [
        {"label": "Windows", "value": "windows"},
        {"label": "Linux", "value": "linux"},
        {"label": "MacOS", "value": "darwin"},
    ]