From baad3fc461c53378760821cf4601f2972782ae22 Mon Sep 17 00:00:00 2001 From: Ryan Nowak Date: Thu, 7 May 2020 13:04:56 -0700 Subject: [PATCH] Add docker network to docs --- docs/reference/schema.md | 7 +++++++ src/schema/tye-schema.json | 4 ++++ 2 files changed, 11 insertions(+) diff --git a/docs/reference/schema.md b/docs/reference/schema.md index da60a196..1d979e9e 100644 --- a/docs/reference/schema.md +++ b/docs/reference/schema.md @@ -47,6 +47,7 @@ services: name: myapplication registry: exampleuser namespace: examplenamespace +network: examplenetwork services: ``` @@ -77,6 +78,12 @@ The namespace specified in `tye.yaml` can be overridden at the command line. > :bulb: Use `kubectl config view --minify --output 'jsonpath={..namespace}'` to view the current namespace. +#### `network` (string) + +Allows configuring the Docker network used for `tye run`. + +If a network is configured, then all services running in containers will connect to the specified network. Otherwise a Docker network will be created with a generated name, and used to connect all containers. + #### `services` (`Service[]`) *required* Specifies the list of services. Applications must have at least one service. diff --git a/src/schema/tye-schema.json b/src/schema/tye-schema.json index 5038bdeb..ecb14c06 100644 --- a/src/schema/tye-schema.json +++ b/src/schema/tye-schema.json @@ -17,6 +17,10 @@ "description": "The Kubernetes namespace to use.", "type": "string" }, + "network": { + "description": "The Docker network to use.", + "type": "string" + }, "services": { "description": "The application's services.", "type": "array",