Line data Source code
1 : //! Structs representing the JSON formats used in the compute_ctl's HTTP API.
2 :
3 : use std::fmt::Display;
4 :
5 : use chrono::{DateTime, Utc};
6 : use jsonwebtoken::jwk::JwkSet;
7 : use serde::{Deserialize, Serialize, Serializer};
8 :
9 : use crate::privilege::Privilege;
10 : use crate::spec::{ComputeSpec, Database, ExtVersion, PgIdent, Role};
11 :
12 0 : #[derive(Serialize, Debug, Deserialize)]
13 : pub struct GenericAPIError {
14 : pub error: String,
15 : }
16 :
17 : /// All configuration parameters necessary for a compute. When
18 : /// [`ComputeConfig::spec`] is provided, it means that the compute is attached
19 : /// to a tenant. [`ComputeConfig::compute_ctl_config`] will always be provided
20 : /// and contains parameters necessary for operating `compute_ctl` independently
21 : /// of whether a tenant is attached to the compute or not.
22 : ///
23 : /// This also happens to be the body of `compute_ctl`'s /configure request.
24 0 : #[derive(Debug, Deserialize, Serialize)]
25 : pub struct ComputeConfig {
26 : /// The compute spec
27 : pub spec: Option<ComputeSpec>,
28 :
29 : /// The compute_ctl configuration
30 : #[allow(dead_code)]
31 : pub compute_ctl_config: ComputeCtlConfig,
32 : }
33 :
34 : impl From<ControlPlaneConfigResponse> for ComputeConfig {
35 0 : fn from(value: ControlPlaneConfigResponse) -> Self {
36 0 : Self {
37 0 : spec: value.spec,
38 0 : compute_ctl_config: value.compute_ctl_config,
39 0 : }
40 0 : }
41 : }
42 :
43 : #[derive(Debug, Clone, Serialize)]
44 : pub struct ExtensionInstallResponse {
45 : pub extension: PgIdent,
46 : pub version: ExtVersion,
47 : }
48 :
49 : /// Status of the LFC prewarm process. The same state machine is reused for
50 : /// both autoprewarm (prewarm after compute/Postgres start using the previously
51 : /// stored LFC state) and explicit prewarming via API.
52 : #[derive(Serialize, Default, Debug, Clone, PartialEq)]
53 : #[serde(tag = "status", rename_all = "snake_case")]
54 : pub enum LfcPrewarmState {
55 : /// Default value when compute boots up.
56 : #[default]
57 : NotPrewarmed,
58 : /// Prewarming thread is active and loading pages into LFC.
59 : Prewarming,
60 : /// We found requested LFC state in the endpoint storage and
61 : /// completed prewarming successfully.
62 : Completed,
63 : /// Unexpected error happened during prewarming. Note, `Not Found 404`
64 : /// response from the endpoint storage is explicitly excluded here
65 : /// because it can normally happen on the first compute start,
66 : /// since LFC state is not available yet.
67 : Failed { error: String },
68 : /// We tried to fetch the corresponding LFC state from the endpoint storage,
69 : /// but received `Not Found 404`. This should normally happen only during the
70 : /// first endpoint start after creation with `autoprewarm: true`.
71 : ///
72 : /// During the orchestrated prewarm via API, when a caller explicitly
73 : /// provides the LFC state key to prewarm from, it's the caller responsibility
74 : /// to handle this status as an error state in this case.
75 : Skipped,
76 : }
77 :
78 : impl Display for LfcPrewarmState {
79 0 : fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
80 0 : match self {
81 0 : LfcPrewarmState::NotPrewarmed => f.write_str("NotPrewarmed"),
82 0 : LfcPrewarmState::Prewarming => f.write_str("Prewarming"),
83 0 : LfcPrewarmState::Completed => f.write_str("Completed"),
84 0 : LfcPrewarmState::Skipped => f.write_str("Skipped"),
85 0 : LfcPrewarmState::Failed { error } => write!(f, "Error({error})"),
86 : }
87 0 : }
88 : }
89 :
90 : #[derive(Serialize, Default, Debug, Clone, PartialEq)]
91 : #[serde(tag = "status", rename_all = "snake_case")]
92 : pub enum LfcOffloadState {
93 : #[default]
94 : NotOffloaded,
95 : Offloading,
96 : Completed,
97 : Failed {
98 : error: String,
99 : },
100 : }
101 :
102 : #[derive(Serialize, Debug, Clone, PartialEq)]
103 : #[serde(tag = "status", rename_all = "snake_case")]
104 : /// Response of /promote
105 : pub enum PromoteState {
106 : NotPromoted,
107 : Completed,
108 : Failed { error: String },
109 : }
110 :
111 0 : #[derive(Deserialize, Default, Debug)]
112 : #[serde(rename_all = "snake_case")]
113 : pub struct PromoteConfig {
114 : pub spec: ComputeSpec,
115 : pub wal_flush_lsn: utils::lsn::Lsn,
116 : }
117 :
118 : /// Response of the /status API
119 0 : #[derive(Serialize, Debug, Deserialize)]
120 : #[serde(rename_all = "snake_case")]
121 : pub struct ComputeStatusResponse {
122 : pub start_time: DateTime<Utc>,
123 : pub tenant: Option<String>,
124 : pub timeline: Option<String>,
125 : pub status: ComputeStatus,
126 : #[serde(serialize_with = "rfc3339_serialize")]
127 : pub last_active: Option<DateTime<Utc>>,
128 : pub error: Option<String>,
129 : }
130 :
131 0 : #[derive(Serialize, Clone, Copy, Debug, Deserialize, PartialEq, Eq, Default)]
132 : #[serde(rename_all = "snake_case")]
133 : pub enum TerminateMode {
134 : #[default]
135 : /// wait 30s till returning from /terminate to allow control plane to get the error
136 : Fast,
137 : /// return from /terminate immediately as soon as all components are terminated
138 : Immediate,
139 : }
140 :
141 : impl From<TerminateMode> for ComputeStatus {
142 0 : fn from(mode: TerminateMode) -> Self {
143 0 : match mode {
144 0 : TerminateMode::Fast => ComputeStatus::TerminationPendingFast,
145 0 : TerminateMode::Immediate => ComputeStatus::TerminationPendingImmediate,
146 : }
147 0 : }
148 : }
149 :
150 0 : #[derive(Serialize, Clone, Copy, Debug, Deserialize, PartialEq, Eq)]
151 : #[serde(rename_all = "snake_case")]
152 : pub enum ComputeStatus {
153 : // Spec wasn't provided at start, waiting for it to be
154 : // provided by control-plane.
155 : Empty,
156 : // Compute configuration was requested.
157 : ConfigurationPending,
158 : // Compute node has spec and initial startup and
159 : // configuration is in progress.
160 : Init,
161 : // Compute is configured and running.
162 : Running,
163 : // New spec is being applied.
164 : Configuration,
165 : // Either startup or configuration failed,
166 : // compute will exit soon or is waiting for
167 : // control-plane to terminate it.
168 : Failed,
169 : // Termination requested
170 : TerminationPendingFast,
171 : // Termination requested, without waiting 30s before returning from /terminate
172 : TerminationPendingImmediate,
173 : // Terminated Postgres
174 : Terminated,
175 : // A spec refresh is being requested
176 : RefreshConfigurationPending,
177 : // A spec refresh is being applied. We cannot refresh configuration again until the current
178 : // refresh is done, i.e., signal_refresh_configuration() will return 500 error.
179 : RefreshConfiguration,
180 : }
181 :
182 0 : #[derive(Deserialize, Serialize)]
183 : pub struct TerminateResponse {
184 : pub lsn: Option<utils::lsn::Lsn>,
185 : }
186 :
187 : impl Display for ComputeStatus {
188 0 : fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
189 0 : match self {
190 0 : ComputeStatus::Empty => f.write_str("empty"),
191 0 : ComputeStatus::ConfigurationPending => f.write_str("configuration-pending"),
192 0 : ComputeStatus::RefreshConfiguration => f.write_str("refresh-configuration"),
193 : ComputeStatus::RefreshConfigurationPending => {
194 0 : f.write_str("refresh-configuration-pending")
195 : }
196 0 : ComputeStatus::Init => f.write_str("init"),
197 0 : ComputeStatus::Running => f.write_str("running"),
198 0 : ComputeStatus::Configuration => f.write_str("configuration"),
199 0 : ComputeStatus::Failed => f.write_str("failed"),
200 0 : ComputeStatus::TerminationPendingFast => f.write_str("termination-pending-fast"),
201 : ComputeStatus::TerminationPendingImmediate => {
202 0 : f.write_str("termination-pending-immediate")
203 : }
204 0 : ComputeStatus::Terminated => f.write_str("terminated"),
205 : }
206 0 : }
207 : }
208 :
209 0 : pub fn rfc3339_serialize<S>(x: &Option<DateTime<Utc>>, s: S) -> Result<S::Ok, S::Error>
210 0 : where
211 0 : S: Serializer,
212 : {
213 0 : if let Some(x) = x {
214 0 : x.to_rfc3339().serialize(s)
215 : } else {
216 0 : s.serialize_none()
217 : }
218 0 : }
219 :
220 : /// Response of the /metrics.json API
221 : #[derive(Clone, Debug, Default, Serialize)]
222 : pub struct ComputeMetrics {
223 : /// Time spent waiting in pool
224 : pub wait_for_spec_ms: u64,
225 :
226 : /// Time spent checking if safekeepers are synced
227 : pub sync_sk_check_ms: u64,
228 :
229 : /// Time spent syncing safekeepers (walproposer.c).
230 : /// In most cases this should be zero.
231 : pub sync_safekeepers_ms: u64,
232 :
233 : /// Time it took to establish a pg connection to the pageserver.
234 : /// This is two roundtrips, so it's a good proxy for compute-pageserver
235 : /// latency. The latency is usually 0.2ms, but it's not safe to assume
236 : /// that.
237 : pub pageserver_connect_micros: u64,
238 :
239 : /// Time to get basebackup from pageserver and write it to disk.
240 : pub basebackup_ms: u64,
241 :
242 : /// Compressed size of basebackup received.
243 : pub basebackup_bytes: u64,
244 :
245 : /// Time spent starting potgres. This includes initialization of shared
246 : /// buffers, preloading extensions, and other pg operations.
247 : pub start_postgres_ms: u64,
248 :
249 : /// Time spent applying pg catalog updates that were made in the console
250 : /// UI. This should be 0 when startup time matters, since cplane tries
251 : /// to do these updates eagerly, and passes the skip_pg_catalog_updates
252 : /// when it's safe to skip this step.
253 : pub config_ms: u64,
254 :
255 : /// Total time, from when we receive the spec to when we're ready to take
256 : /// pg connections.
257 : pub total_startup_ms: u64,
258 : pub load_ext_ms: u64,
259 : pub num_ext_downloaded: u64,
260 : pub largest_ext_size: u64, // these are measured in bytes
261 : pub total_ext_download_size: u64,
262 : }
263 :
264 : #[derive(Clone, Debug, Default, Serialize)]
265 : pub struct CatalogObjects {
266 : pub roles: Vec<Role>,
267 : pub databases: Vec<Database>,
268 : }
269 :
270 0 : #[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
271 : pub struct ComputeCtlConfig {
272 : /// Set of JSON web keys that the compute can use to authenticate
273 : /// communication from the control plane.
274 : pub jwks: JwkSet,
275 : pub tls: Option<TlsConfig>,
276 : }
277 :
278 : impl Default for ComputeCtlConfig {
279 0 : fn default() -> Self {
280 0 : Self {
281 0 : jwks: JwkSet {
282 0 : keys: Vec::default(),
283 0 : },
284 0 : tls: None,
285 0 : }
286 0 : }
287 : }
288 :
289 0 : #[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
290 : pub struct TlsConfig {
291 : pub key_path: String,
292 : pub cert_path: String,
293 : }
294 :
295 : /// Response of the `/computes/{compute_id}/spec` control-plane API.
296 0 : #[derive(Deserialize, Debug)]
297 : pub struct ControlPlaneConfigResponse {
298 : pub spec: Option<ComputeSpec>,
299 : pub status: ControlPlaneComputeStatus,
300 : pub compute_ctl_config: ComputeCtlConfig,
301 : }
302 :
303 0 : #[derive(Deserialize, Clone, Copy, Debug, PartialEq, Eq)]
304 : #[serde(rename_all = "snake_case")]
305 : pub enum ControlPlaneComputeStatus {
306 : // Compute is known to control-plane, but it's not
307 : // yet attached to any timeline / endpoint.
308 : Empty,
309 : // Compute is attached to some timeline / endpoint and
310 : // should be able to start with provided spec.
311 : Attached,
312 : }
313 :
314 : #[derive(Clone, Debug, Default, Serialize)]
315 : pub struct InstalledExtension {
316 : pub extname: String,
317 : pub version: String,
318 : pub n_databases: u32, // Number of databases using this extension
319 : pub owned_by_superuser: String,
320 : }
321 :
322 : #[derive(Clone, Debug, Default, Serialize)]
323 : pub struct InstalledExtensions {
324 : pub extensions: Vec<InstalledExtension>,
325 : }
326 :
327 : #[derive(Clone, Debug, Default, Serialize)]
328 : pub struct ExtensionInstallResult {
329 : pub extension: PgIdent,
330 : pub version: ExtVersion,
331 : }
332 : #[derive(Clone, Debug, Default, Serialize)]
333 : pub struct SetRoleGrantsResponse {
334 : pub database: PgIdent,
335 : pub schema: PgIdent,
336 : pub privileges: Vec<Privilege>,
337 : pub role: PgIdent,
338 : }
|
