Tye

Tye configuration files

Type object
File match tye.yaml tye.yml
Schema URL https://catalog.lintel.tools/schemas/schemastore/tye/latest.json
Source https://raw.githubusercontent.com/dotnet/tye/main/src/schema/tye-schema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Configuration file schema for Tye.

Properties

services object[] required

The application's services.

minItems=1
name string

The application name.

registry string

Dockerhub username or hostname of remote registry. Used for tagging images.

containerEngine string

Container engine.

Values: "docker" "podman"
namespace string

The Kubernetes namespace to use.

network string

The Docker network to use.

dashboardPort integer

Configure the dashboard port used for tye run. Can be overridden using the --port CLI argument, and falls back to port 8000 if free, or a random port if 8000 is in use.

ingress ingress[]

The application's ingresses.

minItems=1
extensions extension[]

Extensions to be added to tye.

solution string

Indicates the solution file (.sln) or filter (.slnf) to use when building project-based services in watch mode. If omitted, those services will be built individually. Specifying the solution [filter] can help reduce repeated builds of shared libraries when in watch mode.

Definitions

binding object
name string

The binding name.

port integer

The binding port.

containerPort integer

The port used when running inside a container.

host string

The hostname for the binding.

protocol string

The protocol used by the binding

autoAssignPort boolean

Whether to auto-assign a port value.

Default: false
connectionString string

The connection string.

env-var object
name string required

Environment variable name.

value string required

Environment variable value.

build-property object
name string required

Build property name.

value string required

Build property name.

volume object
target string required

The destination path within the container.

name string

A named volume.

source string

The local path.

azureFunction object
name string required

The service name. Must be unique per-application.

azureFunction string required

The directory path to the azure function.

env env-var[]

Environment variables to use when launching.

args string

Command-line arguments to use when launching.

replicas integer

Number of service replicas to create.

bindings binding[]

The bindings provided by the service.

pathToFunc string

Optional path to the function host to be used when launching functions. Can point to either func.dll or the binary.

executable object
name string required

The service name. Must be unique per-application.

executable string required

The file path (or file name if on the system path) of an executable.

workingDirectory string

The working directory to use when launching.

env env-var[]

Environment variables to use when launching.

args string

Command-line arguments to use when launching.

replicas integer

Number of service replicas to create.

bindings binding[]

The bindings provided by the service.

external object
name string

The service name. Must be unique per-application.

external boolean

Designates as service as external. External services will not be launched and can only provide bindings.

Constant: true
bindings binding[]

The bindings provided by the service.

repository object
name string required

The service name. Must be unique per-application.

repository string required

The repository url which will be cloned.

cloneDirectory string

The directory to clone the repository into.

include object
name string required

The service name. Must be unique per-application.

include string required

Path to tye.yaml file which will be used in the application.

image object
name string required

The service name. Must be unique per-application.

image string required

The name of a Docker image.

volumes volume[]

Volumes to mount to the container.

env env-var[]

Environment variables to use when launching.

args string

Command-line arguments to use when launching.

replicas integer

Number of service replicas to create.

bindings binding[]

The bindings provided by the service.

dockerFile object
name string required

The service name. Must be unique per-application.

dockerFile string required

The Dockerfile to use.

volumes volume[]

Volumes to mount to the container.

dockerFileArgs object[]

Build arguments to use when building the image.

dockerFileContext string

The Dockerfile context to run docker build on.

env env-var[]

Environment variables to use when launching.

args string

Command-line arguments to use when launching.

replicas integer

Number of service replicas to create.

bindings binding[]

The bindings provided by the service.

ingress object
name string

The ingress name.

bindings ingress-binding[]

Bindings for the ingress in local development.

rules ingress-rule[]

Rules for ingress routing.

ingress-binding object
name string

The binding name.

port integer

The binding port.

protocol string

The protocol used by the binding

ip string

The ip address the ingress listens on.

ingress-rule object
service string required

The service to route traffic when the rule matches.

path string

The path prefix to match.

host string

The hostname to match.

preservePath boolean

Whether to keep the path that was originally present or not after a prefix match.

project object
name string required

The service name. Must be unique per-application.

project string required

The relative path to a .NET project file.

env env-var[]

Environment variables to use when launching.

buildProperties build-property[]

Build properties to use when launching or building a project.

args string

Command-line arguments to use when launching.

build boolean

Whether to build the project.

replicas integer

Number of service replicas to create.

bindings binding[]

The bindings provided by the service.

extension object
name string required

Extension name.