Skip to content

Commit afa7a7d

Browse files
committed
docs: Document route options in manifest schema
1 parent 0be697a commit afa7a7d

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

docs/v3/source/includes/resources/manifests/_object.md.erb

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,9 @@ applications:
2828
- route: route.example.com
2929
- route: another-route.example.com
3030
protocol: http2
31+
- route: route-with-options.example.com
32+
options:
33+
loadbalancing: least-connection
3134
services:
3235
- my-service1
3336
- my-service2
@@ -139,7 +142,16 @@ will be updated for any existing route mapping.
139142
Name | Type | Description
140143
---- | ---- | -----------
141144
**route** | _string_ | **(Required)** The route URI. Example: `host.domain.com`
142-
**protocol** | _string_ | Protocol to use for this route. Valid protocols are `http1`, `http2`, and `tcp`.
145+
**protocol** | _string_ | Protocol to use for this route. Valid protocols are `http1`, `http2`, and `tcp`
146+
**options** | _object_ | A key-value mapping of configuration [options](#space-manifest-per-route-options-level-configuration) to be applied to the specific application route
147+
148+
#### <a name="space-manifest-per-route-options-level-configuration"></a> Per-Route Options-level configuration
149+
This configuration allows additional key-value options for the specific application route.
150+
151+
| Name | Type | Description |
152+
|-------------------|----------|-----------------------------------------------------------------------------------------------------|
153+
| **loadbalancing** | _string_ | The load-balancer associated with this route. Valid values are ‘round-robin’ and ‘least-connection’ |
154+
143155

144156
#### <a name="space-manifest-service-level-configuration"></a> Service-level configuration
145157
This configuration is _creating_ new service bindings between the app and a service instance. The `services` field can

0 commit comments

Comments
 (0)