Skip to content

Commit 74923d3

Browse files
authored
docs: Document route options in manifest schema (#4425)
1 parent cc006c0 commit 74923d3

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
@@ -141,7 +144,16 @@ will be updated for any existing route mapping.
141144
Name | Type | Description
142145
---- | ---- | -----------
143146
**route** | _string_ | **(Required)** The route URI. Example: `host.domain.com`
144-
**protocol** | _string_ | Protocol to use for this route. Valid protocols are `http1`, `http2`, and `tcp`.
147+
**protocol** | _string_ | Protocol to use for this route. Valid protocols are `http1`, `http2`, and `tcp`
148+
**options** | _object_ | A key-value mapping of configuration [options](#space-manifest-per-route-options-level-configuration) to be applied to the specific application route
149+
150+
#### <a name="space-manifest-per-route-options-level-configuration"></a> Per-Route Options-level configuration
151+
This configuration allows additional key-value options for the specific application route.
152+
153+
Name | Type | Description
154+
---- | ---- | -----------
155+
**loadbalancing** | _string_ | The load-balancer associated with this route. Valid values are `round-robin` and `least-connection`
156+
145157

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

0 commit comments

Comments
 (0)