1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437
// Copyright Materialize, Inc. and contributors. All rights reserved.
//
// Use of this software is governed by the Business Source License
// included in the LICENSE file.
//
// As of the Change Date specified in that file, in accordance with
// the Business Source License, use of this software will be governed
// by the Apache License, Version 2.0.
use std::collections::BTreeMap;
use k8s_openapi::{
api::core::v1::{EnvVar, ResourceRequirements},
apimachinery::pkg::{
api::resource::Quantity,
apis::meta::v1::{Condition, OwnerReference, Time},
},
};
use kube::{api::ObjectMeta, CustomResource, Resource, ResourceExt};
use rand::distributions::Uniform;
use rand::Rng;
use schemars::JsonSchema;
use semver::Version;
use serde::{Deserialize, Serialize};
use uuid::Uuid;
pub const LAST_KNOWN_ACTIVE_GENERATION_ANNOTATION: &str =
"materialize.cloud/last-known-active-generation";
pub mod v1alpha1 {
use super::*;
#[derive(
CustomResource, Clone, Debug, Default, PartialEq, Deserialize, Serialize, JsonSchema,
)]
#[serde(rename_all = "camelCase")]
#[kube(
namespaced,
group = "materialize.cloud",
version = "v1alpha1",
kind = "Materialize",
singular = "materialize",
plural = "materializes",
shortname = "mzs",
status = "MaterializeStatus",
printcolumn = r#"{"name": "ImageRef", "type": "string", "description": "Reference to the Docker image.", "jsonPath": ".spec.imageRef", "priority": 1}"#,
printcolumn = r#"{"name": "UpToDate", "type": "string", "description": "Whether the spec has been applied", "jsonPath": ".status.conditions[?(@.type==\"UpToDate\")].status", "priority": 1}"#
)]
pub struct MaterializeSpec {
// The environmentd image to run
pub environmentd_image_ref: String,
// Extra args to pass to the environmentd binary
pub environmentd_extra_args: Option<Vec<String>>,
// Extra environment variables to pass to the environmentd binary
pub environmentd_extra_env: Option<Vec<EnvVar>>,
// If running in AWS, override the IAM role to use to give
// environmentd access to the persist S3 bucket
pub environmentd_iam_role_arn: Option<String>,
// If running in AWS, override the IAM role to use to support
// the CREATE CONNECTION feature
pub environmentd_connection_role_arn: Option<String>,
// Resource requirements for the environmentd pod
pub environmentd_resource_requirements: Option<ResourceRequirements>,
// Amount of disk to allocate, if a storage class is provided
pub environmentd_scratch_volume_storage_requirement: Option<Quantity>,
// Resource requirements for the balancerd pod
pub balancerd_resource_requirements: Option<ResourceRequirements>,
// Resource requirements for the console pod
pub console_resource_requirements: Option<ResourceRequirements>,
// When changes are made to the environmentd resources (either via
// modifying fields in the spec here or by deploying a new
// orchestratord version which changes how resources are generated),
// existing environmentd processes won't be automatically restarted.
// In order to trigger a restart, the request_rollout field should be
// set to a new (random) value. Once the rollout completes, the value
// of status.last_completed_rollout_request will be set to this value
// to indicate completion.
//
// Defaults to a random value in order to ensure that the first
// generation rollout is automatically triggered.
#[serde(default = "Uuid::new_v4")]
pub request_rollout: Uuid,
// This value will be written to an annotation in the generated
// environmentd statefulset, in order to force the controller to
// detect the generated resources as changed even if no other changes
// happened. This can be used to force a rollout to a new generation
// even without making any meaningful changes.
#[serde(default)]
pub force_rollout: Uuid,
// If false (the default), orchestratord will use the leader
// promotion codepath to minimize downtime during rollouts. If true,
// it will just kill the environmentd pod directly.
#[serde(default)]
pub in_place_rollout: bool,
// The name of a secret containing metadata_backend_url and persist_backend_url.
pub backend_secret_name: String,
// The value used by environmentd (via the --environment-id flag) to
// uniquely identify this instance. Must be globally unique, and
// defaults to a random value.
// NOTE: This value MUST NOT be changed in an existing instance,
// since it affects things like the way data is stored in the persist
// backend.
// This is safe to be set via a default because the controller code
// runs an initial reconcile loop in order to set the finalizer on
// the resource before running any user code, and that initial loop
// will populate any defaults.
#[serde(default = "Uuid::new_v4")]
pub environment_id: Uuid,
}
impl Materialize {
pub fn backend_secret_name(&self) -> String {
self.spec.backend_secret_name.clone()
}
pub fn namespace(&self) -> String {
self.meta().namespace.clone().unwrap()
}
pub fn service_account_name(&self) -> String {
self.name_unchecked()
}
pub fn role_name(&self) -> String {
self.name_unchecked()
}
pub fn role_binding_name(&self) -> String {
self.name_unchecked()
}
pub fn environmentd_statefulset_name(&self, generation: u64) -> String {
self.name_prefixed(&format!("environmentd-{generation}"))
}
pub fn environmentd_app_name(&self) -> String {
"environmentd".to_owned()
}
pub fn environmentd_service_name(&self) -> String {
self.name_prefixed("environmentd")
}
pub fn environmentd_generation_service_name(&self, generation: u64) -> String {
self.name_prefixed(&format!("environmentd-{generation}"))
}
pub fn balancerd_app_name(&self) -> String {
"balancerd".to_owned()
}
pub fn balancerd_deployment_name(&self) -> String {
self.name_prefixed("balancerd")
}
pub fn balancerd_service_name(&self) -> String {
self.name_prefixed("balancerd")
}
pub fn console_app_name(&self) -> String {
"console".to_owned()
}
pub fn console_deployment_name(&self) -> String {
self.name_prefixed("console")
}
pub fn console_service_name(&self) -> String {
self.name_prefixed("console")
}
pub fn persist_pubsub_service_name(&self, generation: u64) -> String {
self.name_prefixed(&format!("persist-pubsub-{generation}"))
}
pub fn name_prefixed(&self, suffix: &str) -> String {
format!("mz{}-{}", self.resource_id(), suffix)
}
pub fn resource_id(&self) -> &str {
&self.status.as_ref().unwrap().resource_id
}
pub fn environmentd_scratch_volume_storage_requirement(&self) -> Quantity {
self.spec
.environmentd_scratch_volume_storage_requirement
.clone()
.unwrap_or_else(|| {
self.spec
.environmentd_resource_requirements
.as_ref()
.and_then(|requirements| {
requirements
.requests
.as_ref()
.or(requirements.limits.as_ref())
})
// TODO: in cloud, we've been defaulting to twice the
// memory limit, but k8s-openapi doesn't seem to
// provide any way to parse Quantity values, so there
// isn't an easy way to do arithmetic on it
.and_then(|requirements| requirements.get("memory").cloned())
// TODO: is there a better default to use here?
.unwrap_or(Quantity("4096Mi".to_string()))
})
}
pub fn default_labels(&self) -> BTreeMap<String, String> {
BTreeMap::from_iter([
(
"materialize.cloud/organization-name".to_owned(),
self.name_unchecked(),
),
(
"materialize.cloud/organization-namespace".to_owned(),
self.namespace(),
),
(
"materialize.cloud/mz-resource-id".to_owned(),
self.resource_id().to_owned(),
),
])
}
pub fn environment_id(&self, cloud_provider: &str, region: &str) -> String {
format!(
"{}-{}-{}-0",
cloud_provider, region, self.spec.environment_id,
)
}
pub fn requested_reconciliation_id(&self) -> Uuid {
self.spec.request_rollout
}
pub fn in_place_rollout(&self) -> bool {
self.spec.in_place_rollout
}
pub fn rollout_requested(&self) -> bool {
self.requested_reconciliation_id()
!= self
.status
.as_ref()
.map_or_else(Uuid::nil, |status| status.last_completed_rollout_request)
}
pub fn conditions_need_update(&self) -> bool {
let Some(status) = self.status.as_ref() else {
return true;
};
if status.conditions.is_empty() {
return true;
}
for condition in &status.conditions {
if condition.observed_generation != self.meta().generation {
return true;
}
}
false
}
pub fn update_in_progress(&self) -> bool {
let Some(status) = self.status.as_ref() else {
return false;
};
if status.conditions.is_empty() {
return false;
}
for condition in &status.conditions {
if condition.type_ == "UpToDate" && condition.status == "Unknown" {
return true;
}
}
false
}
/// Checks that the given version is greater than or equal
/// to the existing version, if the existing version
/// can be parsed.
pub fn meets_minimum_version(&self, minimum: &Version) -> bool {
let version = parse_image_ref(&self.spec.environmentd_image_ref);
match version {
Some(version) => &version >= minimum,
// In the rare case that we see an image reference
// that we can't parse, we assume that it satisfies all
// version checks. Usually these are custom images that have
// been by a developer on a branch forked from a recent copy
// of main, and so this works out reasonably well in practice.
None => true,
}
}
pub fn managed_resource_meta(&self, name: String) -> ObjectMeta {
ObjectMeta {
namespace: Some(self.namespace()),
name: Some(name),
labels: Some(self.default_labels()),
owner_references: Some(vec![owner_reference(self)]),
..Default::default()
}
}
pub fn status(&self) -> MaterializeStatus {
self.status.clone().unwrap_or_else(|| {
let mut status = MaterializeStatus::default();
// DNS-1035 names are supposed to be case insensitive,
// so we define our own character set, rather than use the
// built-in Alphanumeric distribution from rand, which
// includes both upper and lowercase letters.
const CHARSET: &[u8] = b"abcdefghijklmnopqrstuvwxyz0123456789";
status.resource_id = rand::thread_rng()
.sample_iter(Uniform::new(0, CHARSET.len()))
.take(10)
.map(|i| char::from(CHARSET[i]))
.collect();
// If we're creating the initial status on an un-soft-deleted
// Environment we need to ensure that the last active generation
// is restored, otherwise the env will crash loop indefinitely
// as its catalog would have durably recorded a greater generation
if let Some(last_active_generation) = self
.annotations()
.get(LAST_KNOWN_ACTIVE_GENERATION_ANNOTATION)
{
status.active_generation = last_active_generation
.parse()
.expect("valid int generation");
}
status
})
}
}
#[derive(Clone, Debug, Default, Deserialize, Serialize, JsonSchema, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct MaterializeStatus {
pub resource_id: String,
pub active_generation: u64,
pub last_completed_rollout_request: Uuid,
pub resources_hash: String,
pub conditions: Vec<Condition>,
}
impl MaterializeStatus {
pub fn needs_update(&self, other: &Self) -> bool {
let now = chrono::offset::Utc::now();
let mut a = self.clone();
for condition in &mut a.conditions {
condition.last_transition_time = Time(now);
}
let mut b = other.clone();
for condition in &mut b.conditions {
condition.last_transition_time = Time(now);
}
a != b
}
}
}
fn parse_image_ref(image_ref: &str) -> Option<Version> {
image_ref
.rsplit_once(':')
.and_then(|(_repo, tag)| tag.strip_prefix('v'))
.and_then(|tag| {
// To work around Docker tag restrictions, build metadata in
// a Docker tag is delimited by `--` rather than the SemVer
// `+` delimiter. So we need to swap the delimiter back to
// `+` before parsing it as SemVer.
let tag = tag.replace("--", "+");
Version::parse(&tag).ok()
})
}
fn owner_reference<T: Resource<DynamicType = ()>>(t: &T) -> OwnerReference {
OwnerReference {
api_version: T::api_version(&()).to_string(),
kind: T::kind(&()).to_string(),
name: t.name_unchecked(),
uid: t.uid().unwrap(),
block_owner_deletion: Some(true),
..Default::default()
}
}
#[cfg(test)]
mod tests {
use kube::core::ObjectMeta;
use semver::Version;
use super::v1alpha1::{Materialize, MaterializeSpec};
#[mz_ore::test]
fn meets_minimum_version() {
let mut mz = Materialize {
spec: MaterializeSpec {
environmentd_image_ref:
"materialize/environmentd:devel-47116c24b8d0df33d3f60a9ee476aa8d7bce5953"
.to_owned(),
..Default::default()
},
metadata: ObjectMeta {
..Default::default()
},
status: None,
};
// true cases
assert!(mz.meets_minimum_version(&Version::parse("0.34.0").unwrap()));
mz.spec.environmentd_image_ref = "materialize/environmentd:v0.34.0".to_owned();
assert!(mz.meets_minimum_version(&Version::parse("0.34.0").unwrap()));
mz.spec.environmentd_image_ref = "materialize/environmentd:v0.35.0".to_owned();
assert!(mz.meets_minimum_version(&Version::parse("0.34.0").unwrap()));
mz.spec.environmentd_image_ref = "materialize/environmentd:v0.34.3".to_owned();
assert!(mz.meets_minimum_version(&Version::parse("0.34.0").unwrap()));
mz.spec.environmentd_image_ref = "materialize/environmentd@41af286dc0b172ed2f1ca934fd2278de4a1192302ffa07087cea2682e7d372e3".to_owned();
assert!(mz.meets_minimum_version(&Version::parse("0.34.0").unwrap()));
mz.spec.environmentd_image_ref = "my.private.registry:5000:v0.34.3".to_owned();
assert!(mz.meets_minimum_version(&Version::parse("0.34.0").unwrap()));
mz.spec.environmentd_image_ref = "materialize/environmentd:v0.asdf.0".to_owned();
assert!(mz.meets_minimum_version(&Version::parse("0.34.0").unwrap()));
// false cases
mz.spec.environmentd_image_ref = "materialize/environmentd:v0.34.0-dev".to_owned();
assert!(!mz.meets_minimum_version(&Version::parse("0.34.0").unwrap()));
mz.spec.environmentd_image_ref = "materialize/environmentd:v0.33.0".to_owned();
assert!(!mz.meets_minimum_version(&Version::parse("0.34.0").unwrap()));
mz.spec.environmentd_image_ref = "materialize/environmentd:v0.34.0".to_owned();
assert!(!mz.meets_minimum_version(&Version::parse("1.0.0").unwrap()));
mz.spec.environmentd_image_ref = "my.private.registry:5000:v0.33.3".to_owned();
assert!(!mz.meets_minimum_version(&Version::parse("0.34.0").unwrap()));
}
}