From 5bca7713c116c27a884f2be86182deb1a8df67d0 Mon Sep 17 00:00:00 2001 From: Heikki Linnakangas Date: Tue, 22 Nov 2022 11:01:09 +0200 Subject: [PATCH] Improve comments on TenantStates --- libs/pageserver_api/src/models.rs | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/libs/pageserver_api/src/models.rs b/libs/pageserver_api/src/models.rs index af9be2d456..aefd793366 100644 --- a/libs/pageserver_api/src/models.rs +++ b/libs/pageserver_api/src/models.rs @@ -17,10 +17,11 @@ use bytes::{BufMut, Bytes, BytesMut}; pub enum TenantState { /// Tenant is fully operational, its background jobs might be running or not. Active { background_jobs_running: bool }, - /// A tenant is recognized by pageserver, but not yet ready to operate: - /// e.g. not present locally and being downloaded or being read into memory from the file system. + /// A tenant is recognized by pageserver, but it is being detached or the + /// system is being shut down. Paused, - /// A tenant is recognized by the pageserver, but no longer used for any operations, as failed to get activated. + /// A tenant is recognized by the pageserver, but can no longer be used for + /// any operations, because it failed to be activated. Broken, } @@ -36,7 +37,8 @@ pub enum TimelineState { /// A timeline is recognized by pageserver, but not yet ready to operate and not allowed to /// automatically become Active after certain events: only a management call can change this status. Paused, - /// A timeline is recognized by the pageserver, but no longer used for any operations, as failed to get activated. + /// A timeline is recognized by the pageserver, but can no longer be used for + /// any operations, because it failed to be activated. Broken, }