From c22368fdbee664039428462ed4ea0ed704ab89e5 Mon Sep 17 00:00:00 2001 From: Daisuke Kobayashi Date: Wed, 21 Aug 2024 11:46:49 +0900 Subject: [PATCH 01/11] Improve cache_size and cache_size_percent descriptions --- .../pages/properties/object-storage-properties.adoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/modules/reference/pages/properties/object-storage-properties.adoc b/modules/reference/pages/properties/object-storage-properties.adoc index 60122962a..269e6c22b 100644 --- a/modules/reference/pages/properties/object-storage-properties.adoc +++ b/modules/reference/pages/properties/object-storage-properties.adoc @@ -85,7 +85,7 @@ AWS or GCS bucket that should be used to store data. Max size of object storage cache. -If both this property and <> are set, Redpanda uses the minimum of the two. +If both this property and <> are set, Redpanda uses the minimum of the two. If one of them is set to 0, Redpanda uses the non-zero one. If they are both set to 0, the cache size is 0. *Units*: bytes @@ -593,7 +593,7 @@ Divide the object storage cache across the specified number of buckets. This onl Maximum size of the cloud cache as a percentage of unreserved disk space (see config_ref:disk_reservation_percent,true,cluster-properties[]). The default value for this option is tuned for a shared disk configuration. Consider increasing the value if using a dedicated cache disk. -The property <> controls the same limit expressed as a fixed number of bytes. If both `cloud_storage_cache_size` and `cloud_storage_cache_size_percent` are set, Redpanda uses the minimum of the two. +The property <> controls the same limit expressed as a fixed number of bytes. If both `cloud_storage_cache_size` and `cloud_storage_cache_size_percent` are set, Redpanda uses the minimum of the two. If one of them is set to 0, Redpanda uses the non-zero one. If they are both set to 0, the cache size is 0. *Units*: percentage of total disk size. @@ -1706,4 +1706,4 @@ If neither addressing style works, Redpanda terminates the startup, requiring ma *Default:* `null` ---- \ No newline at end of file +--- From ea2e99292baf07bfd70f65f0fbe7f75fa0030050 Mon Sep 17 00:00:00 2001 From: Daisuke Kobayashi Date: Fri, 23 Aug 2024 01:05:15 +0900 Subject: [PATCH 02/11] Update modules/reference/pages/properties/object-storage-properties.adoc Co-authored-by: Kat Batuigas <36839689+kbatuigas@users.noreply.github.com> --- .../reference/pages/properties/object-storage-properties.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/reference/pages/properties/object-storage-properties.adoc b/modules/reference/pages/properties/object-storage-properties.adoc index 269e6c22b..be272a56e 100644 --- a/modules/reference/pages/properties/object-storage-properties.adoc +++ b/modules/reference/pages/properties/object-storage-properties.adoc @@ -593,7 +593,7 @@ Divide the object storage cache across the specified number of buckets. This onl Maximum size of the cloud cache as a percentage of unreserved disk space (see config_ref:disk_reservation_percent,true,cluster-properties[]). The default value for this option is tuned for a shared disk configuration. Consider increasing the value if using a dedicated cache disk. -The property <> controls the same limit expressed as a fixed number of bytes. If both `cloud_storage_cache_size` and `cloud_storage_cache_size_percent` are set, Redpanda uses the minimum of the two. If one of them is set to 0, Redpanda uses the non-zero one. If they are both set to 0, the cache size is 0. +The property <> controls the same limit expressed as a fixed number of bytes. If both `cloud_storage_cache_size` and `cloud_storage_cache_size_percent` are set, Redpanda uses the minimum of the two. If one of these properties is set to 0, Redpanda applies the non-zero value. If they are both set to 0, the cache size is 0. *Units*: percentage of total disk size. From 02c37e9842197eff9ebab3edacec894fcc4e84a7 Mon Sep 17 00:00:00 2001 From: Daisuke Kobayashi Date: Fri, 23 Aug 2024 01:05:24 +0900 Subject: [PATCH 03/11] Update modules/reference/pages/properties/object-storage-properties.adoc Co-authored-by: Kat Batuigas <36839689+kbatuigas@users.noreply.github.com> --- .../reference/pages/properties/object-storage-properties.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/reference/pages/properties/object-storage-properties.adoc b/modules/reference/pages/properties/object-storage-properties.adoc index be272a56e..cf0a0ef72 100644 --- a/modules/reference/pages/properties/object-storage-properties.adoc +++ b/modules/reference/pages/properties/object-storage-properties.adoc @@ -85,7 +85,7 @@ AWS or GCS bucket that should be used to store data. Max size of object storage cache. -If both this property and <> are set, Redpanda uses the minimum of the two. If one of them is set to 0, Redpanda uses the non-zero one. If they are both set to 0, the cache size is 0. +If both this property and <> are set, Redpanda uses the minimum of the two. If one of these properties is set to 0, Redpanda applies the non-zero value. If they are both set to 0, the cache size is 0. *Units*: bytes From 25d3898a6482cef7110276d11f3500407d35b739 Mon Sep 17 00:00:00 2001 From: Daisuke Kobayashi Date: Wed, 9 Oct 2024 16:50:41 +0900 Subject: [PATCH 04/11] Update modules/reference/pages/properties/object-storage-properties.adoc Co-authored-by: Jake Cahill <45230295+JakeSCahill@users.noreply.github.com> --- .../reference/pages/properties/object-storage-properties.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/reference/pages/properties/object-storage-properties.adoc b/modules/reference/pages/properties/object-storage-properties.adoc index 9503f301a..7d8c0e585 100644 --- a/modules/reference/pages/properties/object-storage-properties.adoc +++ b/modules/reference/pages/properties/object-storage-properties.adoc @@ -85,7 +85,7 @@ AWS or GCP bucket that should be used to store data. Maximum size of object storage cache. -If both this property and <> are set, Redpanda uses the minimum of the two. If one of these properties is set to 0, Redpanda applies the non-zero value. If they are both set to 0, the cache size is 0. +If both this property and <> are set, Redpanda uses the minimum of the two. If one of these properties is set to `0`, Redpanda uses the non-zero one. These properties cannot both be `0`. *Units*: bytes From e774996c25d00a17ab5028322decb893056854b9 Mon Sep 17 00:00:00 2001 From: Paulo Borges Date: Mon, 16 Dec 2024 14:29:32 -0300 Subject: [PATCH 05/11] Update with merge --- .../pages/properties/object-storage-properties.adoc | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/modules/reference/pages/properties/object-storage-properties.adoc b/modules/reference/pages/properties/object-storage-properties.adoc index f97d5544f..478c0f2e0 100644 --- a/modules/reference/pages/properties/object-storage-properties.adoc +++ b/modules/reference/pages/properties/object-storage-properties.adoc @@ -317,7 +317,9 @@ Divide the object storage cache across the specified number of buckets. This onl === cloud_storage_cache_size -Maximum size of object storage cache. If both this property and <> are set, Redpanda uses the minimum of the two. +Maximum size of object storage cache. + +If both this property and <> are set, Redpanda uses the minimum of the two. If one of these properties is set to `0`, Redpanda uses the non-zero one. These properties cannot both be `0`. *Requires restart:* No @@ -333,7 +335,9 @@ Maximum size of object storage cache. If both this property and <> controls the same limit expressed as a fixed number of bytes. If both `cloud_storage_cache_size` and `cloud_storage_cache_size_percent` are set, Redpanda uses the minimum of the two. +Maximum size of the cloud cache as a percentage of unreserved disk space disk_reservation_percent. The default value for this option is tuned for a shared disk configuration. Consider increasing the value if using a dedicated cache disk. + +The property <> controls the same limit expressed as a fixed number of bytes. If both `cloud_storage_cache_size` and `cloud_storage_cache_size_percent` are set, Redpanda uses the minimum of the two. If one of these properties is set to 0, Redpanda applies the non-zero value. If they are both set to 0, the cache size is 0. *Unit:* percent From 7ba421fc5cc06f5892764fdb7307cc296dcb9884 Mon Sep 17 00:00:00 2001 From: Paulo Borges Date: Mon, 16 Dec 2024 14:59:13 -0300 Subject: [PATCH 06/11] Update description --- .../properties/object-storage-properties.adoc | 22 +++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) diff --git a/modules/reference/pages/properties/object-storage-properties.adoc b/modules/reference/pages/properties/object-storage-properties.adoc index 478c0f2e0..0859e0751 100644 --- a/modules/reference/pages/properties/object-storage-properties.adoc +++ b/modules/reference/pages/properties/object-storage-properties.adoc @@ -317,9 +317,17 @@ Divide the object storage cache across the specified number of buckets. This onl === cloud_storage_cache_size -Maximum size of object storage cache. +Maximum size of object storage cache in bytes. -If both this property and <> are set, Redpanda uses the minimum of the two. If one of these properties is set to `0`, Redpanda uses the non-zero one. These properties cannot both be `0`. +This property interacts with <>: + +- When they're both set Redpanda uses the minimum calculated value in bytes of the two. + +- If one of these properties is set to `0`, Redpanda uses the non-zero one. + +- These properties cannot both be `0`. + +*Unit*: bytes *Requires restart:* No @@ -335,9 +343,15 @@ If both this property and <> are set, Redpanda === cloud_storage_cache_size_percent -Maximum size of the cloud cache as a percentage of unreserved disk space disk_reservation_percent. The default value for this option is tuned for a shared disk configuration. Consider increasing the value if using a dedicated cache disk. +Maximum size of the cache as a percentage minus the space that Redpanda avoids using defined by the xref:reference:cluster-properties.adoc#disk_reservation_percent[`disk_reservation_percent`] cluster property. This value is calculated at startup and dynamically updated on any changes on either <> or <> + +This property interacts with <>: + +- When they're both set Redpanda uses the minimum value in bytes of the two. + +- If one of these properties is set to `0`, Redpanda uses the non-zero one. -The property <> controls the same limit expressed as a fixed number of bytes. If both `cloud_storage_cache_size` and `cloud_storage_cache_size_percent` are set, Redpanda uses the minimum of the two. If one of these properties is set to 0, Redpanda applies the non-zero value. If they are both set to 0, the cache size is 0. +- These properties cannot both be `0`. *Unit:* percent From b5bea5cd24a90b4e8b4bd3b898c762281db0c29d Mon Sep 17 00:00:00 2001 From: Paulo Borges Date: Mon, 16 Dec 2024 15:09:23 -0300 Subject: [PATCH 07/11] Update description --- .../pages/properties/object-storage-properties.adoc | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/modules/reference/pages/properties/object-storage-properties.adoc b/modules/reference/pages/properties/object-storage-properties.adoc index 0859e0751..b389937fb 100644 --- a/modules/reference/pages/properties/object-storage-properties.adoc +++ b/modules/reference/pages/properties/object-storage-properties.adoc @@ -317,11 +317,11 @@ Divide the object storage cache across the specified number of buckets. This onl === cloud_storage_cache_size -Maximum size of object storage cache in bytes. +Maximum object storage cache size in bytes. This property interacts with <>: -- When they're both set Redpanda uses the minimum calculated value in bytes of the two. +- When they're both set Redpanda uses the smaller calculated value in bytes of the two. - If one of these properties is set to `0`, Redpanda uses the non-zero one. @@ -343,11 +343,11 @@ This property interacts with <> or <> +Maximum size of the cache as a percentage minus the space that Redpanda avoids using defined by the xref:reference:cluster-properties.adoc#disk_reservation_percent[`disk_reservation_percent`] cluster property. Calculated at startup and dynamically updated if this property or or <> changes. This property interacts with <>: -- When they're both set Redpanda uses the minimum value in bytes of the two. +- When they're both set Redpanda uses the smaller calculated value in bytes of the two. - If one of these properties is set to `0`, Redpanda uses the non-zero one. From 81c97cdd8e9045b293185637d2f6fc15294ca085 Mon Sep 17 00:00:00 2001 From: Paulo Borges Date: Mon, 16 Dec 2024 17:13:15 -0300 Subject: [PATCH 08/11] Apply suggestions from code review Co-authored-by: Michele Cyran --- .../properties/object-storage-properties.adoc | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/modules/reference/pages/properties/object-storage-properties.adoc b/modules/reference/pages/properties/object-storage-properties.adoc index b389937fb..980dff821 100644 --- a/modules/reference/pages/properties/object-storage-properties.adoc +++ b/modules/reference/pages/properties/object-storage-properties.adoc @@ -317,13 +317,13 @@ Divide the object storage cache across the specified number of buckets. This onl === cloud_storage_cache_size -Maximum object storage cache size in bytes. +Maximum size of the object storage cache, in bytes. -This property interacts with <>: +This property operates along with <>: -- When they're both set Redpanda uses the smaller calculated value in bytes of the two. +- When both properties are set, Redpanda uses the smaller calculated value of the two, in bytes. -- If one of these properties is set to `0`, Redpanda uses the non-zero one. +- If one of these properties is set to `0`, Redpanda uses the non-zero value. - These properties cannot both be `0`. @@ -343,13 +343,13 @@ This property interacts with <> changes. +Maximum size of the cache as a percentage, minus the space that Redpanda avoids using defined by the xref:reference:cluster-properties.adoc#disk_reservation_percent[`disk_reservation_percent`] cluster property. This is calculated at startup and dynamically updated if either this property or <> changes. -This property interacts with <>: +This property operates along with <>: -- When they're both set Redpanda uses the smaller calculated value in bytes of the two. +- When both properties are set, Redpanda uses the smaller calculated value of the two, in bytes. -- If one of these properties is set to `0`, Redpanda uses the non-zero one. +- If one of these properties is set to `0`, Redpanda uses the non-zero value. - These properties cannot both be `0`. From 67221654b097713282bbb44fa8ac1ae3bd17574a Mon Sep 17 00:00:00 2001 From: Paulo Borges Date: Mon, 16 Dec 2024 17:14:58 -0300 Subject: [PATCH 09/11] Apply suggestions from code review --- .../reference/pages/properties/object-storage-properties.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/reference/pages/properties/object-storage-properties.adoc b/modules/reference/pages/properties/object-storage-properties.adoc index 980dff821..44364d594 100644 --- a/modules/reference/pages/properties/object-storage-properties.adoc +++ b/modules/reference/pages/properties/object-storage-properties.adoc @@ -319,7 +319,7 @@ Divide the object storage cache across the specified number of buckets. This onl Maximum size of the object storage cache, in bytes. -This property operates along with <>: +This property works together with <> to define cache behavior: - When both properties are set, Redpanda uses the smaller calculated value of the two, in bytes. @@ -345,7 +345,7 @@ This property operates along with <> changes. -This property operates along with <>: +This property works together with <> to define cache behavior: - When both properties are set, Redpanda uses the smaller calculated value of the two, in bytes. From b6e9df02169a8336c029e4a5d5f85b2b646d5003 Mon Sep 17 00:00:00 2001 From: Paulo Borges Date: Mon, 16 Dec 2024 18:05:54 -0300 Subject: [PATCH 10/11] Apply suggestions from code review --- .../reference/pages/properties/object-storage-properties.adoc | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/modules/reference/pages/properties/object-storage-properties.adoc b/modules/reference/pages/properties/object-storage-properties.adoc index 44364d594..16cad0370 100644 --- a/modules/reference/pages/properties/object-storage-properties.adoc +++ b/modules/reference/pages/properties/object-storage-properties.adoc @@ -343,7 +343,7 @@ This property works together with <> changes. +Maximum size of the cache as a percentage, minus the space that Redpanda avoids using defined by the xref:reference:cluster-properties.adoc#disk_reservation_percent[`disk_reservation_percent`] cluster property. This is calculated at startup and dynamically updated if either this property, `disk_reservation_percent`, or <> changes. This property works together with <> to define cache behavior: @@ -353,6 +353,8 @@ This property works together with < Date: Mon, 16 Dec 2024 18:21:07 -0300 Subject: [PATCH 11/11] Update modules/reference/pages/properties/object-storage-properties.adoc --- .../reference/pages/properties/object-storage-properties.adoc | 2 ++ 1 file changed, 2 insertions(+) diff --git a/modules/reference/pages/properties/object-storage-properties.adoc b/modules/reference/pages/properties/object-storage-properties.adoc index 16cad0370..b87c9518f 100644 --- a/modules/reference/pages/properties/object-storage-properties.adoc +++ b/modules/reference/pages/properties/object-storage-properties.adoc @@ -327,6 +327,8 @@ This property works together with <