Back to Serve

{octicon}`file-code` YAML specification

docs/concepts/serving/executor/deployment-yaml-spec.md

3.34.0640 B
Original Source

(deployment-yaml-spec)=

{octicon}file-code YAML specification

To generate a YAML configuration from a {class}~jina.Deployment Python object, use {meth}~jina.Deployment.save_config.

Example YAML

yaml
jtype: Deployment
with:
  replicas: 2
  uses: jinaai+docker://jina-ai/CLIPEncoder

Fields

jtype

String that is always set to "Deployment", indicating the corresponding Python class.

with

Keyword arguments are passed to a Deployment's __init__() method. You can pass your Deployment settings here:

Arguments

{include}
{include}