Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
165 changes: 164 additions & 1 deletion rust/operator-binary/src/controller/build/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,112 @@

use std::str::FromStr;

use stackable_operator::v2::types::operator::RoleGroupName;
use snafu::{ResultExt, Snafu};
use stackable_operator::{
utils::cluster_info::KubernetesClusterInfo, v2::types::operator::RoleGroupName,
};

use crate::controller::{
KubernetesResources, ValidatedCluster,
build::resource::{
config_map::{self, build_rolegroup_config_map},
discovery::{self, build_discovery_config_map},
pdb::build_pdb,
service::{build_rolegroup_metrics_service, build_rolegroup_service},
statefulset::{self, build_rolegroup_statefulset},
},
};

// Placeholder role-group name used for the recommended labels of the role-level discovery
// `ConfigMap` (which is not tied to a single role group).
stackable_operator::constant!(pub(crate) PLACEHOLDER_DISCOVERY_ROLE_GROUP: RoleGroupName = "discovery");

#[derive(Snafu, Debug)]
pub enum Error {
#[snafu(display("failed to build ConfigMap for role group {role_group}"))]
ConfigMap {
source: config_map::Error,
role_group: RoleGroupName,
},

#[snafu(display("failed to build StatefulSet for role group {role_group}"))]
StatefulSet {
source: statefulset::Error,
role_group: RoleGroupName,
},

#[snafu(display("failed to build discovery ConfigMap"))]
Discovery { source: discovery::Error },
}

/// Builds every Kubernetes resource for the given validated cluster.
///
/// Does not need a Kubernetes client: every reference to another Kubernetes resource is already
/// dereferenced and validated by this point, so the errors returned here are resource-assembly
/// failures only. `cluster_info` is static cluster metadata (not a client call), and
/// `service_account_name` is the name of the RBAC `ServiceAccount` the role-group Pods run under
/// (RBAC resources are built and applied separately, in the reconcile step).
pub fn build(
cluster: &ValidatedCluster,
cluster_info: &KubernetesClusterInfo,
service_account_name: &str,
) -> Result<KubernetesResources, Error> {
let mut stateful_sets = vec![];
let mut services = vec![];
let mut config_maps = vec![];
let mut pod_disruption_budgets = vec![];

for (hbase_role, role_group_configs) in &cluster.role_group_configs {
for (role_group_name, rg_config) in role_group_configs {
services.push(build_rolegroup_service(
cluster,
hbase_role,
role_group_name,
));
services.push(build_rolegroup_metrics_service(
cluster,
hbase_role,
role_group_name,
));
config_maps.push(
build_rolegroup_config_map(cluster, cluster_info, hbase_role, role_group_name)
.context(ConfigMapSnafu {
role_group: role_group_name.clone(),
})?,
);
stateful_sets.push(
build_rolegroup_statefulset(
cluster,
hbase_role,
role_group_name,
rg_config,
service_account_name,
)
.context(StatefulSetSnafu {
role_group: role_group_name.clone(),
})?,
);
}

if let Some(role_config) = cluster.role_configs.get(hbase_role)
&& let Some(pdb) = build_pdb(&role_config.pdb, cluster, hbase_role)
{
pod_disruption_budgets.push(pdb);
}
}

// The role-level discovery ConfigMap advertises the cluster's connection information; it is
// deterministic (derived only from the validated cluster and static cluster info).
config_maps.push(build_discovery_config_map(cluster, cluster_info).context(DiscoverySnafu)?);

Ok(KubernetesResources {
stateful_sets,
services,
config_maps,
pod_disruption_budgets,
})
}

pub mod graceful_shutdown;
pub mod jvm;
pub mod kerberos;
Expand All @@ -17,3 +117,66 @@ pub mod properties;
pub mod region_mover;
pub mod resource;
pub mod role;

#[cfg(test)]
mod tests {
use stackable_operator::kube::Resource;

use super::build;
use crate::test_utils;

/// Collects the `.metadata.name`s of the given resources, sorted for stable comparison.
fn sorted_names(resources: &[impl Resource]) -> Vec<&str> {
let mut names: Vec<&str> = resources
.iter()
.filter_map(|resource| resource.meta().name.as_deref())
.collect();
names.sort();
names
}

#[test]
fn build_produces_expected_resource_names() {
let cluster = test_utils::validated_cluster();
let cluster_info = test_utils::cluster_info();
let resources =
build(&cluster, &cluster_info, "hbase-serviceaccount").expect("build succeeds");

// One StatefulSet per role group (one `default` group for each of the three roles).
assert_eq!(
sorted_names(&resources.stateful_sets),
[
"hbase-master-default",
"hbase-regionserver-default",
"hbase-restserver-default",
]
);
// One headless and one metrics Service per role group.
assert_eq!(
sorted_names(&resources.services),
[
"hbase-master-default-headless",
"hbase-master-default-metrics",
"hbase-regionserver-default-headless",
"hbase-regionserver-default-metrics",
"hbase-restserver-default-headless",
"hbase-restserver-default-metrics",
]
);
// One ConfigMap per role group plus the cluster-wide discovery ConfigMap (`hbase`).
assert_eq!(
sorted_names(&resources.config_maps),
[
"hbase",
"hbase-master-default",
"hbase-regionserver-default",
"hbase-restserver-default",
]
);
// A default PodDisruptionBudget per role.
assert_eq!(
sorted_names(&resources.pod_disruption_budgets),
["hbase-master", "hbase-regionserver", "hbase-restserver"]
);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,10 @@ use stackable_operator::{
DeepMerge,
api::{
apps::v1::{StatefulSet, StatefulSetSpec},
core::v1::{
ConfigMapVolumeSource, ContainerPort, Probe, ServiceAccount, TCPSocketAction,
Volume,
},
core::v1::{ConfigMapVolumeSource, ContainerPort, Probe, TCPSocketAction, Volume},
},
apimachinery::pkg::{apis::meta::v1::LabelSelector, util::intstr::IntOrString},
},
kube::ResourceExt,
product_logging,
v2::{
builder::pod::container::{EnvVarName, EnvVarSet, new_container_builder},
Expand Down Expand Up @@ -110,7 +106,7 @@ pub fn build_rolegroup_statefulset(
hbase_role: &HbaseRole,
role_group_name: &RoleGroupName,
validated_rg_config: &HbaseRoleGroupConfig,
service_account: &ServiceAccount,
service_account_name: &str,
) -> Result<StatefulSet> {
let resolved_product_image = &cluster.image;
let merged_config = &validated_rg_config.config.config;
Expand Down Expand Up @@ -243,7 +239,7 @@ pub fn build_rolegroup_statefulset(
)),
)
.context(AddVolumeSnafu)?
.service_account_name(service_account.name_any())
.service_account_name(service_account_name)
.security_context(PodSecurityContextBuilder::new().fs_group(1000).build());

// The HBase container's log config ConfigMap: either the operator-generated one (the
Expand Down
20 changes: 19 additions & 1 deletion rust/operator-binary/src/controller/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,14 @@ pub use stackable_operator::v2::types::operator::RoleGroupName;
use stackable_operator::{
builder::meta::ObjectMetaBuilder,
commons::product_image_selection::ResolvedProductImage,
k8s_openapi::apimachinery::pkg::apis::meta::v1::ObjectMeta,
k8s_openapi::{
api::{
apps::v1::StatefulSet,
core::v1::{ConfigMap, Service},
policy::v1::PodDisruptionBudget,
},
apimachinery::pkg::apis::meta::v1::ObjectMeta,
},
kube::Resource,
kvp::Labels,
v2::{
Expand Down Expand Up @@ -51,6 +58,17 @@ pub(crate) fn controller_name() -> ControllerName {
.expect("the controller name is a valid label value")
}

/// The complete set of Kubernetes resources built for a [`ValidatedCluster`], ready to be applied.
///
/// hbase exposes its listeners as volume/PVC sources inside the `StatefulSet` rather than as
/// top-level `Listener` objects, so (unlike some sibling operators) there is no `listeners` field.
pub struct KubernetesResources {
pub stateful_sets: Vec<StatefulSet>,
pub services: Vec<Service>,
pub config_maps: Vec<ConfigMap>,
pub pod_disruption_budgets: Vec<PodDisruptionBudget>,
}

/// The validated cluster: proves that config merging and validation succeeded for
/// every role and role group before any resources are created.
#[derive(Clone, Debug)]
Expand Down
Loading
Loading