Skip to content

Commit bf00b39

Browse files
tlrxtlrx
committed
[DOC] Remove obsolete node names from documentation
Funny node names have been removed in #19456 and replaced by UUID. This commit removes these obsolete node names and replace them by real UUIDs in the documentation. closes #20065 (cherry picked from commit 656596c)
1 parent 079855e commit bf00b39

15 files changed

+116
-101
lines changed

‎docs/reference/cat.asciidoc‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -59,11 +59,11 @@ only those columns to appear.
5959
[source,sh]
6060
--------------------------------------------------
6161
% curl 'n1:9200/_cat/nodes?h=ip,port,heapPercent,name'
62-
192.168.56.40 9300 40.3 Captain Universe
63-
192.168.56.20 9300 15.3 Kaluu
64-
192.168.56.50 9300 17.0 Yellowjacket
65-
192.168.56.10 9300 12.3 Remy LeBeau
66-
192.168.56.30 9300 43.9 Ramsey, Doug
62+
192.168.56.40 9300 40.3 bGG90GE
63+
192.168.56.20 9300 15.3 H5dfFeA
64+
192.168.56.50 9300 17.0 I8hydUG
65+
192.168.56.10 9300 12.3 DKDM97B
66+
192.168.56.30 9300 43.9 6-bjhwl
6767
--------------------------------------------------
6868

6969
You can also request multiple columns using simple wildcards like

‎docs/reference/cat/allocation.asciidoc‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ and how much disk space they are using.
88
--------------------------------------------------
99
% curl '192.168.56.10:9200/_cat/allocation?v'
1010
shards disk.indices disk.used disk.avail disk.total disk.percent host ip node
11-
1 3.1gb 5.6gb 72.2gb 77.8gb 7.8 192.168.56.10 192.168.56.10 Jarella
12-
1 3.1gb 5.6gb 72.2gb 77.8gb 7.8 192.168.56.30 192.168.56.30 Solarr
13-
1 3.0gb 5.5gb 72.3gb 77.8gb 7.6 192.168.56.20 192.168.56.20 Adam II
11+
1 3.1gb 5.6gb 72.2gb 77.8gb 7.8 192.168.56.10 192.168.56.10 bGG90GE
12+
1 3.1gb 5.6gb 72.2gb 77.8gb 7.8 192.168.56.30 192.168.56.30 I8hydUG
13+
1 3.0gb 5.5gb 72.3gb 77.8gb 7.6 192.168.56.20 192.168.56.20 H5dfFeA
1414
--------------------------------------------------
1515

1616
Here we can see that each node has been allocated a single shard and

‎docs/reference/cat/fielddata.asciidoc‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -7,33 +7,33 @@ on every data node in the cluster.
77
[source,sh]
88
--------------------------------------------------
99
% curl '192.168.56.10:9200/_cat/fielddata?v'
10-
id host ip node field size
11-
c223lARiSGeezlbrcugAYQ myhost1 10.20.100.200 Jessica Jones body 159.8kb
12-
c223lARiSGeezlbrcugAYQ myhost1 10.20.100.200 Jessica Jones text 225.7kb
13-
waPCbitNQaCL6xC8VxjAwg myhost2 10.20.100.201 Adversary body 159.8kb
14-
waPCbitNQaCL6xC8VxjAwg myhost2 10.20.100.201 Adversary text 275.3kb
15-
yaDkp-G3R0q1AJ-HUEvkSQ myhost3 10.20.100.202 Microchip body 109.2kb
16-
yaDkp-G3R0q1AJ-HUEvkSQ myhost3 10.20.100.202 Microchip text 175.3kb
10+
id host ip node field size
11+
bGG90GEiSGeezlbrcugAYQ myhost1 10.20.100.200 bGG90GE body 159.8kb
12+
bGG90GEiSGeezlbrcugAYQ myhost1 10.20.100.200 bGG90GE text 225.7kb
13+
H5dfFeANQaCL6xC8VxjAwg myhost2 10.20.100.201 H5dfFeA body 159.8kb
14+
H5dfFeANQaCL6xC8VxjAwg myhost2 10.20.100.201 H5dfFeA text 275.3kb
15+
I8hydUG3R0q1AJ-HUEvkSQ myhost3 10.20.100.202 I8hydUG body 109.2kb
16+
I8hydUG3R0q1AJ-HUEvkSQ myhost3 10.20.100.202 I8hydUG text 175.3kb
1717
--------------------------------------------------
1818

1919
Fields can be specified either as a query parameter, or in the URL path:
2020

2121
[source,sh]
2222
--------------------------------------------------
2323
% curl '192.168.56.10:9200/_cat/fielddata?v&fields=body'
24-
id host ip node field size
25-
c223lARiSGeezlbrcugAYQ myhost1 10.20.100.200 Jessica Jones body 159.8kb
26-
waPCbitNQaCL6xC8VxjAwg myhost2 10.20.100.201 Adversary body 159.8kb
27-
yaDkp-G3R0q1AJ-HUEvkSQ myhost3 10.20.100.202 Microchip body 109.2kb
24+
id host ip node field size
25+
bGG90GEiSGeezlbrcugAYQ myhost1 10.20.100.200 bGG90GE body 159.8kb
26+
H5dfFeANQaCL6xC8VxjAwg myhost2 10.20.100.201 H5dfFeA body 159.8kb
27+
I8hydUG3R0q1AJ-HUEvkSQ myhost3 10.20.100.202 I8hydUG body 109.2kb
2828
2929
% curl '192.168.56.10:9200/_cat/fielddata/body,text?v'
30-
id host ip node field size
31-
c223lARiSGeezlbrcugAYQ myhost1 10.20.100.200 Jessica Jones body 159.8kb
32-
c223lARiSGeezlbrcugAYQ myhost1 10.20.100.200 Jessica Jones text 225.7kb
33-
waPCbitNQaCL6xC8VxjAwg myhost2 10.20.100.201 Adversary body 159.8kb
34-
waPCbitNQaCL6xC8VxjAwg myhost2 10.20.100.201 Adversary text 275.3kb
35-
yaDkp-G3R0q1AJ-HUEvkSQ myhost3 10.20.100.202 Microchip body 109.2kb
36-
yaDkp-G3R0q1AJ-HUEvkSQ myhost3 10.20.100.202 Microchip text 175.3kb
30+
id host ip node field size
31+
bGG90GEiSGeezlbrcugAYQ myhost1 10.20.100.200 bGG90GE body 159.8kb
32+
bGG90GEiSGeezlbrcugAYQ myhost1 10.20.100.200 bGG90GE text 225.7kb
33+
H5dfFeANQaCL6xC8VxjAwg myhost2 10.20.100.201 H5dfFeA body 159.8kb
34+
H5dfFeANQaCL6xC8VxjAwg myhost2 10.20.100.201 H5dfFeA text 275.3kb
35+
I8hydUG3R0q1AJ-HUEvkSQ myhost3 10.20.100.202 I8hydUG body 109.2kb
36+
I8hydUG3R0q1AJ-HUEvkSQ myhost3 10.20.100.202 I8hydUG text 175.3kb
3737
--------------------------------------------------
3838

3939
The output shows the individual fielddata for the`body` and `text` fields, one row per field per node.

‎docs/reference/cat/master.asciidoc‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ master's node ID, bound IP address, and node name.
88
--------------------------------------------------
99
% curl 'localhost:9200/_cat/master?v'
1010
id ip node
11-
Ntgn2DcuTjGuXlhKDUD4vA 192.168.56.30 Solarr
11+
Ntgn2DcuTjGuXlhKDUD4vA 192.168.56.30 H5dfFeA
1212
--------------------------------------------------
1313

1414
This information is also available via the `nodes` command, but this
@@ -19,9 +19,9 @@ all nodes agree on the master:
1919
--------------------------------------------------
2020
% pssh -i -h list.of.cluster.hosts curl -s localhost:9200/_cat/master
2121
[1] 19:16:37 [SUCCESS] es3.vm
22-
Ntgn2DcuTjGuXlhKDUD4vA 192.168.56.30 Solarr
22+
Ntgn2DcuTjGuXlhKDUD4vA 192.168.56.30 H5dfFeA
2323
[2] 19:16:37 [SUCCESS] es2.vm
24-
Ntgn2DcuTjGuXlhKDUD4vA 192.168.56.30 Solarr
24+
Ntgn2DcuTjGuXlhKDUD4vA 192.168.56.30 H5dfFeA
2525
[3] 19:16:37 [SUCCESS] es1.vm
26-
Ntgn2DcuTjGuXlhKDUD4vA 192.168.56.30 Solarr
26+
Ntgn2DcuTjGuXlhKDUD4vA 192.168.56.30 H5dfFeA
2727
--------------------------------------------------

‎docs/reference/cat/nodeattrs.asciidoc‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,19 @@ The `nodeattrs` command shows custom node attributes.
66
["source","sh",subs="attributes,callouts"]
77
--------------------------------------------------
88
% curl 192.168.56.10:9200/_cat/nodeattrs
9-
node host ip attr value
10-
Black Bolt epsilon 192.168.1.8 rack rack314
11-
Black Bolt epsilon 192.168.1.8 azone us-east-1
9+
node host ip attr value
10+
DKDM97B epsilon 192.168.1.8 rack rack314
11+
DKDM97B epsilon 192.168.1.8 azone us-east-1
1212
--------------------------------------------------
1313

1414
The first few columns give you basic info per node.
1515

1616

1717
["source","sh",subs="attributes,callouts"]
1818
--------------------------------------------------
19-
node host ip
20-
Black Bolt epsilon 192.168.1.8
21-
Black Bolt epsilon 192.168.1.8
19+
node host ip
20+
DKDM97B epsilon 192.168.1.8
21+
DKDM97B epsilon 192.168.1.8
2222
--------------------------------------------------
2323

2424

@@ -52,15 +52,15 @@ mode (`v`). The header name will match the supplied value (e.g.,
5252
["source","sh",subs="attributes,callouts"]
5353
--------------------------------------------------
5454
% curl 192.168.56.10:9200/_cat/nodeattrs?v&h=name,pid,attr,value
55-
name pid attr value
56-
Black Bolt 28000 rack rack314
57-
Black Bolt 28000 azone us-east-1
55+
name pid attr value
56+
DKDM97B 28000 rack rack314
57+
DKDM97B 28000 azone us-east-1
5858
--------------------------------------------------
5959

6060
[cols="<,<,<,<,<",options="header",subs="normal"]
6161
|=======================================================================
6262
|Header |Alias |Appear by Default |Description |Example
63-
|`node`|`name`|Yes|Name of the node|Black Bolt
63+
|`node`|`name`|Yes|Name of the node|DKDM97B
6464
|`id` |`nodeId` |No |Unique node ID |k0zy
6565
|`pid` |`p` |No |Process ID |13061
6666
|`host` |`h` |Yes |Host name |n1

‎docs/reference/cat/plugins.asciidoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ The `plugins` command provides a view per node of running plugins. This informat
77
------------------------------------------------------------------------------
88
% curl 'localhost:9200/_cat/plugins?v'
99
name component version description
10-
Abraxas discovery-gce 5.0.0 The Google Compute Engine (GCE) Discovery plugin allows to use GCE API for the unicast discovery mechanism.
11-
Abraxas lang-javascript 5.0.0 The JavaScript language plugin allows to have javascript as the language of scripts to execute.
10+
I8hydUG discovery-gce 5.0.0 The Google Compute Engine (GCE) Discovery plugin allows to use GCE API for the unicast discovery mechanism.
11+
I8hydUG lang-javascript 5.0.0 The JavaScript language plugin allows to have javascript as the language of scripts to execute.
1212
-------------------------------------------------------------------------------
1313

1414
We can tell quickly how many plugins per node we have and which versions.

‎docs/reference/cat/recovery.asciidoc‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,13 @@ are no shards in transit from one node to another:
1515
[source,sh]
1616
----------------------------------------------------------------------------
1717
> curl -XGET 'localhost:9200/_cat/recovery?v'
18-
index shard time type stage source_host source_node target_host target_node repository snapshot files files_percent bytes bytes_percent total_files total_bytes translog translog_percent total_translog
19-
index 0 87ms store done 127.0.0.1 Athena 127.0.0.1 Athena n/a n/a 0 0.0% 0 0.0% 0 0 0 100.0% 0
20-
index 1 97ms store done 127.0.0.1 Athena 127.0.0.1 Athena n/a n/a 0 0.0% 0 0.0% 0 0 0 100.0% 0
21-
index 2 93ms store done 127.0.0.1 Athena 127.0.0.1 Athena n/a n/a 0 0.0% 0 0.0% 0 0 0 100.0% 0
22-
index 3 90ms store done 127.0.0.1 Athena 127.0.0.1 Athena n/a n/a 0 0.0% 0 0.0% 0 0 0 100.0% 0
23-
index 4 9ms store done 127.0.0.1 Athena 127.0.0.1 Athena n/a n/a 0 0.0% 0 0.0% 0 0 0 100.0% 0
18+
index shard time type stage source_host source_node target_host target_node repository snapshot files files_percent bytes bytes_percent
19+
total_files total_bytes translog translog_percent total_translog
20+
index 0 87ms store done 127.0.0.1 I8hydUG 127.0.0.1 I8hydUG n/a n/a 0 0.0% 0 0.0% 0 0 0 100.0% 0
21+
index 1 97ms store done 127.0.0.1 I8hydUG 127.0.0.1 I8hydUG n/a n/a 0 0.0% 0 0.0% 0 0 0 100.0% 0
22+
index 2 93ms store done 127.0.0.1 I8hydUG 127.0.0.1 I8hydUG n/a n/a 0 0.0% 0 0.0% 0 0 0 100.0% 0
23+
index 3 90ms store done 127.0.0.1 I8hydUG 127.0.0.1 I8hydUG n/a n/a 0 0.0% 0 0.0% 0 0 0 100.0% 0
24+
index 4 9ms store done 127.0.0.1 I8hydUG 127.0.0.1 I8hydUG n/a n/a 0 0.0% 0 0.0% 0 0 0 100.0% 0
2425
---------------------------------------------------------------------------
2526

2627
In the above case, the source and target nodes are the same because the recovery

‎docs/reference/cat/shards.asciidoc‎

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ Here we see a single index, with three primary shards and no replicas:
1010
[source,sh]
1111
--------------------------------------------------
1212
% curl 192.168.56.20:9200/_cat/shards
13-
wiki1 0 p STARTED 3014 31.1mb 192.168.56.10 Stiletto
14-
wiki1 1 p STARTED 3013 29.6mb 192.168.56.30 Frankie Raye
15-
wiki1 2 p STARTED 3973 38.1mb 192.168.56.20 Commander Kraken
13+
wiki1 0 p STARTED 3014 31.1mb 192.168.56.10 H5dfFeA
14+
wiki1 1 p STARTED 3013 29.6mb 192.168.56.30 bGG90GE
15+
wiki1 2 p STARTED 3973 38.1mb 192.168.56.20 I8hydUG
1616
--------------------------------------------------
1717

1818
[float]
@@ -26,9 +26,9 @@ some bandwidth by supplying an index pattern to the end.
2626
[source,sh]
2727
--------------------------------------------------
2828
% curl 192.168.56.20:9200/_cat/shards/wiki*
29-
wiki2 0 p STARTED 197 3.2mb 192.168.56.10 Stiletto
30-
wiki2 1 p STARTED 205 5.9mb 192.168.56.30 Frankie Raye
31-
wiki2 2 p STARTED 275 7.8mb 192.168.56.20 Commander Kraken
29+
wiki2 0 p STARTED 197 3.2mb 192.168.56.10 H5dfFeA
30+
wiki2 1 p STARTED 205 5.9mb 192.168.56.30 bGG90GE
31+
wiki2 2 p STARTED 275 7.8mb 192.168.56.20 I8hydUG
3232
--------------------------------------------------
3333

3434

@@ -44,8 +44,8 @@ shards. Where are they from and where are they going?
4444
% curl 192.168.56.10:9200/_cat/health
4545
1384315316 20:01:56 foo green 3 3 12 6 2 0 0
4646
% curl 192.168.56.10:9200/_cat/shards | fgrep RELO
47-
wiki1 0 r RELOCATING 3014 31.1mb 192.168.56.20 Commander Kraken -> 192.168.56.30 Frankie Raye
48-
wiki1 1 r RELOCATING 3013 29.6mb 192.168.56.10 Stiletto -> 192.168.56.30 Frankie Raye
47+
wiki1 0 r RELOCATING 3014 31.1mb 192.168.56.20 I8hydUG -> 192.168.56.30 bGG90GE
48+
wiki1 1 r RELOCATING 3013 29.6mb 192.168.56.10 H5dfFeA -> 192.168.56.30 bGG90GE
4949
--------------------------------------------------
5050

5151
[float]
@@ -60,12 +60,12 @@ Before a shard can be used, it goes through an `INITIALIZING` state.
6060
% curl -XPUT 192.168.56.20:9200/_settings -d'{"number_of_replicas":1}'
6161
{"acknowledged":true}
6262
% curl 192.168.56.20:9200/_cat/shards
63-
wiki1 0 p STARTED 3014 31.1mb 192.168.56.10 Stiletto
64-
wiki1 0 r INITIALIZING 0 14.3mb 192.168.56.30 Frankie Raye
65-
wiki1 1 p STARTED 3013 29.6mb 192.168.56.30 Frankie Raye
66-
wiki1 1 r INITIALIZING 0 13.1mb 192.168.56.20 Commander Kraken
67-
wiki1 2 r INITIALIZING 0 14mb 192.168.56.10 Stiletto
68-
wiki1 2 p STARTED 3973 38.1mb 192.168.56.20 Commander Kraken
63+
wiki1 0 p STARTED 3014 31.1mb 192.168.56.10 H5dfFeA
64+
wiki1 0 r INITIALIZING 0 14.3mb 192.168.56.30 bGG90GE
65+
wiki1 1 p STARTED 3013 29.6mb 192.168.56.30 bGG90GE
66+
wiki1 1 r INITIALIZING 0 13.1mb 192.168.56.20 I8hydUG
67+
wiki1 2 r INITIALIZING 0 14mb 192.168.56.10 H5dfFeA
68+
wiki1 2 p STARTED 3973 38.1mb 192.168.56.20 I8hydUG
6969
--------------------------------------------------
7070

7171
If a shard cannot be assigned, for example you've overallocated the
@@ -78,17 +78,17 @@ will remain `UNASSIGNED` with the <<reason-unassigned,reason code>> `ALLOCATION_
7878
% curl 192.168.56.20:9200/_cat/health
7979
1384316325 20:18:45 foo yellow 3 3 9 3 0 0 3
8080
% curl 192.168.56.20:9200/_cat/shards
81-
wiki1 0 p STARTED 3014 31.1mb 192.168.56.10 Stiletto
82-
wiki1 0 r STARTED 3014 31.1mb 192.168.56.30 Frankie Raye
83-
wiki1 0 r STARTED 3014 31.1mb 192.168.56.20 Commander Kraken
81+
wiki1 0 p STARTED 3014 31.1mb 192.168.56.10 H5dfFeA
82+
wiki1 0 r STARTED 3014 31.1mb 192.168.56.30 bGG90GE
83+
wiki1 0 r STARTED 3014 31.1mb 192.168.56.20 I8hydUG
8484
wiki1 0 r UNASSIGNED ALLOCATION_FAILED
85-
wiki1 1 r STARTED 3013 29.6mb 192.168.56.10 Stiletto
86-
wiki1 1 p STARTED 3013 29.6mb 192.168.56.30 Frankie Raye
87-
wiki1 1 r STARTED 3013 29.6mb 192.168.56.20 Commander Kraken
85+
wiki1 1 r STARTED 3013 29.6mb 192.168.56.10 H5dfFeA
86+
wiki1 1 p STARTED 3013 29.6mb 192.168.56.30 bGG90GE
87+
wiki1 1 r STARTED 3013 29.6mb 192.168.56.20 I8hydUG
8888
wiki1 1 r UNASSIGNED ALLOCATION_FAILED
89-
wiki1 2 r STARTED 3973 38.1mb 192.168.56.10 Stiletto
90-
wiki1 2 r STARTED 3973 38.1mb 192.168.56.30 Frankie Raye
91-
wiki1 2 p STARTED 3973 38.1mb 192.168.56.20 Commander Kraken
89+
wiki1 2 r STARTED 3973 38.1mb 192.168.56.10 H5dfFeA
90+
wiki1 2 r STARTED 3973 38.1mb 192.168.56.30 bGG90GE
91+
wiki1 2 p STARTED 3973 38.1mb 192.168.56.20 I8hydUG
9292
wiki1 2 r UNASSIGNED ALLOCATION_FAILED
9393
--------------------------------------------------
9494

‎docs/reference/cluster/allocation-explain.asciidoc‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ The response looks like:
4141
"remaining_delay_ms" : 0, <5>
4242
"nodes" : {
4343
"V-Spi0AyRZ6ZvKbaI3691w" : {
44-
"node_name" : "node1",
44+
"node_name" : "H5dfFeA",
4545
"node_attributes" : { <6>
4646
"bar" : "baz"
4747
},
@@ -58,7 +58,7 @@ The response looks like:
5858
} ]
5959
},
6060
"Qc6VL8c5RWaw1qXZ0Rg57g" : {
61-
"node_name" : "node2",
61+
"node_name" : "bGG90GE",
6262
"node_attributes" : {
6363
"bar" : "baz",
6464
"foo" : "bar"
@@ -76,7 +76,7 @@ The response looks like:
7676
} ]
7777
},
7878
"PzdyMZGXQdGhqTJHF_hGgA" : {
79-
"node_name" : "node3",
79+
"node_name" : "DKDM97B",
8080
"node_attributes" : { },
8181
"store" : {
8282
"shard_copy" : "NONE"
@@ -122,7 +122,7 @@ For a shard that is already assigned, the output looks similar to:
122122
"remaining_delay_ms" : 0,
123123
"nodes" : {
124124
"V-Spi0AyRZ6ZvKbaI3691w" : {
125-
"node_name" : "Susan Storm",
125+
"node_name" : "bGG90GE",
126126
"node_attributes" : {
127127
"bar" : "baz"
128128
},
@@ -139,7 +139,7 @@ For a shard that is already assigned, the output looks similar to:
139139
} ]
140140
},
141141
"Qc6VL8c5RWaw1qXZ0Rg57g" : {
142-
"node_name" : "Slipstream",
142+
"node_name" : "I8hydUG",
143143
"node_attributes" : {
144144
"bar" : "baz",
145145
"foo" : "bar"
@@ -157,7 +157,7 @@ For a shard that is already assigned, the output looks similar to:
157157
} ]
158158
},
159159
"PzdyMZGXQdGhqTJHF_hGgA" : {
160-
"node_name" : "The Symbiote",
160+
"node_name" : "H5dfFeA",
161161
"node_attributes" : { },
162162
"store" : {
163163
"shard_copy" : "NONE"

‎docs/reference/cluster/tasks.asciidoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ The result will look similar to the following:
2828
{
2929
"nodes" : {
3030
"oTUltX4IQMOUUVeiohTt8A" : {
31-
"name" : "Tamara Rahn",
31+
"name" : "H5dfFeA",
3232
"transport_address" : "127.0.0.1:9300",
3333
"host" : "127.0.0.1",
3434
"ip" : "127.0.0.1:9300",

0 commit comments

Comments
 (0)