@@ -362,42 +362,62 @@ defaultIndexSettings = IndexSettings (ShardCount 3) (ReplicaCount 2)
362362 <https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-update-settings.html>
363363-}
364364data IndexSettingUpdate = NumberOfReplicas Int
365+ -- ^ The number of replicas each shard has.
365366 | AutoExpandReplicas ReplicaBounds
366367 | BlocksReadOnly Bool
368+ -- ^ Set to True to have the index read only. False to allow writes and metadata changes.
367369 | BlocksRead Bool
370+ -- ^ Set to True to disable read operations against the index.
368371 | BlocksWrite Bool
372+ -- ^ Set to True to disable write operations against the index.
369373 | BlocksMetaData Bool
374+ -- ^ Set to True to disable metadata operations against the index.
370375 | RefreshInterval NominalDiffTime
376+ -- ^ The async refresh interval of a shard
371377 | IndexConcurrency Int
372378 | FailOnMergeFailure Bool
373379 | TranslogFlushThresholdOps Int
380+ -- ^ When to flush on operations.
374381 | TranslogFlushThresholdSize Bytes
382+ -- ^ When to flush based on translog (bytes) size.
375383 | TranslogFlushThresholdPeriod NominalDiffTime
384+ -- ^ When to flush based on a period of not flushing.
376385 | TranslogDisableFlush Bool
386+ -- ^ Disables flushing. Note, should be set for a short interval and then enabled.
377387 | CacheFilterMaxSize (Maybe Bytes)
388+ -- ^ The maximum size of filter cache (per segment in shard).
378389 | CacheFilterExpire (Maybe NominalDiffTime)
390+ -- ^ The expire after access time for filter cache.
379391 | GatewaySnapshotInterval NominalDiffTime
392+ -- ^ The gateway snapshot interval (only applies to shared gateways).
380393 | RoutingAllocationInclude (NonEmpty NodeAttrFilter)
394+ -- ^ A node matching any rule will be allowed to host shards from the index.
381395 | RoutingAllocationExclude (NonEmpty NodeAttrFilter)
396+ -- ^ A node matching any rule will NOT be allowed to host shards from the index.
382397 | RoutingAllocationRequire (NonEmpty NodeAttrFilter)
383− | RoutingAllocationDisable Bool
384− | RoutingAllocationDisableNew Bool
385− | RoutingAllocationDisableReplica Bool
398+ -- ^ Only nodes matching all rules will be allowed to host shards from the index.
386399 | RoutingAllocationEnable AllocationPolicy
400+ -- ^ Enables shard allocation for a specific index.
387401 | RoutingAllocationShardsPerNode ShardCount
402+ -- ^ Controls the total number of shards (replicas and primaries) allowed to be allocated on a single node.
388403 | RecoveryInitialShards InitialShardCount
404+ -- ^ When using local gateway a particular shard is recovered only if there can be allocated quorum shards in the cluster.
389405 | GCDeletes NominalDiffTime
390406 | TTLDisablePurge Bool
407+ -- ^ Disables temporarily the purge of expired docs.
391408 | TranslogFSType FSType
392409 | IndexCompoundFormat CompoundFormat
393410 | IndexCompoundOnFlush Bool
394411 | WarmerEnabled Bool
395− --TODO: figure out allocation options
396412
397413data AllocationPolicy = AllocAll
414+ -- ^ Allows shard allocation for all shards.
398415 | AllocPrimaries
416+ -- ^ Allows shard allocation only for primary shards.
399417 | AllocNewPrimaries
418+ -- ^ Allows shard allocation only for primary shards for new indices.
400419 | AllocNone
420+ -- ^ No shard allocation is allowed
401421
402422data ReplicaBounds = ReplicasBounded Int Int
403423 | ReplicasLowerBounded Int