Skip to content

Commit

Permalink
control_plane: update tenant_location_config comment
Browse files Browse the repository at this point in the history
  • Loading branch information
jcsp committed Feb 5, 2024
1 parent 47c5c0f commit 4313c0a
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions control_plane/attachment_service/src/service.rs
Original file line number Diff line number Diff line change
Expand Up @@ -879,14 +879,19 @@ impl Service {
Ok(())
}

/// This API is used by the cloud control plane to do coarse-grained control of tenants:
/// This API is used by the cloud control plane to migrate unsharded tenants that it created
/// directly with pageservers into this service.
///
/// Cloud control plane MUST NOT continue issuing GENERATION NUMBERS for this tenant once it
/// has attempted to call this API. Failure to oblige to this rule may lead to S3 corruption.
/// Think of the first attempt to call this API as a transfer of absolute authority over the
/// tenant's source of generation numbers.
///
/// The mode in this request coarse-grained control of tenants:
/// - Call with mode Attached* to upsert the tenant.
/// - Call with mode Secondary to either onboard a tenant without attaching it, or
/// to set an existing tenant to PolicyMode::Secondary
/// - Call with mode Detached to switch to PolicyMode::Detached
///
/// In future, calling with mode Secondary may switch to a detach-lite mode in which a tenant only has
/// secondary locations.
pub(crate) async fn tenant_location_config(
&self,
tenant_id: TenantId,
Expand Down

0 comments on commit 4313c0a

Please sign in to comment.