| Field | Type | Description |
|---|---|---|
| include | string[]? | A list of file paths relative to the module file that should be downloaded alongside the module |
| modules | map<string, ModuleRef>? | A list of file paths relative to the module that should be downloaded alongside the module |
| network | NetworkConfig? | Network config for the module |
| networks | map? | A docker-compose networks snippet. |
| volumes | map? | A docker-compose volumes snippet. |
| containers | map? | A docker-compose services snippet. |
| Field | Type | Description |
|---|---|---|
| url | string | The github repo identifier of a remote module in the form <owner>/<repo>. Currently this is the only supported value but in future this will be expanded to support additional remote sources. |
| ref | string? | A git ref that the remote module should be resolved against. Defaults to the default branch of the repo ormaster |
| sha | string? | An exact sha that should be used instead of dynamically resolving it from a ref. Exclusive with ref. |
| subdir | string? | A directory path within the remote repository that the module config file should be resolved from. Defaults to .kl |
| Field | Type | Description |
|---|---|---|
| services | map<string, Service>? | A set of services defined by the module |
| routes | map<string, Route>? | A set of routes defined by the module |
| Field | Type | Description |
|---|---|---|
| endpoints | map<string, Endpoint> | A set of services defined by the module |
| default-endpoint | string | The name of one of the defined endpoints to which traffic should be routed to by default |
| Field | Type | Description |
|---|---|---|
| url | string | The URL of some HTTP service running somewhere reachable by the proxy container |
| Field | Type | Description |
|---|---|---|
| host | string | The .test domain that should match for this route to be used |
| path-prefix | string? | The subpath of the request that should match for this route to be used. Defaults to / |
| service | string | The name of a defined service that traffic should be routed to when this route matches a request |
| endpoint | string? | The endpoint within the defined service that should be used. Defaults to the default-endpoint on the service |