bump: operator-rs 0.52.1 (#405)

* bump: operator-rs 0.52.1 * add doc review comments --------- Co-authored-by: Malte Sander <[email protected]>
stackabletech · Oct 5, 2023 · 9830327 · 9830327
1 parent cca1dc8
commit 9830327
Show file tree

Hide file tree

Showing 7 changed files with 19 additions and 10 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -14,7 +14,7 @@ All notable changes to this project will be documented in this file.
 
 - `vector` `0.26.0` -> `0.31.0` ([#378]).
 - Let secret-operator handle certificate conversion ([#392]).
-- `operator-rs` `0.44.0` -> `0.52.0` ([#381], [#394], [#404]).
+- `operator-rs` `0.44.0` -> `0.52.1` ([#381], [#394], [#404], [#405]).
 
 ### Fixed
 
@@ -27,6 +27,7 @@ All notable changes to this project will be documented in this file.
 [#394]: https://github.com/stackabletech/hdfs-operator/pull/394
 [#402]: https://github.com/stackabletech/hdfs-operator/pull/402
 [#404]: https://github.com/stackabletech/hdfs-operator/pull/404
+[#405]: https://github.com/stackabletech/hdfs-operator/pull/405
 
 ## [23.7.0] - 2023-07-14
 

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -23,7 +23,7 @@ serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
 serde_yaml = "0.9"
 snafu = "0.7"
-stackable-operator = { git = "https://github.com/stackabletech/operator-rs.git", tag = "0.52.0" }
+stackable-operator = { git = "https://github.com/stackabletech/operator-rs.git", tag = "0.52.1" }
 strum = { version = "0.25", features = ["derive"] }
 tokio = { version = "1.29", features = ["full"] }
 tracing = "0.1"

diff --git a/deploy/helm/hdfs-operator/crds/crds.yaml b/deploy/helm/hdfs-operator/crds/crds.yaml
@@ -94,6 +94,7 @@ spec:
                       type: boolean
                   type: object
                 dataNodes:
+                  description: This struct represents a role - e.g. HDFS datanodes or Trino workers. It has a [`HashMap`] containing all the roleGroups that are part of this role. Additionally, there is a `config`, which is configurable at the role *and* roleGroup level. Everything at roleGroup level is merged on top of what is configured on role level using the [`Merge`] trait. There is also a second form of config, which can only be configured at role level, the `roleConfig`.
                   nullable: true
                   properties:
                     cliOverrides:
@@ -3558,11 +3559,13 @@ spec:
                         podDisruptionBudget:
                           enabled: true
                           maxUnavailable: null
+                      description: This is a product-agnostic RoleConfig, which is sufficient for most of the products.
                       properties:
                         podDisruptionBudget:
                           default:
                             enabled: true
                             maxUnavailable: null
+                          description: 'This struct is used to configure: 1.) If PodDisruptionBudgets are created by the operator 2.) The allowed number of Pods to be unavailable (`maxUnavailable`)'
                           properties:
                             enabled:
                               default: true
@@ -7120,6 +7123,7 @@ spec:
                       type: string
                   type: object
                 journalNodes:
+                  description: This struct represents a role - e.g. HDFS datanodes or Trino workers. It has a [`HashMap`] containing all the roleGroups that are part of this role. Additionally, there is a `config`, which is configurable at the role *and* roleGroup level. Everything at roleGroup level is merged on top of what is configured on role level using the [`Merge`] trait. There is also a second form of config, which can only be configured at role level, the `roleConfig`.
                   nullable: true
                   properties:
                     cliOverrides:
@@ -10575,11 +10579,13 @@ spec:
                         podDisruptionBudget:
                           enabled: true
                           maxUnavailable: null
+                      description: This is a product-agnostic RoleConfig, which is sufficient for most of the products.
                       properties:
                         podDisruptionBudget:
                           default:
                             enabled: true
                             maxUnavailable: null
+                          description: 'This struct is used to configure: 1.) If PodDisruptionBudgets are created by the operator 2.) The allowed number of Pods to be unavailable (`maxUnavailable`)'
                           properties:
                             enabled:
                               default: true
@@ -14086,6 +14092,7 @@ spec:
                     - roleGroups
                   type: object
                 nameNodes:
+                  description: This struct represents a role - e.g. HDFS datanodes or Trino workers. It has a [`HashMap`] containing all the roleGroups that are part of this role. Additionally, there is a `config`, which is configurable at the role *and* roleGroup level. Everything at roleGroup level is merged on top of what is configured on role level using the [`Merge`] trait. There is also a second form of config, which can only be configured at role level, the `roleConfig`.
                   nullable: true
                   properties:
                     cliOverrides:
@@ -17541,11 +17548,13 @@ spec:
                         podDisruptionBudget:
                           enabled: true
                           maxUnavailable: null
+                      description: This is a product-agnostic RoleConfig, which is sufficient for most of the products.
                       properties:
                         podDisruptionBudget:
                           default:
                             enabled: true
                             maxUnavailable: null
+                          description: 'This struct is used to configure: 1.) If PodDisruptionBudgets are created by the operator 2.) The allowed number of Pods to be unavailable (`maxUnavailable`)'
                           properties:
                             enabled:
                               default: true

diff --git a/docs/modules/hdfs/pages/usage-guide/operations/graceful-shutdown.adoc b/docs/modules/hdfs/pages/usage-guide/operations/graceful-shutdown.adoc
@@ -3,5 +3,4 @@
 Graceful shutdown of HDFS nodes is either not supported by the product itself
 or we have not implemented it yet.
 
-The efforts of implementing graceful shutdown for all products that have this functionality is tracked in
-https://github.com/stackabletech/issues/issues/357
+Outstanding implementation work for the graceful shutdowns of all products where this functionality is relevant is tracked in https://github.com/stackabletech/issues/issues/357
diff --git a/docs/modules/hdfs/pages/usage-guide/operations/index.adoc b/docs/modules/hdfs/pages/usage-guide/operations/index.adoc
@@ -2,4 +2,4 @@
 
 This section of the documentation is intended for the operations teams that maintain a Stackable Data Platform installation.
 
-Please read on the xref:concepts:operations/index.adoc[Concepts page on Operations] with the necessary details to operate the platform in a production environment.
+Please read the xref:concepts:operations/index.adoc[Concepts page on Operations] that contains the necessary details to operate the platform in a production environment.
diff --git a/docs/modules/hdfs/pages/usage-guide/operations/pod-disruptions.adoc b/docs/modules/hdfs/pages/usage-guide/operations/pod-disruptions.adoc
@@ -1,7 +1,7 @@
 
 = Allowed Pod disruptions
 
-You can configure the allowed Pod disruptions for HDFS nodes as described in xref:concepts:operations/pod_disruptions.adoc[].
+You can configure the permitted Pod disruptions for HDFS nodes as described in xref:concepts:operations/pod_disruptions.adoc[].
 
 Unless you configure something else or disable our PodDisruptionBudgets (PDBs), we write the following PDBs:
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2,4 +2,4 @@

		This section of the documentation is intended for the operations teams that maintain a Stackable Data Platform installation.

		Please read on the xref:concepts:operations/index.adoc[Concepts page on Operations] with the necessary details to operate the platform in a production environment.
		Please read the xref:concepts:operations/index.adoc[Concepts page on Operations] that contains the necessary details to operate the platform in a production environment.