feat: Support putting TrustStore information in Secret

Author: sbernauer

deploy/helm/secret-operator/crds/crds.yaml

@@ -392,6 +392,18 @@ spec:
                     - kerberos
                   nullable: true
                   type: string
+                outputResource:
+                  default: ConfigMap
+                  description: |-
+                    Which Kubernetes resource should be used to output the requested information to.
+
+                    The trust information (such as a `ca.crt`) can be considered public information, so we put it in a `ConfigMap` by default. However, some tools (such as OpenShift routes) require it to be placed in a `Secret`, so we also support that.
+
+                    Can be either `ConfigMap` or `Secret`, defaults to `ConfigMap`.
+                  enum:
+                    - Secret
+                    - ConfigMap
+                  type: string
                 secretClassName:
                   description: The name of the SecretClass that the request concerns.
                   type: string

rust/operator-binary/src/crd.rs

@@ -518,10 +518,28 @@ pub struct TrustStoreSpec {
     /// The name of the SecretClass that the request concerns.
     pub secret_class_name: String,
 
+    /// Which Kubernetes resource should be used to output the requested information to.
+    ///
+    /// The trust information (such as a `ca.crt`) can be considered public information, so we put
+    /// it in a `ConfigMap` by default. However, some tools (such as OpenShift routes) require it
+    /// to be placed in a `Secret`, so we also support that.
+    ///
+    /// Can be either `ConfigMap` or `Secret`, defaults to `ConfigMap`.
+    #[serde(default)]
+    pub output_resource: TrustStoreOutputType,
+
     /// The [format](DOCS_BASE_URL_PLACEHOLDER/secret-operator/secretclass#format) that the data should be converted into.
     pub format: Option<SecretFormat>,
 }
 
+#[derive(Clone, Debug, Default, PartialEq, JsonSchema, Serialize, Deserialize)]
+pub enum TrustStoreOutputType {
+    Secret,
+
+    #[default]
+    ConfigMap,
+}
+
 #[cfg(test)]
 mod test {
     use super::*;

rust/operator-binary/src/truststore_controller.rs

@@ -32,7 +32,7 @@ use strum::{EnumDiscriminants, IntoStaticStr};
 use crate::{
     OPERATOR_NAME,
     backend::{self, SecretBackendError, TrustSelector},
-    crd::{SearchNamespaceMatchCondition, SecretClass, TrustStore},
+    crd::{SearchNamespaceMatchCondition, SecretClass, TrustStore, TrustStoreOutputType},
     format::{
         self,
         well_known::{CompatibilityOptions, NamingOptions},
@@ -82,6 +82,11 @@ pub async fn start(client: &stackable_operator::client::Client, watch_namespace:
             watch_namespace.get_api::<PartialObjectMeta<ConfigMap>>(client),
             watcher::Config::default(),
         )
+        // TODO: merge this into the other Secret watch
+        .owns(
+            watch_namespace.get_api::<PartialObjectMeta<Secret>>(client),
+            watcher::Config::default(),
+        )
         .watches(
             watch_namespace.get_api::<PartialObjectMeta<ConfigMap>>(client),
             watcher::Config::default(),
@@ -205,7 +210,14 @@ pub enum Error {
         source: stackable_operator::client::Error,
         config_map: ObjectRef<ConfigMap>,
     },
+
+    #[snafu(display("failed to apply target {secret} for the TrustStore"))]
+    ApplyTrustStoreSecret {
+        source: stackable_operator::client::Error,
+        secret: ObjectRef<Secret>,
+    },
 }
+
 type Result<T, E = Error> = std::result::Result<T, E>;
 impl ReconcilerError for Error {
     fn category(&self) -> &'static str {
@@ -222,6 +234,7 @@ impl ReconcilerError for Error {
             Error::FormatData { secret_class, .. } => Some(secret_class.clone().erase()),
             Error::BuildOwnerReference { .. } => None,
             Error::ApplyTrustStoreConfigMap { config_map, .. } => Some(config_map.clone().erase()),
+            Error::ApplyTrustStoreSecret { secret, .. } => Some(secret.clone().erase()),
         }
     }
 }
@@ -264,7 +277,7 @@ async fn reconcile(
         .get_trust_data(&selector)
         .await
         .context(BackendGetTrustDataSnafu)?;
-    let (Flattened(string_data), Flattened(binary_data)) = trust_data
+    let trust_file_contents = trust_data
         .data
         .into_files(
             truststore.spec.format,
@@ -273,30 +286,53 @@ async fn reconcile(
         )
         .context(FormatDataSnafu {
             secret_class: secret_class_ref,
-        })?
+        })?;
+    let (Flattened(string_data), Flattened(binary_data)) = trust_file_contents
         .into_iter()
-        // Try to put valid UTF-8 data into `data`, but fall back to `binary_data` otherwise
+        // Try to put valid UTF-8 data into `string_data`, but fall back to `binary_data` otherwise
         .map(|(k, v)| match String::from_utf8(v) {
             Ok(v) => (Some((k, v)), None),
             Err(v) => (None, Some((k, ByteString(v.into_bytes())))),
         })
         .collect();
-    let trust_cm = ConfigMap {
-        metadata: ObjectMetaBuilder::new()
-            .name_and_namespace(truststore)
-            .ownerreference_from_resource(truststore, None, Some(true))
-            .context(BuildOwnerReferenceSnafu)?
-            .build(),
-        data: Some(string_data),
-        binary_data: Some(binary_data),
-        ..Default::default()
-    };
-    ctx.client
-        .apply_patch(CONTROLLER_NAME, &trust_cm, &trust_cm)
-        .await
-        .context(ApplyTrustStoreConfigMapSnafu {
-            config_map: &trust_cm,
-        })?;
+
+    let trust_metadata = ObjectMetaBuilder::new()
+        .name_and_namespace(truststore)
+        .ownerreference_from_resource(truststore, None, Some(true))
+        .context(BuildOwnerReferenceSnafu)?
+        .build();
+
+    match truststore.spec.output_resource {
+        TrustStoreOutputType::ConfigMap => {
+            let trust_cm = ConfigMap {
+                metadata: trust_metadata,
+                data: Some(string_data),
+                binary_data: Some(binary_data),
+                ..Default::default()
+            };
+            ctx.client
+                .apply_patch(CONTROLLER_NAME, &trust_cm, &trust_cm)
+                .await
+                .context(ApplyTrustStoreConfigMapSnafu {
+                    config_map: &trust_cm,
+                })?;
+        }
+        TrustStoreOutputType::Secret => {
+            let trust_secret = Secret {
+                metadata: trust_metadata,
+                string_data: Some(string_data),
+                data: Some(binary_data),
+                ..Default::default()
+            };
+            ctx.client
+                .apply_patch(CONTROLLER_NAME, &trust_secret, &trust_secret)
+                .await
+                .context(ApplyTrustStoreSecretSnafu {
+                    secret: &trust_secret,
+                })?;
+        }
+    }
+
     Ok(controller::Action::await_change())
 }
 

tests/templates/kuttl/tls-truststore/01-create-secretclass.yaml

@@ -0,0 +1,5 @@
+---
+apiVersion: kuttl.dev/v1beta1
+kind: TestStep
+commands:
+  - script: envsubst '$NAMESPACE' < 01_secretclass.yaml | kubectl --namespace=$NAMESPACE apply -f -

tests/templates/kuttl/tls-truststore/01-secretclass.yaml

@@ -4,17 +4,18 @@ kind: TestAssert
 timeout: 5
 ---
 apiVersion: v1
-kind: ConfigMap
+kind: {{ test_scenario['values']['truststore-output-resource'] }}
 metadata:
   name: truststore-pem
 # data is validated in 03-assert.yaml
 ---
 apiVersion: v1
-kind: ConfigMap
+kind: {{ test_scenario['values']['truststore-output-resource'] }}
 metadata:
   name: truststore-pkcs12
 # data is validated in 03-assert.yaml
 ---
+{% if test_scenario['values']['truststore-output-resource'] == 'ConfigMap' %}
 apiVersion: v1
 kind: ConfigMap
 metadata:
@@ -26,3 +27,13 @@ data:
 binaryData:
   # Should stay binary since it is not legal UTF-8
   actuallyBinary: aWxsZWdhbIB1dGYtOA==
+{% else %}
+apiVersion: v1
+kind: Secret
+metadata:
+  name: truststore-k8ssearch
+data:
+  foo: YmFy
+  baz: aGVsbG8=
+  actuallyBinary: aWxsZWdhbIB1dGYtOA==
+{% endif %}

tests/templates/kuttl/tls-truststore/secretclass.yaml renamed to tests/templates/kuttl/tls-truststore/01_secretclass.yaml

@@ -0,0 +1,5 @@
+---
+apiVersion: kuttl.dev/v1beta1
+kind: TestStep
+commands:
+  - script: envsubst '$NAMESPACE' < 02_truststore.yaml | kubectl --namespace=$NAMESPACE apply -f -

tests/templates/kuttl/tls-truststore/02-assert.yaml renamed to tests/templates/kuttl/tls-truststore/02-assert.yaml.j2

@@ -7,6 +7,7 @@ metadata:
 spec:
   secretClassName: tls-$NAMESPACE
   format: tls-pem
+  outputResource: {{ test_scenario['values']['truststore-output-resource'] }}
 ---
 apiVersion: secrets.stackable.tech/v1alpha1
 kind: TrustStore
@@ -15,10 +16,12 @@ metadata:
 spec:
   secretClassName: tls-$NAMESPACE
   format: tls-pkcs12
+  outputResource: {{ test_scenario['values']['truststore-output-resource'] }}
 ---
 apiVersion: secrets.stackable.tech/v1alpha1
 kind: TrustStore
 metadata:
   name: truststore-k8ssearch
 spec:
   secretClassName: k8ssearch-$NAMESPACE
+  outputResource: {{ test_scenario['values']['truststore-output-resource'] }}