Line data Source code
1 : //! `ComputeSpec` represents the contents of the spec.json file.
2 : //!
3 : //! The spec.json file is used to pass information to 'compute_ctl'. It contains
4 : //! all the information needed to start up the right version of PostgreSQL,
5 : //! and connect it to the storage nodes.
6 : use std::collections::HashMap;
7 :
8 : use indexmap::IndexMap;
9 : use regex::Regex;
10 : use remote_storage::RemotePath;
11 : use serde::{Deserialize, Serialize};
12 : use utils::id::{TenantId, TimelineId};
13 : use utils::lsn::Lsn;
14 :
15 : use crate::responses::TlsConfig;
16 :
17 : /// String type alias representing Postgres identifier and
18 : /// intended to be used for DB / role names.
19 : pub type PgIdent = String;
20 :
21 : /// String type alias representing Postgres extension version
22 : pub type ExtVersion = String;
23 :
24 6 : fn default_reconfigure_concurrency() -> usize {
25 6 : 1
26 6 : }
27 :
28 : /// Cluster spec or configuration represented as an optional number of
29 : /// delta operations + final cluster state description.
30 45 : #[derive(Clone, Debug, Default, Deserialize, Serialize)]
31 : pub struct ComputeSpec {
32 : pub format_version: f32,
33 :
34 : // The control plane also includes a 'timestamp' field in the JSON document,
35 : // but we don't use it for anything. Serde will ignore missing fields when
36 : // deserializing it.
37 : pub operation_uuid: Option<String>,
38 :
39 : /// Compute features to enable. These feature flags are provided, when we
40 : /// know all the details about client's compute, so they cannot be used
41 : /// to change `Empty` compute behavior.
42 : #[serde(default)]
43 : pub features: Vec<ComputeFeature>,
44 :
45 : /// If compute_ctl was passed `--resize-swap-on-bind`, a value of `Some(_)` instructs
46 : /// compute_ctl to `/neonvm/bin/resize-swap` with the given size, when the spec is first
47 : /// received.
48 : ///
49 : /// Both this field and `--resize-swap-on-bind` are required, so that the control plane's
50 : /// spec generation doesn't need to be aware of the actual compute it's running on, while
51 : /// guaranteeing gradual rollout of swap. Otherwise, without `--resize-swap-on-bind`, we could
52 : /// end up trying to resize swap in VMs without it -- or end up *not* resizing swap, thus
53 : /// giving every VM much more swap than it should have (32GiB).
54 : ///
55 : /// Eventually we may remove `--resize-swap-on-bind` and exclusively use `swap_size_bytes` for
56 : /// enabling the swap resizing behavior once rollout is complete.
57 : ///
58 : /// See neondatabase/cloud#12047 for more.
59 : #[serde(default)]
60 : pub swap_size_bytes: Option<u64>,
61 :
62 : /// If compute_ctl was passed `--set-disk-quota-for-fs`, a value of `Some(_)` instructs
63 : /// compute_ctl to run `/neonvm/bin/set-disk-quota` with the given size and fs, when the
64 : /// spec is first received.
65 : ///
66 : /// Both this field and `--set-disk-quota-for-fs` are required, so that the control plane's
67 : /// spec generation doesn't need to be aware of the actual compute it's running on, while
68 : /// guaranteeing gradual rollout of disk quota.
69 : #[serde(default)]
70 : pub disk_quota_bytes: Option<u64>,
71 :
72 : /// Disables the vm-monitor behavior that resizes LFC on upscale/downscale, instead relying on
73 : /// the initial size of LFC.
74 : ///
75 : /// This is intended for use when the LFC size is being overridden from the default but
76 : /// autoscaling is still enabled, and we don't want the vm-monitor to interfere with the custom
77 : /// LFC sizing.
78 : #[serde(default)]
79 : pub disable_lfc_resizing: Option<bool>,
80 :
81 : /// Expected cluster state at the end of transition process.
82 : pub cluster: Cluster,
83 : pub delta_operations: Option<Vec<DeltaOp>>,
84 :
85 : /// An optional hint that can be passed to speed up startup time if we know
86 : /// that no pg catalog mutations (like role creation, database creation,
87 : /// extension creation) need to be done on the actual database to start.
88 : #[serde(default)] // Default false
89 : pub skip_pg_catalog_updates: bool,
90 :
91 : // Information needed to connect to the storage layer.
92 : //
93 : // `tenant_id`, `timeline_id` and `pageserver_connstring` are always needed.
94 : //
95 : // Depending on `mode`, this can be a primary read-write node, a read-only
96 : // replica, or a read-only node pinned at an older LSN.
97 : // `safekeeper_connstrings` must be set for a primary.
98 : //
99 : // For backwards compatibility, the control plane may leave out all of
100 : // these, and instead set the "neon.tenant_id", "neon.timeline_id",
101 : // etc. GUCs in cluster.settings. TODO: Once the control plane has been
102 : // updated to fill these fields, we can make these non optional.
103 : pub tenant_id: Option<TenantId>,
104 : pub timeline_id: Option<TimelineId>,
105 : pub pageserver_connstring: Option<String>,
106 :
107 : /// Safekeeper membership config generation. It is put in
108 : /// neon.safekeepers GUC and serves two purposes:
109 : /// 1) Non zero value forces walproposer to use membership configurations.
110 : /// 2) If walproposer wants to update list of safekeepers to connect to
111 : /// taking them from some safekeeper mconf, it should check what value
112 : /// is newer by comparing the generation.
113 : ///
114 : /// Note: it could be SafekeeperGeneration, but this needs linking
115 : /// compute_ctl with postgres_ffi.
116 : #[serde(default)]
117 : pub safekeepers_generation: Option<u32>,
118 : #[serde(default)]
119 : pub safekeeper_connstrings: Vec<String>,
120 :
121 : #[serde(default)]
122 : pub mode: ComputeMode,
123 :
124 : /// If set, 'storage_auth_token' is used as the password to authenticate to
125 : /// the pageserver and safekeepers.
126 : pub storage_auth_token: Option<String>,
127 :
128 : // information about available remote extensions
129 : pub remote_extensions: Option<RemoteExtSpec>,
130 :
131 : pub pgbouncer_settings: Option<IndexMap<String, String>>,
132 :
133 : // Stripe size for pageserver sharding, in pages
134 : #[serde(default)]
135 : pub shard_stripe_size: Option<usize>,
136 :
137 : /// Local Proxy configuration used for JWT authentication
138 : #[serde(default)]
139 : pub local_proxy_config: Option<LocalProxySpec>,
140 :
141 : /// Number of concurrent connections during the parallel RunInEachDatabase
142 : /// phase of the apply config process.
143 : ///
144 : /// We need a higher concurrency during reconfiguration in case of many DBs,
145 : /// but instance is already running and used by client. We can easily get out of
146 : /// `max_connections` limit, and the current code won't handle that.
147 : ///
148 : /// Default is 1, but also allow control plane to override this value for specific
149 : /// projects. It's also recommended to bump `superuser_reserved_connections` +=
150 : /// `reconfigure_concurrency` for such projects to ensure that we always have
151 : /// enough spare connections for reconfiguration process to succeed.
152 : #[serde(default = "default_reconfigure_concurrency")]
153 : pub reconfigure_concurrency: usize,
154 :
155 : /// If set to true, the compute_ctl will drop all subscriptions before starting the
156 : /// compute. This is needed when we start an endpoint on a branch, so that child
157 : /// would not compete with parent branch subscriptions
158 : /// over the same replication content from publisher.
159 : #[serde(default)] // Default false
160 : pub drop_subscriptions_before_start: bool,
161 :
162 : /// Log level for audit logging:
163 : #[serde(default)]
164 : pub audit_log_level: ComputeAudit,
165 : }
166 :
167 : /// Feature flag to signal `compute_ctl` to enable certain experimental functionality.
168 3 : #[derive(Serialize, Clone, Copy, Debug, Deserialize, PartialEq, Eq)]
169 : #[serde(rename_all = "snake_case")]
170 : pub enum ComputeFeature {
171 : // XXX: Add more feature flags here.
172 : /// Enable the experimental activity monitor logic, which uses `pg_stat_database` to
173 : /// track short-lived connections as user activity.
174 : ActivityMonitorExperimental,
175 :
176 : /// Allow to configure rsyslog for Postgres logs export
177 : PostgresLogsExport,
178 :
179 : /// This is a special feature flag that is used to represent unknown feature flags.
180 : /// Basically all unknown to enum flags are represented as this one. See unit test
181 : /// `parse_unknown_features()` for more details.
182 : #[serde(other)]
183 : UnknownFeature,
184 : }
185 :
186 44 : #[derive(Clone, Debug, Default, Deserialize, Serialize)]
187 : pub struct RemoteExtSpec {
188 : pub public_extensions: Option<Vec<String>>,
189 : pub custom_extensions: Option<Vec<String>>,
190 : pub library_index: HashMap<String, String>,
191 : pub extension_data: HashMap<String, ExtensionData>,
192 : }
193 :
194 18 : #[derive(Clone, Debug, Serialize, Deserialize)]
195 : pub struct ExtensionData {
196 : pub control_data: HashMap<String, String>,
197 : pub archive_path: String,
198 : }
199 :
200 : impl RemoteExtSpec {
201 6 : pub fn get_ext(
202 6 : &self,
203 6 : ext_name: &str,
204 6 : is_library: bool,
205 6 : build_tag: &str,
206 6 : pg_major_version: &str,
207 6 : ) -> anyhow::Result<(String, RemotePath)> {
208 6 : let mut real_ext_name = ext_name;
209 6 : if is_library {
210 : // sometimes library names might have a suffix like
211 : // library.so or library.so.3. We strip this off
212 : // because library_index is based on the name without the file extension
213 1 : let strip_lib_suffix = Regex::new(r"\.so.*").unwrap();
214 1 : let lib_raw_name = strip_lib_suffix.replace(real_ext_name, "").to_string();
215 1 :
216 1 : real_ext_name = self
217 1 : .library_index
218 1 : .get(&lib_raw_name)
219 1 : .ok_or(anyhow::anyhow!("library {} is not found", lib_raw_name))?;
220 5 : }
221 :
222 : // Check if extension is present in public or custom.
223 : // If not, then it is not allowed to be used by this compute.
224 6 : if !self
225 6 : .public_extensions
226 6 : .as_ref()
227 6 : .is_some_and(|exts| exts.iter().any(|e| e == real_ext_name))
228 4 : && !self
229 4 : .custom_extensions
230 4 : .as_ref()
231 4 : .is_some_and(|exts| exts.iter().any(|e| e == real_ext_name))
232 : {
233 3 : return Err(anyhow::anyhow!("extension {} is not found", real_ext_name));
234 3 : }
235 3 :
236 3 : match self.extension_data.get(real_ext_name) {
237 3 : Some(_ext_data) => {
238 3 : // Construct the path to the extension archive
239 3 : // BUILD_TAG/PG_MAJOR_VERSION/extensions/EXTENSION_NAME.tar.zst
240 3 : //
241 3 : // Keep it in sync with path generation in
242 3 : // https://github.com/neondatabase/build-custom-extensions/tree/main
243 3 : let archive_path_str =
244 3 : format!("{build_tag}/{pg_major_version}/extensions/{real_ext_name}.tar.zst");
245 3 : Ok((
246 3 : real_ext_name.to_string(),
247 3 : RemotePath::from_string(&archive_path_str)?,
248 : ))
249 : }
250 0 : None => Err(anyhow::anyhow!(
251 0 : "real_ext_name {} is not found",
252 0 : real_ext_name
253 0 : )),
254 : }
255 6 : }
256 : }
257 :
258 0 : #[derive(Clone, Copy, Debug, Default, Eq, PartialEq, Deserialize, Serialize)]
259 : pub enum ComputeMode {
260 : /// A read-write node
261 : #[default]
262 : Primary,
263 : /// A read-only node, pinned at a particular LSN
264 : Static(Lsn),
265 : /// A read-only node that follows the tip of the branch in hot standby mode
266 : ///
267 : /// Future versions may want to distinguish between replicas with hot standby
268 : /// feedback and other kinds of replication configurations.
269 : Replica,
270 : }
271 :
272 : impl ComputeMode {
273 : /// Convert the compute mode to a string that can be used to identify the type of compute,
274 : /// which means that if it's a static compute, the LSN will not be included.
275 0 : pub fn to_type_str(&self) -> &'static str {
276 0 : match self {
277 0 : ComputeMode::Primary => "primary",
278 0 : ComputeMode::Static(_) => "static",
279 0 : ComputeMode::Replica => "replica",
280 : }
281 0 : }
282 : }
283 :
284 : /// Log level for audit logging
285 0 : #[derive(Clone, Copy, Debug, Default, Eq, PartialEq, Deserialize, Serialize)]
286 : pub enum ComputeAudit {
287 : #[default]
288 : /// no audit logging. This is the default.
289 : Disabled,
290 : /// write masked audit log statements to the postgres log using pgaudit extension
291 : Log,
292 : /// log unmasked statements to the file using pgaudit and pgauditlogtofile extensions
293 : Hipaa,
294 : }
295 :
296 : impl ComputeAudit {
297 0 : pub fn as_str(&self) -> &str {
298 0 : match self {
299 0 : ComputeAudit::Disabled => "disabled",
300 0 : ComputeAudit::Log => "log",
301 0 : ComputeAudit::Hipaa => "hipaa",
302 : }
303 0 : }
304 : }
305 :
306 36 : #[derive(Clone, Debug, Default, Deserialize, Serialize, PartialEq, Eq)]
307 : pub struct Cluster {
308 : pub cluster_id: Option<String>,
309 : pub name: Option<String>,
310 : pub state: Option<String>,
311 : pub roles: Vec<Role>,
312 : pub databases: Vec<Database>,
313 :
314 : /// Desired contents of 'postgresql.conf' file. (The 'compute_ctl'
315 : /// tool may add additional settings to the final file.)
316 : pub postgresql_conf: Option<String>,
317 :
318 : /// Additional settings that will be appended to the 'postgresql.conf' file.
319 : pub settings: GenericOptions,
320 : }
321 :
322 : /// Single cluster state changing operation that could not be represented as
323 : /// a static `Cluster` structure. For example:
324 : /// - DROP DATABASE
325 : /// - DROP ROLE
326 : /// - ALTER ROLE name RENAME TO new_name
327 : /// - ALTER DATABASE name RENAME TO new_name
328 60 : #[derive(Clone, Debug, Deserialize, Serialize)]
329 : pub struct DeltaOp {
330 : pub action: String,
331 : pub name: PgIdent,
332 : pub new_name: Option<PgIdent>,
333 : }
334 :
335 : /// Rust representation of Postgres role info with only those fields
336 : /// that matter for us.
337 90 : #[derive(Clone, Debug, Deserialize, Serialize, PartialEq, Eq)]
338 : pub struct Role {
339 : pub name: PgIdent,
340 : pub encrypted_password: Option<String>,
341 : pub options: GenericOptions,
342 : }
343 :
344 : /// Rust representation of Postgres database info with only those fields
345 : /// that matter for us.
346 42 : #[derive(Clone, Debug, Deserialize, Serialize, PartialEq, Eq)]
347 : pub struct Database {
348 : pub name: PgIdent,
349 : pub owner: PgIdent,
350 : pub options: GenericOptions,
351 : // These are derived flags, not present in the spec file.
352 : // They are never set by the control plane.
353 : #[serde(skip_deserializing, default)]
354 : pub restrict_conn: bool,
355 : #[serde(skip_deserializing, default)]
356 : pub invalid: bool,
357 : }
358 :
359 : /// Common type representing both SQL statement params with or without value,
360 : /// like `LOGIN` or `OWNER username` in the `CREATE/ALTER ROLE`, and config
361 : /// options like `wal_level = logical`.
362 468 : #[derive(Clone, Debug, Deserialize, Serialize, PartialEq, Eq)]
363 : pub struct GenericOption {
364 : pub name: String,
365 : pub value: Option<String>,
366 : pub vartype: String,
367 : }
368 :
369 : /// Optional collection of `GenericOption`'s. Type alias allows us to
370 : /// declare a `trait` on it.
371 : pub type GenericOptions = Option<Vec<GenericOption>>;
372 :
373 : /// Configured the local_proxy application with the relevant JWKS and roles it should
374 : /// use for authorizing connect requests using JWT.
375 0 : #[derive(Clone, Debug, Deserialize, Serialize)]
376 : pub struct LocalProxySpec {
377 : #[serde(default)]
378 : #[serde(skip_serializing_if = "Option::is_none")]
379 : pub jwks: Option<Vec<JwksSettings>>,
380 : #[serde(default)]
381 : #[serde(skip_serializing_if = "Option::is_none")]
382 : pub tls: Option<TlsConfig>,
383 : }
384 :
385 0 : #[derive(Clone, Debug, Deserialize, Serialize)]
386 : pub struct JwksSettings {
387 : pub id: String,
388 : pub role_names: Vec<String>,
389 : pub jwks_url: String,
390 : pub provider_name: String,
391 : pub jwt_audience: Option<String>,
392 : }
393 :
394 : #[cfg(test)]
395 : mod tests {
396 : use std::fs::File;
397 :
398 : use super::*;
399 :
400 : #[test]
401 1 : fn allow_installing_remote_extensions() {
402 1 : let rspec: RemoteExtSpec = serde_json::from_value(serde_json::json!({
403 1 : "public_extensions": null,
404 1 : "custom_extensions": null,
405 1 : "library_index": {},
406 1 : "extension_data": {},
407 1 : }))
408 1 : .unwrap();
409 1 :
410 1 : rspec
411 1 : .get_ext("ext", false, "latest", "v17")
412 1 : .expect_err("Extension should not be found");
413 1 :
414 1 : let rspec: RemoteExtSpec = serde_json::from_value(serde_json::json!({
415 1 : "public_extensions": [],
416 1 : "custom_extensions": null,
417 1 : "library_index": {},
418 1 : "extension_data": {},
419 1 : }))
420 1 : .unwrap();
421 1 :
422 1 : rspec
423 1 : .get_ext("ext", false, "latest", "v17")
424 1 : .expect_err("Extension should not be found");
425 1 :
426 1 : let rspec: RemoteExtSpec = serde_json::from_value(serde_json::json!({
427 1 : "public_extensions": [],
428 1 : "custom_extensions": [],
429 1 : "library_index": {
430 1 : "ext": "ext"
431 1 : },
432 1 : "extension_data": {
433 1 : "ext": {
434 1 : "control_data": {
435 1 : "ext.control": ""
436 1 : },
437 1 : "archive_path": ""
438 1 : }
439 1 : },
440 1 : }))
441 1 : .unwrap();
442 1 :
443 1 : rspec
444 1 : .get_ext("ext", false, "latest", "v17")
445 1 : .expect_err("Extension should not be found");
446 1 :
447 1 : let rspec: RemoteExtSpec = serde_json::from_value(serde_json::json!({
448 1 : "public_extensions": [],
449 1 : "custom_extensions": ["ext"],
450 1 : "library_index": {
451 1 : "ext": "ext"
452 1 : },
453 1 : "extension_data": {
454 1 : "ext": {
455 1 : "control_data": {
456 1 : "ext.control": ""
457 1 : },
458 1 : "archive_path": ""
459 1 : }
460 1 : },
461 1 : }))
462 1 : .unwrap();
463 1 :
464 1 : rspec
465 1 : .get_ext("ext", false, "latest", "v17")
466 1 : .expect("Extension should be found");
467 1 :
468 1 : let rspec: RemoteExtSpec = serde_json::from_value(serde_json::json!({
469 1 : "public_extensions": ["ext"],
470 1 : "custom_extensions": [],
471 1 : "library_index": {
472 1 : "extlib": "ext",
473 1 : },
474 1 : "extension_data": {
475 1 : "ext": {
476 1 : "control_data": {
477 1 : "ext.control": ""
478 1 : },
479 1 : "archive_path": ""
480 1 : }
481 1 : },
482 1 : }))
483 1 : .unwrap();
484 1 :
485 1 : rspec
486 1 : .get_ext("ext", false, "latest", "v17")
487 1 : .expect("Extension should be found");
488 1 :
489 1 : // test library index for the case when library name
490 1 : // doesn't match the extension name
491 1 : rspec
492 1 : .get_ext("extlib", true, "latest", "v17")
493 1 : .expect("Library should be found");
494 1 : }
495 :
496 : #[test]
497 1 : fn parse_spec_file() {
498 1 : let file = File::open("tests/cluster_spec.json").unwrap();
499 1 : let spec: ComputeSpec = serde_json::from_reader(file).unwrap();
500 1 :
501 1 : // Features list defaults to empty vector.
502 1 : assert!(spec.features.is_empty());
503 :
504 : // Reconfigure concurrency defaults to 1.
505 1 : assert_eq!(spec.reconfigure_concurrency, 1);
506 1 : }
507 :
508 : #[test]
509 1 : fn parse_unknown_fields() {
510 1 : // Forward compatibility test
511 1 : let file = File::open("tests/cluster_spec.json").unwrap();
512 1 : let mut json: serde_json::Value = serde_json::from_reader(file).unwrap();
513 1 : let ob = json.as_object_mut().unwrap();
514 1 : ob.insert("unknown_field_123123123".into(), "hello".into());
515 1 : let _spec: ComputeSpec = serde_json::from_value(json).unwrap();
516 1 : }
517 :
518 : #[test]
519 1 : fn parse_unknown_features() {
520 1 : // Test that unknown feature flags do not cause any errors.
521 1 : let file = File::open("tests/cluster_spec.json").unwrap();
522 1 : let mut json: serde_json::Value = serde_json::from_reader(file).unwrap();
523 1 : let ob = json.as_object_mut().unwrap();
524 1 :
525 1 : // Add unknown feature flags.
526 1 : let features = vec!["foo_bar_feature", "baz_feature"];
527 1 : ob.insert("features".into(), features.into());
528 1 :
529 1 : let spec: ComputeSpec = serde_json::from_value(json).unwrap();
530 1 :
531 1 : assert!(spec.features.len() == 2);
532 1 : assert!(spec.features.contains(&ComputeFeature::UnknownFeature));
533 1 : assert_eq!(spec.features, vec![ComputeFeature::UnknownFeature; 2]);
534 1 : }
535 :
536 : #[test]
537 1 : fn parse_known_features() {
538 1 : // Test that we can properly parse known feature flags.
539 1 : let file = File::open("tests/cluster_spec.json").unwrap();
540 1 : let mut json: serde_json::Value = serde_json::from_reader(file).unwrap();
541 1 : let ob = json.as_object_mut().unwrap();
542 1 :
543 1 : // Add known feature flags.
544 1 : let features = vec!["activity_monitor_experimental"];
545 1 : ob.insert("features".into(), features.into());
546 1 :
547 1 : let spec: ComputeSpec = serde_json::from_value(json).unwrap();
548 1 :
549 1 : assert_eq!(
550 1 : spec.features,
551 1 : vec![ComputeFeature::ActivityMonitorExperimental]
552 1 : );
553 1 : }
554 : }
|
