Line data Source code
1 : #![deny(unsafe_code)]
2 : #![deny(clippy::undocumented_unsafe_blocks)]
3 : pub mod checks;
4 : pub mod cloud_admin_api;
5 : pub mod garbage;
6 : pub mod metadata_stream;
7 : pub mod pageserver_physical_gc;
8 : pub mod scan_pageserver_metadata;
9 : pub mod scan_safekeeper_metadata;
10 : pub mod tenant_snapshot;
11 :
12 : use std::env;
13 : use std::fmt::Display;
14 : use std::sync::Arc;
15 : use std::time::Duration;
16 :
17 : use anyhow::Context;
18 : use aws_config::environment::EnvironmentVariableCredentialsProvider;
19 : use aws_config::imds::credentials::ImdsCredentialsProvider;
20 : use aws_config::meta::credentials::CredentialsProviderChain;
21 : use aws_config::profile::ProfileFileCredentialsProvider;
22 : use aws_config::retry::RetryConfig;
23 : use aws_config::sso::SsoCredentialsProvider;
24 : use aws_config::BehaviorVersion;
25 : use aws_sdk_s3::config::{AsyncSleep, Region, SharedAsyncSleep};
26 : use aws_sdk_s3::{Client, Config};
27 : use aws_smithy_async::rt::sleep::TokioSleep;
28 :
29 : use camino::{Utf8Path, Utf8PathBuf};
30 : use clap::ValueEnum;
31 : use pageserver::tenant::TENANTS_SEGMENT_NAME;
32 : use pageserver_api::shard::TenantShardId;
33 : use reqwest::Url;
34 : use serde::{Deserialize, Serialize};
35 : use tokio::io::AsyncReadExt;
36 : use tracing::error;
37 : use tracing_appender::non_blocking::WorkerGuard;
38 : use tracing_subscriber::{fmt, prelude::*, EnvFilter};
39 : use utils::fs_ext;
40 : use utils::id::{TenantId, TimelineId};
41 :
42 : const MAX_RETRIES: usize = 20;
43 : const CLOUD_ADMIN_API_TOKEN_ENV_VAR: &str = "CLOUD_ADMIN_API_TOKEN";
44 :
45 : #[derive(Debug, Clone)]
46 : pub struct S3Target {
47 : pub bucket_name: String,
48 : /// This `prefix_in_bucket` is only equal to the PS/SK config of the same
49 : /// name for the RootTarget: other instances of S3Target will have prefix_in_bucket
50 : /// with extra parts.
51 : pub prefix_in_bucket: String,
52 : pub delimiter: String,
53 : }
54 :
55 : /// Convenience for referring to timelines within a particular shard: more ergonomic
56 : /// than using a 2-tuple.
57 : ///
58 : /// This is the shard-aware equivalent of TenantTimelineId. It's defined here rather
59 : /// than somewhere more broadly exposed, because this kind of thing is rarely needed
60 : /// in the pageserver, as all timeline objects existing in the scope of a particular
61 : /// tenant: the scrubber is different in that it handles collections of data referring to many
62 : /// TenantShardTimelineIds in on place.
63 0 : #[derive(Serialize, Deserialize, Debug, Clone, Copy, Hash, PartialEq, Eq)]
64 : pub struct TenantShardTimelineId {
65 : tenant_shard_id: TenantShardId,
66 : timeline_id: TimelineId,
67 : }
68 :
69 : impl TenantShardTimelineId {
70 0 : fn new(tenant_shard_id: TenantShardId, timeline_id: TimelineId) -> Self {
71 0 : Self {
72 0 : tenant_shard_id,
73 0 : timeline_id,
74 0 : }
75 0 : }
76 : }
77 :
78 : impl Display for TenantShardTimelineId {
79 0 : fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
80 0 : write!(f, "{}/{}", self.tenant_shard_id, self.timeline_id)
81 0 : }
82 : }
83 :
84 0 : #[derive(clap::ValueEnum, Debug, Clone, Copy, PartialEq, Eq)]
85 : pub enum TraversingDepth {
86 : Tenant,
87 : Timeline,
88 : }
89 :
90 : impl Display for TraversingDepth {
91 0 : fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
92 0 : f.write_str(match self {
93 0 : Self::Tenant => "tenant",
94 0 : Self::Timeline => "timeline",
95 : })
96 0 : }
97 : }
98 :
99 0 : #[derive(ValueEnum, Clone, Copy, Eq, PartialEq, Debug, Serialize, Deserialize)]
100 : pub enum NodeKind {
101 : Safekeeper,
102 : Pageserver,
103 : }
104 :
105 : impl NodeKind {
106 0 : fn as_str(&self) -> &'static str {
107 0 : match self {
108 0 : Self::Safekeeper => "safekeeper",
109 0 : Self::Pageserver => "pageserver",
110 : }
111 0 : }
112 : }
113 :
114 : impl Display for NodeKind {
115 0 : fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
116 0 : f.write_str(self.as_str())
117 0 : }
118 : }
119 :
120 : impl S3Target {
121 0 : pub fn with_sub_segment(&self, new_segment: &str) -> Self {
122 0 : let mut new_self = self.clone();
123 0 : if new_self.prefix_in_bucket.is_empty() {
124 0 : new_self.prefix_in_bucket = format!("/{}/", new_segment);
125 0 : } else {
126 0 : if new_self.prefix_in_bucket.ends_with('/') {
127 0 : new_self.prefix_in_bucket.pop();
128 0 : }
129 0 : new_self.prefix_in_bucket =
130 0 : [&new_self.prefix_in_bucket, new_segment, ""].join(&new_self.delimiter);
131 : }
132 0 : new_self
133 0 : }
134 : }
135 :
136 : #[derive(Clone)]
137 : pub enum RootTarget {
138 : Pageserver(S3Target),
139 : Safekeeper(S3Target),
140 : }
141 :
142 : impl RootTarget {
143 0 : pub fn tenants_root(&self) -> S3Target {
144 0 : match self {
145 0 : Self::Pageserver(root) => root.with_sub_segment(TENANTS_SEGMENT_NAME),
146 0 : Self::Safekeeper(root) => root.clone(),
147 : }
148 0 : }
149 :
150 0 : pub fn tenant_root(&self, tenant_id: &TenantShardId) -> S3Target {
151 0 : match self {
152 0 : Self::Pageserver(_) => self.tenants_root().with_sub_segment(&tenant_id.to_string()),
153 0 : Self::Safekeeper(_) => self
154 0 : .tenants_root()
155 0 : .with_sub_segment(&tenant_id.tenant_id.to_string()),
156 : }
157 0 : }
158 :
159 0 : pub(crate) fn tenant_shards_prefix(&self, tenant_id: &TenantId) -> S3Target {
160 0 : // Only pageserver remote storage contains tenant-shards
161 0 : assert!(matches!(self, Self::Pageserver(_)));
162 0 : let Self::Pageserver(root) = self else {
163 0 : panic!();
164 : };
165 :
166 0 : S3Target {
167 0 : bucket_name: root.bucket_name.clone(),
168 0 : prefix_in_bucket: format!(
169 0 : "{}/{TENANTS_SEGMENT_NAME}/{tenant_id}",
170 0 : root.prefix_in_bucket
171 0 : ),
172 0 : delimiter: root.delimiter.clone(),
173 0 : }
174 0 : }
175 :
176 0 : pub fn timelines_root(&self, tenant_id: &TenantShardId) -> S3Target {
177 0 : match self {
178 0 : Self::Pageserver(_) => self.tenant_root(tenant_id).with_sub_segment("timelines"),
179 0 : Self::Safekeeper(_) => self.tenant_root(tenant_id),
180 : }
181 0 : }
182 :
183 0 : pub fn timeline_root(&self, id: &TenantShardTimelineId) -> S3Target {
184 0 : self.timelines_root(&id.tenant_shard_id)
185 0 : .with_sub_segment(&id.timeline_id.to_string())
186 0 : }
187 :
188 0 : pub fn bucket_name(&self) -> &str {
189 0 : match self {
190 0 : Self::Pageserver(root) => &root.bucket_name,
191 0 : Self::Safekeeper(root) => &root.bucket_name,
192 : }
193 0 : }
194 :
195 0 : pub fn delimiter(&self) -> &str {
196 0 : match self {
197 0 : Self::Pageserver(root) => &root.delimiter,
198 0 : Self::Safekeeper(root) => &root.delimiter,
199 : }
200 0 : }
201 : }
202 :
203 0 : #[derive(Debug, Clone, Serialize, Deserialize)]
204 : #[serde(deny_unknown_fields)]
205 : pub struct BucketConfig {
206 : pub region: String,
207 : pub bucket: String,
208 : pub prefix_in_bucket: Option<String>,
209 : }
210 :
211 : impl BucketConfig {
212 0 : pub fn from_env() -> anyhow::Result<Self> {
213 0 : let region = env::var("REGION").context("'REGION' param retrieval")?;
214 0 : let bucket = env::var("BUCKET").context("'BUCKET' param retrieval")?;
215 0 : let prefix_in_bucket = env::var("BUCKET_PREFIX").ok();
216 0 :
217 0 : Ok(Self {
218 0 : region,
219 0 : bucket,
220 0 : prefix_in_bucket,
221 0 : })
222 0 : }
223 : }
224 :
225 : pub struct ConsoleConfig {
226 : pub token: String,
227 : pub base_url: Url,
228 : }
229 :
230 : impl ConsoleConfig {
231 0 : pub fn from_env() -> anyhow::Result<Self> {
232 0 : let base_url: Url = env::var("CLOUD_ADMIN_API_URL")
233 0 : .context("'CLOUD_ADMIN_API_URL' param retrieval")?
234 0 : .parse()
235 0 : .context("'CLOUD_ADMIN_API_URL' param parsing")?;
236 :
237 0 : let token = env::var(CLOUD_ADMIN_API_TOKEN_ENV_VAR)
238 0 : .context("'CLOUD_ADMIN_API_TOKEN' environment variable fetch")?;
239 :
240 0 : Ok(Self { base_url, token })
241 0 : }
242 : }
243 :
244 0 : pub fn init_logging(file_name: &str) -> WorkerGuard {
245 0 : let (file_writer, guard) =
246 0 : tracing_appender::non_blocking(tracing_appender::rolling::never("./logs/", file_name));
247 0 :
248 0 : let file_logs = fmt::Layer::new()
249 0 : .with_target(false)
250 0 : .with_ansi(false)
251 0 : .with_writer(file_writer);
252 0 : let stderr_logs = fmt::Layer::new()
253 0 : .with_target(false)
254 0 : .with_writer(std::io::stderr);
255 0 : tracing_subscriber::registry()
256 0 : .with(EnvFilter::try_from_default_env().unwrap_or_else(|_| EnvFilter::new("info")))
257 0 : .with(file_logs)
258 0 : .with(stderr_logs)
259 0 : .init();
260 0 :
261 0 : guard
262 0 : }
263 :
264 0 : pub fn init_s3_client(bucket_region: Region) -> Client {
265 0 : let credentials_provider = {
266 : // uses "AWS_ACCESS_KEY_ID", "AWS_SECRET_ACCESS_KEY"
267 0 : let chain = CredentialsProviderChain::first_try(
268 0 : "env",
269 0 : EnvironmentVariableCredentialsProvider::new(),
270 0 : )
271 0 : // uses "AWS_PROFILE" / `aws sso login --profile <profile>`
272 0 : .or_else(
273 0 : "profile-sso",
274 0 : ProfileFileCredentialsProvider::builder().build(),
275 0 : );
276 0 :
277 0 : // Use SSO if we were given an account ID
278 0 : match std::env::var("SSO_ACCOUNT_ID").ok() {
279 0 : Some(sso_account) => chain.or_else(
280 0 : "sso",
281 0 : SsoCredentialsProvider::builder()
282 0 : .account_id(sso_account)
283 0 : .role_name("PowerUserAccess")
284 0 : .start_url("https://neondb.awsapps.com/start")
285 0 : .region(bucket_region.clone())
286 0 : .build(),
287 0 : ),
288 0 : None => chain,
289 : }
290 0 : .or_else(
291 0 : // Finally try IMDS
292 0 : "imds",
293 0 : ImdsCredentialsProvider::builder().build(),
294 0 : )
295 0 : };
296 0 :
297 0 : let sleep_impl: Arc<dyn AsyncSleep> = Arc::new(TokioSleep::new());
298 0 :
299 0 : let mut builder = Config::builder()
300 0 : .behavior_version(
301 0 : #[allow(deprecated)] /* TODO: https://github.com/neondatabase/neon/issues/7665 */
302 0 : BehaviorVersion::v2023_11_09(),
303 0 : )
304 0 : .region(bucket_region)
305 0 : .retry_config(RetryConfig::adaptive().with_max_attempts(3))
306 0 : .sleep_impl(SharedAsyncSleep::from(sleep_impl))
307 0 : .credentials_provider(credentials_provider);
308 :
309 0 : if let Ok(endpoint) = env::var("AWS_ENDPOINT_URL") {
310 0 : builder = builder.endpoint_url(endpoint)
311 0 : }
312 :
313 0 : Client::from_conf(builder.build())
314 0 : }
315 :
316 0 : fn init_remote(
317 0 : bucket_config: BucketConfig,
318 0 : node_kind: NodeKind,
319 0 : ) -> anyhow::Result<(Arc<Client>, RootTarget)> {
320 0 : let bucket_region = Region::new(bucket_config.region);
321 0 : let delimiter = "/".to_string();
322 0 : let s3_client = Arc::new(init_s3_client(bucket_region));
323 :
324 0 : let s3_root = match node_kind {
325 0 : NodeKind::Pageserver => RootTarget::Pageserver(S3Target {
326 0 : bucket_name: bucket_config.bucket,
327 0 : prefix_in_bucket: bucket_config
328 0 : .prefix_in_bucket
329 0 : .unwrap_or("pageserver/v1".to_string()),
330 0 : delimiter,
331 0 : }),
332 0 : NodeKind::Safekeeper => RootTarget::Safekeeper(S3Target {
333 0 : bucket_name: bucket_config.bucket,
334 0 : prefix_in_bucket: bucket_config.prefix_in_bucket.unwrap_or("wal/".to_string()),
335 0 : delimiter,
336 0 : }),
337 : };
338 :
339 0 : Ok((s3_client, s3_root))
340 0 : }
341 :
342 0 : async fn list_objects_with_retries(
343 0 : s3_client: &Client,
344 0 : s3_target: &S3Target,
345 0 : continuation_token: Option<String>,
346 0 : ) -> anyhow::Result<aws_sdk_s3::operation::list_objects_v2::ListObjectsV2Output> {
347 0 : for _ in 0..MAX_RETRIES {
348 0 : match s3_client
349 0 : .list_objects_v2()
350 0 : .bucket(&s3_target.bucket_name)
351 0 : .prefix(&s3_target.prefix_in_bucket)
352 0 : .delimiter(&s3_target.delimiter)
353 0 : .set_continuation_token(continuation_token.clone())
354 0 : .send()
355 0 : .await
356 : {
357 0 : Ok(response) => return Ok(response),
358 0 : Err(e) => {
359 0 : error!(
360 0 : "list_objects_v2 query failed: {e}, bucket_name={}, prefix={}, delimiter={}",
361 : s3_target.bucket_name, s3_target.prefix_in_bucket, s3_target.delimiter
362 : );
363 0 : tokio::time::sleep(Duration::from_secs(1)).await;
364 : }
365 : }
366 : }
367 :
368 0 : anyhow::bail!("Failed to list objects {MAX_RETRIES} times")
369 0 : }
370 :
371 0 : async fn download_object_with_retries(
372 0 : s3_client: &Client,
373 0 : bucket_name: &str,
374 0 : key: &str,
375 0 : ) -> anyhow::Result<Vec<u8>> {
376 0 : for _ in 0..MAX_RETRIES {
377 0 : let mut body_buf = Vec::new();
378 0 : let response_stream = match s3_client
379 0 : .get_object()
380 0 : .bucket(bucket_name)
381 0 : .key(key)
382 0 : .send()
383 0 : .await
384 : {
385 0 : Ok(response) => response,
386 0 : Err(e) => {
387 0 : error!("Failed to download object for key {key}: {e}");
388 0 : tokio::time::sleep(Duration::from_secs(1)).await;
389 0 : continue;
390 : }
391 : };
392 :
393 0 : match response_stream
394 0 : .body
395 0 : .into_async_read()
396 0 : .read_to_end(&mut body_buf)
397 0 : .await
398 : {
399 0 : Ok(bytes_read) => {
400 0 : tracing::debug!("Downloaded {bytes_read} bytes for object {key}");
401 0 : return Ok(body_buf);
402 : }
403 0 : Err(e) => {
404 0 : error!("Failed to stream object body for key {key}: {e}");
405 0 : tokio::time::sleep(Duration::from_secs(1)).await;
406 : }
407 : }
408 : }
409 :
410 0 : anyhow::bail!("Failed to download objects with key {key} {MAX_RETRIES} times")
411 0 : }
412 :
413 0 : async fn download_object_to_file(
414 0 : s3_client: &Client,
415 0 : bucket_name: &str,
416 0 : key: &str,
417 0 : version_id: Option<&str>,
418 0 : local_path: &Utf8Path,
419 0 : ) -> anyhow::Result<()> {
420 0 : let tmp_path = Utf8PathBuf::from(format!("{local_path}.tmp"));
421 0 : for _ in 0..MAX_RETRIES {
422 0 : tokio::fs::remove_file(&tmp_path)
423 0 : .await
424 0 : .or_else(fs_ext::ignore_not_found)?;
425 :
426 0 : let mut file = tokio::fs::File::create(&tmp_path)
427 0 : .await
428 0 : .context("Opening output file")?;
429 :
430 0 : let request = s3_client.get_object().bucket(bucket_name).key(key);
431 :
432 0 : let request = match version_id {
433 0 : Some(version_id) => request.version_id(version_id),
434 0 : None => request,
435 : };
436 :
437 0 : let response_stream = match request.send().await {
438 0 : Ok(response) => response,
439 0 : Err(e) => {
440 0 : error!(
441 0 : "Failed to download object for key {key} version {}: {e:#}",
442 0 : version_id.unwrap_or("")
443 : );
444 0 : tokio::time::sleep(Duration::from_secs(1)).await;
445 0 : continue;
446 : }
447 : };
448 :
449 0 : let mut read_stream = response_stream.body.into_async_read();
450 0 :
451 0 : tokio::io::copy(&mut read_stream, &mut file).await?;
452 :
453 0 : tokio::fs::rename(&tmp_path, local_path).await?;
454 0 : return Ok(());
455 : }
456 :
457 0 : anyhow::bail!("Failed to download objects with key {key} {MAX_RETRIES} times")
458 0 : }
|
