Small improvements based on code review feedback

pracucci · pracucci · commit 37dade1e0966 · 2020-08-10T11:35:32.000+02:00
Signed-off-by: Marco Pracucci &lt;marco@pracucci.com&gt;
diff --git a/development/tsdb-blocks-storage-s3-single-binary/config/cortex.yaml b/development/tsdb-blocks-storage-s3-single-binary/config/cortex.yaml
@@ -13,8 +13,6 @@ ingester_client:
     use_gzip_compression: true
 
 ingester:
-  max_transfer_retries: 1
-
   lifecycler:
     # We want to start immediately.
     join_after: 0
diff --git a/development/tsdb-blocks-storage-s3/config/cortex.yaml b/development/tsdb-blocks-storage-s3/config/cortex.yaml
@@ -13,8 +13,6 @@ ingester_client:
     use_gzip_compression: true
 
 ingester:
-  max_transfer_retries: 1
-
   lifecycler:
     # We want to start immediately.
     join_after: 0
diff --git a/docs/blocks-storage/querier.md b/docs/blocks-storage/querier.md
@@ -476,7 +476,7 @@ blocks_storage:
     [wal_compression_enabled: <boolean> | default = false]
 
     # True to flush blocks to storage on shutdown. If false, incomplete blocks
-    # will be reused after restart, and uploaded when finished.
+    # will be reused after restart.
     # CLI flag: -experimental.blocks-storage.tsdb.flush-blocks-on-shutdown
     [flush_blocks_on_shutdown: <boolean> | default = false]
 
diff --git a/docs/blocks-storage/store-gateway.md b/docs/blocks-storage/store-gateway.md
@@ -503,7 +503,7 @@ blocks_storage:
     [wal_compression_enabled: <boolean> | default = false]
 
     # True to flush blocks to storage on shutdown. If false, incomplete blocks
-    # will be reused after restart, and uploaded when finished.
+    # will be reused after restart.
     # CLI flag: -experimental.blocks-storage.tsdb.flush-blocks-on-shutdown
     [flush_blocks_on_shutdown: <boolean> | default = false]
 
diff --git a/docs/configuration/arguments.md b/docs/configuration/arguments.md
@@ -310,7 +310,7 @@ It also talks to a KVStore and has it's own copies of the same flags used by the
 
 - `-ingester.max-transfer-retries`
 
-   How many times a LEAVING ingester tries to find a PENDING ingester during the [hand-over process](../guides/ingesters-rolling-updates.md#chunks-storage-with-wal-disabled-hand-over) (supported only by the chunks storage). Each attempt takes a second or so. Negative value or zero disables hand-over process completely. (default 10)
+   How many times a LEAVING ingester tries to find a PENDING ingester during the [hand-over process](../guides/ingesters-rolling-updates.md#chunks-storage-with-wal-disabled-hand-over) (supported only by the chunks storage). Negative value or zero disables hand-over process completely. (default 10)
 
 - `-ingester.normalise-tokens`
 
diff --git a/docs/configuration/config-file-reference.md b/docs/configuration/config-file-reference.md
@@ -3265,7 +3265,7 @@ tsdb:
   [wal_compression_enabled: <boolean> | default = false]
 
   # True to flush blocks to storage on shutdown. If false, incomplete blocks
-  # will be reused after restart, and uploaded when finished.
+  # will be reused after restart.
   # CLI flag: -experimental.blocks-storage.tsdb.flush-blocks-on-shutdown
   [flush_blocks_on_shutdown: <boolean> | default = false]
 
diff --git a/docs/configuration/single-process-config-blocks-gossip-1.yaml b/docs/configuration/single-process-config-blocks-gossip-1.yaml
@@ -29,9 +29,6 @@ ingester_client:
     use_gzip_compression: true
 
 ingester:
-  # Blocks storage doesn't support blocks transfer between ingesters on shutdown or rollout.
-  max_transfer_retries: 0
-
   lifecycler:
     # The address to advertise for this ingester.  Will be autodiscovered by
     # looking up address on eth0 or en0; can be specified if this fails.
diff --git a/docs/configuration/single-process-config-blocks-gossip-2.yaml b/docs/configuration/single-process-config-blocks-gossip-2.yaml
@@ -29,9 +29,6 @@ ingester_client:
     use_gzip_compression: true
 
 ingester:
-  # Blocks storage doesn't support blocks transfer between ingesters on shutdown or rollout.
-  max_transfer_retries: 0
-
   lifecycler:
     # The address to advertise for this ingester.  Will be autodiscovered by
     # looking up address on eth0 or en0; can be specified if this fails.
diff --git a/docs/configuration/single-process-config-blocks-tls.yaml b/docs/configuration/single-process-config-blocks-tls.yaml
@@ -37,9 +37,6 @@ ingester_client:
     tls_ca_path: "root.crt"
 
 ingester:
-  # Blocks storage doesn't support blocks transfer between ingesters on shutdown or rollout.
-  max_transfer_retries: 0
-
   lifecycler:
     # The address to advertise for this ingester.  Will be autodiscovered by
     # looking up address on eth0 or en0; can be specified if this fails.
diff --git a/docs/configuration/single-process-config-blocks.yaml b/docs/configuration/single-process-config-blocks.yaml
@@ -28,9 +28,6 @@ ingester_client:
     use_gzip_compression: true
 
 ingester:
-  # Blocks storage doesn't support blocks transfer between ingesters on shutdown or rollout.
-  max_transfer_retries: 0
-
   lifecycler:
     # The address to advertise for this ingester.  Will be autodiscovered by
     # looking up address on eth0 or en0; can be specified if this fails.
diff --git a/docs/guides/ingesters-rolling-updates.md b/docs/guides/ingesters-rolling-updates.md
@@ -53,8 +53,7 @@ On startup, an ingester goes into the **`PENDING`** state.
 In this state, the ingester is waiting for a hand-over from another ingester that is `LEAVING`.
 If no hand-over occurs within the configured timeout period ("auto-join timeout", configurable via `-ingester.join-after` option), the ingester will join the ring with a new set of random tokens (eg. during a scale up) and will switch its state to `ACTIVE`.
 
-A running ingester, in the **`ACTIVE`** state, is notified to shutdown via the Unix signal `SIGINT`.
-On receipt of this signal, the ingester switches to `LEAVING`: in this state it cannot receive write requests anymore, while it could still receive read requests for series it has in memory.
+When a running ingester in the **`ACTIVE`** state is notified to shutdown via `SIGINT` or `SIGTERM` Unix signal, the ingester switches to `LEAVING` state. In this state it cannot receive write requests anymore, but it can still receive read requests for series it has in memory.
 
 A **`LEAVING`** ingester looks for a `PENDING` ingester to start a hand-over process with.
 If it finds one, that ingester goes into the `JOINING` state and the leaver transfers all its in-memory data over to the joiner.
diff --git a/pkg/storage/tsdb/config.go b/pkg/storage/tsdb/config.go
@@ -172,7 +172,7 @@ func (cfg *TSDBConfig) RegisterFlags(f *flag.FlagSet) {
 	f.DurationVar(&cfg.HeadCompactionIdleTimeout, "experimental.blocks-storage.tsdb.head-compaction-idle-timeout", 1*time.Hour, "If TSDB head is idle for this duration, it is compacted. 0 means disabled.")
 	f.IntVar(&cfg.StripeSize, "experimental.blocks-storage.tsdb.stripe-size", 16384, "The number of shards of series to use in TSDB (must be a power of 2). Reducing this will decrease memory footprint, but can negatively impact performance.")
 	f.BoolVar(&cfg.WALCompressionEnabled, "experimental.blocks-storage.tsdb.wal-compression-enabled", false, "True to enable TSDB WAL compression.")
-	f.BoolVar(&cfg.FlushBlocksOnShutdown, "experimental.blocks-storage.tsdb.flush-blocks-on-shutdown", false, "True to flush blocks to storage on shutdown. If false, incomplete blocks will be reused after restart, and uploaded when finished.")
+	f.BoolVar(&cfg.FlushBlocksOnShutdown, "experimental.blocks-storage.tsdb.flush-blocks-on-shutdown", false, "True to flush blocks to storage on shutdown. If false, incomplete blocks will be reused after restart.")
 }
 
 // Validate the config.
