Skip to content
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

Jump to bottom

Fixes #540 - Document Search Endpoint #551

Merged
merged 3 commits into from
Sep 16, 2015
Merged

Fixes #540 - Document Search Endpoint #551

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ba1b317
Fixes #540 - Document Search Endpoint
Sep 15, 2015
5c542a9
Fixes #540 - Document Search Endpoint
Sep 15, 2015
da52288
Fixes #540 - Document Search Endpoint Update
Sep 16, 2015
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
16 changes: 16 additions & 0 deletions docs/docs/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ All examples in this section assume that you've found a running leader at `chron

- [Leaders](#leaders)
- [Listing Jobs](#listing-jobs)
- [Searching for a Job](#searching-for-a-job)
- [Deleting a Job](#deleting-a-job)
- [Deleting All Tasks for a Job](#deleting-all-tasks-for-a-job)
- [Manually Starting a Job](#manually-starting-a-job)
Expand Down Expand Up @@ -49,6 +50,21 @@ Interesting fields in the hashes are:

If there is a `parents` field there will be no `schedule` field, and vice-versa.

## Searching for a Job

Get the job definition by searching for the following attributes by using the search endpoint:

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not all of those attributes are supported by the search, see: https://github.com/mesos/chronos/blob/master/src/main/scala/org/apache/mesos/chronos/scheduler/api/JobManagementResource.scala#L221

The search endpoints accepts the following parameters:

  • name
  • command
  • any (which is quite misleading as it actually means "name or command").

We should also mention how the search works. It will convert both the search term and the desired job attribute to lower case and then check if the job attribute contains the term.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Listed the available attributes and description.

* `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`
* Response: HTTP 204

Search term and the desired job attribute will be converted to lower case. It will then be checked if the job attribute contains the term.

## Deleting a Job

Get a job name from the job listing above.
Expand Down