Skip to content
This repository has been archived by the owner on Oct 23, 2024. It is now read-only.

Commit

Permalink
adding documentation to yml reference on ranges (#2890)
Browse files Browse the repository at this point in the history
  • Loading branch information
kvish authored Jan 18, 2019
1 parent db6cbf0 commit 3923bf0
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions docs/pages/yaml-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -362,6 +362,29 @@ This documentation effectively reflects the Java object tree under [RawServiceSp

This may be used to define an environment variable used to advertise this port within the task. This is most useful when a random dynamic port is being used, as it allows the task to know what port was allocated for it.

* `ranges`

When requesting a dynamic port, a list of ranges may be passed to to constrain the value of the dynamic port. The range is inclusive of `begin` and `end` when they are set. If `begin` or `end` is not set the range constraint is implicit and unbounded on that side. Ranges may be defined as follows:

```
ports:
name1:
port: 0
env-key: key1
ranges:
- begin: 1
end: 21
- begin: 2000
end: 5050
name2:
port: 0
ranges:
- begin:
end: 21
- begin: 5000
end:
```

* `advertise`

This may be manually set to `true` to enable advertising this port in the service's `endpoints` listing. Default is `false`.
Expand Down

0 comments on commit 3923bf0

Please sign in to comment.