Allow changing configuration options

config.yaml

@@ -0,0 +1,106 @@
+version: 0.1.0
+spec:
+  units:
+    - unit: &unitDirectory
+        name: "directory"
+        regex: "^/|(/[\\w-]+)+$"
+        examples:
+          - "/tmp/xyz"
+    - unit: &unitPort
+        name: "port"
+        regex: "^([0-9]{1,4}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])$"
+properties:
+  - property: &tickTime
+      propertyNames:
+        - name: "tickTime"
+          kind:
+            type: "file"
+            file: "zoo.cfg"
+      datatype:
+        type: "integer"
+        min: "1"
+      recommendedValues:
+        - fromVersion: "0.0.0"
+          value: "3000"
+      roles:
+        - name: "server"
+          required: true
+      asOfVersion: "0.0.0"
+      comment: "ZK only checks whether the value is 0, all other values (including negative ones) are considered valid, we disallow negative values here, see QuorumPeerConfig.java"
+      description: "The basic time unit in milliseconds used by ZooKeeper. It is used to do heartbeats and the minimum session timeout will be twice the tickTime."
+
+  - property: &clientPort
+      propertyNames:
+        - name: "clientPort"
+          kind:
+            type: "file"
+            file: "zoo.cfg"
+      datatype:
+        type: "string"
+        unit: *unitPort
+      defaultValues:
+        - value: "2181"
+      recommendedValues:
+        - value: "2181"
+      roles:
+        - name: "server"
+          required: true
+      asOfVersion: "0.0.0"
+      comment: "See QuorumPeerConfig.java, I'm unsure what happens when this is set to 0, it might work, it might not"
+      description: "The port to listen for client connections; that is, the port that clients attempt to connect to."
+
+  - property: &dataDir
+      propertyNames:
+        - name: "dataDir"
+          kind:
+            type: "file"
+            file: "zoo.cfg"
+      datatype:
+        type: "string"
+        unit: *unitDirectory
+      recommendedValues:
+        - value: "/tmp/zookeeper"
+      roles:
+        - name: "server"
+          required: true
+      asOfVersion: "0.0.0"
+      comment: "See QuorumPeerConfig.java"
+      description: "The location where ZooKeeper will store the in-memory database snapshots and, unless specified otherwise, the transaction log of updates to the database. Note: Be careful where you put the transaction log. A dedicated transaction log device is key to consistent good performance. Putting the log on a busy device will adversely affect performance."
+
+  # Role required "true" is only correct if more than one zookeeper instances is used.
+  - property: &initLimit
+      propertyNames:
+        - name: "initLimit"
+          kind:
+            type: "file"
+            file: "zoo.cfg"
+      datatype:
+        type: "integer"
+        min: "1"
+      recommendedValues:
+        - value: "5"
+      roles:
+        - name: "server"
+          required: true
+      asOfVersion: "0.0.0"
+      comment: "ZK only checks whether the value is 0, all other values (including negative ones) are considered valid, we disallow negative values here, see QuorumPeerConfig.java"
+      description: "Amount of time, in ticks (see `tickTime`), to allow followers to connect and sync to a leader. Increased this value as needed, if the amount of data managed by ZooKeeper is large."
+
+  # Role required "true" is only correct if more than one zookeeper instances is used.
+  - property: &syncLimit
+      propertyNames:
+        - name: "syncLimit"
+          kind:
+            type: "file"
+            file: "zoo.cfg"
+      datatype:
+        type: "integer"
+        min: "1"
+      recommendedValues:
+        - value: "2"
+      roles:
+        - name: "server"
+          required: true
+      asOfVersion: "0.0.0"
+      comment: "ZK only checks whether the value is 0, all other values (including negative ones) are considered valid, we disallow negative values here, see QuorumPeerConfig.java"
+      description: "Amount of time, in ticks (see `tickTime`), to allow followers to sync with ZooKeeper. If followers fall too far behind a leader, they will be dropped. In other words: The number of ticks that can pass between sending a request and getting an acknowledgment before a follower is dropped."

crd/Cargo.toml

@@ -7,23 +7,23 @@ name = "stackable-zookeeper-crd"
 version = "0.1.0-nightly"
 
 [dependencies]
+product-config = { git = "https://github.com/stackabletech/product-config.git", branch = "main" }
 stackable-operator = { git = "https://github.com/stackabletech/operator-rs.git", branch = "main" }
 
-k8s-openapi = { version = "0.11", default-features = false }
-kube = { version = "0.56", default-features = false, features = ["derive", "jsonpatch"] }
+k8s-openapi = { version = "0.12", default-features = false, features = ["v1_20"] }
+kube = { version = "0.57", default-features = false, features = ["derive", "jsonpatch"] }
 schemars = "0.8"
 semver = "1.0"
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
-serde_yaml = "0.8"
 strum = "0.21"
 strum_macros = "0.21"
 thiserror = "1.0"
 tracing = "0.1"
 
 [dev-dependencies]
 indoc = "1.0"
-k8s-openapi = { version = "0.11", default-features = false, features = ["v1_20"] }
+k8s-openapi = { version = "0.12", default-features = false, features = ["v1_20"] }
 rstest = "0.10"
 serde_yaml = "0.8"
 

crd/src/bin/generate_crd.rs

@@ -1,15 +1,10 @@
+use stackable_operator::crd::CustomResourceExt;
 use stackable_zookeeper_crd::ZookeeperCluster;
-use std::fs;
 
 fn main() {
-    let target_file = "./crd/zookeepercluster.crd.yaml";
-    let schema = ZookeeperCluster::crd();
-    let string_schema = match serde_yaml::to_string(&schema) {
-        Ok(schema) => schema,
-        Err(err) => panic!("Failed to retrieve CRD: [{}]", err),
-    };
-    match fs::write(target_file, string_schema) {
-        Ok(()) => println!("Successfully wrote CRD to file."),
-        Err(err) => println!("Failed to write file: [{}]", err),
+    let target_file = "deploy/crd/zookeepercluster.crd.yaml";
+    match ZookeeperCluster::write_yaml_schema(target_file) {
+        Ok(_) => println!("Wrote CRD to [{}]", target_file),
+        Err(err) => println!("Could not write CRD to [{}]: {:?}", target_file, err),
     }
 }

crd/src/lib.rs

@@ -1,53 +1,82 @@
 pub mod error;
 pub mod util;
 
-use k8s_openapi::apimachinery::pkg::apis::meta::v1::{Condition, LabelSelector};
+use k8s_openapi::apimachinery::pkg::apis::meta::v1::Condition;
 use kube::CustomResource;
 use schemars::JsonSchema;
 use semver::{Error as SemVerError, Version};
 use serde::{Deserialize, Serialize};
-use stackable_operator::label_selector;
+use stackable_operator::product_config_utils::{ConfigError, Configuration};
+use stackable_operator::role_utils::Role;
 use stackable_operator::status::Conditions;
-use stackable_operator::Crd;
-use std::collections::HashMap;
+use std::collections::BTreeMap;
 
 pub const APP_NAME: &str = "zookeeper";
-pub const MANAGED_BY: &str = "stackable-zookeeper";
+pub const MANAGED_BY: &str = "zookeeper-operator";
 
 // TODO: We need to validate the name of the cluster because it is used in pod and configmap names, it can't bee too long
 // This probably also means we shouldn't use the node_names in the pod_name...
 #[derive(Clone, CustomResource, Debug, Deserialize, JsonSchema, PartialEq, Serialize)]
 #[kube(
     group = "zookeeper.stackable.tech",
-    version = "v1",
+    version = "v1alpha1",
     kind = "ZookeeperCluster",
+    plural = "zookeeperclusters",
     shortname = "zk",
     namespaced
 )]
 #[kube(status = "ZookeeperClusterStatus")]
 pub struct ZookeeperClusterSpec {
     pub version: ZookeeperVersion,
-    pub servers: RoleGroups<ZookeeperConfig>,
+    pub servers: Role<ZookeeperConfig>,
 }
 
-#[derive(Clone, Debug, Deserialize, JsonSchema, PartialEq, Serialize)]
+// TODO: These all should be "Property" Enums that can be either simple or complex where complex allows forcing/ignoring errors and/or warnings
+#[derive(Clone, Debug, Deserialize, Eq, JsonSchema, PartialEq, Serialize)]
 #[serde(rename_all = "camelCase")]
-pub struct RoleGroups<T> {
-    pub selectors: HashMap<String, SelectorAndConfig<T>>,
+pub struct ZookeeperConfig {
+    pub client_port: Option<u16>, // int in Java
+    pub data_dir: Option<String>, // String in Java
+    pub init_limit: Option<u32>,  // int in Java
+    pub sync_limit: Option<u32>,  // int in Java
+    pub tick_time: Option<u32>,   // int in Java
 }
 
-#[derive(Clone, Debug, Deserialize, JsonSchema, PartialEq, Serialize)]
-#[serde(rename_all = "camelCase")]
-pub struct SelectorAndConfig<T> {
-    pub instances: u16,
-    pub instances_per_node: u8,
-    pub config: Option<T>,
-    #[schemars(schema_with = "label_selector::schema")]
-    pub selector: Option<LabelSelector>,
-}
+impl Configuration for ZookeeperConfig {
+    type Configurable = ZookeeperCluster;
 
-#[derive(Clone, Debug, Deserialize, Eq, JsonSchema, PartialEq, Serialize)]
-pub struct ZookeeperConfig {}
+    fn compute_env(
+        &self,
+        _resource: &Self::Configurable,
+        _role_name: &str,
+    ) -> Result<BTreeMap<String, Option<String>>, ConfigError> {
+        Ok(BTreeMap::new())
+    }
+
+    fn compute_cli(
+        &self,
+        _resource: &Self::Configurable,
+        _role_name: &str,
+    ) -> Result<BTreeMap<String, Option<String>>, ConfigError> {
+        Ok(BTreeMap::new())
+    }
+
+    fn compute_files(
+        &self,
+        _resource: &Self::Configurable,
+        _role_name: &str,
+        _file: &str,
+    ) -> Result<BTreeMap<String, Option<String>>, ConfigError> {
+        let temp = product_config::ser::to_hash_map(self).map_err(|err| {
+            ConfigError::InvalidConfiguration {
+                reason: format!("Could not deserialize config: {}", err.to_string()),
+            }
+        })?;
+        let result: BTreeMap<String, Option<String>> =
+            temp.into_iter().map(|(k, v)| (k, Some(v))).collect();
+        Ok(result)
+    }
+}
 
 impl Conditions for ZookeeperCluster {
     fn conditions(&self) -> Option<&[Condition]> {
@@ -66,11 +95,6 @@ impl Conditions for ZookeeperCluster {
     }
 }
 
-impl Crd for ZookeeperCluster {
-    const RESOURCE_NAME: &'static str = "zookeeperclusters.zookeeper.stackable.tech";
-    const CRD_DEFINITION: &'static str = include_str!("../../deploy/crd/zookeepercluster.crd.yaml");
-}
-
 #[allow(non_camel_case_types)]
 #[derive(
     Clone,