Line data Source code
1 : pub mod chaos_injector;
2 : mod context_iterator;
3 : pub(crate) mod safekeeper_reconciler;
4 : mod safekeeper_service;
5 :
6 : use std::borrow::Cow;
7 : use std::cmp::Ordering;
8 : use std::collections::{BTreeMap, HashMap, HashSet};
9 : use std::error::Error;
10 : use std::num::NonZeroU32;
11 : use std::ops::{Deref, DerefMut};
12 : use std::path::PathBuf;
13 : use std::str::FromStr;
14 : use std::sync::Arc;
15 : use std::time::{Duration, Instant};
16 :
17 : use anyhow::Context;
18 : use context_iterator::TenantShardContextIterator;
19 : use control_plane::storage_controller::{
20 : AttachHookRequest, AttachHookResponse, InspectRequest, InspectResponse,
21 : };
22 : use diesel::result::DatabaseErrorKind;
23 : use futures::StreamExt;
24 : use futures::stream::FuturesUnordered;
25 : use http_utils::error::ApiError;
26 : use hyper::Uri;
27 : use itertools::Itertools;
28 : use pageserver_api::controller_api::{
29 : AvailabilityZone, MetadataHealthRecord, MetadataHealthUpdateRequest, NodeAvailability,
30 : NodeRegisterRequest, NodeSchedulingPolicy, NodeShard, NodeShardResponse, PlacementPolicy,
31 : ShardSchedulingPolicy, ShardsPreferredAzsRequest, ShardsPreferredAzsResponse,
32 : TenantCreateRequest, TenantCreateResponse, TenantCreateResponseShard, TenantDescribeResponse,
33 : TenantDescribeResponseShard, TenantLocateResponse, TenantPolicyRequest,
34 : TenantShardMigrateRequest, TenantShardMigrateResponse,
35 : };
36 : use pageserver_api::models::{
37 : self, DetachBehavior, LocationConfig, LocationConfigListResponse, LocationConfigMode,
38 : PageserverUtilization, SecondaryProgress, ShardParameters, TenantConfig,
39 : TenantConfigPatchRequest, TenantConfigRequest, TenantLocationConfigRequest,
40 : TenantLocationConfigResponse, TenantShardLocation, TenantShardSplitRequest,
41 : TenantShardSplitResponse, TenantSorting, TenantTimeTravelRequest,
42 : TimelineArchivalConfigRequest, TimelineCreateRequest, TimelineCreateResponseStorcon,
43 : TimelineInfo, TopTenantShardItem, TopTenantShardsRequest,
44 : };
45 : use pageserver_api::shard::{
46 : ShardCount, ShardIdentity, ShardNumber, ShardStripeSize, TenantShardId,
47 : };
48 : use pageserver_api::upcall_api::{
49 : ReAttachRequest, ReAttachResponse, ReAttachResponseTenant, ValidateRequest, ValidateResponse,
50 : ValidateResponseTenant,
51 : };
52 : use pageserver_client::{BlockUnblock, mgmt_api};
53 : use reqwest::{Certificate, StatusCode};
54 : use safekeeper_api::models::SafekeeperUtilization;
55 : use safekeeper_reconciler::SafekeeperReconcilers;
56 : use tokio::sync::TryAcquireError;
57 : use tokio::sync::mpsc::error::TrySendError;
58 : use tokio_util::sync::CancellationToken;
59 : use tracing::{Instrument, debug, error, info, info_span, instrument, warn};
60 : use utils::completion::Barrier;
61 : use utils::generation::Generation;
62 : use utils::id::{NodeId, TenantId, TimelineId};
63 : use utils::sync::gate::Gate;
64 : use utils::{failpoint_support, pausable_failpoint};
65 :
66 : use crate::background_node_operations::{
67 : Drain, Fill, MAX_RECONCILES_PER_OPERATION, Operation, OperationError, OperationHandler,
68 : };
69 : use crate::compute_hook::{self, ComputeHook, NotifyError};
70 : use crate::drain_utils::{self, TenantShardDrain, TenantShardIterator};
71 : use crate::heartbeater::{Heartbeater, PageserverState, SafekeeperState};
72 : use crate::id_lock_map::{
73 : IdLockMap, TracingExclusiveGuard, trace_exclusive_lock, trace_shared_lock,
74 : };
75 : use crate::leadership::Leadership;
76 : use crate::metrics;
77 : use crate::node::{AvailabilityTransition, Node};
78 : use crate::pageserver_client::PageserverClient;
79 : use crate::peer_client::GlobalObservedState;
80 : use crate::persistence::split_state::SplitState;
81 : use crate::persistence::{
82 : AbortShardSplitStatus, ControllerPersistence, DatabaseError, DatabaseResult,
83 : MetadataHealthPersistence, Persistence, ShardGenerationState, TenantFilter,
84 : TenantShardPersistence,
85 : };
86 : use crate::reconciler::{
87 : ReconcileError, ReconcileUnits, ReconcilerConfig, ReconcilerConfigBuilder, ReconcilerPriority,
88 : attached_location_conf,
89 : };
90 : use crate::safekeeper::Safekeeper;
91 : use crate::scheduler::{
92 : AttachedShardTag, MaySchedule, ScheduleContext, ScheduleError, ScheduleMode, Scheduler,
93 : };
94 : use crate::tenant_shard::{
95 : IntentState, MigrateAttachment, ObservedState, ObservedStateDelta, ObservedStateLocation,
96 : ReconcileNeeded, ReconcileResult, ReconcileWaitError, ReconcilerStatus, ReconcilerWaiter,
97 : ScheduleOptimization, ScheduleOptimizationAction, TenantShard,
98 : };
99 :
100 : const WAITER_FILL_DRAIN_POLL_TIMEOUT: Duration = Duration::from_millis(500);
101 :
102 : // For operations that should be quick, like attaching a new tenant
103 : const SHORT_RECONCILE_TIMEOUT: Duration = Duration::from_secs(5);
104 :
105 : // For operations that might be slow, like migrating a tenant with
106 : // some data in it.
107 : pub const RECONCILE_TIMEOUT: Duration = Duration::from_secs(30);
108 :
109 : // If we receive a call using Secondary mode initially, it will omit generation. We will initialize
110 : // tenant shards into this generation, and as long as it remains in this generation, we will accept
111 : // input generation from future requests as authoritative.
112 : const INITIAL_GENERATION: Generation = Generation::new(0);
113 :
114 : /// How long [`Service::startup_reconcile`] is allowed to take before it should give
115 : /// up on unresponsive pageservers and proceed.
116 : pub(crate) const STARTUP_RECONCILE_TIMEOUT: Duration = Duration::from_secs(30);
117 :
118 : /// How long a node may be unresponsive to heartbeats before we declare it offline.
119 : /// This must be long enough to cover node restarts as well as normal operations: in future
120 : pub const MAX_OFFLINE_INTERVAL_DEFAULT: Duration = Duration::from_secs(30);
121 :
122 : /// How long a node may be unresponsive to heartbeats during start up before we declare it
123 : /// offline.
124 : ///
125 : /// This is much more lenient than [`MAX_OFFLINE_INTERVAL_DEFAULT`] since the pageserver's
126 : /// handling of the re-attach response may take a long time and blocks heartbeats from
127 : /// being handled on the pageserver side.
128 : pub const MAX_WARMING_UP_INTERVAL_DEFAULT: Duration = Duration::from_secs(300);
129 :
130 : /// How often to send heartbeats to registered nodes?
131 : pub const HEARTBEAT_INTERVAL_DEFAULT: Duration = Duration::from_secs(5);
132 :
133 : /// How long is too long for a reconciliation?
134 : pub const LONG_RECONCILE_THRESHOLD_DEFAULT: Duration = Duration::from_secs(120);
135 :
136 : #[derive(Clone, strum_macros::Display)]
137 : enum TenantOperations {
138 : Create,
139 : LocationConfig,
140 : ConfigSet,
141 : ConfigPatch,
142 : TimeTravelRemoteStorage,
143 : Delete,
144 : UpdatePolicy,
145 : ShardSplit,
146 : SecondaryDownload,
147 : TimelineCreate,
148 : TimelineDelete,
149 : AttachHook,
150 : TimelineArchivalConfig,
151 : TimelineDetachAncestor,
152 : TimelineGcBlockUnblock,
153 : DropDetached,
154 : DownloadHeatmapLayers,
155 : }
156 :
157 : #[derive(Clone, strum_macros::Display)]
158 : enum NodeOperations {
159 : Register,
160 : Configure,
161 : Delete,
162 : }
163 :
164 : /// The leadership status for the storage controller process.
165 : /// Allowed transitions are:
166 : /// 1. Leader -> SteppedDown
167 : /// 2. Candidate -> Leader
168 : #[derive(
169 : Eq,
170 : PartialEq,
171 : Copy,
172 : Clone,
173 : strum_macros::Display,
174 0 : strum_macros::EnumIter,
175 : measured::FixedCardinalityLabel,
176 : )]
177 : #[strum(serialize_all = "snake_case")]
178 : pub(crate) enum LeadershipStatus {
179 : /// This is the steady state where the storage controller can produce
180 : /// side effects in the cluster.
181 : Leader,
182 : /// We've been notified to step down by another candidate. No reconciliations
183 : /// take place in this state.
184 : SteppedDown,
185 : /// Initial state for a new storage controller instance. Will attempt to assume leadership.
186 : #[allow(unused)]
187 : Candidate,
188 : }
189 :
190 : pub const RECONCILER_CONCURRENCY_DEFAULT: usize = 128;
191 : pub const PRIORITY_RECONCILER_CONCURRENCY_DEFAULT: usize = 256;
192 :
193 : // Depth of the channel used to enqueue shards for reconciliation when they can't do it immediately.
194 : // This channel is finite-size to avoid using excessive memory if we get into a state where reconciles are finishing more slowly
195 : // than they're being pushed onto the queue.
196 : const MAX_DELAYED_RECONCILES: usize = 10000;
197 :
198 : // Top level state available to all HTTP handlers
199 : struct ServiceState {
200 : leadership_status: LeadershipStatus,
201 :
202 : tenants: BTreeMap<TenantShardId, TenantShard>,
203 :
204 : nodes: Arc<HashMap<NodeId, Node>>,
205 :
206 : safekeepers: Arc<HashMap<NodeId, Safekeeper>>,
207 :
208 : safekeeper_reconcilers: SafekeeperReconcilers,
209 :
210 : scheduler: Scheduler,
211 :
212 : /// Ongoing background operation on the cluster if any is running.
213 : /// Note that only one such operation may run at any given time,
214 : /// hence the type choice.
215 : ongoing_operation: Option<OperationHandler>,
216 :
217 : /// Queue of tenants who are waiting for concurrency limits to permit them to reconcile
218 : delayed_reconcile_rx: tokio::sync::mpsc::Receiver<TenantShardId>,
219 : }
220 :
221 : /// Transform an error from a pageserver into an error to return to callers of a storage
222 : /// controller API.
223 0 : fn passthrough_api_error(node: &Node, e: mgmt_api::Error) -> ApiError {
224 0 : match e {
225 0 : mgmt_api::Error::SendRequest(e) => {
226 0 : // Presume errors sending requests are connectivity/availability issues
227 0 : ApiError::ResourceUnavailable(format!("{node} error sending request: {e}").into())
228 : }
229 0 : mgmt_api::Error::ReceiveErrorBody(str) => {
230 0 : // Presume errors receiving body are connectivity/availability issues
231 0 : ApiError::ResourceUnavailable(
232 0 : format!("{node} error receiving error body: {str}").into(),
233 0 : )
234 : }
235 0 : mgmt_api::Error::ReceiveBody(err) if err.is_decode() => {
236 0 : // Return 500 for decoding errors.
237 0 : ApiError::InternalServerError(anyhow::Error::from(err).context("error decoding body"))
238 : }
239 0 : mgmt_api::Error::ReceiveBody(err) => {
240 0 : // Presume errors receiving body are connectivity/availability issues except for decoding errors
241 0 : let src_str = err.source().map(|e| e.to_string()).unwrap_or_default();
242 0 : ApiError::ResourceUnavailable(
243 0 : format!("{node} error receiving error body: {err} {}", src_str).into(),
244 0 : )
245 : }
246 0 : mgmt_api::Error::ApiError(StatusCode::NOT_FOUND, msg) => {
247 0 : ApiError::NotFound(anyhow::anyhow!(format!("{node}: {msg}")).into())
248 : }
249 0 : mgmt_api::Error::ApiError(StatusCode::SERVICE_UNAVAILABLE, msg) => {
250 0 : ApiError::ResourceUnavailable(format!("{node}: {msg}").into())
251 : }
252 0 : mgmt_api::Error::ApiError(status @ StatusCode::UNAUTHORIZED, msg)
253 0 : | mgmt_api::Error::ApiError(status @ StatusCode::FORBIDDEN, msg) => {
254 : // Auth errors talking to a pageserver are not auth errors for the caller: they are
255 : // internal server errors, showing that something is wrong with the pageserver or
256 : // storage controller's auth configuration.
257 0 : ApiError::InternalServerError(anyhow::anyhow!("{node} {status}: {msg}"))
258 : }
259 0 : mgmt_api::Error::ApiError(status @ StatusCode::TOO_MANY_REQUESTS, msg) => {
260 0 : // Pass through 429 errors: if pageserver is asking us to wait + retry, we in
261 0 : // turn ask our clients to wait + retry
262 0 : ApiError::Conflict(format!("{node} {status}: {status} {msg}"))
263 : }
264 0 : mgmt_api::Error::ApiError(status, msg) => {
265 0 : // Presume general case of pageserver API errors is that we tried to do something
266 0 : // that can't be done right now.
267 0 : ApiError::Conflict(format!("{node} {status}: {status} {msg}"))
268 : }
269 0 : mgmt_api::Error::Cancelled => ApiError::ShuttingDown,
270 0 : mgmt_api::Error::Timeout(e) => ApiError::Timeout(e.into()),
271 : }
272 0 : }
273 :
274 : impl ServiceState {
275 0 : fn new(
276 0 : nodes: HashMap<NodeId, Node>,
277 0 : safekeepers: HashMap<NodeId, Safekeeper>,
278 0 : tenants: BTreeMap<TenantShardId, TenantShard>,
279 0 : scheduler: Scheduler,
280 0 : delayed_reconcile_rx: tokio::sync::mpsc::Receiver<TenantShardId>,
281 0 : initial_leadership_status: LeadershipStatus,
282 0 : reconcilers_cancel: CancellationToken,
283 0 : ) -> Self {
284 0 : metrics::update_leadership_status(initial_leadership_status);
285 0 :
286 0 : Self {
287 0 : leadership_status: initial_leadership_status,
288 0 : tenants,
289 0 : nodes: Arc::new(nodes),
290 0 : safekeepers: Arc::new(safekeepers),
291 0 : safekeeper_reconcilers: SafekeeperReconcilers::new(reconcilers_cancel),
292 0 : scheduler,
293 0 : ongoing_operation: None,
294 0 : delayed_reconcile_rx,
295 0 : }
296 0 : }
297 :
298 0 : fn parts_mut(
299 0 : &mut self,
300 0 : ) -> (
301 0 : &mut Arc<HashMap<NodeId, Node>>,
302 0 : &mut BTreeMap<TenantShardId, TenantShard>,
303 0 : &mut Scheduler,
304 0 : ) {
305 0 : (&mut self.nodes, &mut self.tenants, &mut self.scheduler)
306 0 : }
307 :
308 : #[allow(clippy::type_complexity)]
309 0 : fn parts_mut_sk(
310 0 : &mut self,
311 0 : ) -> (
312 0 : &mut Arc<HashMap<NodeId, Node>>,
313 0 : &mut Arc<HashMap<NodeId, Safekeeper>>,
314 0 : &mut BTreeMap<TenantShardId, TenantShard>,
315 0 : &mut Scheduler,
316 0 : ) {
317 0 : (
318 0 : &mut self.nodes,
319 0 : &mut self.safekeepers,
320 0 : &mut self.tenants,
321 0 : &mut self.scheduler,
322 0 : )
323 0 : }
324 :
325 0 : fn get_leadership_status(&self) -> LeadershipStatus {
326 0 : self.leadership_status
327 0 : }
328 :
329 0 : fn step_down(&mut self) {
330 0 : self.leadership_status = LeadershipStatus::SteppedDown;
331 0 : metrics::update_leadership_status(self.leadership_status);
332 0 : }
333 :
334 0 : fn become_leader(&mut self) {
335 0 : self.leadership_status = LeadershipStatus::Leader;
336 0 : metrics::update_leadership_status(self.leadership_status);
337 0 : }
338 : }
339 :
340 : #[derive(Clone)]
341 : pub struct Config {
342 : // All pageservers managed by one instance of this service must have
343 : // the same public key. This JWT token will be used to authenticate
344 : // this service to the pageservers it manages.
345 : pub pageserver_jwt_token: Option<String>,
346 :
347 : // All safekeepers managed by one instance of this service must have
348 : // the same public key. This JWT token will be used to authenticate
349 : // this service to the safekeepers it manages.
350 : pub safekeeper_jwt_token: Option<String>,
351 :
352 : // This JWT token will be used to authenticate this service to the control plane.
353 : pub control_plane_jwt_token: Option<String>,
354 :
355 : // This JWT token will be used to authenticate with other storage controller instances
356 : pub peer_jwt_token: Option<String>,
357 :
358 : /// Where the compute hook should send notifications of pageserver attachment locations
359 : /// (this URL points to the control plane in prod). If this is None, the compute hook will
360 : /// assume it is running in a test environment and try to update neon_local.
361 : pub compute_hook_url: Option<String>,
362 :
363 : /// Prefix for storage API endpoints of the control plane. We use this prefix to compute
364 : /// URLs that we use to send pageserver and safekeeper attachment locations.
365 : /// If this is None, the compute hook will assume it is running in a test environment
366 : /// and try to invoke neon_local instead.
367 : ///
368 : /// For now, there is also `compute_hook_url` which allows configuration of the pageserver
369 : /// specific endpoint, but it is in the process of being phased out.
370 : pub control_plane_url: Option<String>,
371 :
372 : /// Grace period within which a pageserver does not respond to heartbeats, but is still
373 : /// considered active. Once the grace period elapses, the next heartbeat failure will
374 : /// mark the pagseserver offline.
375 : pub max_offline_interval: Duration,
376 :
377 : /// Extended grace period within which pageserver may not respond to heartbeats.
378 : /// This extended grace period kicks in after the node has been drained for restart
379 : /// and/or upon handling the re-attach request from a node.
380 : pub max_warming_up_interval: Duration,
381 :
382 : /// How many normal-priority Reconcilers may be spawned concurrently
383 : pub reconciler_concurrency: usize,
384 :
385 : /// How many high-priority Reconcilers may be spawned concurrently
386 : pub priority_reconciler_concurrency: usize,
387 :
388 : /// How many API requests per second to allow per tenant, across all
389 : /// tenant-scoped API endpoints. Further API requests queue until ready.
390 : pub tenant_rate_limit: NonZeroU32,
391 :
392 : /// If a tenant shard's largest timeline (max_logical_size) exceeds this value, all tenant
393 : /// shards will be split in 2 until they fall below split_threshold (up to max_split_shards).
394 : ///
395 : /// This will greedily split into as many shards as necessary to fall below split_threshold, as
396 : /// powers of 2: if a tenant shard is 7 times larger than split_threshold, it will split into 8
397 : /// immediately, rather than first 2 then 4 then 8.
398 : ///
399 : /// None or 0 disables auto-splitting.
400 : ///
401 : /// TODO: consider using total logical size of all timelines instead.
402 : pub split_threshold: Option<u64>,
403 :
404 : /// The maximum number of shards a tenant can be split into during autosplits. Does not affect
405 : /// manual split requests. 0 or 1 disables autosplits, as we already have 1 shard.
406 : pub max_split_shards: u8,
407 :
408 : /// The size at which an unsharded tenant should initially split. Ingestion is significantly
409 : /// faster with multiple shards, so eagerly splitting below split_threshold will typically speed
410 : /// up initial ingestion of large tenants.
411 : ///
412 : /// This should be below split_threshold, but it is not required. If both split_threshold and
413 : /// initial_split_threshold qualify, the largest number of target shards will be used.
414 : ///
415 : /// Does not apply to already sharded tenants: changing initial_split_threshold or
416 : /// initial_split_shards is not retroactive for already-sharded tenants.
417 : ///
418 : /// None or 0 disables initial splits.
419 : pub initial_split_threshold: Option<u64>,
420 :
421 : /// The number of shards to split into when reaching initial_split_threshold. Will
422 : /// be clamped to max_split_shards.
423 : ///
424 : /// 0 or 1 disables initial splits. Has no effect if initial_split_threshold is disabled.
425 : pub initial_split_shards: u8,
426 :
427 : // TODO: make this cfg(feature = "testing")
428 : pub neon_local_repo_dir: Option<PathBuf>,
429 :
430 : // Maximum acceptable download lag for the secondary location
431 : // while draining a node. If the secondary location is lagging
432 : // by more than the configured amount, then the secondary is not
433 : // upgraded to primary.
434 : pub max_secondary_lag_bytes: Option<u64>,
435 :
436 : pub heartbeat_interval: Duration,
437 :
438 : pub address_for_peers: Option<Uri>,
439 :
440 : pub start_as_candidate: bool,
441 :
442 : pub long_reconcile_threshold: Duration,
443 :
444 : pub use_https_pageserver_api: bool,
445 :
446 : pub use_https_safekeeper_api: bool,
447 :
448 : pub ssl_ca_cert: Option<Certificate>,
449 :
450 : pub timelines_onto_safekeepers: bool,
451 : }
452 :
453 : impl From<DatabaseError> for ApiError {
454 0 : fn from(err: DatabaseError) -> ApiError {
455 0 : match err {
456 0 : DatabaseError::Query(e) => ApiError::InternalServerError(e.into()),
457 : // FIXME: ApiError doesn't have an Unavailable variant, but ShuttingDown maps to 503.
458 : DatabaseError::Connection(_) | DatabaseError::ConnectionPool(_) => {
459 0 : ApiError::ShuttingDown
460 : }
461 0 : DatabaseError::Logical(reason) | DatabaseError::Migration(reason) => {
462 0 : ApiError::InternalServerError(anyhow::anyhow!(reason))
463 : }
464 : }
465 0 : }
466 : }
467 :
468 : enum InitialShardScheduleOutcome {
469 : Scheduled(TenantCreateResponseShard),
470 : NotScheduled,
471 : ShardScheduleError(ScheduleError),
472 : }
473 :
474 : pub struct Service {
475 : inner: Arc<std::sync::RwLock<ServiceState>>,
476 : config: Config,
477 : persistence: Arc<Persistence>,
478 : compute_hook: Arc<ComputeHook>,
479 : result_tx: tokio::sync::mpsc::UnboundedSender<ReconcileResultRequest>,
480 :
481 : heartbeater_ps: Heartbeater<Node, PageserverState>,
482 : heartbeater_sk: Heartbeater<Safekeeper, SafekeeperState>,
483 :
484 : // Channel for background cleanup from failed operations that require cleanup, such as shard split
485 : abort_tx: tokio::sync::mpsc::UnboundedSender<TenantShardSplitAbort>,
486 :
487 : // Locking on a tenant granularity (covers all shards in the tenant):
488 : // - Take exclusively for rare operations that mutate the tenant's persistent state (e.g. create/delete/split)
489 : // - Take in shared mode for operations that need the set of shards to stay the same to complete reliably (e.g. timeline CRUD)
490 : tenant_op_locks: IdLockMap<TenantId, TenantOperations>,
491 :
492 : // Locking for node-mutating operations: take exclusively for operations that modify the node's persistent state, or
493 : // that transition it to/from Active.
494 : node_op_locks: IdLockMap<NodeId, NodeOperations>,
495 :
496 : // Limit how many Reconcilers we will spawn concurrently for normal-priority tasks such as background reconciliations
497 : // and reconciliation on startup.
498 : reconciler_concurrency: Arc<tokio::sync::Semaphore>,
499 :
500 : // Limit how many Reconcilers we will spawn concurrently for high-priority tasks such as tenant/timeline CRUD, which
501 : // a human user might be waiting for.
502 : priority_reconciler_concurrency: Arc<tokio::sync::Semaphore>,
503 :
504 : /// Queue of tenants who are waiting for concurrency limits to permit them to reconcile
505 : /// Send into this queue to promptly attempt to reconcile this shard next time units are available.
506 : ///
507 : /// Note that this state logically lives inside ServiceState, but carrying Sender here makes the code simpler
508 : /// by avoiding needing a &mut ref to something inside the ServiceState. This could be optimized to
509 : /// use a VecDeque instead of a channel to reduce synchronization overhead, at the cost of some code complexity.
510 : delayed_reconcile_tx: tokio::sync::mpsc::Sender<TenantShardId>,
511 :
512 : // Process shutdown will fire this token
513 : cancel: CancellationToken,
514 :
515 : // Child token of [`Service::cancel`] used by reconcilers
516 : reconcilers_cancel: CancellationToken,
517 :
518 : // Background tasks will hold this gate
519 : gate: Gate,
520 :
521 : // Reconcilers background tasks will hold this gate
522 : reconcilers_gate: Gate,
523 :
524 : /// This waits for initial reconciliation with pageservers to complete. Until this barrier
525 : /// passes, it isn't safe to do any actions that mutate tenants.
526 : pub(crate) startup_complete: Barrier,
527 :
528 : /// HTTP client with proper CA certs.
529 : http_client: reqwest::Client,
530 : }
531 :
532 : impl From<ReconcileWaitError> for ApiError {
533 0 : fn from(value: ReconcileWaitError) -> Self {
534 0 : match value {
535 0 : ReconcileWaitError::Shutdown => ApiError::ShuttingDown,
536 0 : e @ ReconcileWaitError::Timeout(_) => ApiError::Timeout(format!("{e}").into()),
537 0 : e @ ReconcileWaitError::Failed(..) => ApiError::InternalServerError(anyhow::anyhow!(e)),
538 : }
539 0 : }
540 : }
541 :
542 : impl From<OperationError> for ApiError {
543 0 : fn from(value: OperationError) -> Self {
544 0 : match value {
545 0 : OperationError::NodeStateChanged(err) | OperationError::FinalizeError(err) => {
546 0 : ApiError::InternalServerError(anyhow::anyhow!(err))
547 : }
548 0 : OperationError::Cancelled => ApiError::Conflict("Operation was cancelled".into()),
549 : }
550 0 : }
551 : }
552 :
553 : #[allow(clippy::large_enum_variant)]
554 : enum TenantCreateOrUpdate {
555 : Create(TenantCreateRequest),
556 : Update(Vec<ShardUpdate>),
557 : }
558 :
559 : struct ShardSplitParams {
560 : old_shard_count: ShardCount,
561 : new_shard_count: ShardCount,
562 : new_stripe_size: Option<ShardStripeSize>,
563 : targets: Vec<ShardSplitTarget>,
564 : policy: PlacementPolicy,
565 : config: TenantConfig,
566 : shard_ident: ShardIdentity,
567 : preferred_az_id: Option<AvailabilityZone>,
568 : }
569 :
570 : // When preparing for a shard split, we may either choose to proceed with the split,
571 : // or find that the work is already done and return NoOp.
572 : enum ShardSplitAction {
573 : Split(Box<ShardSplitParams>),
574 : NoOp(TenantShardSplitResponse),
575 : }
576 :
577 : // A parent shard which will be split
578 : struct ShardSplitTarget {
579 : parent_id: TenantShardId,
580 : node: Node,
581 : child_ids: Vec<TenantShardId>,
582 : }
583 :
584 : /// When we tenant shard split operation fails, we may not be able to clean up immediately, because nodes
585 : /// might not be available. We therefore use a queue of abort operations processed in the background.
586 : struct TenantShardSplitAbort {
587 : tenant_id: TenantId,
588 : /// The target values from the request that failed
589 : new_shard_count: ShardCount,
590 : new_stripe_size: Option<ShardStripeSize>,
591 : /// Until this abort op is complete, no other operations may be done on the tenant
592 : _tenant_lock: TracingExclusiveGuard<TenantOperations>,
593 : }
594 :
595 : #[derive(thiserror::Error, Debug)]
596 : enum TenantShardSplitAbortError {
597 : #[error(transparent)]
598 : Database(#[from] DatabaseError),
599 : #[error(transparent)]
600 : Remote(#[from] mgmt_api::Error),
601 : #[error("Unavailable")]
602 : Unavailable,
603 : }
604 :
605 : /// Inputs for computing a target shard count for a tenant.
606 : struct ShardSplitInputs {
607 : /// Current shard count.
608 : shard_count: ShardCount,
609 : /// Total size of largest timeline summed across all shards.
610 : max_logical_size: u64,
611 : /// Size-based split threshold. Zero if size-based splits are disabled.
612 : split_threshold: u64,
613 : /// Upper bound on target shards. 0 or 1 disables splits.
614 : max_split_shards: u8,
615 : /// Initial split threshold. Zero if initial splits are disabled.
616 : initial_split_threshold: u64,
617 : /// Number of shards for initial splits. 0 or 1 disables initial splits.
618 : initial_split_shards: u8,
619 : }
620 :
621 : struct ShardUpdate {
622 : tenant_shard_id: TenantShardId,
623 : placement_policy: PlacementPolicy,
624 : tenant_config: TenantConfig,
625 :
626 : /// If this is None, generation is not updated.
627 : generation: Option<Generation>,
628 :
629 : /// If this is None, scheduling policy is not updated.
630 : scheduling_policy: Option<ShardSchedulingPolicy>,
631 : }
632 :
633 : enum StopReconciliationsReason {
634 : ShuttingDown,
635 : SteppingDown,
636 : }
637 :
638 : impl std::fmt::Display for StopReconciliationsReason {
639 0 : fn fmt(&self, writer: &mut std::fmt::Formatter) -> std::fmt::Result {
640 0 : let s = match self {
641 0 : Self::ShuttingDown => "Shutting down",
642 0 : Self::SteppingDown => "Stepping down",
643 : };
644 0 : write!(writer, "{}", s)
645 0 : }
646 : }
647 :
648 : pub(crate) enum ReconcileResultRequest {
649 : ReconcileResult(ReconcileResult),
650 : Stop,
651 : }
652 :
653 : #[derive(Clone)]
654 : struct MutationLocation {
655 : node: Node,
656 : generation: Generation,
657 : }
658 :
659 : #[derive(Clone)]
660 : struct ShardMutationLocations {
661 : latest: MutationLocation,
662 : other: Vec<MutationLocation>,
663 : }
664 :
665 : #[derive(Default, Clone)]
666 : struct TenantMutationLocations(BTreeMap<TenantShardId, ShardMutationLocations>);
667 :
668 : impl Service {
669 0 : pub fn get_config(&self) -> &Config {
670 0 : &self.config
671 0 : }
672 :
673 0 : pub fn get_http_client(&self) -> &reqwest::Client {
674 0 : &self.http_client
675 0 : }
676 :
677 : /// Called once on startup, this function attempts to contact all pageservers to build an up-to-date
678 : /// view of the world, and determine which pageservers are responsive.
679 : #[instrument(skip_all)]
680 : async fn startup_reconcile(
681 : self: &Arc<Service>,
682 : current_leader: Option<ControllerPersistence>,
683 : leader_step_down_state: Option<GlobalObservedState>,
684 : bg_compute_notify_result_tx: tokio::sync::mpsc::Sender<
685 : Result<(), (TenantShardId, NotifyError)>,
686 : >,
687 : ) {
688 : // Startup reconciliation does I/O to other services: whether they
689 : // are responsive or not, we should aim to finish within our deadline, because:
690 : // - If we don't, a k8s readiness hook watching /ready will kill us.
691 : // - While we're waiting for startup reconciliation, we are not fully
692 : // available for end user operations like creating/deleting tenants and timelines.
693 : //
694 : // We set multiple deadlines to break up the time available between the phases of work: this is
695 : // arbitrary, but avoids a situation where the first phase could burn our entire timeout period.
696 : let start_at = Instant::now();
697 : let node_scan_deadline = start_at
698 : .checked_add(STARTUP_RECONCILE_TIMEOUT / 2)
699 : .expect("Reconcile timeout is a modest constant");
700 :
701 : let observed = if let Some(state) = leader_step_down_state {
702 : tracing::info!(
703 : "Using observed state received from leader at {}",
704 : current_leader.as_ref().unwrap().address
705 : );
706 :
707 : state
708 : } else {
709 : self.build_global_observed_state(node_scan_deadline).await
710 : };
711 :
712 : // Accumulate a list of any tenant locations that ought to be detached
713 : let mut cleanup = Vec::new();
714 :
715 : // Send initial heartbeat requests to all nodes loaded from the database
716 : let all_nodes = {
717 : let locked = self.inner.read().unwrap();
718 : locked.nodes.clone()
719 : };
720 : let (mut nodes_online, mut sks_online) =
721 : self.initial_heartbeat_round(all_nodes.keys()).await;
722 :
723 : // List of tenants for which we will attempt to notify compute of their location at startup
724 : let mut compute_notifications = Vec::new();
725 :
726 : // Populate intent and observed states for all tenants, based on reported state on pageservers
727 : tracing::info!("Populating tenant shards' states from initial pageserver scan...");
728 : let shard_count = {
729 : let mut locked = self.inner.write().unwrap();
730 : let (nodes, safekeepers, tenants, scheduler) = locked.parts_mut_sk();
731 :
732 : // Mark nodes online if they responded to us: nodes are offline by default after a restart.
733 : let mut new_nodes = (**nodes).clone();
734 : for (node_id, node) in new_nodes.iter_mut() {
735 : if let Some(utilization) = nodes_online.remove(node_id) {
736 : node.set_availability(NodeAvailability::Active(utilization));
737 : scheduler.node_upsert(node);
738 : }
739 : }
740 : *nodes = Arc::new(new_nodes);
741 :
742 : let mut new_sks = (**safekeepers).clone();
743 : for (node_id, node) in new_sks.iter_mut() {
744 : if let Some((utilization, last_seen_at)) = sks_online.remove(node_id) {
745 : node.set_availability(SafekeeperState::Available {
746 : utilization,
747 : last_seen_at,
748 : });
749 : }
750 : }
751 : *safekeepers = Arc::new(new_sks);
752 :
753 : for (tenant_shard_id, observed_state) in observed.0 {
754 : let Some(tenant_shard) = tenants.get_mut(&tenant_shard_id) else {
755 : for node_id in observed_state.locations.keys() {
756 : cleanup.push((tenant_shard_id, *node_id));
757 : }
758 :
759 : continue;
760 : };
761 :
762 : tenant_shard.observed = observed_state;
763 : }
764 :
765 : // Populate each tenant's intent state
766 : let mut schedule_context = ScheduleContext::default();
767 : for (tenant_shard_id, tenant_shard) in tenants.iter_mut() {
768 : if tenant_shard_id.shard_number == ShardNumber(0) {
769 : // Reset scheduling context each time we advance to the next Tenant
770 : schedule_context = ScheduleContext::default();
771 : }
772 :
773 : tenant_shard.intent_from_observed(scheduler);
774 : if let Err(e) = tenant_shard.schedule(scheduler, &mut schedule_context) {
775 : // Non-fatal error: we are unable to properly schedule the tenant, perhaps because
776 : // not enough pageservers are available. The tenant may well still be available
777 : // to clients.
778 : tracing::error!("Failed to schedule tenant {tenant_shard_id} at startup: {e}");
779 : } else {
780 : // If we're both intending and observed to be attached at a particular node, we will
781 : // emit a compute notification for this. In the case where our observed state does not
782 : // yet match our intent, we will eventually reconcile, and that will emit a compute notification.
783 : if let Some(attached_at) = tenant_shard.stably_attached() {
784 : compute_notifications.push(compute_hook::ShardUpdate {
785 : tenant_shard_id: *tenant_shard_id,
786 : node_id: attached_at,
787 : stripe_size: tenant_shard.shard.stripe_size,
788 : preferred_az: tenant_shard
789 : .preferred_az()
790 0 : .map(|az| Cow::Owned(az.clone())),
791 : });
792 : }
793 : }
794 : }
795 :
796 : tenants.len()
797 : };
798 :
799 : // Before making any obeservable changes to the cluster, persist self
800 : // as leader in database and memory.
801 : let leadership = Leadership::new(
802 : self.persistence.clone(),
803 : self.config.clone(),
804 : self.cancel.child_token(),
805 : );
806 :
807 : if let Err(e) = leadership.become_leader(current_leader).await {
808 : tracing::error!("Failed to persist self as leader: {e}. Aborting start-up ...");
809 : std::process::exit(1);
810 : }
811 :
812 : let safekeepers = self.inner.read().unwrap().safekeepers.clone();
813 : let sk_schedule_requests =
814 : match safekeeper_reconciler::load_schedule_requests(self, &safekeepers).await {
815 : Ok(v) => v,
816 : Err(e) => {
817 : tracing::warn!(
818 : "Failed to load safekeeper pending ops at startup: {e}." // Don't abort for now: " Aborting start-up..."
819 : );
820 : // std::process::exit(1);
821 : Vec::new()
822 : }
823 : };
824 :
825 : {
826 : let mut locked = self.inner.write().unwrap();
827 : locked.become_leader();
828 :
829 : locked
830 : .safekeeper_reconcilers
831 : .schedule_request_vec(self, sk_schedule_requests);
832 : }
833 :
834 : // TODO: if any tenant's intent now differs from its loaded generation_pageserver, we should clear that
835 : // generation_pageserver in the database.
836 :
837 : // Emit compute hook notifications for all tenants which are already stably attached. Other tenants
838 : // will emit compute hook notifications when they reconcile.
839 : //
840 : // Ordering: our calls to notify_background synchronously establish a relative order for these notifications vs. any later
841 : // calls into the ComputeHook for the same tenant: we can leave these to run to completion in the background and any later
842 : // calls will be correctly ordered wrt these.
843 : //
844 : // Concurrency: we call notify_background for all tenants, which will create O(N) tokio tasks, but almost all of them
845 : // will just wait on the ComputeHook::API_CONCURRENCY semaphore immediately, so very cheap until they get that semaphore
846 : // unit and start doing I/O.
847 : tracing::info!(
848 : "Sending {} compute notifications",
849 : compute_notifications.len()
850 : );
851 : self.compute_hook.notify_background(
852 : compute_notifications,
853 : bg_compute_notify_result_tx.clone(),
854 : &self.cancel,
855 : );
856 :
857 : // Finally, now that the service is up and running, launch reconcile operations for any tenants
858 : // which require it: under normal circumstances this should only include tenants that were in some
859 : // transient state before we restarted, or any tenants whose compute hooks failed above.
860 : tracing::info!("Checking for shards in need of reconciliation...");
861 : let reconcile_tasks = self.reconcile_all();
862 : // We will not wait for these reconciliation tasks to run here: we're now done with startup and
863 : // normal operations may proceed.
864 :
865 : // Clean up any tenants that were found on pageservers but are not known to us. Do this in the
866 : // background because it does not need to complete in order to proceed with other work.
867 : if !cleanup.is_empty() {
868 : tracing::info!("Cleaning up {} locations in the background", cleanup.len());
869 : tokio::task::spawn({
870 : let cleanup_self = self.clone();
871 0 : async move { cleanup_self.cleanup_locations(cleanup).await }
872 : });
873 : }
874 :
875 : tracing::info!(
876 : "Startup complete, spawned {reconcile_tasks} reconciliation tasks ({shard_count} shards total)"
877 : );
878 : }
879 :
880 0 : async fn initial_heartbeat_round<'a>(
881 0 : &self,
882 0 : node_ids: impl Iterator<Item = &'a NodeId>,
883 0 : ) -> (
884 0 : HashMap<NodeId, PageserverUtilization>,
885 0 : HashMap<NodeId, (SafekeeperUtilization, Instant)>,
886 0 : ) {
887 0 : assert!(!self.startup_complete.is_ready());
888 :
889 0 : let all_nodes = {
890 0 : let locked = self.inner.read().unwrap();
891 0 : locked.nodes.clone()
892 0 : };
893 0 :
894 0 : let mut nodes_to_heartbeat = HashMap::new();
895 0 : for node_id in node_ids {
896 0 : match all_nodes.get(node_id) {
897 0 : Some(node) => {
898 0 : nodes_to_heartbeat.insert(*node_id, node.clone());
899 0 : }
900 : None => {
901 0 : tracing::warn!("Node {node_id} was removed during start-up");
902 : }
903 : }
904 : }
905 :
906 0 : let all_sks = {
907 0 : let locked = self.inner.read().unwrap();
908 0 : locked.safekeepers.clone()
909 0 : };
910 0 :
911 0 : tracing::info!("Sending initial heartbeats...");
912 0 : let (res_ps, res_sk) = tokio::join!(
913 0 : self.heartbeater_ps.heartbeat(Arc::new(nodes_to_heartbeat)),
914 0 : self.heartbeater_sk.heartbeat(all_sks)
915 0 : );
916 :
917 0 : let mut online_nodes = HashMap::new();
918 0 : if let Ok(deltas) = res_ps {
919 0 : for (node_id, status) in deltas.0 {
920 0 : match status {
921 0 : PageserverState::Available { utilization, .. } => {
922 0 : online_nodes.insert(node_id, utilization);
923 0 : }
924 0 : PageserverState::Offline => {}
925 : PageserverState::WarmingUp { .. } => {
926 0 : unreachable!("Nodes are never marked warming-up during startup reconcile")
927 : }
928 : }
929 : }
930 0 : }
931 :
932 0 : let mut online_sks = HashMap::new();
933 0 : if let Ok(deltas) = res_sk {
934 0 : for (node_id, status) in deltas.0 {
935 0 : match status {
936 : SafekeeperState::Available {
937 0 : utilization,
938 0 : last_seen_at,
939 0 : } => {
940 0 : online_sks.insert(node_id, (utilization, last_seen_at));
941 0 : }
942 0 : SafekeeperState::Offline => {}
943 : }
944 : }
945 0 : }
946 :
947 0 : (online_nodes, online_sks)
948 0 : }
949 :
950 : /// Used during [`Self::startup_reconcile`]: issue GETs to all nodes concurrently, with a deadline.
951 : ///
952 : /// The result includes only nodes which responded within the deadline
953 0 : async fn scan_node_locations(
954 0 : &self,
955 0 : deadline: Instant,
956 0 : ) -> HashMap<NodeId, LocationConfigListResponse> {
957 0 : let nodes = {
958 0 : let locked = self.inner.read().unwrap();
959 0 : locked.nodes.clone()
960 0 : };
961 0 :
962 0 : let mut node_results = HashMap::new();
963 0 :
964 0 : let mut node_list_futs = FuturesUnordered::new();
965 0 :
966 0 : tracing::info!("Scanning shards on {} nodes...", nodes.len());
967 0 : for node in nodes.values() {
968 0 : node_list_futs.push({
969 0 : async move {
970 0 : tracing::info!("Scanning shards on node {node}...");
971 0 : let timeout = Duration::from_secs(5);
972 0 : let response = node
973 0 : .with_client_retries(
974 0 : |client| async move { client.list_location_config().await },
975 0 : &self.http_client,
976 0 : &self.config.pageserver_jwt_token,
977 0 : 1,
978 0 : 5,
979 0 : timeout,
980 0 : &self.cancel,
981 0 : )
982 0 : .await;
983 0 : (node.get_id(), response)
984 0 : }
985 0 : });
986 0 : }
987 :
988 : loop {
989 0 : let (node_id, result) = tokio::select! {
990 0 : next = node_list_futs.next() => {
991 0 : match next {
992 0 : Some(result) => result,
993 : None =>{
994 : // We got results for all our nodes
995 0 : break;
996 : }
997 :
998 : }
999 : },
1000 0 : _ = tokio::time::sleep(deadline.duration_since(Instant::now())) => {
1001 : // Give up waiting for anyone who hasn't responded: we will yield the results that we have
1002 0 : tracing::info!("Reached deadline while waiting for nodes to respond to location listing requests");
1003 0 : break;
1004 : }
1005 : };
1006 :
1007 0 : let Some(list_response) = result else {
1008 0 : tracing::info!("Shutdown during startup_reconcile");
1009 0 : break;
1010 : };
1011 :
1012 0 : match list_response {
1013 0 : Err(e) => {
1014 0 : tracing::warn!("Could not scan node {} ({e})", node_id);
1015 : }
1016 0 : Ok(listing) => {
1017 0 : node_results.insert(node_id, listing);
1018 0 : }
1019 : }
1020 : }
1021 :
1022 0 : node_results
1023 0 : }
1024 :
1025 0 : async fn build_global_observed_state(&self, deadline: Instant) -> GlobalObservedState {
1026 0 : let node_listings = self.scan_node_locations(deadline).await;
1027 0 : let mut observed = GlobalObservedState::default();
1028 :
1029 0 : for (node_id, location_confs) in node_listings {
1030 0 : tracing::info!(
1031 0 : "Received {} shard statuses from pageserver {}",
1032 0 : location_confs.tenant_shards.len(),
1033 : node_id
1034 : );
1035 :
1036 0 : for (tid, location_conf) in location_confs.tenant_shards {
1037 0 : let entry = observed.0.entry(tid).or_default();
1038 0 : entry.locations.insert(
1039 0 : node_id,
1040 0 : ObservedStateLocation {
1041 0 : conf: location_conf,
1042 0 : },
1043 0 : );
1044 0 : }
1045 : }
1046 :
1047 0 : observed
1048 0 : }
1049 :
1050 : /// Used during [`Self::startup_reconcile`]: detach a list of unknown-to-us tenants from pageservers.
1051 : ///
1052 : /// This is safe to run in the background, because if we don't have this TenantShardId in our map of
1053 : /// tenants, then it is probably something incompletely deleted before: we will not fight with any
1054 : /// other task trying to attach it.
1055 : #[instrument(skip_all)]
1056 : async fn cleanup_locations(&self, cleanup: Vec<(TenantShardId, NodeId)>) {
1057 : let nodes = self.inner.read().unwrap().nodes.clone();
1058 :
1059 : for (tenant_shard_id, node_id) in cleanup {
1060 : // A node reported a tenant_shard_id which is unknown to us: detach it.
1061 : let Some(node) = nodes.get(&node_id) else {
1062 : // This is legitimate; we run in the background and [`Self::startup_reconcile`] might have identified
1063 : // a location to clean up on a node that has since been removed.
1064 : tracing::info!(
1065 : "Not cleaning up location {node_id}/{tenant_shard_id}: node not found"
1066 : );
1067 : continue;
1068 : };
1069 :
1070 : if self.cancel.is_cancelled() {
1071 : break;
1072 : }
1073 :
1074 : let client = PageserverClient::new(
1075 : node.get_id(),
1076 : self.http_client.clone(),
1077 : node.base_url(),
1078 : self.config.pageserver_jwt_token.as_deref(),
1079 : );
1080 : match client
1081 : .location_config(
1082 : tenant_shard_id,
1083 : LocationConfig {
1084 : mode: LocationConfigMode::Detached,
1085 : generation: None,
1086 : secondary_conf: None,
1087 : shard_number: tenant_shard_id.shard_number.0,
1088 : shard_count: tenant_shard_id.shard_count.literal(),
1089 : shard_stripe_size: 0,
1090 : tenant_conf: models::TenantConfig::default(),
1091 : },
1092 : None,
1093 : false,
1094 : )
1095 : .await
1096 : {
1097 : Ok(()) => {
1098 : tracing::info!(
1099 : "Detached unknown shard {tenant_shard_id} on pageserver {node_id}"
1100 : );
1101 : }
1102 : Err(e) => {
1103 : // Non-fatal error: leaving a tenant shard behind that we are not managing shouldn't
1104 : // break anything.
1105 : tracing::error!(
1106 : "Failed to detach unknown shard {tenant_shard_id} on pageserver {node_id}: {e}"
1107 : );
1108 : }
1109 : }
1110 : }
1111 : }
1112 :
1113 : /// Long running background task that periodically wakes up and looks for shards that need
1114 : /// reconciliation. Reconciliation is fallible, so any reconciliation tasks that fail during
1115 : /// e.g. a tenant create/attach/migrate must eventually be retried: this task is responsible
1116 : /// for those retries.
1117 : #[instrument(skip_all)]
1118 : async fn background_reconcile(self: &Arc<Self>) {
1119 : self.startup_complete.clone().wait().await;
1120 :
1121 : const BACKGROUND_RECONCILE_PERIOD: Duration = Duration::from_secs(20);
1122 : let mut interval = tokio::time::interval(BACKGROUND_RECONCILE_PERIOD);
1123 : while !self.reconcilers_cancel.is_cancelled() {
1124 : tokio::select! {
1125 : _ = interval.tick() => {
1126 : let reconciles_spawned = self.reconcile_all();
1127 : if reconciles_spawned == 0 {
1128 : // Run optimizer only when we didn't find any other work to do
1129 : self.optimize_all().await;
1130 : }
1131 : // Always attempt autosplits. Sharding is crucial for bulk ingest performance, so we
1132 : // must be responsive when new projects begin ingesting and reach the threshold.
1133 : self.autosplit_tenants().await;
1134 : }
1135 : _ = self.reconcilers_cancel.cancelled() => return
1136 : }
1137 : }
1138 : }
1139 : /// Heartbeat all storage nodes once in a while.
1140 : #[instrument(skip_all)]
1141 : async fn spawn_heartbeat_driver(&self) {
1142 : self.startup_complete.clone().wait().await;
1143 :
1144 : let mut interval = tokio::time::interval(self.config.heartbeat_interval);
1145 : while !self.cancel.is_cancelled() {
1146 : tokio::select! {
1147 : _ = interval.tick() => { }
1148 : _ = self.cancel.cancelled() => return
1149 : };
1150 :
1151 : let nodes = {
1152 : let locked = self.inner.read().unwrap();
1153 : locked.nodes.clone()
1154 : };
1155 :
1156 : let safekeepers = {
1157 : let locked = self.inner.read().unwrap();
1158 : locked.safekeepers.clone()
1159 : };
1160 :
1161 : let (res_ps, res_sk) = tokio::join!(
1162 : self.heartbeater_ps.heartbeat(nodes),
1163 : self.heartbeater_sk.heartbeat(safekeepers)
1164 : );
1165 :
1166 : if let Ok(deltas) = res_ps {
1167 : let mut to_handle = Vec::default();
1168 :
1169 : for (node_id, state) in deltas.0 {
1170 : let new_availability = match state {
1171 : PageserverState::Available { utilization, .. } => {
1172 : NodeAvailability::Active(utilization)
1173 : }
1174 : PageserverState::WarmingUp { started_at } => {
1175 : NodeAvailability::WarmingUp(started_at)
1176 : }
1177 : PageserverState::Offline => {
1178 : // The node might have been placed in the WarmingUp state
1179 : // while the heartbeat round was on-going. Hence, filter out
1180 : // offline transitions for WarmingUp nodes that are still within
1181 : // their grace period.
1182 : if let Ok(NodeAvailability::WarmingUp(started_at)) = self
1183 : .get_node(node_id)
1184 : .await
1185 : .as_ref()
1186 0 : .map(|n| n.get_availability())
1187 : {
1188 : let now = Instant::now();
1189 : if now - *started_at >= self.config.max_warming_up_interval {
1190 : NodeAvailability::Offline
1191 : } else {
1192 : NodeAvailability::WarmingUp(*started_at)
1193 : }
1194 : } else {
1195 : NodeAvailability::Offline
1196 : }
1197 : }
1198 : };
1199 :
1200 : let node_lock = trace_exclusive_lock(
1201 : &self.node_op_locks,
1202 : node_id,
1203 : NodeOperations::Configure,
1204 : )
1205 : .await;
1206 :
1207 : pausable_failpoint!("heartbeat-pre-node-state-configure");
1208 :
1209 : // This is the code path for geniune availability transitions (i.e node
1210 : // goes unavailable and/or comes back online).
1211 : let res = self
1212 : .node_state_configure(node_id, Some(new_availability), None, &node_lock)
1213 : .await;
1214 :
1215 : match res {
1216 : Ok(transition) => {
1217 : // Keep hold of the lock until the availability transitions
1218 : // have been handled in
1219 : // [`Service::handle_node_availability_transitions`] in order avoid
1220 : // racing with [`Service::external_node_configure`].
1221 : to_handle.push((node_id, node_lock, transition));
1222 : }
1223 : Err(ApiError::NotFound(_)) => {
1224 : // This should be rare, but legitimate since the heartbeats are done
1225 : // on a snapshot of the nodes.
1226 : tracing::info!("Node {} was not found after heartbeat round", node_id);
1227 : }
1228 : Err(ApiError::ShuttingDown) => {
1229 : // No-op: we're shutting down, no need to try and update any nodes' statuses
1230 : }
1231 : Err(err) => {
1232 : // Transition to active involves reconciling: if a node responds to a heartbeat then
1233 : // becomes unavailable again, we may get an error here.
1234 : tracing::error!(
1235 : "Failed to update node state {} after heartbeat round: {}",
1236 : node_id,
1237 : err
1238 : );
1239 : }
1240 : }
1241 : }
1242 :
1243 : // We collected all the transitions above and now we handle them.
1244 : let res = self.handle_node_availability_transitions(to_handle).await;
1245 : if let Err(errs) = res {
1246 : for (node_id, err) in errs {
1247 : match err {
1248 : ApiError::NotFound(_) => {
1249 : // This should be rare, but legitimate since the heartbeats are done
1250 : // on a snapshot of the nodes.
1251 : tracing::info!(
1252 : "Node {} was not found after heartbeat round",
1253 : node_id
1254 : );
1255 : }
1256 : err => {
1257 : tracing::error!(
1258 : "Failed to handle availability transition for {} after heartbeat round: {}",
1259 : node_id,
1260 : err
1261 : );
1262 : }
1263 : }
1264 : }
1265 : }
1266 : }
1267 : if let Ok(deltas) = res_sk {
1268 : let mut locked = self.inner.write().unwrap();
1269 : let mut safekeepers = (*locked.safekeepers).clone();
1270 : for (id, state) in deltas.0 {
1271 : let Some(sk) = safekeepers.get_mut(&id) else {
1272 : tracing::info!(
1273 : "Couldn't update safekeeper safekeeper state for id {id} from heartbeat={state:?}"
1274 : );
1275 : continue;
1276 : };
1277 : sk.set_availability(state);
1278 : }
1279 : locked.safekeepers = Arc::new(safekeepers);
1280 : }
1281 : }
1282 : }
1283 :
1284 : /// Apply the contents of a [`ReconcileResult`] to our in-memory state: if the reconciliation
1285 : /// was successful and intent hasn't changed since the Reconciler was spawned, this will update
1286 : /// the observed state of the tenant such that subsequent calls to [`TenantShard::get_reconcile_needed`]
1287 : /// will indicate that reconciliation is not needed.
1288 : #[instrument(skip_all, fields(
1289 : seq=%result.sequence,
1290 : tenant_id=%result.tenant_shard_id.tenant_id,
1291 : shard_id=%result.tenant_shard_id.shard_slug(),
1292 : ))]
1293 : fn process_result(&self, result: ReconcileResult) {
1294 : let mut locked = self.inner.write().unwrap();
1295 : let (nodes, tenants, _scheduler) = locked.parts_mut();
1296 : let Some(tenant) = tenants.get_mut(&result.tenant_shard_id) else {
1297 : // A reconciliation result might race with removing a tenant: drop results for
1298 : // tenants that aren't in our map.
1299 : return;
1300 : };
1301 :
1302 : // Usually generation should only be updated via this path, so the max() isn't
1303 : // needed, but it is used to handle out-of-band updates via. e.g. test hook.
1304 : tenant.generation = std::cmp::max(tenant.generation, result.generation);
1305 :
1306 : // If the reconciler signals that it failed to notify compute, set this state on
1307 : // the shard so that a future [`TenantShard::maybe_reconcile`] will try again.
1308 : tenant.pending_compute_notification = result.pending_compute_notification;
1309 :
1310 : // Let the TenantShard know it is idle.
1311 : tenant.reconcile_complete(result.sequence);
1312 :
1313 : // In case a node was deleted while this reconcile is in flight, filter it out of the update we will
1314 : // make to the tenant
1315 0 : let deltas = result.observed_deltas.into_iter().flat_map(|delta| {
1316 : // In case a node was deleted while this reconcile is in flight, filter it out of the update we will
1317 : // make to the tenant
1318 0 : let node = nodes.get(delta.node_id())?;
1319 :
1320 0 : if node.is_available() {
1321 0 : return Some(delta);
1322 0 : }
1323 0 :
1324 0 : // In case a node became unavailable concurrently with the reconcile, observed
1325 0 : // locations on it are now uncertain. By convention, set them to None in order
1326 0 : // for them to get refreshed when the node comes back online.
1327 0 : Some(ObservedStateDelta::Upsert(Box::new((
1328 0 : node.get_id(),
1329 0 : ObservedStateLocation { conf: None },
1330 0 : ))))
1331 0 : });
1332 :
1333 : match result.result {
1334 : Ok(()) => {
1335 : tenant.apply_observed_deltas(deltas);
1336 : tenant.waiter.advance(result.sequence);
1337 : }
1338 : Err(e) => {
1339 : match e {
1340 : ReconcileError::Cancel => {
1341 : tracing::info!("Reconciler was cancelled");
1342 : }
1343 : ReconcileError::Remote(mgmt_api::Error::Cancelled) => {
1344 : // This might be due to the reconciler getting cancelled, or it might
1345 : // be due to the `Node` being marked offline.
1346 : tracing::info!("Reconciler cancelled during pageserver API call");
1347 : }
1348 : _ => {
1349 : tracing::warn!("Reconcile error: {}", e);
1350 : }
1351 : }
1352 :
1353 : // Ordering: populate last_error before advancing error_seq,
1354 : // so that waiters will see the correct error after waiting.
1355 : tenant.set_last_error(result.sequence, e);
1356 :
1357 : // Skip deletions on reconcile failures
1358 : let upsert_deltas =
1359 0 : deltas.filter(|delta| matches!(delta, ObservedStateDelta::Upsert(_)));
1360 : tenant.apply_observed_deltas(upsert_deltas);
1361 : }
1362 : }
1363 :
1364 : // If we just finished detaching all shards for a tenant, it might be time to drop it from memory.
1365 : if tenant.policy == PlacementPolicy::Detached {
1366 : // We may only drop a tenant from memory while holding the exclusive lock on the tenant ID: this protects us
1367 : // from concurrent execution wrt a request handler that might expect the tenant to remain in memory for the
1368 : // duration of the request.
1369 : let guard = self.tenant_op_locks.try_exclusive(
1370 : tenant.tenant_shard_id.tenant_id,
1371 : TenantOperations::DropDetached,
1372 : );
1373 : if let Some(guard) = guard {
1374 : self.maybe_drop_tenant(tenant.tenant_shard_id.tenant_id, &mut locked, &guard);
1375 : }
1376 : }
1377 :
1378 : // Maybe some other work can proceed now that this job finished.
1379 : //
1380 : // Only bother with this if we have some semaphore units available in the normal-priority semaphore (these
1381 : // reconciles are scheduled at `[ReconcilerPriority::Normal]`).
1382 : if self.reconciler_concurrency.available_permits() > 0 {
1383 : while let Ok(tenant_shard_id) = locked.delayed_reconcile_rx.try_recv() {
1384 : let (nodes, tenants, _scheduler) = locked.parts_mut();
1385 : if let Some(shard) = tenants.get_mut(&tenant_shard_id) {
1386 : shard.delayed_reconcile = false;
1387 : self.maybe_reconcile_shard(shard, nodes, ReconcilerPriority::Normal);
1388 : }
1389 :
1390 : if self.reconciler_concurrency.available_permits() == 0 {
1391 : break;
1392 : }
1393 : }
1394 : }
1395 : }
1396 :
1397 0 : async fn process_results(
1398 0 : &self,
1399 0 : mut result_rx: tokio::sync::mpsc::UnboundedReceiver<ReconcileResultRequest>,
1400 0 : mut bg_compute_hook_result_rx: tokio::sync::mpsc::Receiver<
1401 0 : Result<(), (TenantShardId, NotifyError)>,
1402 0 : >,
1403 0 : ) {
1404 : loop {
1405 : // Wait for the next result, or for cancellation
1406 0 : tokio::select! {
1407 0 : r = result_rx.recv() => {
1408 0 : match r {
1409 0 : Some(ReconcileResultRequest::ReconcileResult(result)) => {self.process_result(result);},
1410 0 : None | Some(ReconcileResultRequest::Stop) => {break;}
1411 : }
1412 : }
1413 0 : _ = async{
1414 0 : match bg_compute_hook_result_rx.recv().await {
1415 0 : Some(result) => {
1416 0 : if let Err((tenant_shard_id, notify_error)) = result {
1417 0 : tracing::warn!("Marking shard {tenant_shard_id} for notification retry, due to error {notify_error}");
1418 0 : let mut locked = self.inner.write().unwrap();
1419 0 : if let Some(shard) = locked.tenants.get_mut(&tenant_shard_id) {
1420 0 : shard.pending_compute_notification = true;
1421 0 : }
1422 :
1423 0 : }
1424 : },
1425 : None => {
1426 : // This channel is dead, but we don't want to terminate the outer loop{}: just wait for shutdown
1427 0 : self.cancel.cancelled().await;
1428 : }
1429 : }
1430 0 : } => {},
1431 0 : _ = self.cancel.cancelled() => {
1432 0 : break;
1433 : }
1434 : };
1435 : }
1436 0 : }
1437 :
1438 0 : async fn process_aborts(
1439 0 : &self,
1440 0 : mut abort_rx: tokio::sync::mpsc::UnboundedReceiver<TenantShardSplitAbort>,
1441 0 : ) {
1442 : loop {
1443 : // Wait for the next result, or for cancellation
1444 0 : let op = tokio::select! {
1445 0 : r = abort_rx.recv() => {
1446 0 : match r {
1447 0 : Some(op) => {op},
1448 0 : None => {break;}
1449 : }
1450 : }
1451 0 : _ = self.cancel.cancelled() => {
1452 0 : break;
1453 : }
1454 : };
1455 :
1456 : // Retry until shutdown: we must keep this request object alive until it is properly
1457 : // processed, as it holds a lock guard that prevents other operations trying to do things
1458 : // to the tenant while it is in a weird part-split state.
1459 0 : while !self.cancel.is_cancelled() {
1460 0 : match self.abort_tenant_shard_split(&op).await {
1461 0 : Ok(_) => break,
1462 0 : Err(e) => {
1463 0 : tracing::warn!(
1464 0 : "Failed to abort shard split on {}, will retry: {e}",
1465 : op.tenant_id
1466 : );
1467 :
1468 : // If a node is unavailable, we hope that it has been properly marked Offline
1469 : // when we retry, so that the abort op will succeed. If the abort op is failing
1470 : // for some other reason, we will keep retrying forever, or until a human notices
1471 : // and does something about it (either fixing a pageserver or restarting the controller).
1472 0 : tokio::time::timeout(Duration::from_secs(5), self.cancel.cancelled())
1473 0 : .await
1474 0 : .ok();
1475 : }
1476 : }
1477 : }
1478 : }
1479 0 : }
1480 :
1481 0 : pub async fn spawn(config: Config, persistence: Arc<Persistence>) -> anyhow::Result<Arc<Self>> {
1482 0 : let (result_tx, result_rx) = tokio::sync::mpsc::unbounded_channel();
1483 0 : let (abort_tx, abort_rx) = tokio::sync::mpsc::unbounded_channel();
1484 0 :
1485 0 : let leadership_cancel = CancellationToken::new();
1486 0 : let leadership = Leadership::new(persistence.clone(), config.clone(), leadership_cancel);
1487 0 : let (leader, leader_step_down_state) = leadership.step_down_current_leader().await?;
1488 :
1489 : // Apply the migrations **after** the current leader has stepped down
1490 : // (or we've given up waiting for it), but **before** reading from the
1491 : // database. The only exception is reading the current leader before
1492 : // migrating.
1493 0 : persistence.migration_run().await?;
1494 :
1495 0 : tracing::info!("Loading nodes from database...");
1496 0 : let nodes = persistence
1497 0 : .list_nodes()
1498 0 : .await?
1499 0 : .into_iter()
1500 0 : .map(|x| Node::from_persistent(x, config.use_https_pageserver_api))
1501 0 : .collect::<anyhow::Result<Vec<Node>>>()?;
1502 0 : let nodes: HashMap<NodeId, Node> = nodes.into_iter().map(|n| (n.get_id(), n)).collect();
1503 0 : tracing::info!("Loaded {} nodes from database.", nodes.len());
1504 0 : metrics::METRICS_REGISTRY
1505 0 : .metrics_group
1506 0 : .storage_controller_pageserver_nodes
1507 0 : .set(nodes.len() as i64);
1508 0 :
1509 0 : tracing::info!("Loading safekeepers from database...");
1510 0 : let safekeepers = persistence
1511 0 : .list_safekeepers()
1512 0 : .await?
1513 0 : .into_iter()
1514 0 : .map(|skp| {
1515 0 : Safekeeper::from_persistence(
1516 0 : skp,
1517 0 : CancellationToken::new(),
1518 0 : config.use_https_safekeeper_api,
1519 0 : )
1520 0 : })
1521 0 : .collect::<anyhow::Result<Vec<_>>>()?;
1522 0 : let safekeepers: HashMap<NodeId, Safekeeper> =
1523 0 : safekeepers.into_iter().map(|n| (n.get_id(), n)).collect();
1524 0 : tracing::info!("Loaded {} safekeepers from database.", safekeepers.len());
1525 :
1526 0 : tracing::info!("Loading shards from database...");
1527 0 : let mut tenant_shard_persistence = persistence.load_active_tenant_shards().await?;
1528 0 : tracing::info!(
1529 0 : "Loaded {} shards from database.",
1530 0 : tenant_shard_persistence.len()
1531 : );
1532 :
1533 : // If any shard splits were in progress, reset the database state to abort them
1534 0 : let mut tenant_shard_count_min_max: HashMap<TenantId, (ShardCount, ShardCount)> =
1535 0 : HashMap::new();
1536 0 : for tsp in &mut tenant_shard_persistence {
1537 0 : let shard = tsp.get_shard_identity()?;
1538 0 : let tenant_shard_id = tsp.get_tenant_shard_id()?;
1539 0 : let entry = tenant_shard_count_min_max
1540 0 : .entry(tenant_shard_id.tenant_id)
1541 0 : .or_insert_with(|| (shard.count, shard.count));
1542 0 : entry.0 = std::cmp::min(entry.0, shard.count);
1543 0 : entry.1 = std::cmp::max(entry.1, shard.count);
1544 0 : }
1545 :
1546 0 : for (tenant_id, (count_min, count_max)) in tenant_shard_count_min_max {
1547 0 : if count_min != count_max {
1548 : // Aborting the split in the database and dropping the child shards is sufficient: the reconciliation in
1549 : // [`Self::startup_reconcile`] will implicitly drop the child shards on remote pageservers, or they'll
1550 : // be dropped later in [`Self::node_activate_reconcile`] if it isn't available right now.
1551 0 : tracing::info!("Aborting shard split {tenant_id} {count_min:?} -> {count_max:?}");
1552 0 : let abort_status = persistence.abort_shard_split(tenant_id, count_max).await?;
1553 :
1554 : // We may never see the Complete status here: if the split was complete, we wouldn't have
1555 : // identified this tenant has having mismatching min/max counts.
1556 0 : assert!(matches!(abort_status, AbortShardSplitStatus::Aborted));
1557 :
1558 : // Clear the splitting status in-memory, to reflect that we just aborted in the database
1559 0 : tenant_shard_persistence.iter_mut().for_each(|tsp| {
1560 0 : // Set idle split state on those shards that we will retain.
1561 0 : let tsp_tenant_id = TenantId::from_str(tsp.tenant_id.as_str()).unwrap();
1562 0 : if tsp_tenant_id == tenant_id
1563 0 : && tsp.get_shard_identity().unwrap().count == count_min
1564 0 : {
1565 0 : tsp.splitting = SplitState::Idle;
1566 0 : } else if tsp_tenant_id == tenant_id {
1567 : // Leave the splitting state on the child shards: this will be used next to
1568 : // drop them.
1569 0 : tracing::info!(
1570 0 : "Shard {tsp_tenant_id} will be dropped after shard split abort",
1571 : );
1572 0 : }
1573 0 : });
1574 0 :
1575 0 : // Drop shards for this tenant which we didn't just mark idle (i.e. child shards of the aborted split)
1576 0 : tenant_shard_persistence.retain(|tsp| {
1577 0 : TenantId::from_str(tsp.tenant_id.as_str()).unwrap() != tenant_id
1578 0 : || tsp.splitting == SplitState::Idle
1579 0 : });
1580 0 : }
1581 : }
1582 :
1583 0 : let mut tenants = BTreeMap::new();
1584 0 :
1585 0 : let mut scheduler = Scheduler::new(nodes.values());
1586 :
1587 : #[cfg(feature = "testing")]
1588 : {
1589 : use pageserver_api::controller_api::AvailabilityZone;
1590 :
1591 : // Hack: insert scheduler state for all nodes referenced by shards, as compatibility
1592 : // tests only store the shards, not the nodes. The nodes will be loaded shortly
1593 : // after when pageservers start up and register.
1594 0 : let mut node_ids = HashSet::new();
1595 0 : for tsp in &tenant_shard_persistence {
1596 0 : if let Some(node_id) = tsp.generation_pageserver {
1597 0 : node_ids.insert(node_id);
1598 0 : }
1599 : }
1600 0 : for node_id in node_ids {
1601 0 : tracing::info!("Creating node {} in scheduler for tests", node_id);
1602 0 : let node = Node::new(
1603 0 : NodeId(node_id as u64),
1604 0 : "".to_string(),
1605 0 : 123,
1606 0 : None,
1607 0 : "".to_string(),
1608 0 : 123,
1609 0 : AvailabilityZone("test_az".to_string()),
1610 0 : false,
1611 0 : )
1612 0 : .unwrap();
1613 0 :
1614 0 : scheduler.node_upsert(&node);
1615 : }
1616 : }
1617 0 : for tsp in tenant_shard_persistence {
1618 0 : let tenant_shard_id = tsp.get_tenant_shard_id()?;
1619 :
1620 : // We will populate intent properly later in [`Self::startup_reconcile`], initially populate
1621 : // it with what we can infer: the node for which a generation was most recently issued.
1622 0 : let mut intent = IntentState::new(
1623 0 : tsp.preferred_az_id
1624 0 : .as_ref()
1625 0 : .map(|az| AvailabilityZone(az.clone())),
1626 0 : );
1627 0 : if let Some(generation_pageserver) = tsp.generation_pageserver.map(|n| NodeId(n as u64))
1628 : {
1629 0 : if nodes.contains_key(&generation_pageserver) {
1630 0 : intent.set_attached(&mut scheduler, Some(generation_pageserver));
1631 0 : } else {
1632 : // If a node was removed before being completely drained, it is legal for it to leave behind a `generation_pageserver` referring
1633 : // to a non-existent node, because node deletion doesn't block on completing the reconciliations that will issue new generations
1634 : // on different pageservers.
1635 0 : tracing::warn!(
1636 0 : "Tenant shard {tenant_shard_id} references non-existent node {generation_pageserver} in database, will be rescheduled"
1637 : );
1638 : }
1639 0 : }
1640 0 : let new_tenant = TenantShard::from_persistent(tsp, intent)?;
1641 :
1642 0 : tenants.insert(tenant_shard_id, new_tenant);
1643 : }
1644 :
1645 0 : let (startup_completion, startup_complete) = utils::completion::channel();
1646 0 :
1647 0 : // This channel is continuously consumed by process_results, so doesn't need to be very large.
1648 0 : let (bg_compute_notify_result_tx, bg_compute_notify_result_rx) =
1649 0 : tokio::sync::mpsc::channel(512);
1650 0 :
1651 0 : let (delayed_reconcile_tx, delayed_reconcile_rx) =
1652 0 : tokio::sync::mpsc::channel(MAX_DELAYED_RECONCILES);
1653 0 :
1654 0 : let cancel = CancellationToken::new();
1655 0 : let reconcilers_cancel = cancel.child_token();
1656 0 :
1657 0 : let mut http_client = reqwest::Client::builder();
1658 0 : // We intentionally disable the connection pool, so every request will create its own TCP connection.
1659 0 : // It's especially important for heartbeaters to notice more network problems.
1660 0 : //
1661 0 : // TODO: It makes sense to use this client only in heartbeaters and create a second one with
1662 0 : // connection pooling for everything else. But reqwest::Client may create a connection without
1663 0 : // ever using it (it uses hyper's Client under the hood):
1664 0 : // https://github.com/hyperium/hyper-util/blob/d51318df3461d40e5f5e5ca163cb3905ac960209/src/client/legacy/client.rs#L415
1665 0 : //
1666 0 : // Because of a bug in hyper0::Connection::graceful_shutdown such connections hang during
1667 0 : // graceful server shutdown: https://github.com/hyperium/hyper/issues/2730
1668 0 : //
1669 0 : // The bug has been fixed in hyper v1, so keep alive may be enabled only after we migrate to hyper1.
1670 0 : http_client = http_client.pool_max_idle_per_host(0);
1671 0 : if let Some(ssl_ca_cert) = &config.ssl_ca_cert {
1672 0 : http_client = http_client.add_root_certificate(ssl_ca_cert.clone());
1673 0 : }
1674 0 : let http_client = http_client.build()?;
1675 :
1676 0 : let heartbeater_ps = Heartbeater::new(
1677 0 : http_client.clone(),
1678 0 : config.pageserver_jwt_token.clone(),
1679 0 : config.max_offline_interval,
1680 0 : config.max_warming_up_interval,
1681 0 : cancel.clone(),
1682 0 : );
1683 0 :
1684 0 : let heartbeater_sk = Heartbeater::new(
1685 0 : http_client.clone(),
1686 0 : config.safekeeper_jwt_token.clone(),
1687 0 : config.max_offline_interval,
1688 0 : config.max_warming_up_interval,
1689 0 : cancel.clone(),
1690 0 : );
1691 :
1692 0 : let initial_leadership_status = if config.start_as_candidate {
1693 0 : LeadershipStatus::Candidate
1694 : } else {
1695 0 : LeadershipStatus::Leader
1696 : };
1697 :
1698 0 : let this = Arc::new(Self {
1699 0 : inner: Arc::new(std::sync::RwLock::new(ServiceState::new(
1700 0 : nodes,
1701 0 : safekeepers,
1702 0 : tenants,
1703 0 : scheduler,
1704 0 : delayed_reconcile_rx,
1705 0 : initial_leadership_status,
1706 0 : reconcilers_cancel.clone(),
1707 0 : ))),
1708 0 : config: config.clone(),
1709 0 : persistence,
1710 0 : compute_hook: Arc::new(ComputeHook::new(config.clone())),
1711 0 : result_tx,
1712 0 : heartbeater_ps,
1713 0 : heartbeater_sk,
1714 0 : reconciler_concurrency: Arc::new(tokio::sync::Semaphore::new(
1715 0 : config.reconciler_concurrency,
1716 0 : )),
1717 0 : priority_reconciler_concurrency: Arc::new(tokio::sync::Semaphore::new(
1718 0 : config.priority_reconciler_concurrency,
1719 0 : )),
1720 0 : delayed_reconcile_tx,
1721 0 : abort_tx,
1722 0 : startup_complete: startup_complete.clone(),
1723 0 : cancel,
1724 0 : reconcilers_cancel,
1725 0 : gate: Gate::default(),
1726 0 : reconcilers_gate: Gate::default(),
1727 0 : tenant_op_locks: Default::default(),
1728 0 : node_op_locks: Default::default(),
1729 0 : http_client,
1730 0 : });
1731 0 :
1732 0 : let result_task_this = this.clone();
1733 0 : tokio::task::spawn(async move {
1734 : // Block shutdown until we're done (we must respect self.cancel)
1735 0 : if let Ok(_gate) = result_task_this.gate.enter() {
1736 0 : result_task_this
1737 0 : .process_results(result_rx, bg_compute_notify_result_rx)
1738 0 : .await
1739 0 : }
1740 0 : });
1741 0 :
1742 0 : tokio::task::spawn({
1743 0 : let this = this.clone();
1744 0 : async move {
1745 : // Block shutdown until we're done (we must respect self.cancel)
1746 0 : if let Ok(_gate) = this.gate.enter() {
1747 0 : this.process_aborts(abort_rx).await
1748 0 : }
1749 0 : }
1750 0 : });
1751 0 :
1752 0 : tokio::task::spawn({
1753 0 : let this = this.clone();
1754 0 : async move {
1755 0 : if let Ok(_gate) = this.gate.enter() {
1756 : loop {
1757 0 : tokio::select! {
1758 0 : _ = this.cancel.cancelled() => {
1759 0 : break;
1760 : },
1761 0 : _ = tokio::time::sleep(Duration::from_secs(60)) => {}
1762 0 : };
1763 0 : this.tenant_op_locks.housekeeping();
1764 : }
1765 0 : }
1766 0 : }
1767 0 : });
1768 0 :
1769 0 : tokio::task::spawn({
1770 0 : let this = this.clone();
1771 0 : // We will block the [`Service::startup_complete`] barrier until [`Self::startup_reconcile`]
1772 0 : // is done.
1773 0 : let startup_completion = startup_completion.clone();
1774 0 : async move {
1775 : // Block shutdown until we're done (we must respect self.cancel)
1776 0 : let Ok(_gate) = this.gate.enter() else {
1777 0 : return;
1778 : };
1779 :
1780 0 : this.startup_reconcile(leader, leader_step_down_state, bg_compute_notify_result_tx)
1781 0 : .await;
1782 :
1783 0 : drop(startup_completion);
1784 0 : }
1785 0 : });
1786 0 :
1787 0 : tokio::task::spawn({
1788 0 : let this = this.clone();
1789 0 : let startup_complete = startup_complete.clone();
1790 0 : async move {
1791 0 : startup_complete.wait().await;
1792 0 : this.background_reconcile().await;
1793 0 : }
1794 0 : });
1795 0 :
1796 0 : tokio::task::spawn({
1797 0 : let this = this.clone();
1798 0 : let startup_complete = startup_complete.clone();
1799 0 : async move {
1800 0 : startup_complete.wait().await;
1801 0 : this.spawn_heartbeat_driver().await;
1802 0 : }
1803 0 : });
1804 0 :
1805 0 : Ok(this)
1806 0 : }
1807 :
1808 0 : pub(crate) async fn attach_hook(
1809 0 : &self,
1810 0 : attach_req: AttachHookRequest,
1811 0 : ) -> anyhow::Result<AttachHookResponse> {
1812 0 : let _tenant_lock = trace_exclusive_lock(
1813 0 : &self.tenant_op_locks,
1814 0 : attach_req.tenant_shard_id.tenant_id,
1815 0 : TenantOperations::AttachHook,
1816 0 : )
1817 0 : .await;
1818 :
1819 : // This is a test hook. To enable using it on tenants that were created directly with
1820 : // the pageserver API (not via this service), we will auto-create any missing tenant
1821 : // shards with default state.
1822 0 : let insert = {
1823 0 : match self
1824 0 : .maybe_load_tenant(attach_req.tenant_shard_id.tenant_id, &_tenant_lock)
1825 0 : .await
1826 : {
1827 0 : Ok(_) => false,
1828 0 : Err(ApiError::NotFound(_)) => true,
1829 0 : Err(e) => return Err(e.into()),
1830 : }
1831 : };
1832 :
1833 0 : if insert {
1834 0 : let tsp = TenantShardPersistence {
1835 0 : tenant_id: attach_req.tenant_shard_id.tenant_id.to_string(),
1836 0 : shard_number: attach_req.tenant_shard_id.shard_number.0 as i32,
1837 0 : shard_count: attach_req.tenant_shard_id.shard_count.literal() as i32,
1838 0 : shard_stripe_size: 0,
1839 0 : generation: attach_req.generation_override.or(Some(0)),
1840 0 : generation_pageserver: None,
1841 0 : placement_policy: serde_json::to_string(&PlacementPolicy::Attached(0)).unwrap(),
1842 0 : config: serde_json::to_string(&TenantConfig::default()).unwrap(),
1843 0 : splitting: SplitState::default(),
1844 0 : scheduling_policy: serde_json::to_string(&ShardSchedulingPolicy::default())
1845 0 : .unwrap(),
1846 0 : preferred_az_id: None,
1847 0 : };
1848 0 :
1849 0 : match self.persistence.insert_tenant_shards(vec![tsp]).await {
1850 0 : Err(e) => match e {
1851 : DatabaseError::Query(diesel::result::Error::DatabaseError(
1852 : DatabaseErrorKind::UniqueViolation,
1853 : _,
1854 : )) => {
1855 0 : tracing::info!(
1856 0 : "Raced with another request to insert tenant {}",
1857 : attach_req.tenant_shard_id
1858 : )
1859 : }
1860 0 : _ => return Err(e.into()),
1861 : },
1862 : Ok(()) => {
1863 0 : tracing::info!("Inserted shard {} in database", attach_req.tenant_shard_id);
1864 :
1865 0 : let mut locked = self.inner.write().unwrap();
1866 0 : locked.tenants.insert(
1867 0 : attach_req.tenant_shard_id,
1868 0 : TenantShard::new(
1869 0 : attach_req.tenant_shard_id,
1870 0 : ShardIdentity::unsharded(),
1871 0 : PlacementPolicy::Attached(0),
1872 0 : None,
1873 0 : ),
1874 0 : );
1875 0 : tracing::info!("Inserted shard {} in memory", attach_req.tenant_shard_id);
1876 : }
1877 : }
1878 0 : }
1879 :
1880 0 : let new_generation = if let Some(req_node_id) = attach_req.node_id {
1881 0 : let maybe_tenant_conf = {
1882 0 : let locked = self.inner.write().unwrap();
1883 0 : locked
1884 0 : .tenants
1885 0 : .get(&attach_req.tenant_shard_id)
1886 0 : .map(|t| t.config.clone())
1887 0 : };
1888 0 :
1889 0 : match maybe_tenant_conf {
1890 0 : Some(conf) => {
1891 0 : let new_generation = self
1892 0 : .persistence
1893 0 : .increment_generation(attach_req.tenant_shard_id, req_node_id)
1894 0 : .await?;
1895 :
1896 : // Persist the placement policy update. This is required
1897 : // when we reattaching a detached tenant.
1898 0 : self.persistence
1899 0 : .update_tenant_shard(
1900 0 : TenantFilter::Shard(attach_req.tenant_shard_id),
1901 0 : Some(PlacementPolicy::Attached(0)),
1902 0 : Some(conf),
1903 0 : None,
1904 0 : None,
1905 0 : )
1906 0 : .await?;
1907 0 : Some(new_generation)
1908 : }
1909 : None => {
1910 0 : anyhow::bail!("Attach hook handling raced with tenant removal")
1911 : }
1912 : }
1913 : } else {
1914 0 : self.persistence.detach(attach_req.tenant_shard_id).await?;
1915 0 : None
1916 : };
1917 :
1918 0 : let mut locked = self.inner.write().unwrap();
1919 0 : let (_nodes, tenants, scheduler) = locked.parts_mut();
1920 0 :
1921 0 : let tenant_shard = tenants
1922 0 : .get_mut(&attach_req.tenant_shard_id)
1923 0 : .expect("Checked for existence above");
1924 :
1925 0 : if let Some(new_generation) = new_generation {
1926 0 : tenant_shard.generation = Some(new_generation);
1927 0 : tenant_shard.policy = PlacementPolicy::Attached(0);
1928 0 : } else {
1929 : // This is a detach notification. We must update placement policy to avoid re-attaching
1930 : // during background scheduling/reconciliation, or during storage controller restart.
1931 0 : assert!(attach_req.node_id.is_none());
1932 0 : tenant_shard.policy = PlacementPolicy::Detached;
1933 : }
1934 :
1935 0 : if let Some(attaching_pageserver) = attach_req.node_id.as_ref() {
1936 0 : tracing::info!(
1937 : tenant_id = %attach_req.tenant_shard_id,
1938 : ps_id = %attaching_pageserver,
1939 : generation = ?tenant_shard.generation,
1940 0 : "issuing",
1941 : );
1942 0 : } else if let Some(ps_id) = tenant_shard.intent.get_attached() {
1943 0 : tracing::info!(
1944 : tenant_id = %attach_req.tenant_shard_id,
1945 : %ps_id,
1946 : generation = ?tenant_shard.generation,
1947 0 : "dropping",
1948 : );
1949 : } else {
1950 0 : tracing::info!(
1951 : tenant_id = %attach_req.tenant_shard_id,
1952 0 : "no-op: tenant already has no pageserver");
1953 : }
1954 0 : tenant_shard
1955 0 : .intent
1956 0 : .set_attached(scheduler, attach_req.node_id);
1957 0 :
1958 0 : tracing::info!(
1959 0 : "attach_hook: tenant {} set generation {:?}, pageserver {}",
1960 0 : attach_req.tenant_shard_id,
1961 0 : tenant_shard.generation,
1962 0 : // TODO: this is an odd number of 0xf's
1963 0 : attach_req.node_id.unwrap_or(utils::id::NodeId(0xfffffff))
1964 : );
1965 :
1966 : // Trick the reconciler into not doing anything for this tenant: this helps
1967 : // tests that manually configure a tenant on the pagesrever, and then call this
1968 : // attach hook: they don't want background reconciliation to modify what they
1969 : // did to the pageserver.
1970 : #[cfg(feature = "testing")]
1971 : {
1972 0 : if let Some(node_id) = attach_req.node_id {
1973 0 : tenant_shard.observed.locations = HashMap::from([(
1974 0 : node_id,
1975 0 : ObservedStateLocation {
1976 0 : conf: Some(attached_location_conf(
1977 0 : tenant_shard.generation.unwrap(),
1978 0 : &tenant_shard.shard,
1979 0 : &tenant_shard.config,
1980 0 : &PlacementPolicy::Attached(0),
1981 0 : )),
1982 0 : },
1983 0 : )]);
1984 0 : } else {
1985 0 : tenant_shard.observed.locations.clear();
1986 0 : }
1987 : }
1988 :
1989 0 : Ok(AttachHookResponse {
1990 0 : generation: attach_req
1991 0 : .node_id
1992 0 : .map(|_| tenant_shard.generation.expect("Test hook, not used on tenants that are mid-onboarding with a NULL generation").into().unwrap()),
1993 0 : })
1994 0 : }
1995 :
1996 0 : pub(crate) fn inspect(&self, inspect_req: InspectRequest) -> InspectResponse {
1997 0 : let locked = self.inner.read().unwrap();
1998 0 :
1999 0 : let tenant_shard = locked.tenants.get(&inspect_req.tenant_shard_id);
2000 0 :
2001 0 : InspectResponse {
2002 0 : attachment: tenant_shard.and_then(|s| {
2003 0 : s.intent
2004 0 : .get_attached()
2005 0 : .map(|ps| (s.generation.expect("Test hook, not used on tenants that are mid-onboarding with a NULL generation").into().unwrap(), ps))
2006 0 : }),
2007 0 : }
2008 0 : }
2009 :
2010 : // When the availability state of a node transitions to active, we must do a full reconciliation
2011 : // of LocationConfigs on that node. This is because while a node was offline:
2012 : // - we might have proceeded through startup_reconcile without checking for extraneous LocationConfigs on this node
2013 : // - aborting a tenant shard split might have left rogue child shards behind on this node.
2014 : //
2015 : // This function must complete _before_ setting a `Node` to Active: once it is set to Active, other
2016 : // Reconcilers might communicate with the node, and these must not overlap with the work we do in
2017 : // this function.
2018 : //
2019 : // The reconciliation logic in here is very similar to what [`Self::startup_reconcile`] does, but
2020 : // for written for a single node rather than as a batch job for all nodes.
2021 : #[tracing::instrument(skip_all, fields(node_id=%node.get_id()))]
2022 : async fn node_activate_reconcile(
2023 : &self,
2024 : mut node: Node,
2025 : _lock: &TracingExclusiveGuard<NodeOperations>,
2026 : ) -> Result<(), ApiError> {
2027 : // This Node is a mutable local copy: we will set it active so that we can use its
2028 : // API client to reconcile with the node. The Node in [`Self::nodes`] will get updated
2029 : // later.
2030 : node.set_availability(NodeAvailability::Active(PageserverUtilization::full()));
2031 :
2032 : let configs = match node
2033 : .with_client_retries(
2034 0 : |client| async move { client.list_location_config().await },
2035 : &self.http_client,
2036 : &self.config.pageserver_jwt_token,
2037 : 1,
2038 : 5,
2039 : SHORT_RECONCILE_TIMEOUT,
2040 : &self.cancel,
2041 : )
2042 : .await
2043 : {
2044 : None => {
2045 : // We're shutting down (the Node's cancellation token can't have fired, because
2046 : // we're the only scope that has a reference to it, and we didn't fire it).
2047 : return Err(ApiError::ShuttingDown);
2048 : }
2049 : Some(Err(e)) => {
2050 : // This node didn't succeed listing its locations: it may not proceed to active state
2051 : // as it is apparently unavailable.
2052 : return Err(ApiError::PreconditionFailed(
2053 : format!("Failed to query node location configs, cannot activate ({e})").into(),
2054 : ));
2055 : }
2056 : Some(Ok(configs)) => configs,
2057 : };
2058 : tracing::info!("Loaded {} LocationConfigs", configs.tenant_shards.len());
2059 :
2060 : let mut cleanup = Vec::new();
2061 : let mut mismatched_locations = 0;
2062 : {
2063 : let mut locked = self.inner.write().unwrap();
2064 :
2065 : for (tenant_shard_id, reported) in configs.tenant_shards {
2066 : let Some(tenant_shard) = locked.tenants.get_mut(&tenant_shard_id) else {
2067 : cleanup.push(tenant_shard_id);
2068 : continue;
2069 : };
2070 :
2071 : let on_record = &mut tenant_shard
2072 : .observed
2073 : .locations
2074 : .entry(node.get_id())
2075 0 : .or_insert_with(|| ObservedStateLocation { conf: None })
2076 : .conf;
2077 :
2078 : // If the location reported by the node does not match our observed state,
2079 : // then we mark it as uncertain and let the background reconciliation loop
2080 : // deal with it.
2081 : //
2082 : // Note that this also covers net new locations reported by the node.
2083 : if *on_record != reported {
2084 : mismatched_locations += 1;
2085 : *on_record = None;
2086 : }
2087 : }
2088 : }
2089 :
2090 : if mismatched_locations > 0 {
2091 : tracing::info!(
2092 : "Set observed state to None for {mismatched_locations} mismatched locations"
2093 : );
2094 : }
2095 :
2096 : for tenant_shard_id in cleanup {
2097 : tracing::info!("Detaching {tenant_shard_id}");
2098 : match node
2099 : .with_client_retries(
2100 0 : |client| async move {
2101 0 : let config = LocationConfig {
2102 0 : mode: LocationConfigMode::Detached,
2103 0 : generation: None,
2104 0 : secondary_conf: None,
2105 0 : shard_number: tenant_shard_id.shard_number.0,
2106 0 : shard_count: tenant_shard_id.shard_count.literal(),
2107 0 : shard_stripe_size: 0,
2108 0 : tenant_conf: models::TenantConfig::default(),
2109 0 : };
2110 0 : client
2111 0 : .location_config(tenant_shard_id, config, None, false)
2112 0 : .await
2113 0 : },
2114 : &self.http_client,
2115 : &self.config.pageserver_jwt_token,
2116 : 1,
2117 : 5,
2118 : SHORT_RECONCILE_TIMEOUT,
2119 : &self.cancel,
2120 : )
2121 : .await
2122 : {
2123 : None => {
2124 : // We're shutting down (the Node's cancellation token can't have fired, because
2125 : // we're the only scope that has a reference to it, and we didn't fire it).
2126 : return Err(ApiError::ShuttingDown);
2127 : }
2128 : Some(Err(e)) => {
2129 : // Do not let the node proceed to Active state if it is not responsive to requests
2130 : // to detach. This could happen if e.g. a shutdown bug in the pageserver is preventing
2131 : // detach completing: we should not let this node back into the set of nodes considered
2132 : // okay for scheduling.
2133 : return Err(ApiError::Conflict(format!(
2134 : "Node {node} failed to detach {tenant_shard_id}: {e}"
2135 : )));
2136 : }
2137 : Some(Ok(_)) => {}
2138 : };
2139 : }
2140 :
2141 : Ok(())
2142 : }
2143 :
2144 0 : pub(crate) async fn re_attach(
2145 0 : &self,
2146 0 : reattach_req: ReAttachRequest,
2147 0 : ) -> Result<ReAttachResponse, ApiError> {
2148 0 : if let Some(register_req) = reattach_req.register {
2149 0 : self.node_register(register_req).await?;
2150 0 : }
2151 :
2152 : // Ordering: we must persist generation number updates before making them visible in the in-memory state
2153 0 : let incremented_generations = self.persistence.re_attach(reattach_req.node_id).await?;
2154 :
2155 0 : tracing::info!(
2156 : node_id=%reattach_req.node_id,
2157 0 : "Incremented {} tenant shards' generations",
2158 0 : incremented_generations.len()
2159 : );
2160 :
2161 : // Apply the updated generation to our in-memory state, and
2162 : // gather discover secondary locations.
2163 0 : let mut locked = self.inner.write().unwrap();
2164 0 : let (nodes, tenants, scheduler) = locked.parts_mut();
2165 0 :
2166 0 : let mut response = ReAttachResponse {
2167 0 : tenants: Vec::new(),
2168 0 : };
2169 :
2170 : // TODO: cancel/restart any running reconciliation for this tenant, it might be trying
2171 : // to call location_conf API with an old generation. Wait for cancellation to complete
2172 : // before responding to this request. Requires well implemented CancellationToken logic
2173 : // all the way to where we call location_conf. Even then, there can still be a location_conf
2174 : // request in flight over the network: TODO handle that by making location_conf API refuse
2175 : // to go backward in generations.
2176 :
2177 : // Scan through all shards, applying updates for ones where we updated generation
2178 : // and identifying shards that intend to have a secondary location on this node.
2179 0 : for (tenant_shard_id, shard) in tenants {
2180 0 : if let Some(new_gen) = incremented_generations.get(tenant_shard_id) {
2181 0 : let new_gen = *new_gen;
2182 0 : response.tenants.push(ReAttachResponseTenant {
2183 0 : id: *tenant_shard_id,
2184 0 : r#gen: Some(new_gen.into().unwrap()),
2185 0 : // A tenant is only put into multi or stale modes in the middle of a [`Reconciler::live_migrate`]
2186 0 : // execution. If a pageserver is restarted during that process, then the reconcile pass will
2187 0 : // fail, and start from scratch, so it doesn't make sense for us to try and preserve
2188 0 : // the stale/multi states at this point.
2189 0 : mode: LocationConfigMode::AttachedSingle,
2190 0 : });
2191 0 :
2192 0 : shard.generation = std::cmp::max(shard.generation, Some(new_gen));
2193 0 : if let Some(observed) = shard.observed.locations.get_mut(&reattach_req.node_id) {
2194 : // Why can we update `observed` even though we're not sure our response will be received
2195 : // by the pageserver? Because the pageserver will not proceed with startup until
2196 : // it has processed response: if it loses it, we'll see another request and increment
2197 : // generation again, avoiding any uncertainty about dirtiness of tenant's state.
2198 0 : if let Some(conf) = observed.conf.as_mut() {
2199 0 : conf.generation = new_gen.into();
2200 0 : }
2201 0 : } else {
2202 0 : // This node has no observed state for the shard: perhaps it was offline
2203 0 : // when the pageserver restarted. Insert a None, so that the Reconciler
2204 0 : // will be prompted to learn the location's state before it makes changes.
2205 0 : shard
2206 0 : .observed
2207 0 : .locations
2208 0 : .insert(reattach_req.node_id, ObservedStateLocation { conf: None });
2209 0 : }
2210 0 : } else if shard.intent.get_secondary().contains(&reattach_req.node_id) {
2211 0 : // Ordering: pageserver will not accept /location_config requests until it has
2212 0 : // finished processing the response from re-attach. So we can update our in-memory state
2213 0 : // now, and be confident that we are not stamping on the result of some later location config.
2214 0 : // TODO: however, we are not strictly ordered wrt ReconcileResults queue,
2215 0 : // so we might update observed state here, and then get over-written by some racing
2216 0 : // ReconcileResult. The impact is low however, since we have set state on pageserver something
2217 0 : // that matches intent, so worst case if we race then we end up doing a spurious reconcile.
2218 0 :
2219 0 : response.tenants.push(ReAttachResponseTenant {
2220 0 : id: *tenant_shard_id,
2221 0 : r#gen: None,
2222 0 : mode: LocationConfigMode::Secondary,
2223 0 : });
2224 0 :
2225 0 : // We must not update observed, because we have no guarantee that our
2226 0 : // response will be received by the pageserver. This could leave it
2227 0 : // falsely dirty, but the resulting reconcile should be idempotent.
2228 0 : }
2229 : }
2230 :
2231 : // We consider a node Active once we have composed a re-attach response, but we
2232 : // do not call [`Self::node_activate_reconcile`]: the handling of the re-attach response
2233 : // implicitly synchronizes the LocationConfigs on the node.
2234 : //
2235 : // Setting a node active unblocks any Reconcilers that might write to the location config API,
2236 : // but those requests will not be accepted by the node until it has finished processing
2237 : // the re-attach response.
2238 : //
2239 : // Additionally, reset the nodes scheduling policy to match the conditional update done
2240 : // in [`Persistence::re_attach`].
2241 0 : if let Some(node) = nodes.get(&reattach_req.node_id) {
2242 0 : let reset_scheduling = matches!(
2243 0 : node.get_scheduling(),
2244 : NodeSchedulingPolicy::PauseForRestart
2245 : | NodeSchedulingPolicy::Draining
2246 : | NodeSchedulingPolicy::Filling
2247 : );
2248 :
2249 0 : let mut new_nodes = (**nodes).clone();
2250 0 : if let Some(node) = new_nodes.get_mut(&reattach_req.node_id) {
2251 0 : if reset_scheduling {
2252 0 : node.set_scheduling(NodeSchedulingPolicy::Active);
2253 0 : }
2254 :
2255 0 : tracing::info!("Marking {} warming-up on reattach", reattach_req.node_id);
2256 0 : node.set_availability(NodeAvailability::WarmingUp(std::time::Instant::now()));
2257 0 :
2258 0 : scheduler.node_upsert(node);
2259 0 : let new_nodes = Arc::new(new_nodes);
2260 0 : *nodes = new_nodes;
2261 : } else {
2262 0 : tracing::error!(
2263 0 : "Reattaching node {} was removed while processing the request",
2264 : reattach_req.node_id
2265 : );
2266 : }
2267 0 : }
2268 :
2269 0 : Ok(response)
2270 0 : }
2271 :
2272 0 : pub(crate) async fn validate(
2273 0 : &self,
2274 0 : validate_req: ValidateRequest,
2275 0 : ) -> Result<ValidateResponse, DatabaseError> {
2276 : // Fast in-memory check: we may reject validation on anything that doesn't match our
2277 : // in-memory generation for a shard
2278 0 : let in_memory_result = {
2279 0 : let mut in_memory_result = Vec::new();
2280 0 : let locked = self.inner.read().unwrap();
2281 0 : for req_tenant in validate_req.tenants {
2282 0 : if let Some(tenant_shard) = locked.tenants.get(&req_tenant.id) {
2283 0 : let valid = tenant_shard.generation == Some(Generation::new(req_tenant.r#gen));
2284 0 : tracing::info!(
2285 0 : "handle_validate: {}(gen {}): valid={valid} (latest {:?})",
2286 : req_tenant.id,
2287 : req_tenant.r#gen,
2288 : tenant_shard.generation
2289 : );
2290 :
2291 0 : in_memory_result.push((
2292 0 : req_tenant.id,
2293 0 : Generation::new(req_tenant.r#gen),
2294 0 : valid,
2295 0 : ));
2296 : } else {
2297 : // This is legal: for example during a shard split the pageserver may still
2298 : // have deletions in its queue from the old pre-split shard, or after deletion
2299 : // of a tenant that was busy with compaction/gc while being deleted.
2300 0 : tracing::info!(
2301 0 : "Refusing deletion validation for missing shard {}",
2302 : req_tenant.id
2303 : );
2304 : }
2305 : }
2306 :
2307 0 : in_memory_result
2308 : };
2309 :
2310 : // Database calls to confirm validity for anything that passed the in-memory check. We must do this
2311 : // in case of controller split-brain, where some other controller process might have incremented the generation.
2312 0 : let db_generations = self
2313 0 : .persistence
2314 0 : .shard_generations(
2315 0 : in_memory_result
2316 0 : .iter()
2317 0 : .filter_map(|i| if i.2 { Some(&i.0) } else { None }),
2318 0 : )
2319 0 : .await?;
2320 0 : let db_generations = db_generations.into_iter().collect::<HashMap<_, _>>();
2321 0 :
2322 0 : let mut response = ValidateResponse {
2323 0 : tenants: Vec::new(),
2324 0 : };
2325 0 : for (tenant_shard_id, validate_generation, valid) in in_memory_result.into_iter() {
2326 0 : let valid = if valid {
2327 0 : let db_generation = db_generations.get(&tenant_shard_id);
2328 0 : db_generation == Some(&Some(validate_generation))
2329 : } else {
2330 : // If in-memory state says it's invalid, trust that. It's always safe to fail a validation, at worst
2331 : // this prevents a pageserver from cleaning up an object in S3.
2332 0 : false
2333 : };
2334 :
2335 0 : response.tenants.push(ValidateResponseTenant {
2336 0 : id: tenant_shard_id,
2337 0 : valid,
2338 0 : })
2339 : }
2340 :
2341 0 : Ok(response)
2342 0 : }
2343 :
2344 0 : pub(crate) async fn tenant_create(
2345 0 : &self,
2346 0 : create_req: TenantCreateRequest,
2347 0 : ) -> Result<TenantCreateResponse, ApiError> {
2348 0 : let tenant_id = create_req.new_tenant_id.tenant_id;
2349 :
2350 : // Exclude any concurrent attempts to create/access the same tenant ID
2351 0 : let _tenant_lock = trace_exclusive_lock(
2352 0 : &self.tenant_op_locks,
2353 0 : create_req.new_tenant_id.tenant_id,
2354 0 : TenantOperations::Create,
2355 0 : )
2356 0 : .await;
2357 0 : let (response, waiters) = self.do_tenant_create(create_req).await?;
2358 :
2359 0 : if let Err(e) = self.await_waiters(waiters, RECONCILE_TIMEOUT).await {
2360 : // Avoid deadlock: reconcile may fail while notifying compute, if the cloud control plane refuses to
2361 : // accept compute notifications while it is in the process of creating. Reconciliation will
2362 : // be retried in the background.
2363 0 : tracing::warn!(%tenant_id, "Reconcile not done yet while creating tenant ({e})");
2364 0 : }
2365 0 : Ok(response)
2366 0 : }
2367 :
2368 0 : pub(crate) async fn do_tenant_create(
2369 0 : &self,
2370 0 : create_req: TenantCreateRequest,
2371 0 : ) -> Result<(TenantCreateResponse, Vec<ReconcilerWaiter>), ApiError> {
2372 0 : let placement_policy = create_req
2373 0 : .placement_policy
2374 0 : .clone()
2375 0 : // As a default, zero secondaries is convenient for tests that don't choose a policy.
2376 0 : .unwrap_or(PlacementPolicy::Attached(0));
2377 :
2378 : // This service expects to handle sharding itself: it is an error to try and directly create
2379 : // a particular shard here.
2380 0 : let tenant_id = if !create_req.new_tenant_id.is_unsharded() {
2381 0 : return Err(ApiError::BadRequest(anyhow::anyhow!(
2382 0 : "Attempted to create a specific shard, this API is for creating the whole tenant"
2383 0 : )));
2384 : } else {
2385 0 : create_req.new_tenant_id.tenant_id
2386 0 : };
2387 0 :
2388 0 : tracing::info!(
2389 0 : "Creating tenant {}, shard_count={:?}",
2390 : create_req.new_tenant_id,
2391 : create_req.shard_parameters.count,
2392 : );
2393 :
2394 0 : let create_ids = (0..create_req.shard_parameters.count.count())
2395 0 : .map(|i| TenantShardId {
2396 0 : tenant_id,
2397 0 : shard_number: ShardNumber(i),
2398 0 : shard_count: create_req.shard_parameters.count,
2399 0 : })
2400 0 : .collect::<Vec<_>>();
2401 :
2402 : // If the caller specifies a None generation, it means "start from default". This is different
2403 : // to [`Self::tenant_location_config`], where a None generation is used to represent
2404 : // an incompletely-onboarded tenant.
2405 0 : let initial_generation = if matches!(placement_policy, PlacementPolicy::Secondary) {
2406 0 : tracing::info!(
2407 0 : "tenant_create: secondary mode, generation is_some={}",
2408 0 : create_req.generation.is_some()
2409 : );
2410 0 : create_req.generation.map(Generation::new)
2411 : } else {
2412 0 : tracing::info!(
2413 0 : "tenant_create: not secondary mode, generation is_some={}",
2414 0 : create_req.generation.is_some()
2415 : );
2416 0 : Some(
2417 0 : create_req
2418 0 : .generation
2419 0 : .map(Generation::new)
2420 0 : .unwrap_or(INITIAL_GENERATION),
2421 0 : )
2422 : };
2423 :
2424 0 : let preferred_az_id = {
2425 0 : let locked = self.inner.read().unwrap();
2426 : // Idempotency: take the existing value if the tenant already exists
2427 0 : if let Some(shard) = locked.tenants.get(create_ids.first().unwrap()) {
2428 0 : shard.preferred_az().cloned()
2429 : } else {
2430 0 : locked.scheduler.get_az_for_new_tenant()
2431 : }
2432 : };
2433 :
2434 : // Ordering: we persist tenant shards before creating them on the pageserver. This enables a caller
2435 : // to clean up after themselves by issuing a tenant deletion if something goes wrong and we restart
2436 : // during the creation, rather than risking leaving orphan objects in S3.
2437 0 : let persist_tenant_shards = create_ids
2438 0 : .iter()
2439 0 : .map(|tenant_shard_id| TenantShardPersistence {
2440 0 : tenant_id: tenant_shard_id.tenant_id.to_string(),
2441 0 : shard_number: tenant_shard_id.shard_number.0 as i32,
2442 0 : shard_count: tenant_shard_id.shard_count.literal() as i32,
2443 0 : shard_stripe_size: create_req.shard_parameters.stripe_size.0 as i32,
2444 0 : generation: initial_generation.map(|g| g.into().unwrap() as i32),
2445 0 : // The pageserver is not known until scheduling happens: we will set this column when
2446 0 : // incrementing the generation the first time we attach to a pageserver.
2447 0 : generation_pageserver: None,
2448 0 : placement_policy: serde_json::to_string(&placement_policy).unwrap(),
2449 0 : config: serde_json::to_string(&create_req.config).unwrap(),
2450 0 : splitting: SplitState::default(),
2451 0 : scheduling_policy: serde_json::to_string(&ShardSchedulingPolicy::default())
2452 0 : .unwrap(),
2453 0 : preferred_az_id: preferred_az_id.as_ref().map(|az| az.to_string()),
2454 0 : })
2455 0 : .collect();
2456 0 :
2457 0 : match self
2458 0 : .persistence
2459 0 : .insert_tenant_shards(persist_tenant_shards)
2460 0 : .await
2461 : {
2462 0 : Ok(_) => {}
2463 : Err(DatabaseError::Query(diesel::result::Error::DatabaseError(
2464 : DatabaseErrorKind::UniqueViolation,
2465 : _,
2466 : ))) => {
2467 : // Unique key violation: this is probably a retry. Because the shard count is part of the unique key,
2468 : // if we see a unique key violation it means that the creation request's shard count matches the previous
2469 : // creation's shard count.
2470 0 : tracing::info!(
2471 0 : "Tenant shards already present in database, proceeding with idempotent creation..."
2472 : );
2473 : }
2474 : // Any other database error is unexpected and a bug.
2475 0 : Err(e) => return Err(ApiError::InternalServerError(anyhow::anyhow!(e))),
2476 : };
2477 :
2478 0 : let mut schedule_context = ScheduleContext::default();
2479 0 : let mut schedule_error = None;
2480 0 : let mut response_shards = Vec::new();
2481 0 : for tenant_shard_id in create_ids {
2482 0 : tracing::info!("Creating shard {tenant_shard_id}...");
2483 :
2484 0 : let outcome = self
2485 0 : .do_initial_shard_scheduling(
2486 0 : tenant_shard_id,
2487 0 : initial_generation,
2488 0 : &create_req.shard_parameters,
2489 0 : create_req.config.clone(),
2490 0 : placement_policy.clone(),
2491 0 : preferred_az_id.as_ref(),
2492 0 : &mut schedule_context,
2493 0 : )
2494 0 : .await;
2495 :
2496 0 : match outcome {
2497 0 : InitialShardScheduleOutcome::Scheduled(resp) => response_shards.push(resp),
2498 0 : InitialShardScheduleOutcome::NotScheduled => {}
2499 0 : InitialShardScheduleOutcome::ShardScheduleError(err) => {
2500 0 : schedule_error = Some(err);
2501 0 : }
2502 : }
2503 : }
2504 :
2505 : // If we failed to schedule shards, then they are still created in the controller,
2506 : // but we return an error to the requester to avoid a silent failure when someone
2507 : // tries to e.g. create a tenant whose placement policy requires more nodes than
2508 : // are present in the system. We do this here rather than in the above loop, to
2509 : // avoid situations where we only create a subset of shards in the tenant.
2510 0 : if let Some(e) = schedule_error {
2511 0 : return Err(ApiError::Conflict(format!(
2512 0 : "Failed to schedule shard(s): {e}"
2513 0 : )));
2514 0 : }
2515 0 :
2516 0 : let waiters = {
2517 0 : let mut locked = self.inner.write().unwrap();
2518 0 : let (nodes, tenants, _scheduler) = locked.parts_mut();
2519 0 : let config = ReconcilerConfigBuilder::new(ReconcilerPriority::High)
2520 0 : .tenant_creation_hint(true)
2521 0 : .build();
2522 0 : tenants
2523 0 : .range_mut(TenantShardId::tenant_range(tenant_id))
2524 0 : .filter_map(|(_shard_id, shard)| {
2525 0 : self.maybe_configured_reconcile_shard(shard, nodes, config)
2526 0 : })
2527 0 : .collect::<Vec<_>>()
2528 0 : };
2529 0 :
2530 0 : Ok((
2531 0 : TenantCreateResponse {
2532 0 : shards: response_shards,
2533 0 : },
2534 0 : waiters,
2535 0 : ))
2536 0 : }
2537 :
2538 : /// Helper for tenant creation that does the scheduling for an individual shard. Covers both the
2539 : /// case of a new tenant and a pre-existing one.
2540 : #[allow(clippy::too_many_arguments)]
2541 0 : async fn do_initial_shard_scheduling(
2542 0 : &self,
2543 0 : tenant_shard_id: TenantShardId,
2544 0 : initial_generation: Option<Generation>,
2545 0 : shard_params: &ShardParameters,
2546 0 : config: TenantConfig,
2547 0 : placement_policy: PlacementPolicy,
2548 0 : preferred_az_id: Option<&AvailabilityZone>,
2549 0 : schedule_context: &mut ScheduleContext,
2550 0 : ) -> InitialShardScheduleOutcome {
2551 0 : let mut locked = self.inner.write().unwrap();
2552 0 : let (_nodes, tenants, scheduler) = locked.parts_mut();
2553 :
2554 : use std::collections::btree_map::Entry;
2555 0 : match tenants.entry(tenant_shard_id) {
2556 0 : Entry::Occupied(mut entry) => {
2557 0 : tracing::info!("Tenant shard {tenant_shard_id} already exists while creating");
2558 :
2559 0 : if let Err(err) = entry.get_mut().schedule(scheduler, schedule_context) {
2560 0 : return InitialShardScheduleOutcome::ShardScheduleError(err);
2561 0 : }
2562 :
2563 0 : if let Some(node_id) = entry.get().intent.get_attached() {
2564 0 : let generation = entry
2565 0 : .get()
2566 0 : .generation
2567 0 : .expect("Generation is set when in attached mode");
2568 0 : InitialShardScheduleOutcome::Scheduled(TenantCreateResponseShard {
2569 0 : shard_id: tenant_shard_id,
2570 0 : node_id: *node_id,
2571 0 : generation: generation.into().unwrap(),
2572 0 : })
2573 : } else {
2574 0 : InitialShardScheduleOutcome::NotScheduled
2575 : }
2576 : }
2577 0 : Entry::Vacant(entry) => {
2578 0 : let state = entry.insert(TenantShard::new(
2579 0 : tenant_shard_id,
2580 0 : ShardIdentity::from_params(tenant_shard_id.shard_number, shard_params),
2581 0 : placement_policy,
2582 0 : preferred_az_id.cloned(),
2583 0 : ));
2584 0 :
2585 0 : state.generation = initial_generation;
2586 0 : state.config = config;
2587 0 : if let Err(e) = state.schedule(scheduler, schedule_context) {
2588 0 : return InitialShardScheduleOutcome::ShardScheduleError(e);
2589 0 : }
2590 :
2591 : // Only include shards in result if we are attaching: the purpose
2592 : // of the response is to tell the caller where the shards are attached.
2593 0 : if let Some(node_id) = state.intent.get_attached() {
2594 0 : let generation = state
2595 0 : .generation
2596 0 : .expect("Generation is set when in attached mode");
2597 0 : InitialShardScheduleOutcome::Scheduled(TenantCreateResponseShard {
2598 0 : shard_id: tenant_shard_id,
2599 0 : node_id: *node_id,
2600 0 : generation: generation.into().unwrap(),
2601 0 : })
2602 : } else {
2603 0 : InitialShardScheduleOutcome::NotScheduled
2604 : }
2605 : }
2606 : }
2607 0 : }
2608 :
2609 : /// Helper for functions that reconcile a number of shards, and would like to do a timeout-bounded
2610 : /// wait for reconciliation to complete before responding.
2611 0 : async fn await_waiters(
2612 0 : &self,
2613 0 : waiters: Vec<ReconcilerWaiter>,
2614 0 : timeout: Duration,
2615 0 : ) -> Result<(), ReconcileWaitError> {
2616 0 : let deadline = Instant::now().checked_add(timeout).unwrap();
2617 0 : for waiter in waiters {
2618 0 : let timeout = deadline.duration_since(Instant::now());
2619 0 : waiter.wait_timeout(timeout).await?;
2620 : }
2621 :
2622 0 : Ok(())
2623 0 : }
2624 :
2625 : /// Same as [`Service::await_waiters`], but returns the waiters which are still
2626 : /// in progress
2627 0 : async fn await_waiters_remainder(
2628 0 : &self,
2629 0 : waiters: Vec<ReconcilerWaiter>,
2630 0 : timeout: Duration,
2631 0 : ) -> Vec<ReconcilerWaiter> {
2632 0 : let deadline = Instant::now().checked_add(timeout).unwrap();
2633 0 : for waiter in waiters.iter() {
2634 0 : let timeout = deadline.duration_since(Instant::now());
2635 0 : let _ = waiter.wait_timeout(timeout).await;
2636 : }
2637 :
2638 0 : waiters
2639 0 : .into_iter()
2640 0 : .filter(|waiter| matches!(waiter.get_status(), ReconcilerStatus::InProgress))
2641 0 : .collect::<Vec<_>>()
2642 0 : }
2643 :
2644 : /// Part of [`Self::tenant_location_config`]: dissect an incoming location config request,
2645 : /// and transform it into either a tenant creation of a series of shard updates.
2646 : ///
2647 : /// If the incoming request makes no changes, a [`TenantCreateOrUpdate::Update`] result will
2648 : /// still be returned.
2649 0 : fn tenant_location_config_prepare(
2650 0 : &self,
2651 0 : tenant_id: TenantId,
2652 0 : req: TenantLocationConfigRequest,
2653 0 : ) -> TenantCreateOrUpdate {
2654 0 : let mut updates = Vec::new();
2655 0 : let mut locked = self.inner.write().unwrap();
2656 0 : let (nodes, tenants, _scheduler) = locked.parts_mut();
2657 0 : let tenant_shard_id = TenantShardId::unsharded(tenant_id);
2658 :
2659 : // Use location config mode as an indicator of policy.
2660 0 : let placement_policy = match req.config.mode {
2661 0 : LocationConfigMode::Detached => PlacementPolicy::Detached,
2662 0 : LocationConfigMode::Secondary => PlacementPolicy::Secondary,
2663 : LocationConfigMode::AttachedMulti
2664 : | LocationConfigMode::AttachedSingle
2665 : | LocationConfigMode::AttachedStale => {
2666 0 : if nodes.len() > 1 {
2667 0 : PlacementPolicy::Attached(1)
2668 : } else {
2669 : // Convenience for dev/test: if we just have one pageserver, import
2670 : // tenants into non-HA mode so that scheduling will succeed.
2671 0 : PlacementPolicy::Attached(0)
2672 : }
2673 : }
2674 : };
2675 :
2676 : // Ordinarily we do not update scheduling policy, but when making major changes
2677 : // like detaching or demoting to secondary-only, we need to force the scheduling
2678 : // mode to Active, or the caller's expected outcome (detach it) will not happen.
2679 0 : let scheduling_policy = match req.config.mode {
2680 : LocationConfigMode::Detached | LocationConfigMode::Secondary => {
2681 : // Special case: when making major changes like detaching or demoting to secondary-only,
2682 : // we need to force the scheduling mode to Active, or nothing will happen.
2683 0 : Some(ShardSchedulingPolicy::Active)
2684 : }
2685 : LocationConfigMode::AttachedMulti
2686 : | LocationConfigMode::AttachedSingle
2687 : | LocationConfigMode::AttachedStale => {
2688 : // While attached, continue to respect whatever the existing scheduling mode is.
2689 0 : None
2690 : }
2691 : };
2692 :
2693 0 : let mut create = true;
2694 0 : for (shard_id, shard) in tenants.range_mut(TenantShardId::tenant_range(tenant_id)) {
2695 : // Saw an existing shard: this is not a creation
2696 0 : create = false;
2697 :
2698 : // Shards may have initially been created by a Secondary request, where we
2699 : // would have left generation as None.
2700 : //
2701 : // We only update generation the first time we see an attached-mode request,
2702 : // and if there is no existing generation set. The caller is responsible for
2703 : // ensuring that no non-storage-controller pageserver ever uses a higher
2704 : // generation than they passed in here.
2705 : use LocationConfigMode::*;
2706 0 : let set_generation = match req.config.mode {
2707 0 : AttachedMulti | AttachedSingle | AttachedStale if shard.generation.is_none() => {
2708 0 : req.config.generation.map(Generation::new)
2709 : }
2710 0 : _ => None,
2711 : };
2712 :
2713 0 : updates.push(ShardUpdate {
2714 0 : tenant_shard_id: *shard_id,
2715 0 : placement_policy: placement_policy.clone(),
2716 0 : tenant_config: req.config.tenant_conf.clone(),
2717 0 : generation: set_generation,
2718 0 : scheduling_policy,
2719 0 : });
2720 : }
2721 :
2722 0 : if create {
2723 : use LocationConfigMode::*;
2724 0 : let generation = match req.config.mode {
2725 0 : AttachedMulti | AttachedSingle | AttachedStale => req.config.generation,
2726 : // If a caller provided a generation in a non-attached request, ignore it
2727 : // and leave our generation as None: this enables a subsequent update to set
2728 : // the generation when setting an attached mode for the first time.
2729 0 : _ => None,
2730 : };
2731 :
2732 0 : TenantCreateOrUpdate::Create(
2733 0 : // Synthesize a creation request
2734 0 : TenantCreateRequest {
2735 0 : new_tenant_id: tenant_shard_id,
2736 0 : generation,
2737 0 : shard_parameters: ShardParameters {
2738 0 : count: tenant_shard_id.shard_count,
2739 0 : // We only import un-sharded or single-sharded tenants, so stripe
2740 0 : // size can be made up arbitrarily here.
2741 0 : stripe_size: ShardParameters::DEFAULT_STRIPE_SIZE,
2742 0 : },
2743 0 : placement_policy: Some(placement_policy),
2744 0 : config: req.config.tenant_conf,
2745 0 : },
2746 0 : )
2747 : } else {
2748 0 : assert!(!updates.is_empty());
2749 0 : TenantCreateOrUpdate::Update(updates)
2750 : }
2751 0 : }
2752 :
2753 : /// For APIs that might act on tenants with [`PlacementPolicy::Detached`], first check if
2754 : /// the tenant is present in memory. If not, load it from the database. If it is found
2755 : /// in neither location, return a NotFound error.
2756 : ///
2757 : /// Caller must demonstrate they hold a lock guard, as otherwise two callers might try and load
2758 : /// it at the same time, or we might race with [`Self::maybe_drop_tenant`]
2759 0 : async fn maybe_load_tenant(
2760 0 : &self,
2761 0 : tenant_id: TenantId,
2762 0 : _guard: &TracingExclusiveGuard<TenantOperations>,
2763 0 : ) -> Result<(), ApiError> {
2764 : // Check if the tenant is present in memory, and select an AZ to use when loading
2765 : // if we will load it.
2766 0 : let load_in_az = {
2767 0 : let locked = self.inner.read().unwrap();
2768 0 : let existing = locked
2769 0 : .tenants
2770 0 : .range(TenantShardId::tenant_range(tenant_id))
2771 0 : .next();
2772 0 :
2773 0 : // If the tenant is not present in memory, we expect to load it from database,
2774 0 : // so let's figure out what AZ to load it into while we have self.inner locked.
2775 0 : if existing.is_none() {
2776 0 : locked
2777 0 : .scheduler
2778 0 : .get_az_for_new_tenant()
2779 0 : .ok_or(ApiError::BadRequest(anyhow::anyhow!(
2780 0 : "No AZ with nodes found to load tenant"
2781 0 : )))?
2782 : } else {
2783 : // We already have this tenant in memory
2784 0 : return Ok(());
2785 : }
2786 : };
2787 :
2788 0 : let tenant_shards = self.persistence.load_tenant(tenant_id).await?;
2789 0 : if tenant_shards.is_empty() {
2790 0 : return Err(ApiError::NotFound(
2791 0 : anyhow::anyhow!("Tenant {} not found", tenant_id).into(),
2792 0 : ));
2793 0 : }
2794 0 :
2795 0 : // Update the persistent shards with the AZ that we are about to apply to in-memory state
2796 0 : self.persistence
2797 0 : .set_tenant_shard_preferred_azs(
2798 0 : tenant_shards
2799 0 : .iter()
2800 0 : .map(|t| {
2801 0 : (
2802 0 : t.get_tenant_shard_id().expect("Corrupt shard in database"),
2803 0 : Some(load_in_az.clone()),
2804 0 : )
2805 0 : })
2806 0 : .collect(),
2807 0 : )
2808 0 : .await?;
2809 :
2810 0 : let mut locked = self.inner.write().unwrap();
2811 0 : tracing::info!(
2812 0 : "Loaded {} shards for tenant {}",
2813 0 : tenant_shards.len(),
2814 : tenant_id
2815 : );
2816 :
2817 0 : locked.tenants.extend(tenant_shards.into_iter().map(|p| {
2818 0 : let intent = IntentState::new(Some(load_in_az.clone()));
2819 0 : let shard =
2820 0 : TenantShard::from_persistent(p, intent).expect("Corrupt shard row in database");
2821 0 :
2822 0 : // Sanity check: when loading on-demand, we should always be loaded something Detached
2823 0 : debug_assert!(shard.policy == PlacementPolicy::Detached);
2824 0 : if shard.policy != PlacementPolicy::Detached {
2825 0 : tracing::error!(
2826 0 : "Tenant shard {} loaded on-demand, but has non-Detached policy {:?}",
2827 : shard.tenant_shard_id,
2828 : shard.policy
2829 : );
2830 0 : }
2831 :
2832 0 : (shard.tenant_shard_id, shard)
2833 0 : }));
2834 0 :
2835 0 : Ok(())
2836 0 : }
2837 :
2838 : /// If all shards for a tenant are detached, and in a fully quiescent state (no observed locations on pageservers),
2839 : /// and have no reconciler running, then we can drop the tenant from memory. It will be reloaded on-demand
2840 : /// if we are asked to attach it again (see [`Self::maybe_load_tenant`]).
2841 : ///
2842 : /// Caller must demonstrate they hold a lock guard, as otherwise it is unsafe to drop a tenant from
2843 : /// memory while some other function might assume it continues to exist while not holding the lock on Self::inner.
2844 0 : fn maybe_drop_tenant(
2845 0 : &self,
2846 0 : tenant_id: TenantId,
2847 0 : locked: &mut std::sync::RwLockWriteGuard<ServiceState>,
2848 0 : _guard: &TracingExclusiveGuard<TenantOperations>,
2849 0 : ) {
2850 0 : let mut tenant_shards = locked.tenants.range(TenantShardId::tenant_range(tenant_id));
2851 0 : if tenant_shards.all(|(_id, shard)| {
2852 0 : shard.policy == PlacementPolicy::Detached
2853 0 : && shard.reconciler.is_none()
2854 0 : && shard.observed.is_empty()
2855 0 : }) {
2856 0 : let keys = locked
2857 0 : .tenants
2858 0 : .range(TenantShardId::tenant_range(tenant_id))
2859 0 : .map(|(id, _)| id)
2860 0 : .copied()
2861 0 : .collect::<Vec<_>>();
2862 0 : for key in keys {
2863 0 : tracing::info!("Dropping detached tenant shard {} from memory", key);
2864 0 : locked.tenants.remove(&key);
2865 : }
2866 0 : }
2867 0 : }
2868 :
2869 : /// This API is used by the cloud control plane to migrate unsharded tenants that it created
2870 : /// directly with pageservers into this service.
2871 : ///
2872 : /// Cloud control plane MUST NOT continue issuing GENERATION NUMBERS for this tenant once it
2873 : /// has attempted to call this API. Failure to oblige to this rule may lead to S3 corruption.
2874 : /// Think of the first attempt to call this API as a transfer of absolute authority over the
2875 : /// tenant's source of generation numbers.
2876 : ///
2877 : /// The mode in this request coarse-grained control of tenants:
2878 : /// - Call with mode Attached* to upsert the tenant.
2879 : /// - Call with mode Secondary to either onboard a tenant without attaching it, or
2880 : /// to set an existing tenant to PolicyMode::Secondary
2881 : /// - Call with mode Detached to switch to PolicyMode::Detached
2882 0 : pub(crate) async fn tenant_location_config(
2883 0 : &self,
2884 0 : tenant_shard_id: TenantShardId,
2885 0 : req: TenantLocationConfigRequest,
2886 0 : ) -> Result<TenantLocationConfigResponse, ApiError> {
2887 : // We require an exclusive lock, because we are updating both persistent and in-memory state
2888 0 : let _tenant_lock = trace_exclusive_lock(
2889 0 : &self.tenant_op_locks,
2890 0 : tenant_shard_id.tenant_id,
2891 0 : TenantOperations::LocationConfig,
2892 0 : )
2893 0 : .await;
2894 :
2895 0 : let tenant_id = if !tenant_shard_id.is_unsharded() {
2896 0 : return Err(ApiError::BadRequest(anyhow::anyhow!(
2897 0 : "This API is for importing single-sharded or unsharded tenants"
2898 0 : )));
2899 : } else {
2900 0 : tenant_shard_id.tenant_id
2901 0 : };
2902 0 :
2903 0 : // In case we are waking up a Detached tenant
2904 0 : match self.maybe_load_tenant(tenant_id, &_tenant_lock).await {
2905 0 : Ok(()) | Err(ApiError::NotFound(_)) => {
2906 0 : // This is a creation or an update
2907 0 : }
2908 0 : Err(e) => {
2909 0 : return Err(e);
2910 : }
2911 : };
2912 :
2913 : // First check if this is a creation or an update
2914 0 : let create_or_update = self.tenant_location_config_prepare(tenant_id, req);
2915 0 :
2916 0 : let mut result = TenantLocationConfigResponse {
2917 0 : shards: Vec::new(),
2918 0 : stripe_size: None,
2919 0 : };
2920 0 : let waiters = match create_or_update {
2921 0 : TenantCreateOrUpdate::Create(create_req) => {
2922 0 : let (create_resp, waiters) = self.do_tenant_create(create_req).await?;
2923 0 : result.shards = create_resp
2924 0 : .shards
2925 0 : .into_iter()
2926 0 : .map(|s| TenantShardLocation {
2927 0 : node_id: s.node_id,
2928 0 : shard_id: s.shard_id,
2929 0 : })
2930 0 : .collect();
2931 0 : waiters
2932 : }
2933 0 : TenantCreateOrUpdate::Update(updates) => {
2934 0 : // Persist updates
2935 0 : // Ordering: write to the database before applying changes in-memory, so that
2936 0 : // we will not appear time-travel backwards on a restart.
2937 0 :
2938 0 : let mut schedule_context = ScheduleContext::default();
2939 : for ShardUpdate {
2940 0 : tenant_shard_id,
2941 0 : placement_policy,
2942 0 : tenant_config,
2943 0 : generation,
2944 0 : scheduling_policy,
2945 0 : } in &updates
2946 : {
2947 0 : self.persistence
2948 0 : .update_tenant_shard(
2949 0 : TenantFilter::Shard(*tenant_shard_id),
2950 0 : Some(placement_policy.clone()),
2951 0 : Some(tenant_config.clone()),
2952 0 : *generation,
2953 0 : *scheduling_policy,
2954 0 : )
2955 0 : .await?;
2956 : }
2957 :
2958 : // Apply updates in-memory
2959 0 : let mut waiters = Vec::new();
2960 0 : {
2961 0 : let mut locked = self.inner.write().unwrap();
2962 0 : let (nodes, tenants, scheduler) = locked.parts_mut();
2963 :
2964 : for ShardUpdate {
2965 0 : tenant_shard_id,
2966 0 : placement_policy,
2967 0 : tenant_config,
2968 0 : generation: update_generation,
2969 0 : scheduling_policy,
2970 0 : } in updates
2971 : {
2972 0 : let Some(shard) = tenants.get_mut(&tenant_shard_id) else {
2973 0 : tracing::warn!("Shard {tenant_shard_id} removed while updating");
2974 0 : continue;
2975 : };
2976 :
2977 : // Update stripe size
2978 0 : if result.stripe_size.is_none() && shard.shard.count.count() > 1 {
2979 0 : result.stripe_size = Some(shard.shard.stripe_size);
2980 0 : }
2981 :
2982 0 : shard.policy = placement_policy;
2983 0 : shard.config = tenant_config;
2984 0 : if let Some(generation) = update_generation {
2985 0 : shard.generation = Some(generation);
2986 0 : }
2987 :
2988 0 : if let Some(scheduling_policy) = scheduling_policy {
2989 0 : shard.set_scheduling_policy(scheduling_policy);
2990 0 : }
2991 :
2992 0 : shard.schedule(scheduler, &mut schedule_context)?;
2993 :
2994 0 : let maybe_waiter =
2995 0 : self.maybe_reconcile_shard(shard, nodes, ReconcilerPriority::High);
2996 0 : if let Some(waiter) = maybe_waiter {
2997 0 : waiters.push(waiter);
2998 0 : }
2999 :
3000 0 : if let Some(node_id) = shard.intent.get_attached() {
3001 0 : result.shards.push(TenantShardLocation {
3002 0 : shard_id: tenant_shard_id,
3003 0 : node_id: *node_id,
3004 0 : })
3005 0 : }
3006 : }
3007 : }
3008 0 : waiters
3009 : }
3010 : };
3011 :
3012 0 : if let Err(e) = self.await_waiters(waiters, SHORT_RECONCILE_TIMEOUT).await {
3013 : // Do not treat a reconcile error as fatal: we have already applied any requested
3014 : // Intent changes, and the reconcile can fail for external reasons like unavailable
3015 : // compute notification API. In these cases, it is important that we do not
3016 : // cause the cloud control plane to retry forever on this API.
3017 0 : tracing::warn!(
3018 0 : "Failed to reconcile after /location_config: {e}, returning success anyway"
3019 : );
3020 0 : }
3021 :
3022 : // Logging the full result is useful because it lets us cross-check what the cloud control
3023 : // plane's tenant_shards table should contain.
3024 0 : tracing::info!("Complete, returning {result:?}");
3025 :
3026 0 : Ok(result)
3027 0 : }
3028 :
3029 0 : pub(crate) async fn tenant_config_patch(
3030 0 : &self,
3031 0 : req: TenantConfigPatchRequest,
3032 0 : ) -> Result<(), ApiError> {
3033 0 : let _tenant_lock = trace_exclusive_lock(
3034 0 : &self.tenant_op_locks,
3035 0 : req.tenant_id,
3036 0 : TenantOperations::ConfigPatch,
3037 0 : )
3038 0 : .await;
3039 :
3040 0 : let tenant_id = req.tenant_id;
3041 0 : let patch = req.config;
3042 0 :
3043 0 : self.maybe_load_tenant(tenant_id, &_tenant_lock).await?;
3044 :
3045 0 : let base = {
3046 0 : let locked = self.inner.read().unwrap();
3047 0 : let shards = locked
3048 0 : .tenants
3049 0 : .range(TenantShardId::tenant_range(req.tenant_id));
3050 0 :
3051 0 : let mut configs = shards.map(|(_sid, shard)| &shard.config).peekable();
3052 :
3053 0 : let first = match configs.peek() {
3054 0 : Some(first) => (*first).clone(),
3055 : None => {
3056 0 : return Err(ApiError::NotFound(
3057 0 : anyhow::anyhow!("Tenant {} not found", req.tenant_id).into(),
3058 0 : ));
3059 : }
3060 : };
3061 :
3062 0 : if !configs.all_equal() {
3063 0 : tracing::error!("Tenant configs for {} are mismatched. ", req.tenant_id);
3064 : // This can't happen because we atomically update the database records
3065 : // of all shards to the new value in [`Self::set_tenant_config_and_reconcile`].
3066 0 : return Err(ApiError::InternalServerError(anyhow::anyhow!(
3067 0 : "Tenant configs for {} are mismatched",
3068 0 : req.tenant_id
3069 0 : )));
3070 0 : }
3071 0 :
3072 0 : first
3073 : };
3074 :
3075 0 : let updated_config = base
3076 0 : .apply_patch(patch)
3077 0 : .map_err(|err| ApiError::BadRequest(anyhow::anyhow!(err)))?;
3078 0 : self.set_tenant_config_and_reconcile(tenant_id, updated_config)
3079 0 : .await
3080 0 : }
3081 :
3082 0 : pub(crate) async fn tenant_config_set(&self, req: TenantConfigRequest) -> Result<(), ApiError> {
3083 : // We require an exclusive lock, because we are updating persistent and in-memory state
3084 0 : let _tenant_lock = trace_exclusive_lock(
3085 0 : &self.tenant_op_locks,
3086 0 : req.tenant_id,
3087 0 : TenantOperations::ConfigSet,
3088 0 : )
3089 0 : .await;
3090 :
3091 0 : self.maybe_load_tenant(req.tenant_id, &_tenant_lock).await?;
3092 :
3093 0 : self.set_tenant_config_and_reconcile(req.tenant_id, req.config)
3094 0 : .await
3095 0 : }
3096 :
3097 0 : async fn set_tenant_config_and_reconcile(
3098 0 : &self,
3099 0 : tenant_id: TenantId,
3100 0 : config: TenantConfig,
3101 0 : ) -> Result<(), ApiError> {
3102 0 : self.persistence
3103 0 : .update_tenant_shard(
3104 0 : TenantFilter::Tenant(tenant_id),
3105 0 : None,
3106 0 : Some(config.clone()),
3107 0 : None,
3108 0 : None,
3109 0 : )
3110 0 : .await?;
3111 :
3112 0 : let waiters = {
3113 0 : let mut waiters = Vec::new();
3114 0 : let mut locked = self.inner.write().unwrap();
3115 0 : let (nodes, tenants, _scheduler) = locked.parts_mut();
3116 0 : for (_shard_id, shard) in tenants.range_mut(TenantShardId::tenant_range(tenant_id)) {
3117 0 : shard.config = config.clone();
3118 0 : if let Some(waiter) =
3119 0 : self.maybe_reconcile_shard(shard, nodes, ReconcilerPriority::High)
3120 0 : {
3121 0 : waiters.push(waiter);
3122 0 : }
3123 : }
3124 0 : waiters
3125 : };
3126 :
3127 0 : if let Err(e) = self.await_waiters(waiters, SHORT_RECONCILE_TIMEOUT).await {
3128 : // Treat this as success because we have stored the configuration. If e.g.
3129 : // a node was unavailable at this time, it should not stop us accepting a
3130 : // configuration change.
3131 0 : tracing::warn!(%tenant_id, "Accepted configuration update but reconciliation failed: {e}");
3132 0 : }
3133 :
3134 0 : Ok(())
3135 0 : }
3136 :
3137 0 : pub(crate) fn tenant_config_get(
3138 0 : &self,
3139 0 : tenant_id: TenantId,
3140 0 : ) -> Result<HashMap<&str, serde_json::Value>, ApiError> {
3141 0 : let config = {
3142 0 : let locked = self.inner.read().unwrap();
3143 0 :
3144 0 : match locked
3145 0 : .tenants
3146 0 : .range(TenantShardId::tenant_range(tenant_id))
3147 0 : .next()
3148 : {
3149 0 : Some((_tenant_shard_id, shard)) => shard.config.clone(),
3150 : None => {
3151 0 : return Err(ApiError::NotFound(
3152 0 : anyhow::anyhow!("Tenant not found").into(),
3153 0 : ));
3154 : }
3155 : }
3156 : };
3157 :
3158 : // Unlike the pageserver, we do not have a set of global defaults: the config is
3159 : // entirely per-tenant. Therefore the distinction between `tenant_specific_overrides`
3160 : // and `effective_config` in the response is meaningless, but we retain that syntax
3161 : // in order to remain compatible with the pageserver API.
3162 :
3163 0 : let response = HashMap::from([
3164 : (
3165 : "tenant_specific_overrides",
3166 0 : serde_json::to_value(&config)
3167 0 : .context("serializing tenant specific overrides")
3168 0 : .map_err(ApiError::InternalServerError)?,
3169 : ),
3170 : (
3171 0 : "effective_config",
3172 0 : serde_json::to_value(&config)
3173 0 : .context("serializing effective config")
3174 0 : .map_err(ApiError::InternalServerError)?,
3175 : ),
3176 : ]);
3177 :
3178 0 : Ok(response)
3179 0 : }
3180 :
3181 0 : pub(crate) async fn tenant_time_travel_remote_storage(
3182 0 : &self,
3183 0 : time_travel_req: &TenantTimeTravelRequest,
3184 0 : tenant_id: TenantId,
3185 0 : timestamp: Cow<'_, str>,
3186 0 : done_if_after: Cow<'_, str>,
3187 0 : ) -> Result<(), ApiError> {
3188 0 : let _tenant_lock = trace_exclusive_lock(
3189 0 : &self.tenant_op_locks,
3190 0 : tenant_id,
3191 0 : TenantOperations::TimeTravelRemoteStorage,
3192 0 : )
3193 0 : .await;
3194 :
3195 0 : let node = {
3196 0 : let mut locked = self.inner.write().unwrap();
3197 : // Just a sanity check to prevent misuse: the API expects that the tenant is fully
3198 : // detached everywhere, and nothing writes to S3 storage. Here, we verify that,
3199 : // but only at the start of the process, so it's really just to prevent operator
3200 : // mistakes.
3201 0 : for (shard_id, shard) in locked.tenants.range(TenantShardId::tenant_range(tenant_id)) {
3202 0 : if shard.intent.get_attached().is_some() || !shard.intent.get_secondary().is_empty()
3203 : {
3204 0 : return Err(ApiError::InternalServerError(anyhow::anyhow!(
3205 0 : "We want tenant to be attached in shard with tenant_shard_id={shard_id}"
3206 0 : )));
3207 0 : }
3208 0 : let maybe_attached = shard
3209 0 : .observed
3210 0 : .locations
3211 0 : .iter()
3212 0 : .filter_map(|(node_id, observed_location)| {
3213 0 : observed_location
3214 0 : .conf
3215 0 : .as_ref()
3216 0 : .map(|loc| (node_id, observed_location, loc.mode))
3217 0 : })
3218 0 : .find(|(_, _, mode)| *mode != LocationConfigMode::Detached);
3219 0 : if let Some((node_id, _observed_location, mode)) = maybe_attached {
3220 0 : return Err(ApiError::InternalServerError(anyhow::anyhow!(
3221 0 : "We observed attached={mode:?} tenant in node_id={node_id} shard with tenant_shard_id={shard_id}"
3222 0 : )));
3223 0 : }
3224 : }
3225 0 : let scheduler = &mut locked.scheduler;
3226 : // Right now we only perform the operation on a single node without parallelization
3227 : // TODO fan out the operation to multiple nodes for better performance
3228 0 : let node_id = scheduler.any_available_node()?;
3229 0 : let node = locked
3230 0 : .nodes
3231 0 : .get(&node_id)
3232 0 : .expect("Pageservers may not be deleted while lock is active");
3233 0 : node.clone()
3234 0 : };
3235 0 :
3236 0 : // The shard count is encoded in the remote storage's URL, so we need to handle all historically used shard counts
3237 0 : let mut counts = time_travel_req
3238 0 : .shard_counts
3239 0 : .iter()
3240 0 : .copied()
3241 0 : .collect::<HashSet<_>>()
3242 0 : .into_iter()
3243 0 : .collect::<Vec<_>>();
3244 0 : counts.sort_unstable();
3245 :
3246 0 : for count in counts {
3247 0 : let shard_ids = (0..count.count())
3248 0 : .map(|i| TenantShardId {
3249 0 : tenant_id,
3250 0 : shard_number: ShardNumber(i),
3251 0 : shard_count: count,
3252 0 : })
3253 0 : .collect::<Vec<_>>();
3254 0 : for tenant_shard_id in shard_ids {
3255 0 : let client = PageserverClient::new(
3256 0 : node.get_id(),
3257 0 : self.http_client.clone(),
3258 0 : node.base_url(),
3259 0 : self.config.pageserver_jwt_token.as_deref(),
3260 0 : );
3261 0 :
3262 0 : tracing::info!("Doing time travel recovery for shard {tenant_shard_id}",);
3263 :
3264 0 : client
3265 0 : .tenant_time_travel_remote_storage(
3266 0 : tenant_shard_id,
3267 0 : ×tamp,
3268 0 : &done_if_after,
3269 0 : )
3270 0 : .await
3271 0 : .map_err(|e| {
3272 0 : ApiError::InternalServerError(anyhow::anyhow!(
3273 0 : "Error doing time travel recovery for shard {tenant_shard_id} on node {}: {e}",
3274 0 : node
3275 0 : ))
3276 0 : })?;
3277 : }
3278 : }
3279 0 : Ok(())
3280 0 : }
3281 :
3282 0 : pub(crate) async fn tenant_secondary_download(
3283 0 : &self,
3284 0 : tenant_id: TenantId,
3285 0 : wait: Option<Duration>,
3286 0 : ) -> Result<(StatusCode, SecondaryProgress), ApiError> {
3287 0 : let _tenant_lock = trace_shared_lock(
3288 0 : &self.tenant_op_locks,
3289 0 : tenant_id,
3290 0 : TenantOperations::SecondaryDownload,
3291 0 : )
3292 0 : .await;
3293 :
3294 : // Acquire lock and yield the collection of shard-node tuples which we will send requests onward to
3295 0 : let targets = {
3296 0 : let locked = self.inner.read().unwrap();
3297 0 : let mut targets = Vec::new();
3298 :
3299 0 : for (tenant_shard_id, shard) in
3300 0 : locked.tenants.range(TenantShardId::tenant_range(tenant_id))
3301 : {
3302 0 : for node_id in shard.intent.get_secondary() {
3303 0 : let node = locked
3304 0 : .nodes
3305 0 : .get(node_id)
3306 0 : .expect("Pageservers may not be deleted while referenced");
3307 0 :
3308 0 : targets.push((*tenant_shard_id, node.clone()));
3309 0 : }
3310 : }
3311 0 : targets
3312 0 : };
3313 0 :
3314 0 : // Issue concurrent requests to all shards' locations
3315 0 : let mut futs = FuturesUnordered::new();
3316 0 : for (tenant_shard_id, node) in targets {
3317 0 : let client = PageserverClient::new(
3318 0 : node.get_id(),
3319 0 : self.http_client.clone(),
3320 0 : node.base_url(),
3321 0 : self.config.pageserver_jwt_token.as_deref(),
3322 0 : );
3323 0 : futs.push(async move {
3324 0 : let result = client
3325 0 : .tenant_secondary_download(tenant_shard_id, wait)
3326 0 : .await;
3327 0 : (result, node, tenant_shard_id)
3328 0 : })
3329 : }
3330 :
3331 : // Handle any errors returned by pageservers. This includes cases like this request racing with
3332 : // a scheduling operation, such that the tenant shard we're calling doesn't exist on that pageserver any more, as
3333 : // well as more general cases like 503s, 500s, or timeouts.
3334 0 : let mut aggregate_progress = SecondaryProgress::default();
3335 0 : let mut aggregate_status: Option<StatusCode> = None;
3336 0 : let mut error: Option<mgmt_api::Error> = None;
3337 0 : while let Some((result, node, tenant_shard_id)) = futs.next().await {
3338 0 : match result {
3339 0 : Err(e) => {
3340 0 : // Secondary downloads are always advisory: if something fails, we nevertheless report success, so that whoever
3341 0 : // is calling us will proceed with whatever migration they're doing, albeit with a slightly less warm cache
3342 0 : // than they had hoped for.
3343 0 : tracing::warn!("Secondary download error from pageserver {node}: {e}",);
3344 0 : error = Some(e)
3345 : }
3346 0 : Ok((status_code, progress)) => {
3347 0 : tracing::info!(%tenant_shard_id, "Shard status={status_code} progress: {progress:?}");
3348 0 : aggregate_progress.layers_downloaded += progress.layers_downloaded;
3349 0 : aggregate_progress.layers_total += progress.layers_total;
3350 0 : aggregate_progress.bytes_downloaded += progress.bytes_downloaded;
3351 0 : aggregate_progress.bytes_total += progress.bytes_total;
3352 0 : aggregate_progress.heatmap_mtime =
3353 0 : std::cmp::max(aggregate_progress.heatmap_mtime, progress.heatmap_mtime);
3354 0 : aggregate_status = match aggregate_status {
3355 0 : None => Some(status_code),
3356 0 : Some(StatusCode::OK) => Some(status_code),
3357 0 : Some(cur) => {
3358 0 : // Other status codes (e.g. 202) -- do not overwrite.
3359 0 : Some(cur)
3360 : }
3361 : };
3362 : }
3363 : }
3364 : }
3365 :
3366 : // If any of the shards return 202, indicate our result as 202.
3367 0 : match aggregate_status {
3368 : None => {
3369 0 : match error {
3370 0 : Some(e) => {
3371 0 : // No successes, and an error: surface it
3372 0 : Err(ApiError::Conflict(format!("Error from pageserver: {e}")))
3373 : }
3374 : None => {
3375 : // No shards found
3376 0 : Err(ApiError::NotFound(
3377 0 : anyhow::anyhow!("Tenant {} not found", tenant_id).into(),
3378 0 : ))
3379 : }
3380 : }
3381 : }
3382 0 : Some(aggregate_status) => Ok((aggregate_status, aggregate_progress)),
3383 : }
3384 0 : }
3385 :
3386 0 : pub(crate) async fn tenant_delete(
3387 0 : self: &Arc<Self>,
3388 0 : tenant_id: TenantId,
3389 0 : ) -> Result<StatusCode, ApiError> {
3390 0 : let _tenant_lock =
3391 0 : trace_exclusive_lock(&self.tenant_op_locks, tenant_id, TenantOperations::Delete).await;
3392 :
3393 0 : self.maybe_load_tenant(tenant_id, &_tenant_lock).await?;
3394 :
3395 : // Detach all shards. This also deletes local pageserver shard data.
3396 0 : let (detach_waiters, node) = {
3397 0 : let mut detach_waiters = Vec::new();
3398 0 : let mut locked = self.inner.write().unwrap();
3399 0 : let (nodes, tenants, scheduler) = locked.parts_mut();
3400 0 : for (_, shard) in tenants.range_mut(TenantShardId::tenant_range(tenant_id)) {
3401 : // Update the tenant's intent to remove all attachments
3402 0 : shard.policy = PlacementPolicy::Detached;
3403 0 : shard
3404 0 : .schedule(scheduler, &mut ScheduleContext::default())
3405 0 : .expect("De-scheduling is infallible");
3406 0 : debug_assert!(shard.intent.get_attached().is_none());
3407 0 : debug_assert!(shard.intent.get_secondary().is_empty());
3408 :
3409 0 : if let Some(waiter) =
3410 0 : self.maybe_reconcile_shard(shard, nodes, ReconcilerPriority::High)
3411 0 : {
3412 0 : detach_waiters.push(waiter);
3413 0 : }
3414 : }
3415 :
3416 : // Pick an arbitrary node to use for remote deletions (does not have to be where the tenant
3417 : // was attached, just has to be able to see the S3 content)
3418 0 : let node_id = scheduler.any_available_node()?;
3419 0 : let node = nodes
3420 0 : .get(&node_id)
3421 0 : .expect("Pageservers may not be deleted while lock is active");
3422 0 : (detach_waiters, node.clone())
3423 0 : };
3424 0 :
3425 0 : // This reconcile wait can fail in a few ways:
3426 0 : // A there is a very long queue for the reconciler semaphore
3427 0 : // B some pageserver is failing to handle a detach promptly
3428 0 : // C some pageserver goes offline right at the moment we send it a request.
3429 0 : //
3430 0 : // A and C are transient: the semaphore will eventually become available, and once a node is marked offline
3431 0 : // the next attempt to reconcile will silently skip detaches for an offline node and succeed. If B happens,
3432 0 : // it's a bug, and needs resolving at the pageserver level (we shouldn't just leave attachments behind while
3433 0 : // deleting the underlying data).
3434 0 : self.await_waiters(detach_waiters, RECONCILE_TIMEOUT)
3435 0 : .await?;
3436 :
3437 : // Delete the entire tenant (all shards) from remote storage via a random pageserver.
3438 : // Passing an unsharded tenant ID will cause the pageserver to remove all remote paths with
3439 : // the tenant ID prefix, including all shards (even possibly stale ones).
3440 0 : match node
3441 0 : .with_client_retries(
3442 0 : |client| async move {
3443 0 : client
3444 0 : .tenant_delete(TenantShardId::unsharded(tenant_id))
3445 0 : .await
3446 0 : },
3447 0 : &self.http_client,
3448 0 : &self.config.pageserver_jwt_token,
3449 0 : 1,
3450 0 : 3,
3451 0 : RECONCILE_TIMEOUT,
3452 0 : &self.cancel,
3453 0 : )
3454 0 : .await
3455 0 : .unwrap_or(Err(mgmt_api::Error::Cancelled))
3456 : {
3457 0 : Ok(_) => {}
3458 : Err(mgmt_api::Error::Cancelled) => {
3459 0 : return Err(ApiError::ShuttingDown);
3460 : }
3461 0 : Err(e) => {
3462 0 : // This is unexpected: remote deletion should be infallible, unless the object store
3463 0 : // at large is unavailable.
3464 0 : tracing::error!("Error deleting via node {node}: {e}");
3465 0 : return Err(ApiError::InternalServerError(anyhow::anyhow!(e)));
3466 : }
3467 : }
3468 :
3469 : // Fall through: deletion of the tenant on pageservers is complete, we may proceed to drop
3470 : // our in-memory state and database state.
3471 :
3472 : // Ordering: we delete persistent state first: if we then
3473 : // crash, we will drop the in-memory state.
3474 :
3475 : // Drop persistent state.
3476 0 : self.persistence.delete_tenant(tenant_id).await?;
3477 :
3478 : // Drop in-memory state
3479 : {
3480 0 : let mut locked = self.inner.write().unwrap();
3481 0 : let (_nodes, tenants, scheduler) = locked.parts_mut();
3482 :
3483 : // Dereference Scheduler from shards before dropping them
3484 0 : for (_tenant_shard_id, shard) in
3485 0 : tenants.range_mut(TenantShardId::tenant_range(tenant_id))
3486 0 : {
3487 0 : shard.intent.clear(scheduler);
3488 0 : }
3489 :
3490 0 : tenants.retain(|tenant_shard_id, _shard| tenant_shard_id.tenant_id != tenant_id);
3491 0 : tracing::info!(
3492 0 : "Deleted tenant {tenant_id}, now have {} tenants",
3493 0 : locked.tenants.len()
3494 : );
3495 : };
3496 :
3497 : // Delete the tenant from safekeepers (if needed)
3498 0 : self.tenant_delete_safekeepers(tenant_id)
3499 0 : .instrument(tracing::info_span!("tenant_delete_safekeepers", %tenant_id))
3500 0 : .await?;
3501 :
3502 : // Success is represented as 404, to imitate the existing pageserver deletion API
3503 0 : Ok(StatusCode::NOT_FOUND)
3504 0 : }
3505 :
3506 : /// Naming: this configures the storage controller's policies for a tenant, whereas [`Self::tenant_config_set`] is "set the TenantConfig"
3507 : /// for a tenant. The TenantConfig is passed through to pageservers, whereas this function modifies
3508 : /// the tenant's policies (configuration) within the storage controller
3509 0 : pub(crate) async fn tenant_update_policy(
3510 0 : &self,
3511 0 : tenant_id: TenantId,
3512 0 : req: TenantPolicyRequest,
3513 0 : ) -> Result<(), ApiError> {
3514 : // We require an exclusive lock, because we are updating persistent and in-memory state
3515 0 : let _tenant_lock = trace_exclusive_lock(
3516 0 : &self.tenant_op_locks,
3517 0 : tenant_id,
3518 0 : TenantOperations::UpdatePolicy,
3519 0 : )
3520 0 : .await;
3521 :
3522 0 : self.maybe_load_tenant(tenant_id, &_tenant_lock).await?;
3523 :
3524 0 : failpoint_support::sleep_millis_async!("tenant-update-policy-exclusive-lock");
3525 :
3526 : let TenantPolicyRequest {
3527 0 : placement,
3528 0 : mut scheduling,
3529 0 : } = req;
3530 :
3531 0 : if let Some(PlacementPolicy::Detached | PlacementPolicy::Secondary) = placement {
3532 : // When someone configures a tenant to detach, we force the scheduling policy to enable
3533 : // this to take effect.
3534 0 : if scheduling.is_none() {
3535 0 : scheduling = Some(ShardSchedulingPolicy::Active);
3536 0 : }
3537 0 : }
3538 :
3539 0 : self.persistence
3540 0 : .update_tenant_shard(
3541 0 : TenantFilter::Tenant(tenant_id),
3542 0 : placement.clone(),
3543 0 : None,
3544 0 : None,
3545 0 : scheduling,
3546 0 : )
3547 0 : .await?;
3548 :
3549 0 : let mut schedule_context = ScheduleContext::default();
3550 0 : let mut locked = self.inner.write().unwrap();
3551 0 : let (nodes, tenants, scheduler) = locked.parts_mut();
3552 0 : for (shard_id, shard) in tenants.range_mut(TenantShardId::tenant_range(tenant_id)) {
3553 0 : if let Some(placement) = &placement {
3554 0 : shard.policy = placement.clone();
3555 0 :
3556 0 : tracing::info!(tenant_id=%shard_id.tenant_id, shard_id=%shard_id.shard_slug(),
3557 0 : "Updated placement policy to {placement:?}");
3558 0 : }
3559 :
3560 0 : if let Some(scheduling) = &scheduling {
3561 0 : shard.set_scheduling_policy(*scheduling);
3562 0 :
3563 0 : tracing::info!(tenant_id=%shard_id.tenant_id, shard_id=%shard_id.shard_slug(),
3564 0 : "Updated scheduling policy to {scheduling:?}");
3565 0 : }
3566 :
3567 : // In case scheduling is being switched back on, try it now.
3568 0 : shard.schedule(scheduler, &mut schedule_context).ok();
3569 0 : self.maybe_reconcile_shard(shard, nodes, ReconcilerPriority::High);
3570 : }
3571 :
3572 0 : Ok(())
3573 0 : }
3574 :
3575 0 : pub(crate) async fn tenant_timeline_create_pageservers(
3576 0 : &self,
3577 0 : tenant_id: TenantId,
3578 0 : mut create_req: TimelineCreateRequest,
3579 0 : ) -> Result<TimelineInfo, ApiError> {
3580 0 : tracing::info!(
3581 0 : "Creating timeline {}/{}",
3582 : tenant_id,
3583 : create_req.new_timeline_id,
3584 : );
3585 :
3586 0 : self.tenant_remote_mutation(tenant_id, move |mut targets| async move {
3587 0 : if targets.0.is_empty() {
3588 0 : return Err(ApiError::NotFound(
3589 0 : anyhow::anyhow!("Tenant not found").into(),
3590 0 : ));
3591 0 : };
3592 0 :
3593 0 : let (shard_zero_tid, shard_zero_locations) =
3594 0 : targets.0.pop_first().expect("Must have at least one shard");
3595 0 : assert!(shard_zero_tid.is_shard_zero());
3596 :
3597 0 : async fn create_one(
3598 0 : tenant_shard_id: TenantShardId,
3599 0 : locations: ShardMutationLocations,
3600 0 : http_client: reqwest::Client,
3601 0 : jwt: Option<String>,
3602 0 : create_req: TimelineCreateRequest,
3603 0 : ) -> Result<TimelineInfo, ApiError> {
3604 0 : let latest = locations.latest.node;
3605 0 :
3606 0 : tracing::info!(
3607 0 : "Creating timeline on shard {}/{}, attached to node {latest} in generation {:?}",
3608 : tenant_shard_id,
3609 : create_req.new_timeline_id,
3610 : locations.latest.generation
3611 : );
3612 :
3613 0 : let client =
3614 0 : PageserverClient::new(latest.get_id(), http_client.clone(), latest.base_url(), jwt.as_deref());
3615 :
3616 0 : let timeline_info = client
3617 0 : .timeline_create(tenant_shard_id, &create_req)
3618 0 : .await
3619 0 : .map_err(|e| passthrough_api_error(&latest, e))?;
3620 :
3621 : // We propagate timeline creations to all attached locations such that a compute
3622 : // for the new timeline is able to start regardless of the current state of the
3623 : // tenant shard reconciliation.
3624 0 : for location in locations.other {
3625 0 : tracing::info!(
3626 0 : "Creating timeline on shard {}/{}, stale attached to node {} in generation {:?}",
3627 : tenant_shard_id,
3628 : create_req.new_timeline_id,
3629 : location.node,
3630 : location.generation
3631 : );
3632 :
3633 0 : let client = PageserverClient::new(
3634 0 : location.node.get_id(),
3635 0 : http_client.clone(),
3636 0 : location.node.base_url(),
3637 0 : jwt.as_deref(),
3638 0 : );
3639 :
3640 0 : let res = client
3641 0 : .timeline_create(tenant_shard_id, &create_req)
3642 0 : .await;
3643 :
3644 0 : if let Err(e) = res {
3645 0 : match e {
3646 0 : mgmt_api::Error::ApiError(StatusCode::NOT_FOUND, _) => {
3647 0 : // Tenant might have been detached from the stale location,
3648 0 : // so ignore 404s.
3649 0 : },
3650 : _ => {
3651 0 : return Err(passthrough_api_error(&location.node, e));
3652 : }
3653 : }
3654 0 : }
3655 : }
3656 :
3657 0 : Ok(timeline_info)
3658 0 : }
3659 :
3660 : // Because the caller might not provide an explicit LSN, we must do the creation first on a single shard, and then
3661 : // use whatever LSN that shard picked when creating on subsequent shards. We arbitrarily use shard zero as the shard
3662 : // that will get the first creation request, and propagate the LSN to all the >0 shards.
3663 0 : let timeline_info = create_one(
3664 0 : shard_zero_tid,
3665 0 : shard_zero_locations,
3666 0 : self.http_client.clone(),
3667 0 : self.config.pageserver_jwt_token.clone(),
3668 0 : create_req.clone(),
3669 0 : )
3670 0 : .await?;
3671 :
3672 : // Propagate the LSN that shard zero picked, if caller didn't provide one
3673 0 : match &mut create_req.mode {
3674 0 : models::TimelineCreateRequestMode::Branch { ancestor_start_lsn, .. } if ancestor_start_lsn.is_none() => {
3675 0 : *ancestor_start_lsn = timeline_info.ancestor_lsn;
3676 0 : },
3677 0 : _ => {}
3678 : }
3679 :
3680 : // Create timeline on remaining shards with number >0
3681 0 : if !targets.0.is_empty() {
3682 : // If we had multiple shards, issue requests for the remainder now.
3683 0 : let jwt = &self.config.pageserver_jwt_token;
3684 0 : self.tenant_for_shards(
3685 0 : targets
3686 0 : .0
3687 0 : .iter()
3688 0 : .map(|t| (*t.0, t.1.latest.node.clone()))
3689 0 : .collect(),
3690 0 : |tenant_shard_id: TenantShardId, _node: Node| {
3691 0 : let create_req = create_req.clone();
3692 0 : let mutation_locations = targets.0.remove(&tenant_shard_id).unwrap();
3693 0 : Box::pin(create_one(
3694 0 : tenant_shard_id,
3695 0 : mutation_locations,
3696 0 : self.http_client.clone(),
3697 0 : jwt.clone(),
3698 0 : create_req,
3699 0 : ))
3700 0 : },
3701 0 : )
3702 0 : .await?;
3703 0 : }
3704 :
3705 0 : Ok(timeline_info)
3706 0 : })
3707 0 : .await?
3708 0 : }
3709 :
3710 0 : pub(crate) async fn tenant_timeline_create(
3711 0 : self: &Arc<Self>,
3712 0 : tenant_id: TenantId,
3713 0 : create_req: TimelineCreateRequest,
3714 0 : ) -> Result<TimelineCreateResponseStorcon, ApiError> {
3715 0 : let safekeepers = self.config.timelines_onto_safekeepers;
3716 0 : tracing::info!(
3717 : %safekeepers,
3718 0 : "Creating timeline {}/{}",
3719 : tenant_id,
3720 : create_req.new_timeline_id,
3721 : );
3722 :
3723 0 : let _tenant_lock = trace_shared_lock(
3724 0 : &self.tenant_op_locks,
3725 0 : tenant_id,
3726 0 : TenantOperations::TimelineCreate,
3727 0 : )
3728 0 : .await;
3729 0 : failpoint_support::sleep_millis_async!("tenant-create-timeline-shared-lock");
3730 0 : let create_mode = create_req.mode.clone();
3731 :
3732 0 : let timeline_info = self
3733 0 : .tenant_timeline_create_pageservers(tenant_id, create_req)
3734 0 : .await?;
3735 :
3736 0 : let safekeepers = if safekeepers {
3737 0 : let res = self
3738 0 : .tenant_timeline_create_safekeepers(tenant_id, &timeline_info, create_mode)
3739 0 : .instrument(tracing::info_span!("timeline_create_safekeepers", %tenant_id, timeline_id=%timeline_info.timeline_id))
3740 0 : .await?;
3741 0 : Some(res)
3742 : } else {
3743 0 : None
3744 : };
3745 :
3746 0 : Ok(TimelineCreateResponseStorcon {
3747 0 : timeline_info,
3748 0 : safekeepers,
3749 0 : })
3750 0 : }
3751 :
3752 0 : pub(crate) async fn tenant_timeline_archival_config(
3753 0 : &self,
3754 0 : tenant_id: TenantId,
3755 0 : timeline_id: TimelineId,
3756 0 : req: TimelineArchivalConfigRequest,
3757 0 : ) -> Result<(), ApiError> {
3758 0 : tracing::info!(
3759 0 : "Setting archival config of timeline {tenant_id}/{timeline_id} to '{:?}'",
3760 : req.state
3761 : );
3762 :
3763 0 : let _tenant_lock = trace_shared_lock(
3764 0 : &self.tenant_op_locks,
3765 0 : tenant_id,
3766 0 : TenantOperations::TimelineArchivalConfig,
3767 0 : )
3768 0 : .await;
3769 :
3770 0 : self.tenant_remote_mutation(tenant_id, move |targets| async move {
3771 0 : if targets.0.is_empty() {
3772 0 : return Err(ApiError::NotFound(
3773 0 : anyhow::anyhow!("Tenant not found").into(),
3774 0 : ));
3775 0 : }
3776 0 : async fn config_one(
3777 0 : tenant_shard_id: TenantShardId,
3778 0 : timeline_id: TimelineId,
3779 0 : node: Node,
3780 0 : http_client: reqwest::Client,
3781 0 : jwt: Option<String>,
3782 0 : req: TimelineArchivalConfigRequest,
3783 0 : ) -> Result<(), ApiError> {
3784 0 : tracing::info!(
3785 0 : "Setting archival config of timeline on shard {tenant_shard_id}/{timeline_id}, attached to node {node}",
3786 : );
3787 :
3788 0 : let client = PageserverClient::new(node.get_id(), http_client, node.base_url(), jwt.as_deref());
3789 0 :
3790 0 : client
3791 0 : .timeline_archival_config(tenant_shard_id, timeline_id, &req)
3792 0 : .await
3793 0 : .map_err(|e| match e {
3794 0 : mgmt_api::Error::ApiError(StatusCode::PRECONDITION_FAILED, msg) => {
3795 0 : ApiError::PreconditionFailed(msg.into_boxed_str())
3796 : }
3797 0 : _ => passthrough_api_error(&node, e),
3798 0 : })
3799 0 : }
3800 :
3801 : // no shard needs to go first/last; the operation should be idempotent
3802 : // TODO: it would be great to ensure that all shards return the same error
3803 0 : let locations = targets.0.iter().map(|t| (*t.0, t.1.latest.node.clone())).collect();
3804 0 : let results = self
3805 0 : .tenant_for_shards(locations, |tenant_shard_id, node| {
3806 0 : futures::FutureExt::boxed(config_one(
3807 0 : tenant_shard_id,
3808 0 : timeline_id,
3809 0 : node,
3810 0 : self.http_client.clone(),
3811 0 : self.config.pageserver_jwt_token.clone(),
3812 0 : req.clone(),
3813 0 : ))
3814 0 : })
3815 0 : .await?;
3816 0 : assert!(!results.is_empty(), "must have at least one result");
3817 :
3818 0 : Ok(())
3819 0 : }).await?
3820 0 : }
3821 :
3822 0 : pub(crate) async fn tenant_timeline_detach_ancestor(
3823 0 : &self,
3824 0 : tenant_id: TenantId,
3825 0 : timeline_id: TimelineId,
3826 0 : behavior: Option<DetachBehavior>,
3827 0 : ) -> Result<models::detach_ancestor::AncestorDetached, ApiError> {
3828 0 : tracing::info!("Detaching timeline {tenant_id}/{timeline_id}",);
3829 :
3830 0 : let _tenant_lock = trace_shared_lock(
3831 0 : &self.tenant_op_locks,
3832 0 : tenant_id,
3833 0 : TenantOperations::TimelineDetachAncestor,
3834 0 : )
3835 0 : .await;
3836 :
3837 0 : self.tenant_remote_mutation(tenant_id, move |targets| async move {
3838 0 : if targets.0.is_empty() {
3839 0 : return Err(ApiError::NotFound(
3840 0 : anyhow::anyhow!("Tenant not found").into(),
3841 0 : ));
3842 0 : }
3843 :
3844 0 : async fn detach_one(
3845 0 : tenant_shard_id: TenantShardId,
3846 0 : timeline_id: TimelineId,
3847 0 : node: Node,
3848 0 : http_client: reqwest::Client,
3849 0 : jwt: Option<String>,
3850 0 : behavior: Option<DetachBehavior>,
3851 0 : ) -> Result<(ShardNumber, models::detach_ancestor::AncestorDetached), ApiError> {
3852 0 : tracing::info!(
3853 0 : "Detaching timeline on shard {tenant_shard_id}/{timeline_id}, attached to node {node}",
3854 : );
3855 :
3856 0 : let client = PageserverClient::new(node.get_id(), http_client, node.base_url(), jwt.as_deref());
3857 0 :
3858 0 : client
3859 0 : .timeline_detach_ancestor(tenant_shard_id, timeline_id, behavior)
3860 0 : .await
3861 0 : .map_err(|e| {
3862 : use mgmt_api::Error;
3863 :
3864 0 : match e {
3865 : // no ancestor (ever)
3866 0 : Error::ApiError(StatusCode::CONFLICT, msg) => ApiError::Conflict(format!(
3867 0 : "{node}: {}",
3868 0 : msg.strip_prefix("Conflict: ").unwrap_or(&msg)
3869 0 : )),
3870 : // too many ancestors
3871 0 : Error::ApiError(StatusCode::BAD_REQUEST, msg) => {
3872 0 : ApiError::BadRequest(anyhow::anyhow!("{node}: {msg}"))
3873 : }
3874 0 : Error::ApiError(StatusCode::INTERNAL_SERVER_ERROR, msg) => {
3875 0 : // avoid turning these into conflicts to remain compatible with
3876 0 : // pageservers, 500 errors are sadly retryable with timeline ancestor
3877 0 : // detach
3878 0 : ApiError::InternalServerError(anyhow::anyhow!("{node}: {msg}"))
3879 : }
3880 : // rest can be mapped as usual
3881 0 : other => passthrough_api_error(&node, other),
3882 : }
3883 0 : })
3884 0 : .map(|res| (tenant_shard_id.shard_number, res))
3885 0 : }
3886 :
3887 : // no shard needs to go first/last; the operation should be idempotent
3888 0 : let locations = targets.0.iter().map(|t| (*t.0, t.1.latest.node.clone())).collect();
3889 0 : let mut results = self
3890 0 : .tenant_for_shards(locations, |tenant_shard_id, node| {
3891 0 : futures::FutureExt::boxed(detach_one(
3892 0 : tenant_shard_id,
3893 0 : timeline_id,
3894 0 : node,
3895 0 : self.http_client.clone(),
3896 0 : self.config.pageserver_jwt_token.clone(),
3897 0 : behavior,
3898 0 : ))
3899 0 : })
3900 0 : .await?;
3901 :
3902 0 : let any = results.pop().expect("we must have at least one response");
3903 0 :
3904 0 : let mismatching = results
3905 0 : .iter()
3906 0 : .filter(|(_, res)| res != &any.1)
3907 0 : .collect::<Vec<_>>();
3908 0 : if !mismatching.is_empty() {
3909 : // this can be hit by races which should not happen because operation lock on cplane
3910 0 : let matching = results.len() - mismatching.len();
3911 0 : tracing::error!(
3912 : matching,
3913 : compared_against=?any,
3914 : ?mismatching,
3915 0 : "shards returned different results"
3916 : );
3917 :
3918 0 : return Err(ApiError::InternalServerError(anyhow::anyhow!("pageservers returned mixed results for ancestor detach; manual intervention is required.")));
3919 0 : }
3920 0 :
3921 0 : Ok(any.1)
3922 0 : }).await?
3923 0 : }
3924 :
3925 0 : pub(crate) async fn tenant_timeline_block_unblock_gc(
3926 0 : &self,
3927 0 : tenant_id: TenantId,
3928 0 : timeline_id: TimelineId,
3929 0 : dir: BlockUnblock,
3930 0 : ) -> Result<(), ApiError> {
3931 0 : let _tenant_lock = trace_shared_lock(
3932 0 : &self.tenant_op_locks,
3933 0 : tenant_id,
3934 0 : TenantOperations::TimelineGcBlockUnblock,
3935 0 : )
3936 0 : .await;
3937 :
3938 0 : self.tenant_remote_mutation(tenant_id, move |targets| async move {
3939 0 : if targets.0.is_empty() {
3940 0 : return Err(ApiError::NotFound(
3941 0 : anyhow::anyhow!("Tenant not found").into(),
3942 0 : ));
3943 0 : }
3944 :
3945 0 : async fn do_one(
3946 0 : tenant_shard_id: TenantShardId,
3947 0 : timeline_id: TimelineId,
3948 0 : node: Node,
3949 0 : http_client: reqwest::Client,
3950 0 : jwt: Option<String>,
3951 0 : dir: BlockUnblock,
3952 0 : ) -> Result<(), ApiError> {
3953 0 : let client = PageserverClient::new(
3954 0 : node.get_id(),
3955 0 : http_client,
3956 0 : node.base_url(),
3957 0 : jwt.as_deref(),
3958 0 : );
3959 0 :
3960 0 : client
3961 0 : .timeline_block_unblock_gc(tenant_shard_id, timeline_id, dir)
3962 0 : .await
3963 0 : .map_err(|e| passthrough_api_error(&node, e))
3964 0 : }
3965 :
3966 : // no shard needs to go first/last; the operation should be idempotent
3967 0 : let locations = targets
3968 0 : .0
3969 0 : .iter()
3970 0 : .map(|t| (*t.0, t.1.latest.node.clone()))
3971 0 : .collect();
3972 0 : self.tenant_for_shards(locations, |tenant_shard_id, node| {
3973 0 : futures::FutureExt::boxed(do_one(
3974 0 : tenant_shard_id,
3975 0 : timeline_id,
3976 0 : node,
3977 0 : self.http_client.clone(),
3978 0 : self.config.pageserver_jwt_token.clone(),
3979 0 : dir,
3980 0 : ))
3981 0 : })
3982 0 : .await
3983 0 : })
3984 0 : .await??;
3985 0 : Ok(())
3986 0 : }
3987 :
3988 0 : pub(crate) async fn tenant_timeline_download_heatmap_layers(
3989 0 : &self,
3990 0 : tenant_shard_id: TenantShardId,
3991 0 : timeline_id: TimelineId,
3992 0 : concurrency: Option<usize>,
3993 0 : recurse: bool,
3994 0 : ) -> Result<(), ApiError> {
3995 0 : let _tenant_lock = trace_shared_lock(
3996 0 : &self.tenant_op_locks,
3997 0 : tenant_shard_id.tenant_id,
3998 0 : TenantOperations::DownloadHeatmapLayers,
3999 0 : )
4000 0 : .await;
4001 :
4002 0 : let targets = {
4003 0 : let locked = self.inner.read().unwrap();
4004 0 : let mut targets = Vec::new();
4005 :
4006 : // If the request got an unsharded tenant id, then apply
4007 : // the operation to all shards. Otherwise, apply it to a specific shard.
4008 0 : let shards_range = if tenant_shard_id.is_unsharded() {
4009 0 : TenantShardId::tenant_range(tenant_shard_id.tenant_id)
4010 : } else {
4011 0 : tenant_shard_id.range()
4012 : };
4013 :
4014 0 : for (tenant_shard_id, shard) in locked.tenants.range(shards_range) {
4015 0 : if let Some(node_id) = shard.intent.get_attached() {
4016 0 : let node = locked
4017 0 : .nodes
4018 0 : .get(node_id)
4019 0 : .expect("Pageservers may not be deleted while referenced");
4020 0 :
4021 0 : targets.push((*tenant_shard_id, node.clone()));
4022 0 : }
4023 : }
4024 0 : targets
4025 0 : };
4026 0 :
4027 0 : self.tenant_for_shards_api(
4028 0 : targets,
4029 0 : |tenant_shard_id, client| async move {
4030 0 : client
4031 0 : .timeline_download_heatmap_layers(
4032 0 : tenant_shard_id,
4033 0 : timeline_id,
4034 0 : concurrency,
4035 0 : recurse,
4036 0 : )
4037 0 : .await
4038 0 : },
4039 0 : 1,
4040 0 : 1,
4041 0 : SHORT_RECONCILE_TIMEOUT,
4042 0 : &self.cancel,
4043 0 : )
4044 0 : .await;
4045 :
4046 0 : Ok(())
4047 0 : }
4048 :
4049 : /// Helper for concurrently calling a pageserver API on a number of shards, such as timeline creation.
4050 : ///
4051 : /// On success, the returned vector contains exactly the same number of elements as the input `locations`
4052 : /// and returned element at index `i` is the result for `req_fn(op(locations[i])`.
4053 0 : async fn tenant_for_shards<F, R>(
4054 0 : &self,
4055 0 : locations: Vec<(TenantShardId, Node)>,
4056 0 : mut req_fn: F,
4057 0 : ) -> Result<Vec<R>, ApiError>
4058 0 : where
4059 0 : F: FnMut(
4060 0 : TenantShardId,
4061 0 : Node,
4062 0 : )
4063 0 : -> std::pin::Pin<Box<dyn futures::Future<Output = Result<R, ApiError>> + Send>>,
4064 0 : {
4065 0 : let mut futs = FuturesUnordered::new();
4066 0 : let mut results = Vec::with_capacity(locations.len());
4067 :
4068 0 : for (idx, (tenant_shard_id, node)) in locations.into_iter().enumerate() {
4069 0 : let fut = req_fn(tenant_shard_id, node);
4070 0 : futs.push(async move { (idx, fut.await) });
4071 0 : }
4072 :
4073 0 : while let Some((idx, r)) = futs.next().await {
4074 0 : results.push((idx, r?));
4075 : }
4076 :
4077 0 : results.sort_by_key(|(idx, _)| *idx);
4078 0 : Ok(results.into_iter().map(|(_, r)| r).collect())
4079 0 : }
4080 :
4081 : /// Concurrently invoke a pageserver API call on many shards at once.
4082 : ///
4083 : /// The returned Vec has the same length as the `locations` Vec,
4084 : /// and returned element at index `i` is the result for `op(locations[i])`.
4085 0 : pub(crate) async fn tenant_for_shards_api<T, O, F>(
4086 0 : &self,
4087 0 : locations: Vec<(TenantShardId, Node)>,
4088 0 : op: O,
4089 0 : warn_threshold: u32,
4090 0 : max_retries: u32,
4091 0 : timeout: Duration,
4092 0 : cancel: &CancellationToken,
4093 0 : ) -> Vec<mgmt_api::Result<T>>
4094 0 : where
4095 0 : O: Fn(TenantShardId, PageserverClient) -> F + Copy,
4096 0 : F: std::future::Future<Output = mgmt_api::Result<T>>,
4097 0 : {
4098 0 : let mut futs = FuturesUnordered::new();
4099 0 : let mut results = Vec::with_capacity(locations.len());
4100 :
4101 0 : for (idx, (tenant_shard_id, node)) in locations.into_iter().enumerate() {
4102 0 : futs.push(async move {
4103 0 : let r = node
4104 0 : .with_client_retries(
4105 0 : |client| op(tenant_shard_id, client),
4106 0 : &self.http_client,
4107 0 : &self.config.pageserver_jwt_token,
4108 0 : warn_threshold,
4109 0 : max_retries,
4110 0 : timeout,
4111 0 : cancel,
4112 0 : )
4113 0 : .await;
4114 0 : (idx, r)
4115 0 : });
4116 0 : }
4117 :
4118 0 : while let Some((idx, r)) = futs.next().await {
4119 0 : results.push((idx, r.unwrap_or(Err(mgmt_api::Error::Cancelled))));
4120 0 : }
4121 :
4122 0 : results.sort_by_key(|(idx, _)| *idx);
4123 0 : results.into_iter().map(|(_, r)| r).collect()
4124 0 : }
4125 :
4126 : /// Helper for safely working with the shards in a tenant remotely on pageservers, for example
4127 : /// when creating and deleting timelines:
4128 : /// - Makes sure shards are attached somewhere if they weren't already
4129 : /// - Looks up the shards and the nodes where they were most recently attached
4130 : /// - Guarantees that after the inner function returns, the shards' generations haven't moved on: this
4131 : /// ensures that the remote operation acted on the most recent generation, and is therefore durable.
4132 0 : async fn tenant_remote_mutation<R, O, F>(
4133 0 : &self,
4134 0 : tenant_id: TenantId,
4135 0 : op: O,
4136 0 : ) -> Result<R, ApiError>
4137 0 : where
4138 0 : O: FnOnce(TenantMutationLocations) -> F,
4139 0 : F: std::future::Future<Output = R>,
4140 0 : {
4141 0 : let mutation_locations = {
4142 0 : let mut locations = TenantMutationLocations::default();
4143 :
4144 : // Load the currently attached pageservers for the latest generation of each shard. This can
4145 : // run concurrently with reconciliations, and it is not guaranteed that the node we find here
4146 : // will still be the latest when we're done: we will check generations again at the end of
4147 : // this function to handle that.
4148 0 : let generations = self.persistence.tenant_generations(tenant_id).await?;
4149 :
4150 0 : if generations
4151 0 : .iter()
4152 0 : .any(|i| i.generation.is_none() || i.generation_pageserver.is_none())
4153 : {
4154 0 : let shard_generations = generations
4155 0 : .into_iter()
4156 0 : .map(|i| (i.tenant_shard_id, (i.generation, i.generation_pageserver)))
4157 0 : .collect::<HashMap<_, _>>();
4158 0 :
4159 0 : // One or more shards has not been attached to a pageserver. Check if this is because it's configured
4160 0 : // to be detached (409: caller should give up), or because it's meant to be attached but isn't yet (503: caller should retry)
4161 0 : let locked = self.inner.read().unwrap();
4162 0 : for (shard_id, shard) in
4163 0 : locked.tenants.range(TenantShardId::tenant_range(tenant_id))
4164 : {
4165 0 : match shard.policy {
4166 : PlacementPolicy::Attached(_) => {
4167 : // This shard is meant to be attached: the caller is not wrong to try and
4168 : // use this function, but we can't service the request right now.
4169 0 : let Some(generation) = shard_generations.get(shard_id) else {
4170 : // This can only happen if there is a split brain controller modifying the database. This should
4171 : // never happen when testing, and if it happens in production we can only log the issue.
4172 0 : debug_assert!(false);
4173 0 : tracing::error!(
4174 0 : "Shard {shard_id} not found in generation state! Is another rogue controller running?"
4175 : );
4176 0 : continue;
4177 : };
4178 0 : let (generation, generation_pageserver) = generation;
4179 0 : if let Some(generation) = generation {
4180 0 : if generation_pageserver.is_none() {
4181 : // This is legitimate only in a very narrow window where the shard was only just configured into
4182 : // Attached mode after being created in Secondary or Detached mode, and it has had its generation
4183 : // set but not yet had a Reconciler run (reconciler is the only thing that sets generation_pageserver).
4184 0 : tracing::warn!(
4185 0 : "Shard {shard_id} generation is set ({generation:?}) but generation_pageserver is None, reconciler not run yet?"
4186 : );
4187 0 : }
4188 : } else {
4189 : // This should never happen: a shard with no generation is only permitted when it was created in some state
4190 : // other than PlacementPolicy::Attached (and generation is always written to DB before setting Attached in memory)
4191 0 : debug_assert!(false);
4192 0 : tracing::error!(
4193 0 : "Shard {shard_id} generation is None, but it is in PlacementPolicy::Attached mode!"
4194 : );
4195 0 : continue;
4196 : }
4197 : }
4198 : PlacementPolicy::Secondary | PlacementPolicy::Detached => {
4199 0 : return Err(ApiError::Conflict(format!(
4200 0 : "Shard {shard_id} tenant has policy {:?}",
4201 0 : shard.policy
4202 0 : )));
4203 : }
4204 : }
4205 : }
4206 :
4207 0 : return Err(ApiError::ResourceUnavailable(
4208 0 : "One or more shards in tenant is not yet attached".into(),
4209 0 : ));
4210 0 : }
4211 0 :
4212 0 : let locked = self.inner.read().unwrap();
4213 : for ShardGenerationState {
4214 0 : tenant_shard_id,
4215 0 : generation,
4216 0 : generation_pageserver,
4217 0 : } in generations
4218 : {
4219 0 : let node_id = generation_pageserver.expect("We checked for None above");
4220 0 : let node = locked
4221 0 : .nodes
4222 0 : .get(&node_id)
4223 0 : .ok_or(ApiError::Conflict(format!(
4224 0 : "Raced with removal of node {node_id}"
4225 0 : )))?;
4226 0 : let generation = generation.expect("Checked above");
4227 0 :
4228 0 : let tenant = locked.tenants.get(&tenant_shard_id);
4229 :
4230 : // TODO(vlad): Abstract the logic that finds stale attached locations
4231 : // from observed state into a [`Service`] method.
4232 0 : let other_locations = match tenant {
4233 0 : Some(tenant) => {
4234 0 : let mut other = tenant.attached_locations();
4235 0 : let latest_location_index =
4236 0 : other.iter().position(|&l| l == (node.get_id(), generation));
4237 0 : if let Some(idx) = latest_location_index {
4238 0 : other.remove(idx);
4239 0 : }
4240 :
4241 0 : other
4242 : }
4243 0 : None => Vec::default(),
4244 : };
4245 :
4246 0 : let location = ShardMutationLocations {
4247 0 : latest: MutationLocation {
4248 0 : node: node.clone(),
4249 0 : generation,
4250 0 : },
4251 0 : other: other_locations
4252 0 : .into_iter()
4253 0 : .filter_map(|(node_id, generation)| {
4254 0 : let node = locked.nodes.get(&node_id)?;
4255 :
4256 0 : Some(MutationLocation {
4257 0 : node: node.clone(),
4258 0 : generation,
4259 0 : })
4260 0 : })
4261 0 : .collect(),
4262 0 : };
4263 0 : locations.0.insert(tenant_shard_id, location);
4264 0 : }
4265 :
4266 0 : locations
4267 : };
4268 :
4269 0 : let result = op(mutation_locations.clone()).await;
4270 :
4271 : // Post-check: are all the generations of all the shards the same as they were initially? This proves that
4272 : // our remote operation executed on the latest generation and is therefore persistent.
4273 : {
4274 0 : let latest_generations = self.persistence.tenant_generations(tenant_id).await?;
4275 0 : if latest_generations
4276 0 : .into_iter()
4277 0 : .map(
4278 0 : |ShardGenerationState {
4279 : tenant_shard_id,
4280 : generation,
4281 : generation_pageserver: _,
4282 0 : }| (tenant_shard_id, generation),
4283 0 : )
4284 0 : .collect::<Vec<_>>()
4285 0 : != mutation_locations
4286 0 : .0
4287 0 : .into_iter()
4288 0 : .map(|i| (i.0, Some(i.1.latest.generation)))
4289 0 : .collect::<Vec<_>>()
4290 : {
4291 : // We raced with something that incremented the generation, and therefore cannot be
4292 : // confident that our actions are persistent (they might have hit an old generation).
4293 : //
4294 : // This is safe but requires a retry: ask the client to do that by giving them a 503 response.
4295 0 : return Err(ApiError::ResourceUnavailable(
4296 0 : "Tenant attachment changed, please retry".into(),
4297 0 : ));
4298 0 : }
4299 0 : }
4300 0 :
4301 0 : Ok(result)
4302 0 : }
4303 :
4304 0 : pub(crate) async fn tenant_timeline_delete(
4305 0 : self: &Arc<Self>,
4306 0 : tenant_id: TenantId,
4307 0 : timeline_id: TimelineId,
4308 0 : ) -> Result<StatusCode, ApiError> {
4309 0 : tracing::info!("Deleting timeline {}/{}", tenant_id, timeline_id,);
4310 0 : let _tenant_lock = trace_shared_lock(
4311 0 : &self.tenant_op_locks,
4312 0 : tenant_id,
4313 0 : TenantOperations::TimelineDelete,
4314 0 : )
4315 0 : .await;
4316 :
4317 0 : let status_code = self.tenant_remote_mutation(tenant_id, move |mut targets| async move {
4318 0 : if targets.0.is_empty() {
4319 0 : return Err(ApiError::NotFound(
4320 0 : anyhow::anyhow!("Tenant not found").into(),
4321 0 : ));
4322 0 : }
4323 0 :
4324 0 : let (shard_zero_tid, shard_zero_locations) = targets.0.pop_first().expect("Must have at least one shard");
4325 0 : assert!(shard_zero_tid.is_shard_zero());
4326 :
4327 0 : async fn delete_one(
4328 0 : tenant_shard_id: TenantShardId,
4329 0 : timeline_id: TimelineId,
4330 0 : node: Node,
4331 0 : http_client: reqwest::Client,
4332 0 : jwt: Option<String>,
4333 0 : ) -> Result<StatusCode, ApiError> {
4334 0 : tracing::info!(
4335 0 : "Deleting timeline on shard {tenant_shard_id}/{timeline_id}, attached to node {node}",
4336 : );
4337 :
4338 0 : let client = PageserverClient::new(node.get_id(), http_client, node.base_url(), jwt.as_deref());
4339 0 : let res = client
4340 0 : .timeline_delete(tenant_shard_id, timeline_id)
4341 0 : .await;
4342 :
4343 0 : match res {
4344 0 : Ok(ok) => Ok(ok),
4345 0 : Err(mgmt_api::Error::ApiError(StatusCode::CONFLICT, _)) => Ok(StatusCode::CONFLICT),
4346 0 : Err(mgmt_api::Error::ApiError(StatusCode::SERVICE_UNAVAILABLE, msg)) => Err(ApiError::ResourceUnavailable(msg.into())),
4347 0 : Err(e) => {
4348 0 : Err(
4349 0 : ApiError::InternalServerError(anyhow::anyhow!(
4350 0 : "Error deleting timeline {timeline_id} on {tenant_shard_id} on node {node}: {e}",
4351 0 : ))
4352 0 : )
4353 : }
4354 : }
4355 0 : }
4356 :
4357 0 : let locations = targets.0.iter().map(|t| (*t.0, t.1.latest.node.clone())).collect();
4358 0 : let statuses = self
4359 0 : .tenant_for_shards(locations, |tenant_shard_id: TenantShardId, node: Node| {
4360 0 : Box::pin(delete_one(
4361 0 : tenant_shard_id,
4362 0 : timeline_id,
4363 0 : node,
4364 0 : self.http_client.clone(),
4365 0 : self.config.pageserver_jwt_token.clone(),
4366 0 : ))
4367 0 : })
4368 0 : .await?;
4369 :
4370 : // If any shards >0 haven't finished deletion yet, don't start deletion on shard zero.
4371 : // We return 409 (Conflict) if deletion was already in progress on any of the shards
4372 : // and 202 (Accepted) if deletion was not already in progress on any of the shards.
4373 0 : if statuses.iter().any(|s| s == &StatusCode::CONFLICT) {
4374 0 : return Ok(StatusCode::CONFLICT);
4375 0 : }
4376 0 :
4377 0 : if statuses.iter().any(|s| s != &StatusCode::NOT_FOUND) {
4378 0 : return Ok(StatusCode::ACCEPTED);
4379 0 : }
4380 :
4381 : // Delete shard zero last: this is not strictly necessary, but since a caller's GET on a timeline will be routed
4382 : // to shard zero, it gives a more obvious behavior that a GET returns 404 once the deletion is done.
4383 0 : let shard_zero_status = delete_one(
4384 0 : shard_zero_tid,
4385 0 : timeline_id,
4386 0 : shard_zero_locations.latest.node,
4387 0 : self.http_client.clone(),
4388 0 : self.config.pageserver_jwt_token.clone(),
4389 0 : )
4390 0 : .await?;
4391 0 : Ok(shard_zero_status)
4392 0 : }).await?;
4393 :
4394 0 : self.tenant_timeline_delete_safekeepers(tenant_id, timeline_id)
4395 0 : .await?;
4396 :
4397 0 : status_code
4398 0 : }
4399 : /// When you know the TenantId but not a specific shard, and would like to get the node holding shard 0.
4400 0 : pub(crate) async fn tenant_shard0_node(
4401 0 : &self,
4402 0 : tenant_id: TenantId,
4403 0 : ) -> Result<(Node, TenantShardId), ApiError> {
4404 0 : let tenant_shard_id = {
4405 0 : let locked = self.inner.read().unwrap();
4406 0 : let Some((tenant_shard_id, _shard)) = locked
4407 0 : .tenants
4408 0 : .range(TenantShardId::tenant_range(tenant_id))
4409 0 : .next()
4410 : else {
4411 0 : return Err(ApiError::NotFound(
4412 0 : anyhow::anyhow!("Tenant {tenant_id} not found").into(),
4413 0 : ));
4414 : };
4415 :
4416 0 : *tenant_shard_id
4417 0 : };
4418 0 :
4419 0 : self.tenant_shard_node(tenant_shard_id)
4420 0 : .await
4421 0 : .map(|node| (node, tenant_shard_id))
4422 0 : }
4423 :
4424 : /// When you need to send an HTTP request to the pageserver that holds a shard of a tenant, this
4425 : /// function looks up and returns node. If the shard isn't found, returns Err(ApiError::NotFound)
4426 0 : pub(crate) async fn tenant_shard_node(
4427 0 : &self,
4428 0 : tenant_shard_id: TenantShardId,
4429 0 : ) -> Result<Node, ApiError> {
4430 0 : // Look up in-memory state and maybe use the node from there.
4431 0 : {
4432 0 : let locked = self.inner.read().unwrap();
4433 0 : let Some(shard) = locked.tenants.get(&tenant_shard_id) else {
4434 0 : return Err(ApiError::NotFound(
4435 0 : anyhow::anyhow!("Tenant shard {tenant_shard_id} not found").into(),
4436 0 : ));
4437 : };
4438 :
4439 0 : let Some(intent_node_id) = shard.intent.get_attached() else {
4440 0 : tracing::warn!(
4441 0 : tenant_id=%tenant_shard_id.tenant_id, shard_id=%tenant_shard_id.shard_slug(),
4442 0 : "Shard not scheduled (policy {:?}), cannot generate pass-through URL",
4443 : shard.policy
4444 : );
4445 0 : return Err(ApiError::Conflict(
4446 0 : "Cannot call timeline API on non-attached tenant".to_string(),
4447 0 : ));
4448 : };
4449 :
4450 0 : if shard.reconciler.is_none() {
4451 : // Optimization: while no reconcile is in flight, we may trust our in-memory state
4452 : // to tell us which pageserver to use. Otherwise we will fall through and hit the database
4453 0 : let Some(node) = locked.nodes.get(intent_node_id) else {
4454 : // This should never happen
4455 0 : return Err(ApiError::InternalServerError(anyhow::anyhow!(
4456 0 : "Shard refers to nonexistent node"
4457 0 : )));
4458 : };
4459 0 : return Ok(node.clone());
4460 0 : }
4461 : };
4462 :
4463 : // Look up the latest attached pageserver location from the database
4464 : // generation state: this will reflect the progress of any ongoing migration.
4465 : // Note that it is not guaranteed to _stay_ here, our caller must still handle
4466 : // the case where they call through to the pageserver and get a 404.
4467 0 : let db_result = self
4468 0 : .persistence
4469 0 : .tenant_generations(tenant_shard_id.tenant_id)
4470 0 : .await?;
4471 : let Some(ShardGenerationState {
4472 : tenant_shard_id: _,
4473 : generation: _,
4474 0 : generation_pageserver: Some(node_id),
4475 0 : }) = db_result
4476 0 : .into_iter()
4477 0 : .find(|s| s.tenant_shard_id == tenant_shard_id)
4478 : else {
4479 : // This can happen if we raced with a tenant deletion or a shard split. On a retry
4480 : // the caller will either succeed (shard split case), get a proper 404 (deletion case),
4481 : // or a conflict response (case where tenant was detached in background)
4482 0 : return Err(ApiError::ResourceUnavailable(
4483 0 : format!("Shard {tenant_shard_id} not found in database, or is not attached").into(),
4484 0 : ));
4485 : };
4486 0 : let locked = self.inner.read().unwrap();
4487 0 : let Some(node) = locked.nodes.get(&node_id) else {
4488 : // This should never happen
4489 0 : return Err(ApiError::InternalServerError(anyhow::anyhow!(
4490 0 : "Shard refers to nonexistent node"
4491 0 : )));
4492 : };
4493 :
4494 0 : Ok(node.clone())
4495 0 : }
4496 :
4497 0 : pub(crate) fn tenant_locate(
4498 0 : &self,
4499 0 : tenant_id: TenantId,
4500 0 : ) -> Result<TenantLocateResponse, ApiError> {
4501 0 : let locked = self.inner.read().unwrap();
4502 0 : tracing::info!("Locating shards for tenant {tenant_id}");
4503 :
4504 0 : let mut result = Vec::new();
4505 0 : let mut shard_params: Option<ShardParameters> = None;
4506 :
4507 0 : for (tenant_shard_id, shard) in locked.tenants.range(TenantShardId::tenant_range(tenant_id))
4508 : {
4509 0 : let node_id =
4510 0 : shard
4511 0 : .intent
4512 0 : .get_attached()
4513 0 : .ok_or(ApiError::BadRequest(anyhow::anyhow!(
4514 0 : "Cannot locate a tenant that is not attached"
4515 0 : )))?;
4516 :
4517 0 : let node = locked
4518 0 : .nodes
4519 0 : .get(&node_id)
4520 0 : .expect("Pageservers may not be deleted while referenced");
4521 0 :
4522 0 : result.push(node.shard_location(*tenant_shard_id));
4523 0 :
4524 0 : match &shard_params {
4525 0 : None => {
4526 0 : shard_params = Some(ShardParameters {
4527 0 : stripe_size: shard.shard.stripe_size,
4528 0 : count: shard.shard.count,
4529 0 : });
4530 0 : }
4531 0 : Some(params) => {
4532 0 : if params.stripe_size != shard.shard.stripe_size {
4533 : // This should never happen. We enforce at runtime because it's simpler than
4534 : // adding an extra per-tenant data structure to store the things that should be the same
4535 0 : return Err(ApiError::InternalServerError(anyhow::anyhow!(
4536 0 : "Inconsistent shard stripe size parameters!"
4537 0 : )));
4538 0 : }
4539 : }
4540 : }
4541 : }
4542 :
4543 0 : if result.is_empty() {
4544 0 : return Err(ApiError::NotFound(
4545 0 : anyhow::anyhow!("No shards for this tenant ID found").into(),
4546 0 : ));
4547 0 : }
4548 0 : let shard_params = shard_params.expect("result is non-empty, therefore this is set");
4549 0 : tracing::info!(
4550 0 : "Located tenant {} with params {:?} on shards {}",
4551 0 : tenant_id,
4552 0 : shard_params,
4553 0 : result
4554 0 : .iter()
4555 0 : .map(|s| format!("{:?}", s))
4556 0 : .collect::<Vec<_>>()
4557 0 : .join(",")
4558 : );
4559 :
4560 0 : Ok(TenantLocateResponse {
4561 0 : shards: result,
4562 0 : shard_params,
4563 0 : })
4564 0 : }
4565 :
4566 : /// Returns None if the input iterator of shards does not include a shard with number=0
4567 0 : fn tenant_describe_impl<'a>(
4568 0 : &self,
4569 0 : shards: impl Iterator<Item = &'a TenantShard>,
4570 0 : ) -> Option<TenantDescribeResponse> {
4571 0 : let mut shard_zero = None;
4572 0 : let mut describe_shards = Vec::new();
4573 :
4574 0 : for shard in shards {
4575 0 : if shard.tenant_shard_id.is_shard_zero() {
4576 0 : shard_zero = Some(shard);
4577 0 : }
4578 :
4579 0 : describe_shards.push(TenantDescribeResponseShard {
4580 0 : tenant_shard_id: shard.tenant_shard_id,
4581 0 : node_attached: *shard.intent.get_attached(),
4582 0 : node_secondary: shard.intent.get_secondary().to_vec(),
4583 0 : last_error: shard
4584 0 : .last_error
4585 0 : .lock()
4586 0 : .unwrap()
4587 0 : .as_ref()
4588 0 : .map(|e| format!("{e}"))
4589 0 : .unwrap_or("".to_string())
4590 0 : .clone(),
4591 0 : is_reconciling: shard.reconciler.is_some(),
4592 0 : is_pending_compute_notification: shard.pending_compute_notification,
4593 0 : is_splitting: matches!(shard.splitting, SplitState::Splitting),
4594 0 : scheduling_policy: shard.get_scheduling_policy(),
4595 0 : preferred_az_id: shard.preferred_az().map(ToString::to_string),
4596 : })
4597 : }
4598 :
4599 0 : let shard_zero = shard_zero?;
4600 :
4601 0 : Some(TenantDescribeResponse {
4602 0 : tenant_id: shard_zero.tenant_shard_id.tenant_id,
4603 0 : shards: describe_shards,
4604 0 : stripe_size: shard_zero.shard.stripe_size,
4605 0 : policy: shard_zero.policy.clone(),
4606 0 : config: shard_zero.config.clone(),
4607 0 : })
4608 0 : }
4609 :
4610 0 : pub(crate) fn tenant_describe(
4611 0 : &self,
4612 0 : tenant_id: TenantId,
4613 0 : ) -> Result<TenantDescribeResponse, ApiError> {
4614 0 : let locked = self.inner.read().unwrap();
4615 0 :
4616 0 : self.tenant_describe_impl(
4617 0 : locked
4618 0 : .tenants
4619 0 : .range(TenantShardId::tenant_range(tenant_id))
4620 0 : .map(|(_k, v)| v),
4621 0 : )
4622 0 : .ok_or_else(|| ApiError::NotFound(anyhow::anyhow!("Tenant {tenant_id} not found").into()))
4623 0 : }
4624 :
4625 : /// limit & offset are pagination parameters. Since we are walking an in-memory HashMap, `offset` does not
4626 : /// avoid traversing data, it just avoid returning it. This is suitable for our purposes, since our in memory
4627 : /// maps are small enough to traverse fast, our pagination is just to avoid serializing huge JSON responses
4628 : /// in our external API.
4629 0 : pub(crate) fn tenant_list(
4630 0 : &self,
4631 0 : limit: Option<usize>,
4632 0 : start_after: Option<TenantId>,
4633 0 : ) -> Vec<TenantDescribeResponse> {
4634 0 : let locked = self.inner.read().unwrap();
4635 :
4636 : // Apply start_from parameter
4637 0 : let shard_range = match start_after {
4638 0 : None => locked.tenants.range(..),
4639 0 : Some(tenant_id) => locked.tenants.range(
4640 0 : TenantShardId {
4641 0 : tenant_id,
4642 0 : shard_number: ShardNumber(u8::MAX),
4643 0 : shard_count: ShardCount(u8::MAX),
4644 0 : }..,
4645 0 : ),
4646 : };
4647 :
4648 0 : let mut result = Vec::new();
4649 0 : for (_tenant_id, tenant_shards) in &shard_range.group_by(|(id, _shard)| id.tenant_id) {
4650 0 : result.push(
4651 0 : self.tenant_describe_impl(tenant_shards.map(|(_k, v)| v))
4652 0 : .expect("Groups are always non-empty"),
4653 0 : );
4654 :
4655 : // Enforce `limit` parameter
4656 0 : if let Some(limit) = limit {
4657 0 : if result.len() >= limit {
4658 0 : break;
4659 0 : }
4660 0 : }
4661 : }
4662 :
4663 0 : result
4664 0 : }
4665 :
4666 : #[instrument(skip_all, fields(tenant_id=%op.tenant_id))]
4667 : async fn abort_tenant_shard_split(
4668 : &self,
4669 : op: &TenantShardSplitAbort,
4670 : ) -> Result<(), TenantShardSplitAbortError> {
4671 : // Cleaning up a split:
4672 : // - Parent shards are not destroyed during a split, just detached.
4673 : // - Failed pageserver split API calls can leave the remote node with just the parent attached,
4674 : // just the children attached, or both.
4675 : //
4676 : // Therefore our work to do is to:
4677 : // 1. Clean up storage controller's internal state to just refer to parents, no children
4678 : // 2. Call out to pageservers to ensure that children are detached
4679 : // 3. Call out to pageservers to ensure that parents are attached.
4680 : //
4681 : // Crash safety:
4682 : // - If the storage controller stops running during this cleanup *after* clearing the splitting state
4683 : // from our database, then [`Self::startup_reconcile`] will regard child attachments as garbage
4684 : // and detach them.
4685 : // - TODO: If the storage controller stops running during this cleanup *before* clearing the splitting state
4686 : // from our database, then we will re-enter this cleanup routine on startup.
4687 :
4688 : let TenantShardSplitAbort {
4689 : tenant_id,
4690 : new_shard_count,
4691 : new_stripe_size,
4692 : ..
4693 : } = op;
4694 :
4695 : // First abort persistent state, if any exists.
4696 : match self
4697 : .persistence
4698 : .abort_shard_split(*tenant_id, *new_shard_count)
4699 : .await?
4700 : {
4701 : AbortShardSplitStatus::Aborted => {
4702 : // Proceed to roll back any child shards created on pageservers
4703 : }
4704 : AbortShardSplitStatus::Complete => {
4705 : // The split completed (we might hit that path if e.g. our database transaction
4706 : // to write the completion landed in the database, but we dropped connection
4707 : // before seeing the result).
4708 : //
4709 : // We must update in-memory state to reflect the successful split.
4710 : self.tenant_shard_split_commit_inmem(
4711 : *tenant_id,
4712 : *new_shard_count,
4713 : *new_stripe_size,
4714 : );
4715 : return Ok(());
4716 : }
4717 : }
4718 :
4719 : // Clean up in-memory state, and accumulate the list of child locations that need detaching
4720 : let detach_locations: Vec<(Node, TenantShardId)> = {
4721 : let mut detach_locations = Vec::new();
4722 : let mut locked = self.inner.write().unwrap();
4723 : let (nodes, tenants, scheduler) = locked.parts_mut();
4724 :
4725 : for (tenant_shard_id, shard) in
4726 : tenants.range_mut(TenantShardId::tenant_range(op.tenant_id))
4727 : {
4728 : if shard.shard.count == op.new_shard_count {
4729 : // Surprising: the phase of [`Self::do_tenant_shard_split`] which inserts child shards in-memory
4730 : // is infallible, so if we got an error we shouldn't have got that far.
4731 : tracing::warn!(
4732 : "During split abort, child shard {tenant_shard_id} found in-memory"
4733 : );
4734 : continue;
4735 : }
4736 :
4737 : // Add the children of this shard to this list of things to detach
4738 : if let Some(node_id) = shard.intent.get_attached() {
4739 : for child_id in tenant_shard_id.split(*new_shard_count) {
4740 : detach_locations.push((
4741 : nodes
4742 : .get(node_id)
4743 : .expect("Intent references nonexistent node")
4744 : .clone(),
4745 : child_id,
4746 : ));
4747 : }
4748 : } else {
4749 : tracing::warn!(
4750 : "During split abort, shard {tenant_shard_id} has no attached location"
4751 : );
4752 : }
4753 :
4754 : tracing::info!("Restoring parent shard {tenant_shard_id}");
4755 :
4756 : // Drop any intents that refer to unavailable nodes, to enable this abort to proceed even
4757 : // if the original attachment location is offline.
4758 : if let Some(node_id) = shard.intent.get_attached() {
4759 : if !nodes.get(node_id).unwrap().is_available() {
4760 : tracing::info!(
4761 : "Demoting attached intent for {tenant_shard_id} on unavailable node {node_id}"
4762 : );
4763 : shard.intent.demote_attached(scheduler, *node_id);
4764 : }
4765 : }
4766 : for node_id in shard.intent.get_secondary().clone() {
4767 : if !nodes.get(&node_id).unwrap().is_available() {
4768 : tracing::info!(
4769 : "Dropping secondary intent for {tenant_shard_id} on unavailable node {node_id}"
4770 : );
4771 : shard.intent.remove_secondary(scheduler, node_id);
4772 : }
4773 : }
4774 :
4775 : shard.splitting = SplitState::Idle;
4776 : if let Err(e) = shard.schedule(scheduler, &mut ScheduleContext::default()) {
4777 : // If this shard can't be scheduled now (perhaps due to offline nodes or
4778 : // capacity issues), that must not prevent us rolling back a split. In this
4779 : // case it should be eventually scheduled in the background.
4780 : tracing::warn!("Failed to schedule {tenant_shard_id} during shard abort: {e}")
4781 : }
4782 :
4783 : self.maybe_reconcile_shard(shard, nodes, ReconcilerPriority::High);
4784 : }
4785 :
4786 : // We don't expect any new_shard_count shards to exist here, but drop them just in case
4787 0 : tenants.retain(|_id, s| s.shard.count != *new_shard_count);
4788 :
4789 : detach_locations
4790 : };
4791 :
4792 : for (node, child_id) in detach_locations {
4793 : if !node.is_available() {
4794 : // An unavailable node cannot be cleaned up now: to avoid blocking forever, we will permit this, and
4795 : // rely on the reconciliation that happens when a node transitions to Active to clean up. Since we have
4796 : // removed child shards from our in-memory state and database, the reconciliation will implicitly remove
4797 : // them from the node.
4798 : tracing::warn!(
4799 : "Node {node} unavailable, can't clean up during split abort. It will be cleaned up when it is reactivated."
4800 : );
4801 : continue;
4802 : }
4803 :
4804 : // Detach the remote child. If the pageserver split API call is still in progress, this call will get
4805 : // a 503 and retry, up to our limit.
4806 : tracing::info!("Detaching {child_id} on {node}...");
4807 : match node
4808 : .with_client_retries(
4809 0 : |client| async move {
4810 0 : let config = LocationConfig {
4811 0 : mode: LocationConfigMode::Detached,
4812 0 : generation: None,
4813 0 : secondary_conf: None,
4814 0 : shard_number: child_id.shard_number.0,
4815 0 : shard_count: child_id.shard_count.literal(),
4816 0 : // Stripe size and tenant config don't matter when detaching
4817 0 : shard_stripe_size: 0,
4818 0 : tenant_conf: TenantConfig::default(),
4819 0 : };
4820 0 :
4821 0 : client.location_config(child_id, config, None, false).await
4822 0 : },
4823 : &self.http_client,
4824 : &self.config.pageserver_jwt_token,
4825 : 1,
4826 : 10,
4827 : Duration::from_secs(5),
4828 : &self.cancel,
4829 : )
4830 : .await
4831 : {
4832 : Some(Ok(_)) => {}
4833 : Some(Err(e)) => {
4834 : // We failed to communicate with the remote node. This is problematic: we may be
4835 : // leaving it with a rogue child shard.
4836 : tracing::warn!(
4837 : "Failed to detach child {child_id} from node {node} during abort"
4838 : );
4839 : return Err(e.into());
4840 : }
4841 : None => {
4842 : // Cancellation: we were shutdown or the node went offline. Shutdown is fine, we'll
4843 : // clean up on restart. The node going offline requires a retry.
4844 : return Err(TenantShardSplitAbortError::Unavailable);
4845 : }
4846 : };
4847 : }
4848 :
4849 : tracing::info!("Successfully aborted split");
4850 : Ok(())
4851 : }
4852 :
4853 : /// Infallible final stage of [`Self::tenant_shard_split`]: update the contents
4854 : /// of the tenant map to reflect the child shards that exist after the split.
4855 0 : fn tenant_shard_split_commit_inmem(
4856 0 : &self,
4857 0 : tenant_id: TenantId,
4858 0 : new_shard_count: ShardCount,
4859 0 : new_stripe_size: Option<ShardStripeSize>,
4860 0 : ) -> (
4861 0 : TenantShardSplitResponse,
4862 0 : Vec<(TenantShardId, NodeId, ShardStripeSize)>,
4863 0 : Vec<ReconcilerWaiter>,
4864 0 : ) {
4865 0 : let mut response = TenantShardSplitResponse {
4866 0 : new_shards: Vec::new(),
4867 0 : };
4868 0 : let mut child_locations = Vec::new();
4869 0 : let mut waiters = Vec::new();
4870 0 :
4871 0 : {
4872 0 : let mut locked = self.inner.write().unwrap();
4873 0 :
4874 0 : let parent_ids = locked
4875 0 : .tenants
4876 0 : .range(TenantShardId::tenant_range(tenant_id))
4877 0 : .map(|(shard_id, _)| *shard_id)
4878 0 : .collect::<Vec<_>>();
4879 0 :
4880 0 : let (nodes, tenants, scheduler) = locked.parts_mut();
4881 0 : for parent_id in parent_ids {
4882 0 : let child_ids = parent_id.split(new_shard_count);
4883 :
4884 0 : let (pageserver, generation, policy, parent_ident, config, preferred_az) = {
4885 0 : let mut old_state = tenants
4886 0 : .remove(&parent_id)
4887 0 : .expect("It was present, we just split it");
4888 0 :
4889 0 : // A non-splitting state is impossible, because [`Self::tenant_shard_split`] holds
4890 0 : // a TenantId lock and passes it through to [`TenantShardSplitAbort`] in case of cleanup:
4891 0 : // nothing else can clear this.
4892 0 : assert!(matches!(old_state.splitting, SplitState::Splitting));
4893 :
4894 0 : let old_attached = old_state.intent.get_attached().unwrap();
4895 0 : old_state.intent.clear(scheduler);
4896 0 : let generation = old_state.generation.expect("Shard must have been attached");
4897 0 : (
4898 0 : old_attached,
4899 0 : generation,
4900 0 : old_state.policy.clone(),
4901 0 : old_state.shard,
4902 0 : old_state.config.clone(),
4903 0 : old_state.preferred_az().cloned(),
4904 0 : )
4905 0 : };
4906 0 :
4907 0 : let mut schedule_context = ScheduleContext::default();
4908 0 : for child in child_ids {
4909 0 : let mut child_shard = parent_ident;
4910 0 : child_shard.number = child.shard_number;
4911 0 : child_shard.count = child.shard_count;
4912 0 : if let Some(stripe_size) = new_stripe_size {
4913 0 : child_shard.stripe_size = stripe_size;
4914 0 : }
4915 :
4916 0 : let mut child_observed: HashMap<NodeId, ObservedStateLocation> = HashMap::new();
4917 0 : child_observed.insert(
4918 0 : pageserver,
4919 0 : ObservedStateLocation {
4920 0 : conf: Some(attached_location_conf(
4921 0 : generation,
4922 0 : &child_shard,
4923 0 : &config,
4924 0 : &policy,
4925 0 : )),
4926 0 : },
4927 0 : );
4928 0 :
4929 0 : let mut child_state =
4930 0 : TenantShard::new(child, child_shard, policy.clone(), preferred_az.clone());
4931 0 : child_state.intent =
4932 0 : IntentState::single(scheduler, Some(pageserver), preferred_az.clone());
4933 0 : child_state.observed = ObservedState {
4934 0 : locations: child_observed,
4935 0 : };
4936 0 : child_state.generation = Some(generation);
4937 0 : child_state.config = config.clone();
4938 0 :
4939 0 : // The child's TenantShard::splitting is intentionally left at the default value of Idle,
4940 0 : // as at this point in the split process we have succeeded and this part is infallible:
4941 0 : // we will never need to do any special recovery from this state.
4942 0 :
4943 0 : child_locations.push((child, pageserver, child_shard.stripe_size));
4944 :
4945 0 : if let Err(e) = child_state.schedule(scheduler, &mut schedule_context) {
4946 : // This is not fatal, because we've implicitly already got an attached
4947 : // location for the child shard. Failure here just means we couldn't
4948 : // find a secondary (e.g. because cluster is overloaded).
4949 0 : tracing::warn!("Failed to schedule child shard {child}: {e}");
4950 0 : }
4951 : // In the background, attach secondary locations for the new shards
4952 0 : if let Some(waiter) = self.maybe_reconcile_shard(
4953 0 : &mut child_state,
4954 0 : nodes,
4955 0 : ReconcilerPriority::High,
4956 0 : ) {
4957 0 : waiters.push(waiter);
4958 0 : }
4959 :
4960 0 : tenants.insert(child, child_state);
4961 0 : response.new_shards.push(child);
4962 : }
4963 : }
4964 0 : (response, child_locations, waiters)
4965 0 : }
4966 0 : }
4967 :
4968 0 : async fn tenant_shard_split_start_secondaries(
4969 0 : &self,
4970 0 : tenant_id: TenantId,
4971 0 : waiters: Vec<ReconcilerWaiter>,
4972 0 : ) {
4973 : // Wait for initial reconcile of child shards, this creates the secondary locations
4974 0 : if let Err(e) = self.await_waiters(waiters, RECONCILE_TIMEOUT).await {
4975 : // This is not a failure to split: it's some issue reconciling the new child shards, perhaps
4976 : // their secondaries couldn't be attached.
4977 0 : tracing::warn!("Failed to reconcile after split: {e}");
4978 0 : return;
4979 0 : }
4980 :
4981 : // Take the state lock to discover the attached & secondary intents for all shards
4982 0 : let (attached, secondary) = {
4983 0 : let locked = self.inner.read().unwrap();
4984 0 : let mut attached = Vec::new();
4985 0 : let mut secondary = Vec::new();
4986 :
4987 0 : for (tenant_shard_id, shard) in
4988 0 : locked.tenants.range(TenantShardId::tenant_range(tenant_id))
4989 : {
4990 0 : let Some(node_id) = shard.intent.get_attached() else {
4991 : // Unexpected. Race with a PlacementPolicy change?
4992 0 : tracing::warn!(
4993 0 : "No attached node on {tenant_shard_id} immediately after shard split!"
4994 : );
4995 0 : continue;
4996 : };
4997 :
4998 0 : let Some(secondary_node_id) = shard.intent.get_secondary().first() else {
4999 : // No secondary location. Nothing for us to do.
5000 0 : continue;
5001 : };
5002 :
5003 0 : let attached_node = locked
5004 0 : .nodes
5005 0 : .get(node_id)
5006 0 : .expect("Pageservers may not be deleted while referenced");
5007 0 :
5008 0 : let secondary_node = locked
5009 0 : .nodes
5010 0 : .get(secondary_node_id)
5011 0 : .expect("Pageservers may not be deleted while referenced");
5012 0 :
5013 0 : attached.push((*tenant_shard_id, attached_node.clone()));
5014 0 : secondary.push((*tenant_shard_id, secondary_node.clone()));
5015 : }
5016 0 : (attached, secondary)
5017 0 : };
5018 0 :
5019 0 : if secondary.is_empty() {
5020 : // No secondary locations; nothing for us to do
5021 0 : return;
5022 0 : }
5023 :
5024 0 : for result in self
5025 0 : .tenant_for_shards_api(
5026 0 : attached,
5027 0 : |tenant_shard_id, client| async move {
5028 0 : client.tenant_heatmap_upload(tenant_shard_id).await
5029 0 : },
5030 0 : 1,
5031 0 : 1,
5032 0 : SHORT_RECONCILE_TIMEOUT,
5033 0 : &self.cancel,
5034 0 : )
5035 0 : .await
5036 : {
5037 0 : if let Err(e) = result {
5038 0 : tracing::warn!("Error calling heatmap upload after shard split: {e}");
5039 0 : return;
5040 0 : }
5041 : }
5042 :
5043 0 : for result in self
5044 0 : .tenant_for_shards_api(
5045 0 : secondary,
5046 0 : |tenant_shard_id, client| async move {
5047 0 : client
5048 0 : .tenant_secondary_download(tenant_shard_id, Some(Duration::ZERO))
5049 0 : .await
5050 0 : },
5051 0 : 1,
5052 0 : 1,
5053 0 : SHORT_RECONCILE_TIMEOUT,
5054 0 : &self.cancel,
5055 0 : )
5056 0 : .await
5057 : {
5058 0 : if let Err(e) = result {
5059 0 : tracing::warn!("Error calling secondary download after shard split: {e}");
5060 0 : return;
5061 0 : }
5062 : }
5063 0 : }
5064 :
5065 0 : pub(crate) async fn tenant_shard_split(
5066 0 : &self,
5067 0 : tenant_id: TenantId,
5068 0 : split_req: TenantShardSplitRequest,
5069 0 : ) -> Result<TenantShardSplitResponse, ApiError> {
5070 : // TODO: return 503 if we get stuck waiting for this lock
5071 : // (issue https://github.com/neondatabase/neon/issues/7108)
5072 0 : let _tenant_lock = trace_exclusive_lock(
5073 0 : &self.tenant_op_locks,
5074 0 : tenant_id,
5075 0 : TenantOperations::ShardSplit,
5076 0 : )
5077 0 : .await;
5078 :
5079 0 : let new_shard_count = ShardCount::new(split_req.new_shard_count);
5080 0 : let new_stripe_size = split_req.new_stripe_size;
5081 :
5082 : // Validate the request and construct parameters. This phase is fallible, but does not require
5083 : // rollback on errors, as it does no I/O and mutates no state.
5084 0 : let shard_split_params = match self.prepare_tenant_shard_split(tenant_id, split_req)? {
5085 0 : ShardSplitAction::NoOp(resp) => return Ok(resp),
5086 0 : ShardSplitAction::Split(params) => params,
5087 : };
5088 :
5089 : // Execute this split: this phase mutates state and does remote I/O on pageservers. If it fails,
5090 : // we must roll back.
5091 0 : let r = self
5092 0 : .do_tenant_shard_split(tenant_id, shard_split_params)
5093 0 : .await;
5094 :
5095 0 : let (response, waiters) = match r {
5096 0 : Ok(r) => r,
5097 0 : Err(e) => {
5098 0 : // Split might be part-done, we must do work to abort it.
5099 0 : tracing::warn!("Enqueuing background abort of split on {tenant_id}");
5100 0 : self.abort_tx
5101 0 : .send(TenantShardSplitAbort {
5102 0 : tenant_id,
5103 0 : new_shard_count,
5104 0 : new_stripe_size,
5105 0 : _tenant_lock,
5106 0 : })
5107 0 : // Ignore error sending: that just means we're shutting down: aborts are ephemeral so it's fine to drop it.
5108 0 : .ok();
5109 0 : return Err(e);
5110 : }
5111 : };
5112 :
5113 : // The split is now complete. As an optimization, we will trigger all the child shards to upload
5114 : // a heatmap immediately, and all their secondary locations to start downloading: this avoids waiting
5115 : // for the background heatmap/download interval before secondaries get warm enough to migrate shards
5116 : // in [`Self::optimize_all`]
5117 0 : self.tenant_shard_split_start_secondaries(tenant_id, waiters)
5118 0 : .await;
5119 0 : Ok(response)
5120 0 : }
5121 :
5122 0 : fn prepare_tenant_shard_split(
5123 0 : &self,
5124 0 : tenant_id: TenantId,
5125 0 : split_req: TenantShardSplitRequest,
5126 0 : ) -> Result<ShardSplitAction, ApiError> {
5127 0 : fail::fail_point!("shard-split-validation", |_| Err(ApiError::BadRequest(
5128 0 : anyhow::anyhow!("failpoint")
5129 0 : )));
5130 :
5131 0 : let mut policy = None;
5132 0 : let mut config = None;
5133 0 : let mut shard_ident = None;
5134 0 : let mut preferred_az_id = None;
5135 : // Validate input, and calculate which shards we will create
5136 0 : let (old_shard_count, targets) =
5137 : {
5138 0 : let locked = self.inner.read().unwrap();
5139 0 :
5140 0 : let pageservers = locked.nodes.clone();
5141 0 :
5142 0 : let mut targets = Vec::new();
5143 0 :
5144 0 : // In case this is a retry, count how many already-split shards we found
5145 0 : let mut children_found = Vec::new();
5146 0 : let mut old_shard_count = None;
5147 :
5148 0 : for (tenant_shard_id, shard) in
5149 0 : locked.tenants.range(TenantShardId::tenant_range(tenant_id))
5150 : {
5151 0 : match shard.shard.count.count().cmp(&split_req.new_shard_count) {
5152 : Ordering::Equal => {
5153 : // Already split this
5154 0 : children_found.push(*tenant_shard_id);
5155 0 : continue;
5156 : }
5157 : Ordering::Greater => {
5158 0 : return Err(ApiError::BadRequest(anyhow::anyhow!(
5159 0 : "Requested count {} but already have shards at count {}",
5160 0 : split_req.new_shard_count,
5161 0 : shard.shard.count.count()
5162 0 : )));
5163 : }
5164 0 : Ordering::Less => {
5165 0 : // Fall through: this shard has lower count than requested,
5166 0 : // is a candidate for splitting.
5167 0 : }
5168 0 : }
5169 0 :
5170 0 : match old_shard_count {
5171 0 : None => old_shard_count = Some(shard.shard.count),
5172 0 : Some(old_shard_count) => {
5173 0 : if old_shard_count != shard.shard.count {
5174 : // We may hit this case if a caller asked for two splits to
5175 : // different sizes, before the first one is complete.
5176 : // e.g. 1->2, 2->4, where the 4 call comes while we have a mixture
5177 : // of shard_count=1 and shard_count=2 shards in the map.
5178 0 : return Err(ApiError::Conflict(
5179 0 : "Cannot split, currently mid-split".to_string(),
5180 0 : ));
5181 0 : }
5182 : }
5183 : }
5184 0 : if policy.is_none() {
5185 0 : policy = Some(shard.policy.clone());
5186 0 : }
5187 0 : if shard_ident.is_none() {
5188 0 : shard_ident = Some(shard.shard);
5189 0 : }
5190 0 : if config.is_none() {
5191 0 : config = Some(shard.config.clone());
5192 0 : }
5193 0 : if preferred_az_id.is_none() {
5194 0 : preferred_az_id = shard.preferred_az().cloned();
5195 0 : }
5196 :
5197 0 : if tenant_shard_id.shard_count.count() == split_req.new_shard_count {
5198 0 : tracing::info!(
5199 0 : "Tenant shard {} already has shard count {}",
5200 : tenant_shard_id,
5201 : split_req.new_shard_count
5202 : );
5203 0 : continue;
5204 0 : }
5205 :
5206 0 : let node_id = shard.intent.get_attached().ok_or(ApiError::BadRequest(
5207 0 : anyhow::anyhow!("Cannot split a tenant that is not attached"),
5208 0 : ))?;
5209 :
5210 0 : let node = pageservers
5211 0 : .get(&node_id)
5212 0 : .expect("Pageservers may not be deleted while referenced");
5213 0 :
5214 0 : targets.push(ShardSplitTarget {
5215 0 : parent_id: *tenant_shard_id,
5216 0 : node: node.clone(),
5217 0 : child_ids: tenant_shard_id
5218 0 : .split(ShardCount::new(split_req.new_shard_count)),
5219 0 : });
5220 : }
5221 :
5222 0 : if targets.is_empty() {
5223 0 : if children_found.len() == split_req.new_shard_count as usize {
5224 0 : return Ok(ShardSplitAction::NoOp(TenantShardSplitResponse {
5225 0 : new_shards: children_found,
5226 0 : }));
5227 : } else {
5228 : // No shards found to split, and no existing children found: the
5229 : // tenant doesn't exist at all.
5230 0 : return Err(ApiError::NotFound(
5231 0 : anyhow::anyhow!("Tenant {} not found", tenant_id).into(),
5232 0 : ));
5233 : }
5234 0 : }
5235 0 :
5236 0 : (old_shard_count, targets)
5237 0 : };
5238 0 :
5239 0 : // unwrap safety: we would have returned above if we didn't find at least one shard to split
5240 0 : let old_shard_count = old_shard_count.unwrap();
5241 0 : let shard_ident = if let Some(new_stripe_size) = split_req.new_stripe_size {
5242 : // This ShardIdentity will be used as the template for all children, so this implicitly
5243 : // applies the new stripe size to the children.
5244 0 : let mut shard_ident = shard_ident.unwrap();
5245 0 : if shard_ident.count.count() > 1 && shard_ident.stripe_size != new_stripe_size {
5246 0 : return Err(ApiError::BadRequest(anyhow::anyhow!(
5247 0 : "Attempted to change stripe size ({:?}->{new_stripe_size:?}) on a tenant with multiple shards",
5248 0 : shard_ident.stripe_size
5249 0 : )));
5250 0 : }
5251 0 :
5252 0 : shard_ident.stripe_size = new_stripe_size;
5253 0 : tracing::info!("applied stripe size {}", shard_ident.stripe_size.0);
5254 0 : shard_ident
5255 : } else {
5256 0 : shard_ident.unwrap()
5257 : };
5258 0 : let policy = policy.unwrap();
5259 0 : let config = config.unwrap();
5260 0 :
5261 0 : Ok(ShardSplitAction::Split(Box::new(ShardSplitParams {
5262 0 : old_shard_count,
5263 0 : new_shard_count: ShardCount::new(split_req.new_shard_count),
5264 0 : new_stripe_size: split_req.new_stripe_size,
5265 0 : targets,
5266 0 : policy,
5267 0 : config,
5268 0 : shard_ident,
5269 0 : preferred_az_id,
5270 0 : })))
5271 0 : }
5272 :
5273 0 : async fn do_tenant_shard_split(
5274 0 : &self,
5275 0 : tenant_id: TenantId,
5276 0 : params: Box<ShardSplitParams>,
5277 0 : ) -> Result<(TenantShardSplitResponse, Vec<ReconcilerWaiter>), ApiError> {
5278 0 : // FIXME: we have dropped self.inner lock, and not yet written anything to the database: another
5279 0 : // request could occur here, deleting or mutating the tenant. begin_shard_split checks that the
5280 0 : // parent shards exist as expected, but it would be neater to do the above pre-checks within the
5281 0 : // same database transaction rather than pre-check in-memory and then maybe-fail the database write.
5282 0 : // (https://github.com/neondatabase/neon/issues/6676)
5283 0 :
5284 0 : let ShardSplitParams {
5285 0 : old_shard_count,
5286 0 : new_shard_count,
5287 0 : new_stripe_size,
5288 0 : mut targets,
5289 0 : policy,
5290 0 : config,
5291 0 : shard_ident,
5292 0 : preferred_az_id,
5293 0 : } = *params;
5294 :
5295 : // Drop any secondary locations: pageservers do not support splitting these, and in any case the
5296 : // end-state for a split tenant will usually be to have secondary locations on different nodes.
5297 : // The reconciliation calls in this block also implicitly cancel+barrier wrt any ongoing reconciliation
5298 : // at the time of split.
5299 0 : let waiters = {
5300 0 : let mut locked = self.inner.write().unwrap();
5301 0 : let mut waiters = Vec::new();
5302 0 : let (nodes, tenants, scheduler) = locked.parts_mut();
5303 0 : for target in &mut targets {
5304 0 : let Some(shard) = tenants.get_mut(&target.parent_id) else {
5305 : // Paranoia check: this shouldn't happen: we have the oplock for this tenant ID.
5306 0 : return Err(ApiError::InternalServerError(anyhow::anyhow!(
5307 0 : "Shard {} not found",
5308 0 : target.parent_id
5309 0 : )));
5310 : };
5311 :
5312 0 : if shard.intent.get_attached() != &Some(target.node.get_id()) {
5313 : // Paranoia check: this shouldn't happen: we have the oplock for this tenant ID.
5314 0 : return Err(ApiError::Conflict(format!(
5315 0 : "Shard {} unexpectedly rescheduled during split",
5316 0 : target.parent_id
5317 0 : )));
5318 0 : }
5319 0 :
5320 0 : // Irrespective of PlacementPolicy, clear secondary locations from intent
5321 0 : shard.intent.clear_secondary(scheduler);
5322 :
5323 : // Run Reconciler to execute detach fo secondary locations.
5324 0 : if let Some(waiter) =
5325 0 : self.maybe_reconcile_shard(shard, nodes, ReconcilerPriority::High)
5326 0 : {
5327 0 : waiters.push(waiter);
5328 0 : }
5329 : }
5330 0 : waiters
5331 0 : };
5332 0 : self.await_waiters(waiters, RECONCILE_TIMEOUT).await?;
5333 :
5334 : // Before creating any new child shards in memory or on the pageservers, persist them: this
5335 : // enables us to ensure that we will always be able to clean up if something goes wrong. This also
5336 : // acts as the protection against two concurrent attempts to split: one of them will get a database
5337 : // error trying to insert the child shards.
5338 0 : let mut child_tsps = Vec::new();
5339 0 : for target in &targets {
5340 0 : let mut this_child_tsps = Vec::new();
5341 0 : for child in &target.child_ids {
5342 0 : let mut child_shard = shard_ident;
5343 0 : child_shard.number = child.shard_number;
5344 0 : child_shard.count = child.shard_count;
5345 0 :
5346 0 : tracing::info!(
5347 0 : "Create child shard persistence with stripe size {}",
5348 : shard_ident.stripe_size.0
5349 : );
5350 :
5351 0 : this_child_tsps.push(TenantShardPersistence {
5352 0 : tenant_id: child.tenant_id.to_string(),
5353 0 : shard_number: child.shard_number.0 as i32,
5354 0 : shard_count: child.shard_count.literal() as i32,
5355 0 : shard_stripe_size: shard_ident.stripe_size.0 as i32,
5356 0 : // Note: this generation is a placeholder, [`Persistence::begin_shard_split`] will
5357 0 : // populate the correct generation as part of its transaction, to protect us
5358 0 : // against racing with changes in the state of the parent.
5359 0 : generation: None,
5360 0 : generation_pageserver: Some(target.node.get_id().0 as i64),
5361 0 : placement_policy: serde_json::to_string(&policy).unwrap(),
5362 0 : config: serde_json::to_string(&config).unwrap(),
5363 0 : splitting: SplitState::Splitting,
5364 0 :
5365 0 : // Scheduling policies and preferred AZ do not carry through to children
5366 0 : scheduling_policy: serde_json::to_string(&ShardSchedulingPolicy::default())
5367 0 : .unwrap(),
5368 0 : preferred_az_id: preferred_az_id.as_ref().map(|az| az.0.clone()),
5369 0 : });
5370 0 : }
5371 :
5372 0 : child_tsps.push((target.parent_id, this_child_tsps));
5373 : }
5374 :
5375 0 : if let Err(e) = self
5376 0 : .persistence
5377 0 : .begin_shard_split(old_shard_count, tenant_id, child_tsps)
5378 0 : .await
5379 : {
5380 0 : match e {
5381 : DatabaseError::Query(diesel::result::Error::DatabaseError(
5382 : DatabaseErrorKind::UniqueViolation,
5383 : _,
5384 : )) => {
5385 : // Inserting a child shard violated a unique constraint: we raced with another call to
5386 : // this function
5387 0 : tracing::warn!("Conflicting attempt to split {tenant_id}: {e}");
5388 0 : return Err(ApiError::Conflict("Tenant is already splitting".into()));
5389 : }
5390 0 : _ => return Err(ApiError::InternalServerError(e.into())),
5391 : }
5392 0 : }
5393 0 : fail::fail_point!("shard-split-post-begin", |_| Err(
5394 0 : ApiError::InternalServerError(anyhow::anyhow!("failpoint"))
5395 0 : ));
5396 :
5397 : // Now that I have persisted the splitting state, apply it in-memory. This is infallible, so
5398 : // callers may assume that if splitting is set in memory, then it was persisted, and if splitting
5399 : // is not set in memory, then it was not persisted.
5400 : {
5401 0 : let mut locked = self.inner.write().unwrap();
5402 0 : for target in &targets {
5403 0 : if let Some(parent_shard) = locked.tenants.get_mut(&target.parent_id) {
5404 0 : parent_shard.splitting = SplitState::Splitting;
5405 0 : // Put the observed state to None, to reflect that it is indeterminate once we start the
5406 0 : // split operation.
5407 0 : parent_shard
5408 0 : .observed
5409 0 : .locations
5410 0 : .insert(target.node.get_id(), ObservedStateLocation { conf: None });
5411 0 : }
5412 : }
5413 : }
5414 :
5415 : // TODO: issue split calls concurrently (this only matters once we're splitting
5416 : // N>1 shards into M shards -- initially we're usually splitting 1 shard into N).
5417 :
5418 0 : for target in &targets {
5419 : let ShardSplitTarget {
5420 0 : parent_id,
5421 0 : node,
5422 0 : child_ids,
5423 0 : } = target;
5424 0 : let client = PageserverClient::new(
5425 0 : node.get_id(),
5426 0 : self.http_client.clone(),
5427 0 : node.base_url(),
5428 0 : self.config.pageserver_jwt_token.as_deref(),
5429 0 : );
5430 0 : let response = client
5431 0 : .tenant_shard_split(
5432 0 : *parent_id,
5433 0 : TenantShardSplitRequest {
5434 0 : new_shard_count: new_shard_count.literal(),
5435 0 : new_stripe_size,
5436 0 : },
5437 0 : )
5438 0 : .await
5439 0 : .map_err(|e| ApiError::Conflict(format!("Failed to split {}: {}", parent_id, e)))?;
5440 :
5441 0 : fail::fail_point!("shard-split-post-remote", |_| Err(ApiError::Conflict(
5442 0 : "failpoint".to_string()
5443 0 : )));
5444 :
5445 0 : failpoint_support::sleep_millis_async!("shard-split-post-remote-sleep", &self.cancel);
5446 :
5447 0 : tracing::info!(
5448 0 : "Split {} into {}",
5449 0 : parent_id,
5450 0 : response
5451 0 : .new_shards
5452 0 : .iter()
5453 0 : .map(|s| format!("{:?}", s))
5454 0 : .collect::<Vec<_>>()
5455 0 : .join(",")
5456 : );
5457 :
5458 0 : if &response.new_shards != child_ids {
5459 : // This should never happen: the pageserver should agree with us on how shard splits work.
5460 0 : return Err(ApiError::InternalServerError(anyhow::anyhow!(
5461 0 : "Splitting shard {} resulted in unexpected IDs: {:?} (expected {:?})",
5462 0 : parent_id,
5463 0 : response.new_shards,
5464 0 : child_ids
5465 0 : )));
5466 0 : }
5467 : }
5468 :
5469 0 : pausable_failpoint!("shard-split-pre-complete");
5470 :
5471 : // TODO: if the pageserver restarted concurrently with our split API call,
5472 : // the actual generation of the child shard might differ from the generation
5473 : // we expect it to have. In order for our in-database generation to end up
5474 : // correct, we should carry the child generation back in the response and apply it here
5475 : // in complete_shard_split (and apply the correct generation in memory)
5476 : // (or, we can carry generation in the request and reject the request if
5477 : // it doesn't match, but that requires more retry logic on this side)
5478 :
5479 0 : self.persistence
5480 0 : .complete_shard_split(tenant_id, old_shard_count, new_shard_count)
5481 0 : .await?;
5482 :
5483 0 : fail::fail_point!("shard-split-post-complete", |_| Err(
5484 0 : ApiError::InternalServerError(anyhow::anyhow!("failpoint"))
5485 0 : ));
5486 :
5487 : // Replace all the shards we just split with their children: this phase is infallible.
5488 0 : let (response, child_locations, waiters) =
5489 0 : self.tenant_shard_split_commit_inmem(tenant_id, new_shard_count, new_stripe_size);
5490 0 :
5491 0 : // Send compute notifications for all the new shards
5492 0 : let mut failed_notifications = Vec::new();
5493 0 : for (child_id, child_ps, stripe_size) in child_locations {
5494 0 : if let Err(e) = self
5495 0 : .compute_hook
5496 0 : .notify(
5497 0 : compute_hook::ShardUpdate {
5498 0 : tenant_shard_id: child_id,
5499 0 : node_id: child_ps,
5500 0 : stripe_size,
5501 0 : preferred_az: preferred_az_id.as_ref().map(Cow::Borrowed),
5502 0 : },
5503 0 : &self.cancel,
5504 0 : )
5505 0 : .await
5506 : {
5507 0 : tracing::warn!(
5508 0 : "Failed to update compute of {}->{} during split, proceeding anyway to complete split ({e})",
5509 : child_id,
5510 : child_ps
5511 : );
5512 0 : failed_notifications.push(child_id);
5513 0 : }
5514 : }
5515 :
5516 : // If we failed any compute notifications, make a note to retry later.
5517 0 : if !failed_notifications.is_empty() {
5518 0 : let mut locked = self.inner.write().unwrap();
5519 0 : for failed in failed_notifications {
5520 0 : if let Some(shard) = locked.tenants.get_mut(&failed) {
5521 0 : shard.pending_compute_notification = true;
5522 0 : }
5523 : }
5524 0 : }
5525 :
5526 0 : Ok((response, waiters))
5527 0 : }
5528 :
5529 : /// A graceful migration: update the preferred node and let optimisation handle the migration
5530 : /// in the background (may take a long time as it will fully warm up a location before cutting over)
5531 : ///
5532 : /// Our external API calls this a 'prewarm=true' migration, but internally it isn't a special prewarm step: it's
5533 : /// just a migration that uses the same graceful procedure as our background scheduling optimisations would use.
5534 0 : fn tenant_shard_migrate_with_prewarm(
5535 0 : &self,
5536 0 : migrate_req: &TenantShardMigrateRequest,
5537 0 : shard: &mut TenantShard,
5538 0 : scheduler: &mut Scheduler,
5539 0 : schedule_context: ScheduleContext,
5540 0 : ) -> Result<Option<ScheduleOptimization>, ApiError> {
5541 0 : shard.set_preferred_node(Some(migrate_req.node_id));
5542 0 :
5543 0 : // Generate whatever the initial change to the intent is: this could be creation of a secondary, or
5544 0 : // cutting over to an existing secondary. Caller is responsible for validating this before applying it,
5545 0 : // e.g. by checking secondary is warm enough.
5546 0 : Ok(shard.optimize_attachment(scheduler, &schedule_context))
5547 0 : }
5548 :
5549 : /// Immediate migration: directly update the intent state and kick off a reconciler
5550 0 : fn tenant_shard_migrate_immediate(
5551 0 : &self,
5552 0 : migrate_req: &TenantShardMigrateRequest,
5553 0 : nodes: &Arc<HashMap<NodeId, Node>>,
5554 0 : shard: &mut TenantShard,
5555 0 : scheduler: &mut Scheduler,
5556 0 : ) -> Result<Option<ReconcilerWaiter>, ApiError> {
5557 0 : // Non-graceful migration: update the intent state immediately
5558 0 : let old_attached = *shard.intent.get_attached();
5559 0 : match shard.policy {
5560 0 : PlacementPolicy::Attached(n) => {
5561 0 : // If our new attached node was a secondary, it no longer should be.
5562 0 : shard
5563 0 : .intent
5564 0 : .remove_secondary(scheduler, migrate_req.node_id);
5565 0 :
5566 0 : shard
5567 0 : .intent
5568 0 : .set_attached(scheduler, Some(migrate_req.node_id));
5569 :
5570 : // If we were already attached to something, demote that to a secondary
5571 0 : if let Some(old_attached) = old_attached {
5572 0 : if n > 0 {
5573 : // Remove other secondaries to make room for the location we'll demote
5574 0 : while shard.intent.get_secondary().len() >= n {
5575 0 : shard.intent.pop_secondary(scheduler);
5576 0 : }
5577 :
5578 0 : shard.intent.push_secondary(scheduler, old_attached);
5579 0 : }
5580 0 : }
5581 : }
5582 0 : PlacementPolicy::Secondary => {
5583 0 : shard.intent.clear(scheduler);
5584 0 : shard.intent.push_secondary(scheduler, migrate_req.node_id);
5585 0 : }
5586 : PlacementPolicy::Detached => {
5587 0 : return Err(ApiError::BadRequest(anyhow::anyhow!(
5588 0 : "Cannot migrate a tenant that is PlacementPolicy::Detached: configure it to an attached policy first"
5589 0 : )));
5590 : }
5591 : }
5592 :
5593 0 : tracing::info!("Migrating: new intent {:?}", shard.intent);
5594 0 : shard.sequence = shard.sequence.next();
5595 0 : shard.set_preferred_node(None); // Abort any in-flight graceful migration
5596 0 : Ok(self.maybe_configured_reconcile_shard(
5597 0 : shard,
5598 0 : nodes,
5599 0 : (&migrate_req.migration_config).into(),
5600 0 : ))
5601 0 : }
5602 :
5603 0 : pub(crate) async fn tenant_shard_migrate(
5604 0 : &self,
5605 0 : tenant_shard_id: TenantShardId,
5606 0 : migrate_req: TenantShardMigrateRequest,
5607 0 : ) -> Result<TenantShardMigrateResponse, ApiError> {
5608 : // Depending on whether the migration is a change and whether it's graceful or immediate, we might
5609 : // get a different outcome to handle
5610 : enum MigrationOutcome {
5611 : Optimization(Option<ScheduleOptimization>),
5612 : Reconcile(Option<ReconcilerWaiter>),
5613 : }
5614 :
5615 0 : let outcome = {
5616 0 : let mut locked = self.inner.write().unwrap();
5617 0 : let (nodes, tenants, scheduler) = locked.parts_mut();
5618 :
5619 0 : let Some(node) = nodes.get(&migrate_req.node_id) else {
5620 0 : return Err(ApiError::BadRequest(anyhow::anyhow!(
5621 0 : "Node {} not found",
5622 0 : migrate_req.node_id
5623 0 : )));
5624 : };
5625 :
5626 : // Migration to unavavailable node requires force flag
5627 0 : if !node.is_available() {
5628 0 : if migrate_req.migration_config.override_scheduler {
5629 : // Warn but proceed: the caller may intend to manually adjust the placement of
5630 : // a shard even if the node is down, e.g. if intervening during an incident.
5631 0 : tracing::warn!("Forcibly migrating to unavailable node {node}");
5632 : } else {
5633 0 : tracing::warn!("Node {node} is unavailable, refusing migration");
5634 0 : return Err(ApiError::PreconditionFailed(
5635 0 : format!("Node {node} is unavailable").into_boxed_str(),
5636 0 : ));
5637 : }
5638 0 : }
5639 :
5640 : // Calculate the ScheduleContext for this tenant
5641 0 : let mut schedule_context = ScheduleContext::default();
5642 0 : for (_shard_id, shard) in
5643 0 : tenants.range(TenantShardId::tenant_range(tenant_shard_id.tenant_id))
5644 0 : {
5645 0 : schedule_context.avoid(&shard.intent.all_pageservers());
5646 0 : }
5647 :
5648 : // Look up the specific shard we will migrate
5649 0 : let Some(shard) = tenants.get_mut(&tenant_shard_id) else {
5650 0 : return Err(ApiError::NotFound(
5651 0 : anyhow::anyhow!("Tenant shard not found").into(),
5652 0 : ));
5653 : };
5654 :
5655 : // Migration to a node with unfavorable scheduling score requires a force flag, because it might just
5656 : // be migrated back by the optimiser.
5657 0 : if let Some(better_node) = shard.find_better_location::<AttachedShardTag>(
5658 0 : scheduler,
5659 0 : &schedule_context,
5660 0 : migrate_req.node_id,
5661 0 : &[],
5662 0 : ) {
5663 0 : if !migrate_req.migration_config.override_scheduler {
5664 0 : return Err(ApiError::PreconditionFailed(
5665 0 : "Migration to a worse-scoring node".into(),
5666 0 : ));
5667 : } else {
5668 0 : tracing::info!(
5669 0 : "Migrating to a worse-scoring node {} (optimiser would prefer {better_node})",
5670 : migrate_req.node_id
5671 : );
5672 : }
5673 0 : }
5674 :
5675 0 : if let Some(origin_node_id) = migrate_req.origin_node_id {
5676 0 : if shard.intent.get_attached() != &Some(origin_node_id) {
5677 0 : return Err(ApiError::PreconditionFailed(
5678 0 : format!(
5679 0 : "Migration expected to originate from {} but shard is on {:?}",
5680 0 : origin_node_id,
5681 0 : shard.intent.get_attached()
5682 0 : )
5683 0 : .into(),
5684 0 : ));
5685 0 : }
5686 0 : }
5687 :
5688 0 : if shard.intent.get_attached() == &Some(migrate_req.node_id) {
5689 : // No-op case: we will still proceed to wait for reconciliation in case it is
5690 : // incomplete from an earlier update to the intent.
5691 0 : tracing::info!("Migrating: intent is unchanged {:?}", shard.intent);
5692 :
5693 : // An instruction to migrate to the currently attached node should
5694 : // cancel any pending graceful migration
5695 0 : shard.set_preferred_node(None);
5696 0 :
5697 0 : MigrationOutcome::Reconcile(self.maybe_configured_reconcile_shard(
5698 0 : shard,
5699 0 : nodes,
5700 0 : (&migrate_req.migration_config).into(),
5701 0 : ))
5702 0 : } else if migrate_req.migration_config.prewarm {
5703 0 : MigrationOutcome::Optimization(self.tenant_shard_migrate_with_prewarm(
5704 0 : &migrate_req,
5705 0 : shard,
5706 0 : scheduler,
5707 0 : schedule_context,
5708 0 : )?)
5709 : } else {
5710 0 : MigrationOutcome::Reconcile(self.tenant_shard_migrate_immediate(
5711 0 : &migrate_req,
5712 0 : nodes,
5713 0 : shard,
5714 0 : scheduler,
5715 0 : )?)
5716 : }
5717 : };
5718 :
5719 : // We may need to validate + apply an optimisation, or we may need to just retrive a reconcile waiter
5720 0 : let waiter = match outcome {
5721 0 : MigrationOutcome::Optimization(Some(optimization)) => {
5722 : // Validate and apply the optimization -- this would happen anyway in background reconcile loop, but
5723 : // we might as well do it more promptly as this is a direct external request.
5724 0 : let mut validated = self
5725 0 : .optimize_all_validate(vec![(tenant_shard_id, optimization)])
5726 0 : .await;
5727 0 : if let Some((_shard_id, optimization)) = validated.pop() {
5728 0 : let mut locked = self.inner.write().unwrap();
5729 0 : let (nodes, tenants, scheduler) = locked.parts_mut();
5730 0 : let Some(shard) = tenants.get_mut(&tenant_shard_id) else {
5731 : // Rare but possible: tenant is removed between generating optimisation and validating it.
5732 0 : return Err(ApiError::NotFound(
5733 0 : anyhow::anyhow!("Tenant shard not found").into(),
5734 0 : ));
5735 : };
5736 :
5737 0 : if !shard.apply_optimization(scheduler, optimization) {
5738 : // This can happen but is unusual enough to warn on: something else changed in the shard that made the optimisation stale
5739 : // and therefore not applied.
5740 0 : tracing::warn!(
5741 0 : "Schedule optimisation generated during graceful migration was not applied, shard changed?"
5742 : );
5743 0 : }
5744 0 : self.maybe_configured_reconcile_shard(
5745 0 : shard,
5746 0 : nodes,
5747 0 : (&migrate_req.migration_config).into(),
5748 0 : )
5749 : } else {
5750 0 : None
5751 : }
5752 : }
5753 0 : MigrationOutcome::Optimization(None) => None,
5754 0 : MigrationOutcome::Reconcile(waiter) => waiter,
5755 : };
5756 :
5757 : // Finally, wait for any reconcile we started to complete. In the case of immediate-mode migrations to cold
5758 : // locations, this has a good chance of timing out.
5759 0 : if let Some(waiter) = waiter {
5760 0 : waiter.wait_timeout(RECONCILE_TIMEOUT).await?;
5761 : } else {
5762 0 : tracing::info!("Migration is a no-op");
5763 : }
5764 :
5765 0 : Ok(TenantShardMigrateResponse {})
5766 0 : }
5767 :
5768 0 : pub(crate) async fn tenant_shard_migrate_secondary(
5769 0 : &self,
5770 0 : tenant_shard_id: TenantShardId,
5771 0 : migrate_req: TenantShardMigrateRequest,
5772 0 : ) -> Result<TenantShardMigrateResponse, ApiError> {
5773 0 : let waiter = {
5774 0 : let mut locked = self.inner.write().unwrap();
5775 0 : let (nodes, tenants, scheduler) = locked.parts_mut();
5776 :
5777 0 : let Some(node) = nodes.get(&migrate_req.node_id) else {
5778 0 : return Err(ApiError::BadRequest(anyhow::anyhow!(
5779 0 : "Node {} not found",
5780 0 : migrate_req.node_id
5781 0 : )));
5782 : };
5783 :
5784 0 : if !node.is_available() {
5785 : // Warn but proceed: the caller may intend to manually adjust the placement of
5786 : // a shard even if the node is down, e.g. if intervening during an incident.
5787 0 : tracing::warn!("Migrating to unavailable node {node}");
5788 0 : }
5789 :
5790 0 : let Some(shard) = tenants.get_mut(&tenant_shard_id) else {
5791 0 : return Err(ApiError::NotFound(
5792 0 : anyhow::anyhow!("Tenant shard not found").into(),
5793 0 : ));
5794 : };
5795 :
5796 0 : if shard.intent.get_secondary().len() == 1
5797 0 : && shard.intent.get_secondary()[0] == migrate_req.node_id
5798 : {
5799 0 : tracing::info!(
5800 0 : "Migrating secondary to {node}: intent is unchanged {:?}",
5801 : shard.intent
5802 : );
5803 0 : } else if shard.intent.get_attached() == &Some(migrate_req.node_id) {
5804 0 : tracing::info!(
5805 0 : "Migrating secondary to {node}: already attached where we were asked to create a secondary"
5806 : );
5807 : } else {
5808 0 : let old_secondaries = shard.intent.get_secondary().clone();
5809 0 : for secondary in old_secondaries {
5810 0 : shard.intent.remove_secondary(scheduler, secondary);
5811 0 : }
5812 :
5813 0 : shard.intent.push_secondary(scheduler, migrate_req.node_id);
5814 0 : shard.sequence = shard.sequence.next();
5815 0 : tracing::info!(
5816 0 : "Migrating secondary to {node}: new intent {:?}",
5817 : shard.intent
5818 : );
5819 : }
5820 :
5821 0 : self.maybe_reconcile_shard(shard, nodes, ReconcilerPriority::High)
5822 : };
5823 :
5824 0 : if let Some(waiter) = waiter {
5825 0 : waiter.wait_timeout(RECONCILE_TIMEOUT).await?;
5826 : } else {
5827 0 : tracing::info!("Migration is a no-op");
5828 : }
5829 :
5830 0 : Ok(TenantShardMigrateResponse {})
5831 0 : }
5832 :
5833 : /// 'cancel' in this context means cancel any ongoing reconcile
5834 0 : pub(crate) async fn tenant_shard_cancel_reconcile(
5835 0 : &self,
5836 0 : tenant_shard_id: TenantShardId,
5837 0 : ) -> Result<(), ApiError> {
5838 : // Take state lock and fire the cancellation token, after which we drop lock and wait for any ongoing reconcile to complete
5839 0 : let waiter = {
5840 0 : let locked = self.inner.write().unwrap();
5841 0 : let Some(shard) = locked.tenants.get(&tenant_shard_id) else {
5842 0 : return Err(ApiError::NotFound(
5843 0 : anyhow::anyhow!("Tenant shard not found").into(),
5844 0 : ));
5845 : };
5846 :
5847 0 : let waiter = shard.get_waiter();
5848 0 : match waiter {
5849 : None => {
5850 0 : tracing::info!("Shard does not have an ongoing Reconciler");
5851 0 : return Ok(());
5852 : }
5853 0 : Some(waiter) => {
5854 0 : tracing::info!("Cancelling Reconciler");
5855 0 : shard.cancel_reconciler();
5856 0 : waiter
5857 0 : }
5858 0 : }
5859 0 : };
5860 0 :
5861 0 : // Cancellation should be prompt. If this fails we have still done our job of firing the
5862 0 : // cancellation token, but by returning an ApiError we will indicate to the caller that
5863 0 : // the Reconciler is misbehaving and not respecting the cancellation token
5864 0 : self.await_waiters(vec![waiter], SHORT_RECONCILE_TIMEOUT)
5865 0 : .await?;
5866 :
5867 0 : Ok(())
5868 0 : }
5869 :
5870 : /// This is for debug/support only: we simply drop all state for a tenant, without
5871 : /// detaching or deleting it on pageservers.
5872 0 : pub(crate) async fn tenant_drop(&self, tenant_id: TenantId) -> Result<(), ApiError> {
5873 0 : self.persistence.delete_tenant(tenant_id).await?;
5874 :
5875 0 : let mut locked = self.inner.write().unwrap();
5876 0 : let (_nodes, tenants, scheduler) = locked.parts_mut();
5877 0 : let mut shards = Vec::new();
5878 0 : for (tenant_shard_id, _) in tenants.range(TenantShardId::tenant_range(tenant_id)) {
5879 0 : shards.push(*tenant_shard_id);
5880 0 : }
5881 :
5882 0 : for shard_id in shards {
5883 0 : if let Some(mut shard) = tenants.remove(&shard_id) {
5884 0 : shard.intent.clear(scheduler);
5885 0 : }
5886 : }
5887 :
5888 0 : Ok(())
5889 0 : }
5890 :
5891 : /// This is for debug/support only: assuming tenant data is already present in S3, we "create" a
5892 : /// tenant with a very high generation number so that it will see the existing data.
5893 0 : pub(crate) async fn tenant_import(
5894 0 : &self,
5895 0 : tenant_id: TenantId,
5896 0 : ) -> Result<TenantCreateResponse, ApiError> {
5897 0 : // Pick an arbitrary available pageserver to use for scanning the tenant in remote storage
5898 0 : let maybe_node = {
5899 0 : self.inner
5900 0 : .read()
5901 0 : .unwrap()
5902 0 : .nodes
5903 0 : .values()
5904 0 : .find(|n| n.is_available())
5905 0 : .cloned()
5906 : };
5907 0 : let Some(node) = maybe_node else {
5908 0 : return Err(ApiError::BadRequest(anyhow::anyhow!("No nodes available")));
5909 : };
5910 :
5911 0 : let client = PageserverClient::new(
5912 0 : node.get_id(),
5913 0 : self.http_client.clone(),
5914 0 : node.base_url(),
5915 0 : self.config.pageserver_jwt_token.as_deref(),
5916 0 : );
5917 :
5918 0 : let scan_result = client
5919 0 : .tenant_scan_remote_storage(tenant_id)
5920 0 : .await
5921 0 : .map_err(|e| passthrough_api_error(&node, e))?;
5922 :
5923 : // A post-split tenant may contain a mixture of shard counts in remote storage: pick the highest count.
5924 0 : let Some(shard_count) = scan_result
5925 0 : .shards
5926 0 : .iter()
5927 0 : .map(|s| s.tenant_shard_id.shard_count)
5928 0 : .max()
5929 : else {
5930 0 : return Err(ApiError::NotFound(
5931 0 : anyhow::anyhow!("No shards found").into(),
5932 0 : ));
5933 : };
5934 :
5935 : // Ideally we would set each newly imported shard's generation independently, but for correctness it is sufficient
5936 : // to
5937 0 : let generation = scan_result
5938 0 : .shards
5939 0 : .iter()
5940 0 : .map(|s| s.generation)
5941 0 : .max()
5942 0 : .expect("We already validated >0 shards");
5943 0 :
5944 0 : // FIXME: we have no way to recover the shard stripe size from contents of remote storage: this will
5945 0 : // only work if they were using the default stripe size.
5946 0 : let stripe_size = ShardParameters::DEFAULT_STRIPE_SIZE;
5947 :
5948 0 : let (response, waiters) = self
5949 0 : .do_tenant_create(TenantCreateRequest {
5950 0 : new_tenant_id: TenantShardId::unsharded(tenant_id),
5951 0 : generation,
5952 0 :
5953 0 : shard_parameters: ShardParameters {
5954 0 : count: shard_count,
5955 0 : stripe_size,
5956 0 : },
5957 0 : placement_policy: Some(PlacementPolicy::Attached(0)), // No secondaries, for convenient debug/hacking
5958 0 : config: TenantConfig::default(),
5959 0 : })
5960 0 : .await?;
5961 :
5962 0 : if let Err(e) = self.await_waiters(waiters, SHORT_RECONCILE_TIMEOUT).await {
5963 : // Since this is a debug/support operation, all kinds of weird issues are possible (e.g. this
5964 : // tenant doesn't exist in the control plane), so don't fail the request if it can't fully
5965 : // reconcile, as reconciliation includes notifying compute.
5966 0 : tracing::warn!(%tenant_id, "Reconcile not done yet while importing tenant ({e})");
5967 0 : }
5968 :
5969 0 : Ok(response)
5970 0 : }
5971 :
5972 : /// For debug/support: a full JSON dump of TenantShards. Returns a response so that
5973 : /// we don't have to make TenantShard clonable in the return path.
5974 0 : pub(crate) fn tenants_dump(&self) -> Result<hyper::Response<hyper::Body>, ApiError> {
5975 0 : let serialized = {
5976 0 : let locked = self.inner.read().unwrap();
5977 0 : let result = locked.tenants.values().collect::<Vec<_>>();
5978 0 : serde_json::to_string(&result).map_err(|e| ApiError::InternalServerError(e.into()))?
5979 : };
5980 :
5981 0 : hyper::Response::builder()
5982 0 : .status(hyper::StatusCode::OK)
5983 0 : .header(hyper::header::CONTENT_TYPE, "application/json")
5984 0 : .body(hyper::Body::from(serialized))
5985 0 : .map_err(|e| ApiError::InternalServerError(e.into()))
5986 0 : }
5987 :
5988 : /// Check the consistency of in-memory state vs. persistent state, and check that the
5989 : /// scheduler's statistics are up to date.
5990 : ///
5991 : /// These consistency checks expect an **idle** system. If changes are going on while
5992 : /// we run, then we can falsely indicate a consistency issue. This is sufficient for end-of-test
5993 : /// checks, but not suitable for running continuously in the background in the field.
5994 0 : pub(crate) async fn consistency_check(&self) -> Result<(), ApiError> {
5995 0 : let (mut expect_nodes, mut expect_shards) = {
5996 0 : let locked = self.inner.read().unwrap();
5997 0 :
5998 0 : locked
5999 0 : .scheduler
6000 0 : .consistency_check(locked.nodes.values(), locked.tenants.values())
6001 0 : .context("Scheduler checks")
6002 0 : .map_err(ApiError::InternalServerError)?;
6003 :
6004 0 : let expect_nodes = locked
6005 0 : .nodes
6006 0 : .values()
6007 0 : .map(|n| n.to_persistent())
6008 0 : .collect::<Vec<_>>();
6009 0 :
6010 0 : let expect_shards = locked
6011 0 : .tenants
6012 0 : .values()
6013 0 : .map(|t| t.to_persistent())
6014 0 : .collect::<Vec<_>>();
6015 :
6016 : // This method can only validate the state of an idle system: if a reconcile is in
6017 : // progress, fail out early to avoid giving false errors on state that won't match
6018 : // between database and memory under a ReconcileResult is processed.
6019 0 : for t in locked.tenants.values() {
6020 0 : if t.reconciler.is_some() {
6021 0 : return Err(ApiError::InternalServerError(anyhow::anyhow!(
6022 0 : "Shard {} reconciliation in progress",
6023 0 : t.tenant_shard_id
6024 0 : )));
6025 0 : }
6026 : }
6027 :
6028 0 : (expect_nodes, expect_shards)
6029 : };
6030 :
6031 0 : let mut nodes = self.persistence.list_nodes().await?;
6032 0 : expect_nodes.sort_by_key(|n| n.node_id);
6033 0 : nodes.sort_by_key(|n| n.node_id);
6034 :
6035 : // Errors relating to nodes are deferred so that we don't skip the shard checks below if we have a node error
6036 0 : let node_result = if nodes != expect_nodes {
6037 0 : tracing::error!("Consistency check failed on nodes.");
6038 0 : tracing::error!(
6039 0 : "Nodes in memory: {}",
6040 0 : serde_json::to_string(&expect_nodes)
6041 0 : .map_err(|e| ApiError::InternalServerError(e.into()))?
6042 : );
6043 0 : tracing::error!(
6044 0 : "Nodes in database: {}",
6045 0 : serde_json::to_string(&nodes)
6046 0 : .map_err(|e| ApiError::InternalServerError(e.into()))?
6047 : );
6048 0 : Err(ApiError::InternalServerError(anyhow::anyhow!(
6049 0 : "Node consistency failure"
6050 0 : )))
6051 : } else {
6052 0 : Ok(())
6053 : };
6054 :
6055 0 : let mut persistent_shards = self.persistence.load_active_tenant_shards().await?;
6056 0 : persistent_shards
6057 0 : .sort_by_key(|tsp| (tsp.tenant_id.clone(), tsp.shard_number, tsp.shard_count));
6058 0 :
6059 0 : expect_shards.sort_by_key(|tsp| (tsp.tenant_id.clone(), tsp.shard_number, tsp.shard_count));
6060 :
6061 : // Because JSON contents of persistent tenants might disagree with the fields in current `TenantConfig`
6062 : // definition, we will do an encode/decode cycle to ensure any legacy fields are dropped and any new
6063 : // fields are added, before doing a comparison.
6064 0 : for tsp in &mut persistent_shards {
6065 0 : let config: TenantConfig = serde_json::from_str(&tsp.config)
6066 0 : .map_err(|e| ApiError::InternalServerError(e.into()))?;
6067 0 : tsp.config = serde_json::to_string(&config).expect("Encoding config is infallible");
6068 : }
6069 :
6070 0 : if persistent_shards != expect_shards {
6071 0 : tracing::error!("Consistency check failed on shards.");
6072 :
6073 0 : tracing::error!(
6074 0 : "Shards in memory: {}",
6075 0 : serde_json::to_string(&expect_shards)
6076 0 : .map_err(|e| ApiError::InternalServerError(e.into()))?
6077 : );
6078 0 : tracing::error!(
6079 0 : "Shards in database: {}",
6080 0 : serde_json::to_string(&persistent_shards)
6081 0 : .map_err(|e| ApiError::InternalServerError(e.into()))?
6082 : );
6083 :
6084 : // The total dump log lines above are useful in testing but in the field grafana will
6085 : // usually just drop them because they're so large. So we also do some explicit logging
6086 : // of just the diffs.
6087 0 : let persistent_shards = persistent_shards
6088 0 : .into_iter()
6089 0 : .map(|tsp| (tsp.get_tenant_shard_id().unwrap(), tsp))
6090 0 : .collect::<HashMap<_, _>>();
6091 0 : let expect_shards = expect_shards
6092 0 : .into_iter()
6093 0 : .map(|tsp| (tsp.get_tenant_shard_id().unwrap(), tsp))
6094 0 : .collect::<HashMap<_, _>>();
6095 0 : for (tenant_shard_id, persistent_tsp) in &persistent_shards {
6096 0 : match expect_shards.get(tenant_shard_id) {
6097 : None => {
6098 0 : tracing::error!(
6099 0 : "Shard {} found in database but not in memory",
6100 : tenant_shard_id
6101 : );
6102 : }
6103 0 : Some(expect_tsp) => {
6104 0 : if expect_tsp != persistent_tsp {
6105 0 : tracing::error!(
6106 0 : "Shard {} is inconsistent. In memory: {}, database has: {}",
6107 0 : tenant_shard_id,
6108 0 : serde_json::to_string(expect_tsp).unwrap(),
6109 0 : serde_json::to_string(&persistent_tsp).unwrap()
6110 : );
6111 0 : }
6112 : }
6113 : }
6114 : }
6115 :
6116 : // Having already logged any differences, log any shards that simply aren't present in the database
6117 0 : for (tenant_shard_id, memory_tsp) in &expect_shards {
6118 0 : if !persistent_shards.contains_key(tenant_shard_id) {
6119 0 : tracing::error!(
6120 0 : "Shard {} found in memory but not in database: {}",
6121 0 : tenant_shard_id,
6122 0 : serde_json::to_string(memory_tsp)
6123 0 : .map_err(|e| ApiError::InternalServerError(e.into()))?
6124 : );
6125 0 : }
6126 : }
6127 :
6128 0 : return Err(ApiError::InternalServerError(anyhow::anyhow!(
6129 0 : "Shard consistency failure"
6130 0 : )));
6131 0 : }
6132 0 :
6133 0 : node_result
6134 0 : }
6135 :
6136 : /// For debug/support: a JSON dump of the [`Scheduler`]. Returns a response so that
6137 : /// we don't have to make TenantShard clonable in the return path.
6138 0 : pub(crate) fn scheduler_dump(&self) -> Result<hyper::Response<hyper::Body>, ApiError> {
6139 0 : let serialized = {
6140 0 : let locked = self.inner.read().unwrap();
6141 0 : serde_json::to_string(&locked.scheduler)
6142 0 : .map_err(|e| ApiError::InternalServerError(e.into()))?
6143 : };
6144 :
6145 0 : hyper::Response::builder()
6146 0 : .status(hyper::StatusCode::OK)
6147 0 : .header(hyper::header::CONTENT_TYPE, "application/json")
6148 0 : .body(hyper::Body::from(serialized))
6149 0 : .map_err(|e| ApiError::InternalServerError(e.into()))
6150 0 : }
6151 :
6152 : /// This is for debug/support only: we simply drop all state for a tenant, without
6153 : /// detaching or deleting it on pageservers. We do not try and re-schedule any
6154 : /// tenants that were on this node.
6155 0 : pub(crate) async fn node_drop(&self, node_id: NodeId) -> Result<(), ApiError> {
6156 0 : self.persistence.delete_node(node_id).await?;
6157 :
6158 0 : let mut locked = self.inner.write().unwrap();
6159 :
6160 0 : for shard in locked.tenants.values_mut() {
6161 0 : shard.deref_node(node_id);
6162 0 : shard.observed.locations.remove(&node_id);
6163 0 : }
6164 :
6165 0 : let mut nodes = (*locked.nodes).clone();
6166 0 : nodes.remove(&node_id);
6167 0 : locked.nodes = Arc::new(nodes);
6168 0 : metrics::METRICS_REGISTRY
6169 0 : .metrics_group
6170 0 : .storage_controller_pageserver_nodes
6171 0 : .set(locked.nodes.len() as i64);
6172 0 :
6173 0 : locked.scheduler.node_remove(node_id);
6174 0 :
6175 0 : Ok(())
6176 0 : }
6177 :
6178 : /// If a node has any work on it, it will be rescheduled: this is "clean" in the sense
6179 : /// that we don't leave any bad state behind in the storage controller, but unclean
6180 : /// in the sense that we are not carefully draining the node.
6181 0 : pub(crate) async fn node_delete(&self, node_id: NodeId) -> Result<(), ApiError> {
6182 0 : let _node_lock =
6183 0 : trace_exclusive_lock(&self.node_op_locks, node_id, NodeOperations::Delete).await;
6184 :
6185 : // 1. Atomically update in-memory state:
6186 : // - set the scheduling state to Pause to make subsequent scheduling ops skip it
6187 : // - update shards' intents to exclude the node, and reschedule any shards whose intents we modified.
6188 : // - drop the node from the main nodes map, so that when running reconciles complete they do not
6189 : // re-insert references to this node into the ObservedState of shards
6190 : // - drop the node from the scheduler
6191 : {
6192 0 : let mut locked = self.inner.write().unwrap();
6193 0 : let (nodes, tenants, scheduler) = locked.parts_mut();
6194 0 :
6195 0 : {
6196 0 : let mut nodes_mut = (*nodes).deref().clone();
6197 0 : match nodes_mut.get_mut(&node_id) {
6198 0 : Some(node) => {
6199 0 : // We do not bother setting this in the database, because we're about to delete the row anyway, and
6200 0 : // if we crash it would not be desirable to leave the node paused after a restart.
6201 0 : node.set_scheduling(NodeSchedulingPolicy::Pause);
6202 0 : }
6203 : None => {
6204 0 : tracing::info!(
6205 0 : "Node not found: presuming this is a retry and returning success"
6206 : );
6207 0 : return Ok(());
6208 : }
6209 : }
6210 :
6211 0 : *nodes = Arc::new(nodes_mut);
6212 : }
6213 :
6214 0 : for (_tenant_id, mut schedule_context, shards) in
6215 0 : TenantShardContextIterator::new(tenants, ScheduleMode::Normal)
6216 : {
6217 0 : for shard in shards {
6218 0 : if shard.deref_node(node_id) {
6219 0 : if let Err(e) = shard.schedule(scheduler, &mut schedule_context) {
6220 : // TODO: implement force flag to remove a node even if we can't reschedule
6221 : // a tenant
6222 0 : tracing::error!(
6223 0 : "Refusing to delete node, shard {} can't be rescheduled: {e}",
6224 : shard.tenant_shard_id
6225 : );
6226 0 : return Err(e.into());
6227 : } else {
6228 0 : tracing::info!(
6229 0 : "Rescheduled shard {} away from node during deletion",
6230 : shard.tenant_shard_id
6231 : )
6232 : }
6233 :
6234 0 : self.maybe_reconcile_shard(shard, nodes, ReconcilerPriority::Normal);
6235 0 : }
6236 :
6237 : // Here we remove an existing observed location for the node we're removing, and it will
6238 : // not be re-added by a reconciler's completion because we filter out removed nodes in
6239 : // process_result.
6240 : //
6241 : // Note that we update the shard's observed state _after_ calling maybe_reconcile_shard: that
6242 : // means any reconciles we spawned will know about the node we're deleting, enabling them
6243 : // to do live migrations if it's still online.
6244 0 : shard.observed.locations.remove(&node_id);
6245 : }
6246 : }
6247 :
6248 0 : scheduler.node_remove(node_id);
6249 0 :
6250 0 : {
6251 0 : let mut nodes_mut = (**nodes).clone();
6252 0 : if let Some(mut removed_node) = nodes_mut.remove(&node_id) {
6253 0 : // Ensure that any reconciler holding an Arc<> to this node will
6254 0 : // drop out when trying to RPC to it (setting Offline state sets the
6255 0 : // cancellation token on the Node object).
6256 0 : removed_node.set_availability(NodeAvailability::Offline);
6257 0 : }
6258 0 : *nodes = Arc::new(nodes_mut);
6259 0 : metrics::METRICS_REGISTRY
6260 0 : .metrics_group
6261 0 : .storage_controller_pageserver_nodes
6262 0 : .set(nodes.len() as i64);
6263 0 : }
6264 0 : }
6265 0 :
6266 0 : // Note: some `generation_pageserver` columns on tenant shards in the database may still refer to
6267 0 : // the removed node, as this column means "The pageserver to which this generation was issued", and
6268 0 : // their generations won't get updated until the reconcilers moving them away from this node complete.
6269 0 : // That is safe because in Service::spawn we only use generation_pageserver if it refers to a node
6270 0 : // that exists.
6271 0 :
6272 0 : // 2. Actually delete the node from the database and from in-memory state
6273 0 : tracing::info!("Deleting node from database");
6274 0 : self.persistence.delete_node(node_id).await?;
6275 :
6276 0 : Ok(())
6277 0 : }
6278 :
6279 0 : pub(crate) async fn node_list(&self) -> Result<Vec<Node>, ApiError> {
6280 0 : let nodes = {
6281 0 : self.inner
6282 0 : .read()
6283 0 : .unwrap()
6284 0 : .nodes
6285 0 : .values()
6286 0 : .cloned()
6287 0 : .collect::<Vec<_>>()
6288 0 : };
6289 0 :
6290 0 : Ok(nodes)
6291 0 : }
6292 :
6293 0 : pub(crate) async fn get_node(&self, node_id: NodeId) -> Result<Node, ApiError> {
6294 0 : self.inner
6295 0 : .read()
6296 0 : .unwrap()
6297 0 : .nodes
6298 0 : .get(&node_id)
6299 0 : .cloned()
6300 0 : .ok_or(ApiError::NotFound(
6301 0 : format!("Node {node_id} not registered").into(),
6302 0 : ))
6303 0 : }
6304 :
6305 0 : pub(crate) async fn get_node_shards(
6306 0 : &self,
6307 0 : node_id: NodeId,
6308 0 : ) -> Result<NodeShardResponse, ApiError> {
6309 0 : let locked = self.inner.read().unwrap();
6310 0 : let mut shards = Vec::new();
6311 0 : for (tid, tenant) in locked.tenants.iter() {
6312 0 : let is_intended_secondary = match (
6313 0 : tenant.intent.get_attached() == &Some(node_id),
6314 0 : tenant.intent.get_secondary().contains(&node_id),
6315 0 : ) {
6316 : (true, true) => {
6317 0 : return Err(ApiError::InternalServerError(anyhow::anyhow!(
6318 0 : "{} attached as primary+secondary on the same node",
6319 0 : tid
6320 0 : )));
6321 : }
6322 0 : (true, false) => Some(false),
6323 0 : (false, true) => Some(true),
6324 0 : (false, false) => None,
6325 : };
6326 0 : let is_observed_secondary = if let Some(ObservedStateLocation { conf: Some(conf) }) =
6327 0 : tenant.observed.locations.get(&node_id)
6328 : {
6329 0 : Some(conf.secondary_conf.is_some())
6330 : } else {
6331 0 : None
6332 : };
6333 0 : if is_intended_secondary.is_some() || is_observed_secondary.is_some() {
6334 0 : shards.push(NodeShard {
6335 0 : tenant_shard_id: *tid,
6336 0 : is_intended_secondary,
6337 0 : is_observed_secondary,
6338 0 : });
6339 0 : }
6340 : }
6341 0 : Ok(NodeShardResponse { node_id, shards })
6342 0 : }
6343 :
6344 0 : pub(crate) async fn get_leader(&self) -> DatabaseResult<Option<ControllerPersistence>> {
6345 0 : self.persistence.get_leader().await
6346 0 : }
6347 :
6348 0 : pub(crate) async fn node_register(
6349 0 : &self,
6350 0 : register_req: NodeRegisterRequest,
6351 0 : ) -> Result<(), ApiError> {
6352 0 : let _node_lock = trace_exclusive_lock(
6353 0 : &self.node_op_locks,
6354 0 : register_req.node_id,
6355 0 : NodeOperations::Register,
6356 0 : )
6357 0 : .await;
6358 :
6359 : #[derive(PartialEq)]
6360 : enum RegistrationStatus {
6361 : UpToDate,
6362 : NeedUpdate,
6363 : Mismatched,
6364 : New,
6365 : }
6366 :
6367 0 : let registration_status = {
6368 0 : let locked = self.inner.read().unwrap();
6369 0 : if let Some(node) = locked.nodes.get(®ister_req.node_id) {
6370 0 : if node.registration_match(®ister_req) {
6371 0 : if node.need_update(®ister_req) {
6372 0 : RegistrationStatus::NeedUpdate
6373 : } else {
6374 0 : RegistrationStatus::UpToDate
6375 : }
6376 : } else {
6377 0 : RegistrationStatus::Mismatched
6378 : }
6379 : } else {
6380 0 : RegistrationStatus::New
6381 : }
6382 : };
6383 :
6384 0 : match registration_status {
6385 : RegistrationStatus::UpToDate => {
6386 0 : tracing::info!(
6387 0 : "Node {} re-registered with matching address and is up to date",
6388 : register_req.node_id
6389 : );
6390 :
6391 0 : return Ok(());
6392 : }
6393 : RegistrationStatus::Mismatched => {
6394 : // TODO: decide if we want to allow modifying node addresses without removing and re-adding
6395 : // the node. Safest/simplest thing is to refuse it, and usually we deploy with
6396 : // a fixed address through the lifetime of a node.
6397 0 : tracing::warn!(
6398 0 : "Node {} tried to register with different address",
6399 : register_req.node_id
6400 : );
6401 0 : return Err(ApiError::Conflict(
6402 0 : "Node is already registered with different address".to_string(),
6403 0 : ));
6404 : }
6405 0 : RegistrationStatus::New | RegistrationStatus::NeedUpdate => {
6406 0 : // fallthrough
6407 0 : }
6408 0 : }
6409 0 :
6410 0 : // We do not require that a node is actually online when registered (it will start life
6411 0 : // with it's availability set to Offline), but we _do_ require that its DNS record exists. We're
6412 0 : // therefore not immune to asymmetric L3 connectivity issues, but we are protected against nodes
6413 0 : // that register themselves with a broken DNS config. We check only the HTTP hostname, because
6414 0 : // the postgres hostname might only be resolvable to clients (e.g. if we're on a different VPC than clients).
6415 0 : if tokio::net::lookup_host(format!(
6416 0 : "{}:{}",
6417 0 : register_req.listen_http_addr, register_req.listen_http_port
6418 0 : ))
6419 0 : .await
6420 0 : .is_err()
6421 : {
6422 : // If we have a transient DNS issue, it's up to the caller to retry their registration. Because
6423 : // we can't robustly distinguish between an intermittent issue and a totally bogus DNS situation,
6424 : // we return a soft 503 error, to encourage callers to retry past transient issues.
6425 0 : return Err(ApiError::ResourceUnavailable(
6426 0 : format!(
6427 0 : "Node {} tried to register with unknown DNS name '{}'",
6428 0 : register_req.node_id, register_req.listen_http_addr
6429 0 : )
6430 0 : .into(),
6431 0 : ));
6432 0 : }
6433 0 :
6434 0 : if self.config.use_https_pageserver_api && register_req.listen_https_port.is_none() {
6435 0 : return Err(ApiError::PreconditionFailed(
6436 0 : format!(
6437 0 : "Node {} has no https port, but use_https is enabled",
6438 0 : register_req.node_id
6439 0 : )
6440 0 : .into(),
6441 0 : ));
6442 0 : }
6443 0 :
6444 0 : // Ordering: we must persist the new node _before_ adding it to in-memory state.
6445 0 : // This ensures that before we use it for anything or expose it via any external
6446 0 : // API, it is guaranteed to be available after a restart.
6447 0 : let new_node = Node::new(
6448 0 : register_req.node_id,
6449 0 : register_req.listen_http_addr,
6450 0 : register_req.listen_http_port,
6451 0 : register_req.listen_https_port,
6452 0 : register_req.listen_pg_addr,
6453 0 : register_req.listen_pg_port,
6454 0 : register_req.availability_zone_id.clone(),
6455 0 : self.config.use_https_pageserver_api,
6456 0 : );
6457 0 : let new_node = match new_node {
6458 0 : Ok(new_node) => new_node,
6459 0 : Err(error) => return Err(ApiError::InternalServerError(error)),
6460 : };
6461 :
6462 0 : match registration_status {
6463 0 : RegistrationStatus::New => self.persistence.insert_node(&new_node).await?,
6464 : RegistrationStatus::NeedUpdate => {
6465 0 : self.persistence
6466 0 : .update_node_on_registration(
6467 0 : register_req.node_id,
6468 0 : register_req.listen_https_port,
6469 0 : )
6470 0 : .await?
6471 : }
6472 0 : _ => unreachable!("Other statuses have been processed earlier"),
6473 : }
6474 :
6475 0 : let mut locked = self.inner.write().unwrap();
6476 0 : let mut new_nodes = (*locked.nodes).clone();
6477 0 :
6478 0 : locked.scheduler.node_upsert(&new_node);
6479 0 : new_nodes.insert(register_req.node_id, new_node);
6480 0 :
6481 0 : locked.nodes = Arc::new(new_nodes);
6482 0 :
6483 0 : metrics::METRICS_REGISTRY
6484 0 : .metrics_group
6485 0 : .storage_controller_pageserver_nodes
6486 0 : .set(locked.nodes.len() as i64);
6487 0 :
6488 0 : match registration_status {
6489 : RegistrationStatus::New => {
6490 0 : tracing::info!(
6491 0 : "Registered pageserver {} ({}), now have {} pageservers",
6492 0 : register_req.node_id,
6493 0 : register_req.availability_zone_id,
6494 0 : locked.nodes.len()
6495 : );
6496 : }
6497 : RegistrationStatus::NeedUpdate => {
6498 0 : tracing::info!(
6499 0 : "Re-registered and updated node {} ({})",
6500 : register_req.node_id,
6501 : register_req.availability_zone_id,
6502 : );
6503 : }
6504 0 : _ => unreachable!("Other statuses have been processed earlier"),
6505 : }
6506 0 : Ok(())
6507 0 : }
6508 :
6509 : /// Configure in-memory and persistent state of a node as requested
6510 : ///
6511 : /// Note that this function does not trigger any immediate side effects in response
6512 : /// to the changes. That part is handled by [`Self::handle_node_availability_transition`].
6513 0 : async fn node_state_configure(
6514 0 : &self,
6515 0 : node_id: NodeId,
6516 0 : availability: Option<NodeAvailability>,
6517 0 : scheduling: Option<NodeSchedulingPolicy>,
6518 0 : node_lock: &TracingExclusiveGuard<NodeOperations>,
6519 0 : ) -> Result<AvailabilityTransition, ApiError> {
6520 0 : if let Some(scheduling) = scheduling {
6521 : // Scheduling is a persistent part of Node: we must write updates to the database before
6522 : // applying them in memory
6523 0 : self.persistence
6524 0 : .update_node_scheduling_policy(node_id, scheduling)
6525 0 : .await?;
6526 0 : }
6527 :
6528 : // If we're activating a node, then before setting it active we must reconcile any shard locations
6529 : // on that node, in case it is out of sync, e.g. due to being unavailable during controller startup,
6530 : // by calling [`Self::node_activate_reconcile`]
6531 : //
6532 : // The transition we calculate here remains valid later in the function because we hold the op lock on the node:
6533 : // nothing else can mutate its availability while we run.
6534 0 : let availability_transition = if let Some(input_availability) = availability.as_ref() {
6535 0 : let (activate_node, availability_transition) = {
6536 0 : let locked = self.inner.read().unwrap();
6537 0 : let Some(node) = locked.nodes.get(&node_id) else {
6538 0 : return Err(ApiError::NotFound(
6539 0 : anyhow::anyhow!("Node {} not registered", node_id).into(),
6540 0 : ));
6541 : };
6542 :
6543 0 : (
6544 0 : node.clone(),
6545 0 : node.get_availability_transition(input_availability),
6546 0 : )
6547 : };
6548 :
6549 0 : if matches!(availability_transition, AvailabilityTransition::ToActive) {
6550 0 : self.node_activate_reconcile(activate_node, node_lock)
6551 0 : .await?;
6552 0 : }
6553 0 : availability_transition
6554 : } else {
6555 0 : AvailabilityTransition::Unchanged
6556 : };
6557 :
6558 : // Apply changes from the request to our in-memory state for the Node
6559 0 : let mut locked = self.inner.write().unwrap();
6560 0 : let (nodes, _tenants, scheduler) = locked.parts_mut();
6561 0 :
6562 0 : let mut new_nodes = (**nodes).clone();
6563 :
6564 0 : let Some(node) = new_nodes.get_mut(&node_id) else {
6565 0 : return Err(ApiError::NotFound(
6566 0 : anyhow::anyhow!("Node not registered").into(),
6567 0 : ));
6568 : };
6569 :
6570 0 : if let Some(availability) = availability {
6571 0 : node.set_availability(availability);
6572 0 : }
6573 :
6574 0 : if let Some(scheduling) = scheduling {
6575 0 : node.set_scheduling(scheduling);
6576 0 : }
6577 :
6578 : // Update the scheduler, in case the elegibility of the node for new shards has changed
6579 0 : scheduler.node_upsert(node);
6580 0 :
6581 0 : let new_nodes = Arc::new(new_nodes);
6582 0 : locked.nodes = new_nodes;
6583 0 :
6584 0 : Ok(availability_transition)
6585 0 : }
6586 :
6587 : /// Handle availability transition of one node
6588 : ///
6589 : /// Note that you should first call [`Self::node_state_configure`] to update
6590 : /// the in-memory state referencing that node. If you need to handle more than one transition
6591 : /// consider using [`Self::handle_node_availability_transitions`].
6592 0 : async fn handle_node_availability_transition(
6593 0 : &self,
6594 0 : node_id: NodeId,
6595 0 : transition: AvailabilityTransition,
6596 0 : _node_lock: &TracingExclusiveGuard<NodeOperations>,
6597 0 : ) -> Result<(), ApiError> {
6598 0 : // Modify scheduling state for any Tenants that are affected by a change in the node's availability state.
6599 0 : match transition {
6600 : AvailabilityTransition::ToOffline => {
6601 0 : tracing::info!("Node {} transition to offline", node_id);
6602 :
6603 0 : let mut locked = self.inner.write().unwrap();
6604 0 : let (nodes, tenants, scheduler) = locked.parts_mut();
6605 0 :
6606 0 : let mut tenants_affected: usize = 0;
6607 :
6608 0 : for (_tenant_id, mut schedule_context, shards) in
6609 0 : TenantShardContextIterator::new(tenants, ScheduleMode::Normal)
6610 : {
6611 0 : for tenant_shard in shards {
6612 0 : let tenant_shard_id = tenant_shard.tenant_shard_id;
6613 0 : if let Some(observed_loc) =
6614 0 : tenant_shard.observed.locations.get_mut(&node_id)
6615 0 : {
6616 0 : // When a node goes offline, we set its observed configuration to None, indicating unknown: we will
6617 0 : // not assume our knowledge of the node's configuration is accurate until it comes back online
6618 0 : observed_loc.conf = None;
6619 0 : }
6620 :
6621 0 : if nodes.len() == 1 {
6622 : // Special case for single-node cluster: there is no point trying to reschedule
6623 : // any tenant shards: avoid doing so, in order to avoid spewing warnings about
6624 : // failures to schedule them.
6625 0 : continue;
6626 0 : }
6627 0 :
6628 0 : if !nodes
6629 0 : .values()
6630 0 : .any(|n| matches!(n.may_schedule(), MaySchedule::Yes(_)))
6631 : {
6632 : // Special case for when all nodes are unavailable and/or unschedulable: there is no point
6633 : // trying to reschedule since there's nowhere else to go. Without this
6634 : // branch we incorrectly detach tenants in response to node unavailability.
6635 0 : continue;
6636 0 : }
6637 0 :
6638 0 : if tenant_shard.intent.demote_attached(scheduler, node_id) {
6639 0 : tenant_shard.sequence = tenant_shard.sequence.next();
6640 0 :
6641 0 : match tenant_shard.schedule(scheduler, &mut schedule_context) {
6642 0 : Err(e) => {
6643 0 : // It is possible that some tenants will become unschedulable when too many pageservers
6644 0 : // go offline: in this case there isn't much we can do other than make the issue observable.
6645 0 : // TODO: give TenantShard a scheduling error attribute to be queried later.
6646 0 : tracing::warn!(%tenant_shard_id, "Scheduling error when marking pageserver {} offline: {e}", node_id);
6647 : }
6648 : Ok(()) => {
6649 0 : if self
6650 0 : .maybe_reconcile_shard(
6651 0 : tenant_shard,
6652 0 : nodes,
6653 0 : ReconcilerPriority::Normal,
6654 0 : )
6655 0 : .is_some()
6656 0 : {
6657 0 : tenants_affected += 1;
6658 0 : };
6659 : }
6660 : }
6661 0 : }
6662 : }
6663 : }
6664 0 : tracing::info!(
6665 0 : "Launched {} reconciler tasks for tenants affected by node {} going offline",
6666 : tenants_affected,
6667 : node_id
6668 : )
6669 : }
6670 : AvailabilityTransition::ToActive => {
6671 0 : tracing::info!("Node {} transition to active", node_id);
6672 :
6673 0 : let mut locked = self.inner.write().unwrap();
6674 0 : let (nodes, tenants, _scheduler) = locked.parts_mut();
6675 :
6676 : // When a node comes back online, we must reconcile any tenant that has a None observed
6677 : // location on the node.
6678 0 : for tenant_shard in tenants.values_mut() {
6679 : // If a reconciliation is already in progress, rely on the previous scheduling
6680 : // decision and skip triggering a new reconciliation.
6681 0 : if tenant_shard.reconciler.is_some() {
6682 0 : continue;
6683 0 : }
6684 :
6685 0 : if let Some(observed_loc) = tenant_shard.observed.locations.get_mut(&node_id) {
6686 0 : if observed_loc.conf.is_none() {
6687 0 : self.maybe_reconcile_shard(
6688 0 : tenant_shard,
6689 0 : nodes,
6690 0 : ReconcilerPriority::Normal,
6691 0 : );
6692 0 : }
6693 0 : }
6694 : }
6695 :
6696 : // TODO: in the background, we should balance work back onto this pageserver
6697 : }
6698 : // No action required for the intermediate unavailable state.
6699 : // When we transition into active or offline from the unavailable state,
6700 : // the correct handling above will kick in.
6701 : AvailabilityTransition::ToWarmingUpFromActive => {
6702 0 : tracing::info!("Node {} transition to unavailable from active", node_id);
6703 : }
6704 : AvailabilityTransition::ToWarmingUpFromOffline => {
6705 0 : tracing::info!("Node {} transition to unavailable from offline", node_id);
6706 : }
6707 : AvailabilityTransition::Unchanged => {
6708 0 : tracing::debug!("Node {} no availability change during config", node_id);
6709 : }
6710 : }
6711 :
6712 0 : Ok(())
6713 0 : }
6714 :
6715 : /// Handle availability transition for multiple nodes
6716 : ///
6717 : /// Note that you should first call [`Self::node_state_configure`] for
6718 : /// all nodes being handled here for the handling to use fresh in-memory state.
6719 0 : async fn handle_node_availability_transitions(
6720 0 : &self,
6721 0 : transitions: Vec<(
6722 0 : NodeId,
6723 0 : TracingExclusiveGuard<NodeOperations>,
6724 0 : AvailabilityTransition,
6725 0 : )>,
6726 0 : ) -> Result<(), Vec<(NodeId, ApiError)>> {
6727 0 : let mut errors = Vec::default();
6728 0 : for (node_id, node_lock, transition) in transitions {
6729 0 : let res = self
6730 0 : .handle_node_availability_transition(node_id, transition, &node_lock)
6731 0 : .await;
6732 0 : if let Err(err) = res {
6733 0 : errors.push((node_id, err));
6734 0 : }
6735 : }
6736 :
6737 0 : if errors.is_empty() {
6738 0 : Ok(())
6739 : } else {
6740 0 : Err(errors)
6741 : }
6742 0 : }
6743 :
6744 0 : pub(crate) async fn node_configure(
6745 0 : &self,
6746 0 : node_id: NodeId,
6747 0 : availability: Option<NodeAvailability>,
6748 0 : scheduling: Option<NodeSchedulingPolicy>,
6749 0 : ) -> Result<(), ApiError> {
6750 0 : let node_lock =
6751 0 : trace_exclusive_lock(&self.node_op_locks, node_id, NodeOperations::Configure).await;
6752 :
6753 0 : let transition = self
6754 0 : .node_state_configure(node_id, availability, scheduling, &node_lock)
6755 0 : .await?;
6756 0 : self.handle_node_availability_transition(node_id, transition, &node_lock)
6757 0 : .await
6758 0 : }
6759 :
6760 : /// Wrapper around [`Self::node_configure`] which only allows changes while there is no ongoing
6761 : /// operation for HTTP api.
6762 0 : pub(crate) async fn external_node_configure(
6763 0 : &self,
6764 0 : node_id: NodeId,
6765 0 : availability: Option<NodeAvailability>,
6766 0 : scheduling: Option<NodeSchedulingPolicy>,
6767 0 : ) -> Result<(), ApiError> {
6768 0 : {
6769 0 : let locked = self.inner.read().unwrap();
6770 0 : if let Some(op) = locked.ongoing_operation.as_ref().map(|op| op.operation) {
6771 0 : return Err(ApiError::PreconditionFailed(
6772 0 : format!("Ongoing background operation forbids configuring: {op}").into(),
6773 0 : ));
6774 0 : }
6775 0 : }
6776 0 :
6777 0 : self.node_configure(node_id, availability, scheduling).await
6778 0 : }
6779 :
6780 0 : pub(crate) async fn start_node_drain(
6781 0 : self: &Arc<Self>,
6782 0 : node_id: NodeId,
6783 0 : ) -> Result<(), ApiError> {
6784 0 : let (ongoing_op, node_available, node_policy, schedulable_nodes_count) = {
6785 0 : let locked = self.inner.read().unwrap();
6786 0 : let nodes = &locked.nodes;
6787 0 : let node = nodes.get(&node_id).ok_or(ApiError::NotFound(
6788 0 : anyhow::anyhow!("Node {} not registered", node_id).into(),
6789 0 : ))?;
6790 0 : let schedulable_nodes_count = nodes
6791 0 : .iter()
6792 0 : .filter(|(_, n)| matches!(n.may_schedule(), MaySchedule::Yes(_)))
6793 0 : .count();
6794 0 :
6795 0 : (
6796 0 : locked
6797 0 : .ongoing_operation
6798 0 : .as_ref()
6799 0 : .map(|ongoing| ongoing.operation),
6800 0 : node.is_available(),
6801 0 : node.get_scheduling(),
6802 0 : schedulable_nodes_count,
6803 0 : )
6804 0 : };
6805 :
6806 0 : if let Some(ongoing) = ongoing_op {
6807 0 : return Err(ApiError::PreconditionFailed(
6808 0 : format!("Background operation already ongoing for node: {}", ongoing).into(),
6809 0 : ));
6810 0 : }
6811 0 :
6812 0 : if !node_available {
6813 0 : return Err(ApiError::ResourceUnavailable(
6814 0 : format!("Node {node_id} is currently unavailable").into(),
6815 0 : ));
6816 0 : }
6817 0 :
6818 0 : if schedulable_nodes_count == 0 {
6819 0 : return Err(ApiError::PreconditionFailed(
6820 0 : "No other schedulable nodes to drain to".into(),
6821 0 : ));
6822 0 : }
6823 0 :
6824 0 : match node_policy {
6825 : NodeSchedulingPolicy::Active => {
6826 0 : self.node_configure(node_id, None, Some(NodeSchedulingPolicy::Draining))
6827 0 : .await?;
6828 :
6829 0 : let cancel = self.cancel.child_token();
6830 0 : let gate_guard = self.gate.enter().map_err(|_| ApiError::ShuttingDown)?;
6831 :
6832 0 : self.inner.write().unwrap().ongoing_operation = Some(OperationHandler {
6833 0 : operation: Operation::Drain(Drain { node_id }),
6834 0 : cancel: cancel.clone(),
6835 0 : });
6836 :
6837 0 : let span = tracing::info_span!(parent: None, "drain_node", %node_id);
6838 :
6839 0 : tokio::task::spawn({
6840 0 : let service = self.clone();
6841 0 : let cancel = cancel.clone();
6842 0 : async move {
6843 0 : let _gate_guard = gate_guard;
6844 0 :
6845 0 : scopeguard::defer! {
6846 0 : let prev = service.inner.write().unwrap().ongoing_operation.take();
6847 0 :
6848 0 : if let Some(Operation::Drain(removed_drain)) = prev.map(|h| h.operation) {
6849 0 : assert_eq!(removed_drain.node_id, node_id, "We always take the same operation");
6850 0 : } else {
6851 0 : panic!("We always remove the same operation")
6852 0 : }
6853 0 : }
6854 0 :
6855 0 : tracing::info!("Drain background operation starting");
6856 0 : let res = service.drain_node(node_id, cancel).await;
6857 0 : match res {
6858 : Ok(()) => {
6859 0 : tracing::info!("Drain background operation completed successfully");
6860 : }
6861 : Err(OperationError::Cancelled) => {
6862 0 : tracing::info!("Drain background operation was cancelled");
6863 : }
6864 0 : Err(err) => {
6865 0 : tracing::error!("Drain background operation encountered: {err}")
6866 : }
6867 : }
6868 0 : }
6869 0 : }.instrument(span));
6870 0 : }
6871 : NodeSchedulingPolicy::Draining => {
6872 0 : return Err(ApiError::Conflict(format!(
6873 0 : "Node {node_id} has drain in progress"
6874 0 : )));
6875 : }
6876 0 : policy => {
6877 0 : return Err(ApiError::PreconditionFailed(
6878 0 : format!("Node {node_id} cannot be drained due to {policy:?} policy").into(),
6879 0 : ));
6880 : }
6881 : }
6882 :
6883 0 : Ok(())
6884 0 : }
6885 :
6886 0 : pub(crate) async fn cancel_node_drain(&self, node_id: NodeId) -> Result<(), ApiError> {
6887 0 : let node_available = {
6888 0 : let locked = self.inner.read().unwrap();
6889 0 : let nodes = &locked.nodes;
6890 0 : let node = nodes.get(&node_id).ok_or(ApiError::NotFound(
6891 0 : anyhow::anyhow!("Node {} not registered", node_id).into(),
6892 0 : ))?;
6893 :
6894 0 : node.is_available()
6895 0 : };
6896 0 :
6897 0 : if !node_available {
6898 0 : return Err(ApiError::ResourceUnavailable(
6899 0 : format!("Node {node_id} is currently unavailable").into(),
6900 0 : ));
6901 0 : }
6902 :
6903 0 : if let Some(op_handler) = self.inner.read().unwrap().ongoing_operation.as_ref() {
6904 0 : if let Operation::Drain(drain) = op_handler.operation {
6905 0 : if drain.node_id == node_id {
6906 0 : tracing::info!("Cancelling background drain operation for node {node_id}");
6907 0 : op_handler.cancel.cancel();
6908 0 : return Ok(());
6909 0 : }
6910 0 : }
6911 0 : }
6912 :
6913 0 : Err(ApiError::PreconditionFailed(
6914 0 : format!("Node {node_id} has no drain in progress").into(),
6915 0 : ))
6916 0 : }
6917 :
6918 0 : pub(crate) async fn start_node_fill(self: &Arc<Self>, node_id: NodeId) -> Result<(), ApiError> {
6919 0 : let (ongoing_op, node_available, node_policy, total_nodes_count) = {
6920 0 : let locked = self.inner.read().unwrap();
6921 0 : let nodes = &locked.nodes;
6922 0 : let node = nodes.get(&node_id).ok_or(ApiError::NotFound(
6923 0 : anyhow::anyhow!("Node {} not registered", node_id).into(),
6924 0 : ))?;
6925 :
6926 0 : (
6927 0 : locked
6928 0 : .ongoing_operation
6929 0 : .as_ref()
6930 0 : .map(|ongoing| ongoing.operation),
6931 0 : node.is_available(),
6932 0 : node.get_scheduling(),
6933 0 : nodes.len(),
6934 0 : )
6935 0 : };
6936 :
6937 0 : if let Some(ongoing) = ongoing_op {
6938 0 : return Err(ApiError::PreconditionFailed(
6939 0 : format!("Background operation already ongoing for node: {}", ongoing).into(),
6940 0 : ));
6941 0 : }
6942 0 :
6943 0 : if !node_available {
6944 0 : return Err(ApiError::ResourceUnavailable(
6945 0 : format!("Node {node_id} is currently unavailable").into(),
6946 0 : ));
6947 0 : }
6948 0 :
6949 0 : if total_nodes_count <= 1 {
6950 0 : return Err(ApiError::PreconditionFailed(
6951 0 : "No other nodes to fill from".into(),
6952 0 : ));
6953 0 : }
6954 0 :
6955 0 : match node_policy {
6956 : NodeSchedulingPolicy::Active => {
6957 0 : self.node_configure(node_id, None, Some(NodeSchedulingPolicy::Filling))
6958 0 : .await?;
6959 :
6960 0 : let cancel = self.cancel.child_token();
6961 0 : let gate_guard = self.gate.enter().map_err(|_| ApiError::ShuttingDown)?;
6962 :
6963 0 : self.inner.write().unwrap().ongoing_operation = Some(OperationHandler {
6964 0 : operation: Operation::Fill(Fill { node_id }),
6965 0 : cancel: cancel.clone(),
6966 0 : });
6967 :
6968 0 : let span = tracing::info_span!(parent: None, "fill_node", %node_id);
6969 :
6970 0 : tokio::task::spawn({
6971 0 : let service = self.clone();
6972 0 : let cancel = cancel.clone();
6973 0 : async move {
6974 0 : let _gate_guard = gate_guard;
6975 0 :
6976 0 : scopeguard::defer! {
6977 0 : let prev = service.inner.write().unwrap().ongoing_operation.take();
6978 0 :
6979 0 : if let Some(Operation::Fill(removed_fill)) = prev.map(|h| h.operation) {
6980 0 : assert_eq!(removed_fill.node_id, node_id, "We always take the same operation");
6981 0 : } else {
6982 0 : panic!("We always remove the same operation")
6983 0 : }
6984 0 : }
6985 0 :
6986 0 : tracing::info!("Fill background operation starting");
6987 0 : let res = service.fill_node(node_id, cancel).await;
6988 0 : match res {
6989 : Ok(()) => {
6990 0 : tracing::info!("Fill background operation completed successfully");
6991 : }
6992 : Err(OperationError::Cancelled) => {
6993 0 : tracing::info!("Fill background operation was cancelled");
6994 : }
6995 0 : Err(err) => {
6996 0 : tracing::error!("Fill background operation encountered: {err}")
6997 : }
6998 : }
6999 0 : }
7000 0 : }.instrument(span));
7001 0 : }
7002 : NodeSchedulingPolicy::Filling => {
7003 0 : return Err(ApiError::Conflict(format!(
7004 0 : "Node {node_id} has fill in progress"
7005 0 : )));
7006 : }
7007 0 : policy => {
7008 0 : return Err(ApiError::PreconditionFailed(
7009 0 : format!("Node {node_id} cannot be filled due to {policy:?} policy").into(),
7010 0 : ));
7011 : }
7012 : }
7013 :
7014 0 : Ok(())
7015 0 : }
7016 :
7017 0 : pub(crate) async fn cancel_node_fill(&self, node_id: NodeId) -> Result<(), ApiError> {
7018 0 : let node_available = {
7019 0 : let locked = self.inner.read().unwrap();
7020 0 : let nodes = &locked.nodes;
7021 0 : let node = nodes.get(&node_id).ok_or(ApiError::NotFound(
7022 0 : anyhow::anyhow!("Node {} not registered", node_id).into(),
7023 0 : ))?;
7024 :
7025 0 : node.is_available()
7026 0 : };
7027 0 :
7028 0 : if !node_available {
7029 0 : return Err(ApiError::ResourceUnavailable(
7030 0 : format!("Node {node_id} is currently unavailable").into(),
7031 0 : ));
7032 0 : }
7033 :
7034 0 : if let Some(op_handler) = self.inner.read().unwrap().ongoing_operation.as_ref() {
7035 0 : if let Operation::Fill(fill) = op_handler.operation {
7036 0 : if fill.node_id == node_id {
7037 0 : tracing::info!("Cancelling background drain operation for node {node_id}");
7038 0 : op_handler.cancel.cancel();
7039 0 : return Ok(());
7040 0 : }
7041 0 : }
7042 0 : }
7043 :
7044 0 : Err(ApiError::PreconditionFailed(
7045 0 : format!("Node {node_id} has no fill in progress").into(),
7046 0 : ))
7047 0 : }
7048 :
7049 : /// Like [`Self::maybe_configured_reconcile_shard`], but uses the default reconciler
7050 : /// configuration
7051 0 : fn maybe_reconcile_shard(
7052 0 : &self,
7053 0 : shard: &mut TenantShard,
7054 0 : nodes: &Arc<HashMap<NodeId, Node>>,
7055 0 : priority: ReconcilerPriority,
7056 0 : ) -> Option<ReconcilerWaiter> {
7057 0 : self.maybe_configured_reconcile_shard(shard, nodes, ReconcilerConfig::new(priority))
7058 0 : }
7059 :
7060 : /// Before constructing a Reconciler, acquire semaphore units from the appropriate concurrency limit (depends on priority)
7061 0 : fn get_reconciler_units(
7062 0 : &self,
7063 0 : priority: ReconcilerPriority,
7064 0 : ) -> Result<ReconcileUnits, TryAcquireError> {
7065 0 : let units = match priority {
7066 0 : ReconcilerPriority::Normal => self.reconciler_concurrency.clone().try_acquire_owned(),
7067 : ReconcilerPriority::High => {
7068 0 : match self
7069 0 : .priority_reconciler_concurrency
7070 0 : .clone()
7071 0 : .try_acquire_owned()
7072 : {
7073 0 : Ok(u) => Ok(u),
7074 : Err(TryAcquireError::NoPermits) => {
7075 : // If the high priority semaphore is exhausted, then high priority tasks may steal units from
7076 : // the normal priority semaphore.
7077 0 : self.reconciler_concurrency.clone().try_acquire_owned()
7078 : }
7079 0 : Err(e) => Err(e),
7080 : }
7081 : }
7082 : };
7083 :
7084 0 : units.map(ReconcileUnits::new)
7085 0 : }
7086 :
7087 : /// Wrap [`TenantShard`] reconciliation methods with acquisition of [`Gate`] and [`ReconcileUnits`],
7088 0 : fn maybe_configured_reconcile_shard(
7089 0 : &self,
7090 0 : shard: &mut TenantShard,
7091 0 : nodes: &Arc<HashMap<NodeId, Node>>,
7092 0 : reconciler_config: ReconcilerConfig,
7093 0 : ) -> Option<ReconcilerWaiter> {
7094 0 : let reconcile_needed = shard.get_reconcile_needed(nodes);
7095 :
7096 0 : let reconcile_reason = match reconcile_needed {
7097 0 : ReconcileNeeded::No => return None,
7098 0 : ReconcileNeeded::WaitExisting(waiter) => return Some(waiter),
7099 0 : ReconcileNeeded::Yes(reason) => {
7100 0 : // Fall through to try and acquire units for spawning reconciler
7101 0 : reason
7102 : }
7103 : };
7104 :
7105 0 : let units = match self.get_reconciler_units(reconciler_config.priority) {
7106 0 : Ok(u) => u,
7107 : Err(_) => {
7108 0 : tracing::info!(tenant_id=%shard.tenant_shard_id.tenant_id, shard_id=%shard.tenant_shard_id.shard_slug(),
7109 0 : "Concurrency limited: enqueued for reconcile later");
7110 0 : if !shard.delayed_reconcile {
7111 0 : match self.delayed_reconcile_tx.try_send(shard.tenant_shard_id) {
7112 0 : Err(TrySendError::Closed(_)) => {
7113 0 : // Weird mid-shutdown case?
7114 0 : }
7115 : Err(TrySendError::Full(_)) => {
7116 : // It is safe to skip sending our ID in the channel: we will eventually get retried by the background reconcile task.
7117 0 : tracing::warn!(
7118 0 : "Many shards are waiting to reconcile: delayed_reconcile queue is full"
7119 : );
7120 : }
7121 0 : Ok(()) => {
7122 0 : shard.delayed_reconcile = true;
7123 0 : }
7124 : }
7125 0 : }
7126 :
7127 : // We won't spawn a reconciler, but we will construct a waiter that waits for the shard's sequence
7128 : // number to advance. When this function is eventually called again and succeeds in getting units,
7129 : // it will spawn a reconciler that makes this waiter complete.
7130 0 : return Some(shard.future_reconcile_waiter());
7131 : }
7132 : };
7133 :
7134 0 : let Ok(gate_guard) = self.reconcilers_gate.enter() else {
7135 : // Gate closed: we're shutting down, drop out.
7136 0 : return None;
7137 : };
7138 :
7139 0 : shard.spawn_reconciler(
7140 0 : reconcile_reason,
7141 0 : &self.result_tx,
7142 0 : nodes,
7143 0 : &self.compute_hook,
7144 0 : reconciler_config,
7145 0 : &self.config,
7146 0 : &self.persistence,
7147 0 : units,
7148 0 : gate_guard,
7149 0 : &self.reconcilers_cancel,
7150 0 : self.http_client.clone(),
7151 0 : )
7152 0 : }
7153 :
7154 : /// Check all tenants for pending reconciliation work, and reconcile those in need.
7155 : /// Additionally, reschedule tenants that require it.
7156 : ///
7157 : /// Returns how many reconciliation tasks were started, or `1` if no reconciles were
7158 : /// spawned but some _would_ have been spawned if `reconciler_concurrency` units where
7159 : /// available. A return value of 0 indicates that everything is fully reconciled already.
7160 0 : fn reconcile_all(&self) -> usize {
7161 0 : let mut locked = self.inner.write().unwrap();
7162 0 : let (nodes, tenants, scheduler) = locked.parts_mut();
7163 0 : let pageservers = nodes.clone();
7164 0 :
7165 0 : // This function is an efficient place to update lazy statistics, since we are walking
7166 0 : // all tenants.
7167 0 : let mut pending_reconciles = 0;
7168 0 : let mut az_violations = 0;
7169 0 :
7170 0 : // If we find any tenants to drop from memory, stash them to offload after
7171 0 : // we're done traversing the map of tenants.
7172 0 : let mut drop_detached_tenants = Vec::new();
7173 0 :
7174 0 : let mut reconciles_spawned = 0;
7175 0 : for shard in tenants.values_mut() {
7176 : // Accumulate scheduling statistics
7177 0 : if let (Some(attached), Some(preferred)) =
7178 0 : (shard.intent.get_attached(), shard.preferred_az())
7179 : {
7180 0 : let node_az = nodes
7181 0 : .get(attached)
7182 0 : .expect("Nodes exist if referenced")
7183 0 : .get_availability_zone_id();
7184 0 : if node_az != preferred {
7185 0 : az_violations += 1;
7186 0 : }
7187 0 : }
7188 :
7189 : // Skip checking if this shard is already enqueued for reconciliation
7190 0 : if shard.delayed_reconcile && self.reconciler_concurrency.available_permits() == 0 {
7191 : // If there is something delayed, then return a nonzero count so that
7192 : // callers like reconcile_all_now do not incorrectly get the impression
7193 : // that the system is in a quiescent state.
7194 0 : reconciles_spawned = std::cmp::max(1, reconciles_spawned);
7195 0 : pending_reconciles += 1;
7196 0 : continue;
7197 0 : }
7198 0 :
7199 0 : // Eventual consistency: if an earlier reconcile job failed, and the shard is still
7200 0 : // dirty, spawn another rone
7201 0 : if self
7202 0 : .maybe_reconcile_shard(shard, &pageservers, ReconcilerPriority::Normal)
7203 0 : .is_some()
7204 0 : {
7205 0 : reconciles_spawned += 1;
7206 0 : } else if shard.delayed_reconcile {
7207 0 : // Shard wanted to reconcile but for some reason couldn't.
7208 0 : pending_reconciles += 1;
7209 0 : }
7210 :
7211 : // If this tenant is detached, try dropping it from memory. This is usually done
7212 : // proactively in [`Self::process_results`], but we do it here to handle the edge
7213 : // case where a reconcile completes while someone else is holding an op lock for the tenant.
7214 0 : if shard.tenant_shard_id.shard_number == ShardNumber(0)
7215 0 : && shard.policy == PlacementPolicy::Detached
7216 : {
7217 0 : if let Some(guard) = self.tenant_op_locks.try_exclusive(
7218 0 : shard.tenant_shard_id.tenant_id,
7219 0 : TenantOperations::DropDetached,
7220 0 : ) {
7221 0 : drop_detached_tenants.push((shard.tenant_shard_id.tenant_id, guard));
7222 0 : }
7223 0 : }
7224 : }
7225 :
7226 : // Some metrics are calculated from SchedulerNode state, update these periodically
7227 0 : scheduler.update_metrics();
7228 :
7229 : // Process any deferred tenant drops
7230 0 : for (tenant_id, guard) in drop_detached_tenants {
7231 0 : self.maybe_drop_tenant(tenant_id, &mut locked, &guard);
7232 0 : }
7233 :
7234 0 : metrics::METRICS_REGISTRY
7235 0 : .metrics_group
7236 0 : .storage_controller_schedule_az_violation
7237 0 : .set(az_violations as i64);
7238 0 :
7239 0 : metrics::METRICS_REGISTRY
7240 0 : .metrics_group
7241 0 : .storage_controller_pending_reconciles
7242 0 : .set(pending_reconciles as i64);
7243 0 :
7244 0 : reconciles_spawned
7245 0 : }
7246 :
7247 : /// `optimize` in this context means identifying shards which have valid scheduled locations, but
7248 : /// could be scheduled somewhere better:
7249 : /// - Cutting over to a secondary if the node with the secondary is more lightly loaded
7250 : /// * e.g. after a node fails then recovers, to move some work back to it
7251 : /// - Cutting over to a secondary if it improves the spread of shard attachments within a tenant
7252 : /// * e.g. after a shard split, the initial attached locations will all be on the node where
7253 : /// we did the split, but are probably better placed elsewhere.
7254 : /// - Creating new secondary locations if it improves the spreading of a sharded tenant
7255 : /// * e.g. after a shard split, some locations will be on the same node (where the split
7256 : /// happened), and will probably be better placed elsewhere.
7257 : ///
7258 : /// To put it more briefly: whereas the scheduler respects soft constraints in a ScheduleContext at
7259 : /// the time of scheduling, this function looks for cases where a better-scoring location is available
7260 : /// according to those same soft constraints.
7261 0 : async fn optimize_all(&self) -> usize {
7262 : // Limit on how many shards' optmizations each call to this function will execute. Combined
7263 : // with the frequency of background calls, this acts as an implicit rate limit that runs a small
7264 : // trickle of optimizations in the background, rather than executing a large number in parallel
7265 : // when a change occurs.
7266 : const MAX_OPTIMIZATIONS_EXEC_PER_PASS: usize = 16;
7267 :
7268 : // Synchronous prepare: scan shards for possible scheduling optimizations
7269 0 : let candidate_work = self.optimize_all_plan();
7270 0 : let candidate_work_len = candidate_work.len();
7271 :
7272 : // Asynchronous validate: I/O to pageservers to make sure shards are in a good state to apply validation
7273 0 : let validated_work = self.optimize_all_validate(candidate_work).await;
7274 :
7275 0 : let was_work_filtered = validated_work.len() != candidate_work_len;
7276 0 :
7277 0 : // Synchronous apply: update the shards' intent states according to validated optimisations
7278 0 : let mut reconciles_spawned = 0;
7279 0 : let mut optimizations_applied = 0;
7280 0 : let mut locked = self.inner.write().unwrap();
7281 0 : let (nodes, tenants, scheduler) = locked.parts_mut();
7282 0 : for (tenant_shard_id, optimization) in validated_work {
7283 0 : let Some(shard) = tenants.get_mut(&tenant_shard_id) else {
7284 : // Shard was dropped between planning and execution;
7285 0 : continue;
7286 : };
7287 0 : tracing::info!(tenant_shard_id=%tenant_shard_id, "Applying optimization: {optimization:?}");
7288 0 : if shard.apply_optimization(scheduler, optimization) {
7289 0 : optimizations_applied += 1;
7290 0 : if self
7291 0 : .maybe_reconcile_shard(shard, nodes, ReconcilerPriority::Normal)
7292 0 : .is_some()
7293 0 : {
7294 0 : reconciles_spawned += 1;
7295 0 : }
7296 0 : }
7297 :
7298 0 : if optimizations_applied >= MAX_OPTIMIZATIONS_EXEC_PER_PASS {
7299 0 : break;
7300 0 : }
7301 : }
7302 :
7303 0 : if was_work_filtered {
7304 0 : // If we filtered any work out during validation, ensure we return a nonzero value to indicate
7305 0 : // to callers that the system is not in a truly quiet state, it's going to do some work as soon
7306 0 : // as these validations start passing.
7307 0 : reconciles_spawned = std::cmp::max(reconciles_spawned, 1);
7308 0 : }
7309 :
7310 0 : reconciles_spawned
7311 0 : }
7312 :
7313 0 : fn optimize_all_plan(&self) -> Vec<(TenantShardId, ScheduleOptimization)> {
7314 : // How many candidate optimizations we will generate, before evaluating them for readniess: setting
7315 : // this higher than the execution limit gives us a chance to execute some work even if the first
7316 : // few optimizations we find are not ready.
7317 : const MAX_OPTIMIZATIONS_PLAN_PER_PASS: usize = 64;
7318 :
7319 0 : let mut work = Vec::new();
7320 0 : let mut locked = self.inner.write().unwrap();
7321 0 : let (_nodes, tenants, scheduler) = locked.parts_mut();
7322 :
7323 : // We are going to plan a bunch of optimisations before applying any of them, so the
7324 : // utilisation stats on nodes will be effectively stale for the >1st optimisation we
7325 : // generate. To avoid this causing unstable migrations/flapping, it's important that the
7326 : // code in TenantShard for finding optimisations uses [`NodeAttachmentSchedulingScore::disregard_utilization`]
7327 : // to ignore the utilisation component of the score.
7328 :
7329 0 : for (_tenant_id, schedule_context, shards) in
7330 0 : TenantShardContextIterator::new(tenants, ScheduleMode::Speculative)
7331 : {
7332 0 : for shard in shards {
7333 0 : if work.len() >= MAX_OPTIMIZATIONS_PLAN_PER_PASS {
7334 0 : break;
7335 0 : }
7336 0 : match shard.get_scheduling_policy() {
7337 0 : ShardSchedulingPolicy::Active => {
7338 0 : // Ok to do optimization
7339 0 : }
7340 0 : ShardSchedulingPolicy::Essential if shard.get_preferred_node().is_some() => {
7341 0 : // Ok to do optimization: we are executing a graceful migration that
7342 0 : // has set preferred_node
7343 0 : }
7344 : ShardSchedulingPolicy::Essential
7345 : | ShardSchedulingPolicy::Pause
7346 : | ShardSchedulingPolicy::Stop => {
7347 : // Policy prevents optimizing this shard.
7348 0 : continue;
7349 : }
7350 : }
7351 :
7352 0 : if !matches!(shard.splitting, SplitState::Idle)
7353 0 : || matches!(shard.policy, PlacementPolicy::Detached)
7354 0 : || shard.reconciler.is_some()
7355 : {
7356 : // Do not start any optimizations while another change to the tenant is ongoing: this
7357 : // is not necessary for correctness, but simplifies operations and implicitly throttles
7358 : // optimization changes to happen in a "trickle" over time.
7359 0 : continue;
7360 0 : }
7361 0 :
7362 0 : // Fast path: we may quickly identify shards that don't have any possible optimisations
7363 0 : if !shard.maybe_optimizable(scheduler, &schedule_context) {
7364 0 : if cfg!(feature = "testing") {
7365 : // Check that maybe_optimizable doesn't disagree with the actual optimization functions.
7366 : // Only do this in testing builds because it is not a correctness-critical check, so we shouldn't
7367 : // panic in prod if we hit this, or spend cycles on it in prod.
7368 0 : assert!(
7369 0 : shard
7370 0 : .optimize_attachment(scheduler, &schedule_context)
7371 0 : .is_none()
7372 0 : );
7373 0 : assert!(
7374 0 : shard
7375 0 : .optimize_secondary(scheduler, &schedule_context)
7376 0 : .is_none()
7377 0 : );
7378 0 : }
7379 0 : continue;
7380 0 : }
7381 :
7382 0 : if let Some(optimization) =
7383 : // If idle, maybe optimize attachments: if a shard has a secondary location that is preferable to
7384 : // its primary location based on soft constraints, cut it over.
7385 0 : shard.optimize_attachment(scheduler, &schedule_context)
7386 : {
7387 0 : tracing::info!(tenant_shard_id=%shard.tenant_shard_id, "Identified optimization for attachment: {optimization:?}");
7388 0 : work.push((shard.tenant_shard_id, optimization));
7389 0 : break;
7390 0 : } else if let Some(optimization) =
7391 : // If idle, maybe optimize secondary locations: if a shard has a secondary location that would be
7392 : // better placed on another node, based on ScheduleContext, then adjust it. This
7393 : // covers cases like after a shard split, where we might have too many shards
7394 : // in the same tenant with secondary locations on the node where they originally split.
7395 0 : shard.optimize_secondary(scheduler, &schedule_context)
7396 : {
7397 0 : tracing::info!(tenant_shard_id=%shard.tenant_shard_id, "Identified optimization for secondary: {optimization:?}");
7398 0 : work.push((shard.tenant_shard_id, optimization));
7399 0 : break;
7400 0 : }
7401 : }
7402 : }
7403 :
7404 0 : work
7405 0 : }
7406 :
7407 0 : async fn optimize_all_validate(
7408 0 : &self,
7409 0 : candidate_work: Vec<(TenantShardId, ScheduleOptimization)>,
7410 0 : ) -> Vec<(TenantShardId, ScheduleOptimization)> {
7411 0 : // Take a clone of the node map to use outside the lock in async validation phase
7412 0 : let validation_nodes = { self.inner.read().unwrap().nodes.clone() };
7413 0 :
7414 0 : let mut want_secondary_status = Vec::new();
7415 0 :
7416 0 : // Validate our plans: this is an async phase where we may do I/O to pageservers to
7417 0 : // check that the state of locations is acceptable to run the optimization, such as
7418 0 : // checking that a secondary location is sufficiently warmed-up to cleanly cut over
7419 0 : // in a live migration.
7420 0 : let mut validated_work = Vec::new();
7421 0 : for (tenant_shard_id, optimization) in candidate_work {
7422 0 : match optimization.action {
7423 : ScheduleOptimizationAction::MigrateAttachment(MigrateAttachment {
7424 : old_attached_node_id: _,
7425 0 : new_attached_node_id,
7426 0 : }) => {
7427 0 : match validation_nodes.get(&new_attached_node_id) {
7428 0 : None => {
7429 0 : // Node was dropped between planning and validation
7430 0 : }
7431 0 : Some(node) => {
7432 0 : if !node.is_available() {
7433 0 : tracing::info!(
7434 0 : "Skipping optimization migration of {tenant_shard_id} to {new_attached_node_id} because node unavailable"
7435 : );
7436 0 : } else {
7437 0 : // Accumulate optimizations that require fetching secondary status, so that we can execute these
7438 0 : // remote API requests concurrently.
7439 0 : want_secondary_status.push((
7440 0 : tenant_shard_id,
7441 0 : node.clone(),
7442 0 : optimization,
7443 0 : ));
7444 0 : }
7445 : }
7446 : }
7447 : }
7448 : ScheduleOptimizationAction::ReplaceSecondary(_)
7449 : | ScheduleOptimizationAction::CreateSecondary(_)
7450 : | ScheduleOptimizationAction::RemoveSecondary(_) => {
7451 : // No extra checks needed to manage secondaries: this does not interrupt client access
7452 0 : validated_work.push((tenant_shard_id, optimization))
7453 : }
7454 : };
7455 : }
7456 :
7457 : // Call into pageserver API to find out if the destination secondary location is warm enough for a reasonably smooth migration: we
7458 : // do this so that we avoid spawning a Reconciler that would have to wait minutes/hours for a destination to warm up: that reconciler
7459 : // would hold a precious reconcile semaphore unit the whole time it was waiting for the destination to warm up.
7460 0 : let results = self
7461 0 : .tenant_for_shards_api(
7462 0 : want_secondary_status
7463 0 : .iter()
7464 0 : .map(|i| (i.0, i.1.clone()))
7465 0 : .collect(),
7466 0 : |tenant_shard_id, client| async move {
7467 0 : client.tenant_secondary_status(tenant_shard_id).await
7468 0 : },
7469 0 : 1,
7470 0 : 1,
7471 0 : SHORT_RECONCILE_TIMEOUT,
7472 0 : &self.cancel,
7473 0 : )
7474 0 : .await;
7475 :
7476 0 : for ((tenant_shard_id, node, optimization), secondary_status) in
7477 0 : want_secondary_status.into_iter().zip(results.into_iter())
7478 : {
7479 0 : match secondary_status {
7480 0 : Err(e) => {
7481 0 : tracing::info!(
7482 0 : "Skipping migration of {tenant_shard_id} to {node}, error querying secondary: {e}"
7483 : );
7484 : }
7485 0 : Ok(progress) => {
7486 : // We require secondary locations to have less than 10GiB of downloads pending before we will use
7487 : // them in an optimization
7488 : const DOWNLOAD_FRESHNESS_THRESHOLD: u64 = 10 * 1024 * 1024 * 1024;
7489 :
7490 0 : if progress.heatmap_mtime.is_none()
7491 0 : || progress.bytes_total < DOWNLOAD_FRESHNESS_THRESHOLD
7492 0 : && progress.bytes_downloaded != progress.bytes_total
7493 0 : || progress.bytes_total - progress.bytes_downloaded
7494 0 : > DOWNLOAD_FRESHNESS_THRESHOLD
7495 : {
7496 0 : tracing::info!(
7497 0 : "Skipping migration of {tenant_shard_id} to {node} because secondary isn't ready: {progress:?}"
7498 : );
7499 :
7500 : #[cfg(feature = "testing")]
7501 0 : if progress.heatmap_mtime.is_none() {
7502 : // No heatmap might mean the attached location has never uploaded one, or that
7503 : // the secondary download hasn't happened yet. This is relatively unusual in the field,
7504 : // but fairly common in tests.
7505 0 : self.kick_secondary_download(tenant_shard_id).await;
7506 0 : }
7507 : } else {
7508 : // Location looks ready: proceed
7509 0 : tracing::info!(
7510 0 : "{tenant_shard_id} secondary on {node} is warm enough for migration: {progress:?}"
7511 : );
7512 0 : validated_work.push((tenant_shard_id, optimization))
7513 : }
7514 : }
7515 : }
7516 : }
7517 :
7518 0 : validated_work
7519 0 : }
7520 :
7521 : /// Some aspects of scheduling optimisation wait for secondary locations to be warm. This
7522 : /// happens on multi-minute timescales in the field, which is fine because optimisation is meant
7523 : /// to be a lazy background thing. However, when testing, it is not practical to wait around, so
7524 : /// we have this helper to move things along faster.
7525 : #[cfg(feature = "testing")]
7526 0 : async fn kick_secondary_download(&self, tenant_shard_id: TenantShardId) {
7527 0 : let (attached_node, secondaries) = {
7528 0 : let locked = self.inner.read().unwrap();
7529 0 : let Some(shard) = locked.tenants.get(&tenant_shard_id) else {
7530 0 : tracing::warn!(
7531 0 : "Skipping kick of secondary download for {tenant_shard_id}: not found"
7532 : );
7533 0 : return;
7534 : };
7535 :
7536 0 : let Some(attached) = shard.intent.get_attached() else {
7537 0 : tracing::warn!(
7538 0 : "Skipping kick of secondary download for {tenant_shard_id}: no attached"
7539 : );
7540 0 : return;
7541 : };
7542 :
7543 0 : let secondaries = shard
7544 0 : .intent
7545 0 : .get_secondary()
7546 0 : .iter()
7547 0 : .map(|n| locked.nodes.get(n).unwrap().clone())
7548 0 : .collect::<Vec<_>>();
7549 0 :
7550 0 : (locked.nodes.get(attached).unwrap().clone(), secondaries)
7551 0 : };
7552 0 :
7553 0 : // Make remote API calls to upload + download heatmaps: we ignore errors because this is just
7554 0 : // a 'kick' to let scheduling optimisation run more promptly.
7555 0 : match attached_node
7556 0 : .with_client_retries(
7557 0 : |client| async move { client.tenant_heatmap_upload(tenant_shard_id).await },
7558 0 : &self.http_client,
7559 0 : &self.config.pageserver_jwt_token,
7560 0 : 3,
7561 0 : 10,
7562 0 : SHORT_RECONCILE_TIMEOUT,
7563 0 : &self.cancel,
7564 0 : )
7565 0 : .await
7566 : {
7567 0 : Some(Err(e)) => {
7568 0 : tracing::info!(
7569 0 : "Failed to upload heatmap from {attached_node} for {tenant_shard_id}: {e}"
7570 : );
7571 : }
7572 : None => {
7573 0 : tracing::info!(
7574 0 : "Cancelled while uploading heatmap from {attached_node} for {tenant_shard_id}"
7575 : );
7576 : }
7577 : Some(Ok(_)) => {
7578 0 : tracing::info!(
7579 0 : "Successfully uploaded heatmap from {attached_node} for {tenant_shard_id}"
7580 : );
7581 : }
7582 : }
7583 :
7584 0 : for secondary_node in secondaries {
7585 0 : match secondary_node
7586 0 : .with_client_retries(
7587 0 : |client| async move {
7588 0 : client
7589 0 : .tenant_secondary_download(
7590 0 : tenant_shard_id,
7591 0 : Some(Duration::from_secs(1)),
7592 0 : )
7593 0 : .await
7594 0 : },
7595 0 : &self.http_client,
7596 0 : &self.config.pageserver_jwt_token,
7597 0 : 3,
7598 0 : 10,
7599 0 : SHORT_RECONCILE_TIMEOUT,
7600 0 : &self.cancel,
7601 0 : )
7602 0 : .await
7603 : {
7604 0 : Some(Err(e)) => {
7605 0 : tracing::info!(
7606 0 : "Failed to download heatmap from {secondary_node} for {tenant_shard_id}: {e}"
7607 : );
7608 : }
7609 : None => {
7610 0 : tracing::info!(
7611 0 : "Cancelled while downloading heatmap from {secondary_node} for {tenant_shard_id}"
7612 : );
7613 : }
7614 0 : Some(Ok(progress)) => {
7615 0 : tracing::info!(
7616 0 : "Successfully downloaded heatmap from {secondary_node} for {tenant_shard_id}: {progress:?}"
7617 : );
7618 : }
7619 : }
7620 : }
7621 0 : }
7622 :
7623 : /// Asynchronously split a tenant that's eligible for automatic splits. At most one tenant will
7624 : /// be split per call.
7625 : ///
7626 : /// Two sets of criteria are used: initial splits and size-based splits (in that order).
7627 : /// Initial splits are used to eagerly split unsharded tenants that may be performing initial
7628 : /// ingestion, since sharded tenants have significantly better ingestion throughput. Size-based
7629 : /// splits are used to bound the maximum shard size and balance out load.
7630 : ///
7631 : /// Splits are based on max_logical_size, i.e. the logical size of the largest timeline in a
7632 : /// tenant. We use this instead of the total logical size because branches will duplicate
7633 : /// logical size without actually using more storage. We could also use visible physical size,
7634 : /// but this might overestimate tenants that frequently churn branches.
7635 : ///
7636 : /// Initial splits (initial_split_threshold):
7637 : /// * Applies to tenants with 1 shard.
7638 : /// * The largest timeline (max_logical_size) exceeds initial_split_threshold.
7639 : /// * Splits into initial_split_shards.
7640 : ///
7641 : /// Size-based splits (split_threshold):
7642 : /// * Applies to all tenants.
7643 : /// * The largest timeline (max_logical_size) divided by shard count exceeds split_threshold.
7644 : /// * Splits such that max_logical_size / shard_count <= split_threshold, in powers of 2.
7645 : ///
7646 : /// Tenant shards are ordered by descending max_logical_size, first initial split candidates
7647 : /// then size-based split candidates. The first matching candidate is split.
7648 : ///
7649 : /// The shard count is clamped to max_split_shards. If a candidate is eligible for both initial
7650 : /// and size-based splits, the largest shard count will be used.
7651 : ///
7652 : /// An unsharded tenant will get DEFAULT_STRIPE_SIZE, regardless of what its ShardIdentity says.
7653 : /// A sharded tenant will retain its stripe size, as splits do not allow changing it.
7654 : ///
7655 : /// TODO: consider spawning multiple splits in parallel: this is only called once every 20
7656 : /// seconds, so a large backlog can take a long time, and if a tenant fails to split it will
7657 : /// block all other splits.
7658 0 : async fn autosplit_tenants(self: &Arc<Self>) {
7659 0 : // If max_split_shards is set to 0 or 1, we can't split.
7660 0 : let max_split_shards = self.config.max_split_shards;
7661 0 : if max_split_shards <= 1 {
7662 0 : return;
7663 0 : }
7664 0 :
7665 0 : // If initial_split_shards is set to 0 or 1, disable initial splits.
7666 0 : let mut initial_split_threshold = self.config.initial_split_threshold.unwrap_or(0);
7667 0 : let initial_split_shards = self.config.initial_split_shards;
7668 0 : if initial_split_shards <= 1 {
7669 0 : initial_split_threshold = 0;
7670 0 : }
7671 :
7672 : // If no split_threshold nor initial_split_threshold, disable autosplits.
7673 0 : let split_threshold = self.config.split_threshold.unwrap_or(0);
7674 0 : if split_threshold == 0 && initial_split_threshold == 0 {
7675 0 : return;
7676 0 : }
7677 0 :
7678 0 : // Fetch split candidates in prioritized order.
7679 0 : //
7680 0 : // If initial splits are enabled, fetch eligible tenants first. We prioritize initial splits
7681 0 : // over size-based splits, since these are often performing initial ingestion and rely on
7682 0 : // splits to improve ingest throughput.
7683 0 : let mut candidates = Vec::new();
7684 0 :
7685 0 : if initial_split_threshold > 0 {
7686 : // Initial splits: fetch tenants with 1 shard where the logical size of the largest
7687 : // timeline exceeds the initial split threshold.
7688 0 : let initial_candidates = self
7689 0 : .get_top_tenant_shards(&TopTenantShardsRequest {
7690 0 : order_by: TenantSorting::MaxLogicalSize,
7691 0 : limit: 10,
7692 0 : where_shards_lt: Some(ShardCount(2)),
7693 0 : where_gt: Some(initial_split_threshold),
7694 0 : })
7695 0 : .await;
7696 0 : candidates.extend(initial_candidates);
7697 0 : }
7698 :
7699 0 : if split_threshold > 0 {
7700 : // Size-based splits: fetch tenants where the logical size of the largest timeline
7701 : // divided by shard count exceeds the split threshold.
7702 : //
7703 : // max_logical_size is only tracked on shard 0, and contains the total logical size
7704 : // across all shards. We have to order and filter by MaxLogicalSizePerShard, i.e.
7705 : // max_logical_size / shard_count, such that we only receive tenants that are actually
7706 : // eligible for splits. But we still use max_logical_size for later split calculations.
7707 0 : let size_candidates = self
7708 0 : .get_top_tenant_shards(&TopTenantShardsRequest {
7709 0 : order_by: TenantSorting::MaxLogicalSizePerShard,
7710 0 : limit: 10,
7711 0 : where_shards_lt: Some(ShardCount(max_split_shards)),
7712 0 : where_gt: Some(split_threshold),
7713 0 : })
7714 0 : .await;
7715 : #[cfg(feature = "testing")]
7716 0 : assert!(
7717 0 : size_candidates.iter().all(|c| c.id.is_shard_zero()),
7718 0 : "MaxLogicalSizePerShard returned non-zero shard: {size_candidates:?}",
7719 : );
7720 0 : candidates.extend(size_candidates);
7721 0 : }
7722 :
7723 : // Filter out tenants in a prohibiting scheduling mode.
7724 0 : {
7725 0 : let state = self.inner.read().unwrap();
7726 0 : candidates.retain(|i| {
7727 0 : let policy = state.tenants.get(&i.id).map(|s| s.get_scheduling_policy());
7728 0 : policy == Some(ShardSchedulingPolicy::Active)
7729 0 : });
7730 0 : }
7731 :
7732 : // Pick the first candidate to split. This will generally always be the first one in
7733 : // candidates, but we defensively skip candidates that end up not actually splitting.
7734 0 : let Some((candidate, new_shard_count)) = candidates
7735 0 : .into_iter()
7736 0 : .filter_map(|candidate| {
7737 0 : let new_shard_count = Self::compute_split_shards(ShardSplitInputs {
7738 0 : shard_count: candidate.id.shard_count,
7739 0 : max_logical_size: candidate.max_logical_size,
7740 0 : split_threshold,
7741 0 : max_split_shards,
7742 0 : initial_split_threshold,
7743 0 : initial_split_shards,
7744 0 : });
7745 0 : new_shard_count.map(|shards| (candidate, shards.count()))
7746 0 : })
7747 0 : .next()
7748 : else {
7749 0 : debug!("no split-eligible tenants found");
7750 0 : return;
7751 : };
7752 :
7753 : // Retain the stripe size of sharded tenants, as splits don't allow changing it. Otherwise,
7754 : // use DEFAULT_STRIPE_SIZE for unsharded tenants -- their stripe size doesn't really matter,
7755 : // and if we change the default stripe size we want to use the new default rather than an
7756 : // old, persisted stripe size.
7757 0 : let new_stripe_size = match candidate.id.shard_count.count() {
7758 0 : 0 => panic!("invalid shard count 0"),
7759 0 : 1 => Some(ShardParameters::DEFAULT_STRIPE_SIZE),
7760 0 : 2.. => None,
7761 : };
7762 :
7763 : // We spawn a task to run this, so it's exactly like some external API client requesting
7764 : // it. We don't want to block the background reconcile loop on this.
7765 0 : let old_shard_count = candidate.id.shard_count.count();
7766 0 : info!(
7767 0 : "auto-splitting tenant {old_shard_count} → {new_shard_count} shards, \
7768 0 : current size {candidate:?} (split_threshold={split_threshold} \
7769 0 : initial_split_threshold={initial_split_threshold})"
7770 : );
7771 :
7772 0 : let this = self.clone();
7773 0 : tokio::spawn(
7774 0 : async move {
7775 0 : match this
7776 0 : .tenant_shard_split(
7777 0 : candidate.id.tenant_id,
7778 0 : TenantShardSplitRequest {
7779 0 : new_shard_count,
7780 0 : new_stripe_size,
7781 0 : },
7782 0 : )
7783 0 : .await
7784 : {
7785 : Ok(_) => {
7786 0 : info!("successful auto-split {old_shard_count} → {new_shard_count} shards")
7787 : }
7788 0 : Err(err) => error!("auto-split failed: {err}"),
7789 : }
7790 0 : }
7791 0 : .instrument(info_span!("auto_split", tenant_id=%candidate.id.tenant_id)),
7792 : );
7793 0 : }
7794 :
7795 : /// Returns the number of shards to split a tenant into, or None if the tenant shouldn't split,
7796 : /// based on the total logical size of the largest timeline summed across all shards. Uses the
7797 : /// larger of size-based and initial splits, clamped to max_split_shards.
7798 : ///
7799 : /// NB: the thresholds are exclusive, since TopTenantShardsRequest uses where_gt.
7800 25 : fn compute_split_shards(inputs: ShardSplitInputs) -> Option<ShardCount> {
7801 25 : let ShardSplitInputs {
7802 25 : shard_count,
7803 25 : max_logical_size,
7804 25 : split_threshold,
7805 25 : max_split_shards,
7806 25 : initial_split_threshold,
7807 25 : initial_split_shards,
7808 25 : } = inputs;
7809 25 :
7810 25 : let mut new_shard_count: u8 = shard_count.count();
7811 25 :
7812 25 : // Size-based splits. Ensures max_logical_size / new_shard_count <= split_threshold, using
7813 25 : // power-of-two shard counts.
7814 25 : //
7815 25 : // If the current shard count is not a power of two, and does not exceed split_threshold,
7816 25 : // then we leave it alone rather than forcing a power-of-two split.
7817 25 : if split_threshold > 0
7818 18 : && max_logical_size.div_ceil(split_threshold) > shard_count.count() as u64
7819 12 : {
7820 12 : new_shard_count = max_logical_size
7821 12 : .div_ceil(split_threshold)
7822 12 : .checked_next_power_of_two()
7823 12 : .unwrap_or(u8::MAX as u64)
7824 12 : .try_into()
7825 12 : .unwrap_or(u8::MAX);
7826 13 : }
7827 :
7828 : // Initial splits. Use the larger of size-based and initial split shard counts. This only
7829 : // applies to unsharded tenants, i.e. changes to initial_split_threshold or
7830 : // initial_split_shards are not retroactive for sharded tenants.
7831 25 : if initial_split_threshold > 0
7832 14 : && shard_count.count() <= 1
7833 11 : && max_logical_size > initial_split_threshold
7834 8 : {
7835 8 : new_shard_count = new_shard_count.max(initial_split_shards);
7836 17 : }
7837 :
7838 : // Clamp to max shards.
7839 25 : new_shard_count = new_shard_count.min(max_split_shards);
7840 25 :
7841 25 : // Don't split if we're not increasing the shard count.
7842 25 : if new_shard_count <= shard_count.count() {
7843 10 : return None;
7844 15 : }
7845 15 :
7846 15 : Some(ShardCount(new_shard_count))
7847 25 : }
7848 :
7849 : /// Fetches the top tenant shards from every node, in descending order of
7850 : /// max logical size. Any node errors will be logged and ignored.
7851 0 : async fn get_top_tenant_shards(
7852 0 : &self,
7853 0 : request: &TopTenantShardsRequest,
7854 0 : ) -> Vec<TopTenantShardItem> {
7855 0 : let nodes = self
7856 0 : .inner
7857 0 : .read()
7858 0 : .unwrap()
7859 0 : .nodes
7860 0 : .values()
7861 0 : .cloned()
7862 0 : .collect_vec();
7863 0 :
7864 0 : let mut futures = FuturesUnordered::new();
7865 0 : for node in nodes {
7866 0 : futures.push(async move {
7867 0 : node.with_client_retries(
7868 0 : |client| async move { client.top_tenant_shards(request.clone()).await },
7869 0 : &self.http_client,
7870 0 : &self.config.pageserver_jwt_token,
7871 0 : 3,
7872 0 : 3,
7873 0 : Duration::from_secs(5),
7874 0 : &self.cancel,
7875 0 : )
7876 0 : .await
7877 0 : });
7878 0 : }
7879 :
7880 0 : let mut top = Vec::new();
7881 0 : while let Some(output) = futures.next().await {
7882 0 : match output {
7883 0 : Some(Ok(response)) => top.extend(response.shards),
7884 0 : Some(Err(mgmt_api::Error::Cancelled)) => {}
7885 0 : Some(Err(err)) => warn!("failed to fetch top tenants: {err}"),
7886 0 : None => {} // node is shutting down
7887 : }
7888 : }
7889 :
7890 0 : top.sort_by_key(|i| i.max_logical_size);
7891 0 : top.reverse();
7892 0 : top
7893 0 : }
7894 :
7895 : /// Useful for tests: run whatever work a background [`Self::reconcile_all`] would have done, but
7896 : /// also wait for any generated Reconcilers to complete. Calling this until it returns zero should
7897 : /// put the system into a quiescent state where future background reconciliations won't do anything.
7898 0 : pub(crate) async fn reconcile_all_now(&self) -> Result<usize, ReconcileWaitError> {
7899 0 : let reconciles_spawned = self.reconcile_all();
7900 0 : let reconciles_spawned = if reconciles_spawned == 0 {
7901 : // Only optimize when we are otherwise idle
7902 0 : self.optimize_all().await
7903 : } else {
7904 0 : reconciles_spawned
7905 : };
7906 :
7907 0 : let waiters = {
7908 0 : let mut waiters = Vec::new();
7909 0 : let locked = self.inner.read().unwrap();
7910 0 : for (_tenant_shard_id, shard) in locked.tenants.iter() {
7911 0 : if let Some(waiter) = shard.get_waiter() {
7912 0 : waiters.push(waiter);
7913 0 : }
7914 : }
7915 0 : waiters
7916 0 : };
7917 0 :
7918 0 : let waiter_count = waiters.len();
7919 0 : match self.await_waiters(waiters, RECONCILE_TIMEOUT).await {
7920 0 : Ok(()) => {}
7921 0 : Err(ReconcileWaitError::Failed(_, reconcile_error))
7922 0 : if matches!(*reconcile_error, ReconcileError::Cancel) =>
7923 0 : {
7924 0 : // Ignore reconciler cancel errors: this reconciler might have shut down
7925 0 : // because some other change superceded it. We will return a nonzero number,
7926 0 : // so the caller knows they might have to call again to quiesce the system.
7927 0 : }
7928 0 : Err(e) => {
7929 0 : return Err(e);
7930 : }
7931 : };
7932 :
7933 0 : tracing::info!(
7934 0 : "{} reconciles in reconcile_all, {} waiters",
7935 : reconciles_spawned,
7936 : waiter_count
7937 : );
7938 :
7939 0 : Ok(std::cmp::max(waiter_count, reconciles_spawned))
7940 0 : }
7941 :
7942 0 : async fn stop_reconciliations(&self, reason: StopReconciliationsReason) {
7943 0 : // Cancel all on-going reconciles and wait for them to exit the gate.
7944 0 : tracing::info!("{reason}: cancelling and waiting for in-flight reconciles");
7945 0 : self.reconcilers_cancel.cancel();
7946 0 : self.reconcilers_gate.close().await;
7947 :
7948 : // Signal the background loop in [`Service::process_results`] to exit once
7949 : // it has proccessed the results from all the reconciles we cancelled earlier.
7950 0 : tracing::info!("{reason}: processing results from previously in-flight reconciles");
7951 0 : self.result_tx.send(ReconcileResultRequest::Stop).ok();
7952 0 : self.result_tx.closed().await;
7953 0 : }
7954 :
7955 0 : pub async fn shutdown(&self) {
7956 0 : self.stop_reconciliations(StopReconciliationsReason::ShuttingDown)
7957 0 : .await;
7958 :
7959 : // Background tasks hold gate guards: this notifies them of the cancellation and
7960 : // waits for them all to complete.
7961 0 : tracing::info!("Shutting down: cancelling and waiting for background tasks to exit");
7962 0 : self.cancel.cancel();
7963 0 : self.gate.close().await;
7964 0 : }
7965 :
7966 : /// Spot check the download lag for a secondary location of a shard.
7967 : /// Should be used as a heuristic, since it's not always precise: the
7968 : /// secondary might have not downloaded the new heat map yet and, hence,
7969 : /// is not aware of the lag.
7970 : ///
7971 : /// Returns:
7972 : /// * Ok(None) if the lag could not be determined from the status,
7973 : /// * Ok(Some(_)) if the lag could be determind
7974 : /// * Err on failures to query the pageserver.
7975 0 : async fn secondary_lag(
7976 0 : &self,
7977 0 : secondary: &NodeId,
7978 0 : tenant_shard_id: TenantShardId,
7979 0 : ) -> Result<Option<u64>, mgmt_api::Error> {
7980 0 : let nodes = self.inner.read().unwrap().nodes.clone();
7981 0 : let node = nodes.get(secondary).ok_or(mgmt_api::Error::ApiError(
7982 0 : StatusCode::NOT_FOUND,
7983 0 : format!("Node with id {} not found", secondary),
7984 0 : ))?;
7985 :
7986 0 : match node
7987 0 : .with_client_retries(
7988 0 : |client| async move { client.tenant_secondary_status(tenant_shard_id).await },
7989 0 : &self.http_client,
7990 0 : &self.config.pageserver_jwt_token,
7991 0 : 1,
7992 0 : 3,
7993 0 : Duration::from_millis(250),
7994 0 : &self.cancel,
7995 0 : )
7996 0 : .await
7997 : {
7998 0 : Some(Ok(status)) => match status.heatmap_mtime {
7999 0 : Some(_) => Ok(Some(status.bytes_total - status.bytes_downloaded)),
8000 0 : None => Ok(None),
8001 : },
8002 0 : Some(Err(e)) => Err(e),
8003 0 : None => Err(mgmt_api::Error::Cancelled),
8004 : }
8005 0 : }
8006 :
8007 : /// Drain a node by moving the shards attached to it as primaries.
8008 : /// This is a long running operation and it should run as a separate Tokio task.
8009 0 : pub(crate) async fn drain_node(
8010 0 : self: &Arc<Self>,
8011 0 : node_id: NodeId,
8012 0 : cancel: CancellationToken,
8013 0 : ) -> Result<(), OperationError> {
8014 : const MAX_SECONDARY_LAG_BYTES_DEFAULT: u64 = 256 * 1024 * 1024;
8015 0 : let max_secondary_lag_bytes = self
8016 0 : .config
8017 0 : .max_secondary_lag_bytes
8018 0 : .unwrap_or(MAX_SECONDARY_LAG_BYTES_DEFAULT);
8019 :
8020 : // By default, live migrations are generous about the wait time for getting
8021 : // the secondary location up to speed. When draining, give up earlier in order
8022 : // to not stall the operation when a cold secondary is encountered.
8023 : const SECONDARY_WARMUP_TIMEOUT: Duration = Duration::from_secs(20);
8024 : const SECONDARY_DOWNLOAD_REQUEST_TIMEOUT: Duration = Duration::from_secs(5);
8025 0 : let reconciler_config = ReconcilerConfigBuilder::new(ReconcilerPriority::Normal)
8026 0 : .secondary_warmup_timeout(SECONDARY_WARMUP_TIMEOUT)
8027 0 : .secondary_download_request_timeout(SECONDARY_DOWNLOAD_REQUEST_TIMEOUT)
8028 0 : .build();
8029 0 :
8030 0 : let mut waiters = Vec::new();
8031 0 :
8032 0 : let mut tid_iter = TenantShardIterator::new({
8033 0 : let service = self.clone();
8034 0 : move |last_inspected_shard: Option<TenantShardId>| {
8035 0 : let locked = &service.inner.read().unwrap();
8036 0 : let tenants = &locked.tenants;
8037 0 : let entry = match last_inspected_shard {
8038 0 : Some(skip_past) => {
8039 0 : // Skip to the last seen tenant shard id
8040 0 : let mut cursor = tenants.iter().skip_while(|(tid, _)| **tid != skip_past);
8041 0 :
8042 0 : // Skip past the last seen
8043 0 : cursor.nth(1)
8044 : }
8045 0 : None => tenants.first_key_value(),
8046 : };
8047 :
8048 0 : entry.map(|(tid, _)| tid).copied()
8049 0 : }
8050 0 : });
8051 :
8052 0 : while !tid_iter.finished() {
8053 0 : if cancel.is_cancelled() {
8054 0 : match self
8055 0 : .node_configure(node_id, None, Some(NodeSchedulingPolicy::Active))
8056 0 : .await
8057 : {
8058 0 : Ok(()) => return Err(OperationError::Cancelled),
8059 0 : Err(err) => {
8060 0 : return Err(OperationError::FinalizeError(
8061 0 : format!(
8062 0 : "Failed to finalise drain cancel of {} by setting scheduling policy to Active: {}",
8063 0 : node_id, err
8064 0 : )
8065 0 : .into(),
8066 0 : ));
8067 : }
8068 : }
8069 0 : }
8070 0 :
8071 0 : drain_utils::validate_node_state(&node_id, self.inner.read().unwrap().nodes.clone())?;
8072 :
8073 0 : while waiters.len() < MAX_RECONCILES_PER_OPERATION {
8074 0 : let tid = match tid_iter.next() {
8075 0 : Some(tid) => tid,
8076 : None => {
8077 0 : break;
8078 : }
8079 : };
8080 :
8081 0 : let tid_drain = TenantShardDrain {
8082 0 : drained_node: node_id,
8083 0 : tenant_shard_id: tid,
8084 0 : };
8085 :
8086 0 : let dest_node_id = {
8087 0 : let locked = self.inner.read().unwrap();
8088 0 :
8089 0 : match tid_drain
8090 0 : .tenant_shard_eligible_for_drain(&locked.tenants, &locked.scheduler)
8091 : {
8092 0 : Some(node_id) => node_id,
8093 : None => {
8094 0 : continue;
8095 : }
8096 : }
8097 : };
8098 :
8099 0 : match self.secondary_lag(&dest_node_id, tid).await {
8100 0 : Ok(Some(lag)) if lag <= max_secondary_lag_bytes => {
8101 0 : // The secondary is reasonably up to date.
8102 0 : // Migrate to it
8103 0 : }
8104 0 : Ok(Some(lag)) => {
8105 0 : tracing::info!(
8106 0 : tenant_id=%tid.tenant_id, shard_id=%tid.shard_slug(),
8107 0 : "Secondary on node {dest_node_id} is lagging by {lag}. Skipping reconcile."
8108 : );
8109 0 : continue;
8110 : }
8111 : Ok(None) => {
8112 0 : tracing::info!(
8113 0 : tenant_id=%tid.tenant_id, shard_id=%tid.shard_slug(),
8114 0 : "Could not determine lag for secondary on node {dest_node_id}. Skipping reconcile."
8115 : );
8116 0 : continue;
8117 : }
8118 0 : Err(err) => {
8119 0 : tracing::warn!(
8120 0 : tenant_id=%tid.tenant_id, shard_id=%tid.shard_slug(),
8121 0 : "Failed to get secondary lag from node {dest_node_id}. Skipping reconcile: {err}"
8122 : );
8123 0 : continue;
8124 : }
8125 : }
8126 :
8127 : {
8128 0 : let mut locked = self.inner.write().unwrap();
8129 0 : let (nodes, tenants, scheduler) = locked.parts_mut();
8130 0 : let rescheduled = tid_drain.reschedule_to_secondary(
8131 0 : dest_node_id,
8132 0 : tenants,
8133 0 : scheduler,
8134 0 : nodes,
8135 0 : )?;
8136 :
8137 0 : if let Some(tenant_shard) = rescheduled {
8138 0 : let waiter = self.maybe_configured_reconcile_shard(
8139 0 : tenant_shard,
8140 0 : nodes,
8141 0 : reconciler_config,
8142 0 : );
8143 0 : if let Some(some) = waiter {
8144 0 : waiters.push(some);
8145 0 : }
8146 0 : }
8147 : }
8148 : }
8149 :
8150 0 : waiters = self
8151 0 : .await_waiters_remainder(waiters, WAITER_FILL_DRAIN_POLL_TIMEOUT)
8152 0 : .await;
8153 :
8154 0 : failpoint_support::sleep_millis_async!("sleepy-drain-loop", &cancel);
8155 : }
8156 :
8157 0 : while !waiters.is_empty() {
8158 0 : if cancel.is_cancelled() {
8159 0 : match self
8160 0 : .node_configure(node_id, None, Some(NodeSchedulingPolicy::Active))
8161 0 : .await
8162 : {
8163 0 : Ok(()) => return Err(OperationError::Cancelled),
8164 0 : Err(err) => {
8165 0 : return Err(OperationError::FinalizeError(
8166 0 : format!(
8167 0 : "Failed to finalise drain cancel of {} by setting scheduling policy to Active: {}",
8168 0 : node_id, err
8169 0 : )
8170 0 : .into(),
8171 0 : ));
8172 : }
8173 : }
8174 0 : }
8175 0 :
8176 0 : tracing::info!("Awaiting {} pending drain reconciliations", waiters.len());
8177 :
8178 0 : waiters = self
8179 0 : .await_waiters_remainder(waiters, SHORT_RECONCILE_TIMEOUT)
8180 0 : .await;
8181 : }
8182 :
8183 : // At this point we have done the best we could to drain shards from this node.
8184 : // Set the node scheduling policy to `[NodeSchedulingPolicy::PauseForRestart]`
8185 : // to complete the drain.
8186 0 : if let Err(err) = self
8187 0 : .node_configure(node_id, None, Some(NodeSchedulingPolicy::PauseForRestart))
8188 0 : .await
8189 : {
8190 : // This is not fatal. Anything that is polling the node scheduling policy to detect
8191 : // the end of the drain operations will hang, but all such places should enforce an
8192 : // overall timeout. The scheduling policy will be updated upon node re-attach and/or
8193 : // by the counterpart fill operation.
8194 0 : return Err(OperationError::FinalizeError(
8195 0 : format!(
8196 0 : "Failed to finalise drain of {node_id} by setting scheduling policy to PauseForRestart: {err}"
8197 0 : )
8198 0 : .into(),
8199 0 : ));
8200 0 : }
8201 0 :
8202 0 : Ok(())
8203 0 : }
8204 :
8205 : /// Create a node fill plan (pick secondaries to promote), based on:
8206 : /// 1. Shards which have a secondary on this node, and this node is in their home AZ, and are currently attached to a node
8207 : /// outside their home AZ, should be migrated back here.
8208 : /// 2. If after step 1 we have not migrated enough shards for this node to have its fair share of
8209 : /// attached shards, we will promote more shards from the nodes with the most attached shards, unless
8210 : /// those shards have a home AZ that doesn't match the node we're filling.
8211 0 : fn fill_node_plan(&self, node_id: NodeId) -> Vec<TenantShardId> {
8212 0 : let mut locked = self.inner.write().unwrap();
8213 0 : let (nodes, tenants, _scheduler) = locked.parts_mut();
8214 0 :
8215 0 : let node_az = nodes
8216 0 : .get(&node_id)
8217 0 : .expect("Node must exist")
8218 0 : .get_availability_zone_id()
8219 0 : .clone();
8220 0 :
8221 0 : // The tenant shard IDs that we plan to promote from secondary to attached on this node
8222 0 : let mut plan = Vec::new();
8223 0 :
8224 0 : // Collect shards which do not have a preferred AZ & are elegible for moving in stage 2
8225 0 : let mut free_tids_by_node: HashMap<NodeId, Vec<TenantShardId>> = HashMap::new();
8226 0 :
8227 0 : // Don't respect AZ preferences if there is only one AZ. This comes up in tests, but it could
8228 0 : // conceivably come up in real life if deploying a single-AZ region intentionally.
8229 0 : let respect_azs = nodes
8230 0 : .values()
8231 0 : .map(|n| n.get_availability_zone_id())
8232 0 : .unique()
8233 0 : .count()
8234 0 : > 1;
8235 :
8236 : // Step 1: collect all shards that we are required to migrate back to this node because their AZ preference
8237 : // requires it.
8238 0 : for (tsid, tenant_shard) in tenants {
8239 0 : if !tenant_shard.intent.get_secondary().contains(&node_id) {
8240 : // Shard doesn't have a secondary on this node, ignore it.
8241 0 : continue;
8242 0 : }
8243 0 :
8244 0 : // AZ check: when filling nodes after a restart, our intent is to move _back_ the
8245 0 : // shards which belong on this node, not to promote shards whose scheduling preference
8246 0 : // would be on their currently attached node. So will avoid promoting shards whose
8247 0 : // home AZ doesn't match the AZ of the node we're filling.
8248 0 : match tenant_shard.preferred_az() {
8249 0 : _ if !respect_azs => {
8250 0 : if let Some(primary) = tenant_shard.intent.get_attached() {
8251 0 : free_tids_by_node.entry(*primary).or_default().push(*tsid);
8252 0 : }
8253 : }
8254 : None => {
8255 : // Shard doesn't have an AZ preference: it is elegible to be moved, but we
8256 : // will only do so if our target shard count requires it.
8257 0 : if let Some(primary) = tenant_shard.intent.get_attached() {
8258 0 : free_tids_by_node.entry(*primary).or_default().push(*tsid);
8259 0 : }
8260 : }
8261 0 : Some(az) if az == &node_az => {
8262 : // This shard's home AZ is equal to the node we're filling: it should
8263 : // be moved back to this node as part of filling, unless its currently
8264 : // attached location is also in its home AZ.
8265 0 : if let Some(primary) = tenant_shard.intent.get_attached() {
8266 0 : if nodes
8267 0 : .get(primary)
8268 0 : .expect("referenced node must exist")
8269 0 : .get_availability_zone_id()
8270 0 : != tenant_shard
8271 0 : .preferred_az()
8272 0 : .expect("tenant must have an AZ preference")
8273 : {
8274 0 : plan.push(*tsid)
8275 0 : }
8276 : } else {
8277 0 : plan.push(*tsid)
8278 : }
8279 : }
8280 0 : Some(_) => {
8281 0 : // This shard's home AZ is somewhere other than the node we're filling,
8282 0 : // it may not be moved back to this node as part of filling. Ignore it
8283 0 : }
8284 : }
8285 : }
8286 :
8287 : // Step 2: also promote any AZ-agnostic shards as required to achieve the target number of attachments
8288 0 : let fill_requirement = locked.scheduler.compute_fill_requirement(node_id);
8289 0 :
8290 0 : let expected_attached = locked.scheduler.expected_attached_shard_count();
8291 0 : let nodes_by_load = locked.scheduler.nodes_by_attached_shard_count();
8292 0 :
8293 0 : let mut promoted_per_tenant: HashMap<TenantId, usize> = HashMap::new();
8294 :
8295 0 : for (node_id, attached) in nodes_by_load {
8296 0 : let available = locked.nodes.get(&node_id).is_some_and(|n| n.is_available());
8297 0 : if !available {
8298 0 : continue;
8299 0 : }
8300 0 :
8301 0 : if plan.len() >= fill_requirement
8302 0 : || free_tids_by_node.is_empty()
8303 0 : || attached <= expected_attached
8304 : {
8305 0 : break;
8306 0 : }
8307 0 :
8308 0 : let can_take = attached - expected_attached;
8309 0 : let needed = fill_requirement - plan.len();
8310 0 : let mut take = std::cmp::min(can_take, needed);
8311 0 :
8312 0 : let mut remove_node = false;
8313 0 : while take > 0 {
8314 0 : match free_tids_by_node.get_mut(&node_id) {
8315 0 : Some(tids) => match tids.pop() {
8316 0 : Some(tid) => {
8317 0 : let max_promote_for_tenant = std::cmp::max(
8318 0 : tid.shard_count.count() as usize / locked.nodes.len(),
8319 0 : 1,
8320 0 : );
8321 0 : let promoted = promoted_per_tenant.entry(tid.tenant_id).or_default();
8322 0 : if *promoted < max_promote_for_tenant {
8323 0 : plan.push(tid);
8324 0 : *promoted += 1;
8325 0 : take -= 1;
8326 0 : }
8327 : }
8328 : None => {
8329 0 : remove_node = true;
8330 0 : break;
8331 : }
8332 : },
8333 : None => {
8334 0 : break;
8335 : }
8336 : }
8337 : }
8338 :
8339 0 : if remove_node {
8340 0 : free_tids_by_node.remove(&node_id);
8341 0 : }
8342 : }
8343 :
8344 0 : plan
8345 0 : }
8346 :
8347 : /// Fill a node by promoting its secondaries until the cluster is balanced
8348 : /// with regards to attached shard counts. Note that this operation only
8349 : /// makes sense as a counterpart to the drain implemented in [`Service::drain_node`].
8350 : /// This is a long running operation and it should run as a separate Tokio task.
8351 0 : pub(crate) async fn fill_node(
8352 0 : &self,
8353 0 : node_id: NodeId,
8354 0 : cancel: CancellationToken,
8355 0 : ) -> Result<(), OperationError> {
8356 : const SECONDARY_WARMUP_TIMEOUT: Duration = Duration::from_secs(20);
8357 : const SECONDARY_DOWNLOAD_REQUEST_TIMEOUT: Duration = Duration::from_secs(5);
8358 0 : let reconciler_config = ReconcilerConfigBuilder::new(ReconcilerPriority::Normal)
8359 0 : .secondary_warmup_timeout(SECONDARY_WARMUP_TIMEOUT)
8360 0 : .secondary_download_request_timeout(SECONDARY_DOWNLOAD_REQUEST_TIMEOUT)
8361 0 : .build();
8362 0 :
8363 0 : let mut tids_to_promote = self.fill_node_plan(node_id);
8364 0 : let mut waiters = Vec::new();
8365 :
8366 : // Execute the plan we've composed above. Before aplying each move from the plan,
8367 : // we validate to ensure that it has not gone stale in the meantime.
8368 0 : while !tids_to_promote.is_empty() {
8369 0 : if cancel.is_cancelled() {
8370 0 : match self
8371 0 : .node_configure(node_id, None, Some(NodeSchedulingPolicy::Active))
8372 0 : .await
8373 : {
8374 0 : Ok(()) => return Err(OperationError::Cancelled),
8375 0 : Err(err) => {
8376 0 : return Err(OperationError::FinalizeError(
8377 0 : format!(
8378 0 : "Failed to finalise drain cancel of {} by setting scheduling policy to Active: {}",
8379 0 : node_id, err
8380 0 : )
8381 0 : .into(),
8382 0 : ));
8383 : }
8384 : }
8385 0 : }
8386 0 :
8387 0 : {
8388 0 : let mut locked = self.inner.write().unwrap();
8389 0 : let (nodes, tenants, scheduler) = locked.parts_mut();
8390 :
8391 0 : let node = nodes.get(&node_id).ok_or(OperationError::NodeStateChanged(
8392 0 : format!("node {node_id} was removed").into(),
8393 0 : ))?;
8394 :
8395 0 : let current_policy = node.get_scheduling();
8396 0 : if !matches!(current_policy, NodeSchedulingPolicy::Filling) {
8397 : // TODO(vlad): maybe cancel pending reconciles before erroring out. need to think
8398 : // about it
8399 0 : return Err(OperationError::NodeStateChanged(
8400 0 : format!("node {node_id} changed state to {current_policy:?}").into(),
8401 0 : ));
8402 0 : }
8403 :
8404 0 : while waiters.len() < MAX_RECONCILES_PER_OPERATION {
8405 0 : if let Some(tid) = tids_to_promote.pop() {
8406 0 : if let Some(tenant_shard) = tenants.get_mut(&tid) {
8407 : // If the node being filled is not a secondary anymore,
8408 : // skip the promotion.
8409 0 : if !tenant_shard.intent.get_secondary().contains(&node_id) {
8410 0 : continue;
8411 0 : }
8412 0 :
8413 0 : let previously_attached_to = *tenant_shard.intent.get_attached();
8414 0 : match tenant_shard.reschedule_to_secondary(Some(node_id), scheduler) {
8415 0 : Err(e) => {
8416 0 : tracing::warn!(
8417 0 : tenant_id=%tid.tenant_id, shard_id=%tid.shard_slug(),
8418 0 : "Scheduling error when filling pageserver {} : {e}", node_id
8419 : );
8420 : }
8421 : Ok(()) => {
8422 0 : tracing::info!(
8423 0 : tenant_id=%tid.tenant_id, shard_id=%tid.shard_slug(),
8424 0 : "Rescheduled shard while filling node {}: {:?} -> {}",
8425 : node_id,
8426 : previously_attached_to,
8427 : node_id
8428 : );
8429 :
8430 0 : if let Some(waiter) = self.maybe_configured_reconcile_shard(
8431 0 : tenant_shard,
8432 0 : nodes,
8433 0 : reconciler_config,
8434 0 : ) {
8435 0 : waiters.push(waiter);
8436 0 : }
8437 : }
8438 : }
8439 0 : }
8440 : } else {
8441 0 : break;
8442 : }
8443 : }
8444 : }
8445 :
8446 0 : waiters = self
8447 0 : .await_waiters_remainder(waiters, WAITER_FILL_DRAIN_POLL_TIMEOUT)
8448 0 : .await;
8449 : }
8450 :
8451 0 : while !waiters.is_empty() {
8452 0 : if cancel.is_cancelled() {
8453 0 : match self
8454 0 : .node_configure(node_id, None, Some(NodeSchedulingPolicy::Active))
8455 0 : .await
8456 : {
8457 0 : Ok(()) => return Err(OperationError::Cancelled),
8458 0 : Err(err) => {
8459 0 : return Err(OperationError::FinalizeError(
8460 0 : format!(
8461 0 : "Failed to finalise drain cancel of {} by setting scheduling policy to Active: {}",
8462 0 : node_id, err
8463 0 : )
8464 0 : .into(),
8465 0 : ));
8466 : }
8467 : }
8468 0 : }
8469 0 :
8470 0 : tracing::info!("Awaiting {} pending fill reconciliations", waiters.len());
8471 :
8472 0 : waiters = self
8473 0 : .await_waiters_remainder(waiters, SHORT_RECONCILE_TIMEOUT)
8474 0 : .await;
8475 : }
8476 :
8477 0 : if let Err(err) = self
8478 0 : .node_configure(node_id, None, Some(NodeSchedulingPolicy::Active))
8479 0 : .await
8480 : {
8481 : // This isn't a huge issue since the filling process starts upon request. However, it
8482 : // will prevent the next drain from starting. The only case in which this can fail
8483 : // is database unavailability. Such a case will require manual intervention.
8484 0 : return Err(OperationError::FinalizeError(
8485 0 : format!("Failed to finalise fill of {node_id} by setting scheduling policy to Active: {err}")
8486 0 : .into(),
8487 0 : ));
8488 0 : }
8489 0 :
8490 0 : Ok(())
8491 0 : }
8492 :
8493 : /// Updates scrubber metadata health check results.
8494 0 : pub(crate) async fn metadata_health_update(
8495 0 : &self,
8496 0 : update_req: MetadataHealthUpdateRequest,
8497 0 : ) -> Result<(), ApiError> {
8498 0 : let now = chrono::offset::Utc::now();
8499 0 : let (healthy_records, unhealthy_records) = {
8500 0 : let locked = self.inner.read().unwrap();
8501 0 : let healthy_records = update_req
8502 0 : .healthy_tenant_shards
8503 0 : .into_iter()
8504 0 : // Retain only health records associated with tenant shards managed by storage controller.
8505 0 : .filter(|tenant_shard_id| locked.tenants.contains_key(tenant_shard_id))
8506 0 : .map(|tenant_shard_id| MetadataHealthPersistence::new(tenant_shard_id, true, now))
8507 0 : .collect();
8508 0 : let unhealthy_records = update_req
8509 0 : .unhealthy_tenant_shards
8510 0 : .into_iter()
8511 0 : .filter(|tenant_shard_id| locked.tenants.contains_key(tenant_shard_id))
8512 0 : .map(|tenant_shard_id| MetadataHealthPersistence::new(tenant_shard_id, false, now))
8513 0 : .collect();
8514 0 :
8515 0 : (healthy_records, unhealthy_records)
8516 0 : };
8517 0 :
8518 0 : self.persistence
8519 0 : .update_metadata_health_records(healthy_records, unhealthy_records, now)
8520 0 : .await?;
8521 0 : Ok(())
8522 0 : }
8523 :
8524 : /// Lists the tenant shards that has unhealthy metadata status.
8525 0 : pub(crate) async fn metadata_health_list_unhealthy(
8526 0 : &self,
8527 0 : ) -> Result<Vec<TenantShardId>, ApiError> {
8528 0 : let result = self
8529 0 : .persistence
8530 0 : .list_unhealthy_metadata_health_records()
8531 0 : .await?
8532 0 : .iter()
8533 0 : .map(|p| p.get_tenant_shard_id().unwrap())
8534 0 : .collect();
8535 0 :
8536 0 : Ok(result)
8537 0 : }
8538 :
8539 : /// Lists the tenant shards that have not been scrubbed for some duration.
8540 0 : pub(crate) async fn metadata_health_list_outdated(
8541 0 : &self,
8542 0 : not_scrubbed_for: Duration,
8543 0 : ) -> Result<Vec<MetadataHealthRecord>, ApiError> {
8544 0 : let earlier = chrono::offset::Utc::now() - not_scrubbed_for;
8545 0 : let result = self
8546 0 : .persistence
8547 0 : .list_outdated_metadata_health_records(earlier)
8548 0 : .await?
8549 0 : .into_iter()
8550 0 : .map(|record| record.into())
8551 0 : .collect();
8552 0 : Ok(result)
8553 0 : }
8554 :
8555 0 : pub(crate) fn get_leadership_status(&self) -> LeadershipStatus {
8556 0 : self.inner.read().unwrap().get_leadership_status()
8557 0 : }
8558 :
8559 0 : pub(crate) async fn step_down(&self) -> GlobalObservedState {
8560 0 : tracing::info!("Received step down request from peer");
8561 0 : failpoint_support::sleep_millis_async!("sleep-on-step-down-handling");
8562 :
8563 0 : self.inner.write().unwrap().step_down();
8564 0 : // TODO: would it make sense to have a time-out for this?
8565 0 : self.stop_reconciliations(StopReconciliationsReason::SteppingDown)
8566 0 : .await;
8567 :
8568 0 : let mut global_observed = GlobalObservedState::default();
8569 0 : let locked = self.inner.read().unwrap();
8570 0 : for (tid, tenant_shard) in locked.tenants.iter() {
8571 0 : global_observed
8572 0 : .0
8573 0 : .insert(*tid, tenant_shard.observed.clone());
8574 0 : }
8575 :
8576 0 : global_observed
8577 0 : }
8578 :
8579 0 : pub(crate) async fn update_shards_preferred_azs(
8580 0 : &self,
8581 0 : req: ShardsPreferredAzsRequest,
8582 0 : ) -> Result<ShardsPreferredAzsResponse, ApiError> {
8583 0 : let preferred_azs = req.preferred_az_ids.into_iter().collect::<Vec<_>>();
8584 0 : let updated = self
8585 0 : .persistence
8586 0 : .set_tenant_shard_preferred_azs(preferred_azs)
8587 0 : .await
8588 0 : .map_err(|err| {
8589 0 : ApiError::InternalServerError(anyhow::anyhow!(
8590 0 : "Failed to persist preferred AZs: {err}"
8591 0 : ))
8592 0 : })?;
8593 :
8594 0 : let mut updated_in_mem_and_db = Vec::default();
8595 0 :
8596 0 : let mut locked = self.inner.write().unwrap();
8597 0 : let state = locked.deref_mut();
8598 0 : for (tid, az_id) in updated {
8599 0 : let shard = state.tenants.get_mut(&tid);
8600 0 : if let Some(shard) = shard {
8601 0 : shard.set_preferred_az(&mut state.scheduler, az_id);
8602 0 : updated_in_mem_and_db.push(tid);
8603 0 : }
8604 : }
8605 :
8606 0 : Ok(ShardsPreferredAzsResponse {
8607 0 : updated: updated_in_mem_and_db,
8608 0 : })
8609 0 : }
8610 : }
8611 :
8612 : #[cfg(test)]
8613 : mod tests {
8614 : use super::*;
8615 :
8616 : /// Tests Service::compute_split_shards. For readability, this specifies sizes in GBs rather
8617 : /// than bytes. Note that max_logical_size is the total logical size of the largest timeline
8618 : /// summed across all shards.
8619 : #[test]
8620 1 : fn compute_split_shards() {
8621 1 : // Size-based split: two shards have a 500 GB timeline, which need to split into 8 shards
8622 1 : // that are <= 64 GB,
8623 1 : assert_eq!(
8624 1 : Service::compute_split_shards(ShardSplitInputs {
8625 1 : shard_count: ShardCount(2),
8626 1 : max_logical_size: 500,
8627 1 : split_threshold: 64,
8628 1 : max_split_shards: 16,
8629 1 : initial_split_threshold: 0,
8630 1 : initial_split_shards: 0,
8631 1 : }),
8632 1 : Some(ShardCount(8))
8633 1 : );
8634 :
8635 : // Size-based split: noop at or below threshold, fires above.
8636 1 : assert_eq!(
8637 1 : Service::compute_split_shards(ShardSplitInputs {
8638 1 : shard_count: ShardCount(2),
8639 1 : max_logical_size: 127,
8640 1 : split_threshold: 64,
8641 1 : max_split_shards: 16,
8642 1 : initial_split_threshold: 0,
8643 1 : initial_split_shards: 0,
8644 1 : }),
8645 1 : None,
8646 1 : );
8647 1 : assert_eq!(
8648 1 : Service::compute_split_shards(ShardSplitInputs {
8649 1 : shard_count: ShardCount(2),
8650 1 : max_logical_size: 128,
8651 1 : split_threshold: 64,
8652 1 : max_split_shards: 16,
8653 1 : initial_split_threshold: 0,
8654 1 : initial_split_shards: 0,
8655 1 : }),
8656 1 : None,
8657 1 : );
8658 1 : assert_eq!(
8659 1 : Service::compute_split_shards(ShardSplitInputs {
8660 1 : shard_count: ShardCount(2),
8661 1 : max_logical_size: 129,
8662 1 : split_threshold: 64,
8663 1 : max_split_shards: 16,
8664 1 : initial_split_threshold: 0,
8665 1 : initial_split_shards: 0,
8666 1 : }),
8667 1 : Some(ShardCount(4)),
8668 1 : );
8669 :
8670 : // Size-based split: clamped to max_split_shards.
8671 1 : assert_eq!(
8672 1 : Service::compute_split_shards(ShardSplitInputs {
8673 1 : shard_count: ShardCount(2),
8674 1 : max_logical_size: 10000,
8675 1 : split_threshold: 64,
8676 1 : max_split_shards: 16,
8677 1 : initial_split_threshold: 0,
8678 1 : initial_split_shards: 0,
8679 1 : }),
8680 1 : Some(ShardCount(16))
8681 1 : );
8682 :
8683 : // Size-based split: tenant already at or beyond max_split_shards is not split.
8684 1 : assert_eq!(
8685 1 : Service::compute_split_shards(ShardSplitInputs {
8686 1 : shard_count: ShardCount(16),
8687 1 : max_logical_size: 10000,
8688 1 : split_threshold: 64,
8689 1 : max_split_shards: 16,
8690 1 : initial_split_threshold: 0,
8691 1 : initial_split_shards: 0,
8692 1 : }),
8693 1 : None
8694 1 : );
8695 :
8696 1 : assert_eq!(
8697 1 : Service::compute_split_shards(ShardSplitInputs {
8698 1 : shard_count: ShardCount(32),
8699 1 : max_logical_size: 10000,
8700 1 : split_threshold: 64,
8701 1 : max_split_shards: 16,
8702 1 : initial_split_threshold: 0,
8703 1 : initial_split_shards: 0,
8704 1 : }),
8705 1 : None
8706 1 : );
8707 :
8708 : // Size-based split: a non-power-of-2 shard count is normalized to power-of-2 if it
8709 : // exceeds split_threshold (i.e. a 3-shard tenant splits into 8, not 6).
8710 1 : assert_eq!(
8711 1 : Service::compute_split_shards(ShardSplitInputs {
8712 1 : shard_count: ShardCount(3),
8713 1 : max_logical_size: 320,
8714 1 : split_threshold: 64,
8715 1 : max_split_shards: 16,
8716 1 : initial_split_threshold: 0,
8717 1 : initial_split_shards: 0,
8718 1 : }),
8719 1 : Some(ShardCount(8))
8720 1 : );
8721 :
8722 : // Size-based split: a non-power-of-2 shard count is not normalized to power-of-2 if the
8723 : // existing shards are below or at split_threshold, but splits into 4 if it exceeds it.
8724 1 : assert_eq!(
8725 1 : Service::compute_split_shards(ShardSplitInputs {
8726 1 : shard_count: ShardCount(3),
8727 1 : max_logical_size: 191,
8728 1 : split_threshold: 64,
8729 1 : max_split_shards: 16,
8730 1 : initial_split_threshold: 0,
8731 1 : initial_split_shards: 0,
8732 1 : }),
8733 1 : None
8734 1 : );
8735 1 : assert_eq!(
8736 1 : Service::compute_split_shards(ShardSplitInputs {
8737 1 : shard_count: ShardCount(3),
8738 1 : max_logical_size: 192,
8739 1 : split_threshold: 64,
8740 1 : max_split_shards: 16,
8741 1 : initial_split_threshold: 0,
8742 1 : initial_split_shards: 0,
8743 1 : }),
8744 1 : None
8745 1 : );
8746 1 : assert_eq!(
8747 1 : Service::compute_split_shards(ShardSplitInputs {
8748 1 : shard_count: ShardCount(3),
8749 1 : max_logical_size: 193,
8750 1 : split_threshold: 64,
8751 1 : max_split_shards: 16,
8752 1 : initial_split_threshold: 0,
8753 1 : initial_split_shards: 0,
8754 1 : }),
8755 1 : Some(ShardCount(4))
8756 1 : );
8757 :
8758 : // Initial split: tenant has a 10 GB timeline, split into 4 shards.
8759 1 : assert_eq!(
8760 1 : Service::compute_split_shards(ShardSplitInputs {
8761 1 : shard_count: ShardCount(1),
8762 1 : max_logical_size: 10,
8763 1 : split_threshold: 0,
8764 1 : max_split_shards: 16,
8765 1 : initial_split_threshold: 8,
8766 1 : initial_split_shards: 4,
8767 1 : }),
8768 1 : Some(ShardCount(4))
8769 1 : );
8770 :
8771 : // Initial split: 0 ShardCount is equivalent to 1.
8772 1 : assert_eq!(
8773 1 : Service::compute_split_shards(ShardSplitInputs {
8774 1 : shard_count: ShardCount(0),
8775 1 : max_logical_size: 10,
8776 1 : split_threshold: 0,
8777 1 : max_split_shards: 16,
8778 1 : initial_split_threshold: 8,
8779 1 : initial_split_shards: 4,
8780 1 : }),
8781 1 : Some(ShardCount(4))
8782 1 : );
8783 :
8784 : // Initial split: at or below threshold is noop.
8785 1 : assert_eq!(
8786 1 : Service::compute_split_shards(ShardSplitInputs {
8787 1 : shard_count: ShardCount(1),
8788 1 : max_logical_size: 7,
8789 1 : split_threshold: 0,
8790 1 : max_split_shards: 16,
8791 1 : initial_split_threshold: 8,
8792 1 : initial_split_shards: 4,
8793 1 : }),
8794 1 : None,
8795 1 : );
8796 1 : assert_eq!(
8797 1 : Service::compute_split_shards(ShardSplitInputs {
8798 1 : shard_count: ShardCount(1),
8799 1 : max_logical_size: 8,
8800 1 : split_threshold: 0,
8801 1 : max_split_shards: 16,
8802 1 : initial_split_threshold: 8,
8803 1 : initial_split_shards: 4,
8804 1 : }),
8805 1 : None,
8806 1 : );
8807 1 : assert_eq!(
8808 1 : Service::compute_split_shards(ShardSplitInputs {
8809 1 : shard_count: ShardCount(1),
8810 1 : max_logical_size: 9,
8811 1 : split_threshold: 0,
8812 1 : max_split_shards: 16,
8813 1 : initial_split_threshold: 8,
8814 1 : initial_split_shards: 4,
8815 1 : }),
8816 1 : Some(ShardCount(4))
8817 1 : );
8818 :
8819 : // Initial split: already sharded tenant is not affected, even if above threshold and below
8820 : // shard count.
8821 1 : assert_eq!(
8822 1 : Service::compute_split_shards(ShardSplitInputs {
8823 1 : shard_count: ShardCount(2),
8824 1 : max_logical_size: 20,
8825 1 : split_threshold: 0,
8826 1 : max_split_shards: 16,
8827 1 : initial_split_threshold: 8,
8828 1 : initial_split_shards: 4,
8829 1 : }),
8830 1 : None,
8831 1 : );
8832 :
8833 : // Initial split: clamped to max_shards.
8834 1 : assert_eq!(
8835 1 : Service::compute_split_shards(ShardSplitInputs {
8836 1 : shard_count: ShardCount(1),
8837 1 : max_logical_size: 10,
8838 1 : split_threshold: 0,
8839 1 : max_split_shards: 3,
8840 1 : initial_split_threshold: 8,
8841 1 : initial_split_shards: 4,
8842 1 : }),
8843 1 : Some(ShardCount(3)),
8844 1 : );
8845 :
8846 : // Initial+size split: tenant eligible for both will use the larger shard count.
8847 1 : assert_eq!(
8848 1 : Service::compute_split_shards(ShardSplitInputs {
8849 1 : shard_count: ShardCount(1),
8850 1 : max_logical_size: 10,
8851 1 : split_threshold: 64,
8852 1 : max_split_shards: 16,
8853 1 : initial_split_threshold: 8,
8854 1 : initial_split_shards: 4,
8855 1 : }),
8856 1 : Some(ShardCount(4)),
8857 1 : );
8858 1 : assert_eq!(
8859 1 : Service::compute_split_shards(ShardSplitInputs {
8860 1 : shard_count: ShardCount(1),
8861 1 : max_logical_size: 500,
8862 1 : split_threshold: 64,
8863 1 : max_split_shards: 16,
8864 1 : initial_split_threshold: 8,
8865 1 : initial_split_shards: 4,
8866 1 : }),
8867 1 : Some(ShardCount(8)),
8868 1 : );
8869 :
8870 : // Initial+size split: sharded tenant is only eligible for size-based split.
8871 1 : assert_eq!(
8872 1 : Service::compute_split_shards(ShardSplitInputs {
8873 1 : shard_count: ShardCount(2),
8874 1 : max_logical_size: 200,
8875 1 : split_threshold: 64,
8876 1 : max_split_shards: 16,
8877 1 : initial_split_threshold: 8,
8878 1 : initial_split_shards: 8,
8879 1 : }),
8880 1 : Some(ShardCount(4)),
8881 1 : );
8882 :
8883 : // Initial+size split: uses the larger shard count even with initial_split_threshold above
8884 : // split_threshold.
8885 1 : assert_eq!(
8886 1 : Service::compute_split_shards(ShardSplitInputs {
8887 1 : shard_count: ShardCount(1),
8888 1 : max_logical_size: 10,
8889 1 : split_threshold: 4,
8890 1 : max_split_shards: 16,
8891 1 : initial_split_threshold: 8,
8892 1 : initial_split_shards: 8,
8893 1 : }),
8894 1 : Some(ShardCount(8)),
8895 1 : );
8896 :
8897 : // Test backwards compatibility with production settings when initial/size-based splits were
8898 : // rolled out: a single split into 8 shards at 64 GB. Any already sharded tenants with <8
8899 : // shards will split according to split_threshold.
8900 1 : assert_eq!(
8901 1 : Service::compute_split_shards(ShardSplitInputs {
8902 1 : shard_count: ShardCount(1),
8903 1 : max_logical_size: 65,
8904 1 : split_threshold: 64,
8905 1 : max_split_shards: 8,
8906 1 : initial_split_threshold: 64,
8907 1 : initial_split_shards: 8,
8908 1 : }),
8909 1 : Some(ShardCount(8)),
8910 1 : );
8911 :
8912 1 : assert_eq!(
8913 1 : Service::compute_split_shards(ShardSplitInputs {
8914 1 : shard_count: ShardCount(1),
8915 1 : max_logical_size: 64,
8916 1 : split_threshold: 64,
8917 1 : max_split_shards: 8,
8918 1 : initial_split_threshold: 64,
8919 1 : initial_split_shards: 8,
8920 1 : }),
8921 1 : None,
8922 1 : );
8923 :
8924 1 : assert_eq!(
8925 1 : Service::compute_split_shards(ShardSplitInputs {
8926 1 : shard_count: ShardCount(2),
8927 1 : max_logical_size: 129,
8928 1 : split_threshold: 64,
8929 1 : max_split_shards: 8,
8930 1 : initial_split_threshold: 64,
8931 1 : initial_split_shards: 8,
8932 1 : }),
8933 1 : Some(ShardCount(4)),
8934 1 : );
8935 1 : }
8936 : }
|
