Skip to content

add documentation for coordinator dynamic configuration #11052

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
clintropolis merged 1 commit into from
Apr 3, 2021
Merged

add documentation for coordinator dynamic configuration #11052

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
26 changes: 25 additions & 1 deletion docs/operations/api-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -401,6 +401,30 @@ Returns total size and count for each interval within given isointerval.

Returns total size and count for each datasource for each interval within given isointerval.

#### Dynamic configuration

See [Coordinator Dynamic Configuration](../configuration/index.md#dynamic-configuration) for details.

Note that all _interval_ URL parameters are ISO 8601 strings delimited by a `_` instead of a `/`
(e.g., 2016-06-27_2016-06-28).

##### GET

* `/druid/coordinator/v1/config`

Retrieves current coordinator dynamic configuration.

* `/druid/coordinator/v1/config/history?interval={interval}&count={count}`

Retrieves history of changes to overlord dynamic configuration. Accepts `interval` and `count` query string parameters
to filter by interval and limit the number of results respectively.

##### POST

* `/druid/coordinator/v1/config`

Update overlord dynamic worker configuration.
Copy link
Copy Markdown
Contributor

@techdocsmith techdocsmith Mar 30, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

Seems odd not to have the payload here, but I see that it is in the linked section. Might be worth a mention to get the payload there?

Copy link
Copy Markdown
Contributor

@capistrant capistrant Mar 31, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

I'm indifferent on this note. Since other POST endpoints in this same doc do not include information on what the payload would look like, I think it is fine as is. (this is a reply to another review comment: #11052 (comment))

Copy link
Copy Markdown
Contributor

@techdocsmith techdocsmith Mar 31, 2021

Choose a reason for hiding this comment

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

Thanks @capistrant ! I think you are right, too. Everything API related in Druid could use an overhaul to be a little more user-friendly and that surely wasn't the goal of this PR.

Copy link
Copy Markdown
Member Author

@clintropolis clintropolis Apr 1, 2021

Choose a reason for hiding this comment

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

Ah yeah, I just copied this from the overlord section. It would be really nice to have example requests and responses for all of these API calls, but I think maybe that could be done as future work.


#### Compaction Status

##### GET
Expand Down Expand Up @@ -689,7 +713,7 @@ Note that all _interval_ URL parameters are ISO 8601 strings delimited by a `_`

Retrieves current overlord dynamic configuration.

* `/druid/indexer/v1/worker/history?interval={interval}&counter={count}`
* `/druid/indexer/v1/worker/history?interval={interval}&count={count}`

Retrieves history of changes to overlord dynamic configuration. Accepts `interval` and `count` query string parameters
to filter by interval and limit the number of results respectively.
Expand Down