-
Notifications
You must be signed in to change notification settings - Fork 529
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.
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
Fixes #540 - Document Search Endpoint #551
Merged
Merged
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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) | ||
|
@@ -49,6 +50,16 @@ 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 | ||
|
||
Searching for a job with known attributes can be helpful when a large amount of jobs are being deployed. The list of possible attributes is described in the [Job Configuration](#job-configuration) section. | ||
|
||
* Endpoint: __/scheduler/jobs/search__ | ||
* Method: __GET__ | ||
* Example: `curl -L -X GET chronos-node:8080/scheduler/jobs/search?name=request_event_counter_hourly` | ||
* Example: `curl -L -X GET chronos-node:8080/scheduler/jobs/search?owner=foo@bar.io` | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. owner is not a supported parameter There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Changed |
||
* Response: HTTP 204 | ||
|
||
## Deleting a Job | ||
|
||
Get a job name from the job listing above. | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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:
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.
There was a problem hiding this comment.
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.