Skip to content

Commit 4d4e37a

Browse files
committed
Merge pull request #556 from tony-kerz/master
[docs:api] add clarity around values available for constraints
2 parents 67b6097 + a8026ba commit 4d4e37a

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

docs/docs/api.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ All examples in this section assume that you've found a running leader at `chron
2323
- [Obtaining Remote Executables](#obtaining-remote-executables)
2424
- [Job Configuration](#job-configuration)
2525
- [Sample Job](#sample-job)
26+
- [Constraints](#constraints)
2627

2728

2829
## Leaders
@@ -57,7 +58,7 @@ Get the job definition by searching for the following attributes by using the se
5758
* `name`: Name of a job.
5859
* `command`: Command to execute.
5960
* `any`: Search term contained in `name` or `command`.
60-
*
61+
*
6162
* Endpoint: __/scheduler/jobs/search__
6263
* Method: __GET__
6364
* Example: `curl -L -X GET chronos-node:8080/scheduler/jobs/search?name=request_event_counter_hourly`
@@ -386,6 +387,9 @@ When specifying the `command` field in your job hash, use `url-runner.bash` (mak
386387

387388
## Constraints
388389

390+
These constraints will currently only work against attributes that are specifically set on the Mesos slaves [as described in the Mesos documentation](http://mesos.apache.org/documentation/latest/configuration).
391+
(i.e. the `hostname` attribute is not currently automatically available for constraints [as it is in Marathon](https://mesosphere.github.io/marathon/docs/constraints))
392+
389393
### EQUALS constraint
390394

391395
Schedule a job on nodes that share a common attribute.

0 commit comments

Comments
 (0)