Skip to content

Commit f123a53

Browse files
Docs: Refactored modules and index modules sections
1 parent 1df2d30 commit f123a53

37 files changed

+1171
-1137
lines changed

docs/reference/aggregations/misc.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ can be cached for faster responses. These cached results are the same results
77
that would be returned by an uncached aggregation -- you will never get stale
88
results.
99

10-
See <<index-modules-shard-query-cache>> for more details.
10+
See <<shard-query-cache>> for more details.
1111

1212
[[returning-only-agg-results]]
1313
== Returning only aggregation results

docs/reference/cluster/update-settings.asciidoc

Lines changed: 8 additions & 158 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ survive a full cluster restart). Here is an example:
1010
curl -XPUT localhost:9200/_cluster/settings -d '{
1111
"persistent" : {
1212
"discovery.zen.minimum_master_nodes" : 2
13-
}
14-
}'
13+
}
14+
}'
1515
--------------------------------------------------
1616

1717
Or:
@@ -21,8 +21,8 @@ Or:
2121
curl -XPUT localhost:9200/_cluster/settings -d '{
2222
"transient" : {
2323
"discovery.zen.minimum_master_nodes" : 2
24-
}
25-
}'
24+
}
25+
}'
2626
--------------------------------------------------
2727

2828
The cluster responds with the settings updated. So the response for the
@@ -34,8 +34,8 @@ last example will be:
3434
"persistent" : {},
3535
"transient" : {
3636
"discovery.zen.minimum_master_nodes" : "2"
37-
}
38-
}'
37+
}
38+
}'
3939
--------------------------------------------------
4040

4141
Cluster wide settings can be returned using:
@@ -45,157 +45,7 @@ Cluster wide settings can be returned using:
4545
curl -XGET localhost:9200/_cluster/settings
4646
--------------------------------------------------
4747

48-
There is a specific list of settings that can be updated, those include:
4948

50-
[float]
51-
[[cluster-settings]]
52-
=== Cluster settings
53-
54-
[float]
55-
==== Routing allocation
56-
57-
[float]
58-
===== Awareness
59-
60-
`cluster.routing.allocation.awareness.attributes`::
61-
See <<modules-cluster>>.
62-
63-
`cluster.routing.allocation.awareness.force.*`::
64-
See <<modules-cluster>>.
65-
66-
[float]
67-
===== Balanced Shards
68-
All these values are relative to one another. The first three are used to
69-
compose a three separate weighting functions into one. The cluster is balanced
70-
when no allowed action can bring the weights of each node closer together by
71-
more then the fourth setting. Actions might not be allowed, for instance,
72-
due to forced awareness or allocation filtering.
73-
74-
`cluster.routing.allocation.balance.shard`::
75-
Defines the weight factor for shards allocated on a node
76-
(float). Defaults to `0.45f`. Raising this raises the tendency to
77-
equalize the number of shards across all nodes in the cluster.
78-
79-
`cluster.routing.allocation.balance.index`::
80-
Defines a factor to the number of shards per index allocated
81-
on a specific node (float). Defaults to `0.55f`. Raising this raises the
82-
tendency to equalize the number of shards per index across all nodes in
83-
the cluster.
84-
85-
`cluster.routing.allocation.balance.threshold`::
86-
Minimal optimization value of operations that should be performed (non
87-
negative float). Defaults to `1.0f`. Raising this will cause the cluster
88-
to be less aggressive about optimizing the shard balance.
89-
90-
[float]
91-
===== Concurrent Rebalance
92-
93-
`cluster.routing.allocation.cluster_concurrent_rebalance`::
94-
Allow to control how many concurrent rebalancing of shards are
95-
allowed cluster wide, and default it to `2` (integer). `-1` for
96-
unlimited. See also <<modules-cluster>>.
97-
98-
[float]
99-
===== Enable allocation
100-
101-
`cluster.routing.allocation.enable`::
102-
See <<modules-cluster>>.
103-
104-
[float]
105-
===== Throttling allocation
106-
107-
`cluster.routing.allocation.node_initial_primaries_recoveries`::
108-
See <<modules-cluster>>.
109-
110-
`cluster.routing.allocation.node_concurrent_recoveries`::
111-
See <<modules-cluster>>.
112-
113-
[float]
114-
===== Filter allocation
115-
116-
`cluster.routing.allocation.include.*`::
117-
See <<modules-cluster>>.
118-
119-
`cluster.routing.allocation.exclude.*`::
120-
See <<modules-cluster>>.
121-
122-
`cluster.routing.allocation.require.*`
123-
See <<modules-cluster>>.
124-
125-
[float]
126-
==== Metadata
127-
128-
`cluster.blocks.read_only`::
129-
Have the whole cluster read only (indices do not accept write operations), metadata is not allowed to be modified (create or delete indices).
130-
131-
[float]
132-
==== Discovery
133-
134-
`discovery.zen.minimum_master_nodes`::
135-
See <<modules-discovery-zen>>
136-
137-
`discovery.zen.publish_timeout`::
138-
See <<modules-discovery-zen>>
139-
140-
[float]
141-
==== Threadpools
142-
143-
`threadpool.*`::
144-
See <<modules-threadpool>>
145-
146-
[float]
147-
[[cluster-index-settings]]
148-
=== Index settings
149-
150-
[float]
151-
==== Index filter cache
152-
153-
`indices.cache.filter.size`::
154-
See <<index-modules-cache>>
155-
156-
[float]
157-
==== TTL interval
158-
159-
`indices.ttl.interval` (time)::
160-
See <<mapping-ttl-field>>
161-
162-
[float]
163-
==== Recovery
164-
165-
`indices.recovery.concurrent_streams`::
166-
See <<modules-indices>>
167-
168-
`indices.recovery.concurrent_small_file_streams`::
169-
See <<modules-indices>>
170-
171-
`indices.recovery.file_chunk_size`::
172-
See <<modules-indices>>
173-
174-
`indices.recovery.translog_ops`::
175-
See <<modules-indices>>
176-
177-
`indices.recovery.translog_size`::
178-
See <<modules-indices>>
179-
180-
`indices.recovery.compress`::
181-
See <<modules-indices>>
182-
183-
`indices.recovery.max_bytes_per_sec`::
184-
See <<modules-indices>>
185-
186-
[float]
187-
[[logger]]
188-
=== Logger
189-
190-
Logger values can also be updated by setting `logger.` prefix. More
191-
settings will be allowed to be updated.
192-
193-
[float]
194-
=== Field data circuit breaker
195-
196-
`indices.breaker.fielddata.limit`::
197-
See <<index-modules-fielddata>>
198-
199-
`indices.breaker.fielddata.overhead`::
200-
See <<index-modules-fielddata>>
49+
A list of dynamically updatable settings can be found in the
50+
<<modules,Modules>> documentation.
20151

0 commit comments

Comments
 (0)