Skip to content

[docs:api] add clarity around values available for constraints #556

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 7, 2015
Merged

[docs:api] add clarity around values available for constraints #556

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion docs/docs/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ All examples in this section assume that you've found a running leader at `chron
- [Obtaining Remote Executables](#obtaining-remote-executables)
- [Job Configuration](#job-configuration)
- [Sample Job](#sample-job)
- [Constraints](#constraints)


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

## Constraints

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).
(i.e. the `hostname` attribute is not currently automatically available for constraints [as it is in Marathon](https://mesosphere.github.io/marathon/docs/constraints))

### EQUALS constraint

Schedule a job on nodes that share a common attribute.
Expand Down