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
// 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, BTreeSet};
use std::sync::Arc;
use bytesize::ByteSize;
use ipnet::IpNet;
use mz_build_info::BuildInfo;
use mz_cloud_resources::AwsExternalIdPrefix;
use mz_controller::clusters::ReplicaAllocation;
use mz_orchestrator::MemoryLimit;
use mz_ore::cast::CastFrom;
use mz_ore::metrics::MetricsRegistry;
use mz_persist_client::PersistClient;
use mz_repr::CatalogItemId;
use mz_sql::catalog::CatalogError as SqlCatalogError;
use mz_sql::catalog::EnvironmentId;
use mz_sql::session::vars::ConnectionCounter;
use serde::{Deserialize, Serialize};
use crate::durable::{CatalogError, DurableCatalogState};
/// Configures a catalog.
#[derive(Debug)]
pub struct Config<'a> {
/// The connection to the catalog storage.
pub storage: Box<dyn DurableCatalogState>,
/// The registry that catalog uses to report metrics.
pub metrics_registry: &'a MetricsRegistry,
pub state: StateConfig,
}
#[derive(Debug)]
pub struct StateConfig {
/// Whether to enable unsafe mode.
pub unsafe_mode: bool,
/// Whether the build is a local dev build.
pub all_features: bool,
/// Information about this build of Materialize.
pub build_info: &'static BuildInfo,
/// A persistent ID associated with the environment.
pub environment_id: EnvironmentId,
/// Whether to start Materialize in read-only mode.
pub read_only: bool,
/// Function to generate wall clock now; can be mocked.
pub now: mz_ore::now::NowFn,
/// Linearizable timestamp of when this environment booted.
pub boot_ts: mz_repr::Timestamp,
/// Whether or not to skip catalog migrations.
pub skip_migrations: bool,
/// Map of strings to corresponding compute replica sizes.
pub cluster_replica_sizes: ClusterReplicaSizeMap,
/// Builtin system cluster replica size.
pub builtin_system_cluster_replica_size: String,
/// Builtin catalog server cluster replica size.
pub builtin_catalog_server_cluster_replica_size: String,
/// Builtin probe cluster replica size.
pub builtin_probe_cluster_replica_size: String,
/// Builtin support cluster replica size.
pub builtin_support_cluster_replica_size: String,
/// Builtin analytics cluster replica size.
pub builtin_analytics_cluster_replica_size: String,
/// Dynamic defaults for system parameters.
pub system_parameter_defaults: BTreeMap<String, String>,
/// An optional map of system parameters pulled from a remote frontend.
/// A `None` value indicates that the initial sync was skipped.
pub remote_system_parameters: Option<BTreeMap<String, String>>,
/// Valid availability zones for replicas.
pub availability_zones: Vec<String>,
/// IP Addresses which will be used for egress.
pub egress_addresses: Vec<IpNet>,
/// Context for generating an AWS Principal.
pub aws_principal_context: Option<AwsPrincipalContext>,
/// Supported AWS PrivateLink availability zone ids.
pub aws_privatelink_availability_zones: Option<BTreeSet<String>>,
/// Host name or URL for connecting to the HTTP server of this instance.
pub http_host_name: Option<String>,
/// Context for source and sink connections.
pub connection_context: mz_storage_types::connections::ConnectionContext,
/// Global connection limit and count
pub active_connection_count: Arc<std::sync::Mutex<ConnectionCounter>>,
pub builtin_item_migration_config: BuiltinItemMigrationConfig,
pub persist_client: PersistClient,
/// Overrides the current value of the [`mz_adapter_types::dyncfgs::ENABLE_EXPRESSION_CACHE`]
/// feature flag.
pub enable_expression_cache_override: Option<bool>,
/// Whether to enable zero-downtime deployments.
pub enable_0dt_deployment: bool,
/// Helm chart version
pub helm_chart_version: Option<String>,
}
#[derive(Debug)]
pub enum BuiltinItemMigrationConfig {
Legacy,
ZeroDownTime {
persist_client: PersistClient,
deploy_generation: u64,
read_only: bool,
},
}
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct ClusterReplicaSizeMap(pub BTreeMap<String, ReplicaAllocation>);
impl ClusterReplicaSizeMap {
/// Iterate all enabled (not disabled) replica allocations, with their name.
pub fn enabled_allocations(&self) -> impl Iterator<Item = (&String, &ReplicaAllocation)> {
self.0.iter().filter(|(_, a)| !a.disabled)
}
/// Get a replica allocation by size name. Returns a reference to the allocation, or an
/// error if the size is unknown.
pub fn get_allocation_by_name(&self, name: &str) -> Result<&ReplicaAllocation, CatalogError> {
self.0.get(name).ok_or_else(|| {
CatalogError::Catalog(SqlCatalogError::UnknownClusterReplicaSize(name.into()))
})
}
/// Used for testing and local purposes. This default value should not be used in production.
///
/// Credits per hour are calculated as being equal to scale. This is not necessarily how the
/// value is computed in production.
pub fn for_tests() -> Self {
// {
// "1": {"scale": 1, "workers": 1},
// "2": {"scale": 1, "workers": 2},
// "4": {"scale": 1, "workers": 4},
// /// ...
// "32": {"scale": 1, "workers": 32}
// /// Testing with multiple processes on a single machine
// "2-4": {"scale": 2, "workers": 4},
// /// Used in mzcompose tests
// "2-2": {"scale": 2, "workers": 2},
// ...
// "16-16": {"scale": 16, "workers": 16},
// /// Used in the shared_fate cloudtest tests
// "2-1": {"scale": 2, "workers": 1},
// ...
// "16-1": {"scale": 16, "workers": 1},
// /// Used in the cloudtest tests that force OOMs
// "mem-2": { "memory_limit": 2Gb },
// ...
// "mem-16": { "memory_limit": 16Gb },
// }
let mut inner = (0..=5)
.flat_map(|i| {
let workers: u8 = 1 << i;
[
(workers.to_string(), None),
(format!("{workers}-4G"), Some(4)),
(format!("{workers}-8G"), Some(8)),
(format!("{workers}-16G"), Some(16)),
(format!("{workers}-32G"), Some(32)),
]
.map(|(name, memory_limit)| {
(
name,
ReplicaAllocation {
memory_limit: memory_limit.map(|gib| MemoryLimit(ByteSize::gib(gib))),
cpu_limit: None,
disk_limit: None,
scale: 1,
workers: workers.into(),
credits_per_hour: 1.into(),
cpu_exclusive: false,
is_cc: false,
disabled: false,
selectors: BTreeMap::default(),
},
)
})
})
.collect::<BTreeMap<_, _>>();
for i in 1..=5 {
let scale = 1 << i;
inner.insert(
format!("{scale}-1"),
ReplicaAllocation {
memory_limit: None,
cpu_limit: None,
disk_limit: None,
scale,
workers: 1,
credits_per_hour: scale.into(),
cpu_exclusive: false,
is_cc: false,
disabled: false,
selectors: BTreeMap::default(),
},
);
inner.insert(
format!("{scale}-{scale}"),
ReplicaAllocation {
memory_limit: None,
cpu_limit: None,
disk_limit: None,
scale,
workers: scale.into(),
credits_per_hour: scale.into(),
cpu_exclusive: false,
is_cc: false,
disabled: false,
selectors: BTreeMap::default(),
},
);
inner.insert(
format!("mem-{scale}"),
ReplicaAllocation {
memory_limit: Some(MemoryLimit(ByteSize(u64::cast_from(scale) * (1 << 30)))),
cpu_limit: None,
disk_limit: None,
scale: 1,
workers: 8,
credits_per_hour: 1.into(),
cpu_exclusive: false,
is_cc: false,
disabled: false,
selectors: BTreeMap::default(),
},
);
}
inner.insert(
"2-4".to_string(),
ReplicaAllocation {
memory_limit: None,
cpu_limit: None,
disk_limit: None,
scale: 2,
workers: 4,
credits_per_hour: 2.into(),
cpu_exclusive: false,
is_cc: false,
disabled: false,
selectors: BTreeMap::default(),
},
);
inner.insert(
"free".to_string(),
ReplicaAllocation {
memory_limit: None,
cpu_limit: None,
disk_limit: None,
scale: 0,
workers: 0,
credits_per_hour: 0.into(),
cpu_exclusive: false,
is_cc: true,
disabled: true,
selectors: BTreeMap::default(),
},
);
for size in ["1cc", "1C"] {
inner.insert(
size.to_string(),
ReplicaAllocation {
memory_limit: None,
cpu_limit: None,
disk_limit: None,
scale: 1,
workers: 1,
credits_per_hour: 1.into(),
cpu_exclusive: false,
is_cc: true,
disabled: false,
selectors: BTreeMap::default(),
},
);
}
Self(inner)
}
}
/// Context used to generate an AWS Principal.
///
/// In the case of AWS PrivateLink connections, Materialize will connect to the
/// VPC endpoint as the AWS Principal generated via this context.
#[derive(Debug, Clone, Serialize)]
pub struct AwsPrincipalContext {
pub aws_account_id: String,
pub aws_external_id_prefix: AwsExternalIdPrefix,
}
impl AwsPrincipalContext {
pub fn to_principal_string(&self, aws_external_id_suffix: CatalogItemId) -> String {
format!(
"arn:aws:iam::{}:role/mz_{}_{}",
self.aws_account_id, self.aws_external_id_prefix, aws_external_id_suffix
)
}
}