//! This module is responsible for locating and loading paths in a local setup. //! //! Now it also provides init method which acts like a stub for proper installation //! script which will use local paths. use anyhow::{bail, Context}; use clap::ValueEnum; use postgres_backend::AuthType; use reqwest::Url; use serde::{Deserialize, Serialize}; use std::collections::HashMap; use std::env; use std::fs; use std::net::IpAddr; use std::net::Ipv4Addr; use std::net::SocketAddr; use std::path::{Path, PathBuf}; use std::process::{Command, Stdio}; use std::time::Duration; use utils::{ auth::{encode_from_key_file, Claims}, id::{NodeId, TenantId, TenantTimelineId, TimelineId}, }; use crate::pageserver::PageServerNode; use crate::pageserver::PAGESERVER_REMOTE_STORAGE_DIR; use crate::safekeeper::SafekeeperNode; pub const DEFAULT_PG_VERSION: u32 = 15; // // This data structures represents neon_local CLI config // // It is deserialized from the .neon/config file, or the config file passed // to 'neon_local init --config=' option. See control_plane/simple.conf for // an example. // #[derive(PartialEq, Eq, Clone, Debug)] pub struct LocalEnv { // Base directory for all the nodes (the pageserver, safekeepers and // compute endpoints). // // This is not stored in the config file. Rather, this is the path where the // config file itself is. It is read from the NEON_REPO_DIR env variable which // must be an absolute path. If the env var is not set, $PWD/.neon is used. pub base_data_dir: PathBuf, // Path to postgres distribution. It's expected that "bin", "include", // "lib", "share" from postgres distribution are there. If at some point // in time we will be able to run against vanilla postgres we may split that // to four separate paths and match OS-specific installation layout. pub pg_distrib_dir: PathBuf, // Path to pageserver binary. pub neon_distrib_dir: PathBuf, // Default tenant ID to use with the 'neon_local' command line utility, when // --tenant_id is not explicitly specified. pub default_tenant_id: Option, // used to issue tokens during e.g pg start pub private_key_path: PathBuf, pub broker: NeonBroker, // Configuration for the storage controller (1 per neon_local environment) pub storage_controller: NeonStorageControllerConf, /// This Vec must always contain at least one pageserver /// Populdated by [`Self::load_config`] from the individual `pageserver.toml`s. /// NB: not used anymore except for informing users that they need to change their `.neon/config`. pub pageservers: Vec, pub safekeepers: Vec, // Control plane upcall API for pageserver: if None, we will not run storage_controller If set, this will // be propagated into each pageserver's configuration. pub control_plane_api: Option, // Control plane upcall API for storage controller. If set, this will be propagated into the // storage controller's configuration. pub control_plane_compute_hook_api: Option, /// Keep human-readable aliases in memory (and persist them to config), to hide ZId hex strings from the user. // A `HashMap>` would be more appropriate here, // but deserialization into a generic toml object as `toml::Value::try_from` fails with an error. // https://toml.io/en/v1.0.0 does not contain a concept of "a table inside another table". pub branch_name_mappings: HashMap>, } /// On-disk state stored in `.neon/config`. #[derive(PartialEq, Eq, Clone, Debug, Default, Serialize, Deserialize)] #[serde(default, deny_unknown_fields)] pub struct OnDiskConfig { pub pg_distrib_dir: PathBuf, pub neon_distrib_dir: PathBuf, pub default_tenant_id: Option, pub private_key_path: PathBuf, pub broker: NeonBroker, pub storage_controller: NeonStorageControllerConf, #[serde( skip_serializing, deserialize_with = "fail_if_pageservers_field_specified" )] pub pageservers: Vec, pub safekeepers: Vec, pub control_plane_api: Option, pub control_plane_compute_hook_api: Option, branch_name_mappings: HashMap>, } fn fail_if_pageservers_field_specified<'de, D>(_: D) -> Result, D::Error> where D: serde::Deserializer<'de>, { Err(serde::de::Error::custom( "The 'pageservers' field is no longer used; pageserver.toml is now authoritative; \ Please remove the `pageservers` from your .neon/config.", )) } /// The description of the neon_local env to be initialized by `neon_local init --config`. #[derive(Clone, Debug, Deserialize)] #[serde(deny_unknown_fields)] pub struct NeonLocalInitConf { // TODO: do we need this? Seems unused pub pg_distrib_dir: Option, // TODO: do we need this? Seems unused pub neon_distrib_dir: Option, pub default_tenant_id: TenantId, pub broker: NeonBroker, pub storage_controller: Option, pub pageservers: Vec, pub safekeepers: Vec, pub control_plane_api: Option>, pub control_plane_compute_hook_api: Option>, } /// Broker config for cluster internal communication. #[derive(Serialize, Deserialize, PartialEq, Eq, Clone, Debug)] #[serde(default)] pub struct NeonBroker { /// Broker listen address for storage nodes coordination, e.g. '127.0.0.1:50051'. pub listen_addr: SocketAddr, } /// Broker config for cluster internal communication. #[derive(Serialize, Deserialize, PartialEq, Eq, Clone, Debug)] #[serde(default)] pub struct NeonStorageControllerConf { /// Heartbeat timeout before marking a node offline #[serde(with = "humantime_serde")] pub max_unavailable: Duration, /// Threshold for auto-splitting a tenant into shards pub split_threshold: Option, } impl NeonStorageControllerConf { // Use a shorter pageserver unavailability interval than the default to speed up tests. const DEFAULT_MAX_UNAVAILABLE_INTERVAL: std::time::Duration = std::time::Duration::from_secs(10); } impl Default for NeonStorageControllerConf { fn default() -> Self { Self { max_unavailable: Self::DEFAULT_MAX_UNAVAILABLE_INTERVAL, split_threshold: None, } } } // Dummy Default impl to satisfy Deserialize derive. impl Default for NeonBroker { fn default() -> Self { NeonBroker { listen_addr: SocketAddr::new(IpAddr::V4(Ipv4Addr::new(0, 0, 0, 0)), 0), } } } impl NeonBroker { pub fn client_url(&self) -> Url { Url::parse(&format!("http://{}", self.listen_addr)).expect("failed to construct url") } } // neon_local needs to know this subset of pageserver configuration. // For legacy reasons, this information is duplicated from `pageserver.toml` into `.neon/config`. // It can get stale if `pageserver.toml` is changed. // TODO(christian): don't store this at all in `.neon/config`, always load it from `pageserver.toml` #[derive(Serialize, Deserialize, PartialEq, Eq, Clone, Debug)] #[serde(default, deny_unknown_fields)] pub struct PageServerConf { pub id: NodeId, pub listen_pg_addr: String, pub listen_http_addr: String, pub pg_auth_type: AuthType, pub http_auth_type: AuthType, } impl Default for PageServerConf { fn default() -> Self { Self { id: NodeId(0), listen_pg_addr: String::new(), listen_http_addr: String::new(), pg_auth_type: AuthType::Trust, http_auth_type: AuthType::Trust, } } } /// The toml that can be passed to `neon_local init --config`. /// This is a subset of the `pageserver.toml` configuration. // TODO(christian): use pageserver_api::config::ConfigToml (PR #7656) #[derive(Clone, Debug, serde::Deserialize, serde::Serialize)] pub struct NeonLocalInitPageserverConf { pub id: NodeId, pub listen_pg_addr: String, pub listen_http_addr: String, pub pg_auth_type: AuthType, pub http_auth_type: AuthType, #[serde(flatten)] pub other: HashMap, } impl From<&NeonLocalInitPageserverConf> for PageServerConf { fn from(conf: &NeonLocalInitPageserverConf) -> Self { let NeonLocalInitPageserverConf { id, listen_pg_addr, listen_http_addr, pg_auth_type, http_auth_type, other: _, } = conf; Self { id: *id, listen_pg_addr: listen_pg_addr.clone(), listen_http_addr: listen_http_addr.clone(), pg_auth_type: *pg_auth_type, http_auth_type: *http_auth_type, } } } #[derive(Serialize, Deserialize, PartialEq, Eq, Clone, Debug)] #[serde(default)] pub struct SafekeeperConf { pub id: NodeId, pub pg_port: u16, pub pg_tenant_only_port: Option, pub http_port: u16, pub sync: bool, pub remote_storage: Option, pub backup_threads: Option, pub auth_enabled: bool, pub listen_addr: Option, } impl Default for SafekeeperConf { fn default() -> Self { Self { id: NodeId(0), pg_port: 0, pg_tenant_only_port: None, http_port: 0, sync: true, remote_storage: None, backup_threads: None, auth_enabled: false, listen_addr: None, } } } #[derive(Clone, Copy)] pub enum InitForceMode { MustNotExist, EmptyDirOk, RemoveAllContents, } impl ValueEnum for InitForceMode { fn value_variants<'a>() -> &'a [Self] { &[ Self::MustNotExist, Self::EmptyDirOk, Self::RemoveAllContents, ] } fn to_possible_value(&self) -> Option { Some(clap::builder::PossibleValue::new(match self { InitForceMode::MustNotExist => "must-not-exist", InitForceMode::EmptyDirOk => "empty-dir-ok", InitForceMode::RemoveAllContents => "remove-all-contents", })) } } impl SafekeeperConf { /// Compute is served by port on which only tenant scoped tokens allowed, if /// it is configured. pub fn get_compute_port(&self) -> u16 { self.pg_tenant_only_port.unwrap_or(self.pg_port) } } impl LocalEnv { pub fn pg_distrib_dir_raw(&self) -> PathBuf { self.pg_distrib_dir.clone() } pub fn pg_distrib_dir(&self, pg_version: u32) -> anyhow::Result { let path = self.pg_distrib_dir.clone(); #[allow(clippy::manual_range_patterns)] match pg_version { 14 | 15 | 16 => Ok(path.join(format!("v{pg_version}"))), _ => bail!("Unsupported postgres version: {}", pg_version), } } pub fn pg_dir(&self, pg_version: u32, dir_name: &str) -> anyhow::Result { Ok(self.pg_distrib_dir(pg_version)?.join(dir_name)) } pub fn pg_bin_dir(&self, pg_version: u32) -> anyhow::Result { self.pg_dir(pg_version, "bin") } pub fn pg_lib_dir(&self, pg_version: u32) -> anyhow::Result { self.pg_dir(pg_version, "lib") } pub fn pageserver_bin(&self) -> PathBuf { self.neon_distrib_dir.join("pageserver") } pub fn storage_controller_bin(&self) -> PathBuf { // Irrespective of configuration, storage controller binary is always // run from the same location as neon_local. This means that for compatibility // tests that run old pageserver/safekeeper, they still run latest storage controller. let neon_local_bin_dir = env::current_exe().unwrap().parent().unwrap().to_owned(); neon_local_bin_dir.join("storage_controller") } pub fn safekeeper_bin(&self) -> PathBuf { self.neon_distrib_dir.join("safekeeper") } pub fn storage_broker_bin(&self) -> PathBuf { self.neon_distrib_dir.join("storage_broker") } pub fn endpoints_path(&self) -> PathBuf { self.base_data_dir.join("endpoints") } pub fn pageserver_data_dir(&self, pageserver_id: NodeId) -> PathBuf { self.base_data_dir .join(format!("pageserver_{pageserver_id}")) } pub fn safekeeper_data_dir(&self, data_dir_name: &str) -> PathBuf { self.base_data_dir.join("safekeepers").join(data_dir_name) } pub fn get_pageserver_conf(&self, id: NodeId) -> anyhow::Result<&PageServerConf> { if let Some(conf) = self.pageservers.iter().find(|node| node.id == id) { Ok(conf) } else { let have_ids = self .pageservers .iter() .map(|node| format!("{}:{}", node.id, node.listen_http_addr)) .collect::>(); let joined = have_ids.join(","); bail!("could not find pageserver {id}, have ids {joined}") } } pub fn register_branch_mapping( &mut self, branch_name: String, tenant_id: TenantId, timeline_id: TimelineId, ) -> anyhow::Result<()> { let existing_values = self .branch_name_mappings .entry(branch_name.clone()) .or_default(); let existing_ids = existing_values .iter() .find(|(existing_tenant_id, _)| existing_tenant_id == &tenant_id); if let Some((_, old_timeline_id)) = existing_ids { if old_timeline_id == &timeline_id { Ok(()) } else { bail!("branch '{branch_name}' is already mapped to timeline {old_timeline_id}, cannot map to another timeline {timeline_id}"); } } else { existing_values.push((tenant_id, timeline_id)); Ok(()) } } pub fn get_branch_timeline_id( &self, branch_name: &str, tenant_id: TenantId, ) -> Option { self.branch_name_mappings .get(branch_name)? .iter() .find(|(mapped_tenant_id, _)| mapped_tenant_id == &tenant_id) .map(|&(_, timeline_id)| timeline_id) .map(TimelineId::from) } pub fn timeline_name_mappings(&self) -> HashMap { self.branch_name_mappings .iter() .flat_map(|(name, tenant_timelines)| { tenant_timelines.iter().map(|&(tenant_id, timeline_id)| { (TenantTimelineId::new(tenant_id, timeline_id), name.clone()) }) }) .collect() } /// Construct `Self` from on-disk state. pub fn load_config(repopath: &Path) -> anyhow::Result { if !repopath.exists() { bail!( "Neon config is not found in {}. You need to run 'neon_local init' first", repopath.to_str().unwrap() ); } // TODO: check that it looks like a neon repository // load and parse file let config_file_contents = fs::read_to_string(repopath.join("config"))?; let on_disk_config: OnDiskConfig = toml::from_str(config_file_contents.as_str())?; let mut env = { let OnDiskConfig { pg_distrib_dir, neon_distrib_dir, default_tenant_id, private_key_path, broker, storage_controller, pageservers, safekeepers, control_plane_api, control_plane_compute_hook_api, branch_name_mappings, } = on_disk_config; LocalEnv { base_data_dir: repopath.to_owned(), pg_distrib_dir, neon_distrib_dir, default_tenant_id, private_key_path, broker, storage_controller, pageservers, safekeepers, control_plane_api, control_plane_compute_hook_api, branch_name_mappings, } }; // The source of truth for pageserver configuration is the pageserver.toml. assert!( env.pageservers.is_empty(), "we ensure this during deserialization" ); env.pageservers = { let iter = std::fs::read_dir(repopath).context("open dir")?; let mut pageservers = Vec::new(); for res in iter { let dentry = res?; const PREFIX: &str = "pageserver_"; let dentry_name = dentry .file_name() .into_string() .ok() .with_context(|| format!("non-utf8 dentry: {:?}", dentry.path())) .unwrap(); if !dentry_name.starts_with(PREFIX) { continue; } if !dentry.file_type().context("determine file type")?.is_dir() { anyhow::bail!("expected a directory, got {:?}", dentry.path()); } let id = dentry_name[PREFIX.len()..] .parse::() .with_context(|| format!("parse id from {:?}", dentry.path()))?; // TODO(christian): use pageserver_api::config::ConfigToml (PR #7656) #[derive(serde::Serialize, serde::Deserialize)] // (allow unknown fields, unlike PageServerConf) struct PageserverConfigTomlSubset { id: NodeId, listen_pg_addr: String, listen_http_addr: String, pg_auth_type: AuthType, http_auth_type: AuthType, } let config_toml_path = dentry.path().join("pageserver.toml"); let config_toml: PageserverConfigTomlSubset = toml_edit::de::from_str( &std::fs::read_to_string(&config_toml_path) .with_context(|| format!("read {:?}", config_toml_path))?, ) .context("parse pageserver.toml")?; let PageserverConfigTomlSubset { id: config_toml_id, listen_pg_addr, listen_http_addr, pg_auth_type, http_auth_type, } = config_toml; let conf = PageServerConf { id: { anyhow::ensure!( config_toml_id == id, "id mismatch: config_toml.id={config_toml_id} id={id}", ); id }, listen_pg_addr, listen_http_addr, pg_auth_type, http_auth_type, }; pageservers.push(conf); } pageservers }; Ok(env) } pub fn persist_config(&self) -> anyhow::Result<()> { Self::persist_config_impl( &self.base_data_dir, &OnDiskConfig { pg_distrib_dir: self.pg_distrib_dir.clone(), neon_distrib_dir: self.neon_distrib_dir.clone(), default_tenant_id: self.default_tenant_id, private_key_path: self.private_key_path.clone(), broker: self.broker.clone(), storage_controller: self.storage_controller.clone(), pageservers: vec![], // it's skip_serializing anyway safekeepers: self.safekeepers.clone(), control_plane_api: self.control_plane_api.clone(), control_plane_compute_hook_api: self.control_plane_compute_hook_api.clone(), branch_name_mappings: self.branch_name_mappings.clone(), }, ) } pub fn persist_config_impl(base_path: &Path, config: &OnDiskConfig) -> anyhow::Result<()> { let conf_content = &toml::to_string_pretty(config)?; let target_config_path = base_path.join("config"); fs::write(&target_config_path, conf_content).with_context(|| { format!( "Failed to write config file into path '{}'", target_config_path.display() ) }) } // this function is used only for testing purposes in CLI e g generate tokens during init pub fn generate_auth_token(&self, claims: &Claims) -> anyhow::Result { let private_key_path = self.get_private_key_path(); let key_data = fs::read(private_key_path)?; encode_from_key_file(claims, &key_data) } pub fn get_private_key_path(&self) -> PathBuf { if self.private_key_path.is_absolute() { self.private_key_path.to_path_buf() } else { self.base_data_dir.join(&self.private_key_path) } } /// Materialize the [`NeonLocalInitConf`] to disk. Called during [`neon_local init`]. pub fn init(conf: NeonLocalInitConf, force: &InitForceMode) -> anyhow::Result<()> { let base_path = base_path(); assert_ne!(base_path, Path::new("")); let base_path = &base_path; // create base_path dir if base_path.exists() { match force { InitForceMode::MustNotExist => { bail!( "directory '{}' already exists. Perhaps already initialized?", base_path.display() ); } InitForceMode::EmptyDirOk => { if let Some(res) = std::fs::read_dir(base_path)?.next() { res.context("check if directory is empty")?; anyhow::bail!("directory not empty: {base_path:?}"); } } InitForceMode::RemoveAllContents => { println!("removing all contents of '{}'", base_path.display()); // instead of directly calling `remove_dir_all`, we keep the original dir but removing // all contents inside. This helps if the developer symbol links another directory (i.e., // S3 local SSD) to the `.neon` base directory. for entry in std::fs::read_dir(base_path)? { let entry = entry?; let path = entry.path(); if path.is_dir() { fs::remove_dir_all(&path)?; } else { fs::remove_file(&path)?; } } } } } if !base_path.exists() { fs::create_dir(base_path)?; } let NeonLocalInitConf { pg_distrib_dir, neon_distrib_dir, default_tenant_id, broker, storage_controller, pageservers, safekeepers, control_plane_api, control_plane_compute_hook_api, } = conf; // Find postgres binaries. // Follow POSTGRES_DISTRIB_DIR if set, otherwise look in "pg_install". // Note that later in the code we assume, that distrib dirs follow the same pattern // for all postgres versions. let pg_distrib_dir = pg_distrib_dir.unwrap_or_else(|| { if let Some(postgres_bin) = env::var_os("POSTGRES_DISTRIB_DIR") { postgres_bin.into() } else { let cwd = env::current_dir().unwrap(); cwd.join("pg_install") } }); // Find neon binaries. let neon_distrib_dir = neon_distrib_dir .unwrap_or_else(|| env::current_exe().unwrap().parent().unwrap().to_owned()); // Generate keypair for JWT. // // The keypair is only needed if authentication is enabled in any of the // components. For convenience, we generate the keypair even if authentication // is not enabled, so that you can easily enable it after the initialization // step. generate_auth_keys( base_path.join("auth_private_key.pem").as_path(), base_path.join("auth_public_key.pem").as_path(), ) .context("generate auth keys")?; let private_key_path = PathBuf::from("auth_private_key.pem"); // create the runtime type because the remaining initialization code below needs // a LocalEnv instance op operation // TODO: refactor to avoid this, LocalEnv should only be constructed from on-disk state let env = LocalEnv { base_data_dir: base_path.clone(), pg_distrib_dir, neon_distrib_dir, default_tenant_id: Some(default_tenant_id), private_key_path, broker, storage_controller: storage_controller.unwrap_or_default(), pageservers: pageservers.iter().map(Into::into).collect(), safekeepers, control_plane_api: control_plane_api.unwrap_or_default(), control_plane_compute_hook_api: control_plane_compute_hook_api.unwrap_or_default(), branch_name_mappings: Default::default(), }; // create endpoints dir fs::create_dir_all(env.endpoints_path())?; // create safekeeper dirs for safekeeper in &env.safekeepers { fs::create_dir_all(SafekeeperNode::datadir_path_by_id(&env, safekeeper.id))?; } // initialize pageserver state for (i, ps) in pageservers.into_iter().enumerate() { let runtime_ps = &env.pageservers[i]; assert_eq!(&PageServerConf::from(&ps), runtime_ps); fs::create_dir(env.pageserver_data_dir(ps.id))?; PageServerNode::from_env(&env, runtime_ps) .initialize(ps) .context("pageserver init failed")?; } // setup remote remote location for default LocalFs remote storage std::fs::create_dir_all(env.base_data_dir.join(PAGESERVER_REMOTE_STORAGE_DIR))?; env.persist_config() } } pub fn base_path() -> PathBuf { let path = match std::env::var_os("NEON_REPO_DIR") { Some(val) => { let path = PathBuf::from(val); if !path.is_absolute() { // repeat the env var in the error because our default is always absolute panic!("NEON_REPO_DIR must be an absolute path, got {path:?}"); } path } None => { let pwd = std::env::current_dir() // technically this can fail but it's quite unlikeley .expect("determine current directory"); let pwd_abs = pwd.canonicalize().expect("canonicalize current directory"); pwd_abs.join(".neon") } }; assert!(path.is_absolute()); path } /// Generate a public/private key pair for JWT authentication fn generate_auth_keys(private_key_path: &Path, public_key_path: &Path) -> anyhow::Result<()> { // Generate the key pair // // openssl genpkey -algorithm ed25519 -out auth_private_key.pem let keygen_output = Command::new("openssl") .arg("genpkey") .args(["-algorithm", "ed25519"]) .args(["-out", private_key_path.to_str().unwrap()]) .stdout(Stdio::null()) .output() .context("failed to generate auth private key")?; if !keygen_output.status.success() { bail!( "openssl failed: '{}'", String::from_utf8_lossy(&keygen_output.stderr) ); } // Extract the public key from the private key file // // openssl pkey -in auth_private_key.pem -pubout -out auth_public_key.pem let keygen_output = Command::new("openssl") .arg("pkey") .args(["-in", private_key_path.to_str().unwrap()]) .arg("-pubout") .args(["-out", public_key_path.to_str().unwrap()]) .output() .context("failed to extract public key from private key")?; if !keygen_output.status.success() { bail!( "openssl failed: '{}'", String::from_utf8_lossy(&keygen_output.stderr) ); } Ok(()) }