Browse Source

Add docker network to docs

jkotalik/porter
Ryan Nowak 6 years ago
committed by Justin Kotalik
parent
commit
baad3fc461
  1. 7
      docs/reference/schema.md
  2. 4
      src/schema/tye-schema.json

7
docs/reference/schema.md

@ -47,6 +47,7 @@ services:
name: myapplication name: myapplication
registry: exampleuser registry: exampleuser
namespace: examplenamespace namespace: examplenamespace
network: examplenetwork
services: 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. > :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* #### `services` (`Service[]`) *required*
Specifies the list of services. Applications must have at least one service. Specifies the list of services. Applications must have at least one service.

4
src/schema/tye-schema.json

@ -17,6 +17,10 @@
"description": "The Kubernetes namespace to use.", "description": "The Kubernetes namespace to use.",
"type": "string" "type": "string"
}, },
"network": {
"description": "The Docker network to use.",
"type": "string"
},
"services": { "services": {
"description": "The application's services.", "description": "The application's services.",
"type": "array", "type": "array",

Loading…
Cancel
Save