Line data Source code
1 : use crate::{
2 : background_process,
3 : local_env::{LocalEnv, NeonStorageControllerConf},
4 : };
5 : use camino::{Utf8Path, Utf8PathBuf};
6 : use pageserver_api::{
7 : controller_api::{
8 : NodeConfigureRequest, NodeRegisterRequest, TenantCreateRequest, TenantCreateResponse,
9 : TenantLocateResponse, TenantShardMigrateRequest, TenantShardMigrateResponse,
10 : },
11 : models::{
12 : TenantShardSplitRequest, TenantShardSplitResponse, TimelineCreateRequest, TimelineInfo,
13 : },
14 : shard::{ShardStripeSize, TenantShardId},
15 : };
16 : use pageserver_client::mgmt_api::ResponseErrorMessageExt;
17 : use postgres_backend::AuthType;
18 : use reqwest::Method;
19 : use serde::{de::DeserializeOwned, Deserialize, Serialize};
20 : use std::{fs, str::FromStr, time::Duration};
21 : use tokio::process::Command;
22 : use tracing::instrument;
23 : use url::Url;
24 : use utils::{
25 : auth::{encode_from_key_file, Claims, Scope},
26 : id::{NodeId, TenantId},
27 : };
28 :
29 : pub struct StorageController {
30 : env: LocalEnv,
31 : listen: String,
32 : path: Utf8PathBuf,
33 : private_key: Option<Vec<u8>>,
34 : public_key: Option<String>,
35 : postgres_port: u16,
36 : client: reqwest::Client,
37 : config: NeonStorageControllerConf,
38 : }
39 :
40 : const COMMAND: &str = "storage_controller";
41 :
42 : const STORAGE_CONTROLLER_POSTGRES_VERSION: u32 = 16;
43 :
44 0 : #[derive(Serialize, Deserialize)]
45 : pub struct AttachHookRequest {
46 : pub tenant_shard_id: TenantShardId,
47 : pub node_id: Option<NodeId>,
48 : pub generation_override: Option<i32>,
49 : }
50 :
51 0 : #[derive(Serialize, Deserialize)]
52 : pub struct AttachHookResponse {
53 : pub gen: Option<u32>,
54 : }
55 :
56 0 : #[derive(Serialize, Deserialize)]
57 : pub struct InspectRequest {
58 : pub tenant_shard_id: TenantShardId,
59 : }
60 :
61 0 : #[derive(Serialize, Deserialize)]
62 : pub struct InspectResponse {
63 : pub attachment: Option<(u32, NodeId)>,
64 : }
65 :
66 : impl StorageController {
67 0 : pub fn from_env(env: &LocalEnv) -> Self {
68 0 : let path = Utf8PathBuf::from_path_buf(env.base_data_dir.clone())
69 0 : .unwrap()
70 0 : .join("attachments.json");
71 0 :
72 0 : // Makes no sense to construct this if pageservers aren't going to use it: assume
73 0 : // pageservers have control plane API set
74 0 : let listen_url = env.control_plane_api.clone().unwrap();
75 0 :
76 0 : let listen = format!(
77 0 : "{}:{}",
78 0 : listen_url.host_str().unwrap(),
79 0 : listen_url.port().unwrap()
80 0 : );
81 0 :
82 0 : // Convention: NeonEnv in python tests reserves the next port after the control_plane_api
83 0 : // port, for use by our captive postgres.
84 0 : let postgres_port = listen_url
85 0 : .port()
86 0 : .expect("Control plane API setting should always have a port")
87 0 : + 1;
88 0 :
89 0 : // Assume all pageservers have symmetric auth configuration: this service
90 0 : // expects to use one JWT token to talk to all of them.
91 0 : let ps_conf = env
92 0 : .pageservers
93 0 : .first()
94 0 : .expect("Config is validated to contain at least one pageserver");
95 0 : let (private_key, public_key) = match ps_conf.http_auth_type {
96 0 : AuthType::Trust => (None, None),
97 : AuthType::NeonJWT => {
98 0 : let private_key_path = env.get_private_key_path();
99 0 : let private_key = fs::read(private_key_path).expect("failed to read private key");
100 0 :
101 0 : // If pageserver auth is enabled, this implicitly enables auth for this service,
102 0 : // using the same credentials.
103 0 : let public_key_path =
104 0 : camino::Utf8PathBuf::try_from(env.base_data_dir.join("auth_public_key.pem"))
105 0 : .unwrap();
106 :
107 : // This service takes keys as a string rather than as a path to a file/dir: read the key into memory.
108 0 : let public_key = if std::fs::metadata(&public_key_path)
109 0 : .expect("Can't stat public key")
110 0 : .is_dir()
111 : {
112 : // Our config may specify a directory: this is for the pageserver's ability to handle multiple
113 : // keys. We only use one key at a time, so, arbitrarily load the first one in the directory.
114 0 : let mut dir =
115 0 : std::fs::read_dir(&public_key_path).expect("Can't readdir public key path");
116 0 : let dent = dir
117 0 : .next()
118 0 : .expect("Empty key dir")
119 0 : .expect("Error reading key dir");
120 0 :
121 0 : std::fs::read_to_string(dent.path()).expect("Can't read public key")
122 : } else {
123 0 : std::fs::read_to_string(&public_key_path).expect("Can't read public key")
124 : };
125 0 : (Some(private_key), Some(public_key))
126 : }
127 : };
128 :
129 0 : Self {
130 0 : env: env.clone(),
131 0 : path,
132 0 : listen,
133 0 : private_key,
134 0 : public_key,
135 0 : postgres_port,
136 0 : client: reqwest::ClientBuilder::new()
137 0 : .build()
138 0 : .expect("Failed to construct http client"),
139 0 : config: env.storage_controller.clone(),
140 0 : }
141 0 : }
142 :
143 0 : fn pid_file(&self) -> Utf8PathBuf {
144 0 : Utf8PathBuf::from_path_buf(self.env.base_data_dir.join("storage_controller.pid"))
145 0 : .expect("non-Unicode path")
146 0 : }
147 :
148 : /// PIDFile for the postgres instance used to store storage controller state
149 0 : fn postgres_pid_file(&self) -> Utf8PathBuf {
150 0 : Utf8PathBuf::from_path_buf(
151 0 : self.env
152 0 : .base_data_dir
153 0 : .join("storage_controller_postgres.pid"),
154 0 : )
155 0 : .expect("non-Unicode path")
156 0 : }
157 :
158 : /// Find the directory containing postgres binaries, such as `initdb` and `pg_ctl`
159 : ///
160 : /// This usually uses STORAGE_CONTROLLER_POSTGRES_VERSION of postgres, but will fall back
161 : /// to other versions if that one isn't found. Some automated tests create circumstances
162 : /// where only one version is available in pg_distrib_dir, such as `test_remote_extensions`.
163 0 : pub async fn get_pg_bin_dir(&self) -> anyhow::Result<Utf8PathBuf> {
164 0 : let prefer_versions = [STORAGE_CONTROLLER_POSTGRES_VERSION, 15, 14];
165 :
166 0 : for v in prefer_versions {
167 0 : let path = Utf8PathBuf::from_path_buf(self.env.pg_bin_dir(v)?).unwrap();
168 0 : if tokio::fs::try_exists(&path).await? {
169 0 : return Ok(path);
170 0 : }
171 : }
172 :
173 : // Fall through
174 0 : anyhow::bail!(
175 0 : "Postgres binaries not found in {}",
176 0 : self.env.pg_distrib_dir.display()
177 0 : );
178 0 : }
179 :
180 : /// Readiness check for our postgres process
181 0 : async fn pg_isready(&self, pg_bin_dir: &Utf8Path) -> anyhow::Result<bool> {
182 0 : let bin_path = pg_bin_dir.join("pg_isready");
183 0 : let args = ["-h", "localhost", "-p", &format!("{}", self.postgres_port)];
184 0 : let exitcode = Command::new(bin_path).args(args).spawn()?.wait().await?;
185 :
186 0 : Ok(exitcode.success())
187 0 : }
188 :
189 : /// Create our database if it doesn't exist, and run migrations.
190 : ///
191 : /// This function is equivalent to the `diesel setup` command in the diesel CLI. We implement
192 : /// the same steps by hand to avoid imposing a dependency on installing diesel-cli for developers
193 : /// who just want to run `cargo neon_local` without knowing about diesel.
194 : ///
195 : /// Returns the database url
196 0 : pub async fn setup_database(&self) -> anyhow::Result<String> {
197 0 : const DB_NAME: &str = "storage_controller";
198 0 : let database_url = format!("postgresql://localhost:{}/{DB_NAME}", self.postgres_port);
199 :
200 0 : let pg_bin_dir = self.get_pg_bin_dir().await?;
201 0 : let createdb_path = pg_bin_dir.join("createdb");
202 0 : let output = Command::new(&createdb_path)
203 0 : .args([
204 0 : "-h",
205 0 : "localhost",
206 0 : "-p",
207 0 : &format!("{}", self.postgres_port),
208 0 : DB_NAME,
209 0 : ])
210 0 : .output()
211 0 : .await
212 0 : .expect("Failed to spawn createdb");
213 0 :
214 0 : if !output.status.success() {
215 0 : let stderr = String::from_utf8(output.stderr).expect("Non-UTF8 output from createdb");
216 0 : if stderr.contains("already exists") {
217 0 : tracing::info!("Database {DB_NAME} already exists");
218 : } else {
219 0 : anyhow::bail!("createdb failed with status {}: {stderr}", output.status);
220 : }
221 0 : }
222 :
223 0 : Ok(database_url)
224 0 : }
225 :
226 0 : pub async fn start(&self, retry_timeout: &Duration) -> anyhow::Result<()> {
227 0 : // Start a vanilla Postgres process used by the storage controller for persistence.
228 0 : let pg_data_path = Utf8PathBuf::from_path_buf(self.env.base_data_dir.clone())
229 0 : .unwrap()
230 0 : .join("storage_controller_db");
231 0 : let pg_bin_dir = self.get_pg_bin_dir().await?;
232 0 : let pg_log_path = pg_data_path.join("postgres.log");
233 0 :
234 0 : if !tokio::fs::try_exists(&pg_data_path).await? {
235 : // Initialize empty database
236 0 : let initdb_path = pg_bin_dir.join("initdb");
237 0 : let mut child = Command::new(&initdb_path)
238 0 : .args(["-D", pg_data_path.as_ref()])
239 0 : .spawn()
240 0 : .expect("Failed to spawn initdb");
241 0 : let status = child.wait().await?;
242 0 : if !status.success() {
243 0 : anyhow::bail!("initdb failed with status {status}");
244 0 : }
245 0 :
246 0 : // Write a minimal config file:
247 0 : // - Specify the port, since this is chosen dynamically
248 0 : // - Switch off fsync, since we're running on lightweight test environments and when e.g. scale testing
249 0 : // the storage controller we don't want a slow local disk to interfere with that.
250 0 : tokio::fs::write(
251 0 : &pg_data_path.join("postgresql.conf"),
252 0 : format!("port = {}\nfsync=off\n", self.postgres_port),
253 0 : )
254 0 : .await?;
255 0 : };
256 :
257 0 : println!("Starting storage controller database...");
258 0 : let db_start_args = [
259 0 : "-w",
260 0 : "-D",
261 0 : pg_data_path.as_ref(),
262 0 : "-l",
263 0 : pg_log_path.as_ref(),
264 0 : "start",
265 0 : ];
266 0 :
267 0 : background_process::start_process(
268 0 : "storage_controller_db",
269 0 : &self.env.base_data_dir,
270 0 : pg_bin_dir.join("pg_ctl").as_std_path(),
271 0 : db_start_args,
272 0 : [],
273 0 : background_process::InitialPidFile::Create(self.postgres_pid_file()),
274 0 : retry_timeout,
275 0 : || self.pg_isready(&pg_bin_dir),
276 0 : )
277 0 : .await?;
278 :
279 : // Run migrations on every startup, in case something changed.
280 0 : let database_url = self.setup_database().await?;
281 :
282 0 : let mut args = vec![
283 0 : "-l",
284 0 : &self.listen,
285 0 : "-p",
286 0 : self.path.as_ref(),
287 0 : "--dev",
288 0 : "--database-url",
289 0 : &database_url,
290 0 : "--max-unavailable-interval",
291 0 : &humantime::Duration::from(self.config.max_unavailable).to_string(),
292 0 : ]
293 0 : .into_iter()
294 0 : .map(|s| s.to_string())
295 0 : .collect::<Vec<_>>();
296 0 : if let Some(private_key) = &self.private_key {
297 0 : let claims = Claims::new(None, Scope::PageServerApi);
298 0 : let jwt_token =
299 0 : encode_from_key_file(&claims, private_key).expect("failed to generate jwt token");
300 0 : args.push(format!("--jwt-token={jwt_token}"));
301 0 : }
302 :
303 0 : if let Some(public_key) = &self.public_key {
304 0 : args.push(format!("--public-key=\"{public_key}\""));
305 0 : }
306 :
307 0 : if let Some(control_plane_compute_hook_api) = &self.env.control_plane_compute_hook_api {
308 0 : args.push(format!(
309 0 : "--compute-hook-url={control_plane_compute_hook_api}"
310 0 : ));
311 0 : }
312 :
313 0 : if let Some(split_threshold) = self.config.split_threshold.as_ref() {
314 0 : args.push(format!("--split-threshold={split_threshold}"))
315 0 : }
316 :
317 0 : args.push(format!(
318 0 : "--neon-local-repo-dir={}",
319 0 : self.env.base_data_dir.display()
320 0 : ));
321 0 :
322 0 : background_process::start_process(
323 0 : COMMAND,
324 0 : &self.env.base_data_dir,
325 0 : &self.env.storage_controller_bin(),
326 0 : args,
327 0 : [],
328 0 : background_process::InitialPidFile::Create(self.pid_file()),
329 0 : retry_timeout,
330 0 : || async {
331 0 : match self.ready().await {
332 0 : Ok(_) => Ok(true),
333 0 : Err(_) => Ok(false),
334 0 : }
335 0 : },
336 0 : )
337 0 : .await?;
338 :
339 0 : Ok(())
340 0 : }
341 :
342 0 : pub async fn stop(&self, immediate: bool) -> anyhow::Result<()> {
343 0 : background_process::stop_process(immediate, COMMAND, &self.pid_file())?;
344 :
345 0 : let pg_data_path = self.env.base_data_dir.join("storage_controller_db");
346 0 : let pg_bin_dir = self.get_pg_bin_dir().await?;
347 :
348 0 : println!("Stopping storage controller database...");
349 0 : let pg_stop_args = ["-D", &pg_data_path.to_string_lossy(), "stop"];
350 0 : let stop_status = Command::new(pg_bin_dir.join("pg_ctl"))
351 0 : .args(pg_stop_args)
352 0 : .spawn()?
353 0 : .wait()
354 0 : .await?;
355 0 : if !stop_status.success() {
356 0 : let pg_status_args = ["-D", &pg_data_path.to_string_lossy(), "status"];
357 0 : let status_exitcode = Command::new(pg_bin_dir.join("pg_ctl"))
358 0 : .args(pg_status_args)
359 0 : .spawn()?
360 0 : .wait()
361 0 : .await?;
362 :
363 : // pg_ctl status returns this exit code if postgres is not running: in this case it is
364 : // fine that stop failed. Otherwise it is an error that stop failed.
365 : const PG_STATUS_NOT_RUNNING: i32 = 3;
366 0 : if Some(PG_STATUS_NOT_RUNNING) == status_exitcode.code() {
367 0 : println!("Storage controller database is already stopped");
368 0 : return Ok(());
369 : } else {
370 0 : anyhow::bail!("Failed to stop storage controller database: {stop_status}")
371 : }
372 0 : }
373 0 :
374 0 : Ok(())
375 0 : }
376 :
377 0 : fn get_claims_for_path(path: &str) -> anyhow::Result<Option<Claims>> {
378 0 : let category = match path.find('/') {
379 0 : Some(idx) => &path[..idx],
380 0 : None => path,
381 : };
382 :
383 0 : match category {
384 0 : "status" | "ready" => Ok(None),
385 0 : "control" | "debug" => Ok(Some(Claims::new(None, Scope::Admin))),
386 0 : "v1" => Ok(Some(Claims::new(None, Scope::PageServerApi))),
387 0 : _ => Err(anyhow::anyhow!("Failed to determine claims for {}", path)),
388 : }
389 0 : }
390 :
391 : /// Simple HTTP request wrapper for calling into storage controller
392 0 : async fn dispatch<RQ, RS>(
393 0 : &self,
394 0 : method: reqwest::Method,
395 0 : path: String,
396 0 : body: Option<RQ>,
397 0 : ) -> anyhow::Result<RS>
398 0 : where
399 0 : RQ: Serialize + Sized,
400 0 : RS: DeserializeOwned + Sized,
401 0 : {
402 0 : // The configured URL has the /upcall path prefix for pageservers to use: we will strip that out
403 0 : // for general purpose API access.
404 0 : let listen_url = self.env.control_plane_api.clone().unwrap();
405 0 : let url = Url::from_str(&format!(
406 0 : "http://{}:{}/{path}",
407 0 : listen_url.host_str().unwrap(),
408 0 : listen_url.port().unwrap()
409 0 : ))
410 0 : .unwrap();
411 0 :
412 0 : let mut builder = self.client.request(method, url);
413 0 : if let Some(body) = body {
414 0 : builder = builder.json(&body)
415 0 : }
416 0 : if let Some(private_key) = &self.private_key {
417 0 : println!("Getting claims for path {}", path);
418 0 : if let Some(required_claims) = Self::get_claims_for_path(&path)? {
419 0 : println!("Got claims {:?} for path {}", required_claims, path);
420 0 : let jwt_token = encode_from_key_file(&required_claims, private_key)?;
421 0 : builder = builder.header(
422 0 : reqwest::header::AUTHORIZATION,
423 0 : format!("Bearer {jwt_token}"),
424 0 : );
425 0 : }
426 0 : }
427 :
428 0 : let response = builder.send().await?;
429 0 : let response = response.error_from_body().await?;
430 :
431 0 : Ok(response
432 0 : .json()
433 0 : .await
434 0 : .map_err(pageserver_client::mgmt_api::Error::ReceiveBody)?)
435 0 : }
436 :
437 : /// Call into the attach_hook API, for use before handing out attachments to pageservers
438 0 : #[instrument(skip(self))]
439 : pub async fn attach_hook(
440 : &self,
441 : tenant_shard_id: TenantShardId,
442 : pageserver_id: NodeId,
443 : ) -> anyhow::Result<Option<u32>> {
444 : let request = AttachHookRequest {
445 : tenant_shard_id,
446 : node_id: Some(pageserver_id),
447 : generation_override: None,
448 : };
449 :
450 : let response = self
451 : .dispatch::<_, AttachHookResponse>(
452 : Method::POST,
453 : "debug/v1/attach-hook".to_string(),
454 : Some(request),
455 : )
456 : .await?;
457 :
458 : Ok(response.gen)
459 : }
460 :
461 0 : #[instrument(skip(self))]
462 : pub async fn inspect(
463 : &self,
464 : tenant_shard_id: TenantShardId,
465 : ) -> anyhow::Result<Option<(u32, NodeId)>> {
466 : let request = InspectRequest { tenant_shard_id };
467 :
468 : let response = self
469 : .dispatch::<_, InspectResponse>(
470 : Method::POST,
471 : "debug/v1/inspect".to_string(),
472 : Some(request),
473 : )
474 : .await?;
475 :
476 : Ok(response.attachment)
477 : }
478 :
479 0 : #[instrument(skip(self))]
480 : pub async fn tenant_create(
481 : &self,
482 : req: TenantCreateRequest,
483 : ) -> anyhow::Result<TenantCreateResponse> {
484 : self.dispatch(Method::POST, "v1/tenant".to_string(), Some(req))
485 : .await
486 : }
487 :
488 0 : #[instrument(skip(self))]
489 : pub async fn tenant_import(&self, tenant_id: TenantId) -> anyhow::Result<TenantCreateResponse> {
490 : self.dispatch::<(), TenantCreateResponse>(
491 : Method::POST,
492 : format!("debug/v1/tenant/{tenant_id}/import"),
493 : None,
494 : )
495 : .await
496 : }
497 :
498 0 : #[instrument(skip(self))]
499 : pub async fn tenant_locate(&self, tenant_id: TenantId) -> anyhow::Result<TenantLocateResponse> {
500 : self.dispatch::<(), _>(
501 : Method::GET,
502 : format!("debug/v1/tenant/{tenant_id}/locate"),
503 : None,
504 : )
505 : .await
506 : }
507 :
508 0 : #[instrument(skip(self))]
509 : pub async fn tenant_migrate(
510 : &self,
511 : tenant_shard_id: TenantShardId,
512 : node_id: NodeId,
513 : ) -> anyhow::Result<TenantShardMigrateResponse> {
514 : self.dispatch(
515 : Method::PUT,
516 : format!("control/v1/tenant/{tenant_shard_id}/migrate"),
517 : Some(TenantShardMigrateRequest {
518 : tenant_shard_id,
519 : node_id,
520 : }),
521 : )
522 : .await
523 : }
524 :
525 0 : #[instrument(skip(self), fields(%tenant_id, %new_shard_count))]
526 : pub async fn tenant_split(
527 : &self,
528 : tenant_id: TenantId,
529 : new_shard_count: u8,
530 : new_stripe_size: Option<ShardStripeSize>,
531 : ) -> anyhow::Result<TenantShardSplitResponse> {
532 : self.dispatch(
533 : Method::PUT,
534 : format!("control/v1/tenant/{tenant_id}/shard_split"),
535 : Some(TenantShardSplitRequest {
536 : new_shard_count,
537 : new_stripe_size,
538 : }),
539 : )
540 : .await
541 : }
542 :
543 0 : #[instrument(skip_all, fields(node_id=%req.node_id))]
544 : pub async fn node_register(&self, req: NodeRegisterRequest) -> anyhow::Result<()> {
545 : self.dispatch::<_, ()>(Method::POST, "control/v1/node".to_string(), Some(req))
546 : .await
547 : }
548 :
549 0 : #[instrument(skip_all, fields(node_id=%req.node_id))]
550 : pub async fn node_configure(&self, req: NodeConfigureRequest) -> anyhow::Result<()> {
551 : self.dispatch::<_, ()>(
552 : Method::PUT,
553 : format!("control/v1/node/{}/config", req.node_id),
554 : Some(req),
555 : )
556 : .await
557 : }
558 :
559 0 : #[instrument(skip(self))]
560 : pub async fn ready(&self) -> anyhow::Result<()> {
561 : self.dispatch::<(), ()>(Method::GET, "ready".to_string(), None)
562 : .await
563 : }
564 :
565 0 : #[instrument(skip_all, fields(%tenant_id, timeline_id=%req.new_timeline_id))]
566 : pub async fn tenant_timeline_create(
567 : &self,
568 : tenant_id: TenantId,
569 : req: TimelineCreateRequest,
570 : ) -> anyhow::Result<TimelineInfo> {
571 : self.dispatch(
572 : Method::POST,
573 : format!("v1/tenant/{tenant_id}/timeline"),
574 : Some(req),
575 : )
576 : .await
577 : }
578 : }
|
