|
| 1 | +//! Builds the discovery [`ConfigMap`] clients use to connect to an `OpaCluster`. |
| 2 | +//! |
| 3 | +//! The content comes entirely from the [`ValidatedCluster`] (plus the externally-resolved role |
| 4 | +//! [`Service`] and `cluster_info`); the owner object is only used for the owner reference and |
| 5 | +//! object metadata. |
| 6 | +
|
| 7 | +use snafu::{OptionExt, ResultExt, Snafu}; |
| 8 | +use stackable_operator::{ |
| 9 | + builder::{configmap::ConfigMapBuilder, meta::ObjectMetaBuilder}, |
| 10 | + k8s_openapi::api::core::v1::{ConfigMap, Service}, |
| 11 | + kube::runtime::reflector::ObjectRef, |
| 12 | + utils::cluster_info::KubernetesClusterInfo, |
| 13 | +}; |
| 14 | + |
| 15 | +use crate::{ |
| 16 | + controller::{build_recommended_labels, validate::ValidatedCluster}, |
| 17 | + crd::{OpaRole, v1alpha2}, |
| 18 | + service::{APP_PORT, APP_TLS_PORT}, |
| 19 | +}; |
| 20 | + |
| 21 | +#[derive(Snafu, Debug)] |
| 22 | +pub enum Error { |
| 23 | + #[snafu(display("object {} is missing metadata to build owner reference", opa))] |
| 24 | + ObjectMissingMetadataForOwnerRef { |
| 25 | + source: stackable_operator::builder::meta::Error, |
| 26 | + opa: ObjectRef<v1alpha2::OpaCluster>, |
| 27 | + }, |
| 28 | + |
| 29 | + #[snafu(display("the role Service has no name associated"))] |
| 30 | + NoServiceName, |
| 31 | + |
| 32 | + #[snafu(display("the role Service has no namespace associated"))] |
| 33 | + NoServiceNamespace, |
| 34 | + |
| 35 | + #[snafu(display("failed to build ConfigMap"))] |
| 36 | + BuildConfigMap { |
| 37 | + source: stackable_operator::builder::configmap::Error, |
| 38 | + }, |
| 39 | + |
| 40 | + #[snafu(display("failed to build object meta data"))] |
| 41 | + ObjectMeta { |
| 42 | + source: stackable_operator::builder::meta::Error, |
| 43 | + }, |
| 44 | +} |
| 45 | + |
| 46 | +type Result<T, E = Error> = std::result::Result<T, E>; |
| 47 | + |
| 48 | +/// Builds the discovery [`ConfigMap`] containing the URL (and, when TLS is enabled, the secret |
| 49 | +/// class) clients need to connect to the cluster. |
| 50 | +pub fn build_discovery_config_map( |
| 51 | + cluster: &ValidatedCluster, |
| 52 | + svc: &Service, |
| 53 | + cluster_info: &KubernetesClusterInfo, |
| 54 | + owner: &v1alpha2::OpaCluster, |
| 55 | +) -> Result<ConfigMap> { |
| 56 | + let name = cluster.name.to_string(); |
| 57 | + |
| 58 | + let (scheme, port) = if cluster.cluster_config.tls.is_some() { |
| 59 | + ("https", APP_TLS_PORT) |
| 60 | + } else { |
| 61 | + ("http", APP_PORT) |
| 62 | + }; |
| 63 | + |
| 64 | + let url = format!( |
| 65 | + "{scheme}://{service_name}.{namespace}.svc.{cluster_domain}:{port}/", |
| 66 | + service_name = svc.metadata.name.as_deref().context(NoServiceNameSnafu)?, |
| 67 | + namespace = svc |
| 68 | + .metadata |
| 69 | + .namespace |
| 70 | + .as_deref() |
| 71 | + .context(NoServiceNamespaceSnafu)?, |
| 72 | + cluster_domain = cluster_info.cluster_domain, |
| 73 | + ); |
| 74 | + |
| 75 | + let metadata = ObjectMetaBuilder::new() |
| 76 | + .name_and_namespace(owner) |
| 77 | + .name(&name) |
| 78 | + .ownerreference_from_resource(owner, None, Some(true)) |
| 79 | + .with_context(|_| ObjectMissingMetadataForOwnerRefSnafu { |
| 80 | + opa: ObjectRef::from_obj(owner), |
| 81 | + })? |
| 82 | + .with_recommended_labels(&build_recommended_labels( |
| 83 | + owner, |
| 84 | + &cluster.image.app_version_label_value, |
| 85 | + &OpaRole::Server.to_string(), |
| 86 | + "discovery", |
| 87 | + )) |
| 88 | + .context(ObjectMetaSnafu)? |
| 89 | + .build(); |
| 90 | + |
| 91 | + let mut cm_builder = ConfigMapBuilder::new(); |
| 92 | + cm_builder.metadata(metadata).add_data("OPA", url); |
| 93 | + |
| 94 | + if let Some(tls) = &cluster.cluster_config.tls { |
| 95 | + cm_builder.add_data("OPA_SECRET_CLASS", &tls.server_secret_class); |
| 96 | + } |
| 97 | + |
| 98 | + cm_builder.build().context(BuildConfigMapSnafu) |
| 99 | +} |
| 100 | + |
| 101 | +#[cfg(test)] |
| 102 | +mod tests { |
| 103 | + use stackable_operator::{ |
| 104 | + commons::networking::DomainName, |
| 105 | + k8s_openapi::api::core::v1::{Service, ServiceSpec}, |
| 106 | + kube::api::ObjectMeta, |
| 107 | + utils::cluster_info::KubernetesClusterInfo, |
| 108 | + }; |
| 109 | + |
| 110 | + use super::*; |
| 111 | + use crate::controller::build::properties::test_support::validated_cluster_from_spec; |
| 112 | + |
| 113 | + fn role_service() -> Service { |
| 114 | + Service { |
| 115 | + metadata: ObjectMeta { |
| 116 | + name: Some("test-opa-server".to_owned()), |
| 117 | + namespace: Some("default".to_owned()), |
| 118 | + ..ObjectMeta::default() |
| 119 | + }, |
| 120 | + spec: Some(ServiceSpec::default()), |
| 121 | + status: None, |
| 122 | + } |
| 123 | + } |
| 124 | + |
| 125 | + fn cluster_info() -> KubernetesClusterInfo { |
| 126 | + KubernetesClusterInfo { |
| 127 | + cluster_domain: DomainName::try_from("cluster.local").unwrap(), |
| 128 | + } |
| 129 | + } |
| 130 | + |
| 131 | + #[test] |
| 132 | + fn renders_http_url_without_tls() { |
| 133 | + let (opa, validated) = validated_cluster_from_spec(serde_json::json!({ |
| 134 | + "image": { "productVersion": "1.2.3" }, |
| 135 | + "servers": { "roleGroups": { "default": {} } }, |
| 136 | + })); |
| 137 | + |
| 138 | + let cm = |
| 139 | + build_discovery_config_map(&validated, &role_service(), &cluster_info(), &opa).unwrap(); |
| 140 | + let data = cm.data.unwrap(); |
| 141 | + |
| 142 | + assert_eq!( |
| 143 | + data.get("OPA").map(String::as_str), |
| 144 | + Some("http://test-opa-server.default.svc.cluster.local:8081/") |
| 145 | + ); |
| 146 | + assert!(!data.contains_key("OPA_SECRET_CLASS")); |
| 147 | + } |
| 148 | + |
| 149 | + #[test] |
| 150 | + fn renders_https_url_and_secret_class_with_tls() { |
| 151 | + let (opa, validated) = validated_cluster_from_spec(serde_json::json!({ |
| 152 | + "image": { "productVersion": "1.2.3" }, |
| 153 | + "clusterConfig": { "tls": { "serverSecretClass": "tls" } }, |
| 154 | + "servers": { "roleGroups": { "default": {} } }, |
| 155 | + })); |
| 156 | + |
| 157 | + let cm = |
| 158 | + build_discovery_config_map(&validated, &role_service(), &cluster_info(), &opa).unwrap(); |
| 159 | + let data = cm.data.unwrap(); |
| 160 | + |
| 161 | + assert_eq!( |
| 162 | + data.get("OPA").map(String::as_str), |
| 163 | + Some("https://test-opa-server.default.svc.cluster.local:8443/") |
| 164 | + ); |
| 165 | + assert_eq!(data.get("OPA_SECRET_CLASS").map(String::as_str), Some("tls")); |
| 166 | + } |
| 167 | +} |
0 commit comments