Line data Source code
1 : use std::{
2 : borrow::Cow,
3 : cmp::Ordering,
4 : collections::{BTreeMap, HashMap, HashSet},
5 : path::PathBuf,
6 : str::FromStr,
7 : sync::Arc,
8 : time::{Duration, Instant},
9 : };
10 :
11 : use crate::{
12 : background_node_operations::{
13 : Drain, Fill, Operation, OperationError, OperationHandler, MAX_RECONCILES_PER_OPERATION,
14 : },
15 : compute_hook::NotifyError,
16 : id_lock_map::{trace_exclusive_lock, trace_shared_lock, IdLockMap, TracingExclusiveGuard},
17 : persistence::{AbortShardSplitStatus, TenantFilter},
18 : reconciler::{ReconcileError, ReconcileUnits},
19 : scheduler::{MaySchedule, ScheduleContext, ScheduleMode},
20 : tenant_shard::{
21 : MigrateAttachment, ReconcileNeeded, ReconcilerStatus, ScheduleOptimization,
22 : ScheduleOptimizationAction,
23 : },
24 : };
25 : use anyhow::Context;
26 : use control_plane::storage_controller::{
27 : AttachHookRequest, AttachHookResponse, InspectRequest, InspectResponse,
28 : };
29 : use diesel::result::DatabaseErrorKind;
30 : use futures::{stream::FuturesUnordered, StreamExt};
31 : use itertools::Itertools;
32 : use pageserver_api::{
33 : controller_api::{
34 : NodeAvailability, NodeRegisterRequest, NodeSchedulingPolicy, PlacementPolicy,
35 : ShardSchedulingPolicy, TenantCreateRequest, TenantCreateResponse,
36 : TenantCreateResponseShard, TenantDescribeResponse, TenantDescribeResponseShard,
37 : TenantLocateResponse, TenantPolicyRequest, TenantShardMigrateRequest,
38 : TenantShardMigrateResponse, UtilizationScore,
39 : },
40 : models::{SecondaryProgress, TenantConfigRequest, TopTenantShardsRequest},
41 : };
42 : use reqwest::StatusCode;
43 : use tracing::{instrument, Instrument};
44 :
45 : use crate::pageserver_client::PageserverClient;
46 : use pageserver_api::{
47 : models::{
48 : self, LocationConfig, LocationConfigListResponse, LocationConfigMode,
49 : PageserverUtilization, ShardParameters, TenantConfig, TenantLocationConfigRequest,
50 : TenantLocationConfigResponse, TenantShardLocation, TenantShardSplitRequest,
51 : TenantShardSplitResponse, TenantTimeTravelRequest, TimelineCreateRequest, TimelineInfo,
52 : },
53 : shard::{ShardCount, ShardIdentity, ShardNumber, ShardStripeSize, TenantShardId},
54 : upcall_api::{
55 : ReAttachRequest, ReAttachResponse, ReAttachResponseTenant, ValidateRequest,
56 : ValidateResponse, ValidateResponseTenant,
57 : },
58 : };
59 : use pageserver_client::mgmt_api;
60 : use tokio::sync::mpsc::error::TrySendError;
61 : use tokio_util::sync::CancellationToken;
62 : use utils::{
63 : completion::Barrier,
64 : failpoint_support,
65 : generation::Generation,
66 : http::error::ApiError,
67 : id::{NodeId, TenantId, TimelineId},
68 : sync::gate::Gate,
69 : };
70 :
71 : use crate::{
72 : compute_hook::ComputeHook,
73 : heartbeater::{Heartbeater, PageserverState},
74 : node::{AvailabilityTransition, Node},
75 : persistence::{split_state::SplitState, DatabaseError, Persistence, TenantShardPersistence},
76 : reconciler::attached_location_conf,
77 : scheduler::Scheduler,
78 : tenant_shard::{
79 : IntentState, ObservedState, ObservedStateLocation, ReconcileResult, ReconcileWaitError,
80 : ReconcilerWaiter, TenantShard,
81 : },
82 : };
83 :
84 : // For operations that should be quick, like attaching a new tenant
85 : const SHORT_RECONCILE_TIMEOUT: Duration = Duration::from_secs(5);
86 :
87 : // For operations that might be slow, like migrating a tenant with
88 : // some data in it.
89 : pub const RECONCILE_TIMEOUT: Duration = Duration::from_secs(30);
90 :
91 : // If we receive a call using Secondary mode initially, it will omit generation. We will initialize
92 : // tenant shards into this generation, and as long as it remains in this generation, we will accept
93 : // input generation from future requests as authoritative.
94 : const INITIAL_GENERATION: Generation = Generation::new(0);
95 :
96 : /// How long [`Service::startup_reconcile`] is allowed to take before it should give
97 : /// up on unresponsive pageservers and proceed.
98 : pub(crate) const STARTUP_RECONCILE_TIMEOUT: Duration = Duration::from_secs(30);
99 :
100 : /// How long a node may be unresponsive to heartbeats before we declare it offline.
101 : /// This must be long enough to cover node restarts as well as normal operations: in future
102 : /// it should be separated into distinct timeouts for startup vs. normal operation
103 : /// (`<https://github.com/neondatabase/neon/issues/7552>`)
104 : pub const MAX_UNAVAILABLE_INTERVAL_DEFAULT: Duration = Duration::from_secs(300);
105 :
106 0 : #[derive(Clone, strum_macros::Display)]
107 : enum TenantOperations {
108 : Create,
109 : LocationConfig,
110 : ConfigSet,
111 : TimeTravelRemoteStorage,
112 : Delete,
113 : UpdatePolicy,
114 : ShardSplit,
115 : SecondaryDownload,
116 : TimelineCreate,
117 : TimelineDelete,
118 : }
119 :
120 0 : #[derive(Clone, strum_macros::Display)]
121 : enum NodeOperations {
122 : Register,
123 : Configure,
124 : }
125 :
126 : pub const RECONCILER_CONCURRENCY_DEFAULT: usize = 128;
127 :
128 : // Depth of the channel used to enqueue shards for reconciliation when they can't do it immediately.
129 : // This channel is finite-size to avoid using excessive memory if we get into a state where reconciles are finishing more slowly
130 : // than they're being pushed onto the queue.
131 : const MAX_DELAYED_RECONCILES: usize = 10000;
132 :
133 : // Top level state available to all HTTP handlers
134 : struct ServiceState {
135 : tenants: BTreeMap<TenantShardId, TenantShard>,
136 :
137 : nodes: Arc<HashMap<NodeId, Node>>,
138 :
139 : scheduler: Scheduler,
140 :
141 : /// Ongoing background operation on the cluster if any is running.
142 : /// Note that only one such operation may run at any given time,
143 : /// hence the type choice.
144 : ongoing_operation: Option<OperationHandler>,
145 :
146 : /// Queue of tenants who are waiting for concurrency limits to permit them to reconcile
147 : delayed_reconcile_rx: tokio::sync::mpsc::Receiver<TenantShardId>,
148 : }
149 :
150 : /// Transform an error from a pageserver into an error to return to callers of a storage
151 : /// controller API.
152 0 : fn passthrough_api_error(node: &Node, e: mgmt_api::Error) -> ApiError {
153 0 : match e {
154 0 : mgmt_api::Error::ReceiveErrorBody(str) => {
155 0 : // Presume errors receiving body are connectivity/availability issues
156 0 : ApiError::ResourceUnavailable(
157 0 : format!("{node} error receiving error body: {str}").into(),
158 0 : )
159 : }
160 0 : mgmt_api::Error::ReceiveBody(str) => {
161 0 : // Presume errors receiving body are connectivity/availability issues
162 0 : ApiError::ResourceUnavailable(format!("{node} error receiving body: {str}").into())
163 : }
164 0 : mgmt_api::Error::ApiError(StatusCode::NOT_FOUND, msg) => {
165 0 : ApiError::NotFound(anyhow::anyhow!(format!("{node}: {msg}")).into())
166 : }
167 0 : mgmt_api::Error::ApiError(StatusCode::SERVICE_UNAVAILABLE, msg) => {
168 0 : ApiError::ResourceUnavailable(format!("{node}: {msg}").into())
169 : }
170 0 : mgmt_api::Error::ApiError(status @ StatusCode::UNAUTHORIZED, msg)
171 0 : | mgmt_api::Error::ApiError(status @ StatusCode::FORBIDDEN, msg) => {
172 : // Auth errors talking to a pageserver are not auth errors for the caller: they are
173 : // internal server errors, showing that something is wrong with the pageserver or
174 : // storage controller's auth configuration.
175 0 : ApiError::InternalServerError(anyhow::anyhow!("{node} {status}: {msg}"))
176 : }
177 0 : mgmt_api::Error::ApiError(status, msg) => {
178 0 : // Presume general case of pageserver API errors is that we tried to do something
179 0 : // that can't be done right now.
180 0 : ApiError::Conflict(format!("{node} {status}: {status} {msg}"))
181 : }
182 0 : mgmt_api::Error::Cancelled => ApiError::ShuttingDown,
183 : }
184 0 : }
185 :
186 : impl ServiceState {
187 0 : fn new(
188 0 : nodes: HashMap<NodeId, Node>,
189 0 : tenants: BTreeMap<TenantShardId, TenantShard>,
190 0 : scheduler: Scheduler,
191 0 : delayed_reconcile_rx: tokio::sync::mpsc::Receiver<TenantShardId>,
192 0 : ) -> Self {
193 0 : Self {
194 0 : tenants,
195 0 : nodes: Arc::new(nodes),
196 0 : scheduler,
197 0 : ongoing_operation: None,
198 0 : delayed_reconcile_rx,
199 0 : }
200 0 : }
201 :
202 0 : fn parts_mut(
203 0 : &mut self,
204 0 : ) -> (
205 0 : &mut Arc<HashMap<NodeId, Node>>,
206 0 : &mut BTreeMap<TenantShardId, TenantShard>,
207 0 : &mut Scheduler,
208 0 : ) {
209 0 : (&mut self.nodes, &mut self.tenants, &mut self.scheduler)
210 0 : }
211 : }
212 :
213 : #[derive(Clone)]
214 : pub struct Config {
215 : // All pageservers managed by one instance of this service must have
216 : // the same public key. This JWT token will be used to authenticate
217 : // this service to the pageservers it manages.
218 : pub jwt_token: Option<String>,
219 :
220 : // This JWT token will be used to authenticate this service to the control plane.
221 : pub control_plane_jwt_token: Option<String>,
222 :
223 : /// Where the compute hook should send notifications of pageserver attachment locations
224 : /// (this URL points to the control plane in prod). If this is None, the compute hook will
225 : /// assume it is running in a test environment and try to update neon_local.
226 : pub compute_hook_url: Option<String>,
227 :
228 : /// Grace period within which a pageserver does not respond to heartbeats, but is still
229 : /// considered active. Once the grace period elapses, the next heartbeat failure will
230 : /// mark the pagseserver offline.
231 : pub max_unavailable_interval: Duration,
232 :
233 : /// How many Reconcilers may be spawned concurrently
234 : pub reconciler_concurrency: usize,
235 :
236 : /// How large must a shard grow in bytes before we split it?
237 : /// None disables auto-splitting.
238 : pub split_threshold: Option<u64>,
239 :
240 : // TODO: make this cfg(feature = "testing")
241 : pub neon_local_repo_dir: Option<PathBuf>,
242 : }
243 :
244 : impl From<DatabaseError> for ApiError {
245 0 : fn from(err: DatabaseError) -> ApiError {
246 0 : match err {
247 0 : DatabaseError::Query(e) => ApiError::InternalServerError(e.into()),
248 : // FIXME: ApiError doesn't have an Unavailable variant, but ShuttingDown maps to 503.
249 : DatabaseError::Connection(_) | DatabaseError::ConnectionPool(_) => {
250 0 : ApiError::ShuttingDown
251 : }
252 0 : DatabaseError::Logical(reason) => {
253 0 : ApiError::InternalServerError(anyhow::anyhow!(reason))
254 : }
255 : }
256 0 : }
257 : }
258 :
259 : pub struct Service {
260 : inner: Arc<std::sync::RwLock<ServiceState>>,
261 : config: Config,
262 : persistence: Arc<Persistence>,
263 : compute_hook: Arc<ComputeHook>,
264 : result_tx: tokio::sync::mpsc::UnboundedSender<ReconcileResult>,
265 :
266 : heartbeater: Heartbeater,
267 :
268 : // Channel for background cleanup from failed operations that require cleanup, such as shard split
269 : abort_tx: tokio::sync::mpsc::UnboundedSender<TenantShardSplitAbort>,
270 :
271 : // Locking on a tenant granularity (covers all shards in the tenant):
272 : // - Take exclusively for rare operations that mutate the tenant's persistent state (e.g. create/delete/split)
273 : // - Take in shared mode for operations that need the set of shards to stay the same to complete reliably (e.g. timeline CRUD)
274 : tenant_op_locks: IdLockMap<TenantId, TenantOperations>,
275 :
276 : // Locking for node-mutating operations: take exclusively for operations that modify the node's persistent state, or
277 : // that transition it to/from Active.
278 : node_op_locks: IdLockMap<NodeId, NodeOperations>,
279 :
280 : // Limit how many Reconcilers we will spawn concurrently
281 : reconciler_concurrency: Arc<tokio::sync::Semaphore>,
282 :
283 : /// Queue of tenants who are waiting for concurrency limits to permit them to reconcile
284 : /// Send into this queue to promptly attempt to reconcile this shard next time units are available.
285 : ///
286 : /// Note that this state logically lives inside ServiceInner, but carrying Sender here makes the code simpler
287 : /// by avoiding needing a &mut ref to something inside the ServiceInner. This could be optimized to
288 : /// use a VecDeque instead of a channel to reduce synchronization overhead, at the cost of some code complexity.
289 : delayed_reconcile_tx: tokio::sync::mpsc::Sender<TenantShardId>,
290 :
291 : // Process shutdown will fire this token
292 : cancel: CancellationToken,
293 :
294 : // Background tasks will hold this gate
295 : gate: Gate,
296 :
297 : /// This waits for initial reconciliation with pageservers to complete. Until this barrier
298 : /// passes, it isn't safe to do any actions that mutate tenants.
299 : pub(crate) startup_complete: Barrier,
300 : }
301 :
302 : impl From<ReconcileWaitError> for ApiError {
303 0 : fn from(value: ReconcileWaitError) -> Self {
304 0 : match value {
305 0 : ReconcileWaitError::Shutdown => ApiError::ShuttingDown,
306 0 : e @ ReconcileWaitError::Timeout(_) => ApiError::Timeout(format!("{e}").into()),
307 0 : e @ ReconcileWaitError::Failed(..) => ApiError::InternalServerError(anyhow::anyhow!(e)),
308 : }
309 0 : }
310 : }
311 :
312 : impl From<OperationError> for ApiError {
313 0 : fn from(value: OperationError) -> Self {
314 0 : match value {
315 0 : OperationError::NodeStateChanged(err) | OperationError::FinalizeError(err) => {
316 0 : ApiError::InternalServerError(anyhow::anyhow!(err))
317 : }
318 0 : OperationError::Cancelled => ApiError::Conflict("Operation was cancelled".into()),
319 : }
320 0 : }
321 : }
322 :
323 : #[allow(clippy::large_enum_variant)]
324 : enum TenantCreateOrUpdate {
325 : Create(TenantCreateRequest),
326 : Update(Vec<ShardUpdate>),
327 : }
328 :
329 : struct ShardSplitParams {
330 : old_shard_count: ShardCount,
331 : new_shard_count: ShardCount,
332 : new_stripe_size: Option<ShardStripeSize>,
333 : targets: Vec<ShardSplitTarget>,
334 : policy: PlacementPolicy,
335 : config: TenantConfig,
336 : shard_ident: ShardIdentity,
337 : }
338 :
339 : // When preparing for a shard split, we may either choose to proceed with the split,
340 : // or find that the work is already done and return NoOp.
341 : enum ShardSplitAction {
342 : Split(ShardSplitParams),
343 : NoOp(TenantShardSplitResponse),
344 : }
345 :
346 : // A parent shard which will be split
347 : struct ShardSplitTarget {
348 : parent_id: TenantShardId,
349 : node: Node,
350 : child_ids: Vec<TenantShardId>,
351 : }
352 :
353 : /// When we tenant shard split operation fails, we may not be able to clean up immediately, because nodes
354 : /// might not be available. We therefore use a queue of abort operations processed in the background.
355 : struct TenantShardSplitAbort {
356 : tenant_id: TenantId,
357 : /// The target values from the request that failed
358 : new_shard_count: ShardCount,
359 : new_stripe_size: Option<ShardStripeSize>,
360 : /// Until this abort op is complete, no other operations may be done on the tenant
361 : _tenant_lock: TracingExclusiveGuard<TenantOperations>,
362 : }
363 :
364 0 : #[derive(thiserror::Error, Debug)]
365 : enum TenantShardSplitAbortError {
366 : #[error(transparent)]
367 : Database(#[from] DatabaseError),
368 : #[error(transparent)]
369 : Remote(#[from] mgmt_api::Error),
370 : #[error("Unavailable")]
371 : Unavailable,
372 : }
373 :
374 : struct ShardUpdate {
375 : tenant_shard_id: TenantShardId,
376 : placement_policy: PlacementPolicy,
377 : tenant_config: TenantConfig,
378 :
379 : /// If this is None, generation is not updated.
380 : generation: Option<Generation>,
381 : }
382 :
383 : impl Service {
384 0 : pub fn get_config(&self) -> &Config {
385 0 : &self.config
386 0 : }
387 :
388 : /// Called once on startup, this function attempts to contact all pageservers to build an up-to-date
389 : /// view of the world, and determine which pageservers are responsive.
390 0 : #[instrument(skip_all)]
391 : async fn startup_reconcile(
392 : self: &Arc<Service>,
393 : bg_compute_notify_result_tx: tokio::sync::mpsc::Sender<
394 : Result<(), (TenantShardId, NotifyError)>,
395 : >,
396 : ) {
397 : // For all tenant shards, a vector of observed states on nodes (where None means
398 : // indeterminate, same as in [`ObservedStateLocation`])
399 : let mut observed: HashMap<TenantShardId, Vec<(NodeId, Option<LocationConfig>)>> =
400 : HashMap::new();
401 :
402 : // Startup reconciliation does I/O to other services: whether they
403 : // are responsive or not, we should aim to finish within our deadline, because:
404 : // - If we don't, a k8s readiness hook watching /ready will kill us.
405 : // - While we're waiting for startup reconciliation, we are not fully
406 : // available for end user operations like creating/deleting tenants and timelines.
407 : //
408 : // We set multiple deadlines to break up the time available between the phases of work: this is
409 : // arbitrary, but avoids a situation where the first phase could burn our entire timeout period.
410 : let start_at = Instant::now();
411 : let node_scan_deadline = start_at
412 : .checked_add(STARTUP_RECONCILE_TIMEOUT / 2)
413 : .expect("Reconcile timeout is a modest constant");
414 :
415 : // Accumulate a list of any tenant locations that ought to be detached
416 : let mut cleanup = Vec::new();
417 :
418 : let node_listings = self.scan_node_locations(node_scan_deadline).await;
419 : // Send initial heartbeat requests to nodes that replied to the location listing above.
420 : let nodes_online = self.initial_heartbeat_round(node_listings.keys()).await;
421 :
422 : for (node_id, list_response) in node_listings {
423 : let tenant_shards = list_response.tenant_shards;
424 : tracing::info!(
425 : "Received {} shard statuses from pageserver {}, setting it to Active",
426 : tenant_shards.len(),
427 : node_id
428 : );
429 :
430 : for (tenant_shard_id, conf_opt) in tenant_shards {
431 : let shard_observations = observed.entry(tenant_shard_id).or_default();
432 : shard_observations.push((node_id, conf_opt));
433 : }
434 : }
435 :
436 : // List of tenants for which we will attempt to notify compute of their location at startup
437 : let mut compute_notifications = Vec::new();
438 :
439 : // Populate intent and observed states for all tenants, based on reported state on pageservers
440 : tracing::info!("Populating tenant shards' states from initial pageserver scan...");
441 : let shard_count = {
442 : let mut locked = self.inner.write().unwrap();
443 : let (nodes, tenants, scheduler) = locked.parts_mut();
444 :
445 : // Mark nodes online if they responded to us: nodes are offline by default after a restart.
446 : let mut new_nodes = (**nodes).clone();
447 : for (node_id, node) in new_nodes.iter_mut() {
448 : if let Some(utilization) = nodes_online.get(node_id) {
449 : node.set_availability(NodeAvailability::Active(UtilizationScore(
450 : utilization.utilization_score,
451 : )));
452 : scheduler.node_upsert(node);
453 : }
454 : }
455 : *nodes = Arc::new(new_nodes);
456 :
457 : for (tenant_shard_id, shard_observations) in observed {
458 : for (node_id, observed_loc) in shard_observations {
459 : let Some(tenant_shard) = tenants.get_mut(&tenant_shard_id) else {
460 : cleanup.push((tenant_shard_id, node_id));
461 : continue;
462 : };
463 : tenant_shard
464 : .observed
465 : .locations
466 : .insert(node_id, ObservedStateLocation { conf: observed_loc });
467 : }
468 : }
469 :
470 : // Populate each tenant's intent state
471 : let mut schedule_context = ScheduleContext::default();
472 : for (tenant_shard_id, tenant_shard) in tenants.iter_mut() {
473 : if tenant_shard_id.shard_number == ShardNumber(0) {
474 : // Reset scheduling context each time we advance to the next Tenant
475 : schedule_context = ScheduleContext::default();
476 : }
477 :
478 : tenant_shard.intent_from_observed(scheduler);
479 : if let Err(e) = tenant_shard.schedule(scheduler, &mut schedule_context) {
480 : // Non-fatal error: we are unable to properly schedule the tenant, perhaps because
481 : // not enough pageservers are available. The tenant may well still be available
482 : // to clients.
483 : tracing::error!("Failed to schedule tenant {tenant_shard_id} at startup: {e}");
484 : } else {
485 : // If we're both intending and observed to be attached at a particular node, we will
486 : // emit a compute notification for this. In the case where our observed state does not
487 : // yet match our intent, we will eventually reconcile, and that will emit a compute notification.
488 : if let Some(attached_at) = tenant_shard.stably_attached() {
489 : compute_notifications.push((
490 : *tenant_shard_id,
491 : attached_at,
492 : tenant_shard.shard.stripe_size,
493 : ));
494 : }
495 : }
496 : }
497 :
498 : tenants.len()
499 : };
500 :
501 : // TODO: if any tenant's intent now differs from its loaded generation_pageserver, we should clear that
502 : // generation_pageserver in the database.
503 :
504 : // Emit compute hook notifications for all tenants which are already stably attached. Other tenants
505 : // will emit compute hook notifications when they reconcile.
506 : //
507 : // Ordering: our calls to notify_background synchronously establish a relative order for these notifications vs. any later
508 : // calls into the ComputeHook for the same tenant: we can leave these to run to completion in the background and any later
509 : // calls will be correctly ordered wrt these.
510 : //
511 : // Concurrency: we call notify_background for all tenants, which will create O(N) tokio tasks, but almost all of them
512 : // will just wait on the ComputeHook::API_CONCURRENCY semaphore immediately, so very cheap until they get that semaphore
513 : // unit and start doing I/O.
514 : tracing::info!(
515 : "Sending {} compute notifications",
516 : compute_notifications.len()
517 : );
518 : self.compute_hook.notify_background(
519 : compute_notifications,
520 : bg_compute_notify_result_tx.clone(),
521 : &self.cancel,
522 : );
523 :
524 : // Finally, now that the service is up and running, launch reconcile operations for any tenants
525 : // which require it: under normal circumstances this should only include tenants that were in some
526 : // transient state before we restarted, or any tenants whose compute hooks failed above.
527 : tracing::info!("Checking for shards in need of reconciliation...");
528 : let reconcile_tasks = self.reconcile_all();
529 : // We will not wait for these reconciliation tasks to run here: we're now done with startup and
530 : // normal operations may proceed.
531 :
532 : // Clean up any tenants that were found on pageservers but are not known to us. Do this in the
533 : // background because it does not need to complete in order to proceed with other work.
534 : if !cleanup.is_empty() {
535 : tracing::info!("Cleaning up {} locations in the background", cleanup.len());
536 : tokio::task::spawn({
537 : let cleanup_self = self.clone();
538 0 : async move { cleanup_self.cleanup_locations(cleanup).await }
539 : });
540 : }
541 :
542 : tracing::info!("Startup complete, spawned {reconcile_tasks} reconciliation tasks ({shard_count} shards total)");
543 : }
544 :
545 0 : async fn initial_heartbeat_round<'a>(
546 0 : &self,
547 0 : node_ids: impl Iterator<Item = &'a NodeId>,
548 0 : ) -> HashMap<NodeId, PageserverUtilization> {
549 0 : assert!(!self.startup_complete.is_ready());
550 :
551 0 : let all_nodes = {
552 0 : let locked = self.inner.read().unwrap();
553 0 : locked.nodes.clone()
554 0 : };
555 0 :
556 0 : let mut nodes_to_heartbeat = HashMap::new();
557 0 : for node_id in node_ids {
558 0 : match all_nodes.get(node_id) {
559 0 : Some(node) => {
560 0 : nodes_to_heartbeat.insert(*node_id, node.clone());
561 0 : }
562 : None => {
563 0 : tracing::warn!("Node {node_id} was removed during start-up");
564 : }
565 : }
566 : }
567 :
568 0 : tracing::info!("Sending initial heartbeats...");
569 0 : let res = self
570 0 : .heartbeater
571 0 : .heartbeat(Arc::new(nodes_to_heartbeat))
572 0 : .await;
573 :
574 0 : let mut online_nodes = HashMap::new();
575 0 : if let Ok(deltas) = res {
576 0 : for (node_id, status) in deltas.0 {
577 0 : match status {
578 0 : PageserverState::Available { utilization, .. } => {
579 0 : online_nodes.insert(node_id, utilization);
580 0 : }
581 0 : PageserverState::Offline => {}
582 : }
583 : }
584 0 : }
585 :
586 0 : online_nodes
587 0 : }
588 :
589 : /// Used during [`Self::startup_reconcile`]: issue GETs to all nodes concurrently, with a deadline.
590 : ///
591 : /// The result includes only nodes which responded within the deadline
592 0 : async fn scan_node_locations(
593 0 : &self,
594 0 : deadline: Instant,
595 0 : ) -> HashMap<NodeId, LocationConfigListResponse> {
596 0 : let nodes = {
597 0 : let locked = self.inner.read().unwrap();
598 0 : locked.nodes.clone()
599 0 : };
600 0 :
601 0 : let mut node_results = HashMap::new();
602 0 :
603 0 : let mut node_list_futs = FuturesUnordered::new();
604 0 :
605 0 : tracing::info!("Scanning shards on {} nodes...", nodes.len());
606 0 : for node in nodes.values() {
607 0 : node_list_futs.push({
608 0 : async move {
609 0 : tracing::info!("Scanning shards on node {node}...");
610 0 : let timeout = Duration::from_secs(1);
611 0 : let response = node
612 0 : .with_client_retries(
613 0 : |client| async move { client.list_location_config().await },
614 0 : &self.config.jwt_token,
615 0 : 1,
616 0 : 5,
617 0 : timeout,
618 0 : &self.cancel,
619 0 : )
620 0 : .await;
621 0 : (node.get_id(), response)
622 0 : }
623 0 : });
624 0 : }
625 :
626 : loop {
627 0 : let (node_id, result) = tokio::select! {
628 : next = node_list_futs.next() => {
629 : match next {
630 : Some(result) => result,
631 : None =>{
632 : // We got results for all our nodes
633 : break;
634 : }
635 :
636 : }
637 : },
638 : _ = tokio::time::sleep(deadline.duration_since(Instant::now())) => {
639 : // Give up waiting for anyone who hasn't responded: we will yield the results that we have
640 : tracing::info!("Reached deadline while waiting for nodes to respond to location listing requests");
641 : break;
642 : }
643 : };
644 :
645 0 : let Some(list_response) = result else {
646 0 : tracing::info!("Shutdown during startup_reconcile");
647 0 : break;
648 : };
649 :
650 0 : match list_response {
651 0 : Err(e) => {
652 0 : tracing::warn!("Could not scan node {} ({e})", node_id);
653 : }
654 0 : Ok(listing) => {
655 0 : node_results.insert(node_id, listing);
656 0 : }
657 : }
658 : }
659 :
660 0 : node_results
661 0 : }
662 :
663 : /// Used during [`Self::startup_reconcile`]: detach a list of unknown-to-us tenants from pageservers.
664 : ///
665 : /// This is safe to run in the background, because if we don't have this TenantShardId in our map of
666 : /// tenants, then it is probably something incompletely deleted before: we will not fight with any
667 : /// other task trying to attach it.
668 0 : #[instrument(skip_all)]
669 : async fn cleanup_locations(&self, cleanup: Vec<(TenantShardId, NodeId)>) {
670 : let nodes = self.inner.read().unwrap().nodes.clone();
671 :
672 : for (tenant_shard_id, node_id) in cleanup {
673 : // A node reported a tenant_shard_id which is unknown to us: detach it.
674 : let Some(node) = nodes.get(&node_id) else {
675 : // This is legitimate; we run in the background and [`Self::startup_reconcile`] might have identified
676 : // a location to clean up on a node that has since been removed.
677 : tracing::info!(
678 : "Not cleaning up location {node_id}/{tenant_shard_id}: node not found"
679 : );
680 : continue;
681 : };
682 :
683 : if self.cancel.is_cancelled() {
684 : break;
685 : }
686 :
687 : let client = PageserverClient::new(
688 : node.get_id(),
689 : node.base_url(),
690 : self.config.jwt_token.as_deref(),
691 : );
692 : match client
693 : .location_config(
694 : tenant_shard_id,
695 : LocationConfig {
696 : mode: LocationConfigMode::Detached,
697 : generation: None,
698 : secondary_conf: None,
699 : shard_number: tenant_shard_id.shard_number.0,
700 : shard_count: tenant_shard_id.shard_count.literal(),
701 : shard_stripe_size: 0,
702 : tenant_conf: models::TenantConfig::default(),
703 : },
704 : None,
705 : false,
706 : )
707 : .await
708 : {
709 : Ok(()) => {
710 : tracing::info!(
711 : "Detached unknown shard {tenant_shard_id} on pageserver {node_id}"
712 : );
713 : }
714 : Err(e) => {
715 : // Non-fatal error: leaving a tenant shard behind that we are not managing shouldn't
716 : // break anything.
717 : tracing::error!(
718 : "Failed to detach unknkown shard {tenant_shard_id} on pageserver {node_id}: {e}"
719 : );
720 : }
721 : }
722 : }
723 : }
724 :
725 : /// Long running background task that periodically wakes up and looks for shards that need
726 : /// reconciliation. Reconciliation is fallible, so any reconciliation tasks that fail during
727 : /// e.g. a tenant create/attach/migrate must eventually be retried: this task is responsible
728 : /// for those retries.
729 0 : #[instrument(skip_all)]
730 : async fn background_reconcile(self: &Arc<Self>) {
731 : self.startup_complete.clone().wait().await;
732 :
733 : const BACKGROUND_RECONCILE_PERIOD: Duration = Duration::from_secs(20);
734 :
735 : let mut interval = tokio::time::interval(BACKGROUND_RECONCILE_PERIOD);
736 : while !self.cancel.is_cancelled() {
737 : tokio::select! {
738 : _ = interval.tick() => {
739 : let reconciles_spawned = self.reconcile_all();
740 : if reconciles_spawned == 0 {
741 : // Run optimizer only when we didn't find any other work to do
742 : let optimizations = self.optimize_all().await;
743 : if optimizations == 0 {
744 : // Run new splits only when no optimizations are pending
745 : self.autosplit_tenants().await;
746 : }
747 : }
748 : }
749 : _ = self.cancel.cancelled() => return
750 : }
751 : }
752 : }
753 0 : #[instrument(skip_all)]
754 : async fn spawn_heartbeat_driver(&self) {
755 : self.startup_complete.clone().wait().await;
756 :
757 : const HEARTBEAT_INTERVAL: Duration = Duration::from_secs(5);
758 :
759 : let mut interval = tokio::time::interval(HEARTBEAT_INTERVAL);
760 : while !self.cancel.is_cancelled() {
761 : tokio::select! {
762 : _ = interval.tick() => { }
763 : _ = self.cancel.cancelled() => return
764 : };
765 :
766 : let nodes = {
767 : let locked = self.inner.read().unwrap();
768 : locked.nodes.clone()
769 : };
770 :
771 : let res = self.heartbeater.heartbeat(nodes).await;
772 : if let Ok(deltas) = res {
773 : for (node_id, state) in deltas.0 {
774 : let (new_node, new_availability) = match state {
775 : PageserverState::Available {
776 : utilization, new, ..
777 : } => (
778 : new,
779 : NodeAvailability::Active(UtilizationScore(
780 : utilization.utilization_score,
781 : )),
782 : ),
783 : PageserverState::Offline => (false, NodeAvailability::Offline),
784 : };
785 :
786 : if new_node {
787 : // When the heartbeats detect a newly added node, we don't wish
788 : // to attempt to reconcile the shards assigned to it. The node
789 : // is likely handling it's re-attach response, so reconciling now
790 : // would be counterproductive.
791 : //
792 : // Instead, update the in-memory state with the details learned about the
793 : // node.
794 : let mut locked = self.inner.write().unwrap();
795 : let (nodes, _tenants, scheduler) = locked.parts_mut();
796 :
797 : let mut new_nodes = (**nodes).clone();
798 :
799 : if let Some(node) = new_nodes.get_mut(&node_id) {
800 : node.set_availability(new_availability);
801 : scheduler.node_upsert(node);
802 : }
803 :
804 : locked.nodes = Arc::new(new_nodes);
805 : } else {
806 : // This is the code path for geniune availability transitions (i.e node
807 : // goes unavailable and/or comes back online).
808 : let res = self
809 : .node_configure(node_id, Some(new_availability), None)
810 : .await;
811 :
812 : match res {
813 : Ok(()) => {}
814 : Err(ApiError::NotFound(_)) => {
815 : // This should be rare, but legitimate since the heartbeats are done
816 : // on a snapshot of the nodes.
817 : tracing::info!(
818 : "Node {} was not found after heartbeat round",
819 : node_id
820 : );
821 : }
822 : Err(err) => {
823 : tracing::error!(
824 : "Failed to update node {} after heartbeat round: {}",
825 : node_id,
826 : err
827 : );
828 : }
829 : }
830 : }
831 : }
832 : }
833 : }
834 : }
835 :
836 : /// Apply the contents of a [`ReconcileResult`] to our in-memory state: if the reconciliation
837 : /// was successful and intent hasn't changed since the Reconciler was spawned, this will update
838 : /// the observed state of the tenant such that subsequent calls to [`TenantShard::get_reconcile_needed`]
839 : /// will indicate that reconciliation is not needed.
840 0 : #[instrument(skip_all, fields(
841 : tenant_id=%result.tenant_shard_id.tenant_id, shard_id=%result.tenant_shard_id.shard_slug(),
842 : sequence=%result.sequence
843 0 : ))]
844 : fn process_result(&self, result: ReconcileResult) {
845 : let mut locked = self.inner.write().unwrap();
846 : let Some(tenant) = locked.tenants.get_mut(&result.tenant_shard_id) else {
847 : // A reconciliation result might race with removing a tenant: drop results for
848 : // tenants that aren't in our map.
849 : return;
850 : };
851 :
852 : // Usually generation should only be updated via this path, so the max() isn't
853 : // needed, but it is used to handle out-of-band updates via. e.g. test hook.
854 : tenant.generation = std::cmp::max(tenant.generation, result.generation);
855 :
856 : // If the reconciler signals that it failed to notify compute, set this state on
857 : // the shard so that a future [`TenantShard::maybe_reconcile`] will try again.
858 : tenant.pending_compute_notification = result.pending_compute_notification;
859 :
860 : // Let the TenantShard know it is idle.
861 : tenant.reconcile_complete(result.sequence);
862 :
863 : match result.result {
864 : Ok(()) => {
865 : for (node_id, loc) in &result.observed.locations {
866 : if let Some(conf) = &loc.conf {
867 : tracing::info!("Updating observed location {}: {:?}", node_id, conf);
868 : } else {
869 : tracing::info!("Setting observed location {} to None", node_id,)
870 : }
871 : }
872 : tenant.observed = result.observed;
873 : tenant.waiter.advance(result.sequence);
874 : }
875 : Err(e) => {
876 : match e {
877 : ReconcileError::Cancel => {
878 : tracing::info!("Reconciler was cancelled");
879 : }
880 : ReconcileError::Remote(mgmt_api::Error::Cancelled) => {
881 : // This might be due to the reconciler getting cancelled, or it might
882 : // be due to the `Node` being marked offline.
883 : tracing::info!("Reconciler cancelled during pageserver API call");
884 : }
885 : _ => {
886 : tracing::warn!("Reconcile error: {}", e);
887 : }
888 : }
889 :
890 : // Ordering: populate last_error before advancing error_seq,
891 : // so that waiters will see the correct error after waiting.
892 : tenant.set_last_error(result.sequence, e);
893 :
894 : for (node_id, o) in result.observed.locations {
895 : tenant.observed.locations.insert(node_id, o);
896 : }
897 : }
898 : }
899 :
900 : // Maybe some other work can proceed now that this job finished.
901 : if self.reconciler_concurrency.available_permits() > 0 {
902 : while let Ok(tenant_shard_id) = locked.delayed_reconcile_rx.try_recv() {
903 : let (nodes, tenants, _scheduler) = locked.parts_mut();
904 : if let Some(shard) = tenants.get_mut(&tenant_shard_id) {
905 : shard.delayed_reconcile = false;
906 : self.maybe_reconcile_shard(shard, nodes);
907 : }
908 :
909 : if self.reconciler_concurrency.available_permits() == 0 {
910 : break;
911 : }
912 : }
913 : }
914 : }
915 :
916 0 : async fn process_results(
917 0 : &self,
918 0 : mut result_rx: tokio::sync::mpsc::UnboundedReceiver<ReconcileResult>,
919 0 : mut bg_compute_hook_result_rx: tokio::sync::mpsc::Receiver<
920 0 : Result<(), (TenantShardId, NotifyError)>,
921 0 : >,
922 0 : ) {
923 0 : loop {
924 0 : // Wait for the next result, or for cancellation
925 0 : tokio::select! {
926 : r = result_rx.recv() => {
927 : match r {
928 : Some(result) => {self.process_result(result);},
929 : None => {break;}
930 : }
931 : }
932 0 : _ = async{
933 0 : match bg_compute_hook_result_rx.recv().await {
934 0 : Some(result) => {
935 0 : if let Err((tenant_shard_id, notify_error)) = result {
936 0 : tracing::warn!("Marking shard {tenant_shard_id} for notification retry, due to error {notify_error}");
937 0 : let mut locked = self.inner.write().unwrap();
938 0 : if let Some(shard) = locked.tenants.get_mut(&tenant_shard_id) {
939 0 : shard.pending_compute_notification = true;
940 0 : }
941 :
942 0 : }
943 : },
944 : None => {
945 : // This channel is dead, but we don't want to terminate the outer loop{}: just wait for shutdown
946 0 : self.cancel.cancelled().await;
947 : }
948 : }
949 0 : } => {},
950 : _ = self.cancel.cancelled() => {
951 : break;
952 : }
953 0 : };
954 0 : }
955 :
956 : // We should only fall through on shutdown
957 0 : assert!(self.cancel.is_cancelled());
958 0 : }
959 :
960 0 : async fn process_aborts(
961 0 : &self,
962 0 : mut abort_rx: tokio::sync::mpsc::UnboundedReceiver<TenantShardSplitAbort>,
963 0 : ) {
964 : loop {
965 : // Wait for the next result, or for cancellation
966 0 : let op = tokio::select! {
967 : r = abort_rx.recv() => {
968 : match r {
969 : Some(op) => {op},
970 : None => {break;}
971 : }
972 : }
973 : _ = self.cancel.cancelled() => {
974 : break;
975 : }
976 : };
977 :
978 : // Retry until shutdown: we must keep this request object alive until it is properly
979 : // processed, as it holds a lock guard that prevents other operations trying to do things
980 : // to the tenant while it is in a weird part-split state.
981 0 : while !self.cancel.is_cancelled() {
982 0 : match self.abort_tenant_shard_split(&op).await {
983 0 : Ok(_) => break,
984 0 : Err(e) => {
985 0 : tracing::warn!(
986 0 : "Failed to abort shard split on {}, will retry: {e}",
987 : op.tenant_id
988 : );
989 :
990 : // If a node is unavailable, we hope that it has been properly marked Offline
991 : // when we retry, so that the abort op will succeed. If the abort op is failing
992 : // for some other reason, we will keep retrying forever, or until a human notices
993 : // and does something about it (either fixing a pageserver or restarting the controller).
994 0 : tokio::time::timeout(Duration::from_secs(5), self.cancel.cancelled())
995 0 : .await
996 0 : .ok();
997 : }
998 : }
999 : }
1000 : }
1001 0 : }
1002 :
1003 0 : pub async fn spawn(config: Config, persistence: Arc<Persistence>) -> anyhow::Result<Arc<Self>> {
1004 0 : let (result_tx, result_rx) = tokio::sync::mpsc::unbounded_channel();
1005 0 : let (abort_tx, abort_rx) = tokio::sync::mpsc::unbounded_channel();
1006 0 :
1007 0 : tracing::info!("Loading nodes from database...");
1008 0 : let nodes = persistence
1009 0 : .list_nodes()
1010 0 : .await?
1011 0 : .into_iter()
1012 0 : .map(Node::from_persistent)
1013 0 : .collect::<Vec<_>>();
1014 0 : let nodes: HashMap<NodeId, Node> = nodes.into_iter().map(|n| (n.get_id(), n)).collect();
1015 0 : tracing::info!("Loaded {} nodes from database.", nodes.len());
1016 :
1017 0 : tracing::info!("Loading shards from database...");
1018 0 : let mut tenant_shard_persistence = persistence.list_tenant_shards().await?;
1019 0 : tracing::info!(
1020 0 : "Loaded {} shards from database.",
1021 0 : tenant_shard_persistence.len()
1022 : );
1023 :
1024 : // If any shard splits were in progress, reset the database state to abort them
1025 0 : let mut tenant_shard_count_min_max: HashMap<TenantId, (ShardCount, ShardCount)> =
1026 0 : HashMap::new();
1027 0 : for tsp in &mut tenant_shard_persistence {
1028 0 : let shard = tsp.get_shard_identity()?;
1029 0 : let tenant_shard_id = tsp.get_tenant_shard_id()?;
1030 0 : let entry = tenant_shard_count_min_max
1031 0 : .entry(tenant_shard_id.tenant_id)
1032 0 : .or_insert_with(|| (shard.count, shard.count));
1033 0 : entry.0 = std::cmp::min(entry.0, shard.count);
1034 0 : entry.1 = std::cmp::max(entry.1, shard.count);
1035 : }
1036 :
1037 0 : for (tenant_id, (count_min, count_max)) in tenant_shard_count_min_max {
1038 0 : if count_min != count_max {
1039 : // Aborting the split in the database and dropping the child shards is sufficient: the reconciliation in
1040 : // [`Self::startup_reconcile`] will implicitly drop the child shards on remote pageservers, or they'll
1041 : // be dropped later in [`Self::node_activate_reconcile`] if it isn't available right now.
1042 0 : tracing::info!("Aborting shard split {tenant_id} {count_min:?} -> {count_max:?}");
1043 0 : let abort_status = persistence.abort_shard_split(tenant_id, count_max).await?;
1044 :
1045 : // We may never see the Complete status here: if the split was complete, we wouldn't have
1046 : // identified this tenant has having mismatching min/max counts.
1047 0 : assert!(matches!(abort_status, AbortShardSplitStatus::Aborted));
1048 :
1049 : // Clear the splitting status in-memory, to reflect that we just aborted in the database
1050 0 : tenant_shard_persistence.iter_mut().for_each(|tsp| {
1051 0 : // Set idle split state on those shards that we will retain.
1052 0 : let tsp_tenant_id = TenantId::from_str(tsp.tenant_id.as_str()).unwrap();
1053 0 : if tsp_tenant_id == tenant_id
1054 0 : && tsp.get_shard_identity().unwrap().count == count_min
1055 0 : {
1056 0 : tsp.splitting = SplitState::Idle;
1057 0 : } else if tsp_tenant_id == tenant_id {
1058 : // Leave the splitting state on the child shards: this will be used next to
1059 : // drop them.
1060 0 : tracing::info!(
1061 0 : "Shard {tsp_tenant_id} will be dropped after shard split abort",
1062 : );
1063 0 : }
1064 0 : });
1065 0 :
1066 0 : // Drop shards for this tenant which we didn't just mark idle (i.e. child shards of the aborted split)
1067 0 : tenant_shard_persistence.retain(|tsp| {
1068 0 : TenantId::from_str(tsp.tenant_id.as_str()).unwrap() != tenant_id
1069 0 : || tsp.splitting == SplitState::Idle
1070 0 : });
1071 0 : }
1072 : }
1073 :
1074 0 : let mut tenants = BTreeMap::new();
1075 0 :
1076 0 : let mut scheduler = Scheduler::new(nodes.values());
1077 0 :
1078 0 : #[cfg(feature = "testing")]
1079 0 : {
1080 0 : // Hack: insert scheduler state for all nodes referenced by shards, as compatibility
1081 0 : // tests only store the shards, not the nodes. The nodes will be loaded shortly
1082 0 : // after when pageservers start up and register.
1083 0 : let mut node_ids = HashSet::new();
1084 0 : for tsp in &tenant_shard_persistence {
1085 0 : if let Some(node_id) = tsp.generation_pageserver {
1086 0 : node_ids.insert(node_id);
1087 0 : }
1088 : }
1089 0 : for node_id in node_ids {
1090 0 : tracing::info!("Creating node {} in scheduler for tests", node_id);
1091 0 : let node = Node::new(
1092 0 : NodeId(node_id as u64),
1093 0 : "".to_string(),
1094 0 : 123,
1095 0 : "".to_string(),
1096 0 : 123,
1097 0 : );
1098 0 :
1099 0 : scheduler.node_upsert(&node);
1100 : }
1101 : }
1102 0 : for tsp in tenant_shard_persistence {
1103 0 : let tenant_shard_id = tsp.get_tenant_shard_id()?;
1104 :
1105 : // We will populate intent properly later in [`Self::startup_reconcile`], initially populate
1106 : // it with what we can infer: the node for which a generation was most recently issued.
1107 0 : let mut intent = IntentState::new();
1108 0 : if let Some(generation_pageserver) = tsp.generation_pageserver {
1109 0 : intent.set_attached(&mut scheduler, Some(NodeId(generation_pageserver as u64)));
1110 0 : }
1111 0 : let new_tenant = TenantShard::from_persistent(tsp, intent)?;
1112 :
1113 0 : tenants.insert(tenant_shard_id, new_tenant);
1114 : }
1115 :
1116 0 : let (startup_completion, startup_complete) = utils::completion::channel();
1117 0 :
1118 0 : // This channel is continuously consumed by process_results, so doesn't need to be very large.
1119 0 : let (bg_compute_notify_result_tx, bg_compute_notify_result_rx) =
1120 0 : tokio::sync::mpsc::channel(512);
1121 0 :
1122 0 : let (delayed_reconcile_tx, delayed_reconcile_rx) =
1123 0 : tokio::sync::mpsc::channel(MAX_DELAYED_RECONCILES);
1124 0 :
1125 0 : let cancel = CancellationToken::new();
1126 0 : let heartbeater = Heartbeater::new(
1127 0 : config.jwt_token.clone(),
1128 0 : config.max_unavailable_interval,
1129 0 : cancel.clone(),
1130 0 : );
1131 0 : let this = Arc::new(Self {
1132 0 : inner: Arc::new(std::sync::RwLock::new(ServiceState::new(
1133 0 : nodes,
1134 0 : tenants,
1135 0 : scheduler,
1136 0 : delayed_reconcile_rx,
1137 0 : ))),
1138 0 : config: config.clone(),
1139 0 : persistence,
1140 0 : compute_hook: Arc::new(ComputeHook::new(config.clone())),
1141 0 : result_tx,
1142 0 : heartbeater,
1143 0 : reconciler_concurrency: Arc::new(tokio::sync::Semaphore::new(
1144 0 : config.reconciler_concurrency,
1145 0 : )),
1146 0 : delayed_reconcile_tx,
1147 0 : abort_tx,
1148 0 : startup_complete: startup_complete.clone(),
1149 0 : cancel,
1150 0 : gate: Gate::default(),
1151 0 : tenant_op_locks: Default::default(),
1152 0 : node_op_locks: Default::default(),
1153 0 : });
1154 0 :
1155 0 : let result_task_this = this.clone();
1156 0 : tokio::task::spawn(async move {
1157 : // Block shutdown until we're done (we must respect self.cancel)
1158 0 : if let Ok(_gate) = result_task_this.gate.enter() {
1159 0 : result_task_this
1160 0 : .process_results(result_rx, bg_compute_notify_result_rx)
1161 0 : .await
1162 0 : }
1163 0 : });
1164 0 :
1165 0 : tokio::task::spawn({
1166 0 : let this = this.clone();
1167 0 : async move {
1168 : // Block shutdown until we're done (we must respect self.cancel)
1169 0 : if let Ok(_gate) = this.gate.enter() {
1170 0 : this.process_aborts(abort_rx).await
1171 0 : }
1172 0 : }
1173 0 : });
1174 0 :
1175 0 : tokio::task::spawn({
1176 0 : let this = this.clone();
1177 0 : async move {
1178 0 : if let Ok(_gate) = this.gate.enter() {
1179 0 : loop {
1180 0 : tokio::select! {
1181 : _ = this.cancel.cancelled() => {
1182 : break;
1183 : },
1184 : _ = tokio::time::sleep(Duration::from_secs(60)) => {}
1185 0 : };
1186 0 : this.tenant_op_locks.housekeeping();
1187 0 : }
1188 0 : }
1189 0 : }
1190 0 : });
1191 0 :
1192 0 : tokio::task::spawn({
1193 0 : let this = this.clone();
1194 0 : // We will block the [`Service::startup_complete`] barrier until [`Self::startup_reconcile`]
1195 0 : // is done.
1196 0 : let startup_completion = startup_completion.clone();
1197 0 : async move {
1198 : // Block shutdown until we're done (we must respect self.cancel)
1199 0 : let Ok(_gate) = this.gate.enter() else {
1200 0 : return;
1201 : };
1202 :
1203 0 : this.startup_reconcile(bg_compute_notify_result_tx).await;
1204 0 : drop(startup_completion);
1205 0 : }
1206 0 : });
1207 0 :
1208 0 : tokio::task::spawn({
1209 0 : let this = this.clone();
1210 0 : let startup_complete = startup_complete.clone();
1211 0 : async move {
1212 0 : startup_complete.wait().await;
1213 0 : this.background_reconcile().await;
1214 0 : }
1215 0 : });
1216 0 :
1217 0 : tokio::task::spawn({
1218 0 : let this = this.clone();
1219 0 : let startup_complete = startup_complete.clone();
1220 0 : async move {
1221 0 : startup_complete.wait().await;
1222 0 : this.spawn_heartbeat_driver().await;
1223 0 : }
1224 0 : });
1225 0 :
1226 0 : Ok(this)
1227 0 : }
1228 :
1229 0 : pub(crate) async fn attach_hook(
1230 0 : &self,
1231 0 : attach_req: AttachHookRequest,
1232 0 : ) -> anyhow::Result<AttachHookResponse> {
1233 0 : let _tenant_lock = trace_exclusive_lock(
1234 0 : &self.tenant_op_locks,
1235 0 : attach_req.tenant_shard_id.tenant_id,
1236 0 : TenantOperations::ShardSplit,
1237 0 : )
1238 0 : .await;
1239 :
1240 : // This is a test hook. To enable using it on tenants that were created directly with
1241 : // the pageserver API (not via this service), we will auto-create any missing tenant
1242 : // shards with default state.
1243 0 : let insert = {
1244 0 : let locked = self.inner.write().unwrap();
1245 0 : !locked.tenants.contains_key(&attach_req.tenant_shard_id)
1246 0 : };
1247 0 :
1248 0 : if insert {
1249 0 : let tsp = TenantShardPersistence {
1250 0 : tenant_id: attach_req.tenant_shard_id.tenant_id.to_string(),
1251 0 : shard_number: attach_req.tenant_shard_id.shard_number.0 as i32,
1252 0 : shard_count: attach_req.tenant_shard_id.shard_count.literal() as i32,
1253 0 : shard_stripe_size: 0,
1254 0 : generation: attach_req.generation_override.or(Some(0)),
1255 0 : generation_pageserver: None,
1256 0 : placement_policy: serde_json::to_string(&PlacementPolicy::Attached(0)).unwrap(),
1257 0 : config: serde_json::to_string(&TenantConfig::default()).unwrap(),
1258 0 : splitting: SplitState::default(),
1259 0 : scheduling_policy: serde_json::to_string(&ShardSchedulingPolicy::default())
1260 0 : .unwrap(),
1261 0 : };
1262 0 :
1263 0 : match self.persistence.insert_tenant_shards(vec![tsp]).await {
1264 0 : Err(e) => match e {
1265 : DatabaseError::Query(diesel::result::Error::DatabaseError(
1266 : DatabaseErrorKind::UniqueViolation,
1267 : _,
1268 : )) => {
1269 0 : tracing::info!(
1270 0 : "Raced with another request to insert tenant {}",
1271 : attach_req.tenant_shard_id
1272 : )
1273 : }
1274 0 : _ => return Err(e.into()),
1275 : },
1276 : Ok(()) => {
1277 0 : tracing::info!("Inserted shard {} in database", attach_req.tenant_shard_id);
1278 :
1279 0 : let mut locked = self.inner.write().unwrap();
1280 0 : locked.tenants.insert(
1281 0 : attach_req.tenant_shard_id,
1282 0 : TenantShard::new(
1283 0 : attach_req.tenant_shard_id,
1284 0 : ShardIdentity::unsharded(),
1285 0 : PlacementPolicy::Attached(0),
1286 0 : ),
1287 0 : );
1288 0 : tracing::info!("Inserted shard {} in memory", attach_req.tenant_shard_id);
1289 : }
1290 : }
1291 0 : }
1292 :
1293 0 : let new_generation = if let Some(req_node_id) = attach_req.node_id {
1294 0 : let maybe_tenant_conf = {
1295 0 : let locked = self.inner.write().unwrap();
1296 0 : locked
1297 0 : .tenants
1298 0 : .get(&attach_req.tenant_shard_id)
1299 0 : .map(|t| t.config.clone())
1300 0 : };
1301 0 :
1302 0 : match maybe_tenant_conf {
1303 0 : Some(conf) => {
1304 0 : let new_generation = self
1305 0 : .persistence
1306 0 : .increment_generation(attach_req.tenant_shard_id, req_node_id)
1307 0 : .await?;
1308 :
1309 : // Persist the placement policy update. This is required
1310 : // when we reattaching a detached tenant.
1311 0 : self.persistence
1312 0 : .update_tenant_shard(
1313 0 : TenantFilter::Shard(attach_req.tenant_shard_id),
1314 0 : Some(PlacementPolicy::Attached(0)),
1315 0 : Some(conf),
1316 0 : None,
1317 0 : None,
1318 0 : )
1319 0 : .await?;
1320 0 : Some(new_generation)
1321 : }
1322 : None => {
1323 0 : anyhow::bail!("Attach hook handling raced with tenant removal")
1324 : }
1325 : }
1326 : } else {
1327 0 : self.persistence.detach(attach_req.tenant_shard_id).await?;
1328 0 : None
1329 : };
1330 :
1331 0 : let mut locked = self.inner.write().unwrap();
1332 0 : let (_nodes, tenants, scheduler) = locked.parts_mut();
1333 0 :
1334 0 : let tenant_shard = tenants
1335 0 : .get_mut(&attach_req.tenant_shard_id)
1336 0 : .expect("Checked for existence above");
1337 :
1338 0 : if let Some(new_generation) = new_generation {
1339 0 : tenant_shard.generation = Some(new_generation);
1340 0 : tenant_shard.policy = PlacementPolicy::Attached(0);
1341 0 : } else {
1342 : // This is a detach notification. We must update placement policy to avoid re-attaching
1343 : // during background scheduling/reconciliation, or during storage controller restart.
1344 0 : assert!(attach_req.node_id.is_none());
1345 0 : tenant_shard.policy = PlacementPolicy::Detached;
1346 : }
1347 :
1348 0 : if let Some(attaching_pageserver) = attach_req.node_id.as_ref() {
1349 0 : tracing::info!(
1350 : tenant_id = %attach_req.tenant_shard_id,
1351 : ps_id = %attaching_pageserver,
1352 : generation = ?tenant_shard.generation,
1353 0 : "issuing",
1354 : );
1355 0 : } else if let Some(ps_id) = tenant_shard.intent.get_attached() {
1356 0 : tracing::info!(
1357 : tenant_id = %attach_req.tenant_shard_id,
1358 : %ps_id,
1359 : generation = ?tenant_shard.generation,
1360 0 : "dropping",
1361 : );
1362 : } else {
1363 0 : tracing::info!(
1364 : tenant_id = %attach_req.tenant_shard_id,
1365 0 : "no-op: tenant already has no pageserver");
1366 : }
1367 0 : tenant_shard
1368 0 : .intent
1369 0 : .set_attached(scheduler, attach_req.node_id);
1370 0 :
1371 0 : tracing::info!(
1372 0 : "attach_hook: tenant {} set generation {:?}, pageserver {}",
1373 0 : attach_req.tenant_shard_id,
1374 0 : tenant_shard.generation,
1375 0 : // TODO: this is an odd number of 0xf's
1376 0 : attach_req.node_id.unwrap_or(utils::id::NodeId(0xfffffff))
1377 : );
1378 :
1379 : // Trick the reconciler into not doing anything for this tenant: this helps
1380 : // tests that manually configure a tenant on the pagesrever, and then call this
1381 : // attach hook: they don't want background reconciliation to modify what they
1382 : // did to the pageserver.
1383 : #[cfg(feature = "testing")]
1384 : {
1385 0 : if let Some(node_id) = attach_req.node_id {
1386 0 : tenant_shard.observed.locations = HashMap::from([(
1387 0 : node_id,
1388 0 : ObservedStateLocation {
1389 0 : conf: Some(attached_location_conf(
1390 0 : tenant_shard.generation.unwrap(),
1391 0 : &tenant_shard.shard,
1392 0 : &tenant_shard.config,
1393 0 : &PlacementPolicy::Attached(0),
1394 0 : )),
1395 0 : },
1396 0 : )]);
1397 0 : } else {
1398 0 : tenant_shard.observed.locations.clear();
1399 0 : }
1400 : }
1401 :
1402 0 : Ok(AttachHookResponse {
1403 0 : gen: attach_req
1404 0 : .node_id
1405 0 : .map(|_| tenant_shard.generation.expect("Test hook, not used on tenants that are mid-onboarding with a NULL generation").into().unwrap()),
1406 0 : })
1407 0 : }
1408 :
1409 0 : pub(crate) fn inspect(&self, inspect_req: InspectRequest) -> InspectResponse {
1410 0 : let locked = self.inner.read().unwrap();
1411 0 :
1412 0 : let tenant_shard = locked.tenants.get(&inspect_req.tenant_shard_id);
1413 0 :
1414 0 : InspectResponse {
1415 0 : attachment: tenant_shard.and_then(|s| {
1416 0 : s.intent
1417 0 : .get_attached()
1418 0 : .map(|ps| (s.generation.expect("Test hook, not used on tenants that are mid-onboarding with a NULL generation").into().unwrap(), ps))
1419 0 : }),
1420 0 : }
1421 0 : }
1422 :
1423 : // When the availability state of a node transitions to active, we must do a full reconciliation
1424 : // of LocationConfigs on that node. This is because while a node was offline:
1425 : // - we might have proceeded through startup_reconcile without checking for extraneous LocationConfigs on this node
1426 : // - aborting a tenant shard split might have left rogue child shards behind on this node.
1427 : //
1428 : // This function must complete _before_ setting a `Node` to Active: once it is set to Active, other
1429 : // Reconcilers might communicate with the node, and these must not overlap with the work we do in
1430 : // this function.
1431 : //
1432 : // The reconciliation logic in here is very similar to what [`Self::startup_reconcile`] does, but
1433 : // for written for a single node rather than as a batch job for all nodes.
1434 0 : #[tracing::instrument(skip_all, fields(node_id=%node.get_id()))]
1435 : async fn node_activate_reconcile(
1436 : &self,
1437 : mut node: Node,
1438 : _lock: &TracingExclusiveGuard<NodeOperations>,
1439 : ) -> Result<(), ApiError> {
1440 : // This Node is a mutable local copy: we will set it active so that we can use its
1441 : // API client to reconcile with the node. The Node in [`Self::nodes`] will get updated
1442 : // later.
1443 : node.set_availability(NodeAvailability::Active(UtilizationScore::worst()));
1444 :
1445 : let configs = match node
1446 : .with_client_retries(
1447 0 : |client| async move { client.list_location_config().await },
1448 : &self.config.jwt_token,
1449 : 1,
1450 : 5,
1451 : SHORT_RECONCILE_TIMEOUT,
1452 : &self.cancel,
1453 : )
1454 : .await
1455 : {
1456 : None => {
1457 : // We're shutting down (the Node's cancellation token can't have fired, because
1458 : // we're the only scope that has a reference to it, and we didn't fire it).
1459 : return Err(ApiError::ShuttingDown);
1460 : }
1461 : Some(Err(e)) => {
1462 : // This node didn't succeed listing its locations: it may not proceed to active state
1463 : // as it is apparently unavailable.
1464 : return Err(ApiError::PreconditionFailed(
1465 : format!("Failed to query node location configs, cannot activate ({e})").into(),
1466 : ));
1467 : }
1468 : Some(Ok(configs)) => configs,
1469 : };
1470 : tracing::info!("Loaded {} LocationConfigs", configs.tenant_shards.len());
1471 :
1472 : let mut cleanup = Vec::new();
1473 : {
1474 : let mut locked = self.inner.write().unwrap();
1475 :
1476 : for (tenant_shard_id, observed_loc) in configs.tenant_shards {
1477 : let Some(tenant_shard) = locked.tenants.get_mut(&tenant_shard_id) else {
1478 : cleanup.push(tenant_shard_id);
1479 : continue;
1480 : };
1481 : tenant_shard
1482 : .observed
1483 : .locations
1484 : .insert(node.get_id(), ObservedStateLocation { conf: observed_loc });
1485 : }
1486 : }
1487 :
1488 : for tenant_shard_id in cleanup {
1489 : tracing::info!("Detaching {tenant_shard_id}");
1490 : match node
1491 : .with_client_retries(
1492 0 : |client| async move {
1493 0 : let config = LocationConfig {
1494 0 : mode: LocationConfigMode::Detached,
1495 0 : generation: None,
1496 0 : secondary_conf: None,
1497 0 : shard_number: tenant_shard_id.shard_number.0,
1498 0 : shard_count: tenant_shard_id.shard_count.literal(),
1499 0 : shard_stripe_size: 0,
1500 0 : tenant_conf: models::TenantConfig::default(),
1501 0 : };
1502 0 : client
1503 0 : .location_config(tenant_shard_id, config, None, false)
1504 0 : .await
1505 0 : },
1506 : &self.config.jwt_token,
1507 : 1,
1508 : 5,
1509 : SHORT_RECONCILE_TIMEOUT,
1510 : &self.cancel,
1511 : )
1512 : .await
1513 : {
1514 : None => {
1515 : // We're shutting down (the Node's cancellation token can't have fired, because
1516 : // we're the only scope that has a reference to it, and we didn't fire it).
1517 : return Err(ApiError::ShuttingDown);
1518 : }
1519 : Some(Err(e)) => {
1520 : // Do not let the node proceed to Active state if it is not responsive to requests
1521 : // to detach. This could happen if e.g. a shutdown bug in the pageserver is preventing
1522 : // detach completing: we should not let this node back into the set of nodes considered
1523 : // okay for scheduling.
1524 : return Err(ApiError::Conflict(format!(
1525 : "Node {node} failed to detach {tenant_shard_id}: {e}"
1526 : )));
1527 : }
1528 : Some(Ok(_)) => {}
1529 : };
1530 : }
1531 :
1532 : Ok(())
1533 : }
1534 :
1535 0 : pub(crate) async fn re_attach(
1536 0 : &self,
1537 0 : reattach_req: ReAttachRequest,
1538 0 : ) -> Result<ReAttachResponse, ApiError> {
1539 0 : if let Some(register_req) = reattach_req.register {
1540 0 : self.node_register(register_req).await?;
1541 0 : }
1542 :
1543 : // Ordering: we must persist generation number updates before making them visible in the in-memory state
1544 0 : let incremented_generations = self.persistence.re_attach(reattach_req.node_id).await?;
1545 :
1546 0 : tracing::info!(
1547 : node_id=%reattach_req.node_id,
1548 0 : "Incremented {} tenant shards' generations",
1549 0 : incremented_generations.len()
1550 : );
1551 :
1552 : // Apply the updated generation to our in-memory state, and
1553 : // gather discover secondary locations.
1554 0 : let mut locked = self.inner.write().unwrap();
1555 0 : let (nodes, tenants, scheduler) = locked.parts_mut();
1556 0 :
1557 0 : let mut response = ReAttachResponse {
1558 0 : tenants: Vec::new(),
1559 0 : };
1560 :
1561 : // TODO: cancel/restart any running reconciliation for this tenant, it might be trying
1562 : // to call location_conf API with an old generation. Wait for cancellation to complete
1563 : // before responding to this request. Requires well implemented CancellationToken logic
1564 : // all the way to where we call location_conf. Even then, there can still be a location_conf
1565 : // request in flight over the network: TODO handle that by making location_conf API refuse
1566 : // to go backward in generations.
1567 :
1568 : // Scan through all shards, applying updates for ones where we updated generation
1569 : // and identifying shards that intend to have a secondary location on this node.
1570 0 : for (tenant_shard_id, shard) in tenants {
1571 0 : if let Some(new_gen) = incremented_generations.get(tenant_shard_id) {
1572 0 : let new_gen = *new_gen;
1573 0 : response.tenants.push(ReAttachResponseTenant {
1574 0 : id: *tenant_shard_id,
1575 0 : gen: Some(new_gen.into().unwrap()),
1576 0 : // A tenant is only put into multi or stale modes in the middle of a [`Reconciler::live_migrate`]
1577 0 : // execution. If a pageserver is restarted during that process, then the reconcile pass will
1578 0 : // fail, and start from scratch, so it doesn't make sense for us to try and preserve
1579 0 : // the stale/multi states at this point.
1580 0 : mode: LocationConfigMode::AttachedSingle,
1581 0 : });
1582 0 :
1583 0 : shard.generation = std::cmp::max(shard.generation, Some(new_gen));
1584 0 : if let Some(observed) = shard.observed.locations.get_mut(&reattach_req.node_id) {
1585 : // Why can we update `observed` even though we're not sure our response will be received
1586 : // by the pageserver? Because the pageserver will not proceed with startup until
1587 : // it has processed response: if it loses it, we'll see another request and increment
1588 : // generation again, avoiding any uncertainty about dirtiness of tenant's state.
1589 0 : if let Some(conf) = observed.conf.as_mut() {
1590 0 : conf.generation = new_gen.into();
1591 0 : }
1592 0 : } else {
1593 0 : // This node has no observed state for the shard: perhaps it was offline
1594 0 : // when the pageserver restarted. Insert a None, so that the Reconciler
1595 0 : // will be prompted to learn the location's state before it makes changes.
1596 0 : shard
1597 0 : .observed
1598 0 : .locations
1599 0 : .insert(reattach_req.node_id, ObservedStateLocation { conf: None });
1600 0 : }
1601 0 : } else if shard.intent.get_secondary().contains(&reattach_req.node_id) {
1602 0 : // Ordering: pageserver will not accept /location_config requests until it has
1603 0 : // finished processing the response from re-attach. So we can update our in-memory state
1604 0 : // now, and be confident that we are not stamping on the result of some later location config.
1605 0 : // TODO: however, we are not strictly ordered wrt ReconcileResults queue,
1606 0 : // so we might update observed state here, and then get over-written by some racing
1607 0 : // ReconcileResult. The impact is low however, since we have set state on pageserver something
1608 0 : // that matches intent, so worst case if we race then we end up doing a spurious reconcile.
1609 0 :
1610 0 : response.tenants.push(ReAttachResponseTenant {
1611 0 : id: *tenant_shard_id,
1612 0 : gen: None,
1613 0 : mode: LocationConfigMode::Secondary,
1614 0 : });
1615 0 :
1616 0 : // We must not update observed, because we have no guarantee that our
1617 0 : // response will be received by the pageserver. This could leave it
1618 0 : // falsely dirty, but the resulting reconcile should be idempotent.
1619 0 : }
1620 : }
1621 :
1622 : // We consider a node Active once we have composed a re-attach response, but we
1623 : // do not call [`Self::node_activate_reconcile`]: the handling of the re-attach response
1624 : // implicitly synchronizes the LocationConfigs on the node.
1625 : //
1626 : // Setting a node active unblocks any Reconcilers that might write to the location config API,
1627 : // but those requests will not be accepted by the node until it has finished processing
1628 : // the re-attach response.
1629 : //
1630 : // Additionally, reset the nodes scheduling policy to match the conditional update done
1631 : // in [`Persistence::re_attach`].
1632 0 : if let Some(node) = nodes.get(&reattach_req.node_id) {
1633 0 : let reset_scheduling = matches!(
1634 0 : node.get_scheduling(),
1635 : NodeSchedulingPolicy::PauseForRestart
1636 : | NodeSchedulingPolicy::Draining
1637 : | NodeSchedulingPolicy::Filling
1638 : );
1639 :
1640 0 : if !node.is_available() || reset_scheduling {
1641 0 : let mut new_nodes = (**nodes).clone();
1642 0 : if let Some(node) = new_nodes.get_mut(&reattach_req.node_id) {
1643 0 : if !node.is_available() {
1644 0 : node.set_availability(NodeAvailability::Active(UtilizationScore::worst()));
1645 0 : }
1646 :
1647 0 : if reset_scheduling {
1648 0 : node.set_scheduling(NodeSchedulingPolicy::Active);
1649 0 : }
1650 :
1651 0 : scheduler.node_upsert(node);
1652 0 : let new_nodes = Arc::new(new_nodes);
1653 0 : *nodes = new_nodes;
1654 0 : }
1655 0 : }
1656 0 : }
1657 :
1658 0 : Ok(response)
1659 0 : }
1660 :
1661 0 : pub(crate) fn validate(&self, validate_req: ValidateRequest) -> ValidateResponse {
1662 0 : let locked = self.inner.read().unwrap();
1663 0 :
1664 0 : let mut response = ValidateResponse {
1665 0 : tenants: Vec::new(),
1666 0 : };
1667 :
1668 0 : for req_tenant in validate_req.tenants {
1669 0 : if let Some(tenant_shard) = locked.tenants.get(&req_tenant.id) {
1670 0 : let valid = tenant_shard.generation == Some(Generation::new(req_tenant.gen));
1671 0 : tracing::info!(
1672 0 : "handle_validate: {}(gen {}): valid={valid} (latest {:?})",
1673 : req_tenant.id,
1674 : req_tenant.gen,
1675 : tenant_shard.generation
1676 : );
1677 0 : response.tenants.push(ValidateResponseTenant {
1678 0 : id: req_tenant.id,
1679 0 : valid,
1680 0 : });
1681 0 : } else {
1682 0 : // After tenant deletion, we may approve any validation. This avoids
1683 0 : // spurious warnings on the pageserver if it has pending LSN updates
1684 0 : // at the point a deletion happens.
1685 0 : response.tenants.push(ValidateResponseTenant {
1686 0 : id: req_tenant.id,
1687 0 : valid: true,
1688 0 : });
1689 0 : }
1690 : }
1691 0 : response
1692 0 : }
1693 :
1694 0 : pub(crate) async fn tenant_create(
1695 0 : &self,
1696 0 : create_req: TenantCreateRequest,
1697 0 : ) -> Result<TenantCreateResponse, ApiError> {
1698 0 : let tenant_id = create_req.new_tenant_id.tenant_id;
1699 :
1700 : // Exclude any concurrent attempts to create/access the same tenant ID
1701 0 : let _tenant_lock = trace_exclusive_lock(
1702 0 : &self.tenant_op_locks,
1703 0 : create_req.new_tenant_id.tenant_id,
1704 0 : TenantOperations::Create,
1705 0 : )
1706 0 : .await;
1707 0 : let (response, waiters) = self.do_tenant_create(create_req).await?;
1708 :
1709 0 : if let Err(e) = self.await_waiters(waiters, RECONCILE_TIMEOUT).await {
1710 : // Avoid deadlock: reconcile may fail while notifying compute, if the cloud control plane refuses to
1711 : // accept compute notifications while it is in the process of creating. Reconciliation will
1712 : // be retried in the background.
1713 0 : tracing::warn!(%tenant_id, "Reconcile not done yet while creating tenant ({e})");
1714 0 : }
1715 0 : Ok(response)
1716 0 : }
1717 :
1718 0 : pub(crate) async fn do_tenant_create(
1719 0 : &self,
1720 0 : create_req: TenantCreateRequest,
1721 0 : ) -> Result<(TenantCreateResponse, Vec<ReconcilerWaiter>), ApiError> {
1722 0 : let placement_policy = create_req
1723 0 : .placement_policy
1724 0 : .clone()
1725 0 : // As a default, zero secondaries is convenient for tests that don't choose a policy.
1726 0 : .unwrap_or(PlacementPolicy::Attached(0));
1727 :
1728 : // This service expects to handle sharding itself: it is an error to try and directly create
1729 : // a particular shard here.
1730 0 : let tenant_id = if !create_req.new_tenant_id.is_unsharded() {
1731 0 : return Err(ApiError::BadRequest(anyhow::anyhow!(
1732 0 : "Attempted to create a specific shard, this API is for creating the whole tenant"
1733 0 : )));
1734 : } else {
1735 0 : create_req.new_tenant_id.tenant_id
1736 0 : };
1737 0 :
1738 0 : tracing::info!(
1739 0 : "Creating tenant {}, shard_count={:?}",
1740 : create_req.new_tenant_id,
1741 : create_req.shard_parameters.count,
1742 : );
1743 :
1744 0 : let create_ids = (0..create_req.shard_parameters.count.count())
1745 0 : .map(|i| TenantShardId {
1746 0 : tenant_id,
1747 0 : shard_number: ShardNumber(i),
1748 0 : shard_count: create_req.shard_parameters.count,
1749 0 : })
1750 0 : .collect::<Vec<_>>();
1751 :
1752 : // If the caller specifies a None generation, it means "start from default". This is different
1753 : // to [`Self::tenant_location_config`], where a None generation is used to represent
1754 : // an incompletely-onboarded tenant.
1755 0 : let initial_generation = if matches!(placement_policy, PlacementPolicy::Secondary) {
1756 0 : tracing::info!(
1757 0 : "tenant_create: secondary mode, generation is_some={}",
1758 0 : create_req.generation.is_some()
1759 : );
1760 0 : create_req.generation.map(Generation::new)
1761 : } else {
1762 0 : tracing::info!(
1763 0 : "tenant_create: not secondary mode, generation is_some={}",
1764 0 : create_req.generation.is_some()
1765 : );
1766 0 : Some(
1767 0 : create_req
1768 0 : .generation
1769 0 : .map(Generation::new)
1770 0 : .unwrap_or(INITIAL_GENERATION),
1771 0 : )
1772 : };
1773 :
1774 : // Ordering: we persist tenant shards before creating them on the pageserver. This enables a caller
1775 : // to clean up after themselves by issuing a tenant deletion if something goes wrong and we restart
1776 : // during the creation, rather than risking leaving orphan objects in S3.
1777 0 : let persist_tenant_shards = create_ids
1778 0 : .iter()
1779 0 : .map(|tenant_shard_id| TenantShardPersistence {
1780 0 : tenant_id: tenant_shard_id.tenant_id.to_string(),
1781 0 : shard_number: tenant_shard_id.shard_number.0 as i32,
1782 0 : shard_count: tenant_shard_id.shard_count.literal() as i32,
1783 0 : shard_stripe_size: create_req.shard_parameters.stripe_size.0 as i32,
1784 0 : generation: initial_generation.map(|g| g.into().unwrap() as i32),
1785 0 : // The pageserver is not known until scheduling happens: we will set this column when
1786 0 : // incrementing the generation the first time we attach to a pageserver.
1787 0 : generation_pageserver: None,
1788 0 : placement_policy: serde_json::to_string(&placement_policy).unwrap(),
1789 0 : config: serde_json::to_string(&create_req.config).unwrap(),
1790 0 : splitting: SplitState::default(),
1791 0 : scheduling_policy: serde_json::to_string(&ShardSchedulingPolicy::default())
1792 0 : .unwrap(),
1793 0 : })
1794 0 : .collect();
1795 0 :
1796 0 : match self
1797 0 : .persistence
1798 0 : .insert_tenant_shards(persist_tenant_shards)
1799 0 : .await
1800 : {
1801 0 : Ok(_) => {}
1802 : Err(DatabaseError::Query(diesel::result::Error::DatabaseError(
1803 : DatabaseErrorKind::UniqueViolation,
1804 : _,
1805 : ))) => {
1806 : // Unique key violation: this is probably a retry. Because the shard count is part of the unique key,
1807 : // if we see a unique key violation it means that the creation request's shard count matches the previous
1808 : // creation's shard count.
1809 0 : tracing::info!("Tenant shards already present in database, proceeding with idempotent creation...");
1810 : }
1811 : // Any other database error is unexpected and a bug.
1812 0 : Err(e) => return Err(ApiError::InternalServerError(anyhow::anyhow!(e))),
1813 : };
1814 :
1815 0 : let mut schedule_context = ScheduleContext::default();
1816 :
1817 0 : let (waiters, response_shards) = {
1818 0 : let mut locked = self.inner.write().unwrap();
1819 0 : let (nodes, tenants, scheduler) = locked.parts_mut();
1820 0 :
1821 0 : let mut response_shards = Vec::new();
1822 0 : let mut schcedule_error = None;
1823 :
1824 0 : for tenant_shard_id in create_ids {
1825 0 : tracing::info!("Creating shard {tenant_shard_id}...");
1826 :
1827 : use std::collections::btree_map::Entry;
1828 0 : match tenants.entry(tenant_shard_id) {
1829 0 : Entry::Occupied(mut entry) => {
1830 0 : tracing::info!(
1831 0 : "Tenant shard {tenant_shard_id} already exists while creating"
1832 : );
1833 :
1834 : // TODO: schedule() should take an anti-affinity expression that pushes
1835 : // attached and secondary locations (independently) away frorm those
1836 : // pageservers also holding a shard for this tenant.
1837 :
1838 0 : entry
1839 0 : .get_mut()
1840 0 : .schedule(scheduler, &mut schedule_context)
1841 0 : .map_err(|e| {
1842 0 : ApiError::Conflict(format!(
1843 0 : "Failed to schedule shard {tenant_shard_id}: {e}"
1844 0 : ))
1845 0 : })?;
1846 :
1847 0 : if let Some(node_id) = entry.get().intent.get_attached() {
1848 0 : let generation = entry
1849 0 : .get()
1850 0 : .generation
1851 0 : .expect("Generation is set when in attached mode");
1852 0 : response_shards.push(TenantCreateResponseShard {
1853 0 : shard_id: tenant_shard_id,
1854 0 : node_id: *node_id,
1855 0 : generation: generation.into().unwrap(),
1856 0 : });
1857 0 : }
1858 :
1859 0 : continue;
1860 : }
1861 0 : Entry::Vacant(entry) => {
1862 0 : let state = entry.insert(TenantShard::new(
1863 0 : tenant_shard_id,
1864 0 : ShardIdentity::from_params(
1865 0 : tenant_shard_id.shard_number,
1866 0 : &create_req.shard_parameters,
1867 0 : ),
1868 0 : placement_policy.clone(),
1869 0 : ));
1870 0 :
1871 0 : state.generation = initial_generation;
1872 0 : state.config = create_req.config.clone();
1873 0 : if let Err(e) = state.schedule(scheduler, &mut schedule_context) {
1874 0 : schcedule_error = Some(e);
1875 0 : }
1876 :
1877 : // Only include shards in result if we are attaching: the purpose
1878 : // of the response is to tell the caller where the shards are attached.
1879 0 : if let Some(node_id) = state.intent.get_attached() {
1880 0 : let generation = state
1881 0 : .generation
1882 0 : .expect("Generation is set when in attached mode");
1883 0 : response_shards.push(TenantCreateResponseShard {
1884 0 : shard_id: tenant_shard_id,
1885 0 : node_id: *node_id,
1886 0 : generation: generation.into().unwrap(),
1887 0 : });
1888 0 : }
1889 : }
1890 : };
1891 : }
1892 :
1893 : // If we failed to schedule shards, then they are still created in the controller,
1894 : // but we return an error to the requester to avoid a silent failure when someone
1895 : // tries to e.g. create a tenant whose placement policy requires more nodes than
1896 : // are present in the system. We do this here rather than in the above loop, to
1897 : // avoid situations where we only create a subset of shards in the tenant.
1898 0 : if let Some(e) = schcedule_error {
1899 0 : return Err(ApiError::Conflict(format!(
1900 0 : "Failed to schedule shard(s): {e}"
1901 0 : )));
1902 0 : }
1903 0 :
1904 0 : let waiters = tenants
1905 0 : .range_mut(TenantShardId::tenant_range(tenant_id))
1906 0 : .filter_map(|(_shard_id, shard)| self.maybe_reconcile_shard(shard, nodes))
1907 0 : .collect::<Vec<_>>();
1908 0 : (waiters, response_shards)
1909 0 : };
1910 0 :
1911 0 : Ok((
1912 0 : TenantCreateResponse {
1913 0 : shards: response_shards,
1914 0 : },
1915 0 : waiters,
1916 0 : ))
1917 0 : }
1918 :
1919 : /// Helper for functions that reconcile a number of shards, and would like to do a timeout-bounded
1920 : /// wait for reconciliation to complete before responding.
1921 0 : async fn await_waiters(
1922 0 : &self,
1923 0 : waiters: Vec<ReconcilerWaiter>,
1924 0 : timeout: Duration,
1925 0 : ) -> Result<(), ReconcileWaitError> {
1926 0 : let deadline = Instant::now().checked_add(timeout).unwrap();
1927 0 : for waiter in waiters {
1928 0 : let timeout = deadline.duration_since(Instant::now());
1929 0 : waiter.wait_timeout(timeout).await?;
1930 : }
1931 :
1932 0 : Ok(())
1933 0 : }
1934 :
1935 : /// Same as [`Service::await_waiters`], but returns the waiters which are still
1936 : /// in progress
1937 0 : async fn await_waiters_remainder(
1938 0 : &self,
1939 0 : waiters: Vec<ReconcilerWaiter>,
1940 0 : timeout: Duration,
1941 0 : ) -> Vec<ReconcilerWaiter> {
1942 0 : let deadline = Instant::now().checked_add(timeout).unwrap();
1943 0 : for waiter in waiters.iter() {
1944 0 : let timeout = deadline.duration_since(Instant::now());
1945 0 : let _ = waiter.wait_timeout(timeout).await;
1946 : }
1947 :
1948 0 : waiters
1949 0 : .into_iter()
1950 0 : .filter(|waiter| matches!(waiter.get_status(), ReconcilerStatus::InProgress))
1951 0 : .collect::<Vec<_>>()
1952 0 : }
1953 :
1954 : /// Part of [`Self::tenant_location_config`]: dissect an incoming location config request,
1955 : /// and transform it into either a tenant creation of a series of shard updates.
1956 : ///
1957 : /// If the incoming request makes no changes, a [`TenantCreateOrUpdate::Update`] result will
1958 : /// still be returned.
1959 0 : fn tenant_location_config_prepare(
1960 0 : &self,
1961 0 : tenant_id: TenantId,
1962 0 : req: TenantLocationConfigRequest,
1963 0 : ) -> TenantCreateOrUpdate {
1964 0 : let mut updates = Vec::new();
1965 0 : let mut locked = self.inner.write().unwrap();
1966 0 : let (nodes, tenants, _scheduler) = locked.parts_mut();
1967 0 : let tenant_shard_id = TenantShardId::unsharded(tenant_id);
1968 :
1969 : // Use location config mode as an indicator of policy.
1970 0 : let placement_policy = match req.config.mode {
1971 0 : LocationConfigMode::Detached => PlacementPolicy::Detached,
1972 0 : LocationConfigMode::Secondary => PlacementPolicy::Secondary,
1973 : LocationConfigMode::AttachedMulti
1974 : | LocationConfigMode::AttachedSingle
1975 : | LocationConfigMode::AttachedStale => {
1976 0 : if nodes.len() > 1 {
1977 0 : PlacementPolicy::Attached(1)
1978 : } else {
1979 : // Convenience for dev/test: if we just have one pageserver, import
1980 : // tenants into non-HA mode so that scheduling will succeed.
1981 0 : PlacementPolicy::Attached(0)
1982 : }
1983 : }
1984 : };
1985 :
1986 0 : let mut create = true;
1987 0 : for (shard_id, shard) in tenants.range_mut(TenantShardId::tenant_range(tenant_id)) {
1988 : // Saw an existing shard: this is not a creation
1989 0 : create = false;
1990 :
1991 : // Shards may have initially been created by a Secondary request, where we
1992 : // would have left generation as None.
1993 : //
1994 : // We only update generation the first time we see an attached-mode request,
1995 : // and if there is no existing generation set. The caller is responsible for
1996 : // ensuring that no non-storage-controller pageserver ever uses a higher
1997 : // generation than they passed in here.
1998 : use LocationConfigMode::*;
1999 0 : let set_generation = match req.config.mode {
2000 0 : AttachedMulti | AttachedSingle | AttachedStale if shard.generation.is_none() => {
2001 0 : req.config.generation.map(Generation::new)
2002 : }
2003 0 : _ => None,
2004 : };
2005 :
2006 0 : updates.push(ShardUpdate {
2007 0 : tenant_shard_id: *shard_id,
2008 0 : placement_policy: placement_policy.clone(),
2009 0 : tenant_config: req.config.tenant_conf.clone(),
2010 0 : generation: set_generation,
2011 0 : });
2012 : }
2013 :
2014 0 : if create {
2015 : use LocationConfigMode::*;
2016 0 : let generation = match req.config.mode {
2017 0 : AttachedMulti | AttachedSingle | AttachedStale => req.config.generation,
2018 : // If a caller provided a generation in a non-attached request, ignore it
2019 : // and leave our generation as None: this enables a subsequent update to set
2020 : // the generation when setting an attached mode for the first time.
2021 0 : _ => None,
2022 : };
2023 :
2024 0 : TenantCreateOrUpdate::Create(
2025 0 : // Synthesize a creation request
2026 0 : TenantCreateRequest {
2027 0 : new_tenant_id: tenant_shard_id,
2028 0 : generation,
2029 0 : shard_parameters: ShardParameters {
2030 0 : count: tenant_shard_id.shard_count,
2031 0 : // We only import un-sharded or single-sharded tenants, so stripe
2032 0 : // size can be made up arbitrarily here.
2033 0 : stripe_size: ShardParameters::DEFAULT_STRIPE_SIZE,
2034 0 : },
2035 0 : placement_policy: Some(placement_policy),
2036 0 : config: req.config.tenant_conf,
2037 0 : },
2038 0 : )
2039 : } else {
2040 0 : assert!(!updates.is_empty());
2041 0 : TenantCreateOrUpdate::Update(updates)
2042 : }
2043 0 : }
2044 :
2045 : /// This API is used by the cloud control plane to migrate unsharded tenants that it created
2046 : /// directly with pageservers into this service.
2047 : ///
2048 : /// Cloud control plane MUST NOT continue issuing GENERATION NUMBERS for this tenant once it
2049 : /// has attempted to call this API. Failure to oblige to this rule may lead to S3 corruption.
2050 : /// Think of the first attempt to call this API as a transfer of absolute authority over the
2051 : /// tenant's source of generation numbers.
2052 : ///
2053 : /// The mode in this request coarse-grained control of tenants:
2054 : /// - Call with mode Attached* to upsert the tenant.
2055 : /// - Call with mode Secondary to either onboard a tenant without attaching it, or
2056 : /// to set an existing tenant to PolicyMode::Secondary
2057 : /// - Call with mode Detached to switch to PolicyMode::Detached
2058 0 : pub(crate) async fn tenant_location_config(
2059 0 : &self,
2060 0 : tenant_shard_id: TenantShardId,
2061 0 : req: TenantLocationConfigRequest,
2062 0 : ) -> Result<TenantLocationConfigResponse, ApiError> {
2063 : // We require an exclusive lock, because we are updating both persistent and in-memory state
2064 0 : let _tenant_lock = trace_exclusive_lock(
2065 0 : &self.tenant_op_locks,
2066 0 : tenant_shard_id.tenant_id,
2067 0 : TenantOperations::LocationConfig,
2068 0 : )
2069 0 : .await;
2070 :
2071 0 : if !tenant_shard_id.is_unsharded() {
2072 0 : return Err(ApiError::BadRequest(anyhow::anyhow!(
2073 0 : "This API is for importing single-sharded or unsharded tenants"
2074 0 : )));
2075 0 : }
2076 0 :
2077 0 : // First check if this is a creation or an update
2078 0 : let create_or_update = self.tenant_location_config_prepare(tenant_shard_id.tenant_id, req);
2079 0 :
2080 0 : let mut result = TenantLocationConfigResponse {
2081 0 : shards: Vec::new(),
2082 0 : stripe_size: None,
2083 0 : };
2084 0 : let waiters = match create_or_update {
2085 0 : TenantCreateOrUpdate::Create(create_req) => {
2086 0 : let (create_resp, waiters) = self.do_tenant_create(create_req).await?;
2087 0 : result.shards = create_resp
2088 0 : .shards
2089 0 : .into_iter()
2090 0 : .map(|s| TenantShardLocation {
2091 0 : node_id: s.node_id,
2092 0 : shard_id: s.shard_id,
2093 0 : })
2094 0 : .collect();
2095 0 : waiters
2096 : }
2097 0 : TenantCreateOrUpdate::Update(updates) => {
2098 0 : // Persist updates
2099 0 : // Ordering: write to the database before applying changes in-memory, so that
2100 0 : // we will not appear time-travel backwards on a restart.
2101 0 : let mut schedule_context = ScheduleContext::default();
2102 : for ShardUpdate {
2103 0 : tenant_shard_id,
2104 0 : placement_policy,
2105 0 : tenant_config,
2106 0 : generation,
2107 0 : } in &updates
2108 : {
2109 0 : self.persistence
2110 0 : .update_tenant_shard(
2111 0 : TenantFilter::Shard(*tenant_shard_id),
2112 0 : Some(placement_policy.clone()),
2113 0 : Some(tenant_config.clone()),
2114 0 : *generation,
2115 0 : None,
2116 0 : )
2117 0 : .await?;
2118 : }
2119 :
2120 : // Apply updates in-memory
2121 0 : let mut waiters = Vec::new();
2122 0 : {
2123 0 : let mut locked = self.inner.write().unwrap();
2124 0 : let (nodes, tenants, scheduler) = locked.parts_mut();
2125 :
2126 : for ShardUpdate {
2127 0 : tenant_shard_id,
2128 0 : placement_policy,
2129 0 : tenant_config,
2130 0 : generation: update_generation,
2131 0 : } in updates
2132 : {
2133 0 : let Some(shard) = tenants.get_mut(&tenant_shard_id) else {
2134 0 : tracing::warn!("Shard {tenant_shard_id} removed while updating");
2135 0 : continue;
2136 : };
2137 :
2138 : // Update stripe size
2139 0 : if result.stripe_size.is_none() && shard.shard.count.count() > 1 {
2140 0 : result.stripe_size = Some(shard.shard.stripe_size);
2141 0 : }
2142 :
2143 0 : shard.policy = placement_policy;
2144 0 : shard.config = tenant_config;
2145 0 : if let Some(generation) = update_generation {
2146 0 : shard.generation = Some(generation);
2147 0 : }
2148 :
2149 0 : shard.schedule(scheduler, &mut schedule_context)?;
2150 :
2151 0 : let maybe_waiter = self.maybe_reconcile_shard(shard, nodes);
2152 0 : if let Some(waiter) = maybe_waiter {
2153 0 : waiters.push(waiter);
2154 0 : }
2155 :
2156 0 : if let Some(node_id) = shard.intent.get_attached() {
2157 0 : result.shards.push(TenantShardLocation {
2158 0 : shard_id: tenant_shard_id,
2159 0 : node_id: *node_id,
2160 0 : })
2161 0 : }
2162 : }
2163 : }
2164 0 : waiters
2165 : }
2166 : };
2167 :
2168 0 : if let Err(e) = self.await_waiters(waiters, SHORT_RECONCILE_TIMEOUT).await {
2169 : // Do not treat a reconcile error as fatal: we have already applied any requested
2170 : // Intent changes, and the reconcile can fail for external reasons like unavailable
2171 : // compute notification API. In these cases, it is important that we do not
2172 : // cause the cloud control plane to retry forever on this API.
2173 0 : tracing::warn!(
2174 0 : "Failed to reconcile after /location_config: {e}, returning success anyway"
2175 : );
2176 0 : }
2177 :
2178 : // Logging the full result is useful because it lets us cross-check what the cloud control
2179 : // plane's tenant_shards table should contain.
2180 0 : tracing::info!("Complete, returning {result:?}");
2181 :
2182 0 : Ok(result)
2183 0 : }
2184 :
2185 0 : pub(crate) async fn tenant_config_set(&self, req: TenantConfigRequest) -> Result<(), ApiError> {
2186 : // We require an exclusive lock, because we are updating persistent and in-memory state
2187 0 : let _tenant_lock = trace_exclusive_lock(
2188 0 : &self.tenant_op_locks,
2189 0 : req.tenant_id,
2190 0 : TenantOperations::ConfigSet,
2191 0 : )
2192 0 : .await;
2193 :
2194 0 : let tenant_id = req.tenant_id;
2195 0 : let config = req.config;
2196 0 :
2197 0 : self.persistence
2198 0 : .update_tenant_shard(
2199 0 : TenantFilter::Tenant(req.tenant_id),
2200 0 : None,
2201 0 : Some(config.clone()),
2202 0 : None,
2203 0 : None,
2204 0 : )
2205 0 : .await?;
2206 :
2207 0 : let waiters = {
2208 0 : let mut waiters = Vec::new();
2209 0 : let mut locked = self.inner.write().unwrap();
2210 0 : let (nodes, tenants, _scheduler) = locked.parts_mut();
2211 0 : for (_shard_id, shard) in tenants.range_mut(TenantShardId::tenant_range(tenant_id)) {
2212 0 : shard.config = config.clone();
2213 0 : if let Some(waiter) = self.maybe_reconcile_shard(shard, nodes) {
2214 0 : waiters.push(waiter);
2215 0 : }
2216 : }
2217 0 : waiters
2218 : };
2219 :
2220 0 : if let Err(e) = self.await_waiters(waiters, SHORT_RECONCILE_TIMEOUT).await {
2221 : // Treat this as success because we have stored the configuration. If e.g.
2222 : // a node was unavailable at this time, it should not stop us accepting a
2223 : // configuration change.
2224 0 : tracing::warn!(%tenant_id, "Accepted configuration update but reconciliation failed: {e}");
2225 0 : }
2226 :
2227 0 : Ok(())
2228 0 : }
2229 :
2230 0 : pub(crate) fn tenant_config_get(
2231 0 : &self,
2232 0 : tenant_id: TenantId,
2233 0 : ) -> Result<HashMap<&str, serde_json::Value>, ApiError> {
2234 0 : let config = {
2235 0 : let locked = self.inner.read().unwrap();
2236 0 :
2237 0 : match locked
2238 0 : .tenants
2239 0 : .range(TenantShardId::tenant_range(tenant_id))
2240 0 : .next()
2241 : {
2242 0 : Some((_tenant_shard_id, shard)) => shard.config.clone(),
2243 : None => {
2244 0 : return Err(ApiError::NotFound(
2245 0 : anyhow::anyhow!("Tenant not found").into(),
2246 0 : ))
2247 : }
2248 : }
2249 : };
2250 :
2251 : // Unlike the pageserver, we do not have a set of global defaults: the config is
2252 : // entirely per-tenant. Therefore the distinction between `tenant_specific_overrides`
2253 : // and `effective_config` in the response is meaningless, but we retain that syntax
2254 : // in order to remain compatible with the pageserver API.
2255 :
2256 0 : let response = HashMap::from([
2257 : (
2258 : "tenant_specific_overrides",
2259 0 : serde_json::to_value(&config)
2260 0 : .context("serializing tenant specific overrides")
2261 0 : .map_err(ApiError::InternalServerError)?,
2262 : ),
2263 : (
2264 0 : "effective_config",
2265 0 : serde_json::to_value(&config)
2266 0 : .context("serializing effective config")
2267 0 : .map_err(ApiError::InternalServerError)?,
2268 : ),
2269 : ]);
2270 :
2271 0 : Ok(response)
2272 0 : }
2273 :
2274 0 : pub(crate) async fn tenant_time_travel_remote_storage(
2275 0 : &self,
2276 0 : time_travel_req: &TenantTimeTravelRequest,
2277 0 : tenant_id: TenantId,
2278 0 : timestamp: Cow<'_, str>,
2279 0 : done_if_after: Cow<'_, str>,
2280 0 : ) -> Result<(), ApiError> {
2281 0 : let _tenant_lock = trace_exclusive_lock(
2282 0 : &self.tenant_op_locks,
2283 0 : tenant_id,
2284 0 : TenantOperations::TimeTravelRemoteStorage,
2285 0 : )
2286 0 : .await;
2287 :
2288 0 : let node = {
2289 0 : let locked = self.inner.read().unwrap();
2290 : // Just a sanity check to prevent misuse: the API expects that the tenant is fully
2291 : // detached everywhere, and nothing writes to S3 storage. Here, we verify that,
2292 : // but only at the start of the process, so it's really just to prevent operator
2293 : // mistakes.
2294 0 : for (shard_id, shard) in locked.tenants.range(TenantShardId::tenant_range(tenant_id)) {
2295 0 : if shard.intent.get_attached().is_some() || !shard.intent.get_secondary().is_empty()
2296 : {
2297 0 : return Err(ApiError::InternalServerError(anyhow::anyhow!(
2298 0 : "We want tenant to be attached in shard with tenant_shard_id={shard_id}"
2299 0 : )));
2300 0 : }
2301 0 : let maybe_attached = shard
2302 0 : .observed
2303 0 : .locations
2304 0 : .iter()
2305 0 : .filter_map(|(node_id, observed_location)| {
2306 0 : observed_location
2307 0 : .conf
2308 0 : .as_ref()
2309 0 : .map(|loc| (node_id, observed_location, loc.mode))
2310 0 : })
2311 0 : .find(|(_, _, mode)| *mode != LocationConfigMode::Detached);
2312 0 : if let Some((node_id, _observed_location, mode)) = maybe_attached {
2313 0 : return Err(ApiError::InternalServerError(anyhow::anyhow!("We observed attached={mode:?} tenant in node_id={node_id} shard with tenant_shard_id={shard_id}")));
2314 0 : }
2315 : }
2316 0 : let scheduler = &locked.scheduler;
2317 : // Right now we only perform the operation on a single node without parallelization
2318 : // TODO fan out the operation to multiple nodes for better performance
2319 0 : let node_id = scheduler.schedule_shard(&[], &ScheduleContext::default())?;
2320 0 : let node = locked
2321 0 : .nodes
2322 0 : .get(&node_id)
2323 0 : .expect("Pageservers may not be deleted while lock is active");
2324 0 : node.clone()
2325 0 : };
2326 0 :
2327 0 : // The shard count is encoded in the remote storage's URL, so we need to handle all historically used shard counts
2328 0 : let mut counts = time_travel_req
2329 0 : .shard_counts
2330 0 : .iter()
2331 0 : .copied()
2332 0 : .collect::<HashSet<_>>()
2333 0 : .into_iter()
2334 0 : .collect::<Vec<_>>();
2335 0 : counts.sort_unstable();
2336 :
2337 0 : for count in counts {
2338 0 : let shard_ids = (0..count.count())
2339 0 : .map(|i| TenantShardId {
2340 0 : tenant_id,
2341 0 : shard_number: ShardNumber(i),
2342 0 : shard_count: count,
2343 0 : })
2344 0 : .collect::<Vec<_>>();
2345 0 : for tenant_shard_id in shard_ids {
2346 0 : let client = PageserverClient::new(
2347 0 : node.get_id(),
2348 0 : node.base_url(),
2349 0 : self.config.jwt_token.as_deref(),
2350 0 : );
2351 0 :
2352 0 : tracing::info!("Doing time travel recovery for shard {tenant_shard_id}",);
2353 :
2354 0 : client
2355 0 : .tenant_time_travel_remote_storage(
2356 0 : tenant_shard_id,
2357 0 : ×tamp,
2358 0 : &done_if_after,
2359 0 : )
2360 0 : .await
2361 0 : .map_err(|e| {
2362 0 : ApiError::InternalServerError(anyhow::anyhow!(
2363 0 : "Error doing time travel recovery for shard {tenant_shard_id} on node {}: {e}",
2364 0 : node
2365 0 : ))
2366 0 : })?;
2367 : }
2368 : }
2369 0 : Ok(())
2370 0 : }
2371 :
2372 0 : pub(crate) async fn tenant_secondary_download(
2373 0 : &self,
2374 0 : tenant_id: TenantId,
2375 0 : wait: Option<Duration>,
2376 0 : ) -> Result<(StatusCode, SecondaryProgress), ApiError> {
2377 0 : let _tenant_lock = trace_shared_lock(
2378 0 : &self.tenant_op_locks,
2379 0 : tenant_id,
2380 0 : TenantOperations::SecondaryDownload,
2381 0 : )
2382 0 : .await;
2383 :
2384 : // Acquire lock and yield the collection of shard-node tuples which we will send requests onward to
2385 0 : let targets = {
2386 0 : let locked = self.inner.read().unwrap();
2387 0 : let mut targets = Vec::new();
2388 :
2389 0 : for (tenant_shard_id, shard) in
2390 0 : locked.tenants.range(TenantShardId::tenant_range(tenant_id))
2391 : {
2392 0 : for node_id in shard.intent.get_secondary() {
2393 0 : let node = locked
2394 0 : .nodes
2395 0 : .get(node_id)
2396 0 : .expect("Pageservers may not be deleted while referenced");
2397 0 :
2398 0 : targets.push((*tenant_shard_id, node.clone()));
2399 0 : }
2400 : }
2401 0 : targets
2402 0 : };
2403 0 :
2404 0 : // Issue concurrent requests to all shards' locations
2405 0 : let mut futs = FuturesUnordered::new();
2406 0 : for (tenant_shard_id, node) in targets {
2407 0 : let client = PageserverClient::new(
2408 0 : node.get_id(),
2409 0 : node.base_url(),
2410 0 : self.config.jwt_token.as_deref(),
2411 0 : );
2412 0 : futs.push(async move {
2413 0 : let result = client
2414 0 : .tenant_secondary_download(tenant_shard_id, wait)
2415 0 : .await;
2416 0 : (result, node, tenant_shard_id)
2417 0 : })
2418 : }
2419 :
2420 : // Handle any errors returned by pageservers. This includes cases like this request racing with
2421 : // a scheduling operation, such that the tenant shard we're calling doesn't exist on that pageserver any more, as
2422 : // well as more general cases like 503s, 500s, or timeouts.
2423 0 : let mut aggregate_progress = SecondaryProgress::default();
2424 0 : let mut aggregate_status: Option<StatusCode> = None;
2425 0 : let mut error: Option<mgmt_api::Error> = None;
2426 0 : while let Some((result, node, tenant_shard_id)) = futs.next().await {
2427 0 : match result {
2428 0 : Err(e) => {
2429 0 : // Secondary downloads are always advisory: if something fails, we nevertheless report success, so that whoever
2430 0 : // is calling us will proceed with whatever migration they're doing, albeit with a slightly less warm cache
2431 0 : // than they had hoped for.
2432 0 : tracing::warn!("Secondary download error from pageserver {node}: {e}",);
2433 0 : error = Some(e)
2434 : }
2435 0 : Ok((status_code, progress)) => {
2436 0 : tracing::info!(%tenant_shard_id, "Shard status={status_code} progress: {progress:?}");
2437 0 : aggregate_progress.layers_downloaded += progress.layers_downloaded;
2438 0 : aggregate_progress.layers_total += progress.layers_total;
2439 0 : aggregate_progress.bytes_downloaded += progress.bytes_downloaded;
2440 0 : aggregate_progress.bytes_total += progress.bytes_total;
2441 0 : aggregate_progress.heatmap_mtime =
2442 0 : std::cmp::max(aggregate_progress.heatmap_mtime, progress.heatmap_mtime);
2443 0 : aggregate_status = match aggregate_status {
2444 0 : None => Some(status_code),
2445 0 : Some(StatusCode::OK) => Some(status_code),
2446 0 : Some(cur) => {
2447 0 : // Other status codes (e.g. 202) -- do not overwrite.
2448 0 : Some(cur)
2449 : }
2450 : };
2451 : }
2452 : }
2453 : }
2454 :
2455 : // If any of the shards return 202, indicate our result as 202.
2456 0 : match aggregate_status {
2457 : None => {
2458 0 : match error {
2459 0 : Some(e) => {
2460 0 : // No successes, and an error: surface it
2461 0 : Err(ApiError::Conflict(format!("Error from pageserver: {e}")))
2462 : }
2463 : None => {
2464 : // No shards found
2465 0 : Err(ApiError::NotFound(
2466 0 : anyhow::anyhow!("Tenant {} not found", tenant_id).into(),
2467 0 : ))
2468 : }
2469 : }
2470 : }
2471 0 : Some(aggregate_status) => Ok((aggregate_status, aggregate_progress)),
2472 : }
2473 0 : }
2474 :
2475 0 : pub(crate) async fn tenant_delete(&self, tenant_id: TenantId) -> Result<StatusCode, ApiError> {
2476 0 : let _tenant_lock =
2477 0 : trace_exclusive_lock(&self.tenant_op_locks, tenant_id, TenantOperations::Delete).await;
2478 :
2479 : // Detach all shards
2480 0 : let (detach_waiters, shard_ids, node) = {
2481 0 : let mut shard_ids = Vec::new();
2482 0 : let mut detach_waiters = Vec::new();
2483 0 : let mut locked = self.inner.write().unwrap();
2484 0 : let (nodes, tenants, scheduler) = locked.parts_mut();
2485 0 : for (tenant_shard_id, shard) in
2486 0 : tenants.range_mut(TenantShardId::tenant_range(tenant_id))
2487 : {
2488 0 : shard_ids.push(*tenant_shard_id);
2489 0 :
2490 0 : // Update the tenant's intent to remove all attachments
2491 0 : shard.policy = PlacementPolicy::Detached;
2492 0 : shard
2493 0 : .schedule(scheduler, &mut ScheduleContext::default())
2494 0 : .expect("De-scheduling is infallible");
2495 0 : debug_assert!(shard.intent.get_attached().is_none());
2496 0 : debug_assert!(shard.intent.get_secondary().is_empty());
2497 :
2498 0 : if let Some(waiter) = self.maybe_reconcile_shard(shard, nodes) {
2499 0 : detach_waiters.push(waiter);
2500 0 : }
2501 : }
2502 :
2503 : // Pick an arbitrary node to use for remote deletions (does not have to be where the tenant
2504 : // was attached, just has to be able to see the S3 content)
2505 0 : let node_id = scheduler.schedule_shard(&[], &ScheduleContext::default())?;
2506 0 : let node = nodes
2507 0 : .get(&node_id)
2508 0 : .expect("Pageservers may not be deleted while lock is active");
2509 0 : (detach_waiters, shard_ids, node.clone())
2510 0 : };
2511 0 :
2512 0 : // This reconcile wait can fail in a few ways:
2513 0 : // A there is a very long queue for the reconciler semaphore
2514 0 : // B some pageserver is failing to handle a detach promptly
2515 0 : // C some pageserver goes offline right at the moment we send it a request.
2516 0 : //
2517 0 : // A and C are transient: the semaphore will eventually become available, and once a node is marked offline
2518 0 : // the next attempt to reconcile will silently skip detaches for an offline node and succeed. If B happens,
2519 0 : // it's a bug, and needs resolving at the pageserver level (we shouldn't just leave attachments behind while
2520 0 : // deleting the underlying data).
2521 0 : self.await_waiters(detach_waiters, RECONCILE_TIMEOUT)
2522 0 : .await?;
2523 :
2524 0 : let locations = shard_ids
2525 0 : .into_iter()
2526 0 : .map(|s| (s, node.clone()))
2527 0 : .collect::<Vec<_>>();
2528 0 : let results = self.tenant_for_shards_api(
2529 0 : locations,
2530 0 : |tenant_shard_id, client| async move { client.tenant_delete(tenant_shard_id).await },
2531 0 : 1,
2532 0 : 3,
2533 0 : RECONCILE_TIMEOUT,
2534 0 : &self.cancel,
2535 0 : )
2536 0 : .await;
2537 0 : for result in results {
2538 0 : match result {
2539 : Ok(StatusCode::ACCEPTED) => {
2540 : // This should never happen: we waited for detaches to finish above
2541 0 : return Err(ApiError::InternalServerError(anyhow::anyhow!(
2542 0 : "Unexpectedly still attached on {}",
2543 0 : node
2544 0 : )));
2545 : }
2546 0 : Ok(_) => {}
2547 : Err(mgmt_api::Error::Cancelled) => {
2548 0 : return Err(ApiError::ShuttingDown);
2549 : }
2550 0 : Err(e) => {
2551 0 : // This is unexpected: remote deletion should be infallible, unless the object store
2552 0 : // at large is unavailable.
2553 0 : tracing::error!("Error deleting via node {}: {e}", node);
2554 0 : return Err(ApiError::InternalServerError(anyhow::anyhow!(e)));
2555 : }
2556 : }
2557 : }
2558 :
2559 : // Fall through: deletion of the tenant on pageservers is complete, we may proceed to drop
2560 : // our in-memory state and database state.
2561 :
2562 : // Ordering: we delete persistent state first: if we then
2563 : // crash, we will drop the in-memory state.
2564 :
2565 : // Drop persistent state.
2566 0 : self.persistence.delete_tenant(tenant_id).await?;
2567 :
2568 : // Drop in-memory state
2569 : {
2570 0 : let mut locked = self.inner.write().unwrap();
2571 0 : let (_nodes, tenants, scheduler) = locked.parts_mut();
2572 :
2573 : // Dereference Scheduler from shards before dropping them
2574 0 : for (_tenant_shard_id, shard) in
2575 0 : tenants.range_mut(TenantShardId::tenant_range(tenant_id))
2576 0 : {
2577 0 : shard.intent.clear(scheduler);
2578 0 : }
2579 :
2580 0 : tenants.retain(|tenant_shard_id, _shard| tenant_shard_id.tenant_id != tenant_id);
2581 0 : tracing::info!(
2582 0 : "Deleted tenant {tenant_id}, now have {} tenants",
2583 0 : locked.tenants.len()
2584 : );
2585 : };
2586 :
2587 : // Success is represented as 404, to imitate the existing pageserver deletion API
2588 0 : Ok(StatusCode::NOT_FOUND)
2589 0 : }
2590 :
2591 : /// Naming: this configures the storage controller's policies for a tenant, whereas [`Self::tenant_config_set`] is "set the TenantConfig"
2592 : /// for a tenant. The TenantConfig is passed through to pageservers, whereas this function modifies
2593 : /// the tenant's policies (configuration) within the storage controller
2594 0 : pub(crate) async fn tenant_update_policy(
2595 0 : &self,
2596 0 : tenant_id: TenantId,
2597 0 : req: TenantPolicyRequest,
2598 0 : ) -> Result<(), ApiError> {
2599 : // We require an exclusive lock, because we are updating persistent and in-memory state
2600 0 : let _tenant_lock = trace_exclusive_lock(
2601 0 : &self.tenant_op_locks,
2602 0 : tenant_id,
2603 0 : TenantOperations::UpdatePolicy,
2604 0 : )
2605 0 : .await;
2606 :
2607 0 : failpoint_support::sleep_millis_async!("tenant-update-policy-exclusive-lock");
2608 :
2609 : let TenantPolicyRequest {
2610 0 : placement,
2611 0 : scheduling,
2612 0 : } = req;
2613 0 :
2614 0 : self.persistence
2615 0 : .update_tenant_shard(
2616 0 : TenantFilter::Tenant(tenant_id),
2617 0 : placement.clone(),
2618 0 : None,
2619 0 : None,
2620 0 : scheduling,
2621 0 : )
2622 0 : .await?;
2623 :
2624 0 : let mut schedule_context = ScheduleContext::default();
2625 0 : let mut locked = self.inner.write().unwrap();
2626 0 : let (nodes, tenants, scheduler) = locked.parts_mut();
2627 0 : for (shard_id, shard) in tenants.range_mut(TenantShardId::tenant_range(tenant_id)) {
2628 0 : if let Some(placement) = &placement {
2629 0 : shard.policy = placement.clone();
2630 0 :
2631 0 : tracing::info!(tenant_id=%shard_id.tenant_id, shard_id=%shard_id.shard_slug(),
2632 0 : "Updated placement policy to {placement:?}");
2633 0 : }
2634 :
2635 0 : if let Some(scheduling) = &scheduling {
2636 0 : shard.set_scheduling_policy(*scheduling);
2637 0 :
2638 0 : tracing::info!(tenant_id=%shard_id.tenant_id, shard_id=%shard_id.shard_slug(),
2639 0 : "Updated scheduling policy to {scheduling:?}");
2640 0 : }
2641 :
2642 : // In case scheduling is being switched back on, try it now.
2643 0 : shard.schedule(scheduler, &mut schedule_context).ok();
2644 0 : self.maybe_reconcile_shard(shard, nodes);
2645 : }
2646 :
2647 0 : Ok(())
2648 0 : }
2649 :
2650 0 : pub(crate) async fn tenant_timeline_create(
2651 0 : &self,
2652 0 : tenant_id: TenantId,
2653 0 : mut create_req: TimelineCreateRequest,
2654 0 : ) -> Result<TimelineInfo, ApiError> {
2655 0 : tracing::info!(
2656 0 : "Creating timeline {}/{}",
2657 : tenant_id,
2658 : create_req.new_timeline_id,
2659 : );
2660 :
2661 0 : let _tenant_lock = trace_shared_lock(
2662 0 : &self.tenant_op_locks,
2663 0 : tenant_id,
2664 0 : TenantOperations::TimelineCreate,
2665 0 : )
2666 0 : .await;
2667 0 : failpoint_support::sleep_millis_async!("tenant-create-timeline-shared-lock");
2668 :
2669 0 : self.ensure_attached_wait(tenant_id).await?;
2670 :
2671 0 : let mut targets = {
2672 0 : let locked = self.inner.read().unwrap();
2673 0 : let mut targets = Vec::new();
2674 :
2675 0 : for (tenant_shard_id, shard) in
2676 0 : locked.tenants.range(TenantShardId::tenant_range(tenant_id))
2677 0 : {
2678 0 : let node_id = shard.intent.get_attached().ok_or_else(|| {
2679 0 : ApiError::InternalServerError(anyhow::anyhow!("Shard not scheduled"))
2680 0 : })?;
2681 0 : let node = locked
2682 0 : .nodes
2683 0 : .get(&node_id)
2684 0 : .expect("Pageservers may not be deleted while referenced");
2685 0 :
2686 0 : targets.push((*tenant_shard_id, node.clone()));
2687 : }
2688 0 : targets
2689 0 : };
2690 0 :
2691 0 : if targets.is_empty() {
2692 0 : return Err(ApiError::NotFound(
2693 0 : anyhow::anyhow!("Tenant not found").into(),
2694 0 : ));
2695 0 : };
2696 0 : let shard_zero = targets.remove(0);
2697 :
2698 0 : async fn create_one(
2699 0 : tenant_shard_id: TenantShardId,
2700 0 : node: Node,
2701 0 : jwt: Option<String>,
2702 0 : create_req: TimelineCreateRequest,
2703 0 : ) -> Result<TimelineInfo, ApiError> {
2704 0 : tracing::info!(
2705 0 : "Creating timeline on shard {}/{}, attached to node {node}",
2706 : tenant_shard_id,
2707 : create_req.new_timeline_id,
2708 : );
2709 0 : let client = PageserverClient::new(node.get_id(), node.base_url(), jwt.as_deref());
2710 0 :
2711 0 : client
2712 0 : .timeline_create(tenant_shard_id, &create_req)
2713 0 : .await
2714 0 : .map_err(|e| passthrough_api_error(&node, e))
2715 0 : }
2716 :
2717 : // Because the caller might not provide an explicit LSN, we must do the creation first on a single shard, and then
2718 : // use whatever LSN that shard picked when creating on subsequent shards. We arbitrarily use shard zero as the shard
2719 : // that will get the first creation request, and propagate the LSN to all the >0 shards.
2720 0 : let timeline_info = create_one(
2721 0 : shard_zero.0,
2722 0 : shard_zero.1,
2723 0 : self.config.jwt_token.clone(),
2724 0 : create_req.clone(),
2725 0 : )
2726 0 : .await?;
2727 :
2728 : // Propagate the LSN that shard zero picked, if caller didn't provide one
2729 0 : if create_req.ancestor_timeline_id.is_some() && create_req.ancestor_start_lsn.is_none() {
2730 0 : create_req.ancestor_start_lsn = timeline_info.ancestor_lsn;
2731 0 : }
2732 :
2733 : // Create timeline on remaining shards with number >0
2734 0 : if !targets.is_empty() {
2735 : // If we had multiple shards, issue requests for the remainder now.
2736 0 : let jwt = self.config.jwt_token.clone();
2737 0 : self.tenant_for_shards(targets, |tenant_shard_id: TenantShardId, node: Node| {
2738 0 : let create_req = create_req.clone();
2739 0 : Box::pin(create_one(tenant_shard_id, node, jwt.clone(), create_req))
2740 0 : })
2741 0 : .await?;
2742 0 : }
2743 :
2744 0 : Ok(timeline_info)
2745 0 : }
2746 :
2747 : /// Helper for concurrently calling a pageserver API on a number of shards, such as timeline creation.
2748 : ///
2749 : /// On success, the returned vector contains exactly the same number of elements as the input `locations`.
2750 0 : async fn tenant_for_shards<F, R>(
2751 0 : &self,
2752 0 : locations: Vec<(TenantShardId, Node)>,
2753 0 : mut req_fn: F,
2754 0 : ) -> Result<Vec<R>, ApiError>
2755 0 : where
2756 0 : F: FnMut(
2757 0 : TenantShardId,
2758 0 : Node,
2759 0 : )
2760 0 : -> std::pin::Pin<Box<dyn futures::Future<Output = Result<R, ApiError>> + Send>>,
2761 0 : {
2762 0 : let mut futs = FuturesUnordered::new();
2763 0 : let mut results = Vec::with_capacity(locations.len());
2764 :
2765 0 : for (tenant_shard_id, node) in locations {
2766 0 : futs.push(req_fn(tenant_shard_id, node));
2767 0 : }
2768 :
2769 0 : while let Some(r) = futs.next().await {
2770 0 : results.push(r?);
2771 : }
2772 :
2773 0 : Ok(results)
2774 0 : }
2775 :
2776 : /// Concurrently invoke a pageserver API call on many shards at once
2777 0 : pub(crate) async fn tenant_for_shards_api<T, O, F>(
2778 0 : &self,
2779 0 : locations: Vec<(TenantShardId, Node)>,
2780 0 : op: O,
2781 0 : warn_threshold: u32,
2782 0 : max_retries: u32,
2783 0 : timeout: Duration,
2784 0 : cancel: &CancellationToken,
2785 0 : ) -> Vec<mgmt_api::Result<T>>
2786 0 : where
2787 0 : O: Fn(TenantShardId, PageserverClient) -> F + Copy,
2788 0 : F: std::future::Future<Output = mgmt_api::Result<T>>,
2789 0 : {
2790 0 : let mut futs = FuturesUnordered::new();
2791 0 : let mut results = Vec::with_capacity(locations.len());
2792 :
2793 0 : for (tenant_shard_id, node) in locations {
2794 0 : futs.push(async move {
2795 0 : node.with_client_retries(
2796 0 : |client| op(tenant_shard_id, client),
2797 0 : &self.config.jwt_token,
2798 0 : warn_threshold,
2799 0 : max_retries,
2800 0 : timeout,
2801 0 : cancel,
2802 0 : )
2803 0 : .await
2804 0 : });
2805 0 : }
2806 :
2807 0 : while let Some(r) = futs.next().await {
2808 0 : let r = r.unwrap_or(Err(mgmt_api::Error::Cancelled));
2809 0 : results.push(r);
2810 0 : }
2811 :
2812 0 : results
2813 0 : }
2814 :
2815 0 : pub(crate) async fn tenant_timeline_delete(
2816 0 : &self,
2817 0 : tenant_id: TenantId,
2818 0 : timeline_id: TimelineId,
2819 0 : ) -> Result<StatusCode, ApiError> {
2820 0 : tracing::info!("Deleting timeline {}/{}", tenant_id, timeline_id,);
2821 0 : let _tenant_lock = trace_shared_lock(
2822 0 : &self.tenant_op_locks,
2823 0 : tenant_id,
2824 0 : TenantOperations::TimelineDelete,
2825 0 : )
2826 0 : .await;
2827 :
2828 0 : self.ensure_attached_wait(tenant_id).await?;
2829 :
2830 0 : let mut targets = {
2831 0 : let locked = self.inner.read().unwrap();
2832 0 : let mut targets = Vec::new();
2833 :
2834 0 : for (tenant_shard_id, shard) in
2835 0 : locked.tenants.range(TenantShardId::tenant_range(tenant_id))
2836 0 : {
2837 0 : let node_id = shard.intent.get_attached().ok_or_else(|| {
2838 0 : ApiError::InternalServerError(anyhow::anyhow!("Shard not scheduled"))
2839 0 : })?;
2840 0 : let node = locked
2841 0 : .nodes
2842 0 : .get(&node_id)
2843 0 : .expect("Pageservers may not be deleted while referenced");
2844 0 :
2845 0 : targets.push((*tenant_shard_id, node.clone()));
2846 : }
2847 0 : targets
2848 0 : };
2849 0 :
2850 0 : if targets.is_empty() {
2851 0 : return Err(ApiError::NotFound(
2852 0 : anyhow::anyhow!("Tenant not found").into(),
2853 0 : ));
2854 0 : }
2855 0 : let shard_zero = targets.remove(0);
2856 :
2857 0 : async fn delete_one(
2858 0 : tenant_shard_id: TenantShardId,
2859 0 : timeline_id: TimelineId,
2860 0 : node: Node,
2861 0 : jwt: Option<String>,
2862 0 : ) -> Result<StatusCode, ApiError> {
2863 0 : tracing::info!(
2864 0 : "Deleting timeline on shard {tenant_shard_id}/{timeline_id}, attached to node {node}",
2865 : );
2866 :
2867 0 : let client = PageserverClient::new(node.get_id(), node.base_url(), jwt.as_deref());
2868 0 : client
2869 0 : .timeline_delete(tenant_shard_id, timeline_id)
2870 0 : .await
2871 0 : .map_err(|e| {
2872 0 : ApiError::InternalServerError(anyhow::anyhow!(
2873 0 : "Error deleting timeline {timeline_id} on {tenant_shard_id} on node {node}: {e}",
2874 0 : ))
2875 0 : })
2876 0 : }
2877 :
2878 0 : let statuses = self
2879 0 : .tenant_for_shards(targets, |tenant_shard_id: TenantShardId, node: Node| {
2880 0 : Box::pin(delete_one(
2881 0 : tenant_shard_id,
2882 0 : timeline_id,
2883 0 : node,
2884 0 : self.config.jwt_token.clone(),
2885 0 : ))
2886 0 : })
2887 0 : .await?;
2888 :
2889 : // If any shards >0 haven't finished deletion yet, don't start deletion on shard zero
2890 0 : if statuses.iter().any(|s| s != &StatusCode::NOT_FOUND) {
2891 0 : return Ok(StatusCode::ACCEPTED);
2892 0 : }
2893 :
2894 : // Delete shard zero last: this is not strictly necessary, but since a caller's GET on a timeline will be routed
2895 : // to shard zero, it gives a more obvious behavior that a GET returns 404 once the deletion is done.
2896 0 : let shard_zero_status = delete_one(
2897 0 : shard_zero.0,
2898 0 : timeline_id,
2899 0 : shard_zero.1,
2900 0 : self.config.jwt_token.clone(),
2901 0 : )
2902 0 : .await?;
2903 :
2904 0 : Ok(shard_zero_status)
2905 0 : }
2906 :
2907 : /// When you need to send an HTTP request to the pageserver that holds shard0 of a tenant, this
2908 : /// function looks up and returns node. If the tenant isn't found, returns Err(ApiError::NotFound)
2909 0 : pub(crate) fn tenant_shard0_node(
2910 0 : &self,
2911 0 : tenant_id: TenantId,
2912 0 : ) -> Result<(Node, TenantShardId), ApiError> {
2913 0 : let locked = self.inner.read().unwrap();
2914 0 : let Some((tenant_shard_id, shard)) = locked
2915 0 : .tenants
2916 0 : .range(TenantShardId::tenant_range(tenant_id))
2917 0 : .next()
2918 : else {
2919 0 : return Err(ApiError::NotFound(
2920 0 : anyhow::anyhow!("Tenant {tenant_id} not found").into(),
2921 0 : ));
2922 : };
2923 :
2924 : // TODO: should use the ID last published to compute_hook, rather than the intent: the intent might
2925 : // point to somewhere we haven't attached yet.
2926 0 : let Some(node_id) = shard.intent.get_attached() else {
2927 0 : tracing::warn!(
2928 0 : tenant_id=%tenant_shard_id.tenant_id, shard_id=%tenant_shard_id.shard_slug(),
2929 0 : "Shard not scheduled (policy {:?}), cannot generate pass-through URL",
2930 : shard.policy
2931 : );
2932 0 : return Err(ApiError::Conflict(
2933 0 : "Cannot call timeline API on non-attached tenant".to_string(),
2934 0 : ));
2935 : };
2936 :
2937 0 : let Some(node) = locked.nodes.get(node_id) else {
2938 : // This should never happen
2939 0 : return Err(ApiError::InternalServerError(anyhow::anyhow!(
2940 0 : "Shard refers to nonexistent node"
2941 0 : )));
2942 : };
2943 :
2944 0 : Ok((node.clone(), *tenant_shard_id))
2945 0 : }
2946 :
2947 0 : pub(crate) fn tenant_locate(
2948 0 : &self,
2949 0 : tenant_id: TenantId,
2950 0 : ) -> Result<TenantLocateResponse, ApiError> {
2951 0 : let locked = self.inner.read().unwrap();
2952 0 : tracing::info!("Locating shards for tenant {tenant_id}");
2953 :
2954 0 : let mut result = Vec::new();
2955 0 : let mut shard_params: Option<ShardParameters> = None;
2956 :
2957 0 : for (tenant_shard_id, shard) in locked.tenants.range(TenantShardId::tenant_range(tenant_id))
2958 : {
2959 0 : let node_id =
2960 0 : shard
2961 0 : .intent
2962 0 : .get_attached()
2963 0 : .ok_or(ApiError::BadRequest(anyhow::anyhow!(
2964 0 : "Cannot locate a tenant that is not attached"
2965 0 : )))?;
2966 :
2967 0 : let node = locked
2968 0 : .nodes
2969 0 : .get(&node_id)
2970 0 : .expect("Pageservers may not be deleted while referenced");
2971 0 :
2972 0 : result.push(node.shard_location(*tenant_shard_id));
2973 0 :
2974 0 : match &shard_params {
2975 0 : None => {
2976 0 : shard_params = Some(ShardParameters {
2977 0 : stripe_size: shard.shard.stripe_size,
2978 0 : count: shard.shard.count,
2979 0 : });
2980 0 : }
2981 0 : Some(params) => {
2982 0 : if params.stripe_size != shard.shard.stripe_size {
2983 : // This should never happen. We enforce at runtime because it's simpler than
2984 : // adding an extra per-tenant data structure to store the things that should be the same
2985 0 : return Err(ApiError::InternalServerError(anyhow::anyhow!(
2986 0 : "Inconsistent shard stripe size parameters!"
2987 0 : )));
2988 0 : }
2989 : }
2990 : }
2991 : }
2992 :
2993 0 : if result.is_empty() {
2994 0 : return Err(ApiError::NotFound(
2995 0 : anyhow::anyhow!("No shards for this tenant ID found").into(),
2996 0 : ));
2997 0 : }
2998 0 : let shard_params = shard_params.expect("result is non-empty, therefore this is set");
2999 0 : tracing::info!(
3000 0 : "Located tenant {} with params {:?} on shards {}",
3001 0 : tenant_id,
3002 0 : shard_params,
3003 0 : result
3004 0 : .iter()
3005 0 : .map(|s| format!("{:?}", s))
3006 0 : .collect::<Vec<_>>()
3007 0 : .join(",")
3008 : );
3009 :
3010 0 : Ok(TenantLocateResponse {
3011 0 : shards: result,
3012 0 : shard_params,
3013 0 : })
3014 0 : }
3015 :
3016 : /// Returns None if the input iterator of shards does not include a shard with number=0
3017 0 : fn tenant_describe_impl<'a>(
3018 0 : &self,
3019 0 : shards: impl Iterator<Item = &'a TenantShard>,
3020 0 : ) -> Option<TenantDescribeResponse> {
3021 0 : let mut shard_zero = None;
3022 0 : let mut describe_shards = Vec::new();
3023 :
3024 0 : for shard in shards {
3025 0 : if shard.tenant_shard_id.is_shard_zero() {
3026 0 : shard_zero = Some(shard);
3027 0 : }
3028 :
3029 0 : describe_shards.push(TenantDescribeResponseShard {
3030 0 : tenant_shard_id: shard.tenant_shard_id,
3031 0 : node_attached: *shard.intent.get_attached(),
3032 0 : node_secondary: shard.intent.get_secondary().to_vec(),
3033 0 : last_error: shard
3034 0 : .last_error
3035 0 : .lock()
3036 0 : .unwrap()
3037 0 : .as_ref()
3038 0 : .map(|e| format!("{e}"))
3039 0 : .unwrap_or("".to_string())
3040 0 : .clone(),
3041 0 : is_reconciling: shard.reconciler.is_some(),
3042 0 : is_pending_compute_notification: shard.pending_compute_notification,
3043 0 : is_splitting: matches!(shard.splitting, SplitState::Splitting),
3044 0 : scheduling_policy: *shard.get_scheduling_policy(),
3045 : })
3046 : }
3047 :
3048 0 : let shard_zero = shard_zero?;
3049 :
3050 0 : Some(TenantDescribeResponse {
3051 0 : tenant_id: shard_zero.tenant_shard_id.tenant_id,
3052 0 : shards: describe_shards,
3053 0 : stripe_size: shard_zero.shard.stripe_size,
3054 0 : policy: shard_zero.policy.clone(),
3055 0 : config: shard_zero.config.clone(),
3056 0 : })
3057 0 : }
3058 :
3059 0 : pub(crate) fn tenant_describe(
3060 0 : &self,
3061 0 : tenant_id: TenantId,
3062 0 : ) -> Result<TenantDescribeResponse, ApiError> {
3063 0 : let locked = self.inner.read().unwrap();
3064 0 :
3065 0 : self.tenant_describe_impl(
3066 0 : locked
3067 0 : .tenants
3068 0 : .range(TenantShardId::tenant_range(tenant_id))
3069 0 : .map(|(_k, v)| v),
3070 0 : )
3071 0 : .ok_or_else(|| ApiError::NotFound(anyhow::anyhow!("Tenant {tenant_id} not found").into()))
3072 0 : }
3073 :
3074 0 : pub(crate) fn tenant_list(&self) -> Vec<TenantDescribeResponse> {
3075 0 : let locked = self.inner.read().unwrap();
3076 0 :
3077 0 : let mut result = Vec::new();
3078 0 : for (_tenant_id, tenant_shards) in
3079 0 : &locked.tenants.iter().group_by(|(id, _shard)| id.tenant_id)
3080 0 : {
3081 0 : result.push(
3082 0 : self.tenant_describe_impl(tenant_shards.map(|(_k, v)| v))
3083 0 : .expect("Groups are always non-empty"),
3084 0 : );
3085 0 : }
3086 :
3087 0 : result
3088 0 : }
3089 :
3090 0 : #[instrument(skip_all, fields(tenant_id=%op.tenant_id))]
3091 : async fn abort_tenant_shard_split(
3092 : &self,
3093 : op: &TenantShardSplitAbort,
3094 : ) -> Result<(), TenantShardSplitAbortError> {
3095 : // Cleaning up a split:
3096 : // - Parent shards are not destroyed during a split, just detached.
3097 : // - Failed pageserver split API calls can leave the remote node with just the parent attached,
3098 : // just the children attached, or both.
3099 : //
3100 : // Therefore our work to do is to:
3101 : // 1. Clean up storage controller's internal state to just refer to parents, no children
3102 : // 2. Call out to pageservers to ensure that children are detached
3103 : // 3. Call out to pageservers to ensure that parents are attached.
3104 : //
3105 : // Crash safety:
3106 : // - If the storage controller stops running during this cleanup *after* clearing the splitting state
3107 : // from our database, then [`Self::startup_reconcile`] will regard child attachments as garbage
3108 : // and detach them.
3109 : // - TODO: If the storage controller stops running during this cleanup *before* clearing the splitting state
3110 : // from our database, then we will re-enter this cleanup routine on startup.
3111 :
3112 : let TenantShardSplitAbort {
3113 : tenant_id,
3114 : new_shard_count,
3115 : new_stripe_size,
3116 : ..
3117 : } = op;
3118 :
3119 : // First abort persistent state, if any exists.
3120 : match self
3121 : .persistence
3122 : .abort_shard_split(*tenant_id, *new_shard_count)
3123 : .await?
3124 : {
3125 : AbortShardSplitStatus::Aborted => {
3126 : // Proceed to roll back any child shards created on pageservers
3127 : }
3128 : AbortShardSplitStatus::Complete => {
3129 : // The split completed (we might hit that path if e.g. our database transaction
3130 : // to write the completion landed in the database, but we dropped connection
3131 : // before seeing the result).
3132 : //
3133 : // We must update in-memory state to reflect the successful split.
3134 : self.tenant_shard_split_commit_inmem(
3135 : *tenant_id,
3136 : *new_shard_count,
3137 : *new_stripe_size,
3138 : );
3139 : return Ok(());
3140 : }
3141 : }
3142 :
3143 : // Clean up in-memory state, and accumulate the list of child locations that need detaching
3144 : let detach_locations: Vec<(Node, TenantShardId)> = {
3145 : let mut detach_locations = Vec::new();
3146 : let mut locked = self.inner.write().unwrap();
3147 : let (nodes, tenants, scheduler) = locked.parts_mut();
3148 :
3149 : for (tenant_shard_id, shard) in
3150 : tenants.range_mut(TenantShardId::tenant_range(op.tenant_id))
3151 : {
3152 : if shard.shard.count == op.new_shard_count {
3153 : // Surprising: the phase of [`Self::do_tenant_shard_split`] which inserts child shards in-memory
3154 : // is infallible, so if we got an error we shouldn't have got that far.
3155 : tracing::warn!(
3156 : "During split abort, child shard {tenant_shard_id} found in-memory"
3157 : );
3158 : continue;
3159 : }
3160 :
3161 : // Add the children of this shard to this list of things to detach
3162 : if let Some(node_id) = shard.intent.get_attached() {
3163 : for child_id in tenant_shard_id.split(*new_shard_count) {
3164 : detach_locations.push((
3165 : nodes
3166 : .get(node_id)
3167 : .expect("Intent references nonexistent node")
3168 : .clone(),
3169 : child_id,
3170 : ));
3171 : }
3172 : } else {
3173 : tracing::warn!(
3174 : "During split abort, shard {tenant_shard_id} has no attached location"
3175 : );
3176 : }
3177 :
3178 : tracing::info!("Restoring parent shard {tenant_shard_id}");
3179 : shard.splitting = SplitState::Idle;
3180 : if let Err(e) = shard.schedule(scheduler, &mut ScheduleContext::default()) {
3181 : // If this shard can't be scheduled now (perhaps due to offline nodes or
3182 : // capacity issues), that must not prevent us rolling back a split. In this
3183 : // case it should be eventually scheduled in the background.
3184 : tracing::warn!("Failed to schedule {tenant_shard_id} during shard abort: {e}")
3185 : }
3186 :
3187 : self.maybe_reconcile_shard(shard, nodes);
3188 : }
3189 :
3190 : // We don't expect any new_shard_count shards to exist here, but drop them just in case
3191 0 : tenants.retain(|_id, s| s.shard.count != *new_shard_count);
3192 :
3193 : detach_locations
3194 : };
3195 :
3196 : for (node, child_id) in detach_locations {
3197 : if !node.is_available() {
3198 : // An unavailable node cannot be cleaned up now: to avoid blocking forever, we will permit this, and
3199 : // rely on the reconciliation that happens when a node transitions to Active to clean up. Since we have
3200 : // removed child shards from our in-memory state and database, the reconciliation will implicitly remove
3201 : // them from the node.
3202 : tracing::warn!("Node {node} unavailable, can't clean up during split abort. It will be cleaned up when it is reactivated.");
3203 : continue;
3204 : }
3205 :
3206 : // Detach the remote child. If the pageserver split API call is still in progress, this call will get
3207 : // a 503 and retry, up to our limit.
3208 : tracing::info!("Detaching {child_id} on {node}...");
3209 : match node
3210 : .with_client_retries(
3211 0 : |client| async move {
3212 0 : let config = LocationConfig {
3213 0 : mode: LocationConfigMode::Detached,
3214 0 : generation: None,
3215 0 : secondary_conf: None,
3216 0 : shard_number: child_id.shard_number.0,
3217 0 : shard_count: child_id.shard_count.literal(),
3218 0 : // Stripe size and tenant config don't matter when detaching
3219 0 : shard_stripe_size: 0,
3220 0 : tenant_conf: TenantConfig::default(),
3221 0 : };
3222 0 :
3223 0 : client.location_config(child_id, config, None, false).await
3224 0 : },
3225 : &self.config.jwt_token,
3226 : 1,
3227 : 10,
3228 : Duration::from_secs(5),
3229 : &self.cancel,
3230 : )
3231 : .await
3232 : {
3233 : Some(Ok(_)) => {}
3234 : Some(Err(e)) => {
3235 : // We failed to communicate with the remote node. This is problematic: we may be
3236 : // leaving it with a rogue child shard.
3237 : tracing::warn!(
3238 : "Failed to detach child {child_id} from node {node} during abort"
3239 : );
3240 : return Err(e.into());
3241 : }
3242 : None => {
3243 : // Cancellation: we were shutdown or the node went offline. Shutdown is fine, we'll
3244 : // clean up on restart. The node going offline requires a retry.
3245 : return Err(TenantShardSplitAbortError::Unavailable);
3246 : }
3247 : };
3248 : }
3249 :
3250 : tracing::info!("Successfully aborted split");
3251 : Ok(())
3252 : }
3253 :
3254 : /// Infallible final stage of [`Self::tenant_shard_split`]: update the contents
3255 : /// of the tenant map to reflect the child shards that exist after the split.
3256 0 : fn tenant_shard_split_commit_inmem(
3257 0 : &self,
3258 0 : tenant_id: TenantId,
3259 0 : new_shard_count: ShardCount,
3260 0 : new_stripe_size: Option<ShardStripeSize>,
3261 0 : ) -> (
3262 0 : TenantShardSplitResponse,
3263 0 : Vec<(TenantShardId, NodeId, ShardStripeSize)>,
3264 0 : Vec<ReconcilerWaiter>,
3265 0 : ) {
3266 0 : let mut response = TenantShardSplitResponse {
3267 0 : new_shards: Vec::new(),
3268 0 : };
3269 0 : let mut child_locations = Vec::new();
3270 0 : let mut waiters = Vec::new();
3271 0 :
3272 0 : {
3273 0 : let mut locked = self.inner.write().unwrap();
3274 0 :
3275 0 : let parent_ids = locked
3276 0 : .tenants
3277 0 : .range(TenantShardId::tenant_range(tenant_id))
3278 0 : .map(|(shard_id, _)| *shard_id)
3279 0 : .collect::<Vec<_>>();
3280 0 :
3281 0 : let (nodes, tenants, scheduler) = locked.parts_mut();
3282 0 : for parent_id in parent_ids {
3283 0 : let child_ids = parent_id.split(new_shard_count);
3284 :
3285 0 : let (pageserver, generation, policy, parent_ident, config) = {
3286 0 : let mut old_state = tenants
3287 0 : .remove(&parent_id)
3288 0 : .expect("It was present, we just split it");
3289 0 :
3290 0 : // A non-splitting state is impossible, because [`Self::tenant_shard_split`] holds
3291 0 : // a TenantId lock and passes it through to [`TenantShardSplitAbort`] in case of cleanup:
3292 0 : // nothing else can clear this.
3293 0 : assert!(matches!(old_state.splitting, SplitState::Splitting));
3294 :
3295 0 : let old_attached = old_state.intent.get_attached().unwrap();
3296 0 : old_state.intent.clear(scheduler);
3297 0 : let generation = old_state.generation.expect("Shard must have been attached");
3298 0 : (
3299 0 : old_attached,
3300 0 : generation,
3301 0 : old_state.policy,
3302 0 : old_state.shard,
3303 0 : old_state.config,
3304 0 : )
3305 0 : };
3306 0 :
3307 0 : let mut schedule_context = ScheduleContext::default();
3308 0 : for child in child_ids {
3309 0 : let mut child_shard = parent_ident;
3310 0 : child_shard.number = child.shard_number;
3311 0 : child_shard.count = child.shard_count;
3312 0 : if let Some(stripe_size) = new_stripe_size {
3313 0 : child_shard.stripe_size = stripe_size;
3314 0 : }
3315 :
3316 0 : let mut child_observed: HashMap<NodeId, ObservedStateLocation> = HashMap::new();
3317 0 : child_observed.insert(
3318 0 : pageserver,
3319 0 : ObservedStateLocation {
3320 0 : conf: Some(attached_location_conf(
3321 0 : generation,
3322 0 : &child_shard,
3323 0 : &config,
3324 0 : &policy,
3325 0 : )),
3326 0 : },
3327 0 : );
3328 0 :
3329 0 : let mut child_state = TenantShard::new(child, child_shard, policy.clone());
3330 0 : child_state.intent = IntentState::single(scheduler, Some(pageserver));
3331 0 : child_state.observed = ObservedState {
3332 0 : locations: child_observed,
3333 0 : };
3334 0 : child_state.generation = Some(generation);
3335 0 : child_state.config = config.clone();
3336 0 :
3337 0 : // The child's TenantShard::splitting is intentionally left at the default value of Idle,
3338 0 : // as at this point in the split process we have succeeded and this part is infallible:
3339 0 : // we will never need to do any special recovery from this state.
3340 0 :
3341 0 : child_locations.push((child, pageserver, child_shard.stripe_size));
3342 :
3343 0 : if let Err(e) = child_state.schedule(scheduler, &mut schedule_context) {
3344 : // This is not fatal, because we've implicitly already got an attached
3345 : // location for the child shard. Failure here just means we couldn't
3346 : // find a secondary (e.g. because cluster is overloaded).
3347 0 : tracing::warn!("Failed to schedule child shard {child}: {e}");
3348 0 : }
3349 : // In the background, attach secondary locations for the new shards
3350 0 : if let Some(waiter) = self.maybe_reconcile_shard(&mut child_state, nodes) {
3351 0 : waiters.push(waiter);
3352 0 : }
3353 :
3354 0 : tenants.insert(child, child_state);
3355 0 : response.new_shards.push(child);
3356 : }
3357 : }
3358 0 : (response, child_locations, waiters)
3359 0 : }
3360 0 : }
3361 :
3362 0 : async fn tenant_shard_split_start_secondaries(
3363 0 : &self,
3364 0 : tenant_id: TenantId,
3365 0 : waiters: Vec<ReconcilerWaiter>,
3366 0 : ) {
3367 : // Wait for initial reconcile of child shards, this creates the secondary locations
3368 0 : if let Err(e) = self.await_waiters(waiters, RECONCILE_TIMEOUT).await {
3369 : // This is not a failure to split: it's some issue reconciling the new child shards, perhaps
3370 : // their secondaries couldn't be attached.
3371 0 : tracing::warn!("Failed to reconcile after split: {e}");
3372 0 : return;
3373 0 : }
3374 :
3375 : // Take the state lock to discover the attached & secondary intents for all shards
3376 0 : let (attached, secondary) = {
3377 0 : let locked = self.inner.read().unwrap();
3378 0 : let mut attached = Vec::new();
3379 0 : let mut secondary = Vec::new();
3380 :
3381 0 : for (tenant_shard_id, shard) in
3382 0 : locked.tenants.range(TenantShardId::tenant_range(tenant_id))
3383 : {
3384 0 : let Some(node_id) = shard.intent.get_attached() else {
3385 : // Unexpected. Race with a PlacementPolicy change?
3386 0 : tracing::warn!(
3387 0 : "No attached node on {tenant_shard_id} immediately after shard split!"
3388 : );
3389 0 : continue;
3390 : };
3391 :
3392 0 : let Some(secondary_node_id) = shard.intent.get_secondary().first() else {
3393 : // No secondary location. Nothing for us to do.
3394 0 : continue;
3395 : };
3396 :
3397 0 : let attached_node = locked
3398 0 : .nodes
3399 0 : .get(node_id)
3400 0 : .expect("Pageservers may not be deleted while referenced");
3401 0 :
3402 0 : let secondary_node = locked
3403 0 : .nodes
3404 0 : .get(secondary_node_id)
3405 0 : .expect("Pageservers may not be deleted while referenced");
3406 0 :
3407 0 : attached.push((*tenant_shard_id, attached_node.clone()));
3408 0 : secondary.push((*tenant_shard_id, secondary_node.clone()));
3409 : }
3410 0 : (attached, secondary)
3411 0 : };
3412 0 :
3413 0 : if secondary.is_empty() {
3414 : // No secondary locations; nothing for us to do
3415 0 : return;
3416 0 : }
3417 :
3418 0 : for result in self
3419 0 : .tenant_for_shards_api(
3420 0 : attached,
3421 0 : |tenant_shard_id, client| async move {
3422 0 : client.tenant_heatmap_upload(tenant_shard_id).await
3423 0 : },
3424 0 : 1,
3425 0 : 1,
3426 0 : SHORT_RECONCILE_TIMEOUT,
3427 0 : &self.cancel,
3428 0 : )
3429 0 : .await
3430 : {
3431 0 : if let Err(e) = result {
3432 0 : tracing::warn!("Error calling heatmap upload after shard split: {e}");
3433 0 : return;
3434 0 : }
3435 : }
3436 :
3437 0 : for result in self
3438 0 : .tenant_for_shards_api(
3439 0 : secondary,
3440 0 : |tenant_shard_id, client| async move {
3441 0 : client
3442 0 : .tenant_secondary_download(tenant_shard_id, Some(Duration::ZERO))
3443 0 : .await
3444 0 : },
3445 0 : 1,
3446 0 : 1,
3447 0 : SHORT_RECONCILE_TIMEOUT,
3448 0 : &self.cancel,
3449 0 : )
3450 0 : .await
3451 : {
3452 0 : if let Err(e) = result {
3453 0 : tracing::warn!("Error calling secondary download after shard split: {e}");
3454 0 : return;
3455 0 : }
3456 : }
3457 0 : }
3458 :
3459 0 : pub(crate) async fn tenant_shard_split(
3460 0 : &self,
3461 0 : tenant_id: TenantId,
3462 0 : split_req: TenantShardSplitRequest,
3463 0 : ) -> Result<TenantShardSplitResponse, ApiError> {
3464 : // TODO: return 503 if we get stuck waiting for this lock
3465 : // (issue https://github.com/neondatabase/neon/issues/7108)
3466 0 : let _tenant_lock = trace_exclusive_lock(
3467 0 : &self.tenant_op_locks,
3468 0 : tenant_id,
3469 0 : TenantOperations::ShardSplit,
3470 0 : )
3471 0 : .await;
3472 :
3473 0 : let new_shard_count = ShardCount::new(split_req.new_shard_count);
3474 0 : let new_stripe_size = split_req.new_stripe_size;
3475 :
3476 : // Validate the request and construct parameters. This phase is fallible, but does not require
3477 : // rollback on errors, as it does no I/O and mutates no state.
3478 0 : let shard_split_params = match self.prepare_tenant_shard_split(tenant_id, split_req)? {
3479 0 : ShardSplitAction::NoOp(resp) => return Ok(resp),
3480 0 : ShardSplitAction::Split(params) => params,
3481 : };
3482 :
3483 : // Execute this split: this phase mutates state and does remote I/O on pageservers. If it fails,
3484 : // we must roll back.
3485 0 : let r = self
3486 0 : .do_tenant_shard_split(tenant_id, shard_split_params)
3487 0 : .await;
3488 :
3489 0 : let (response, waiters) = match r {
3490 0 : Ok(r) => r,
3491 0 : Err(e) => {
3492 0 : // Split might be part-done, we must do work to abort it.
3493 0 : tracing::warn!("Enqueuing background abort of split on {tenant_id}");
3494 0 : self.abort_tx
3495 0 : .send(TenantShardSplitAbort {
3496 0 : tenant_id,
3497 0 : new_shard_count,
3498 0 : new_stripe_size,
3499 0 : _tenant_lock,
3500 0 : })
3501 0 : // Ignore error sending: that just means we're shutting down: aborts are ephemeral so it's fine to drop it.
3502 0 : .ok();
3503 0 : return Err(e);
3504 : }
3505 : };
3506 :
3507 : // The split is now complete. As an optimization, we will trigger all the child shards to upload
3508 : // a heatmap immediately, and all their secondary locations to start downloading: this avoids waiting
3509 : // for the background heatmap/download interval before secondaries get warm enough to migrate shards
3510 : // in [`Self::optimize_all`]
3511 0 : self.tenant_shard_split_start_secondaries(tenant_id, waiters)
3512 0 : .await;
3513 0 : Ok(response)
3514 0 : }
3515 :
3516 0 : fn prepare_tenant_shard_split(
3517 0 : &self,
3518 0 : tenant_id: TenantId,
3519 0 : split_req: TenantShardSplitRequest,
3520 0 : ) -> Result<ShardSplitAction, ApiError> {
3521 0 : fail::fail_point!("shard-split-validation", |_| Err(ApiError::BadRequest(
3522 0 : anyhow::anyhow!("failpoint")
3523 0 : )));
3524 :
3525 0 : let mut policy = None;
3526 0 : let mut config = None;
3527 0 : let mut shard_ident = None;
3528 : // Validate input, and calculate which shards we will create
3529 0 : let (old_shard_count, targets) =
3530 : {
3531 0 : let locked = self.inner.read().unwrap();
3532 0 :
3533 0 : let pageservers = locked.nodes.clone();
3534 0 :
3535 0 : let mut targets = Vec::new();
3536 0 :
3537 0 : // In case this is a retry, count how many already-split shards we found
3538 0 : let mut children_found = Vec::new();
3539 0 : let mut old_shard_count = None;
3540 :
3541 0 : for (tenant_shard_id, shard) in
3542 0 : locked.tenants.range(TenantShardId::tenant_range(tenant_id))
3543 : {
3544 0 : match shard.shard.count.count().cmp(&split_req.new_shard_count) {
3545 : Ordering::Equal => {
3546 : // Already split this
3547 0 : children_found.push(*tenant_shard_id);
3548 0 : continue;
3549 : }
3550 : Ordering::Greater => {
3551 0 : return Err(ApiError::BadRequest(anyhow::anyhow!(
3552 0 : "Requested count {} but already have shards at count {}",
3553 0 : split_req.new_shard_count,
3554 0 : shard.shard.count.count()
3555 0 : )));
3556 : }
3557 0 : Ordering::Less => {
3558 0 : // Fall through: this shard has lower count than requested,
3559 0 : // is a candidate for splitting.
3560 0 : }
3561 0 : }
3562 0 :
3563 0 : match old_shard_count {
3564 0 : None => old_shard_count = Some(shard.shard.count),
3565 0 : Some(old_shard_count) => {
3566 0 : if old_shard_count != shard.shard.count {
3567 : // We may hit this case if a caller asked for two splits to
3568 : // different sizes, before the first one is complete.
3569 : // e.g. 1->2, 2->4, where the 4 call comes while we have a mixture
3570 : // of shard_count=1 and shard_count=2 shards in the map.
3571 0 : return Err(ApiError::Conflict(
3572 0 : "Cannot split, currently mid-split".to_string(),
3573 0 : ));
3574 0 : }
3575 : }
3576 : }
3577 0 : if policy.is_none() {
3578 0 : policy = Some(shard.policy.clone());
3579 0 : }
3580 0 : if shard_ident.is_none() {
3581 0 : shard_ident = Some(shard.shard);
3582 0 : }
3583 0 : if config.is_none() {
3584 0 : config = Some(shard.config.clone());
3585 0 : }
3586 :
3587 0 : if tenant_shard_id.shard_count.count() == split_req.new_shard_count {
3588 0 : tracing::info!(
3589 0 : "Tenant shard {} already has shard count {}",
3590 : tenant_shard_id,
3591 : split_req.new_shard_count
3592 : );
3593 0 : continue;
3594 0 : }
3595 :
3596 0 : let node_id = shard.intent.get_attached().ok_or(ApiError::BadRequest(
3597 0 : anyhow::anyhow!("Cannot split a tenant that is not attached"),
3598 0 : ))?;
3599 :
3600 0 : let node = pageservers
3601 0 : .get(&node_id)
3602 0 : .expect("Pageservers may not be deleted while referenced");
3603 0 :
3604 0 : targets.push(ShardSplitTarget {
3605 0 : parent_id: *tenant_shard_id,
3606 0 : node: node.clone(),
3607 0 : child_ids: tenant_shard_id
3608 0 : .split(ShardCount::new(split_req.new_shard_count)),
3609 0 : });
3610 : }
3611 :
3612 0 : if targets.is_empty() {
3613 0 : if children_found.len() == split_req.new_shard_count as usize {
3614 0 : return Ok(ShardSplitAction::NoOp(TenantShardSplitResponse {
3615 0 : new_shards: children_found,
3616 0 : }));
3617 : } else {
3618 : // No shards found to split, and no existing children found: the
3619 : // tenant doesn't exist at all.
3620 0 : return Err(ApiError::NotFound(
3621 0 : anyhow::anyhow!("Tenant {} not found", tenant_id).into(),
3622 0 : ));
3623 : }
3624 0 : }
3625 0 :
3626 0 : (old_shard_count, targets)
3627 0 : };
3628 0 :
3629 0 : // unwrap safety: we would have returned above if we didn't find at least one shard to split
3630 0 : let old_shard_count = old_shard_count.unwrap();
3631 0 : let shard_ident = if let Some(new_stripe_size) = split_req.new_stripe_size {
3632 : // This ShardIdentity will be used as the template for all children, so this implicitly
3633 : // applies the new stripe size to the children.
3634 0 : let mut shard_ident = shard_ident.unwrap();
3635 0 : if shard_ident.count.count() > 1 && shard_ident.stripe_size != new_stripe_size {
3636 0 : return Err(ApiError::BadRequest(anyhow::anyhow!("Attempted to change stripe size ({:?}->{new_stripe_size:?}) on a tenant with multiple shards", shard_ident.stripe_size)));
3637 0 : }
3638 0 :
3639 0 : shard_ident.stripe_size = new_stripe_size;
3640 0 : tracing::info!("applied stripe size {}", shard_ident.stripe_size.0);
3641 0 : shard_ident
3642 : } else {
3643 0 : shard_ident.unwrap()
3644 : };
3645 0 : let policy = policy.unwrap();
3646 0 : let config = config.unwrap();
3647 0 :
3648 0 : Ok(ShardSplitAction::Split(ShardSplitParams {
3649 0 : old_shard_count,
3650 0 : new_shard_count: ShardCount::new(split_req.new_shard_count),
3651 0 : new_stripe_size: split_req.new_stripe_size,
3652 0 : targets,
3653 0 : policy,
3654 0 : config,
3655 0 : shard_ident,
3656 0 : }))
3657 0 : }
3658 :
3659 0 : async fn do_tenant_shard_split(
3660 0 : &self,
3661 0 : tenant_id: TenantId,
3662 0 : params: ShardSplitParams,
3663 0 : ) -> Result<(TenantShardSplitResponse, Vec<ReconcilerWaiter>), ApiError> {
3664 0 : // FIXME: we have dropped self.inner lock, and not yet written anything to the database: another
3665 0 : // request could occur here, deleting or mutating the tenant. begin_shard_split checks that the
3666 0 : // parent shards exist as expected, but it would be neater to do the above pre-checks within the
3667 0 : // same database transaction rather than pre-check in-memory and then maybe-fail the database write.
3668 0 : // (https://github.com/neondatabase/neon/issues/6676)
3669 0 :
3670 0 : let ShardSplitParams {
3671 0 : old_shard_count,
3672 0 : new_shard_count,
3673 0 : new_stripe_size,
3674 0 : mut targets,
3675 0 : policy,
3676 0 : config,
3677 0 : shard_ident,
3678 0 : } = params;
3679 :
3680 : // Drop any secondary locations: pageservers do not support splitting these, and in any case the
3681 : // end-state for a split tenant will usually be to have secondary locations on different nodes.
3682 : // The reconciliation calls in this block also implicitly cancel+barrier wrt any ongoing reconciliation
3683 : // at the time of split.
3684 0 : let waiters = {
3685 0 : let mut locked = self.inner.write().unwrap();
3686 0 : let mut waiters = Vec::new();
3687 0 : let (nodes, tenants, scheduler) = locked.parts_mut();
3688 0 : for target in &mut targets {
3689 0 : let Some(shard) = tenants.get_mut(&target.parent_id) else {
3690 : // Paranoia check: this shouldn't happen: we have the oplock for this tenant ID.
3691 0 : return Err(ApiError::InternalServerError(anyhow::anyhow!(
3692 0 : "Shard {} not found",
3693 0 : target.parent_id
3694 0 : )));
3695 : };
3696 :
3697 0 : if shard.intent.get_attached() != &Some(target.node.get_id()) {
3698 : // Paranoia check: this shouldn't happen: we have the oplock for this tenant ID.
3699 0 : return Err(ApiError::Conflict(format!(
3700 0 : "Shard {} unexpectedly rescheduled during split",
3701 0 : target.parent_id
3702 0 : )));
3703 0 : }
3704 0 :
3705 0 : // Irrespective of PlacementPolicy, clear secondary locations from intent
3706 0 : shard.intent.clear_secondary(scheduler);
3707 :
3708 : // Run Reconciler to execute detach fo secondary locations.
3709 0 : if let Some(waiter) = self.maybe_reconcile_shard(shard, nodes) {
3710 0 : waiters.push(waiter);
3711 0 : }
3712 : }
3713 0 : waiters
3714 0 : };
3715 0 : self.await_waiters(waiters, RECONCILE_TIMEOUT).await?;
3716 :
3717 : // Before creating any new child shards in memory or on the pageservers, persist them: this
3718 : // enables us to ensure that we will always be able to clean up if something goes wrong. This also
3719 : // acts as the protection against two concurrent attempts to split: one of them will get a database
3720 : // error trying to insert the child shards.
3721 0 : let mut child_tsps = Vec::new();
3722 0 : for target in &targets {
3723 0 : let mut this_child_tsps = Vec::new();
3724 0 : for child in &target.child_ids {
3725 0 : let mut child_shard = shard_ident;
3726 0 : child_shard.number = child.shard_number;
3727 0 : child_shard.count = child.shard_count;
3728 0 :
3729 0 : tracing::info!(
3730 0 : "Create child shard persistence with stripe size {}",
3731 : shard_ident.stripe_size.0
3732 : );
3733 :
3734 0 : this_child_tsps.push(TenantShardPersistence {
3735 0 : tenant_id: child.tenant_id.to_string(),
3736 0 : shard_number: child.shard_number.0 as i32,
3737 0 : shard_count: child.shard_count.literal() as i32,
3738 0 : shard_stripe_size: shard_ident.stripe_size.0 as i32,
3739 0 : // Note: this generation is a placeholder, [`Persistence::begin_shard_split`] will
3740 0 : // populate the correct generation as part of its transaction, to protect us
3741 0 : // against racing with changes in the state of the parent.
3742 0 : generation: None,
3743 0 : generation_pageserver: Some(target.node.get_id().0 as i64),
3744 0 : placement_policy: serde_json::to_string(&policy).unwrap(),
3745 0 : config: serde_json::to_string(&config).unwrap(),
3746 0 : splitting: SplitState::Splitting,
3747 0 :
3748 0 : // Scheduling policies do not carry through to children
3749 0 : scheduling_policy: serde_json::to_string(&ShardSchedulingPolicy::default())
3750 0 : .unwrap(),
3751 0 : });
3752 : }
3753 :
3754 0 : child_tsps.push((target.parent_id, this_child_tsps));
3755 : }
3756 :
3757 0 : if let Err(e) = self
3758 0 : .persistence
3759 0 : .begin_shard_split(old_shard_count, tenant_id, child_tsps)
3760 0 : .await
3761 : {
3762 0 : match e {
3763 : DatabaseError::Query(diesel::result::Error::DatabaseError(
3764 : DatabaseErrorKind::UniqueViolation,
3765 : _,
3766 : )) => {
3767 : // Inserting a child shard violated a unique constraint: we raced with another call to
3768 : // this function
3769 0 : tracing::warn!("Conflicting attempt to split {tenant_id}: {e}");
3770 0 : return Err(ApiError::Conflict("Tenant is already splitting".into()));
3771 : }
3772 0 : _ => return Err(ApiError::InternalServerError(e.into())),
3773 : }
3774 0 : }
3775 0 : fail::fail_point!("shard-split-post-begin", |_| Err(
3776 0 : ApiError::InternalServerError(anyhow::anyhow!("failpoint"))
3777 0 : ));
3778 :
3779 : // Now that I have persisted the splitting state, apply it in-memory. This is infallible, so
3780 : // callers may assume that if splitting is set in memory, then it was persisted, and if splitting
3781 : // is not set in memory, then it was not persisted.
3782 : {
3783 0 : let mut locked = self.inner.write().unwrap();
3784 0 : for target in &targets {
3785 0 : if let Some(parent_shard) = locked.tenants.get_mut(&target.parent_id) {
3786 0 : parent_shard.splitting = SplitState::Splitting;
3787 0 : // Put the observed state to None, to reflect that it is indeterminate once we start the
3788 0 : // split operation.
3789 0 : parent_shard
3790 0 : .observed
3791 0 : .locations
3792 0 : .insert(target.node.get_id(), ObservedStateLocation { conf: None });
3793 0 : }
3794 : }
3795 : }
3796 :
3797 : // TODO: issue split calls concurrently (this only matters once we're splitting
3798 : // N>1 shards into M shards -- initially we're usually splitting 1 shard into N).
3799 :
3800 0 : for target in &targets {
3801 : let ShardSplitTarget {
3802 0 : parent_id,
3803 0 : node,
3804 0 : child_ids,
3805 0 : } = target;
3806 0 : let client = PageserverClient::new(
3807 0 : node.get_id(),
3808 0 : node.base_url(),
3809 0 : self.config.jwt_token.as_deref(),
3810 0 : );
3811 0 : let response = client
3812 0 : .tenant_shard_split(
3813 0 : *parent_id,
3814 0 : TenantShardSplitRequest {
3815 0 : new_shard_count: new_shard_count.literal(),
3816 0 : new_stripe_size,
3817 0 : },
3818 0 : )
3819 0 : .await
3820 0 : .map_err(|e| ApiError::Conflict(format!("Failed to split {}: {}", parent_id, e)))?;
3821 :
3822 0 : fail::fail_point!("shard-split-post-remote", |_| Err(ApiError::Conflict(
3823 0 : "failpoint".to_string()
3824 0 : )));
3825 :
3826 0 : tracing::info!(
3827 0 : "Split {} into {}",
3828 0 : parent_id,
3829 0 : response
3830 0 : .new_shards
3831 0 : .iter()
3832 0 : .map(|s| format!("{:?}", s))
3833 0 : .collect::<Vec<_>>()
3834 0 : .join(",")
3835 : );
3836 :
3837 0 : if &response.new_shards != child_ids {
3838 : // This should never happen: the pageserver should agree with us on how shard splits work.
3839 0 : return Err(ApiError::InternalServerError(anyhow::anyhow!(
3840 0 : "Splitting shard {} resulted in unexpected IDs: {:?} (expected {:?})",
3841 0 : parent_id,
3842 0 : response.new_shards,
3843 0 : child_ids
3844 0 : )));
3845 0 : }
3846 : }
3847 :
3848 : // TODO: if the pageserver restarted concurrently with our split API call,
3849 : // the actual generation of the child shard might differ from the generation
3850 : // we expect it to have. In order for our in-database generation to end up
3851 : // correct, we should carry the child generation back in the response and apply it here
3852 : // in complete_shard_split (and apply the correct generation in memory)
3853 : // (or, we can carry generation in the request and reject the request if
3854 : // it doesn't match, but that requires more retry logic on this side)
3855 :
3856 0 : self.persistence
3857 0 : .complete_shard_split(tenant_id, old_shard_count)
3858 0 : .await?;
3859 :
3860 0 : fail::fail_point!("shard-split-post-complete", |_| Err(
3861 0 : ApiError::InternalServerError(anyhow::anyhow!("failpoint"))
3862 0 : ));
3863 :
3864 : // Replace all the shards we just split with their children: this phase is infallible.
3865 0 : let (response, child_locations, waiters) =
3866 0 : self.tenant_shard_split_commit_inmem(tenant_id, new_shard_count, new_stripe_size);
3867 0 :
3868 0 : // Send compute notifications for all the new shards
3869 0 : let mut failed_notifications = Vec::new();
3870 0 : for (child_id, child_ps, stripe_size) in child_locations {
3871 0 : if let Err(e) = self
3872 0 : .compute_hook
3873 0 : .notify(child_id, child_ps, stripe_size, &self.cancel)
3874 0 : .await
3875 : {
3876 0 : tracing::warn!("Failed to update compute of {}->{} during split, proceeding anyway to complete split ({e})",
3877 : child_id, child_ps);
3878 0 : failed_notifications.push(child_id);
3879 0 : }
3880 : }
3881 :
3882 : // If we failed any compute notifications, make a note to retry later.
3883 0 : if !failed_notifications.is_empty() {
3884 0 : let mut locked = self.inner.write().unwrap();
3885 0 : for failed in failed_notifications {
3886 0 : if let Some(shard) = locked.tenants.get_mut(&failed) {
3887 0 : shard.pending_compute_notification = true;
3888 0 : }
3889 : }
3890 0 : }
3891 :
3892 0 : Ok((response, waiters))
3893 0 : }
3894 :
3895 0 : pub(crate) async fn tenant_shard_migrate(
3896 0 : &self,
3897 0 : tenant_shard_id: TenantShardId,
3898 0 : migrate_req: TenantShardMigrateRequest,
3899 0 : ) -> Result<TenantShardMigrateResponse, ApiError> {
3900 0 : let waiter = {
3901 0 : let mut locked = self.inner.write().unwrap();
3902 0 : let (nodes, tenants, scheduler) = locked.parts_mut();
3903 :
3904 0 : let Some(node) = nodes.get(&migrate_req.node_id) else {
3905 0 : return Err(ApiError::BadRequest(anyhow::anyhow!(
3906 0 : "Node {} not found",
3907 0 : migrate_req.node_id
3908 0 : )));
3909 : };
3910 :
3911 0 : if !node.is_available() {
3912 : // Warn but proceed: the caller may intend to manually adjust the placement of
3913 : // a shard even if the node is down, e.g. if intervening during an incident.
3914 0 : tracing::warn!("Migrating to unavailable node {node}");
3915 0 : }
3916 :
3917 0 : let Some(shard) = tenants.get_mut(&tenant_shard_id) else {
3918 0 : return Err(ApiError::NotFound(
3919 0 : anyhow::anyhow!("Tenant shard not found").into(),
3920 0 : ));
3921 : };
3922 :
3923 0 : if shard.intent.get_attached() == &Some(migrate_req.node_id) {
3924 : // No-op case: we will still proceed to wait for reconciliation in case it is
3925 : // incomplete from an earlier update to the intent.
3926 0 : tracing::info!("Migrating: intent is unchanged {:?}", shard.intent);
3927 : } else {
3928 0 : let old_attached = *shard.intent.get_attached();
3929 0 :
3930 0 : match shard.policy {
3931 0 : PlacementPolicy::Attached(n) => {
3932 0 : // If our new attached node was a secondary, it no longer should be.
3933 0 : shard.intent.remove_secondary(scheduler, migrate_req.node_id);
3934 :
3935 : // If we were already attached to something, demote that to a secondary
3936 0 : if let Some(old_attached) = old_attached {
3937 0 : if n > 0 {
3938 : // Remove other secondaries to make room for the location we'll demote
3939 0 : while shard.intent.get_secondary().len() >= n {
3940 0 : shard.intent.pop_secondary(scheduler);
3941 0 : }
3942 :
3943 0 : shard.intent.push_secondary(scheduler, old_attached);
3944 0 : }
3945 0 : }
3946 :
3947 0 : shard.intent.set_attached(scheduler, Some(migrate_req.node_id));
3948 : }
3949 0 : PlacementPolicy::Secondary => {
3950 0 : shard.intent.clear(scheduler);
3951 0 : shard.intent.push_secondary(scheduler, migrate_req.node_id);
3952 0 : }
3953 : PlacementPolicy::Detached => {
3954 0 : return Err(ApiError::BadRequest(anyhow::anyhow!(
3955 0 : "Cannot migrate a tenant that is PlacementPolicy::Detached: configure it to an attached policy first"
3956 0 : )))
3957 : }
3958 : }
3959 :
3960 0 : tracing::info!("Migrating: new intent {:?}", shard.intent);
3961 0 : shard.sequence = shard.sequence.next();
3962 : }
3963 :
3964 0 : self.maybe_reconcile_shard(shard, nodes)
3965 : };
3966 :
3967 0 : if let Some(waiter) = waiter {
3968 0 : waiter.wait_timeout(RECONCILE_TIMEOUT).await?;
3969 : } else {
3970 0 : tracing::info!("Migration is a no-op");
3971 : }
3972 :
3973 0 : Ok(TenantShardMigrateResponse {})
3974 0 : }
3975 :
3976 : /// This is for debug/support only: we simply drop all state for a tenant, without
3977 : /// detaching or deleting it on pageservers.
3978 0 : pub(crate) async fn tenant_drop(&self, tenant_id: TenantId) -> Result<(), ApiError> {
3979 0 : self.persistence.delete_tenant(tenant_id).await?;
3980 :
3981 0 : let mut locked = self.inner.write().unwrap();
3982 0 : let (_nodes, tenants, scheduler) = locked.parts_mut();
3983 0 : let mut shards = Vec::new();
3984 0 : for (tenant_shard_id, _) in tenants.range(TenantShardId::tenant_range(tenant_id)) {
3985 0 : shards.push(*tenant_shard_id);
3986 0 : }
3987 :
3988 0 : for shard_id in shards {
3989 0 : if let Some(mut shard) = tenants.remove(&shard_id) {
3990 0 : shard.intent.clear(scheduler);
3991 0 : }
3992 : }
3993 :
3994 0 : Ok(())
3995 0 : }
3996 :
3997 : /// This is for debug/support only: assuming tenant data is already present in S3, we "create" a
3998 : /// tenant with a very high generation number so that it will see the existing data.
3999 0 : pub(crate) async fn tenant_import(
4000 0 : &self,
4001 0 : tenant_id: TenantId,
4002 0 : ) -> Result<TenantCreateResponse, ApiError> {
4003 0 : // Pick an arbitrary available pageserver to use for scanning the tenant in remote storage
4004 0 : let maybe_node = {
4005 0 : self.inner
4006 0 : .read()
4007 0 : .unwrap()
4008 0 : .nodes
4009 0 : .values()
4010 0 : .find(|n| n.is_available())
4011 0 : .cloned()
4012 : };
4013 0 : let Some(node) = maybe_node else {
4014 0 : return Err(ApiError::BadRequest(anyhow::anyhow!("No nodes available")));
4015 : };
4016 :
4017 0 : let client = PageserverClient::new(
4018 0 : node.get_id(),
4019 0 : node.base_url(),
4020 0 : self.config.jwt_token.as_deref(),
4021 0 : );
4022 :
4023 0 : let scan_result = client
4024 0 : .tenant_scan_remote_storage(tenant_id)
4025 0 : .await
4026 0 : .map_err(|e| passthrough_api_error(&node, e))?;
4027 :
4028 : // A post-split tenant may contain a mixture of shard counts in remote storage: pick the highest count.
4029 0 : let Some(shard_count) = scan_result
4030 0 : .shards
4031 0 : .iter()
4032 0 : .map(|s| s.tenant_shard_id.shard_count)
4033 0 : .max()
4034 : else {
4035 0 : return Err(ApiError::NotFound(
4036 0 : anyhow::anyhow!("No shards found").into(),
4037 0 : ));
4038 : };
4039 :
4040 : // Ideally we would set each newly imported shard's generation independently, but for correctness it is sufficient
4041 : // to
4042 0 : let generation = scan_result
4043 0 : .shards
4044 0 : .iter()
4045 0 : .map(|s| s.generation)
4046 0 : .max()
4047 0 : .expect("We already validated >0 shards");
4048 0 :
4049 0 : // FIXME: we have no way to recover the shard stripe size from contents of remote storage: this will
4050 0 : // only work if they were using the default stripe size.
4051 0 : let stripe_size = ShardParameters::DEFAULT_STRIPE_SIZE;
4052 :
4053 0 : let (response, waiters) = self
4054 0 : .do_tenant_create(TenantCreateRequest {
4055 0 : new_tenant_id: TenantShardId::unsharded(tenant_id),
4056 0 : generation,
4057 0 :
4058 0 : shard_parameters: ShardParameters {
4059 0 : count: shard_count,
4060 0 : stripe_size,
4061 0 : },
4062 0 : placement_policy: Some(PlacementPolicy::Attached(0)), // No secondaries, for convenient debug/hacking
4063 0 :
4064 0 : // There is no way to know what the tenant's config was: revert to defaults
4065 0 : config: TenantConfig::default(),
4066 0 : })
4067 0 : .await?;
4068 :
4069 0 : if let Err(e) = self.await_waiters(waiters, SHORT_RECONCILE_TIMEOUT).await {
4070 : // Since this is a debug/support operation, all kinds of weird issues are possible (e.g. this
4071 : // tenant doesn't exist in the control plane), so don't fail the request if it can't fully
4072 : // reconcile, as reconciliation includes notifying compute.
4073 0 : tracing::warn!(%tenant_id, "Reconcile not done yet while importing tenant ({e})");
4074 0 : }
4075 :
4076 0 : Ok(response)
4077 0 : }
4078 :
4079 : /// For debug/support: a full JSON dump of TenantShards. Returns a response so that
4080 : /// we don't have to make TenantShard clonable in the return path.
4081 0 : pub(crate) fn tenants_dump(&self) -> Result<hyper::Response<hyper::Body>, ApiError> {
4082 0 : let serialized = {
4083 0 : let locked = self.inner.read().unwrap();
4084 0 : let result = locked.tenants.values().collect::<Vec<_>>();
4085 0 : serde_json::to_string(&result).map_err(|e| ApiError::InternalServerError(e.into()))?
4086 : };
4087 :
4088 0 : hyper::Response::builder()
4089 0 : .status(hyper::StatusCode::OK)
4090 0 : .header(hyper::header::CONTENT_TYPE, "application/json")
4091 0 : .body(hyper::Body::from(serialized))
4092 0 : .map_err(|e| ApiError::InternalServerError(e.into()))
4093 0 : }
4094 :
4095 : /// Check the consistency of in-memory state vs. persistent state, and check that the
4096 : /// scheduler's statistics are up to date.
4097 : ///
4098 : /// These consistency checks expect an **idle** system. If changes are going on while
4099 : /// we run, then we can falsely indicate a consistency issue. This is sufficient for end-of-test
4100 : /// checks, but not suitable for running continuously in the background in the field.
4101 0 : pub(crate) async fn consistency_check(&self) -> Result<(), ApiError> {
4102 0 : let (mut expect_nodes, mut expect_shards) = {
4103 0 : let locked = self.inner.read().unwrap();
4104 0 :
4105 0 : locked
4106 0 : .scheduler
4107 0 : .consistency_check(locked.nodes.values(), locked.tenants.values())
4108 0 : .context("Scheduler checks")
4109 0 : .map_err(ApiError::InternalServerError)?;
4110 :
4111 0 : let expect_nodes = locked
4112 0 : .nodes
4113 0 : .values()
4114 0 : .map(|n| n.to_persistent())
4115 0 : .collect::<Vec<_>>();
4116 0 :
4117 0 : let expect_shards = locked
4118 0 : .tenants
4119 0 : .values()
4120 0 : .map(|t| t.to_persistent())
4121 0 : .collect::<Vec<_>>();
4122 :
4123 : // This method can only validate the state of an idle system: if a reconcile is in
4124 : // progress, fail out early to avoid giving false errors on state that won't match
4125 : // between database and memory under a ReconcileResult is processed.
4126 0 : for t in locked.tenants.values() {
4127 0 : if t.reconciler.is_some() {
4128 0 : return Err(ApiError::InternalServerError(anyhow::anyhow!(
4129 0 : "Shard {} reconciliation in progress",
4130 0 : t.tenant_shard_id
4131 0 : )));
4132 0 : }
4133 : }
4134 :
4135 0 : (expect_nodes, expect_shards)
4136 : };
4137 :
4138 0 : let mut nodes = self.persistence.list_nodes().await?;
4139 0 : expect_nodes.sort_by_key(|n| n.node_id);
4140 0 : nodes.sort_by_key(|n| n.node_id);
4141 0 :
4142 0 : if nodes != expect_nodes {
4143 0 : tracing::error!("Consistency check failed on nodes.");
4144 0 : tracing::error!(
4145 0 : "Nodes in memory: {}",
4146 0 : serde_json::to_string(&expect_nodes)
4147 0 : .map_err(|e| ApiError::InternalServerError(e.into()))?
4148 : );
4149 0 : tracing::error!(
4150 0 : "Nodes in database: {}",
4151 0 : serde_json::to_string(&nodes)
4152 0 : .map_err(|e| ApiError::InternalServerError(e.into()))?
4153 : );
4154 0 : return Err(ApiError::InternalServerError(anyhow::anyhow!(
4155 0 : "Node consistency failure"
4156 0 : )));
4157 0 : }
4158 :
4159 0 : let mut shards = self.persistence.list_tenant_shards().await?;
4160 0 : shards.sort_by_key(|tsp| (tsp.tenant_id.clone(), tsp.shard_number, tsp.shard_count));
4161 0 : expect_shards.sort_by_key(|tsp| (tsp.tenant_id.clone(), tsp.shard_number, tsp.shard_count));
4162 0 :
4163 0 : if shards != expect_shards {
4164 0 : tracing::error!("Consistency check failed on shards.");
4165 0 : tracing::error!(
4166 0 : "Shards in memory: {}",
4167 0 : serde_json::to_string(&expect_shards)
4168 0 : .map_err(|e| ApiError::InternalServerError(e.into()))?
4169 : );
4170 0 : tracing::error!(
4171 0 : "Shards in database: {}",
4172 0 : serde_json::to_string(&shards)
4173 0 : .map_err(|e| ApiError::InternalServerError(e.into()))?
4174 : );
4175 0 : return Err(ApiError::InternalServerError(anyhow::anyhow!(
4176 0 : "Shard consistency failure"
4177 0 : )));
4178 0 : }
4179 0 :
4180 0 : Ok(())
4181 0 : }
4182 :
4183 : /// For debug/support: a JSON dump of the [`Scheduler`]. Returns a response so that
4184 : /// we don't have to make TenantShard clonable in the return path.
4185 0 : pub(crate) fn scheduler_dump(&self) -> Result<hyper::Response<hyper::Body>, ApiError> {
4186 0 : let serialized = {
4187 0 : let locked = self.inner.read().unwrap();
4188 0 : serde_json::to_string(&locked.scheduler)
4189 0 : .map_err(|e| ApiError::InternalServerError(e.into()))?
4190 : };
4191 :
4192 0 : hyper::Response::builder()
4193 0 : .status(hyper::StatusCode::OK)
4194 0 : .header(hyper::header::CONTENT_TYPE, "application/json")
4195 0 : .body(hyper::Body::from(serialized))
4196 0 : .map_err(|e| ApiError::InternalServerError(e.into()))
4197 0 : }
4198 :
4199 : /// This is for debug/support only: we simply drop all state for a tenant, without
4200 : /// detaching or deleting it on pageservers. We do not try and re-schedule any
4201 : /// tenants that were on this node.
4202 : ///
4203 : /// TODO: proper node deletion API that unhooks things more gracefully
4204 0 : pub(crate) async fn node_drop(&self, node_id: NodeId) -> Result<(), ApiError> {
4205 0 : self.persistence.delete_node(node_id).await?;
4206 :
4207 0 : let mut locked = self.inner.write().unwrap();
4208 :
4209 0 : for shard in locked.tenants.values_mut() {
4210 0 : shard.deref_node(node_id);
4211 0 : }
4212 :
4213 0 : let mut nodes = (*locked.nodes).clone();
4214 0 : nodes.remove(&node_id);
4215 0 : locked.nodes = Arc::new(nodes);
4216 0 :
4217 0 : locked.scheduler.node_remove(node_id);
4218 0 :
4219 0 : Ok(())
4220 0 : }
4221 :
4222 0 : pub(crate) async fn node_list(&self) -> Result<Vec<Node>, ApiError> {
4223 0 : let nodes = {
4224 0 : self.inner
4225 0 : .read()
4226 0 : .unwrap()
4227 0 : .nodes
4228 0 : .values()
4229 0 : .cloned()
4230 0 : .collect::<Vec<_>>()
4231 0 : };
4232 0 :
4233 0 : Ok(nodes)
4234 0 : }
4235 :
4236 0 : pub(crate) async fn get_node(&self, node_id: NodeId) -> Result<Node, ApiError> {
4237 0 : self.inner
4238 0 : .read()
4239 0 : .unwrap()
4240 0 : .nodes
4241 0 : .get(&node_id)
4242 0 : .cloned()
4243 0 : .ok_or(ApiError::NotFound(
4244 0 : format!("Node {node_id} not registered").into(),
4245 0 : ))
4246 0 : }
4247 :
4248 0 : pub(crate) async fn node_register(
4249 0 : &self,
4250 0 : register_req: NodeRegisterRequest,
4251 0 : ) -> Result<(), ApiError> {
4252 0 : let _node_lock = trace_exclusive_lock(
4253 0 : &self.node_op_locks,
4254 0 : register_req.node_id,
4255 0 : NodeOperations::Register,
4256 0 : )
4257 0 : .await;
4258 :
4259 : {
4260 0 : let locked = self.inner.read().unwrap();
4261 0 : if let Some(node) = locked.nodes.get(®ister_req.node_id) {
4262 : // Note that we do not do a total equality of the struct, because we don't require
4263 : // the availability/scheduling states to agree for a POST to be idempotent.
4264 0 : if node.registration_match(®ister_req) {
4265 0 : tracing::info!(
4266 0 : "Node {} re-registered with matching address",
4267 : register_req.node_id
4268 : );
4269 0 : return Ok(());
4270 : } else {
4271 : // TODO: decide if we want to allow modifying node addresses without removing and re-adding
4272 : // the node. Safest/simplest thing is to refuse it, and usually we deploy with
4273 : // a fixed address through the lifetime of a node.
4274 0 : tracing::warn!(
4275 0 : "Node {} tried to register with different address",
4276 : register_req.node_id
4277 : );
4278 0 : return Err(ApiError::Conflict(
4279 0 : "Node is already registered with different address".to_string(),
4280 0 : ));
4281 : }
4282 0 : }
4283 0 : }
4284 0 :
4285 0 : // We do not require that a node is actually online when registered (it will start life
4286 0 : // with it's availability set to Offline), but we _do_ require that its DNS record exists. We're
4287 0 : // therefore not immune to asymmetric L3 connectivity issues, but we are protected against nodes
4288 0 : // that register themselves with a broken DNS config. We check only the HTTP hostname, because
4289 0 : // the postgres hostname might only be resolvable to clients (e.g. if we're on a different VPC than clients).
4290 0 : if tokio::net::lookup_host(format!(
4291 0 : "{}:{}",
4292 0 : register_req.listen_http_addr, register_req.listen_http_port
4293 0 : ))
4294 0 : .await
4295 0 : .is_err()
4296 : {
4297 : // If we have a transient DNS issue, it's up to the caller to retry their registration. Because
4298 : // we can't robustly distinguish between an intermittent issue and a totally bogus DNS situation,
4299 : // we return a soft 503 error, to encourage callers to retry past transient issues.
4300 0 : return Err(ApiError::ResourceUnavailable(
4301 0 : format!(
4302 0 : "Node {} tried to register with unknown DNS name '{}'",
4303 0 : register_req.node_id, register_req.listen_http_addr
4304 0 : )
4305 0 : .into(),
4306 0 : ));
4307 0 : }
4308 0 :
4309 0 : // Ordering: we must persist the new node _before_ adding it to in-memory state.
4310 0 : // This ensures that before we use it for anything or expose it via any external
4311 0 : // API, it is guaranteed to be available after a restart.
4312 0 : let new_node = Node::new(
4313 0 : register_req.node_id,
4314 0 : register_req.listen_http_addr,
4315 0 : register_req.listen_http_port,
4316 0 : register_req.listen_pg_addr,
4317 0 : register_req.listen_pg_port,
4318 0 : );
4319 0 :
4320 0 : // TODO: idempotency if the node already exists in the database
4321 0 : self.persistence.insert_node(&new_node).await?;
4322 :
4323 0 : let mut locked = self.inner.write().unwrap();
4324 0 : let mut new_nodes = (*locked.nodes).clone();
4325 0 :
4326 0 : locked.scheduler.node_upsert(&new_node);
4327 0 : new_nodes.insert(register_req.node_id, new_node);
4328 0 :
4329 0 : locked.nodes = Arc::new(new_nodes);
4330 0 :
4331 0 : tracing::info!(
4332 0 : "Registered pageserver {}, now have {} pageservers",
4333 0 : register_req.node_id,
4334 0 : locked.nodes.len()
4335 : );
4336 0 : Ok(())
4337 0 : }
4338 :
4339 0 : pub(crate) async fn node_configure(
4340 0 : &self,
4341 0 : node_id: NodeId,
4342 0 : availability: Option<NodeAvailability>,
4343 0 : scheduling: Option<NodeSchedulingPolicy>,
4344 0 : ) -> Result<(), ApiError> {
4345 0 : let _node_lock =
4346 0 : trace_exclusive_lock(&self.node_op_locks, node_id, NodeOperations::Configure).await;
4347 :
4348 0 : if let Some(scheduling) = scheduling {
4349 : // Scheduling is a persistent part of Node: we must write updates to the database before
4350 : // applying them in memory
4351 0 : self.persistence.update_node(node_id, scheduling).await?;
4352 0 : }
4353 :
4354 : // If we're activating a node, then before setting it active we must reconcile any shard locations
4355 : // on that node, in case it is out of sync, e.g. due to being unavailable during controller startup,
4356 : // by calling [`Self::node_activate_reconcile`]
4357 : //
4358 : // The transition we calculate here remains valid later in the function because we hold the op lock on the node:
4359 : // nothing else can mutate its availability while we run.
4360 0 : let availability_transition = if let Some(input_availability) = availability {
4361 0 : let (activate_node, availability_transition) = {
4362 0 : let locked = self.inner.read().unwrap();
4363 0 : let Some(node) = locked.nodes.get(&node_id) else {
4364 0 : return Err(ApiError::NotFound(
4365 0 : anyhow::anyhow!("Node {} not registered", node_id).into(),
4366 0 : ));
4367 : };
4368 :
4369 0 : (
4370 0 : node.clone(),
4371 0 : node.get_availability_transition(input_availability),
4372 0 : )
4373 : };
4374 :
4375 0 : if matches!(availability_transition, AvailabilityTransition::ToActive) {
4376 0 : self.node_activate_reconcile(activate_node, &_node_lock)
4377 0 : .await?;
4378 0 : }
4379 0 : availability_transition
4380 : } else {
4381 0 : AvailabilityTransition::Unchanged
4382 : };
4383 :
4384 : // Apply changes from the request to our in-memory state for the Node
4385 0 : let mut locked = self.inner.write().unwrap();
4386 0 : let (nodes, tenants, scheduler) = locked.parts_mut();
4387 0 :
4388 0 : let mut new_nodes = (**nodes).clone();
4389 :
4390 0 : let Some(node) = new_nodes.get_mut(&node_id) else {
4391 0 : return Err(ApiError::NotFound(
4392 0 : anyhow::anyhow!("Node not registered").into(),
4393 0 : ));
4394 : };
4395 :
4396 0 : if let Some(availability) = &availability {
4397 0 : node.set_availability(*availability);
4398 0 : }
4399 :
4400 0 : if let Some(scheduling) = scheduling {
4401 0 : node.set_scheduling(scheduling);
4402 0 : }
4403 :
4404 : // Update the scheduler, in case the elegibility of the node for new shards has changed
4405 0 : scheduler.node_upsert(node);
4406 0 :
4407 0 : let new_nodes = Arc::new(new_nodes);
4408 0 :
4409 0 : // Modify scheduling state for any Tenants that are affected by a change in the node's availability state.
4410 0 : match availability_transition {
4411 : AvailabilityTransition::ToOffline => {
4412 0 : tracing::info!("Node {} transition to offline", node_id);
4413 0 : let mut tenants_affected: usize = 0;
4414 :
4415 0 : for (tenant_shard_id, tenant_shard) in tenants {
4416 0 : if let Some(observed_loc) = tenant_shard.observed.locations.get_mut(&node_id) {
4417 0 : // When a node goes offline, we set its observed configuration to None, indicating unknown: we will
4418 0 : // not assume our knowledge of the node's configuration is accurate until it comes back online
4419 0 : observed_loc.conf = None;
4420 0 : }
4421 :
4422 0 : if new_nodes.len() == 1 {
4423 : // Special case for single-node cluster: there is no point trying to reschedule
4424 : // any tenant shards: avoid doing so, in order to avoid spewing warnings about
4425 : // failures to schedule them.
4426 0 : continue;
4427 0 : }
4428 0 :
4429 0 : if !new_nodes
4430 0 : .values()
4431 0 : .any(|n| matches!(n.may_schedule(), MaySchedule::Yes(_)))
4432 : {
4433 : // Special case for when all nodes are unavailable and/or unschedulable: there is no point
4434 : // trying to reschedule since there's nowhere else to go. Without this
4435 : // branch we incorrectly detach tenants in response to node unavailability.
4436 0 : continue;
4437 0 : }
4438 0 :
4439 0 : if tenant_shard.intent.demote_attached(scheduler, node_id) {
4440 0 : tenant_shard.sequence = tenant_shard.sequence.next();
4441 0 :
4442 0 : // TODO: populate a ScheduleContext including all shards in the same tenant_id (only matters
4443 0 : // for tenants without secondary locations: if they have a secondary location, then this
4444 0 : // schedule() call is just promoting an existing secondary)
4445 0 : let mut schedule_context = ScheduleContext::default();
4446 0 :
4447 0 : match tenant_shard.schedule(scheduler, &mut schedule_context) {
4448 0 : Err(e) => {
4449 0 : // It is possible that some tenants will become unschedulable when too many pageservers
4450 0 : // go offline: in this case there isn't much we can do other than make the issue observable.
4451 0 : // TODO: give TenantShard a scheduling error attribute to be queried later.
4452 0 : tracing::warn!(%tenant_shard_id, "Scheduling error when marking pageserver {} offline: {e}", node_id);
4453 : }
4454 : Ok(()) => {
4455 0 : if self
4456 0 : .maybe_reconcile_shard(tenant_shard, &new_nodes)
4457 0 : .is_some()
4458 0 : {
4459 0 : tenants_affected += 1;
4460 0 : };
4461 : }
4462 : }
4463 0 : }
4464 : }
4465 0 : tracing::info!(
4466 0 : "Launched {} reconciler tasks for tenants affected by node {} going offline",
4467 : tenants_affected,
4468 : node_id
4469 : )
4470 : }
4471 : AvailabilityTransition::ToActive => {
4472 0 : tracing::info!("Node {} transition to active", node_id);
4473 : // When a node comes back online, we must reconcile any tenant that has a None observed
4474 : // location on the node.
4475 0 : for tenant_shard in locked.tenants.values_mut() {
4476 : // If a reconciliation is already in progress, rely on the previous scheduling
4477 : // decision and skip triggering a new reconciliation.
4478 0 : if tenant_shard.reconciler.is_some() {
4479 0 : continue;
4480 0 : }
4481 :
4482 0 : if let Some(observed_loc) = tenant_shard.observed.locations.get_mut(&node_id) {
4483 0 : if observed_loc.conf.is_none() {
4484 0 : self.maybe_reconcile_shard(tenant_shard, &new_nodes);
4485 0 : }
4486 0 : }
4487 : }
4488 :
4489 : // TODO: in the background, we should balance work back onto this pageserver
4490 : }
4491 : AvailabilityTransition::Unchanged => {
4492 0 : tracing::debug!("Node {} no availability change during config", node_id);
4493 : }
4494 : }
4495 :
4496 0 : locked.nodes = new_nodes;
4497 0 :
4498 0 : Ok(())
4499 0 : }
4500 :
4501 0 : pub(crate) async fn start_node_drain(
4502 0 : self: &Arc<Self>,
4503 0 : node_id: NodeId,
4504 0 : ) -> Result<(), ApiError> {
4505 0 : let (ongoing_op, node_available, node_policy, schedulable_nodes_count) = {
4506 0 : let locked = self.inner.read().unwrap();
4507 0 : let nodes = &locked.nodes;
4508 0 : let node = nodes.get(&node_id).ok_or(ApiError::NotFound(
4509 0 : anyhow::anyhow!("Node {} not registered", node_id).into(),
4510 0 : ))?;
4511 0 : let schedulable_nodes_count = nodes
4512 0 : .iter()
4513 0 : .filter(|(_, n)| matches!(n.may_schedule(), MaySchedule::Yes(_)))
4514 0 : .count();
4515 0 :
4516 0 : (
4517 0 : locked
4518 0 : .ongoing_operation
4519 0 : .as_ref()
4520 0 : .map(|ongoing| ongoing.operation),
4521 0 : node.is_available(),
4522 0 : node.get_scheduling(),
4523 0 : schedulable_nodes_count,
4524 0 : )
4525 : };
4526 :
4527 0 : if let Some(ongoing) = ongoing_op {
4528 0 : return Err(ApiError::PreconditionFailed(
4529 0 : format!("Background operation already ongoing for node: {}", ongoing).into(),
4530 0 : ));
4531 0 : }
4532 0 :
4533 0 : if !node_available {
4534 0 : return Err(ApiError::ResourceUnavailable(
4535 0 : format!("Node {node_id} is currently unavailable").into(),
4536 0 : ));
4537 0 : }
4538 0 :
4539 0 : if schedulable_nodes_count == 0 {
4540 0 : return Err(ApiError::PreconditionFailed(
4541 0 : "No other schedulable nodes to drain to".into(),
4542 0 : ));
4543 0 : }
4544 0 :
4545 0 : match node_policy {
4546 : NodeSchedulingPolicy::Active | NodeSchedulingPolicy::Pause => {
4547 0 : self.node_configure(node_id, None, Some(NodeSchedulingPolicy::Draining))
4548 0 : .await?;
4549 :
4550 0 : let cancel = self.cancel.child_token();
4551 0 : let gate_guard = self.gate.enter().map_err(|_| ApiError::ShuttingDown)?;
4552 :
4553 0 : self.inner.write().unwrap().ongoing_operation = Some(OperationHandler {
4554 0 : operation: Operation::Drain(Drain { node_id }),
4555 0 : cancel: cancel.clone(),
4556 0 : });
4557 0 :
4558 0 : tokio::task::spawn({
4559 0 : let service = self.clone();
4560 0 : let cancel = cancel.clone();
4561 0 : async move {
4562 0 : let _gate_guard = gate_guard;
4563 :
4564 : scopeguard::defer! {
4565 : let prev = service.inner.write().unwrap().ongoing_operation.take();
4566 :
4567 0 : if let Some(Operation::Drain(removed_drain)) = prev.map(|h| h.operation) {
4568 : assert_eq!(removed_drain.node_id, node_id, "We always take the same operation");
4569 : } else {
4570 : panic!("We always remove the same operation")
4571 : }
4572 : }
4573 :
4574 0 : tracing::info!(%node_id, "Drain background operation starting");
4575 0 : let res = service.drain_node(node_id, cancel).await;
4576 0 : match res {
4577 : Ok(()) => {
4578 0 : tracing::info!(%node_id, "Drain background operation completed successfully");
4579 : }
4580 : Err(OperationError::Cancelled) => {
4581 0 : tracing::info!(%node_id, "Drain background operation was cancelled");
4582 : }
4583 0 : Err(err) => {
4584 0 : tracing::error!(%node_id, "Drain background operation encountered: {err}")
4585 : }
4586 : }
4587 0 : }
4588 0 : });
4589 : }
4590 : NodeSchedulingPolicy::Draining => {
4591 0 : return Err(ApiError::Conflict(format!(
4592 0 : "Node {node_id} has drain in progress"
4593 0 : )));
4594 : }
4595 0 : policy => {
4596 0 : return Err(ApiError::PreconditionFailed(
4597 0 : format!("Node {node_id} cannot be drained due to {policy:?} policy").into(),
4598 0 : ));
4599 : }
4600 : }
4601 :
4602 0 : Ok(())
4603 0 : }
4604 :
4605 0 : pub(crate) async fn cancel_node_drain(&self, node_id: NodeId) -> Result<(), ApiError> {
4606 0 : let (node_available, node_policy) = {
4607 0 : let locked = self.inner.read().unwrap();
4608 0 : let nodes = &locked.nodes;
4609 0 : let node = nodes.get(&node_id).ok_or(ApiError::NotFound(
4610 0 : anyhow::anyhow!("Node {} not registered", node_id).into(),
4611 0 : ))?;
4612 :
4613 0 : (node.is_available(), node.get_scheduling())
4614 0 : };
4615 0 :
4616 0 : if !node_available {
4617 0 : return Err(ApiError::ResourceUnavailable(
4618 0 : format!("Node {node_id} is currently unavailable").into(),
4619 0 : ));
4620 0 : }
4621 :
4622 0 : if !matches!(node_policy, NodeSchedulingPolicy::Draining) {
4623 0 : return Err(ApiError::PreconditionFailed(
4624 0 : format!("Node {node_id} has no drain in progress").into(),
4625 0 : ));
4626 0 : }
4627 :
4628 0 : if let Some(op_handler) = self.inner.read().unwrap().ongoing_operation.as_ref() {
4629 0 : if let Operation::Drain(drain) = op_handler.operation {
4630 0 : if drain.node_id == node_id {
4631 0 : tracing::info!("Cancelling background drain operation for node {node_id}");
4632 0 : op_handler.cancel.cancel();
4633 0 : return Ok(());
4634 0 : }
4635 0 : }
4636 0 : }
4637 :
4638 0 : Err(ApiError::PreconditionFailed(
4639 0 : format!("Node {node_id} has no drain in progress").into(),
4640 0 : ))
4641 0 : }
4642 :
4643 0 : pub(crate) async fn start_node_fill(self: &Arc<Self>, node_id: NodeId) -> Result<(), ApiError> {
4644 0 : let (ongoing_op, node_available, node_policy, total_nodes_count) = {
4645 0 : let locked = self.inner.read().unwrap();
4646 0 : let nodes = &locked.nodes;
4647 0 : let node = nodes.get(&node_id).ok_or(ApiError::NotFound(
4648 0 : anyhow::anyhow!("Node {} not registered", node_id).into(),
4649 0 : ))?;
4650 :
4651 0 : (
4652 0 : locked
4653 0 : .ongoing_operation
4654 0 : .as_ref()
4655 0 : .map(|ongoing| ongoing.operation),
4656 0 : node.is_available(),
4657 0 : node.get_scheduling(),
4658 0 : nodes.len(),
4659 0 : )
4660 : };
4661 :
4662 0 : if let Some(ongoing) = ongoing_op {
4663 0 : return Err(ApiError::PreconditionFailed(
4664 0 : format!("Background operation already ongoing for node: {}", ongoing).into(),
4665 0 : ));
4666 0 : }
4667 0 :
4668 0 : if !node_available {
4669 0 : return Err(ApiError::ResourceUnavailable(
4670 0 : format!("Node {node_id} is currently unavailable").into(),
4671 0 : ));
4672 0 : }
4673 0 :
4674 0 : if total_nodes_count <= 1 {
4675 0 : return Err(ApiError::PreconditionFailed(
4676 0 : "No other nodes to fill from".into(),
4677 0 : ));
4678 0 : }
4679 0 :
4680 0 : match node_policy {
4681 : NodeSchedulingPolicy::Active => {
4682 0 : self.node_configure(node_id, None, Some(NodeSchedulingPolicy::Filling))
4683 0 : .await?;
4684 :
4685 0 : let cancel = self.cancel.child_token();
4686 0 : let gate_guard = self.gate.enter().map_err(|_| ApiError::ShuttingDown)?;
4687 :
4688 0 : self.inner.write().unwrap().ongoing_operation = Some(OperationHandler {
4689 0 : operation: Operation::Fill(Fill { node_id }),
4690 0 : cancel: cancel.clone(),
4691 0 : });
4692 0 :
4693 0 : tokio::task::spawn({
4694 0 : let service = self.clone();
4695 0 : let cancel = cancel.clone();
4696 0 : async move {
4697 0 : let _gate_guard = gate_guard;
4698 :
4699 : scopeguard::defer! {
4700 : let prev = service.inner.write().unwrap().ongoing_operation.take();
4701 :
4702 0 : if let Some(Operation::Fill(removed_fill)) = prev.map(|h| h.operation) {
4703 : assert_eq!(removed_fill.node_id, node_id, "We always take the same operation");
4704 : } else {
4705 : panic!("We always remove the same operation")
4706 : }
4707 : }
4708 :
4709 0 : tracing::info!(%node_id, "Fill background operation starting");
4710 0 : let res = service.fill_node(node_id, cancel).await;
4711 0 : match res {
4712 : Ok(()) => {
4713 0 : tracing::info!(%node_id, "Fill background operation completed successfully");
4714 : }
4715 : Err(OperationError::Cancelled) => {
4716 0 : tracing::info!(%node_id, "Fill background operation was cancelled");
4717 : }
4718 0 : Err(err) => {
4719 0 : tracing::error!(%node_id, "Fill background operation encountered: {err}")
4720 : }
4721 : }
4722 0 : }
4723 0 : });
4724 : }
4725 : NodeSchedulingPolicy::Filling => {
4726 0 : return Err(ApiError::Conflict(format!(
4727 0 : "Node {node_id} has fill in progress"
4728 0 : )));
4729 : }
4730 0 : policy => {
4731 0 : return Err(ApiError::PreconditionFailed(
4732 0 : format!("Node {node_id} cannot be filled due to {policy:?} policy").into(),
4733 0 : ));
4734 : }
4735 : }
4736 :
4737 0 : Ok(())
4738 0 : }
4739 :
4740 0 : pub(crate) async fn cancel_node_fill(&self, node_id: NodeId) -> Result<(), ApiError> {
4741 0 : let (node_available, node_policy) = {
4742 0 : let locked = self.inner.read().unwrap();
4743 0 : let nodes = &locked.nodes;
4744 0 : let node = nodes.get(&node_id).ok_or(ApiError::NotFound(
4745 0 : anyhow::anyhow!("Node {} not registered", node_id).into(),
4746 0 : ))?;
4747 :
4748 0 : (node.is_available(), node.get_scheduling())
4749 0 : };
4750 0 :
4751 0 : if !node_available {
4752 0 : return Err(ApiError::ResourceUnavailable(
4753 0 : format!("Node {node_id} is currently unavailable").into(),
4754 0 : ));
4755 0 : }
4756 :
4757 0 : if !matches!(node_policy, NodeSchedulingPolicy::Filling) {
4758 0 : return Err(ApiError::PreconditionFailed(
4759 0 : format!("Node {node_id} has no fill in progress").into(),
4760 0 : ));
4761 0 : }
4762 :
4763 0 : if let Some(op_handler) = self.inner.read().unwrap().ongoing_operation.as_ref() {
4764 0 : if let Operation::Fill(fill) = op_handler.operation {
4765 0 : if fill.node_id == node_id {
4766 0 : tracing::info!("Cancelling background drain operation for node {node_id}");
4767 0 : op_handler.cancel.cancel();
4768 0 : return Ok(());
4769 0 : }
4770 0 : }
4771 0 : }
4772 :
4773 0 : Err(ApiError::PreconditionFailed(
4774 0 : format!("Node {node_id} has no fill in progress").into(),
4775 0 : ))
4776 0 : }
4777 :
4778 : /// Helper for methods that will try and call pageserver APIs for
4779 : /// a tenant, such as timeline CRUD: they cannot proceed unless the tenant
4780 : /// is attached somewhere.
4781 0 : fn ensure_attached_schedule(
4782 0 : &self,
4783 0 : mut locked: std::sync::RwLockWriteGuard<'_, ServiceState>,
4784 0 : tenant_id: TenantId,
4785 0 : ) -> Result<Vec<ReconcilerWaiter>, anyhow::Error> {
4786 0 : let mut waiters = Vec::new();
4787 0 : let (nodes, tenants, scheduler) = locked.parts_mut();
4788 0 :
4789 0 : let mut schedule_context = ScheduleContext::default();
4790 0 : for (tenant_shard_id, shard) in tenants.range_mut(TenantShardId::tenant_range(tenant_id)) {
4791 0 : shard.schedule(scheduler, &mut schedule_context)?;
4792 :
4793 : // The shard's policies may not result in an attached location being scheduled: this
4794 : // is an error because our caller needs it attached somewhere.
4795 0 : if shard.intent.get_attached().is_none() {
4796 0 : return Err(anyhow::anyhow!(
4797 0 : "Tenant {tenant_id} not scheduled to be attached"
4798 0 : ));
4799 0 : };
4800 0 :
4801 0 : if shard.stably_attached().is_some() {
4802 : // We do not require the shard to be totally up to date on reconciliation: we just require
4803 : // that it has been attached on the intended node. Other dirty state such as unattached secondary
4804 : // locations, or compute hook notifications can be ignored.
4805 0 : continue;
4806 0 : }
4807 :
4808 0 : if let Some(waiter) = self.maybe_reconcile_shard(shard, nodes) {
4809 0 : tracing::info!("Waiting for shard {tenant_shard_id} to reconcile, in order to ensure it is attached");
4810 0 : waiters.push(waiter);
4811 0 : }
4812 : }
4813 0 : Ok(waiters)
4814 0 : }
4815 :
4816 0 : async fn ensure_attached_wait(&self, tenant_id: TenantId) -> Result<(), ApiError> {
4817 0 : let ensure_waiters = {
4818 0 : let locked = self.inner.write().unwrap();
4819 :
4820 : // Check if the tenant is splitting: in this case, even if it is attached,
4821 : // we must act as if it is not: this blocks e.g. timeline creation/deletion
4822 : // operations during the split.
4823 0 : for (_shard_id, shard) in locked.tenants.range(TenantShardId::tenant_range(tenant_id)) {
4824 0 : if !matches!(shard.splitting, SplitState::Idle) {
4825 0 : return Err(ApiError::ResourceUnavailable(
4826 0 : "Tenant shards are currently splitting".into(),
4827 0 : ));
4828 0 : }
4829 : }
4830 :
4831 0 : self.ensure_attached_schedule(locked, tenant_id)
4832 0 : .map_err(ApiError::InternalServerError)?
4833 : };
4834 :
4835 0 : let deadline = Instant::now().checked_add(Duration::from_secs(5)).unwrap();
4836 0 : for waiter in ensure_waiters {
4837 0 : let timeout = deadline.duration_since(Instant::now());
4838 0 : waiter.wait_timeout(timeout).await?;
4839 : }
4840 :
4841 0 : Ok(())
4842 0 : }
4843 :
4844 : /// Wrap [`TenantShard`] reconciliation methods with acquisition of [`Gate`] and [`ReconcileUnits`],
4845 0 : fn maybe_reconcile_shard(
4846 0 : &self,
4847 0 : shard: &mut TenantShard,
4848 0 : nodes: &Arc<HashMap<NodeId, Node>>,
4849 0 : ) -> Option<ReconcilerWaiter> {
4850 0 : let reconcile_needed = shard.get_reconcile_needed(nodes);
4851 0 :
4852 0 : match reconcile_needed {
4853 0 : ReconcileNeeded::No => return None,
4854 0 : ReconcileNeeded::WaitExisting(waiter) => return Some(waiter),
4855 0 : ReconcileNeeded::Yes => {
4856 0 : // Fall through to try and acquire units for spawning reconciler
4857 0 : }
4858 : };
4859 :
4860 0 : let units = match self.reconciler_concurrency.clone().try_acquire_owned() {
4861 0 : Ok(u) => ReconcileUnits::new(u),
4862 : Err(_) => {
4863 0 : tracing::info!(tenant_id=%shard.tenant_shard_id.tenant_id, shard_id=%shard.tenant_shard_id.shard_slug(),
4864 0 : "Concurrency limited: enqueued for reconcile later");
4865 0 : if !shard.delayed_reconcile {
4866 0 : match self.delayed_reconcile_tx.try_send(shard.tenant_shard_id) {
4867 0 : Err(TrySendError::Closed(_)) => {
4868 0 : // Weird mid-shutdown case?
4869 0 : }
4870 : Err(TrySendError::Full(_)) => {
4871 : // It is safe to skip sending our ID in the channel: we will eventually get retried by the background reconcile task.
4872 0 : tracing::warn!(
4873 0 : "Many shards are waiting to reconcile: delayed_reconcile queue is full"
4874 : );
4875 : }
4876 0 : Ok(()) => {
4877 0 : shard.delayed_reconcile = true;
4878 0 : }
4879 : }
4880 0 : }
4881 :
4882 : // We won't spawn a reconciler, but we will construct a waiter that waits for the shard's sequence
4883 : // number to advance. When this function is eventually called again and succeeds in getting units,
4884 : // it will spawn a reconciler that makes this waiter complete.
4885 0 : return Some(shard.future_reconcile_waiter());
4886 : }
4887 : };
4888 :
4889 0 : let Ok(gate_guard) = self.gate.enter() else {
4890 : // Gate closed: we're shutting down, drop out.
4891 0 : return None;
4892 : };
4893 :
4894 0 : shard.spawn_reconciler(
4895 0 : &self.result_tx,
4896 0 : nodes,
4897 0 : &self.compute_hook,
4898 0 : &self.config,
4899 0 : &self.persistence,
4900 0 : units,
4901 0 : gate_guard,
4902 0 : &self.cancel,
4903 0 : )
4904 0 : }
4905 :
4906 : /// Check all tenants for pending reconciliation work, and reconcile those in need.
4907 : /// Additionally, reschedule tenants that require it.
4908 : ///
4909 : /// Returns how many reconciliation tasks were started, or `1` if no reconciles were
4910 : /// spawned but some _would_ have been spawned if `reconciler_concurrency` units where
4911 : /// available. A return value of 0 indicates that everything is fully reconciled already.
4912 0 : fn reconcile_all(&self) -> usize {
4913 0 : let mut locked = self.inner.write().unwrap();
4914 0 : let (nodes, tenants, _scheduler) = locked.parts_mut();
4915 0 : let pageservers = nodes.clone();
4916 0 :
4917 0 : let mut schedule_context = ScheduleContext::default();
4918 0 :
4919 0 : let mut reconciles_spawned = 0;
4920 0 : for (tenant_shard_id, shard) in tenants.iter_mut() {
4921 0 : if tenant_shard_id.is_shard_zero() {
4922 0 : schedule_context = ScheduleContext::default();
4923 0 : }
4924 :
4925 : // Skip checking if this shard is already enqueued for reconciliation
4926 0 : if shard.delayed_reconcile && self.reconciler_concurrency.available_permits() == 0 {
4927 : // If there is something delayed, then return a nonzero count so that
4928 : // callers like reconcile_all_now do not incorrectly get the impression
4929 : // that the system is in a quiescent state.
4930 0 : reconciles_spawned = std::cmp::max(1, reconciles_spawned);
4931 0 : continue;
4932 0 : }
4933 0 :
4934 0 : // Eventual consistency: if an earlier reconcile job failed, and the shard is still
4935 0 : // dirty, spawn another rone
4936 0 : if self.maybe_reconcile_shard(shard, &pageservers).is_some() {
4937 0 : reconciles_spawned += 1;
4938 0 : }
4939 :
4940 0 : schedule_context.avoid(&shard.intent.all_pageservers());
4941 : }
4942 :
4943 0 : reconciles_spawned
4944 0 : }
4945 :
4946 : /// `optimize` in this context means identifying shards which have valid scheduled locations, but
4947 : /// could be scheduled somewhere better:
4948 : /// - Cutting over to a secondary if the node with the secondary is more lightly loaded
4949 : /// * e.g. after a node fails then recovers, to move some work back to it
4950 : /// - Cutting over to a secondary if it improves the spread of shard attachments within a tenant
4951 : /// * e.g. after a shard split, the initial attached locations will all be on the node where
4952 : /// we did the split, but are probably better placed elsewhere.
4953 : /// - Creating new secondary locations if it improves the spreading of a sharded tenant
4954 : /// * e.g. after a shard split, some locations will be on the same node (where the split
4955 : /// happened), and will probably be better placed elsewhere.
4956 : ///
4957 : /// To put it more briefly: whereas the scheduler respects soft constraints in a ScheduleContext at
4958 : /// the time of scheduling, this function looks for cases where a better-scoring location is available
4959 : /// according to those same soft constraints.
4960 0 : async fn optimize_all(&self) -> usize {
4961 0 : // Limit on how many shards' optmizations each call to this function will execute. Combined
4962 0 : // with the frequency of background calls, this acts as an implicit rate limit that runs a small
4963 0 : // trickle of optimizations in the background, rather than executing a large number in parallel
4964 0 : // when a change occurs.
4965 0 : const MAX_OPTIMIZATIONS_EXEC_PER_PASS: usize = 2;
4966 0 :
4967 0 : // Synchronous prepare: scan shards for possible scheduling optimizations
4968 0 : let candidate_work = self.optimize_all_plan();
4969 0 : let candidate_work_len = candidate_work.len();
4970 :
4971 : // Asynchronous validate: I/O to pageservers to make sure shards are in a good state to apply validation
4972 0 : let validated_work = self.optimize_all_validate(candidate_work).await;
4973 :
4974 0 : let was_work_filtered = validated_work.len() != candidate_work_len;
4975 0 :
4976 0 : // Synchronous apply: update the shards' intent states according to validated optimisations
4977 0 : let mut reconciles_spawned = 0;
4978 0 : let mut optimizations_applied = 0;
4979 0 : let mut locked = self.inner.write().unwrap();
4980 0 : let (nodes, tenants, scheduler) = locked.parts_mut();
4981 0 : for (tenant_shard_id, optimization) in validated_work {
4982 0 : let Some(shard) = tenants.get_mut(&tenant_shard_id) else {
4983 : // Shard was dropped between planning and execution;
4984 0 : continue;
4985 : };
4986 0 : if shard.apply_optimization(scheduler, optimization) {
4987 0 : optimizations_applied += 1;
4988 0 : if self.maybe_reconcile_shard(shard, nodes).is_some() {
4989 0 : reconciles_spawned += 1;
4990 0 : }
4991 0 : }
4992 :
4993 0 : if optimizations_applied >= MAX_OPTIMIZATIONS_EXEC_PER_PASS {
4994 0 : break;
4995 0 : }
4996 : }
4997 :
4998 0 : if was_work_filtered {
4999 0 : // If we filtered any work out during validation, ensure we return a nonzero value to indicate
5000 0 : // to callers that the system is not in a truly quiet state, it's going to do some work as soon
5001 0 : // as these validations start passing.
5002 0 : reconciles_spawned = std::cmp::max(reconciles_spawned, 1);
5003 0 : }
5004 :
5005 0 : reconciles_spawned
5006 0 : }
5007 :
5008 0 : fn optimize_all_plan(&self) -> Vec<(TenantShardId, ScheduleOptimization)> {
5009 0 : let mut schedule_context = ScheduleContext::default();
5010 0 :
5011 0 : let mut tenant_shards: Vec<&TenantShard> = Vec::new();
5012 0 :
5013 0 : // How many candidate optimizations we will generate, before evaluating them for readniess: setting
5014 0 : // this higher than the execution limit gives us a chance to execute some work even if the first
5015 0 : // few optimizations we find are not ready.
5016 0 : const MAX_OPTIMIZATIONS_PLAN_PER_PASS: usize = 8;
5017 0 :
5018 0 : let mut work = Vec::new();
5019 0 :
5020 0 : let mut locked = self.inner.write().unwrap();
5021 0 : let (nodes, tenants, scheduler) = locked.parts_mut();
5022 0 : for (tenant_shard_id, shard) in tenants.iter() {
5023 0 : if tenant_shard_id.is_shard_zero() {
5024 0 : // Reset accumulators on the first shard in a tenant
5025 0 : schedule_context = ScheduleContext::default();
5026 0 : schedule_context.mode = ScheduleMode::Speculative;
5027 0 : tenant_shards.clear();
5028 0 : }
5029 :
5030 0 : if work.len() >= MAX_OPTIMIZATIONS_PLAN_PER_PASS {
5031 0 : break;
5032 0 : }
5033 0 :
5034 0 : match shard.get_scheduling_policy() {
5035 0 : ShardSchedulingPolicy::Active => {
5036 0 : // Ok to do optimization
5037 0 : }
5038 : ShardSchedulingPolicy::Essential
5039 : | ShardSchedulingPolicy::Pause
5040 : | ShardSchedulingPolicy::Stop => {
5041 : // Policy prevents optimizing this shard.
5042 0 : continue;
5043 : }
5044 : }
5045 :
5046 : // Accumulate the schedule context for all the shards in a tenant: we must have
5047 : // the total view of all shards before we can try to optimize any of them.
5048 0 : schedule_context.avoid(&shard.intent.all_pageservers());
5049 0 : if let Some(attached) = shard.intent.get_attached() {
5050 0 : schedule_context.push_attached(*attached);
5051 0 : }
5052 0 : tenant_shards.push(shard);
5053 0 :
5054 0 : // Once we have seen the last shard in the tenant, proceed to search across all shards
5055 0 : // in the tenant for optimizations
5056 0 : if shard.shard.number.0 == shard.shard.count.count() - 1 {
5057 0 : if tenant_shards.iter().any(|s| s.reconciler.is_some()) {
5058 : // Do not start any optimizations while another change to the tenant is ongoing: this
5059 : // is not necessary for correctness, but simplifies operations and implicitly throttles
5060 : // optimization changes to happen in a "trickle" over time.
5061 0 : continue;
5062 0 : }
5063 0 :
5064 0 : if tenant_shards.iter().any(|s| {
5065 0 : !matches!(s.splitting, SplitState::Idle)
5066 0 : || matches!(s.policy, PlacementPolicy::Detached)
5067 0 : }) {
5068 : // Never attempt to optimize a tenant that is currently being split, or
5069 : // a tenant that is meant to be detached
5070 0 : continue;
5071 0 : }
5072 :
5073 : // TODO: optimization calculations are relatively expensive: create some fast-path for
5074 : // the common idle case (avoiding the search on tenants that we have recently checked)
5075 :
5076 0 : for shard in &tenant_shards {
5077 0 : if let Some(optimization) =
5078 : // If idle, maybe ptimize attachments: if a shard has a secondary location that is preferable to
5079 : // its primary location based on soft constraints, cut it over.
5080 0 : shard.optimize_attachment(nodes, &schedule_context)
5081 : {
5082 0 : work.push((shard.tenant_shard_id, optimization));
5083 0 : break;
5084 0 : } else if let Some(optimization) =
5085 : // If idle, maybe optimize secondary locations: if a shard has a secondary location that would be
5086 : // better placed on another node, based on ScheduleContext, then adjust it. This
5087 : // covers cases like after a shard split, where we might have too many shards
5088 : // in the same tenant with secondary locations on the node where they originally split.
5089 0 : shard.optimize_secondary(scheduler, &schedule_context)
5090 : {
5091 0 : work.push((shard.tenant_shard_id, optimization));
5092 0 : break;
5093 0 : }
5094 :
5095 : // TODO: extend this mechanism to prefer attaching on nodes with fewer attached
5096 : // tenants (i.e. extend schedule state to distinguish attached from secondary counts),
5097 : // for the total number of attachments on a node (not just within a tenant.)
5098 : }
5099 0 : }
5100 : }
5101 :
5102 0 : work
5103 0 : }
5104 :
5105 0 : async fn optimize_all_validate(
5106 0 : &self,
5107 0 : candidate_work: Vec<(TenantShardId, ScheduleOptimization)>,
5108 0 : ) -> Vec<(TenantShardId, ScheduleOptimization)> {
5109 0 : // Take a clone of the node map to use outside the lock in async validation phase
5110 0 : let validation_nodes = { self.inner.read().unwrap().nodes.clone() };
5111 0 :
5112 0 : let mut want_secondary_status = Vec::new();
5113 0 :
5114 0 : // Validate our plans: this is an async phase where we may do I/O to pageservers to
5115 0 : // check that the state of locations is acceptable to run the optimization, such as
5116 0 : // checking that a secondary location is sufficiently warmed-up to cleanly cut over
5117 0 : // in a live migration.
5118 0 : let mut validated_work = Vec::new();
5119 0 : for (tenant_shard_id, optimization) in candidate_work {
5120 0 : match optimization.action {
5121 : ScheduleOptimizationAction::MigrateAttachment(MigrateAttachment {
5122 : old_attached_node_id: _,
5123 0 : new_attached_node_id,
5124 0 : }) => {
5125 0 : match validation_nodes.get(&new_attached_node_id) {
5126 0 : None => {
5127 0 : // Node was dropped between planning and validation
5128 0 : }
5129 0 : Some(node) => {
5130 0 : if !node.is_available() {
5131 0 : tracing::info!("Skipping optimization migration of {tenant_shard_id} to {new_attached_node_id} because node unavailable");
5132 0 : } else {
5133 0 : // Accumulate optimizations that require fetching secondary status, so that we can execute these
5134 0 : // remote API requests concurrently.
5135 0 : want_secondary_status.push((
5136 0 : tenant_shard_id,
5137 0 : node.clone(),
5138 0 : optimization,
5139 0 : ));
5140 0 : }
5141 : }
5142 : }
5143 : }
5144 : ScheduleOptimizationAction::ReplaceSecondary(_) => {
5145 : // No extra checks needed to replace a secondary: this does not interrupt client access
5146 0 : validated_work.push((tenant_shard_id, optimization))
5147 : }
5148 : };
5149 : }
5150 :
5151 : // Call into pageserver API to find out if the destination secondary location is warm enough for a reasonably smooth migration: we
5152 : // do this so that we avoid spawning a Reconciler that would have to wait minutes/hours for a destination to warm up: that reconciler
5153 : // would hold a precious reconcile semaphore unit the whole time it was waiting for the destination to warm up.
5154 0 : let results = self
5155 0 : .tenant_for_shards_api(
5156 0 : want_secondary_status
5157 0 : .iter()
5158 0 : .map(|i| (i.0, i.1.clone()))
5159 0 : .collect(),
5160 0 : |tenant_shard_id, client| async move {
5161 0 : client.tenant_secondary_status(tenant_shard_id).await
5162 0 : },
5163 0 : 1,
5164 0 : 1,
5165 0 : SHORT_RECONCILE_TIMEOUT,
5166 0 : &self.cancel,
5167 0 : )
5168 0 : .await;
5169 :
5170 0 : for ((tenant_shard_id, node, optimization), secondary_status) in
5171 0 : want_secondary_status.into_iter().zip(results.into_iter())
5172 : {
5173 0 : match secondary_status {
5174 0 : Err(e) => {
5175 0 : tracing::info!("Skipping migration of {tenant_shard_id} to {node}, error querying secondary: {e}");
5176 : }
5177 0 : Ok(progress) => {
5178 0 : // We require secondary locations to have less than 10GiB of downloads pending before we will use
5179 0 : // them in an optimization
5180 0 : const DOWNLOAD_FRESHNESS_THRESHOLD: u64 = 10 * 1024 * 1024 * 1024;
5181 0 :
5182 0 : if progress.heatmap_mtime.is_none()
5183 0 : || progress.bytes_total < DOWNLOAD_FRESHNESS_THRESHOLD
5184 0 : && progress.bytes_downloaded != progress.bytes_total
5185 0 : || progress.bytes_total - progress.bytes_downloaded
5186 0 : > DOWNLOAD_FRESHNESS_THRESHOLD
5187 : {
5188 0 : tracing::info!("Skipping migration of {tenant_shard_id} to {node} because secondary isn't ready: {progress:?}");
5189 : } else {
5190 : // Location looks ready: proceed
5191 0 : tracing::info!(
5192 0 : "{tenant_shard_id} secondary on {node} is warm enough for migration: {progress:?}"
5193 : );
5194 0 : validated_work.push((tenant_shard_id, optimization))
5195 : }
5196 : }
5197 : }
5198 : }
5199 :
5200 0 : validated_work
5201 0 : }
5202 :
5203 : /// Look for shards which are oversized and in need of splitting
5204 0 : async fn autosplit_tenants(self: &Arc<Self>) {
5205 0 : let Some(split_threshold) = self.config.split_threshold else {
5206 : // Auto-splitting is disabled
5207 0 : return;
5208 : };
5209 :
5210 0 : let nodes = self.inner.read().unwrap().nodes.clone();
5211 0 :
5212 0 : const SPLIT_TO_MAX: ShardCount = ShardCount::new(8);
5213 0 :
5214 0 : let mut top_n = Vec::new();
5215 0 :
5216 0 : // Call into each node to look for big tenants
5217 0 : let top_n_request = TopTenantShardsRequest {
5218 0 : // We currently split based on logical size, for simplicity: logical size is a signal of
5219 0 : // the user's intent to run a large database, whereas physical/resident size can be symptoms
5220 0 : // of compaction issues. Eventually we should switch to using resident size to bound the
5221 0 : // disk space impact of one shard.
5222 0 : order_by: models::TenantSorting::MaxLogicalSize,
5223 0 : limit: 10,
5224 0 : where_shards_lt: Some(SPLIT_TO_MAX),
5225 0 : where_gt: Some(split_threshold),
5226 0 : };
5227 0 : for node in nodes.values() {
5228 0 : let request_ref = &top_n_request;
5229 0 : match node
5230 0 : .with_client_retries(
5231 0 : |client| async move {
5232 0 : let request = request_ref.clone();
5233 0 : client.top_tenant_shards(request.clone()).await
5234 0 : },
5235 0 : &self.config.jwt_token,
5236 0 : 3,
5237 0 : 3,
5238 0 : Duration::from_secs(5),
5239 0 : &self.cancel,
5240 0 : )
5241 0 : .await
5242 : {
5243 0 : Some(Ok(node_top_n)) => {
5244 0 : top_n.extend(node_top_n.shards.into_iter());
5245 0 : }
5246 : Some(Err(mgmt_api::Error::Cancelled)) => {
5247 0 : continue;
5248 : }
5249 0 : Some(Err(e)) => {
5250 0 : tracing::warn!("Failed to fetch top N tenants from {node}: {e}");
5251 0 : continue;
5252 : }
5253 : None => {
5254 : // Node is shutting down
5255 0 : continue;
5256 : }
5257 : };
5258 : }
5259 :
5260 : // Pick the biggest tenant to split first
5261 0 : top_n.sort_by_key(|i| i.resident_size);
5262 0 : let Some(split_candidate) = top_n.into_iter().next() else {
5263 0 : tracing::debug!("No split-elegible shards found");
5264 0 : return;
5265 : };
5266 :
5267 : // We spawn a task to run this, so it's exactly like some external API client requesting it. We don't
5268 : // want to block the background reconcile loop on this.
5269 0 : tracing::info!("Auto-splitting tenant for size threshold {split_threshold}: current size {split_candidate:?}");
5270 :
5271 0 : let this = self.clone();
5272 0 : tokio::spawn(
5273 0 : async move {
5274 0 : match this
5275 0 : .tenant_shard_split(
5276 0 : split_candidate.id.tenant_id,
5277 0 : TenantShardSplitRequest {
5278 0 : // Always split to the max number of shards: this avoids stepping through
5279 0 : // intervening shard counts and encountering the overrhead of a split+cleanup
5280 0 : // each time as a tenant grows, and is not too expensive because our max shard
5281 0 : // count is relatively low anyway.
5282 0 : // This policy will be adjusted in future once we support higher shard count.
5283 0 : new_shard_count: SPLIT_TO_MAX.literal(),
5284 0 : new_stripe_size: Some(ShardParameters::DEFAULT_STRIPE_SIZE),
5285 0 : },
5286 0 : )
5287 0 : .await
5288 : {
5289 : Ok(_) => {
5290 0 : tracing::info!("Successful auto-split");
5291 : }
5292 0 : Err(e) => {
5293 0 : tracing::error!("Auto-split failed: {e}");
5294 : }
5295 : }
5296 0 : }
5297 0 : .instrument(tracing::info_span!("auto_split", tenant_id=%split_candidate.id.tenant_id)),
5298 : );
5299 0 : }
5300 :
5301 : /// Useful for tests: run whatever work a background [`Self::reconcile_all`] would have done, but
5302 : /// also wait for any generated Reconcilers to complete. Calling this until it returns zero should
5303 : /// put the system into a quiescent state where future background reconciliations won't do anything.
5304 0 : pub(crate) async fn reconcile_all_now(&self) -> Result<usize, ReconcileWaitError> {
5305 0 : let reconciles_spawned = self.reconcile_all();
5306 0 : let reconciles_spawned = if reconciles_spawned == 0 {
5307 : // Only optimize when we are otherwise idle
5308 0 : self.optimize_all().await
5309 : } else {
5310 0 : reconciles_spawned
5311 : };
5312 :
5313 0 : let waiters = {
5314 0 : let mut waiters = Vec::new();
5315 0 : let locked = self.inner.read().unwrap();
5316 0 : for (_tenant_shard_id, shard) in locked.tenants.iter() {
5317 0 : if let Some(waiter) = shard.get_waiter() {
5318 0 : waiters.push(waiter);
5319 0 : }
5320 : }
5321 0 : waiters
5322 0 : };
5323 0 :
5324 0 : let waiter_count = waiters.len();
5325 0 : match self.await_waiters(waiters, RECONCILE_TIMEOUT).await {
5326 0 : Ok(()) => {}
5327 0 : Err(ReconcileWaitError::Failed(_, reconcile_error))
5328 0 : if matches!(*reconcile_error, ReconcileError::Cancel) =>
5329 0 : {
5330 0 : // Ignore reconciler cancel errors: this reconciler might have shut down
5331 0 : // because some other change superceded it. We will return a nonzero number,
5332 0 : // so the caller knows they might have to call again to quiesce the system.
5333 0 : }
5334 0 : Err(e) => {
5335 0 : return Err(e);
5336 : }
5337 : };
5338 :
5339 0 : tracing::info!(
5340 0 : "{} reconciles in reconcile_all, {} waiters",
5341 : reconciles_spawned,
5342 : waiter_count
5343 : );
5344 :
5345 0 : Ok(std::cmp::max(waiter_count, reconciles_spawned))
5346 0 : }
5347 :
5348 0 : pub async fn shutdown(&self) {
5349 0 : // Note that this already stops processing any results from reconciles: so
5350 0 : // we do not expect that our [`TenantShard`] objects will reach a neat
5351 0 : // final state.
5352 0 : self.cancel.cancel();
5353 0 :
5354 0 : // The cancellation tokens in [`crate::reconciler::Reconciler`] are children
5355 0 : // of our cancellation token, so we do not need to explicitly cancel each of
5356 0 : // them.
5357 0 :
5358 0 : // Background tasks and reconcilers hold gate guards: this waits for them all
5359 0 : // to complete.
5360 0 : self.gate.close().await;
5361 0 : }
5362 :
5363 : /// Drain a node by moving the shards attached to it as primaries.
5364 : /// This is a long running operation and it should run as a separate Tokio task.
5365 0 : pub(crate) async fn drain_node(
5366 0 : &self,
5367 0 : node_id: NodeId,
5368 0 : cancel: CancellationToken,
5369 0 : ) -> Result<(), OperationError> {
5370 0 : let mut last_inspected_shard: Option<TenantShardId> = None;
5371 0 : let mut inspected_all_shards = false;
5372 0 : let mut waiters = Vec::new();
5373 :
5374 0 : while !inspected_all_shards {
5375 0 : if cancel.is_cancelled() {
5376 0 : match self
5377 0 : .node_configure(node_id, None, Some(NodeSchedulingPolicy::Active))
5378 0 : .await
5379 : {
5380 0 : Ok(()) => return Err(OperationError::Cancelled),
5381 0 : Err(err) => {
5382 0 : return Err(OperationError::FinalizeError(
5383 0 : format!(
5384 0 : "Failed to finalise drain cancel of {} by setting scheduling policy to Active: {}",
5385 0 : node_id, err
5386 0 : )
5387 0 : .into(),
5388 0 : ));
5389 : }
5390 : }
5391 0 : }
5392 0 :
5393 0 : {
5394 0 : let mut locked = self.inner.write().unwrap();
5395 0 : let (nodes, tenants, scheduler) = locked.parts_mut();
5396 :
5397 0 : let node = nodes.get(&node_id).ok_or(OperationError::NodeStateChanged(
5398 0 : format!("node {node_id} was removed").into(),
5399 0 : ))?;
5400 :
5401 0 : let current_policy = node.get_scheduling();
5402 0 : if !matches!(current_policy, NodeSchedulingPolicy::Draining) {
5403 : // TODO(vlad): maybe cancel pending reconciles before erroring out. need to think
5404 : // about it
5405 0 : return Err(OperationError::NodeStateChanged(
5406 0 : format!("node {node_id} changed state to {current_policy:?}").into(),
5407 0 : ));
5408 0 : }
5409 0 :
5410 0 : let mut cursor = tenants.iter_mut().skip_while({
5411 0 : let skip_past = last_inspected_shard;
5412 0 : move |(tid, _)| match skip_past {
5413 0 : Some(last) => **tid != last,
5414 0 : None => false,
5415 0 : }
5416 0 : });
5417 :
5418 0 : while waiters.len() < MAX_RECONCILES_PER_OPERATION {
5419 0 : let (tid, tenant_shard) = match cursor.next() {
5420 0 : Some(some) => some,
5421 : None => {
5422 0 : inspected_all_shards = true;
5423 0 : break;
5424 : }
5425 : };
5426 :
5427 : // If the shard is not attached to the node being drained, skip it.
5428 0 : if *tenant_shard.intent.get_attached() != Some(node_id) {
5429 0 : last_inspected_shard = Some(*tid);
5430 0 : continue;
5431 0 : }
5432 0 :
5433 0 : match tenant_shard.reschedule_to_secondary(None, scheduler) {
5434 0 : Err(e) => {
5435 0 : tracing::warn!(
5436 0 : tenant_id=%tid.tenant_id, shard_id=%tid.shard_slug(),
5437 0 : "Scheduling error when draining pageserver {} : {e}", node_id
5438 : );
5439 : }
5440 : Ok(()) => {
5441 0 : let scheduled_to = tenant_shard.intent.get_attached();
5442 0 : tracing::info!(
5443 0 : tenant_id=%tid.tenant_id, shard_id=%tid.shard_slug(),
5444 0 : "Rescheduled shard while draining node {}: {} -> {:?}",
5445 : node_id,
5446 : node_id,
5447 : scheduled_to
5448 : );
5449 :
5450 0 : let waiter = self.maybe_reconcile_shard(tenant_shard, nodes);
5451 0 : if let Some(some) = waiter {
5452 0 : waiters.push(some);
5453 0 : }
5454 : }
5455 : }
5456 :
5457 0 : last_inspected_shard = Some(*tid);
5458 : }
5459 : }
5460 :
5461 0 : waiters = self
5462 0 : .await_waiters_remainder(waiters, SHORT_RECONCILE_TIMEOUT)
5463 0 : .await;
5464 :
5465 0 : failpoint_support::sleep_millis_async!("sleepy-drain-loop");
5466 : }
5467 :
5468 0 : while !waiters.is_empty() {
5469 0 : if cancel.is_cancelled() {
5470 0 : match self
5471 0 : .node_configure(node_id, None, Some(NodeSchedulingPolicy::Active))
5472 0 : .await
5473 : {
5474 0 : Ok(()) => return Err(OperationError::Cancelled),
5475 0 : Err(err) => {
5476 0 : return Err(OperationError::FinalizeError(
5477 0 : format!(
5478 0 : "Failed to finalise drain cancel of {} by setting scheduling policy to Active: {}",
5479 0 : node_id, err
5480 0 : )
5481 0 : .into(),
5482 0 : ));
5483 : }
5484 : }
5485 0 : }
5486 0 :
5487 0 : tracing::info!("Awaiting {} pending drain reconciliations", waiters.len());
5488 :
5489 0 : waiters = self
5490 0 : .await_waiters_remainder(waiters, SHORT_RECONCILE_TIMEOUT)
5491 0 : .await;
5492 : }
5493 :
5494 : // At this point we have done the best we could to drain shards from this node.
5495 : // Set the node scheduling policy to `[NodeSchedulingPolicy::PauseForRestart]`
5496 : // to complete the drain.
5497 0 : if let Err(err) = self
5498 0 : .node_configure(node_id, None, Some(NodeSchedulingPolicy::PauseForRestart))
5499 0 : .await
5500 : {
5501 : // This is not fatal. Anything that is polling the node scheduling policy to detect
5502 : // the end of the drain operations will hang, but all such places should enforce an
5503 : // overall timeout. The scheduling policy will be updated upon node re-attach and/or
5504 : // by the counterpart fill operation.
5505 0 : return Err(OperationError::FinalizeError(
5506 0 : format!(
5507 0 : "Failed to finalise drain of {node_id} by setting scheduling policy to PauseForRestart: {err}"
5508 0 : )
5509 0 : .into(),
5510 0 : ));
5511 0 : }
5512 0 :
5513 0 : Ok(())
5514 0 : }
5515 :
5516 : /// Create a node fill plan (pick secondaries to promote) that meets the following requirements:
5517 : /// 1. The node should be filled until it reaches the expected cluster average of
5518 : /// attached shards. If there are not enough secondaries on the node, the plan stops early.
5519 : /// 2. Select tenant shards to promote such that the number of attached shards is balanced
5520 : /// throughout the cluster. We achieve this by picking tenant shards from each node,
5521 : /// starting from the ones with the largest number of attached shards, until the node
5522 : /// reaches the expected cluster average.
5523 : /// 3. Avoid promoting more shards of the same tenant than required. The upper bound
5524 : /// for the number of tenants from the same shard promoted to the node being filled is:
5525 : /// shard count for the tenant divided by the number of nodes in the cluster.
5526 0 : fn fill_node_plan(&self, node_id: NodeId) -> Vec<TenantShardId> {
5527 0 : let mut locked = self.inner.write().unwrap();
5528 0 : let fill_requirement = locked.scheduler.compute_fill_requirement(node_id);
5529 0 :
5530 0 : let mut tids_by_node = locked
5531 0 : .tenants
5532 0 : .iter_mut()
5533 0 : .filter_map(|(tid, tenant_shard)| {
5534 0 : if tenant_shard.intent.get_secondary().contains(&node_id) {
5535 0 : if let Some(primary) = tenant_shard.intent.get_attached() {
5536 0 : return Some((*primary, *tid));
5537 0 : }
5538 0 : }
5539 :
5540 0 : None
5541 0 : })
5542 0 : .into_group_map();
5543 0 :
5544 0 : let expected_attached = locked.scheduler.expected_attached_shard_count();
5545 0 : let nodes_by_load = locked.scheduler.nodes_by_attached_shard_count();
5546 0 :
5547 0 : let mut promoted_per_tenant: HashMap<TenantId, usize> = HashMap::new();
5548 0 : let mut plan = Vec::new();
5549 :
5550 0 : for (node_id, attached) in nodes_by_load {
5551 0 : let available = locked
5552 0 : .nodes
5553 0 : .get(&node_id)
5554 0 : .map_or(false, |n| n.is_available());
5555 0 : if !available {
5556 0 : continue;
5557 0 : }
5558 0 :
5559 0 : if plan.len() >= fill_requirement
5560 0 : || tids_by_node.is_empty()
5561 0 : || attached <= expected_attached
5562 : {
5563 0 : break;
5564 0 : }
5565 0 :
5566 0 : let can_take = attached - expected_attached;
5567 0 : let needed = fill_requirement - plan.len();
5568 0 : let mut take = std::cmp::min(can_take, needed);
5569 0 :
5570 0 : let mut remove_node = false;
5571 0 : while take > 0 {
5572 0 : match tids_by_node.get_mut(&node_id) {
5573 0 : Some(tids) => match tids.pop() {
5574 0 : Some(tid) => {
5575 0 : let max_promote_for_tenant = std::cmp::max(
5576 0 : tid.shard_count.count() as usize / locked.nodes.len(),
5577 0 : 1,
5578 0 : );
5579 0 : let promoted = promoted_per_tenant.entry(tid.tenant_id).or_default();
5580 0 : if *promoted < max_promote_for_tenant {
5581 0 : plan.push(tid);
5582 0 : *promoted += 1;
5583 0 : take -= 1;
5584 0 : }
5585 : }
5586 : None => {
5587 0 : remove_node = true;
5588 0 : break;
5589 : }
5590 : },
5591 : None => {
5592 0 : break;
5593 : }
5594 : }
5595 : }
5596 :
5597 0 : if remove_node {
5598 0 : tids_by_node.remove(&node_id);
5599 0 : }
5600 : }
5601 :
5602 0 : plan
5603 0 : }
5604 :
5605 : /// Fill a node by promoting its secondaries until the cluster is balanced
5606 : /// with regards to attached shard counts. Note that this operation only
5607 : /// makes sense as a counterpart to the drain implemented in [`Service::drain_node`].
5608 : /// This is a long running operation and it should run as a separate Tokio task.
5609 0 : pub(crate) async fn fill_node(
5610 0 : &self,
5611 0 : node_id: NodeId,
5612 0 : cancel: CancellationToken,
5613 0 : ) -> Result<(), OperationError> {
5614 0 : // TODO(vlad): Currently this operates on the assumption that all
5615 0 : // secondaries are warm. This is not always true (e.g. we just migrated the
5616 0 : // tenant). Take that into consideration by checking the secondary status.
5617 0 : let mut tids_to_promote = self.fill_node_plan(node_id);
5618 0 : let mut waiters = Vec::new();
5619 :
5620 : // Execute the plan we've composed above. Before aplying each move from the plan,
5621 : // we validate to ensure that it has not gone stale in the meantime.
5622 0 : while !tids_to_promote.is_empty() {
5623 0 : if cancel.is_cancelled() {
5624 0 : match self
5625 0 : .node_configure(node_id, None, Some(NodeSchedulingPolicy::Active))
5626 0 : .await
5627 : {
5628 0 : Ok(()) => return Err(OperationError::Cancelled),
5629 0 : Err(err) => {
5630 0 : return Err(OperationError::FinalizeError(
5631 0 : format!(
5632 0 : "Failed to finalise drain cancel of {} by setting scheduling policy to Active: {}",
5633 0 : node_id, err
5634 0 : )
5635 0 : .into(),
5636 0 : ));
5637 : }
5638 : }
5639 0 : }
5640 0 :
5641 0 : {
5642 0 : let mut locked = self.inner.write().unwrap();
5643 0 : let (nodes, tenants, scheduler) = locked.parts_mut();
5644 :
5645 0 : let node = nodes.get(&node_id).ok_or(OperationError::NodeStateChanged(
5646 0 : format!("node {node_id} was removed").into(),
5647 0 : ))?;
5648 :
5649 0 : let current_policy = node.get_scheduling();
5650 0 : if !matches!(current_policy, NodeSchedulingPolicy::Filling) {
5651 : // TODO(vlad): maybe cancel pending reconciles before erroring out. need to think
5652 : // about it
5653 0 : return Err(OperationError::NodeStateChanged(
5654 0 : format!("node {node_id} changed state to {current_policy:?}").into(),
5655 0 : ));
5656 0 : }
5657 :
5658 0 : while waiters.len() < MAX_RECONCILES_PER_OPERATION {
5659 0 : if let Some(tid) = tids_to_promote.pop() {
5660 0 : if let Some(tenant_shard) = tenants.get_mut(&tid) {
5661 : // If the node being filled is not a secondary anymore,
5662 : // skip the promotion.
5663 0 : if !tenant_shard.intent.get_secondary().contains(&node_id) {
5664 0 : continue;
5665 0 : }
5666 0 :
5667 0 : let previously_attached_to = *tenant_shard.intent.get_attached();
5668 0 : match tenant_shard.reschedule_to_secondary(Some(node_id), scheduler) {
5669 0 : Err(e) => {
5670 0 : tracing::warn!(
5671 0 : tenant_id=%tid.tenant_id, shard_id=%tid.shard_slug(),
5672 0 : "Scheduling error when filling pageserver {} : {e}", node_id
5673 : );
5674 : }
5675 : Ok(()) => {
5676 0 : tracing::info!(
5677 0 : tenant_id=%tid.tenant_id, shard_id=%tid.shard_slug(),
5678 0 : "Rescheduled shard while filling node {}: {:?} -> {}",
5679 : node_id,
5680 : previously_attached_to,
5681 : node_id
5682 : );
5683 :
5684 0 : if let Some(waiter) =
5685 0 : self.maybe_reconcile_shard(tenant_shard, nodes)
5686 0 : {
5687 0 : waiters.push(waiter);
5688 0 : }
5689 : }
5690 : }
5691 0 : }
5692 : } else {
5693 0 : break;
5694 : }
5695 : }
5696 : }
5697 :
5698 0 : waiters = self
5699 0 : .await_waiters_remainder(waiters, SHORT_RECONCILE_TIMEOUT)
5700 0 : .await;
5701 : }
5702 :
5703 0 : while !waiters.is_empty() {
5704 0 : if cancel.is_cancelled() {
5705 0 : match self
5706 0 : .node_configure(node_id, None, Some(NodeSchedulingPolicy::Active))
5707 0 : .await
5708 : {
5709 0 : Ok(()) => return Err(OperationError::Cancelled),
5710 0 : Err(err) => {
5711 0 : return Err(OperationError::FinalizeError(
5712 0 : format!(
5713 0 : "Failed to finalise drain cancel of {} by setting scheduling policy to Active: {}",
5714 0 : node_id, err
5715 0 : )
5716 0 : .into(),
5717 0 : ));
5718 : }
5719 : }
5720 0 : }
5721 0 :
5722 0 : tracing::info!("Awaiting {} pending fill reconciliations", waiters.len());
5723 :
5724 0 : waiters = self
5725 0 : .await_waiters_remainder(waiters, SHORT_RECONCILE_TIMEOUT)
5726 0 : .await;
5727 : }
5728 :
5729 0 : if let Err(err) = self
5730 0 : .node_configure(node_id, None, Some(NodeSchedulingPolicy::Active))
5731 0 : .await
5732 : {
5733 : // This isn't a huge issue since the filling process starts upon request. However, it
5734 : // will prevent the next drain from starting. The only case in which this can fail
5735 : // is database unavailability. Such a case will require manual intervention.
5736 0 : return Err(OperationError::FinalizeError(
5737 0 : format!("Failed to finalise fill of {node_id} by setting scheduling policy to Active: {err}")
5738 0 : .into(),
5739 0 : ));
5740 0 : }
5741 0 :
5742 0 : Ok(())
5743 0 : }
5744 : }
|
