YAML Specification#

YAML is widely used in Jina to define an Executor, Flow. This page helps you quickly navigate different YAML specifications.

Executor-level YAML#

Executor level YAML is placed inside the Executor directory, as a part of Executor file structure.

Executor YAML

Define the argument of __init__, Python module dependencies and other settings of an Executor.

Flow-level YAML#

Flow level YAML is placed inside the Flow directory, as a part of Flow file structure. It defines the Executors that will be used in the Flow, the Gateway and the JCloud hosting specifications.


Define the Executors, the topology and the Gateway settings of a Flow.

Gateway YAML

Define the protocol, TLS, authentication and other settings of a Gateway.


Define the resources and autoscaling settings on Jina Cloud