Line data Source code
1 : //! This module is responsible for locating and loading paths in a local setup.
2 : //!
3 : //! Now it also provides init method which acts like a stub for proper installation
4 : //! script which will use local paths.
5 :
6 : use anyhow::{bail, Context};
7 :
8 : use clap::ValueEnum;
9 : use postgres_backend::AuthType;
10 : use reqwest::Url;
11 : use serde::{Deserialize, Serialize};
12 : use std::collections::HashMap;
13 : use std::env;
14 : use std::fs;
15 : use std::net::IpAddr;
16 : use std::net::Ipv4Addr;
17 : use std::net::SocketAddr;
18 : use std::path::{Path, PathBuf};
19 : use std::process::{Command, Stdio};
20 : use std::time::Duration;
21 : use utils::{
22 : auth::{encode_from_key_file, Claims},
23 : id::{NodeId, TenantId, TenantTimelineId, TimelineId},
24 : };
25 :
26 : use crate::pageserver::PageServerNode;
27 : use crate::pageserver::PAGESERVER_REMOTE_STORAGE_DIR;
28 : use crate::safekeeper::SafekeeperNode;
29 :
30 : pub const DEFAULT_PG_VERSION: u32 = 16;
31 :
32 : //
33 : // This data structures represents neon_local CLI config
34 : //
35 : // It is deserialized from the .neon/config file, or the config file passed
36 : // to 'neon_local init --config=<path>' option. See control_plane/simple.conf for
37 : // an example.
38 : //
39 : #[derive(PartialEq, Eq, Clone, Debug)]
40 : pub struct LocalEnv {
41 : // Base directory for all the nodes (the pageserver, safekeepers and
42 : // compute endpoints).
43 : //
44 : // This is not stored in the config file. Rather, this is the path where the
45 : // config file itself is. It is read from the NEON_REPO_DIR env variable which
46 : // must be an absolute path. If the env var is not set, $PWD/.neon is used.
47 : pub base_data_dir: PathBuf,
48 :
49 : // Path to postgres distribution. It's expected that "bin", "include",
50 : // "lib", "share" from postgres distribution are there. If at some point
51 : // in time we will be able to run against vanilla postgres we may split that
52 : // to four separate paths and match OS-specific installation layout.
53 : pub pg_distrib_dir: PathBuf,
54 :
55 : // Path to pageserver binary.
56 : pub neon_distrib_dir: PathBuf,
57 :
58 : // Default tenant ID to use with the 'neon_local' command line utility, when
59 : // --tenant_id is not explicitly specified.
60 : pub default_tenant_id: Option<TenantId>,
61 :
62 : // used to issue tokens during e.g pg start
63 : pub private_key_path: PathBuf,
64 :
65 : pub broker: NeonBroker,
66 :
67 : // Configuration for the storage controller (1 per neon_local environment)
68 : pub storage_controller: NeonStorageControllerConf,
69 :
70 : /// This Vec must always contain at least one pageserver
71 : /// Populdated by [`Self::load_config`] from the individual `pageserver.toml`s.
72 : /// NB: not used anymore except for informing users that they need to change their `.neon/config`.
73 : pub pageservers: Vec<PageServerConf>,
74 :
75 : pub safekeepers: Vec<SafekeeperConf>,
76 :
77 : // Control plane upcall API for pageserver: if None, we will not run storage_controller If set, this will
78 : // be propagated into each pageserver's configuration.
79 : pub control_plane_api: Url,
80 :
81 : // Control plane upcall API for storage controller. If set, this will be propagated into the
82 : // storage controller's configuration.
83 : pub control_plane_compute_hook_api: Option<Url>,
84 :
85 : /// Keep human-readable aliases in memory (and persist them to config), to hide ZId hex strings from the user.
86 : // A `HashMap<String, HashMap<TenantId, TimelineId>>` would be more appropriate here,
87 : // but deserialization into a generic toml object as `toml::Value::try_from` fails with an error.
88 : // https://toml.io/en/v1.0.0 does not contain a concept of "a table inside another table".
89 : pub branch_name_mappings: HashMap<String, Vec<(TenantId, TimelineId)>>,
90 : }
91 :
92 : /// On-disk state stored in `.neon/config`.
93 0 : #[derive(PartialEq, Eq, Clone, Debug, Default, Serialize, Deserialize)]
94 : #[serde(default, deny_unknown_fields)]
95 : pub struct OnDiskConfig {
96 : pub pg_distrib_dir: PathBuf,
97 : pub neon_distrib_dir: PathBuf,
98 : pub default_tenant_id: Option<TenantId>,
99 : pub private_key_path: PathBuf,
100 : pub broker: NeonBroker,
101 : pub storage_controller: NeonStorageControllerConf,
102 : #[serde(
103 : skip_serializing,
104 : deserialize_with = "fail_if_pageservers_field_specified"
105 : )]
106 : pub pageservers: Vec<PageServerConf>,
107 : pub safekeepers: Vec<SafekeeperConf>,
108 : pub control_plane_api: Option<Url>,
109 : pub control_plane_compute_hook_api: Option<Url>,
110 : branch_name_mappings: HashMap<String, Vec<(TenantId, TimelineId)>>,
111 : }
112 :
113 0 : fn fail_if_pageservers_field_specified<'de, D>(_: D) -> Result<Vec<PageServerConf>, D::Error>
114 0 : where
115 0 : D: serde::Deserializer<'de>,
116 0 : {
117 0 : Err(serde::de::Error::custom(
118 0 : "The 'pageservers' field is no longer used; pageserver.toml is now authoritative; \
119 0 : Please remove the `pageservers` from your .neon/config.",
120 0 : ))
121 0 : }
122 :
123 : /// The description of the neon_local env to be initialized by `neon_local init --config`.
124 0 : #[derive(Clone, Debug, Deserialize)]
125 : #[serde(deny_unknown_fields)]
126 : pub struct NeonLocalInitConf {
127 : // TODO: do we need this? Seems unused
128 : pub pg_distrib_dir: Option<PathBuf>,
129 : // TODO: do we need this? Seems unused
130 : pub neon_distrib_dir: Option<PathBuf>,
131 : pub default_tenant_id: TenantId,
132 : pub broker: NeonBroker,
133 : pub storage_controller: Option<NeonStorageControllerConf>,
134 : pub pageservers: Vec<NeonLocalInitPageserverConf>,
135 : pub safekeepers: Vec<SafekeeperConf>,
136 : pub control_plane_api: Option<Url>,
137 : pub control_plane_compute_hook_api: Option<Option<Url>>,
138 : }
139 :
140 : /// Broker config for cluster internal communication.
141 0 : #[derive(Serialize, Deserialize, PartialEq, Eq, Clone, Debug)]
142 : #[serde(default)]
143 : pub struct NeonBroker {
144 : /// Broker listen address for storage nodes coordination, e.g. '127.0.0.1:50051'.
145 : pub listen_addr: SocketAddr,
146 : }
147 :
148 : /// Broker config for cluster internal communication.
149 0 : #[derive(Serialize, Deserialize, PartialEq, Eq, Clone, Debug)]
150 : #[serde(default)]
151 : pub struct NeonStorageControllerConf {
152 : /// Heartbeat timeout before marking a node offline
153 : #[serde(with = "humantime_serde")]
154 : pub max_offline: Duration,
155 :
156 : #[serde(with = "humantime_serde")]
157 : pub max_warming_up: Duration,
158 :
159 : pub start_as_candidate: bool,
160 :
161 : /// Database url used when running multiple storage controller instances
162 : pub database_url: Option<SocketAddr>,
163 :
164 : /// Threshold for auto-splitting a tenant into shards
165 : pub split_threshold: Option<u64>,
166 :
167 : pub max_secondary_lag_bytes: Option<u64>,
168 :
169 : #[serde(with = "humantime_serde")]
170 : pub heartbeat_interval: Duration,
171 :
172 : #[serde(with = "humantime_serde")]
173 : pub long_reconcile_threshold: Option<Duration>,
174 : }
175 :
176 : impl NeonStorageControllerConf {
177 : // Use a shorter pageserver unavailability interval than the default to speed up tests.
178 : const DEFAULT_MAX_OFFLINE_INTERVAL: std::time::Duration = std::time::Duration::from_secs(10);
179 :
180 : const DEFAULT_MAX_WARMING_UP_INTERVAL: std::time::Duration = std::time::Duration::from_secs(30);
181 :
182 : // Very tight heartbeat interval to speed up tests
183 : const DEFAULT_HEARTBEAT_INTERVAL: std::time::Duration = std::time::Duration::from_millis(1000);
184 : }
185 :
186 : impl Default for NeonStorageControllerConf {
187 0 : fn default() -> Self {
188 0 : Self {
189 0 : max_offline: Self::DEFAULT_MAX_OFFLINE_INTERVAL,
190 0 : max_warming_up: Self::DEFAULT_MAX_WARMING_UP_INTERVAL,
191 0 : start_as_candidate: false,
192 0 : database_url: None,
193 0 : split_threshold: None,
194 0 : max_secondary_lag_bytes: None,
195 0 : heartbeat_interval: Self::DEFAULT_HEARTBEAT_INTERVAL,
196 0 : long_reconcile_threshold: None,
197 0 : }
198 0 : }
199 : }
200 :
201 : // Dummy Default impl to satisfy Deserialize derive.
202 : impl Default for NeonBroker {
203 0 : fn default() -> Self {
204 0 : NeonBroker {
205 0 : listen_addr: SocketAddr::new(IpAddr::V4(Ipv4Addr::new(0, 0, 0, 0)), 0),
206 0 : }
207 0 : }
208 : }
209 :
210 : impl NeonBroker {
211 0 : pub fn client_url(&self) -> Url {
212 0 : Url::parse(&format!("http://{}", self.listen_addr)).expect("failed to construct url")
213 0 : }
214 : }
215 :
216 : // neon_local needs to know this subset of pageserver configuration.
217 : // For legacy reasons, this information is duplicated from `pageserver.toml` into `.neon/config`.
218 : // It can get stale if `pageserver.toml` is changed.
219 : // TODO(christian): don't store this at all in `.neon/config`, always load it from `pageserver.toml`
220 0 : #[derive(Serialize, Deserialize, PartialEq, Eq, Clone, Debug)]
221 : #[serde(default, deny_unknown_fields)]
222 : pub struct PageServerConf {
223 : pub id: NodeId,
224 : pub listen_pg_addr: String,
225 : pub listen_http_addr: String,
226 : pub pg_auth_type: AuthType,
227 : pub http_auth_type: AuthType,
228 : pub no_sync: bool,
229 : }
230 :
231 : impl Default for PageServerConf {
232 0 : fn default() -> Self {
233 0 : Self {
234 0 : id: NodeId(0),
235 0 : listen_pg_addr: String::new(),
236 0 : listen_http_addr: String::new(),
237 0 : pg_auth_type: AuthType::Trust,
238 0 : http_auth_type: AuthType::Trust,
239 0 : no_sync: false,
240 0 : }
241 0 : }
242 : }
243 :
244 : /// The toml that can be passed to `neon_local init --config`.
245 : /// This is a subset of the `pageserver.toml` configuration.
246 : // TODO(christian): use pageserver_api::config::ConfigToml (PR #7656)
247 0 : #[derive(Clone, Debug, serde::Deserialize, serde::Serialize)]
248 : pub struct NeonLocalInitPageserverConf {
249 : pub id: NodeId,
250 : pub listen_pg_addr: String,
251 : pub listen_http_addr: String,
252 : pub pg_auth_type: AuthType,
253 : pub http_auth_type: AuthType,
254 : #[serde(default, skip_serializing_if = "std::ops::Not::not")]
255 : pub no_sync: bool,
256 : #[serde(flatten)]
257 : pub other: HashMap<String, toml::Value>,
258 : }
259 :
260 : impl From<&NeonLocalInitPageserverConf> for PageServerConf {
261 0 : fn from(conf: &NeonLocalInitPageserverConf) -> Self {
262 0 : let NeonLocalInitPageserverConf {
263 0 : id,
264 0 : listen_pg_addr,
265 0 : listen_http_addr,
266 0 : pg_auth_type,
267 0 : http_auth_type,
268 0 : no_sync,
269 0 : other: _,
270 0 : } = conf;
271 0 : Self {
272 0 : id: *id,
273 0 : listen_pg_addr: listen_pg_addr.clone(),
274 0 : listen_http_addr: listen_http_addr.clone(),
275 0 : pg_auth_type: *pg_auth_type,
276 0 : http_auth_type: *http_auth_type,
277 0 : no_sync: *no_sync,
278 0 : }
279 0 : }
280 : }
281 :
282 0 : #[derive(Serialize, Deserialize, PartialEq, Eq, Clone, Debug)]
283 : #[serde(default)]
284 : pub struct SafekeeperConf {
285 : pub id: NodeId,
286 : pub pg_port: u16,
287 : pub pg_tenant_only_port: Option<u16>,
288 : pub http_port: u16,
289 : pub sync: bool,
290 : pub remote_storage: Option<String>,
291 : pub backup_threads: Option<u32>,
292 : pub auth_enabled: bool,
293 : pub listen_addr: Option<String>,
294 : }
295 :
296 : impl Default for SafekeeperConf {
297 0 : fn default() -> Self {
298 0 : Self {
299 0 : id: NodeId(0),
300 0 : pg_port: 0,
301 0 : pg_tenant_only_port: None,
302 0 : http_port: 0,
303 0 : sync: true,
304 0 : remote_storage: None,
305 0 : backup_threads: None,
306 0 : auth_enabled: false,
307 0 : listen_addr: None,
308 0 : }
309 0 : }
310 : }
311 :
312 : #[derive(Clone, Copy)]
313 : pub enum InitForceMode {
314 : MustNotExist,
315 : EmptyDirOk,
316 : RemoveAllContents,
317 : }
318 :
319 : impl ValueEnum for InitForceMode {
320 0 : fn value_variants<'a>() -> &'a [Self] {
321 0 : &[
322 0 : Self::MustNotExist,
323 0 : Self::EmptyDirOk,
324 0 : Self::RemoveAllContents,
325 0 : ]
326 0 : }
327 :
328 0 : fn to_possible_value(&self) -> Option<clap::builder::PossibleValue> {
329 0 : Some(clap::builder::PossibleValue::new(match self {
330 0 : InitForceMode::MustNotExist => "must-not-exist",
331 0 : InitForceMode::EmptyDirOk => "empty-dir-ok",
332 0 : InitForceMode::RemoveAllContents => "remove-all-contents",
333 : }))
334 0 : }
335 : }
336 :
337 : impl SafekeeperConf {
338 : /// Compute is served by port on which only tenant scoped tokens allowed, if
339 : /// it is configured.
340 0 : pub fn get_compute_port(&self) -> u16 {
341 0 : self.pg_tenant_only_port.unwrap_or(self.pg_port)
342 0 : }
343 : }
344 :
345 : impl LocalEnv {
346 0 : pub fn pg_distrib_dir_raw(&self) -> PathBuf {
347 0 : self.pg_distrib_dir.clone()
348 0 : }
349 :
350 0 : pub fn pg_distrib_dir(&self, pg_version: u32) -> anyhow::Result<PathBuf> {
351 0 : let path = self.pg_distrib_dir.clone();
352 0 :
353 0 : #[allow(clippy::manual_range_patterns)]
354 0 : match pg_version {
355 0 : 14 | 15 | 16 | 17 => Ok(path.join(format!("v{pg_version}"))),
356 0 : _ => bail!("Unsupported postgres version: {}", pg_version),
357 : }
358 0 : }
359 :
360 0 : pub fn pg_dir(&self, pg_version: u32, dir_name: &str) -> anyhow::Result<PathBuf> {
361 0 : Ok(self.pg_distrib_dir(pg_version)?.join(dir_name))
362 0 : }
363 :
364 0 : pub fn pg_bin_dir(&self, pg_version: u32) -> anyhow::Result<PathBuf> {
365 0 : self.pg_dir(pg_version, "bin")
366 0 : }
367 :
368 0 : pub fn pg_lib_dir(&self, pg_version: u32) -> anyhow::Result<PathBuf> {
369 0 : self.pg_dir(pg_version, "lib")
370 0 : }
371 :
372 0 : pub fn pageserver_bin(&self) -> PathBuf {
373 0 : self.neon_distrib_dir.join("pageserver")
374 0 : }
375 :
376 0 : pub fn storage_controller_bin(&self) -> PathBuf {
377 0 : // Irrespective of configuration, storage controller binary is always
378 0 : // run from the same location as neon_local. This means that for compatibility
379 0 : // tests that run old pageserver/safekeeper, they still run latest storage controller.
380 0 : let neon_local_bin_dir = env::current_exe().unwrap().parent().unwrap().to_owned();
381 0 : neon_local_bin_dir.join("storage_controller")
382 0 : }
383 :
384 0 : pub fn safekeeper_bin(&self) -> PathBuf {
385 0 : self.neon_distrib_dir.join("safekeeper")
386 0 : }
387 :
388 0 : pub fn storage_broker_bin(&self) -> PathBuf {
389 0 : self.neon_distrib_dir.join("storage_broker")
390 0 : }
391 :
392 0 : pub fn endpoints_path(&self) -> PathBuf {
393 0 : self.base_data_dir.join("endpoints")
394 0 : }
395 :
396 0 : pub fn pageserver_data_dir(&self, pageserver_id: NodeId) -> PathBuf {
397 0 : self.base_data_dir
398 0 : .join(format!("pageserver_{pageserver_id}"))
399 0 : }
400 :
401 0 : pub fn safekeeper_data_dir(&self, data_dir_name: &str) -> PathBuf {
402 0 : self.base_data_dir.join("safekeepers").join(data_dir_name)
403 0 : }
404 :
405 0 : pub fn get_pageserver_conf(&self, id: NodeId) -> anyhow::Result<&PageServerConf> {
406 0 : if let Some(conf) = self.pageservers.iter().find(|node| node.id == id) {
407 0 : Ok(conf)
408 : } else {
409 0 : let have_ids = self
410 0 : .pageservers
411 0 : .iter()
412 0 : .map(|node| format!("{}:{}", node.id, node.listen_http_addr))
413 0 : .collect::<Vec<_>>();
414 0 : let joined = have_ids.join(",");
415 0 : bail!("could not find pageserver {id}, have ids {joined}")
416 : }
417 0 : }
418 :
419 : /// Inspect the base data directory and extract the instance id and instance directory path
420 : /// for all storage controller instances
421 0 : pub async fn storage_controller_instances(&self) -> std::io::Result<Vec<(u8, PathBuf)>> {
422 0 : let mut instances = Vec::default();
423 :
424 0 : let dir = std::fs::read_dir(self.base_data_dir.clone())?;
425 0 : for dentry in dir {
426 0 : let dentry = dentry?;
427 0 : let is_dir = dentry.metadata()?.is_dir();
428 0 : let filename = dentry.file_name().into_string().unwrap();
429 0 : let parsed_instance_id = match filename.strip_prefix("storage_controller_") {
430 0 : Some(suffix) => suffix.parse::<u8>().ok(),
431 0 : None => None,
432 : };
433 :
434 0 : let is_instance_dir = is_dir && parsed_instance_id.is_some();
435 :
436 0 : if !is_instance_dir {
437 0 : continue;
438 0 : }
439 0 :
440 0 : instances.push((
441 0 : parsed_instance_id.expect("Checked previously"),
442 0 : dentry.path(),
443 0 : ));
444 : }
445 :
446 0 : Ok(instances)
447 0 : }
448 :
449 0 : pub fn register_branch_mapping(
450 0 : &mut self,
451 0 : branch_name: String,
452 0 : tenant_id: TenantId,
453 0 : timeline_id: TimelineId,
454 0 : ) -> anyhow::Result<()> {
455 0 : let existing_values = self
456 0 : .branch_name_mappings
457 0 : .entry(branch_name.clone())
458 0 : .or_default();
459 0 :
460 0 : let existing_ids = existing_values
461 0 : .iter()
462 0 : .find(|(existing_tenant_id, _)| existing_tenant_id == &tenant_id);
463 :
464 0 : if let Some((_, old_timeline_id)) = existing_ids {
465 0 : if old_timeline_id == &timeline_id {
466 0 : Ok(())
467 : } else {
468 0 : bail!("branch '{branch_name}' is already mapped to timeline {old_timeline_id}, cannot map to another timeline {timeline_id}");
469 : }
470 : } else {
471 0 : existing_values.push((tenant_id, timeline_id));
472 0 : Ok(())
473 : }
474 0 : }
475 :
476 0 : pub fn get_branch_timeline_id(
477 0 : &self,
478 0 : branch_name: &str,
479 0 : tenant_id: TenantId,
480 0 : ) -> Option<TimelineId> {
481 0 : self.branch_name_mappings
482 0 : .get(branch_name)?
483 0 : .iter()
484 0 : .find(|(mapped_tenant_id, _)| mapped_tenant_id == &tenant_id)
485 0 : .map(|&(_, timeline_id)| timeline_id)
486 0 : }
487 :
488 0 : pub fn timeline_name_mappings(&self) -> HashMap<TenantTimelineId, String> {
489 0 : self.branch_name_mappings
490 0 : .iter()
491 0 : .flat_map(|(name, tenant_timelines)| {
492 0 : tenant_timelines.iter().map(|&(tenant_id, timeline_id)| {
493 0 : (TenantTimelineId::new(tenant_id, timeline_id), name.clone())
494 0 : })
495 0 : })
496 0 : .collect()
497 0 : }
498 :
499 : /// Construct `Self` from on-disk state.
500 0 : pub fn load_config(repopath: &Path) -> anyhow::Result<Self> {
501 0 : if !repopath.exists() {
502 0 : bail!(
503 0 : "Neon config is not found in {}. You need to run 'neon_local init' first",
504 0 : repopath.to_str().unwrap()
505 0 : );
506 0 : }
507 :
508 : // TODO: check that it looks like a neon repository
509 :
510 : // load and parse file
511 0 : let config_file_contents = fs::read_to_string(repopath.join("config"))?;
512 0 : let on_disk_config: OnDiskConfig = toml::from_str(config_file_contents.as_str())?;
513 0 : let mut env = {
514 0 : let OnDiskConfig {
515 0 : pg_distrib_dir,
516 0 : neon_distrib_dir,
517 0 : default_tenant_id,
518 0 : private_key_path,
519 0 : broker,
520 0 : storage_controller,
521 0 : pageservers,
522 0 : safekeepers,
523 0 : control_plane_api,
524 0 : control_plane_compute_hook_api,
525 0 : branch_name_mappings,
526 0 : } = on_disk_config;
527 0 : LocalEnv {
528 0 : base_data_dir: repopath.to_owned(),
529 0 : pg_distrib_dir,
530 0 : neon_distrib_dir,
531 0 : default_tenant_id,
532 0 : private_key_path,
533 0 : broker,
534 0 : storage_controller,
535 0 : pageservers,
536 0 : safekeepers,
537 0 : control_plane_api: control_plane_api.unwrap(),
538 0 : control_plane_compute_hook_api,
539 0 : branch_name_mappings,
540 0 : }
541 0 : };
542 0 :
543 0 : // The source of truth for pageserver configuration is the pageserver.toml.
544 0 : assert!(
545 0 : env.pageservers.is_empty(),
546 0 : "we ensure this during deserialization"
547 : );
548 0 : env.pageservers = {
549 0 : let iter = std::fs::read_dir(repopath).context("open dir")?;
550 0 : let mut pageservers = Vec::new();
551 0 : for res in iter {
552 0 : let dentry = res?;
553 : const PREFIX: &str = "pageserver_";
554 0 : let dentry_name = dentry
555 0 : .file_name()
556 0 : .into_string()
557 0 : .ok()
558 0 : .with_context(|| format!("non-utf8 dentry: {:?}", dentry.path()))
559 0 : .unwrap();
560 0 : if !dentry_name.starts_with(PREFIX) {
561 0 : continue;
562 0 : }
563 0 : if !dentry.file_type().context("determine file type")?.is_dir() {
564 0 : anyhow::bail!("expected a directory, got {:?}", dentry.path());
565 0 : }
566 0 : let id = dentry_name[PREFIX.len()..]
567 0 : .parse::<NodeId>()
568 0 : .with_context(|| format!("parse id from {:?}", dentry.path()))?;
569 : // TODO(christian): use pageserver_api::config::ConfigToml (PR #7656)
570 0 : #[derive(serde::Serialize, serde::Deserialize)]
571 : // (allow unknown fields, unlike PageServerConf)
572 : struct PageserverConfigTomlSubset {
573 : listen_pg_addr: String,
574 : listen_http_addr: String,
575 : pg_auth_type: AuthType,
576 : http_auth_type: AuthType,
577 : #[serde(default)]
578 : no_sync: bool,
579 : }
580 0 : let config_toml_path = dentry.path().join("pageserver.toml");
581 0 : let config_toml: PageserverConfigTomlSubset = toml_edit::de::from_str(
582 0 : &std::fs::read_to_string(&config_toml_path)
583 0 : .with_context(|| format!("read {:?}", config_toml_path))?,
584 : )
585 0 : .context("parse pageserver.toml")?;
586 0 : let identity_toml_path = dentry.path().join("identity.toml");
587 0 : #[derive(serde::Serialize, serde::Deserialize)]
588 : struct IdentityTomlSubset {
589 : id: NodeId,
590 : }
591 0 : let identity_toml: IdentityTomlSubset = toml_edit::de::from_str(
592 0 : &std::fs::read_to_string(&identity_toml_path)
593 0 : .with_context(|| format!("read {:?}", identity_toml_path))?,
594 : )
595 0 : .context("parse identity.toml")?;
596 : let PageserverConfigTomlSubset {
597 0 : listen_pg_addr,
598 0 : listen_http_addr,
599 0 : pg_auth_type,
600 0 : http_auth_type,
601 0 : no_sync,
602 0 : } = config_toml;
603 0 : let IdentityTomlSubset {
604 0 : id: identity_toml_id,
605 0 : } = identity_toml;
606 0 : let conf = PageServerConf {
607 : id: {
608 0 : anyhow::ensure!(
609 0 : identity_toml_id == id,
610 0 : "id mismatch: identity.toml:id={identity_toml_id} pageserver_(.*) id={id}",
611 : );
612 0 : id
613 0 : },
614 0 : listen_pg_addr,
615 0 : listen_http_addr,
616 0 : pg_auth_type,
617 0 : http_auth_type,
618 0 : no_sync,
619 0 : };
620 0 : pageservers.push(conf);
621 : }
622 0 : pageservers
623 0 : };
624 0 :
625 0 : Ok(env)
626 0 : }
627 :
628 0 : pub fn persist_config(&self) -> anyhow::Result<()> {
629 0 : Self::persist_config_impl(
630 0 : &self.base_data_dir,
631 0 : &OnDiskConfig {
632 0 : pg_distrib_dir: self.pg_distrib_dir.clone(),
633 0 : neon_distrib_dir: self.neon_distrib_dir.clone(),
634 0 : default_tenant_id: self.default_tenant_id,
635 0 : private_key_path: self.private_key_path.clone(),
636 0 : broker: self.broker.clone(),
637 0 : storage_controller: self.storage_controller.clone(),
638 0 : pageservers: vec![], // it's skip_serializing anyway
639 0 : safekeepers: self.safekeepers.clone(),
640 0 : control_plane_api: Some(self.control_plane_api.clone()),
641 0 : control_plane_compute_hook_api: self.control_plane_compute_hook_api.clone(),
642 0 : branch_name_mappings: self.branch_name_mappings.clone(),
643 0 : },
644 0 : )
645 0 : }
646 :
647 0 : pub fn persist_config_impl(base_path: &Path, config: &OnDiskConfig) -> anyhow::Result<()> {
648 0 : let conf_content = &toml::to_string_pretty(config)?;
649 0 : let target_config_path = base_path.join("config");
650 0 : fs::write(&target_config_path, conf_content).with_context(|| {
651 0 : format!(
652 0 : "Failed to write config file into path '{}'",
653 0 : target_config_path.display()
654 0 : )
655 0 : })
656 0 : }
657 :
658 : // this function is used only for testing purposes in CLI e g generate tokens during init
659 0 : pub fn generate_auth_token(&self, claims: &Claims) -> anyhow::Result<String> {
660 0 : let private_key_path = self.get_private_key_path();
661 0 : let key_data = fs::read(private_key_path)?;
662 0 : encode_from_key_file(claims, &key_data)
663 0 : }
664 :
665 0 : pub fn get_private_key_path(&self) -> PathBuf {
666 0 : if self.private_key_path.is_absolute() {
667 0 : self.private_key_path.to_path_buf()
668 : } else {
669 0 : self.base_data_dir.join(&self.private_key_path)
670 : }
671 0 : }
672 :
673 : /// Materialize the [`NeonLocalInitConf`] to disk. Called during [`neon_local init`].
674 0 : pub fn init(conf: NeonLocalInitConf, force: &InitForceMode) -> anyhow::Result<()> {
675 0 : let base_path = base_path();
676 0 : assert_ne!(base_path, Path::new(""));
677 0 : let base_path = &base_path;
678 0 :
679 0 : // create base_path dir
680 0 : if base_path.exists() {
681 0 : match force {
682 : InitForceMode::MustNotExist => {
683 0 : bail!(
684 0 : "directory '{}' already exists. Perhaps already initialized?",
685 0 : base_path.display()
686 0 : );
687 : }
688 : InitForceMode::EmptyDirOk => {
689 0 : if let Some(res) = std::fs::read_dir(base_path)?.next() {
690 0 : res.context("check if directory is empty")?;
691 0 : anyhow::bail!("directory not empty: {base_path:?}");
692 0 : }
693 : }
694 : InitForceMode::RemoveAllContents => {
695 0 : println!("removing all contents of '{}'", base_path.display());
696 : // instead of directly calling `remove_dir_all`, we keep the original dir but removing
697 : // all contents inside. This helps if the developer symbol links another directory (i.e.,
698 : // S3 local SSD) to the `.neon` base directory.
699 0 : for entry in std::fs::read_dir(base_path)? {
700 0 : let entry = entry?;
701 0 : let path = entry.path();
702 0 : if path.is_dir() {
703 0 : fs::remove_dir_all(&path)?;
704 : } else {
705 0 : fs::remove_file(&path)?;
706 : }
707 : }
708 : }
709 : }
710 0 : }
711 0 : if !base_path.exists() {
712 0 : fs::create_dir(base_path)?;
713 0 : }
714 :
715 : let NeonLocalInitConf {
716 0 : pg_distrib_dir,
717 0 : neon_distrib_dir,
718 0 : default_tenant_id,
719 0 : broker,
720 0 : storage_controller,
721 0 : pageservers,
722 0 : safekeepers,
723 0 : control_plane_api,
724 0 : control_plane_compute_hook_api,
725 0 : } = conf;
726 0 :
727 0 : // Find postgres binaries.
728 0 : // Follow POSTGRES_DISTRIB_DIR if set, otherwise look in "pg_install".
729 0 : // Note that later in the code we assume, that distrib dirs follow the same pattern
730 0 : // for all postgres versions.
731 0 : let pg_distrib_dir = pg_distrib_dir.unwrap_or_else(|| {
732 0 : if let Some(postgres_bin) = env::var_os("POSTGRES_DISTRIB_DIR") {
733 0 : postgres_bin.into()
734 : } else {
735 0 : let cwd = env::current_dir().unwrap();
736 0 : cwd.join("pg_install")
737 : }
738 0 : });
739 0 :
740 0 : // Find neon binaries.
741 0 : let neon_distrib_dir = neon_distrib_dir
742 0 : .unwrap_or_else(|| env::current_exe().unwrap().parent().unwrap().to_owned());
743 0 :
744 0 : // Generate keypair for JWT.
745 0 : //
746 0 : // The keypair is only needed if authentication is enabled in any of the
747 0 : // components. For convenience, we generate the keypair even if authentication
748 0 : // is not enabled, so that you can easily enable it after the initialization
749 0 : // step.
750 0 : generate_auth_keys(
751 0 : base_path.join("auth_private_key.pem").as_path(),
752 0 : base_path.join("auth_public_key.pem").as_path(),
753 0 : )
754 0 : .context("generate auth keys")?;
755 0 : let private_key_path = PathBuf::from("auth_private_key.pem");
756 0 :
757 0 : // create the runtime type because the remaining initialization code below needs
758 0 : // a LocalEnv instance op operation
759 0 : // TODO: refactor to avoid this, LocalEnv should only be constructed from on-disk state
760 0 : let env = LocalEnv {
761 0 : base_data_dir: base_path.clone(),
762 0 : pg_distrib_dir,
763 0 : neon_distrib_dir,
764 0 : default_tenant_id: Some(default_tenant_id),
765 0 : private_key_path,
766 0 : broker,
767 0 : storage_controller: storage_controller.unwrap_or_default(),
768 0 : pageservers: pageservers.iter().map(Into::into).collect(),
769 0 : safekeepers,
770 0 : control_plane_api: control_plane_api.unwrap(),
771 0 : control_plane_compute_hook_api: control_plane_compute_hook_api.unwrap_or_default(),
772 0 : branch_name_mappings: Default::default(),
773 0 : };
774 0 :
775 0 : // create endpoints dir
776 0 : fs::create_dir_all(env.endpoints_path())?;
777 :
778 : // create safekeeper dirs
779 0 : for safekeeper in &env.safekeepers {
780 0 : fs::create_dir_all(SafekeeperNode::datadir_path_by_id(&env, safekeeper.id))?;
781 : }
782 :
783 : // initialize pageserver state
784 0 : for (i, ps) in pageservers.into_iter().enumerate() {
785 0 : let runtime_ps = &env.pageservers[i];
786 0 : assert_eq!(&PageServerConf::from(&ps), runtime_ps);
787 0 : fs::create_dir(env.pageserver_data_dir(ps.id))?;
788 0 : PageServerNode::from_env(&env, runtime_ps)
789 0 : .initialize(ps)
790 0 : .context("pageserver init failed")?;
791 : }
792 :
793 : // setup remote remote location for default LocalFs remote storage
794 0 : std::fs::create_dir_all(env.base_data_dir.join(PAGESERVER_REMOTE_STORAGE_DIR))?;
795 :
796 0 : env.persist_config()
797 0 : }
798 : }
799 :
800 0 : pub fn base_path() -> PathBuf {
801 0 : let path = match std::env::var_os("NEON_REPO_DIR") {
802 0 : Some(val) => {
803 0 : let path = PathBuf::from(val);
804 0 : if !path.is_absolute() {
805 : // repeat the env var in the error because our default is always absolute
806 0 : panic!("NEON_REPO_DIR must be an absolute path, got {path:?}");
807 0 : }
808 0 : path
809 : }
810 : None => {
811 0 : let pwd = std::env::current_dir()
812 0 : // technically this can fail but it's quite unlikeley
813 0 : .expect("determine current directory");
814 0 : let pwd_abs = pwd.canonicalize().expect("canonicalize current directory");
815 0 : pwd_abs.join(".neon")
816 : }
817 : };
818 0 : assert!(path.is_absolute());
819 0 : path
820 0 : }
821 :
822 : /// Generate a public/private key pair for JWT authentication
823 0 : fn generate_auth_keys(private_key_path: &Path, public_key_path: &Path) -> anyhow::Result<()> {
824 : // Generate the key pair
825 : //
826 : // openssl genpkey -algorithm ed25519 -out auth_private_key.pem
827 0 : let keygen_output = Command::new("openssl")
828 0 : .arg("genpkey")
829 0 : .args(["-algorithm", "ed25519"])
830 0 : .args(["-out", private_key_path.to_str().unwrap()])
831 0 : .stdout(Stdio::null())
832 0 : .output()
833 0 : .context("failed to generate auth private key")?;
834 0 : if !keygen_output.status.success() {
835 0 : bail!(
836 0 : "openssl failed: '{}'",
837 0 : String::from_utf8_lossy(&keygen_output.stderr)
838 0 : );
839 0 : }
840 : // Extract the public key from the private key file
841 : //
842 : // openssl pkey -in auth_private_key.pem -pubout -out auth_public_key.pem
843 0 : let keygen_output = Command::new("openssl")
844 0 : .arg("pkey")
845 0 : .args(["-in", private_key_path.to_str().unwrap()])
846 0 : .arg("-pubout")
847 0 : .args(["-out", public_key_path.to_str().unwrap()])
848 0 : .output()
849 0 : .context("failed to extract public key from private key")?;
850 0 : if !keygen_output.status.success() {
851 0 : bail!(
852 0 : "openssl failed: '{}'",
853 0 : String::from_utf8_lossy(&keygen_output.stderr)
854 0 : );
855 0 : }
856 0 : Ok(())
857 0 : }
|
