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 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759
// 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.
//! Cluster management.
use std::collections::{BTreeMap, BTreeSet};
use std::sync::Arc;
use std::time::Duration;
use anyhow::anyhow;
use chrono::{DateTime, Utc};
use differential_dataflow::lattice::Lattice;
use futures::stream::{BoxStream, StreamExt};
use mz_cluster_client::client::ClusterReplicaLocation;
use mz_compute_client::controller::{ComputeReplicaConfig, ComputeReplicaLogging};
use mz_compute_client::logging::LogVariant;
use mz_compute_client::service::{ComputeClient, ComputeGrpcClient};
use mz_compute_types::ComputeInstanceId;
use mz_controller_types::{ClusterId, ReplicaId};
use mz_orchestrator::{
CpuLimit, DiskLimit, LabelSelectionLogic, LabelSelector, MemoryLimit, Service, ServiceConfig,
ServiceEvent, ServicePort,
};
use mz_ore::halt;
use mz_ore::task::{AbortOnDropHandle, JoinHandleExt};
use mz_repr::adt::numeric::Numeric;
use mz_repr::GlobalId;
use once_cell::sync::Lazy;
use regex::Regex;
use serde::{Deserialize, Serialize};
use timely::progress::Timestamp;
use tracing::{error, warn};
use crate::Controller;
/// Configures a cluster.
pub struct ClusterConfig {
/// The logging variants to enable on the compute instance.
///
/// Each logging variant is mapped to the identifier under which to register
/// the arrangement storing the log's data.
pub arranged_logs: BTreeMap<LogVariant, GlobalId>,
}
/// The status of a cluster.
pub type ClusterStatus = mz_orchestrator::ServiceStatus;
/// Configures a cluster replica.
#[derive(Clone, Debug, Serialize)]
pub struct ReplicaConfig {
/// The location of the replica.
pub location: ReplicaLocation,
/// Configuration for the compute half of the replica.
pub compute: ComputeReplicaConfig,
}
/// Configures the resource allocation for a cluster replica.
#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
pub struct ReplicaAllocation {
/// The memory limit for each process in the replica.
pub memory_limit: Option<MemoryLimit>,
/// The CPU limit for each process in the replica.
pub cpu_limit: Option<CpuLimit>,
/// The disk limit for each process in the replica.
pub disk_limit: Option<DiskLimit>,
/// The number of processes in the replica.
pub scale: u16,
/// The number of worker threads in the replica.
pub workers: usize,
/// The number of credits per hour that the replica consumes.
#[serde(deserialize_with = "mz_repr::adt::numeric::str_serde::deserialize")]
pub credits_per_hour: Numeric,
/// Whether instances of this type can be created
#[serde(default)]
pub disabled: bool,
}
#[mz_ore::test]
// We test this particularly because we deserialize values from strings.
#[cfg_attr(miri, ignore)] // unsupported operation: can't call foreign function `decContextDefault` on OS `linux`
fn test_replica_allocation_deserialization() {
use bytesize::ByteSize;
let data = r#"
{
"cpu_limit": 1.0,
"memory_limit": "10GiB",
"disk_limit": "100MiB",
"scale": 16,
"workers": 1,
"credits_per_hour": "16"
}"#;
let replica_allocation: ReplicaAllocation = serde_json::from_str(data)
.expect("deserialization from JSON succeeds for ReplicaAllocation");
assert_eq!(
replica_allocation,
ReplicaAllocation {
credits_per_hour: 16.into(),
disk_limit: Some(DiskLimit(ByteSize::mib(100))),
disabled: false,
memory_limit: Some(MemoryLimit(ByteSize::gib(10))),
cpu_limit: Some(CpuLimit::from_millicpus(1000)),
scale: 16,
workers: 1
}
);
let data = r#"
{
"cpu_limit": 0,
"memory_limit": "0GiB",
"disk_limit": "0MiB",
"scale": 0,
"workers": 0,
"credits_per_hour": "0",
"disabled": true
}"#;
let replica_allocation: ReplicaAllocation = serde_json::from_str(data)
.expect("deserialization from JSON succeeds for ReplicaAllocation");
assert_eq!(
replica_allocation,
ReplicaAllocation {
credits_per_hour: 0.into(),
disk_limit: Some(DiskLimit(ByteSize::mib(0))),
disabled: true,
memory_limit: Some(MemoryLimit(ByteSize::gib(0))),
cpu_limit: Some(CpuLimit::from_millicpus(0)),
scale: 0,
workers: 0
}
);
}
/// Configures the location of a cluster replica.
#[derive(Clone, Debug, Serialize)]
pub enum ReplicaLocation {
/// An unmanaged replica.
Unmanaged(UnmanagedReplicaLocation),
/// A managed replica.
Managed(ManagedReplicaLocation),
}
impl ReplicaLocation {
/// Returns the number of processes specified by this replica location.
pub fn num_processes(&self) -> usize {
match self {
ReplicaLocation::Unmanaged(UnmanagedReplicaLocation {
computectl_addrs, ..
}) => computectl_addrs.len(),
ReplicaLocation::Managed(ManagedReplicaLocation { allocation, .. }) => {
allocation.scale.into()
}
}
}
pub fn billed_as(&self) -> Option<&str> {
match self {
ReplicaLocation::Managed(ManagedReplicaLocation { billed_as, .. }) => {
billed_as.as_deref()
}
_ => None,
}
}
pub fn internal(&self) -> bool {
match self {
ReplicaLocation::Managed(ManagedReplicaLocation { internal, .. }) => *internal,
ReplicaLocation::Unmanaged(_) => false,
}
}
}
/// The "role" of a cluster, which is currently used to determine the
/// severity of alerts for problems with its replicas.
pub enum ClusterRole {
/// The existence and proper functioning of the cluster's replicas is
/// business-critical for Materialize.
SystemCritical,
/// Assuming no bugs, the cluster's replicas should always exist and function
/// properly. If it doesn't, however, that is less urgent than
/// would be the case for a `SystemCritical` replica.
System,
/// The cluster is controlled by the user, and might go down for
/// reasons outside our control (e.g., OOMs).
User,
}
/// The location of an unmanaged replica.
#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct UnmanagedReplicaLocation {
/// The network addresses of the storagectl endpoints for each process in
/// the replica.
pub storagectl_addrs: Vec<String>,
/// The network addresses of the storage (Timely) endpoints for
/// each process in the replica.
pub storage_addrs: Vec<String>,
/// The network addresses of the computectl endpoints for each process in
/// the replica.
pub computectl_addrs: Vec<String>,
/// The network addresses of the compute (Timely) endpoints for
/// each process in the replica.
pub compute_addrs: Vec<String>,
/// The workers per process in the replica.
pub workers: usize,
}
/// Information about availability zone constraints for replicas.
#[derive(Clone, Debug)]
pub enum ManagedReplicaAvailabilityZones {
/// Specified if the `Replica` is from `MANAGED` cluster,
/// and specifies if there is an `AVAILABILITY ZONES`
/// constraint. Empty lists are represented as `None`.
FromCluster(Option<Vec<String>>),
/// Specified if the `Replica` is from a non-`MANAGED` cluster,
/// and specifies if there is a specific `AVAILABILITY ZONE`.
FromReplica(Option<String>),
}
/// The location of a managed replica.
#[derive(Clone, Debug, Serialize)]
pub struct ManagedReplicaLocation {
/// The resource allocation for the replica.
pub allocation: ReplicaAllocation,
/// SQL size parameter used for allocation
pub size: String,
/// If `true`, Materialize support owns this replica.
pub internal: bool,
/// Optional SQL size parameter used for billing.
pub billed_as: Option<String>,
/// The replica's availability zones, if specified.
///
/// This is either the replica's specific `AVAILABILITY ZONE`,
/// or the zones placed here during replica concretization
/// from the `MANAGED` cluster config.
///
/// We skip serialization (which is used for some validation
/// in tests) as the latter case is a "virtual" piece of information,
/// that exists only at runtime.
///
/// An empty list of availability zones is concretized as `None`,
/// as the on-disk serialization of `MANAGED CLUSTER AVAILABILITY ZONES`
/// is an empty list if none are specified
#[serde(skip)]
pub availability_zones: ManagedReplicaAvailabilityZones,
/// Whether the replica needs scratch disk space.
pub disk: bool,
}
impl ManagedReplicaLocation {
/// Return the size which should be used to determine billing-related information.
pub fn size_for_billing(&self) -> &str {
self.billed_as.as_deref().unwrap_or(&self.size)
}
}
/// Configures logging for a cluster replica.
pub type ReplicaLogging = ComputeReplicaLogging;
/// Identifier of a process within a replica.
pub type ProcessId = u64;
/// An event describing a change in status of a cluster replica process.
#[derive(Debug, Clone, Serialize)]
pub struct ClusterEvent {
pub cluster_id: ClusterId,
pub replica_id: ReplicaId,
pub process_id: ProcessId,
pub status: ClusterStatus,
pub time: DateTime<Utc>,
}
/// A struct describing a replica that needs to be created,
/// using `Controller::create_replicas`.
pub struct CreateReplicaConfig {
pub cluster_id: ClusterId,
pub replica_id: ReplicaId,
pub role: ClusterRole,
pub config: ReplicaConfig,
}
impl<T> Controller<T>
where
T: Timestamp + Lattice,
ComputeGrpcClient: ComputeClient<T>,
{
/// Creates a cluster with the specified identifier and configuration.
///
/// A cluster is a combination of a storage instance and a compute instance.
/// A cluster has zero or more replicas; each replica colocates the storage
/// and compute layers on the same physical resources.
pub fn create_cluster(
&mut self,
id: ClusterId,
config: ClusterConfig,
) -> Result<(), anyhow::Error> {
self.storage.create_instance(id);
self.compute.create_instance(id, config.arranged_logs)?;
Ok(())
}
/// Drops the specified cluster.
///
/// # Panics
///
/// Panics if the cluster still has replicas.
pub fn drop_cluster(&mut self, id: ClusterId) {
self.storage.drop_instance(id);
self.compute.drop_instance(id);
}
/// Creates a replica of the specified cluster with the specified identifier
/// and configuration.
///
/// This method is NOT idempotent; It can fail between processing of different
/// replicas and leave the controller in an inconsistent state. It is almost
/// always wrong to do anything but abort the process on `Err`.
pub async fn create_replicas(
&mut self,
replicas: Vec<CreateReplicaConfig>,
) -> Result<(), anyhow::Error> {
/// A intermediate struct to hold info about a replica, to avoid
/// a large tuple.
struct ReplicaInfo {
replica_id: ReplicaId,
compute_config: ComputeReplicaConfig,
storage_location: ClusterReplicaLocation,
compute_location: ClusterReplicaLocation,
metrics_task_join_handle: Option<AbortOnDropHandle<()>>,
}
// Reborrow the `&mut self` as immutable, as all the concurrent work to be processed in
// this stream cannot all have exclusive access.
let this = &*self;
let mut replica_stream = futures::stream::iter(replicas)
.map(|config| async move {
let CreateReplicaConfig {
cluster_id,
replica_id,
role,
config,
} = config;
match config.location {
// This branch doesn't do any async work, so there is a slight performance
// opportunity to serially process it, but it makes the code worse to read.
ReplicaLocation::Unmanaged(UnmanagedReplicaLocation {
storagectl_addrs,
storage_addrs,
computectl_addrs,
compute_addrs,
workers,
}) => {
let compute_location = ClusterReplicaLocation {
ctl_addrs: computectl_addrs,
dataflow_addrs: compute_addrs,
workers,
};
let storage_location = ClusterReplicaLocation {
ctl_addrs: storagectl_addrs,
dataflow_addrs: storage_addrs,
// Storage and compute on the same replica have linked sizes.
workers,
};
Ok::<_, anyhow::Error>((
cluster_id,
ReplicaInfo {
replica_id,
compute_config: config.compute,
storage_location,
compute_location,
metrics_task_join_handle: None,
},
))
}
ReplicaLocation::Managed(m) => {
let workers = m.allocation.workers;
let (service, metrics_task_join_handle) = this
.provision_replica(cluster_id, replica_id, role, m)
.await?;
let storage_location = ClusterReplicaLocation {
ctl_addrs: service.addresses("storagectl"),
dataflow_addrs: service.addresses("storage"),
workers,
};
let compute_location = ClusterReplicaLocation {
ctl_addrs: service.addresses("computectl"),
dataflow_addrs: service.addresses("compute"),
workers,
};
Ok((
cluster_id,
ReplicaInfo {
replica_id,
compute_config: config.compute,
storage_location,
compute_location,
metrics_task_join_handle: Some(metrics_task_join_handle),
},
))
}
}
})
// TODO(guswynn): make this configurable.
.buffer_unordered(50);
// _Usually_ `try_collect` and `collect` are the only safe ways to process a
// `buffer_unordered`, but if we ensure we don't do
// any async work in this loop, we are fine.
//
// If we do do async work in the loop, we could starve the stream itself of
// polls, which can cause errors.
// See the docs in `mz_storage_client::controller` for more info.
let mut replicas: BTreeMap<_, Vec<_>> = BTreeMap::new();
while let Some(res) = replica_stream.next().await {
let (cluster_id, replica_info) = res?;
replicas.entry(cluster_id).or_default().push(replica_info);
}
drop(replica_stream);
for (cluster_id, replicas) in replicas {
let last_replica = replicas.last().unwrap();
// We only connect to the last replica (chosen arbitrarily)
// for storage, until we support multi-replica storage objects
self.storage.connect_replica(
cluster_id,
last_replica.replica_id,
last_replica.storage_location.clone(),
);
for ReplicaInfo {
replica_id,
compute_config,
storage_location: _,
compute_location,
metrics_task_join_handle,
} in replicas
{
if let Some(jh) = metrics_task_join_handle {
self.metrics_tasks.insert(replica_id, jh);
}
self.active_compute().add_replica_to_instance(
cluster_id,
replica_id,
compute_location,
compute_config,
)?;
}
}
Ok(())
}
/// Drops the specified replica of the specified cluster.
pub async fn drop_replica(
&mut self,
cluster_id: ClusterId,
replica_id: ReplicaId,
) -> Result<(), anyhow::Error> {
// We unconditionally deprovision even for unmanaged replicas to avoid
// needing to keep track of which replicas are managed and which are
// unmanaged. Deprovisioning is a no-op if the replica ID was never
// provisioned.
self.deprovision_replica(cluster_id, replica_id).await?;
self.metrics_tasks.remove(&replica_id);
self.active_compute().drop_replica(cluster_id, replica_id)?;
self.storage.drop_replica(cluster_id, replica_id);
Ok(())
}
/// Remove orphaned replicas.
pub async fn remove_orphaned_replicas(
&mut self,
next_user_replica_id: u64,
next_system_replica_id: u64,
) -> Result<(), anyhow::Error> {
// Remove replicas with the old service name format.
// TODO(teskje): Remove this after v0.67 has been rolled out.
self.deprovision_old_services().await?;
let desired: BTreeSet<_> = self.metrics_tasks.keys().copied().collect();
let actual: BTreeSet<_> = self
.orchestrator
.list_services()
.await?
.iter()
.map(|s| parse_replica_service_name(s))
.collect::<Result<_, _>>()?;
for (cluster_id, replica_id) in actual {
let smaller_next = match replica_id {
ReplicaId::User(id) if id >= next_user_replica_id => {
Some(ReplicaId::User(next_user_replica_id))
}
ReplicaId::System(id) if id >= next_system_replica_id => {
Some(ReplicaId::System(next_system_replica_id))
}
_ => None,
};
if let Some(next) = smaller_next {
// Found a replica in kubernetes with a higher replica ID than
// what we are aware of. This must have been created by an
// environmentd with higher epoch number.
halt!("found replica ID ({replica_id}) in orchestrator >= next ID ({next})");
}
if !desired.contains(&replica_id) {
self.deprovision_replica(cluster_id, replica_id).await?;
}
}
Ok(())
}
async fn deprovision_old_services(&self) -> Result<(), anyhow::Error> {
static OLD_SERVICE_NAME_RE: Lazy<Regex> =
Lazy::new(|| Regex::new(r"(?-u)^[us]\d+-replica-\d+$").unwrap());
let old_services = self
.orchestrator
.list_services()
.await?
.into_iter()
.filter(|s| OLD_SERVICE_NAME_RE.is_match(s));
for service_name in old_services {
self.orchestrator.drop_service(&service_name).await?;
}
Ok(())
}
pub fn events_stream(&self) -> BoxStream<'static, ClusterEvent> {
fn translate_event(event: ServiceEvent) -> Result<ClusterEvent, anyhow::Error> {
let (cluster_id, replica_id) = parse_replica_service_name(&event.service_id)?;
Ok(ClusterEvent {
cluster_id,
replica_id,
process_id: event.process_id,
status: event.status,
time: event.time,
})
}
let stream = self
.orchestrator
.watch_services()
.map(|event| event.and_then(translate_event))
.filter_map(|event| async {
match event {
Ok(event) => Some(event),
Err(error) => {
error!("service watch error: {error}");
None
}
}
});
Box::pin(stream)
}
/// Provisions a replica with the service orchestrator.
async fn provision_replica(
&self,
cluster_id: ClusterId,
replica_id: ReplicaId,
role: ClusterRole,
location: ManagedReplicaLocation,
) -> Result<(Box<dyn Service>, AbortOnDropHandle<()>), anyhow::Error> {
let service_name = generate_replica_service_name(cluster_id, replica_id);
let role_label = match role {
ClusterRole::SystemCritical => "system-critical",
ClusterRole::System => "system",
ClusterRole::User => "user",
};
let persist_pubsub_url = self.persist_pubsub_url.clone();
let enable_persist_txn_tables = self.enable_persist_txn_tables;
let secrets_args = self.secrets_args.to_flags();
let service = self
.orchestrator
.ensure_service(
&service_name,
ServiceConfig {
image: self.clusterd_image.clone(),
init_container_image: self.init_container_image.clone(),
args: &|assigned| {
let mut args = vec![
format!(
"--storage-controller-listen-addr={}",
assigned["storagectl"]
),
format!(
"--compute-controller-listen-addr={}",
assigned["computectl"]
),
format!("--internal-http-listen-addr={}", assigned["internal-http"]),
format!("--opentelemetry-resource=cluster_id={}", cluster_id),
format!("--opentelemetry-resource=replica_id={}", replica_id),
format!("--persist-pubsub-url={}", persist_pubsub_url),
format!("--enable-persist-txn-tables={}", enable_persist_txn_tables),
];
if let Some(memory_limit) = location.allocation.memory_limit {
args.push(format!(
"--announce-memory-limit={}",
memory_limit.0.as_u64()
));
}
args.extend(secrets_args.clone());
args
},
ports: vec![
ServicePort {
name: "storagectl".into(),
port_hint: 2100,
},
// To simplify the changes to tests, the port
// chosen here is _after_ the compute ones.
// TODO(petrosagg): fix the numerical ordering here
ServicePort {
name: "storage".into(),
port_hint: 2103,
},
ServicePort {
name: "computectl".into(),
port_hint: 2101,
},
ServicePort {
name: "compute".into(),
port_hint: 2102,
},
ServicePort {
name: "internal-http".into(),
port_hint: 6878,
},
],
cpu_limit: location.allocation.cpu_limit,
memory_limit: location.allocation.memory_limit,
scale: location.allocation.scale,
labels: BTreeMap::from([
("replica-id".into(), replica_id.to_string()),
("cluster-id".into(), cluster_id.to_string()),
("type".into(), "cluster".into()),
("replica-role".into(), role_label.into()),
("workers".into(), location.allocation.workers.to_string()),
("size".into(), location.size.to_string()),
]),
availability_zones: match location.availability_zones {
ManagedReplicaAvailabilityZones::FromCluster(azs) => azs,
ManagedReplicaAvailabilityZones::FromReplica(az) => az.map(|z| vec![z]),
},
// This provides the orchestrator with some label selectors that
// are used to constraint the scheduling of replicas, based on
// its internal configuration.
other_replicas_selector: vec![
LabelSelector {
label_name: "cluster-id".to_string(),
logic: LabelSelectionLogic::Eq {
value: cluster_id.to_string(),
},
},
// Select other replicas (but not oneself)
LabelSelector {
label_name: "replica-id".into(),
logic: LabelSelectionLogic::NotEq {
value: replica_id.to_string(),
},
},
],
replicas_selector: vec![LabelSelector {
label_name: "cluster-id".to_string(),
// Select ALL replicas.
logic: LabelSelectionLogic::Eq {
value: cluster_id.to_string(),
},
}],
disk_limit: location.allocation.disk_limit,
disk: location.disk,
},
)
.await?;
let metrics_task = mz_ore::task::spawn(|| format!("replica-metrics-{replica_id}"), {
let tx = self.metrics_tx.clone();
let orchestrator = Arc::clone(&self.orchestrator);
let service_name = service_name.clone();
async move {
const METRICS_INTERVAL: Duration = Duration::from_secs(60);
// TODO[btv] -- I tried implementing a `watch_metrics` function,
// similar to `watch_services`, but it crashed due to
// https://github.com/kube-rs/kube/issues/1092 .
//
// If `metrics-server` can be made to fill in `resourceVersion`,
// or if that bug is fixed, we can try that again rather than using this inelegant
// loop.
let mut interval = tokio::time::interval(METRICS_INTERVAL);
loop {
interval.tick().await;
match orchestrator.fetch_service_metrics(&service_name).await {
Ok(metrics) => {
let _ = tx.send((replica_id, metrics));
}
Err(e) => {
warn!("failed to get metrics for replica {replica_id}: {e}");
}
}
}
}
});
Ok((service, metrics_task.abort_on_drop()))
}
/// Deprovisions a replica with the service orchestrator.
async fn deprovision_replica(
&mut self,
cluster_id: ClusterId,
replica_id: ReplicaId,
) -> Result<(), anyhow::Error> {
let service_name = generate_replica_service_name(cluster_id, replica_id);
self.orchestrator.drop_service(&service_name).await
}
}
/// Deterministically generates replica names based on inputs.
fn generate_replica_service_name(cluster_id: ClusterId, replica_id: ReplicaId) -> String {
format!("{cluster_id}-replica-{replica_id}")
}
/// Parses a name generated by `generate_replica_service_name`, to extract the
/// replica's cluster ID and replica ID.
fn parse_replica_service_name(
service_name: &str,
) -> Result<(ComputeInstanceId, ReplicaId), anyhow::Error> {
static SERVICE_NAME_RE: Lazy<Regex> =
Lazy::new(|| Regex::new(r"(?-u)^([us]\d+)-replica-([us]\d+)$").unwrap());
let caps = SERVICE_NAME_RE
.captures(service_name)
.ok_or_else(|| anyhow!("invalid service name: {service_name}"))?;
let cluster_id = caps.get(1).unwrap().as_str().parse().unwrap();
let replica_id = caps.get(2).unwrap().as_str().parse().unwrap();
Ok((cluster_id, replica_id))
}