Line data Source code
1 : //! Functions for handling page server configuration options
2 : //!
3 : //! Configuration options can be set in the pageserver.toml configuration
4 : //! file, or on the command line.
5 : //! See also `settings.md` for better description on every parameter.
6 :
7 : use anyhow::{bail, ensure, Context};
8 : use pageserver_api::models::ImageCompressionAlgorithm;
9 : use pageserver_api::{
10 : config::{DiskUsageEvictionTaskConfig, MaxVectoredReadBytes},
11 : shard::TenantShardId,
12 : };
13 : use remote_storage::{RemotePath, RemoteStorageConfig};
14 : use std::env;
15 : use storage_broker::Uri;
16 : use utils::logging::SecretString;
17 : use utils::postgres_client::PostgresClientProtocol;
18 :
19 : use once_cell::sync::OnceCell;
20 : use reqwest::Url;
21 : use std::num::NonZeroUsize;
22 : use std::sync::Arc;
23 : use std::time::Duration;
24 :
25 : use camino::{Utf8Path, Utf8PathBuf};
26 : use postgres_backend::AuthType;
27 : use utils::{
28 : id::{NodeId, TimelineId},
29 : logging::LogFormat,
30 : };
31 :
32 : use crate::tenant::storage_layer::inmemory_layer::IndexEntry;
33 : use crate::tenant::{TENANTS_SEGMENT_NAME, TIMELINES_SEGMENT_NAME};
34 : use crate::virtual_file;
35 : use crate::virtual_file::io_engine;
36 : use crate::{TENANT_HEATMAP_BASENAME, TENANT_LOCATION_CONFIG_NAME};
37 :
38 : /// Global state of pageserver.
39 : ///
40 : /// It's mostly immutable configuration, but some semaphores and the
41 : /// like crept in over time and the name stuck.
42 : ///
43 : /// Instantiated by deserializing `pageserver.toml` into [`pageserver_api::config::ConfigToml`]
44 : /// and passing that to [`PageServerConf::parse_and_validate`].
45 : ///
46 : /// # Adding a New Field
47 : ///
48 : /// 1. Add the field to `pageserver_api::config::ConfigToml`.
49 : /// 2. Fix compiler errors (exhaustive destructuring will guide you).
50 : ///
51 : /// For fields that require additional validation or filling in of defaults at runtime,
52 : /// check for examples in the [`PageServerConf::parse_and_validate`] method.
53 : #[derive(Debug, Clone, PartialEq, Eq)]
54 : pub struct PageServerConf {
55 : // Identifier of that particular pageserver so e g safekeepers
56 : // can safely distinguish different pageservers
57 : pub id: NodeId,
58 :
59 : /// Example (default): 127.0.0.1:64000
60 : pub listen_pg_addr: String,
61 : /// Example (default): 127.0.0.1:9898
62 : pub listen_http_addr: String,
63 :
64 : /// Current availability zone. Used for traffic metrics.
65 : pub availability_zone: Option<String>,
66 :
67 : // Timeout when waiting for WAL receiver to catch up to an LSN given in a GetPage@LSN call.
68 : pub wait_lsn_timeout: Duration,
69 : // How long to wait for WAL redo to complete.
70 : pub wal_redo_timeout: Duration,
71 :
72 : pub superuser: String,
73 : pub locale: String,
74 :
75 : pub page_cache_size: usize,
76 : pub max_file_descriptors: usize,
77 :
78 : // Repository directory, relative to current working directory.
79 : // Normally, the page server changes the current working directory
80 : // to the repository, and 'workdir' is always '.'. But we don't do
81 : // that during unit testing, because the current directory is global
82 : // to the process but different unit tests work on different
83 : // repositories.
84 : pub workdir: Utf8PathBuf,
85 :
86 : pub pg_distrib_dir: Utf8PathBuf,
87 :
88 : // Authentication
89 : /// authentication method for the HTTP mgmt API
90 : pub http_auth_type: AuthType,
91 : /// authentication method for libpq connections from compute
92 : pub pg_auth_type: AuthType,
93 : /// Path to a file or directory containing public key(s) for verifying JWT tokens.
94 : /// Used for both mgmt and compute auth, if enabled.
95 : pub auth_validation_public_key_path: Option<Utf8PathBuf>,
96 :
97 : pub remote_storage_config: Option<RemoteStorageConfig>,
98 :
99 : pub default_tenant_conf: crate::tenant::config::TenantConf,
100 :
101 : /// Storage broker endpoints to connect to.
102 : pub broker_endpoint: Uri,
103 : pub broker_keepalive_interval: Duration,
104 :
105 : pub log_format: LogFormat,
106 :
107 : /// Number of tenants which will be concurrently loaded from remote storage proactively on startup or attach.
108 : ///
109 : /// A lower value implicitly deprioritizes loading such tenants, vs. other work in the system.
110 : pub concurrent_tenant_warmup: ConfigurableSemaphore,
111 :
112 : /// Number of concurrent [`Tenant::gather_size_inputs`](crate::tenant::Tenant::gather_size_inputs) allowed.
113 : pub concurrent_tenant_size_logical_size_queries: ConfigurableSemaphore,
114 : /// Limit of concurrent [`Tenant::gather_size_inputs`] issued by module `eviction_task`.
115 : /// The number of permits is the same as `concurrent_tenant_size_logical_size_queries`.
116 : /// See the comment in `eviction_task` for details.
117 : ///
118 : /// [`Tenant::gather_size_inputs`]: crate::tenant::Tenant::gather_size_inputs
119 : pub eviction_task_immitated_concurrent_logical_size_queries: ConfigurableSemaphore,
120 :
121 : // How often to collect metrics and send them to the metrics endpoint.
122 : pub metric_collection_interval: Duration,
123 : // How often to send unchanged cached metrics to the metrics endpoint.
124 : pub metric_collection_endpoint: Option<Url>,
125 : pub metric_collection_bucket: Option<RemoteStorageConfig>,
126 : pub synthetic_size_calculation_interval: Duration,
127 :
128 : pub disk_usage_based_eviction: Option<DiskUsageEvictionTaskConfig>,
129 :
130 : pub test_remote_failures: u64,
131 :
132 : pub ondemand_download_behavior_treat_error_as_warn: bool,
133 :
134 : /// How long will background tasks be delayed at most after initial load of tenants.
135 : ///
136 : /// Our largest initialization completions are in the range of 100-200s, so perhaps 10s works
137 : /// as we now isolate initial loading, initial logical size calculation and background tasks.
138 : /// Smaller nodes will have background tasks "not running" for this long unless every timeline
139 : /// has it's initial logical size calculated. Not running background tasks for some seconds is
140 : /// not terrible.
141 : pub background_task_maximum_delay: Duration,
142 :
143 : pub control_plane_api: Option<Url>,
144 :
145 : /// JWT token for use with the control plane API.
146 : pub control_plane_api_token: Option<SecretString>,
147 :
148 : pub import_pgdata_upcall_api: Option<Url>,
149 : pub import_pgdata_upcall_api_token: Option<SecretString>,
150 : pub import_pgdata_aws_endpoint_url: Option<Url>,
151 :
152 : /// If true, pageserver will make best-effort to operate without a control plane: only
153 : /// for use in major incidents.
154 : pub control_plane_emergency_mode: bool,
155 :
156 : /// How many heatmap uploads may be done concurrency: lower values implicitly deprioritize
157 : /// heatmap uploads vs. other remote storage operations.
158 : pub heatmap_upload_concurrency: usize,
159 :
160 : /// How many remote storage downloads may be done for secondary tenants concurrently. Implicitly
161 : /// deprioritises secondary downloads vs. remote storage operations for attached tenants.
162 : pub secondary_download_concurrency: usize,
163 :
164 : /// Maximum number of WAL records to be ingested and committed at the same time
165 : pub ingest_batch_size: u64,
166 :
167 : pub virtual_file_io_engine: virtual_file::IoEngineKind,
168 :
169 : pub max_vectored_read_bytes: MaxVectoredReadBytes,
170 :
171 : pub image_compression: ImageCompressionAlgorithm,
172 :
173 : /// Whether to offload archived timelines automatically
174 : pub timeline_offloading: bool,
175 :
176 : /// How many bytes of ephemeral layer content will we allow per kilobyte of RAM. When this
177 : /// is exceeded, we start proactively closing ephemeral layers to limit the total amount
178 : /// of ephemeral data.
179 : ///
180 : /// Setting this to zero disables limits on total ephemeral layer size.
181 : pub ephemeral_bytes_per_memory_kb: usize,
182 :
183 : pub l0_flush: crate::l0_flush::L0FlushConfig,
184 :
185 : /// Direct IO settings
186 : pub virtual_file_io_mode: virtual_file::IoMode,
187 :
188 : /// Optionally disable disk syncs (unsafe!)
189 : pub no_sync: bool,
190 :
191 : pub wal_receiver_protocol: PostgresClientProtocol,
192 :
193 : pub page_service_pipelining: pageserver_api::config::PageServicePipeliningConfig,
194 : }
195 :
196 : /// Token for authentication to safekeepers
197 : ///
198 : /// We do not want to store this in a PageServerConf because the latter may be logged
199 : /// and/or serialized at a whim, while the token is secret. Currently this token is the
200 : /// same for accessing all tenants/timelines, but may become per-tenant/per-timeline in
201 : /// the future, more tokens and auth may arrive for storage broker, completely changing the logic.
202 : /// Hence, we resort to a global variable for now instead of passing the token from the
203 : /// startup code to the connection code through a dozen layers.
204 : pub static SAFEKEEPER_AUTH_TOKEN: OnceCell<Arc<String>> = OnceCell::new();
205 :
206 : impl PageServerConf {
207 : //
208 : // Repository paths, relative to workdir.
209 : //
210 :
211 7156 : pub fn tenants_path(&self) -> Utf8PathBuf {
212 7156 : self.workdir.join(TENANTS_SEGMENT_NAME)
213 7156 : }
214 :
215 72 : pub fn deletion_prefix(&self) -> Utf8PathBuf {
216 72 : self.workdir.join("deletion")
217 72 : }
218 :
219 0 : pub fn metadata_path(&self) -> Utf8PathBuf {
220 0 : self.workdir.join("metadata.json")
221 0 : }
222 :
223 28 : pub fn deletion_list_path(&self, sequence: u64) -> Utf8PathBuf {
224 : // Encode a version in the filename, so that if we ever switch away from JSON we can
225 : // increment this.
226 : const VERSION: u8 = 1;
227 :
228 28 : self.deletion_prefix()
229 28 : .join(format!("{sequence:016x}-{VERSION:02x}.list"))
230 28 : }
231 :
232 24 : pub fn deletion_header_path(&self) -> Utf8PathBuf {
233 : // Encode a version in the filename, so that if we ever switch away from JSON we can
234 : // increment this.
235 : const VERSION: u8 = 1;
236 :
237 24 : self.deletion_prefix().join(format!("header-{VERSION:02x}"))
238 24 : }
239 :
240 7104 : pub fn tenant_path(&self, tenant_shard_id: &TenantShardId) -> Utf8PathBuf {
241 7104 : self.tenants_path().join(tenant_shard_id.to_string())
242 7104 : }
243 :
244 : /// Points to a place in pageserver's local directory,
245 : /// where certain tenant's LocationConf be stored.
246 0 : pub(crate) fn tenant_location_config_path(
247 0 : &self,
248 0 : tenant_shard_id: &TenantShardId,
249 0 : ) -> Utf8PathBuf {
250 0 : self.tenant_path(tenant_shard_id)
251 0 : .join(TENANT_LOCATION_CONFIG_NAME)
252 0 : }
253 :
254 0 : pub(crate) fn tenant_heatmap_path(&self, tenant_shard_id: &TenantShardId) -> Utf8PathBuf {
255 0 : self.tenant_path(tenant_shard_id)
256 0 : .join(TENANT_HEATMAP_BASENAME)
257 0 : }
258 :
259 6904 : pub fn timelines_path(&self, tenant_shard_id: &TenantShardId) -> Utf8PathBuf {
260 6904 : self.tenant_path(tenant_shard_id)
261 6904 : .join(TIMELINES_SEGMENT_NAME)
262 6904 : }
263 :
264 6506 : pub fn timeline_path(
265 6506 : &self,
266 6506 : tenant_shard_id: &TenantShardId,
267 6506 : timeline_id: &TimelineId,
268 6506 : ) -> Utf8PathBuf {
269 6506 : self.timelines_path(tenant_shard_id)
270 6506 : .join(timeline_id.to_string())
271 6506 : }
272 :
273 : /// Turns storage remote path of a file into its local path.
274 0 : pub fn local_path(&self, remote_path: &RemotePath) -> Utf8PathBuf {
275 0 : remote_path.with_base(&self.workdir)
276 0 : }
277 :
278 : //
279 : // Postgres distribution paths
280 : //
281 20 : pub fn pg_distrib_dir(&self, pg_version: u32) -> anyhow::Result<Utf8PathBuf> {
282 20 : let path = self.pg_distrib_dir.clone();
283 20 :
284 20 : #[allow(clippy::manual_range_patterns)]
285 20 : match pg_version {
286 20 : 14 | 15 | 16 | 17 => Ok(path.join(format!("v{pg_version}"))),
287 0 : _ => bail!("Unsupported postgres version: {}", pg_version),
288 : }
289 20 : }
290 :
291 10 : pub fn pg_bin_dir(&self, pg_version: u32) -> anyhow::Result<Utf8PathBuf> {
292 10 : Ok(self.pg_distrib_dir(pg_version)?.join("bin"))
293 10 : }
294 10 : pub fn pg_lib_dir(&self, pg_version: u32) -> anyhow::Result<Utf8PathBuf> {
295 10 : Ok(self.pg_distrib_dir(pg_version)?.join("lib"))
296 10 : }
297 :
298 : /// Parse a configuration file (pageserver.toml) into a PageServerConf struct,
299 : /// validating the input and failing on errors.
300 : ///
301 : /// This leaves any options not present in the file in the built-in defaults.
302 214 : pub fn parse_and_validate(
303 214 : id: NodeId,
304 214 : config_toml: pageserver_api::config::ConfigToml,
305 214 : workdir: &Utf8Path,
306 214 : ) -> anyhow::Result<Self> {
307 214 : let pageserver_api::config::ConfigToml {
308 214 : listen_pg_addr,
309 214 : listen_http_addr,
310 214 : availability_zone,
311 214 : wait_lsn_timeout,
312 214 : wal_redo_timeout,
313 214 : superuser,
314 214 : locale,
315 214 : page_cache_size,
316 214 : max_file_descriptors,
317 214 : pg_distrib_dir,
318 214 : http_auth_type,
319 214 : pg_auth_type,
320 214 : auth_validation_public_key_path,
321 214 : remote_storage,
322 214 : broker_endpoint,
323 214 : broker_keepalive_interval,
324 214 : log_format,
325 214 : metric_collection_interval,
326 214 : metric_collection_endpoint,
327 214 : metric_collection_bucket,
328 214 : synthetic_size_calculation_interval,
329 214 : disk_usage_based_eviction,
330 214 : test_remote_failures,
331 214 : ondemand_download_behavior_treat_error_as_warn,
332 214 : background_task_maximum_delay,
333 214 : control_plane_api,
334 214 : control_plane_api_token,
335 214 : control_plane_emergency_mode,
336 214 : import_pgdata_upcall_api,
337 214 : import_pgdata_upcall_api_token,
338 214 : import_pgdata_aws_endpoint_url,
339 214 : heatmap_upload_concurrency,
340 214 : secondary_download_concurrency,
341 214 : ingest_batch_size,
342 214 : max_vectored_read_bytes,
343 214 : image_compression,
344 214 : timeline_offloading,
345 214 : ephemeral_bytes_per_memory_kb,
346 214 : l0_flush,
347 214 : virtual_file_io_mode,
348 214 : concurrent_tenant_warmup,
349 214 : concurrent_tenant_size_logical_size_queries,
350 214 : virtual_file_io_engine,
351 214 : tenant_config,
352 214 : no_sync,
353 214 : wal_receiver_protocol,
354 214 : page_service_pipelining,
355 214 : } = config_toml;
356 :
357 214 : let mut conf = PageServerConf {
358 : // ------------------------------------------------------------
359 : // fields that are already fully validated by the ConfigToml Deserialize impl
360 : // ------------------------------------------------------------
361 214 : listen_pg_addr,
362 214 : listen_http_addr,
363 214 : availability_zone,
364 214 : wait_lsn_timeout,
365 214 : wal_redo_timeout,
366 214 : superuser,
367 214 : locale,
368 214 : page_cache_size,
369 214 : max_file_descriptors,
370 214 : http_auth_type,
371 214 : pg_auth_type,
372 214 : auth_validation_public_key_path,
373 214 : remote_storage_config: remote_storage,
374 214 : broker_endpoint,
375 214 : broker_keepalive_interval,
376 214 : log_format,
377 214 : metric_collection_interval,
378 214 : metric_collection_endpoint,
379 214 : metric_collection_bucket,
380 214 : synthetic_size_calculation_interval,
381 214 : disk_usage_based_eviction,
382 214 : test_remote_failures,
383 214 : ondemand_download_behavior_treat_error_as_warn,
384 214 : background_task_maximum_delay,
385 214 : control_plane_api,
386 214 : control_plane_emergency_mode,
387 214 : heatmap_upload_concurrency,
388 214 : secondary_download_concurrency,
389 214 : ingest_batch_size,
390 214 : max_vectored_read_bytes,
391 214 : image_compression,
392 214 : timeline_offloading,
393 214 : ephemeral_bytes_per_memory_kb,
394 214 : import_pgdata_upcall_api,
395 214 : import_pgdata_upcall_api_token: import_pgdata_upcall_api_token.map(SecretString::from),
396 214 : import_pgdata_aws_endpoint_url,
397 214 : wal_receiver_protocol,
398 214 : page_service_pipelining,
399 214 :
400 214 : // ------------------------------------------------------------
401 214 : // fields that require additional validation or custom handling
402 214 : // ------------------------------------------------------------
403 214 : workdir: workdir.to_owned(),
404 214 : pg_distrib_dir: pg_distrib_dir.unwrap_or_else(|| {
405 2 : std::env::current_dir()
406 2 : .expect("current_dir() failed")
407 2 : .try_into()
408 2 : .expect("current_dir() is not a valid Utf8Path")
409 214 : }),
410 214 : control_plane_api_token: control_plane_api_token.map(SecretString::from),
411 214 : id,
412 214 : default_tenant_conf: tenant_config,
413 214 : concurrent_tenant_warmup: ConfigurableSemaphore::new(concurrent_tenant_warmup),
414 214 : concurrent_tenant_size_logical_size_queries: ConfigurableSemaphore::new(
415 214 : concurrent_tenant_size_logical_size_queries,
416 214 : ),
417 214 : eviction_task_immitated_concurrent_logical_size_queries: ConfigurableSemaphore::new(
418 214 : // re-use `concurrent_tenant_size_logical_size_queries`
419 214 : concurrent_tenant_size_logical_size_queries,
420 214 : ),
421 214 : virtual_file_io_engine: match virtual_file_io_engine {
422 0 : Some(v) => v,
423 214 : None => match crate::virtual_file::io_engine_feature_test()
424 214 : .context("auto-detect virtual_file_io_engine")?
425 : {
426 214 : io_engine::FeatureTestResult::PlatformPreferred(v) => v, // make no noise
427 0 : io_engine::FeatureTestResult::Worse { engine, remark } => {
428 0 : // TODO: bubble this up to the caller so we can tracing::warn! it.
429 0 : eprintln!("auto-detected IO engine is not platform-preferred: engine={engine:?} remark={remark:?}");
430 0 : engine
431 : }
432 : },
433 : },
434 214 : l0_flush: l0_flush
435 214 : .map(crate::l0_flush::L0FlushConfig::from)
436 214 : .unwrap_or_default(),
437 214 : virtual_file_io_mode: virtual_file_io_mode.unwrap_or(virtual_file::IoMode::preferred()),
438 214 : no_sync: no_sync.unwrap_or(false),
439 214 : };
440 214 :
441 214 : // ------------------------------------------------------------
442 214 : // custom validation code that covers more than one field in isolation
443 214 : // ------------------------------------------------------------
444 214 :
445 214 : if conf.http_auth_type == AuthType::NeonJWT || conf.pg_auth_type == AuthType::NeonJWT {
446 0 : let auth_validation_public_key_path = conf
447 0 : .auth_validation_public_key_path
448 0 : .get_or_insert_with(|| workdir.join("auth_public_key.pem"));
449 0 : ensure!(
450 0 : auth_validation_public_key_path.exists(),
451 0 : format!(
452 0 : "Can't find auth_validation_public_key at '{auth_validation_public_key_path}'",
453 0 : )
454 : );
455 214 : }
456 :
457 214 : IndexEntry::validate_checkpoint_distance(conf.default_tenant_conf.checkpoint_distance)
458 214 : .map_err(anyhow::Error::msg)
459 214 : .with_context(|| {
460 0 : format!(
461 0 : "effective checkpoint distance is unsupported: {}",
462 0 : conf.default_tenant_conf.checkpoint_distance
463 0 : )
464 214 : })?;
465 :
466 214 : Ok(conf)
467 214 : }
468 :
469 : #[cfg(test)]
470 214 : pub fn test_repo_dir(test_name: &str) -> Utf8PathBuf {
471 214 : let test_output_dir = std::env::var("TEST_OUTPUT").unwrap_or("../tmp_check".into());
472 214 : Utf8PathBuf::from(format!("{test_output_dir}/test_{test_name}"))
473 214 : }
474 :
475 212 : pub fn dummy_conf(repo_dir: Utf8PathBuf) -> Self {
476 212 : let pg_distrib_dir = Utf8PathBuf::from(env!("CARGO_MANIFEST_DIR")).join("../pg_install");
477 212 :
478 212 : let config_toml = pageserver_api::config::ConfigToml {
479 212 : wait_lsn_timeout: Duration::from_secs(60),
480 212 : wal_redo_timeout: Duration::from_secs(60),
481 212 : pg_distrib_dir: Some(pg_distrib_dir),
482 212 : metric_collection_interval: Duration::from_secs(60),
483 212 : synthetic_size_calculation_interval: Duration::from_secs(60),
484 212 : background_task_maximum_delay: Duration::ZERO,
485 212 : ..Default::default()
486 212 : };
487 212 : PageServerConf::parse_and_validate(NodeId(0), config_toml, &repo_dir).unwrap()
488 212 : }
489 : }
490 :
491 0 : #[derive(serde::Deserialize, serde::Serialize)]
492 : #[serde(deny_unknown_fields)]
493 : pub struct PageserverIdentity {
494 : pub id: NodeId,
495 : }
496 :
497 : /// Configurable semaphore permits setting.
498 : ///
499 : /// Does not allow semaphore permits to be zero, because at runtime initially zero permits and empty
500 : /// semaphore cannot be distinguished, leading any feature using these to await forever (or until
501 : /// new permits are added).
502 : #[derive(Debug, Clone)]
503 : pub struct ConfigurableSemaphore {
504 : initial_permits: NonZeroUsize,
505 : inner: std::sync::Arc<tokio::sync::Semaphore>,
506 : }
507 :
508 : impl ConfigurableSemaphore {
509 : /// Initializse using a non-zero amount of permits.
510 : ///
511 : /// Require a non-zero initial permits, because using permits == 0 is a crude way to disable a
512 : /// feature such as [`Tenant::gather_size_inputs`]. Otherwise any semaphore using future will
513 : /// behave like [`futures::future::pending`], just waiting until new permits are added.
514 : ///
515 : /// [`Tenant::gather_size_inputs`]: crate::tenant::Tenant::gather_size_inputs
516 642 : pub fn new(initial_permits: NonZeroUsize) -> Self {
517 642 : ConfigurableSemaphore {
518 642 : initial_permits,
519 642 : inner: std::sync::Arc::new(tokio::sync::Semaphore::new(initial_permits.get())),
520 642 : }
521 642 : }
522 :
523 : /// Returns the configured amount of permits.
524 0 : pub fn initial_permits(&self) -> NonZeroUsize {
525 0 : self.initial_permits
526 0 : }
527 : }
528 :
529 : impl PartialEq for ConfigurableSemaphore {
530 0 : fn eq(&self, other: &Self) -> bool {
531 0 : // the number of permits can be increased at runtime, so we cannot really fulfill the
532 0 : // PartialEq value equality otherwise
533 0 : self.initial_permits == other.initial_permits
534 0 : }
535 : }
536 :
537 : impl Eq for ConfigurableSemaphore {}
538 :
539 : impl ConfigurableSemaphore {
540 0 : pub fn inner(&self) -> &std::sync::Arc<tokio::sync::Semaphore> {
541 0 : &self.inner
542 0 : }
543 : }
544 :
545 : #[cfg(test)]
546 : mod tests {
547 :
548 : use camino::Utf8PathBuf;
549 : use utils::id::NodeId;
550 :
551 : use super::PageServerConf;
552 :
553 : #[test]
554 2 : fn test_empty_config_toml_is_valid() {
555 2 : // we use Default impl of everything in this situation
556 2 : let input = r#"
557 2 : "#;
558 2 : let config_toml = toml_edit::de::from_str::<pageserver_api::config::ConfigToml>(input)
559 2 : .expect("empty config is valid");
560 2 : let workdir = Utf8PathBuf::from("/nonexistent");
561 2 : PageServerConf::parse_and_validate(NodeId(0), config_toml, &workdir)
562 2 : .expect("parse_and_validate");
563 2 : }
564 :
565 : /// If there's a typo in the pageserver config, we'd rather catch that typo
566 : /// and fail pageserver startup than silently ignoring the typo, leaving whoever
567 : /// made it in the believe that their config change is effective.
568 : ///
569 : /// The default in serde is to allow unknown fields, so, we rely
570 : /// on developer+review discipline to add `deny_unknown_fields` when adding
571 : /// new structs to the config, and these tests here as a regression test.
572 : ///
573 : /// The alternative to all of this would be to allow unknown fields in the config.
574 : /// To catch them, we could have a config check tool or mgmt API endpoint that
575 : /// compares the effective config with the TOML on disk and makes sure that
576 : /// the on-disk TOML is a strict subset of the effective config.
577 : mod unknown_fields_handling {
578 : macro_rules! test {
579 : ($short_name:ident, $input:expr) => {
580 : #[test]
581 10 : fn $short_name() {
582 10 : let input = $input;
583 10 : let err = toml_edit::de::from_str::<pageserver_api::config::ConfigToml>(&input)
584 10 : .expect_err("some_invalid_field is an invalid field");
585 10 : dbg!(&err);
586 10 : assert!(err.to_string().contains("some_invalid_field"));
587 10 : }
588 : };
589 : }
590 : use indoc::indoc;
591 :
592 : test!(
593 : toplevel,
594 : indoc! {r#"
595 : some_invalid_field = 23
596 : "#}
597 : );
598 :
599 : test!(
600 : toplevel_nested,
601 : indoc! {r#"
602 : [some_invalid_field]
603 : foo = 23
604 : "#}
605 : );
606 :
607 : test!(
608 : disk_usage_based_eviction,
609 : indoc! {r#"
610 : [disk_usage_based_eviction]
611 : some_invalid_field = 23
612 : "#}
613 : );
614 :
615 : test!(
616 : tenant_config,
617 : indoc! {r#"
618 : [tenant_config]
619 : some_invalid_field = 23
620 : "#}
621 : );
622 :
623 : test!(
624 : l0_flush,
625 : indoc! {r#"
626 : [l0_flush]
627 : mode = "direct"
628 : some_invalid_field = 23
629 : "#}
630 : );
631 :
632 : // TODO: fix this => https://github.com/neondatabase/neon/issues/8915
633 : // test!(
634 : // remote_storage_config,
635 : // indoc! {r#"
636 : // [remote_storage_config]
637 : // local_path = "/nonexistent"
638 : // some_invalid_field = 23
639 : // "#}
640 : // );
641 : }
642 : }
|
