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 = 15;
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: Option<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<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 : /// Threshold for auto-splitting a tenant into shards
160 : pub split_threshold: Option<u64>,
161 : }
162 :
163 : impl NeonStorageControllerConf {
164 : // Use a shorter pageserver unavailability interval than the default to speed up tests.
165 : const DEFAULT_MAX_OFFLINE_INTERVAL: std::time::Duration = std::time::Duration::from_secs(10);
166 :
167 : const DEFAULT_MAX_WARMING_UP_INTERVAL: std::time::Duration = std::time::Duration::from_secs(30);
168 : }
169 :
170 : impl Default for NeonStorageControllerConf {
171 0 : fn default() -> Self {
172 0 : Self {
173 0 : max_offline: Self::DEFAULT_MAX_OFFLINE_INTERVAL,
174 0 : max_warming_up: Self::DEFAULT_MAX_WARMING_UP_INTERVAL,
175 0 : split_threshold: None,
176 0 : }
177 0 : }
178 : }
179 :
180 : // Dummy Default impl to satisfy Deserialize derive.
181 : impl Default for NeonBroker {
182 0 : fn default() -> Self {
183 0 : NeonBroker {
184 0 : listen_addr: SocketAddr::new(IpAddr::V4(Ipv4Addr::new(0, 0, 0, 0)), 0),
185 0 : }
186 0 : }
187 : }
188 :
189 : impl NeonBroker {
190 0 : pub fn client_url(&self) -> Url {
191 0 : Url::parse(&format!("http://{}", self.listen_addr)).expect("failed to construct url")
192 0 : }
193 : }
194 :
195 : // neon_local needs to know this subset of pageserver configuration.
196 : // For legacy reasons, this information is duplicated from `pageserver.toml` into `.neon/config`.
197 : // It can get stale if `pageserver.toml` is changed.
198 : // TODO(christian): don't store this at all in `.neon/config`, always load it from `pageserver.toml`
199 0 : #[derive(Serialize, Deserialize, PartialEq, Eq, Clone, Debug)]
200 : #[serde(default, deny_unknown_fields)]
201 : pub struct PageServerConf {
202 : pub id: NodeId,
203 : pub listen_pg_addr: String,
204 : pub listen_http_addr: String,
205 : pub pg_auth_type: AuthType,
206 : pub http_auth_type: AuthType,
207 : }
208 :
209 : impl Default for PageServerConf {
210 0 : fn default() -> Self {
211 0 : Self {
212 0 : id: NodeId(0),
213 0 : listen_pg_addr: String::new(),
214 0 : listen_http_addr: String::new(),
215 0 : pg_auth_type: AuthType::Trust,
216 0 : http_auth_type: AuthType::Trust,
217 0 : }
218 0 : }
219 : }
220 :
221 : /// The toml that can be passed to `neon_local init --config`.
222 : /// This is a subset of the `pageserver.toml` configuration.
223 : // TODO(christian): use pageserver_api::config::ConfigToml (PR #7656)
224 0 : #[derive(Clone, Debug, serde::Deserialize, serde::Serialize)]
225 : pub struct NeonLocalInitPageserverConf {
226 : pub id: NodeId,
227 : pub listen_pg_addr: String,
228 : pub listen_http_addr: String,
229 : pub pg_auth_type: AuthType,
230 : pub http_auth_type: AuthType,
231 : #[serde(flatten)]
232 : pub other: HashMap<String, toml::Value>,
233 : }
234 :
235 : impl From<&NeonLocalInitPageserverConf> for PageServerConf {
236 0 : fn from(conf: &NeonLocalInitPageserverConf) -> Self {
237 0 : let NeonLocalInitPageserverConf {
238 0 : id,
239 0 : listen_pg_addr,
240 0 : listen_http_addr,
241 0 : pg_auth_type,
242 0 : http_auth_type,
243 0 : other: _,
244 0 : } = conf;
245 0 : Self {
246 0 : id: *id,
247 0 : listen_pg_addr: listen_pg_addr.clone(),
248 0 : listen_http_addr: listen_http_addr.clone(),
249 0 : pg_auth_type: *pg_auth_type,
250 0 : http_auth_type: *http_auth_type,
251 0 : }
252 0 : }
253 : }
254 :
255 0 : #[derive(Serialize, Deserialize, PartialEq, Eq, Clone, Debug)]
256 : #[serde(default)]
257 : pub struct SafekeeperConf {
258 : pub id: NodeId,
259 : pub pg_port: u16,
260 : pub pg_tenant_only_port: Option<u16>,
261 : pub http_port: u16,
262 : pub sync: bool,
263 : pub remote_storage: Option<String>,
264 : pub backup_threads: Option<u32>,
265 : pub auth_enabled: bool,
266 : pub listen_addr: Option<String>,
267 : }
268 :
269 : impl Default for SafekeeperConf {
270 0 : fn default() -> Self {
271 0 : Self {
272 0 : id: NodeId(0),
273 0 : pg_port: 0,
274 0 : pg_tenant_only_port: None,
275 0 : http_port: 0,
276 0 : sync: true,
277 0 : remote_storage: None,
278 0 : backup_threads: None,
279 0 : auth_enabled: false,
280 0 : listen_addr: None,
281 0 : }
282 0 : }
283 : }
284 :
285 : #[derive(Clone, Copy)]
286 : pub enum InitForceMode {
287 : MustNotExist,
288 : EmptyDirOk,
289 : RemoveAllContents,
290 : }
291 :
292 : impl ValueEnum for InitForceMode {
293 4 : fn value_variants<'a>() -> &'a [Self] {
294 4 : &[
295 4 : Self::MustNotExist,
296 4 : Self::EmptyDirOk,
297 4 : Self::RemoveAllContents,
298 4 : ]
299 4 : }
300 :
301 10 : fn to_possible_value(&self) -> Option<clap::builder::PossibleValue> {
302 10 : Some(clap::builder::PossibleValue::new(match self {
303 6 : InitForceMode::MustNotExist => "must-not-exist",
304 2 : InitForceMode::EmptyDirOk => "empty-dir-ok",
305 2 : InitForceMode::RemoveAllContents => "remove-all-contents",
306 : }))
307 10 : }
308 : }
309 :
310 : impl SafekeeperConf {
311 : /// Compute is served by port on which only tenant scoped tokens allowed, if
312 : /// it is configured.
313 0 : pub fn get_compute_port(&self) -> u16 {
314 0 : self.pg_tenant_only_port.unwrap_or(self.pg_port)
315 0 : }
316 : }
317 :
318 : impl LocalEnv {
319 0 : pub fn pg_distrib_dir_raw(&self) -> PathBuf {
320 0 : self.pg_distrib_dir.clone()
321 0 : }
322 :
323 0 : pub fn pg_distrib_dir(&self, pg_version: u32) -> anyhow::Result<PathBuf> {
324 0 : let path = self.pg_distrib_dir.clone();
325 0 :
326 0 : #[allow(clippy::manual_range_patterns)]
327 0 : match pg_version {
328 0 : 14 | 15 | 16 => Ok(path.join(format!("v{pg_version}"))),
329 0 : _ => bail!("Unsupported postgres version: {}", pg_version),
330 : }
331 0 : }
332 :
333 0 : pub fn pg_dir(&self, pg_version: u32, dir_name: &str) -> anyhow::Result<PathBuf> {
334 0 : Ok(self.pg_distrib_dir(pg_version)?.join(dir_name))
335 0 : }
336 :
337 0 : pub fn pg_bin_dir(&self, pg_version: u32) -> anyhow::Result<PathBuf> {
338 0 : self.pg_dir(pg_version, "bin")
339 0 : }
340 :
341 0 : pub fn pg_lib_dir(&self, pg_version: u32) -> anyhow::Result<PathBuf> {
342 0 : self.pg_dir(pg_version, "lib")
343 0 : }
344 :
345 0 : pub fn pageserver_bin(&self) -> PathBuf {
346 0 : self.neon_distrib_dir.join("pageserver")
347 0 : }
348 :
349 0 : pub fn storage_controller_bin(&self) -> PathBuf {
350 0 : // Irrespective of configuration, storage controller binary is always
351 0 : // run from the same location as neon_local. This means that for compatibility
352 0 : // tests that run old pageserver/safekeeper, they still run latest storage controller.
353 0 : let neon_local_bin_dir = env::current_exe().unwrap().parent().unwrap().to_owned();
354 0 : neon_local_bin_dir.join("storage_controller")
355 0 : }
356 :
357 0 : pub fn safekeeper_bin(&self) -> PathBuf {
358 0 : self.neon_distrib_dir.join("safekeeper")
359 0 : }
360 :
361 0 : pub fn storage_broker_bin(&self) -> PathBuf {
362 0 : self.neon_distrib_dir.join("storage_broker")
363 0 : }
364 :
365 0 : pub fn endpoints_path(&self) -> PathBuf {
366 0 : self.base_data_dir.join("endpoints")
367 0 : }
368 :
369 0 : pub fn pageserver_data_dir(&self, pageserver_id: NodeId) -> PathBuf {
370 0 : self.base_data_dir
371 0 : .join(format!("pageserver_{pageserver_id}"))
372 0 : }
373 :
374 0 : pub fn safekeeper_data_dir(&self, data_dir_name: &str) -> PathBuf {
375 0 : self.base_data_dir.join("safekeepers").join(data_dir_name)
376 0 : }
377 :
378 0 : pub fn get_pageserver_conf(&self, id: NodeId) -> anyhow::Result<&PageServerConf> {
379 0 : if let Some(conf) = self.pageservers.iter().find(|node| node.id == id) {
380 0 : Ok(conf)
381 : } else {
382 0 : let have_ids = self
383 0 : .pageservers
384 0 : .iter()
385 0 : .map(|node| format!("{}:{}", node.id, node.listen_http_addr))
386 0 : .collect::<Vec<_>>();
387 0 : let joined = have_ids.join(",");
388 0 : bail!("could not find pageserver {id}, have ids {joined}")
389 : }
390 0 : }
391 :
392 0 : pub fn register_branch_mapping(
393 0 : &mut self,
394 0 : branch_name: String,
395 0 : tenant_id: TenantId,
396 0 : timeline_id: TimelineId,
397 0 : ) -> anyhow::Result<()> {
398 0 : let existing_values = self
399 0 : .branch_name_mappings
400 0 : .entry(branch_name.clone())
401 0 : .or_default();
402 0 :
403 0 : let existing_ids = existing_values
404 0 : .iter()
405 0 : .find(|(existing_tenant_id, _)| existing_tenant_id == &tenant_id);
406 :
407 0 : if let Some((_, old_timeline_id)) = existing_ids {
408 0 : if old_timeline_id == &timeline_id {
409 0 : Ok(())
410 : } else {
411 0 : bail!("branch '{branch_name}' is already mapped to timeline {old_timeline_id}, cannot map to another timeline {timeline_id}");
412 : }
413 : } else {
414 0 : existing_values.push((tenant_id, timeline_id));
415 0 : Ok(())
416 : }
417 0 : }
418 :
419 0 : pub fn get_branch_timeline_id(
420 0 : &self,
421 0 : branch_name: &str,
422 0 : tenant_id: TenantId,
423 0 : ) -> Option<TimelineId> {
424 0 : self.branch_name_mappings
425 0 : .get(branch_name)?
426 0 : .iter()
427 0 : .find(|(mapped_tenant_id, _)| mapped_tenant_id == &tenant_id)
428 0 : .map(|&(_, timeline_id)| timeline_id)
429 0 : .map(TimelineId::from)
430 0 : }
431 :
432 0 : pub fn timeline_name_mappings(&self) -> HashMap<TenantTimelineId, String> {
433 0 : self.branch_name_mappings
434 0 : .iter()
435 0 : .flat_map(|(name, tenant_timelines)| {
436 0 : tenant_timelines.iter().map(|&(tenant_id, timeline_id)| {
437 0 : (TenantTimelineId::new(tenant_id, timeline_id), name.clone())
438 0 : })
439 0 : })
440 0 : .collect()
441 0 : }
442 :
443 : /// Construct `Self` from on-disk state.
444 0 : pub fn load_config(repopath: &Path) -> anyhow::Result<Self> {
445 0 : if !repopath.exists() {
446 0 : bail!(
447 0 : "Neon config is not found in {}. You need to run 'neon_local init' first",
448 0 : repopath.to_str().unwrap()
449 0 : );
450 0 : }
451 :
452 : // TODO: check that it looks like a neon repository
453 :
454 : // load and parse file
455 0 : let config_file_contents = fs::read_to_string(repopath.join("config"))?;
456 0 : let on_disk_config: OnDiskConfig = toml::from_str(config_file_contents.as_str())?;
457 0 : let mut env = {
458 0 : let OnDiskConfig {
459 0 : pg_distrib_dir,
460 0 : neon_distrib_dir,
461 0 : default_tenant_id,
462 0 : private_key_path,
463 0 : broker,
464 0 : storage_controller,
465 0 : pageservers,
466 0 : safekeepers,
467 0 : control_plane_api,
468 0 : control_plane_compute_hook_api,
469 0 : branch_name_mappings,
470 0 : } = on_disk_config;
471 0 : LocalEnv {
472 0 : base_data_dir: repopath.to_owned(),
473 0 : pg_distrib_dir,
474 0 : neon_distrib_dir,
475 0 : default_tenant_id,
476 0 : private_key_path,
477 0 : broker,
478 0 : storage_controller,
479 0 : pageservers,
480 0 : safekeepers,
481 0 : control_plane_api,
482 0 : control_plane_compute_hook_api,
483 0 : branch_name_mappings,
484 0 : }
485 0 : };
486 0 :
487 0 : // The source of truth for pageserver configuration is the pageserver.toml.
488 0 : assert!(
489 0 : env.pageservers.is_empty(),
490 0 : "we ensure this during deserialization"
491 : );
492 0 : env.pageservers = {
493 0 : let iter = std::fs::read_dir(repopath).context("open dir")?;
494 0 : let mut pageservers = Vec::new();
495 0 : for res in iter {
496 0 : let dentry = res?;
497 : const PREFIX: &str = "pageserver_";
498 0 : let dentry_name = dentry
499 0 : .file_name()
500 0 : .into_string()
501 0 : .ok()
502 0 : .with_context(|| format!("non-utf8 dentry: {:?}", dentry.path()))
503 0 : .unwrap();
504 0 : if !dentry_name.starts_with(PREFIX) {
505 0 : continue;
506 0 : }
507 0 : if !dentry.file_type().context("determine file type")?.is_dir() {
508 0 : anyhow::bail!("expected a directory, got {:?}", dentry.path());
509 0 : }
510 0 : let id = dentry_name[PREFIX.len()..]
511 0 : .parse::<NodeId>()
512 0 : .with_context(|| format!("parse id from {:?}", dentry.path()))?;
513 : // TODO(christian): use pageserver_api::config::ConfigToml (PR #7656)
514 0 : #[derive(serde::Serialize, serde::Deserialize)]
515 : // (allow unknown fields, unlike PageServerConf)
516 : struct PageserverConfigTomlSubset {
517 : listen_pg_addr: String,
518 : listen_http_addr: String,
519 : pg_auth_type: AuthType,
520 : http_auth_type: AuthType,
521 : }
522 0 : let config_toml_path = dentry.path().join("pageserver.toml");
523 0 : let config_toml: PageserverConfigTomlSubset = toml_edit::de::from_str(
524 0 : &std::fs::read_to_string(&config_toml_path)
525 0 : .with_context(|| format!("read {:?}", config_toml_path))?,
526 : )
527 0 : .context("parse pageserver.toml")?;
528 0 : let identity_toml_path = dentry.path().join("identity.toml");
529 0 : #[derive(serde::Serialize, serde::Deserialize)]
530 : struct IdentityTomlSubset {
531 : id: NodeId,
532 : }
533 0 : let identity_toml: IdentityTomlSubset = toml_edit::de::from_str(
534 0 : &std::fs::read_to_string(&identity_toml_path)
535 0 : .with_context(|| format!("read {:?}", identity_toml_path))?,
536 : )
537 0 : .context("parse identity.toml")?;
538 : let PageserverConfigTomlSubset {
539 0 : listen_pg_addr,
540 0 : listen_http_addr,
541 0 : pg_auth_type,
542 0 : http_auth_type,
543 0 : } = config_toml;
544 0 : let IdentityTomlSubset {
545 0 : id: identity_toml_id,
546 0 : } = identity_toml;
547 0 : let conf = PageServerConf {
548 : id: {
549 0 : anyhow::ensure!(
550 0 : identity_toml_id == id,
551 0 : "id mismatch: identity.toml:id={identity_toml_id} pageserver_(.*) id={id}",
552 : );
553 0 : id
554 0 : },
555 0 : listen_pg_addr,
556 0 : listen_http_addr,
557 0 : pg_auth_type,
558 0 : http_auth_type,
559 0 : };
560 0 : pageservers.push(conf);
561 : }
562 0 : pageservers
563 0 : };
564 0 :
565 0 : Ok(env)
566 0 : }
567 :
568 0 : pub fn persist_config(&self) -> anyhow::Result<()> {
569 0 : Self::persist_config_impl(
570 0 : &self.base_data_dir,
571 0 : &OnDiskConfig {
572 0 : pg_distrib_dir: self.pg_distrib_dir.clone(),
573 0 : neon_distrib_dir: self.neon_distrib_dir.clone(),
574 0 : default_tenant_id: self.default_tenant_id,
575 0 : private_key_path: self.private_key_path.clone(),
576 0 : broker: self.broker.clone(),
577 0 : storage_controller: self.storage_controller.clone(),
578 0 : pageservers: vec![], // it's skip_serializing anyway
579 0 : safekeepers: self.safekeepers.clone(),
580 0 : control_plane_api: self.control_plane_api.clone(),
581 0 : control_plane_compute_hook_api: self.control_plane_compute_hook_api.clone(),
582 0 : branch_name_mappings: self.branch_name_mappings.clone(),
583 0 : },
584 0 : )
585 0 : }
586 :
587 0 : pub fn persist_config_impl(base_path: &Path, config: &OnDiskConfig) -> anyhow::Result<()> {
588 0 : let conf_content = &toml::to_string_pretty(config)?;
589 0 : let target_config_path = base_path.join("config");
590 0 : fs::write(&target_config_path, conf_content).with_context(|| {
591 0 : format!(
592 0 : "Failed to write config file into path '{}'",
593 0 : target_config_path.display()
594 0 : )
595 0 : })
596 0 : }
597 :
598 : // this function is used only for testing purposes in CLI e g generate tokens during init
599 0 : pub fn generate_auth_token(&self, claims: &Claims) -> anyhow::Result<String> {
600 0 : let private_key_path = self.get_private_key_path();
601 0 : let key_data = fs::read(private_key_path)?;
602 0 : encode_from_key_file(claims, &key_data)
603 0 : }
604 :
605 0 : pub fn get_private_key_path(&self) -> PathBuf {
606 0 : if self.private_key_path.is_absolute() {
607 0 : self.private_key_path.to_path_buf()
608 : } else {
609 0 : self.base_data_dir.join(&self.private_key_path)
610 : }
611 0 : }
612 :
613 : /// Materialize the [`NeonLocalInitConf`] to disk. Called during [`neon_local init`].
614 0 : pub fn init(conf: NeonLocalInitConf, force: &InitForceMode) -> anyhow::Result<()> {
615 0 : let base_path = base_path();
616 0 : assert_ne!(base_path, Path::new(""));
617 0 : let base_path = &base_path;
618 0 :
619 0 : // create base_path dir
620 0 : if base_path.exists() {
621 0 : match force {
622 : InitForceMode::MustNotExist => {
623 0 : bail!(
624 0 : "directory '{}' already exists. Perhaps already initialized?",
625 0 : base_path.display()
626 0 : );
627 : }
628 : InitForceMode::EmptyDirOk => {
629 0 : if let Some(res) = std::fs::read_dir(base_path)?.next() {
630 0 : res.context("check if directory is empty")?;
631 0 : anyhow::bail!("directory not empty: {base_path:?}");
632 0 : }
633 : }
634 : InitForceMode::RemoveAllContents => {
635 0 : println!("removing all contents of '{}'", base_path.display());
636 : // instead of directly calling `remove_dir_all`, we keep the original dir but removing
637 : // all contents inside. This helps if the developer symbol links another directory (i.e.,
638 : // S3 local SSD) to the `.neon` base directory.
639 0 : for entry in std::fs::read_dir(base_path)? {
640 0 : let entry = entry?;
641 0 : let path = entry.path();
642 0 : if path.is_dir() {
643 0 : fs::remove_dir_all(&path)?;
644 : } else {
645 0 : fs::remove_file(&path)?;
646 : }
647 : }
648 : }
649 : }
650 0 : }
651 0 : if !base_path.exists() {
652 0 : fs::create_dir(base_path)?;
653 0 : }
654 :
655 : let NeonLocalInitConf {
656 0 : pg_distrib_dir,
657 0 : neon_distrib_dir,
658 0 : default_tenant_id,
659 0 : broker,
660 0 : storage_controller,
661 0 : pageservers,
662 0 : safekeepers,
663 0 : control_plane_api,
664 0 : control_plane_compute_hook_api,
665 0 : } = conf;
666 0 :
667 0 : // Find postgres binaries.
668 0 : // Follow POSTGRES_DISTRIB_DIR if set, otherwise look in "pg_install".
669 0 : // Note that later in the code we assume, that distrib dirs follow the same pattern
670 0 : // for all postgres versions.
671 0 : let pg_distrib_dir = pg_distrib_dir.unwrap_or_else(|| {
672 0 : if let Some(postgres_bin) = env::var_os("POSTGRES_DISTRIB_DIR") {
673 0 : postgres_bin.into()
674 : } else {
675 0 : let cwd = env::current_dir().unwrap();
676 0 : cwd.join("pg_install")
677 : }
678 0 : });
679 0 :
680 0 : // Find neon binaries.
681 0 : let neon_distrib_dir = neon_distrib_dir
682 0 : .unwrap_or_else(|| env::current_exe().unwrap().parent().unwrap().to_owned());
683 0 :
684 0 : // Generate keypair for JWT.
685 0 : //
686 0 : // The keypair is only needed if authentication is enabled in any of the
687 0 : // components. For convenience, we generate the keypair even if authentication
688 0 : // is not enabled, so that you can easily enable it after the initialization
689 0 : // step.
690 0 : generate_auth_keys(
691 0 : base_path.join("auth_private_key.pem").as_path(),
692 0 : base_path.join("auth_public_key.pem").as_path(),
693 0 : )
694 0 : .context("generate auth keys")?;
695 0 : let private_key_path = PathBuf::from("auth_private_key.pem");
696 0 :
697 0 : // create the runtime type because the remaining initialization code below needs
698 0 : // a LocalEnv instance op operation
699 0 : // TODO: refactor to avoid this, LocalEnv should only be constructed from on-disk state
700 0 : let env = LocalEnv {
701 0 : base_data_dir: base_path.clone(),
702 0 : pg_distrib_dir,
703 0 : neon_distrib_dir,
704 0 : default_tenant_id: Some(default_tenant_id),
705 0 : private_key_path,
706 0 : broker,
707 0 : storage_controller: storage_controller.unwrap_or_default(),
708 0 : pageservers: pageservers.iter().map(Into::into).collect(),
709 0 : safekeepers,
710 0 : control_plane_api: control_plane_api.unwrap_or_default(),
711 0 : control_plane_compute_hook_api: control_plane_compute_hook_api.unwrap_or_default(),
712 0 : branch_name_mappings: Default::default(),
713 0 : };
714 0 :
715 0 : // create endpoints dir
716 0 : fs::create_dir_all(env.endpoints_path())?;
717 :
718 : // create safekeeper dirs
719 0 : for safekeeper in &env.safekeepers {
720 0 : fs::create_dir_all(SafekeeperNode::datadir_path_by_id(&env, safekeeper.id))?;
721 : }
722 :
723 : // initialize pageserver state
724 0 : for (i, ps) in pageservers.into_iter().enumerate() {
725 0 : let runtime_ps = &env.pageservers[i];
726 0 : assert_eq!(&PageServerConf::from(&ps), runtime_ps);
727 0 : fs::create_dir(env.pageserver_data_dir(ps.id))?;
728 0 : PageServerNode::from_env(&env, runtime_ps)
729 0 : .initialize(ps)
730 0 : .context("pageserver init failed")?;
731 : }
732 :
733 : // setup remote remote location for default LocalFs remote storage
734 0 : std::fs::create_dir_all(env.base_data_dir.join(PAGESERVER_REMOTE_STORAGE_DIR))?;
735 :
736 0 : env.persist_config()
737 0 : }
738 : }
739 :
740 0 : pub fn base_path() -> PathBuf {
741 0 : let path = match std::env::var_os("NEON_REPO_DIR") {
742 0 : Some(val) => {
743 0 : let path = PathBuf::from(val);
744 0 : if !path.is_absolute() {
745 : // repeat the env var in the error because our default is always absolute
746 0 : panic!("NEON_REPO_DIR must be an absolute path, got {path:?}");
747 0 : }
748 0 : path
749 : }
750 : None => {
751 0 : let pwd = std::env::current_dir()
752 0 : // technically this can fail but it's quite unlikeley
753 0 : .expect("determine current directory");
754 0 : let pwd_abs = pwd.canonicalize().expect("canonicalize current directory");
755 0 : pwd_abs.join(".neon")
756 : }
757 : };
758 0 : assert!(path.is_absolute());
759 0 : path
760 0 : }
761 :
762 : /// Generate a public/private key pair for JWT authentication
763 0 : fn generate_auth_keys(private_key_path: &Path, public_key_path: &Path) -> anyhow::Result<()> {
764 : // Generate the key pair
765 : //
766 : // openssl genpkey -algorithm ed25519 -out auth_private_key.pem
767 0 : let keygen_output = Command::new("openssl")
768 0 : .arg("genpkey")
769 0 : .args(["-algorithm", "ed25519"])
770 0 : .args(["-out", private_key_path.to_str().unwrap()])
771 0 : .stdout(Stdio::null())
772 0 : .output()
773 0 : .context("failed to generate auth private key")?;
774 0 : if !keygen_output.status.success() {
775 0 : bail!(
776 0 : "openssl failed: '{}'",
777 0 : String::from_utf8_lossy(&keygen_output.stderr)
778 0 : );
779 0 : }
780 : // Extract the public key from the private key file
781 : //
782 : // openssl pkey -in auth_private_key.pem -pubout -out auth_public_key.pem
783 0 : let keygen_output = Command::new("openssl")
784 0 : .arg("pkey")
785 0 : .args(["-in", private_key_path.to_str().unwrap()])
786 0 : .arg("-pubout")
787 0 : .args(["-out", public_key_path.to_str().unwrap()])
788 0 : .output()
789 0 : .context("failed to extract public key from private key")?;
790 0 : if !keygen_output.status.success() {
791 0 : bail!(
792 0 : "openssl failed: '{}'",
793 0 : String::from_utf8_lossy(&keygen_output.stderr)
794 0 : );
795 0 : }
796 0 : Ok(())
797 0 : }
|
