Skip to content

Update docs for cluster API #30468

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 13 commits into from
Aug 20, 2018
Merged

Update docs for cluster API #30468

Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
165eaf8
Update docs for cluster API
PnPie May 8, 2018
5b4c070
Update according to comments
PnPie May 10, 2018
4344a88
small format change
PnPie May 10, 2018
1ebb53e
still some changes
PnPie May 11, 2018
ff337e9
Merge branch 'master' into 2018-06-08-node-filter-docs
DaveCTurner Jun 8, 2018
86c08f0
Some rewording, and add a note about filters in cluster stats
DaveCTurner Jun 8, 2018
4a63d4a
Merge branch 'master' into update_cluster_api_docs
DaveCTurner Jun 14, 2018
e02ec75
Clarify that both attribute names and values can be patterns
DaveCTurner Jun 14, 2018
19c6cb6
Merge branch 'master' into update_cluster_api_docs
DaveCTurner Jul 2, 2018
dc180f9
Fix regression introduced in merge
DaveCTurner Jul 2, 2018
779e281
Fix regression introduced in merge
DaveCTurner Jul 2, 2018
c11a1ba
Merge branch 'master' into update_cluster_api_docs
DaveCTurner Aug 18, 2018
ae3b2ed
Spell out that wildcards are optional
DaveCTurner Aug 20, 2018
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
25 changes: 16 additions & 9 deletions docs/reference/cluster.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,30 @@
["float",id="cluster-nodes"]
== Node specification

Most cluster level APIs allow to specify which nodes to execute on (for
example, getting the node stats for a node). Nodes can be identified in
the APIs either using their internal node id, the node name, address,
custom attributes, or just the `_local` node receiving the request. For
example, here are some sample executions of nodes info:
Most cluster level APIs allow to specify nodes (for example, getting
Copy link
Member

@nik9000 nik9000 May 8, 2018

Choose a reason for hiding this comment

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

Can you add something to sentence to explain that specifying nodes limits the results to those nodes? At least, I think that is what specifying the node does here, but I'm no expect.

the node stats for a certain node). Nodes can be identified in
the APIs either using their internal node id, node name, address,
built-in/custom attributes, or `_local`, `_master`, `_all` for the relevant nodes.
Here are examples of using nodes info API for each case:

[source,js]
--------------------------------------------------
# Local
# Local node
GET /_nodes/_local
# Address
# Master node
GET /_nodes/_master
# All nodes
GET /_nodes/_all
# Using address
GET /_nodes/10.0.0.3,10.0.0.4
GET /_nodes/10.0.0.*
# Names
# Using node name
GET /_nodes/node_name_goes_here
GET /_nodes/node_name_goes_*
# Attributes (set something like node.attr.rack: 2 in the config)
# Using built-in attributes (master, data, ingest or coordinating_only)
GET /_nodes/master:false,data:false,ingest:true
Copy link
Contributor

@DaveCTurner DaveCTurner May 9, 2018

Choose a reason for hiding this comment

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

This is equivalent to the simpler GET /_nodes/ingest:true so I don't think we should have this.

GET /_nodes/coordinating_only:true
# Using custom attributes (You need to set something like `node.attr.rack: 2` in the config)
GET /_nodes/rack:2
GET /_nodes/ra*:2
GET /_nodes/ra*:2*
Expand Down