feat: Support dynamic image repositories

Author: Techassi

Cargo.lock

@@ -11,7 +11,7 @@ repository = "https://github.com/stackabletech/zookeeper-operator"
 
 [workspace.dependencies]
 product-config = { git = "https://github.com/stackabletech/product-config.git", tag = "0.8.0" }
-stackable-operator = { git = "https://github.com/stackabletech/operator-rs.git", tag = "stackable-operator-0.110.1", features = ["webhook"] }
+stackable-operator = { git = "https://github.com/stackabletech/operator-rs.git", tag = "stackable-operator-0.111.1", features = ["webhook"] }
 
 anyhow = "1.0"
 built = { version = "0.8", features = ["chrono", "git2"] }

Cargo.nix

@@ -145,8 +145,9 @@ spec:
                 properties:
                   custom:
                     description: |-
-                      Overwrite the docker image.
-                      Specify the full docker image name, e.g. `oci.stackable.tech/sdp/superset:1.4.1-stackable2.1.0`
+                      Provide a custom container image.
+
+                      Specify the full container image name, e.g. `oci.example.tech/namespace/superset:1.4.1-my-tag`
                     type: string
                   productVersion:
                     description: Version of the product, e.g. `1.4.1`.
@@ -173,14 +174,20 @@ spec:
                     nullable: true
                     type: array
                   repo:
-                    description: Name of the docker repo, e.g. `oci.stackable.tech/sdp`
+                    description: |-
+                      The repository on the container image registry where the container image is located, e.g.
+                      `oci.example.com/namespace`.
+
+                      If not specified, the operator will use the image registry provided via the operator
+                      environment options.
                     nullable: true
                     type: string
                   stackableVersion:
                     description: |-
                       Stackable version of the product, e.g. `23.4`, `23.4.1` or `0.0.0-dev`.
-                      If not specified, the operator will use its own version, e.g. `23.4.1`.
-                      When using a nightly operator or a pr version, it will use the nightly `0.0.0-dev` image.
+
+                      If not specified, the operator will use its own version, e.g. `23.4.1`. When using a nightly
+                      operator or a PR version, it will use the nightly `0.0.0-dev` image.
                     nullable: true
                     type: string
                 type: object

Cargo.toml

@@ -158,6 +158,7 @@ async fn main() -> anyhow::Result<()> {
                     zk_controller::reconcile_zk,
                     zk_controller::error_policy,
                     Arc::new(zk_controller::Ctx {
+                        operator_environment: operator_environment.clone(),
                         client: client.clone(),
                         product_config,
                     }),
@@ -224,6 +225,7 @@ async fn main() -> anyhow::Result<()> {
                     znode_controller::error_policy,
                     Arc::new(znode_controller::Ctx {
                         client: client.clone(),
+                        operator_environment,
                     }),
                 )
                 // We can let the reporting happen in the background

crate-hashes.json

@@ -28,6 +28,7 @@ use stackable_operator::{
             volume::{ListenerOperatorVolumeSourceBuilder, ListenerReference},
         },
     },
+    cli::OperatorEnvironmentOptions,
     cluster_resources::{ClusterResourceApplyStrategy, ClusterResources},
     commons::{
         product_image_selection::{self, ResolvedProductImage},
@@ -80,7 +81,7 @@ use crate::{
     command::create_init_container_command_args,
     config::jvm::{construct_non_heap_jvm_args, construct_zk_server_heap_env},
     crd::{
-        DOCKER_IMAGE_BASE_NAME, JMX_METRICS_PORT_NAME, JVM_SECURITY_PROPERTIES_FILE,
+        CONTAINER_IMAGE_BASE_NAME, JMX_METRICS_PORT_NAME, JVM_SECURITY_PROPERTIES_FILE,
         MAX_PREPARE_LOG_FILE_SIZE, MAX_ZK_LOG_FILES_SIZE, METRICS_PROVIDER_HTTP_PORT_NAME,
         STACKABLE_CONFIG_DIR, STACKABLE_DATA_DIR, STACKABLE_LOG_CONFIG_DIR, STACKABLE_LOG_DIR,
         STACKABLE_RW_CONFIG_DIR, ZOOKEEPER_ELECTION_PORT, ZOOKEEPER_ELECTION_PORT_NAME,
@@ -108,6 +109,7 @@ pub const LISTENER_VOLUME_DIR: &str = "/stackable/listener";
 pub struct Ctx {
     pub client: stackable_operator::client::Client,
     pub product_config: ProductConfigManager,
+    pub operator_environment: OperatorEnvironmentOptions,
 }
 
 type Result<T, E = Error> = std::result::Result<T, E>;
@@ -365,7 +367,11 @@ pub async fn reconcile_zk(
     let resolved_product_image = zk
         .spec
         .image
-        .resolve(DOCKER_IMAGE_BASE_NAME, crate::built_info::PKG_VERSION)
+        .resolve(
+            CONTAINER_IMAGE_BASE_NAME,
+            &ctx.operator_environment.image_repository,
+            crate::built_info::PKG_VERSION,
+        )
         .context(ResolveProductImageSnafu)?;
 
     let mut cluster_resources = ClusterResources::new(
@@ -1149,7 +1155,7 @@ mod tests {
         let resolved_product_image = zookeeper
             .spec
             .image
-            .resolve(DOCKER_IMAGE_BASE_NAME, "0.0.0-dev")
+            .resolve(CONTAINER_IMAGE_BASE_NAME, "oci.example.org", "0.0.0-dev")
             .expect("test resolved product image is always valid");
 
         let validated_config = validate_all_roles_and_groups_config(

extra/crds.yaml

@@ -6,6 +6,7 @@ use std::{borrow::Cow, convert::Infallible, sync::Arc};
 use const_format::concatcp;
 use snafu::{OptionExt, ResultExt, Snafu};
 use stackable_operator::{
+    cli::OperatorEnvironmentOptions,
     cluster_resources::{ClusterResourceApplyStrategy, ClusterResources},
     commons::product_image_selection::{self, ResolvedProductImage},
     crd::listener,
@@ -25,7 +26,7 @@ use tracing::{debug, info};
 
 use crate::{
     APP_NAME, OPERATOR_NAME,
-    crd::{DOCKER_IMAGE_BASE_NAME, ZookeeperRole, security::ZookeeperSecurity, v1alpha1},
+    crd::{CONTAINER_IMAGE_BASE_NAME, ZookeeperRole, security::ZookeeperSecurity, v1alpha1},
     discovery::{self, build_discovery_configmap},
     listener::role_listener_name,
 };
@@ -35,6 +36,7 @@ pub const ZNODE_FULL_CONTROLLER_NAME: &str = concatcp!(ZNODE_CONTROLLER_NAME, '.
 
 pub struct Ctx {
     pub client: stackable_operator::client::Client,
+    pub operator_environment: OperatorEnvironmentOptions,
 }
 
 #[derive(Snafu, Debug, EnumDiscriminants)]
@@ -253,7 +255,11 @@ pub async fn reconcile_znode(
                     let resolved_product_image = zk
                         .spec
                         .image
-                        .resolve(DOCKER_IMAGE_BASE_NAME, crate::built_info::PKG_VERSION)
+                        .resolve(
+                            CONTAINER_IMAGE_BASE_NAME,
+                            &ctx.operator_environment.image_repository,
+                            crate::built_info::PKG_VERSION,
+                        )
                         .context(ResolveProductImageSnafu)?;
                     reconcile_apply(client, &znode, Ok(zk), &znode_path, &resolved_product_image)
                         .await