Line data Source code
1 : //! `ComputeSpec` represents the contents of the spec.json file.
2 : //!
3 : //! The spec.json file is used to pass information to 'compute_ctl'. It contains
4 : //! all the information needed to start up the right version of PostgreSQL,
5 : //! and connect it to the storage nodes.
6 : use std::collections::HashMap;
7 :
8 : use serde::{Deserialize, Serialize};
9 : use utils::id::{TenantId, TimelineId};
10 : use utils::lsn::Lsn;
11 :
12 : use regex::Regex;
13 : use remote_storage::RemotePath;
14 :
15 : /// String type alias representing Postgres identifier and
16 : /// intended to be used for DB / role names.
17 : pub type PgIdent = String;
18 :
19 : /// Cluster spec or configuration represented as an optional number of
20 : /// delta operations + final cluster state description.
21 178 : #[derive(Clone, Debug, Default, Deserialize, Serialize)]
22 : pub struct ComputeSpec {
23 : pub format_version: f32,
24 :
25 : // The control plane also includes a 'timestamp' field in the JSON document,
26 : // but we don't use it for anything. Serde will ignore missing fields when
27 : // deserializing it.
28 : pub operation_uuid: Option<String>,
29 :
30 : /// Compute features to enable. These feature flags are provided, when we
31 : /// know all the details about client's compute, so they cannot be used
32 : /// to change `Empty` compute behavior.
33 : #[serde(default)]
34 : pub features: Vec<ComputeFeature>,
35 :
36 : /// Expected cluster state at the end of transition process.
37 : pub cluster: Cluster,
38 : pub delta_operations: Option<Vec<DeltaOp>>,
39 :
40 : /// An optinal hint that can be passed to speed up startup time if we know
41 : /// that no pg catalog mutations (like role creation, database creation,
42 : /// extension creation) need to be done on the actual database to start.
43 : #[serde(default)] // Default false
44 : pub skip_pg_catalog_updates: bool,
45 :
46 : // Information needed to connect to the storage layer.
47 : //
48 : // `tenant_id`, `timeline_id` and `pageserver_connstring` are always needed.
49 : //
50 : // Depending on `mode`, this can be a primary read-write node, a read-only
51 : // replica, or a read-only node pinned at an older LSN.
52 : // `safekeeper_connstrings` must be set for a primary.
53 : //
54 : // For backwards compatibility, the control plane may leave out all of
55 : // these, and instead set the "neon.tenant_id", "neon.timeline_id",
56 : // etc. GUCs in cluster.settings. TODO: Once the control plane has been
57 : // updated to fill these fields, we can make these non optional.
58 : pub tenant_id: Option<TenantId>,
59 :
60 : pub timeline_id: Option<TimelineId>,
61 :
62 : pub pageserver_connstring: Option<String>,
63 :
64 : #[serde(default)]
65 : pub safekeeper_connstrings: Vec<String>,
66 :
67 : #[serde(default)]
68 : pub mode: ComputeMode,
69 :
70 : /// If set, 'storage_auth_token' is used as the password to authenticate to
71 : /// the pageserver and safekeepers.
72 : pub storage_auth_token: Option<String>,
73 :
74 : // information about available remote extensions
75 : pub remote_extensions: Option<RemoteExtSpec>,
76 :
77 : pub pgbouncer_settings: Option<HashMap<String, String>>,
78 :
79 : // Stripe size for pageserver sharding, in pages
80 : #[serde(default)]
81 : pub shard_stripe_size: Option<usize>,
82 :
83 : // When we are starting a new replica in hot standby mode,
84 : // we need to know if the primary is running.
85 : // This is used to determine if replica should wait for
86 : // RUNNING_XACTS from primary or not.
87 : pub primary_is_running: Option<bool>,
88 : }
89 :
90 : /// Feature flag to signal `compute_ctl` to enable certain experimental functionality.
91 12 : #[derive(Serialize, Clone, Copy, Debug, Deserialize, PartialEq, Eq)]
92 : #[serde(rename_all = "snake_case")]
93 : pub enum ComputeFeature {
94 : // XXX: Add more feature flags here.
95 : /// Enable the experimental activity monitor logic, which uses `pg_stat_database` to
96 : /// track short-lived connections as user activity.
97 : ActivityMonitorExperimental,
98 :
99 : /// Pre-install and initialize anon extension for every database in the cluster
100 : AnonExtension,
101 :
102 : /// This is a special feature flag that is used to represent unknown feature flags.
103 : /// Basically all unknown to enum flags are represented as this one. See unit test
104 : /// `parse_unknown_features()` for more details.
105 : #[serde(other)]
106 : UnknownFeature,
107 : }
108 :
109 108 : #[derive(Clone, Debug, Default, Deserialize, Serialize)]
110 : pub struct RemoteExtSpec {
111 : pub public_extensions: Option<Vec<String>>,
112 : pub custom_extensions: Option<Vec<String>>,
113 : pub library_index: HashMap<String, String>,
114 : pub extension_data: HashMap<String, ExtensionData>,
115 : }
116 :
117 120 : #[derive(Clone, Debug, Serialize, Deserialize)]
118 : pub struct ExtensionData {
119 : pub control_data: HashMap<String, String>,
120 : pub archive_path: String,
121 : }
122 :
123 : impl RemoteExtSpec {
124 0 : pub fn get_ext(
125 0 : &self,
126 0 : ext_name: &str,
127 0 : is_library: bool,
128 0 : build_tag: &str,
129 0 : pg_major_version: &str,
130 0 : ) -> anyhow::Result<(String, RemotePath)> {
131 0 : let mut real_ext_name = ext_name;
132 0 : if is_library {
133 : // sometimes library names might have a suffix like
134 : // library.so or library.so.3. We strip this off
135 : // because library_index is based on the name without the file extension
136 0 : let strip_lib_suffix = Regex::new(r"\.so.*").unwrap();
137 0 : let lib_raw_name = strip_lib_suffix.replace(real_ext_name, "").to_string();
138 0 :
139 0 : real_ext_name = self
140 0 : .library_index
141 0 : .get(&lib_raw_name)
142 0 : .ok_or(anyhow::anyhow!("library {} is not found", lib_raw_name))?;
143 0 : }
144 :
145 : // Check if extension is present in public or custom.
146 : // If not, then it is not allowed to be used by this compute.
147 0 : if let Some(public_extensions) = &self.public_extensions {
148 0 : if !public_extensions.contains(&real_ext_name.to_string()) {
149 0 : if let Some(custom_extensions) = &self.custom_extensions {
150 0 : if !custom_extensions.contains(&real_ext_name.to_string()) {
151 0 : return Err(anyhow::anyhow!("extension {} is not found", real_ext_name));
152 0 : }
153 0 : }
154 0 : }
155 0 : }
156 :
157 0 : match self.extension_data.get(real_ext_name) {
158 0 : Some(_ext_data) => {
159 0 : // Construct the path to the extension archive
160 0 : // BUILD_TAG/PG_MAJOR_VERSION/extensions/EXTENSION_NAME.tar.zst
161 0 : //
162 0 : // Keep it in sync with path generation in
163 0 : // https://github.com/neondatabase/build-custom-extensions/tree/main
164 0 : let archive_path_str =
165 0 : format!("{build_tag}/{pg_major_version}/extensions/{real_ext_name}.tar.zst");
166 0 : Ok((
167 0 : real_ext_name.to_string(),
168 0 : RemotePath::from_string(&archive_path_str)?,
169 : ))
170 : }
171 0 : None => Err(anyhow::anyhow!(
172 0 : "real_ext_name {} is not found",
173 0 : real_ext_name
174 0 : )),
175 : }
176 0 : }
177 : }
178 :
179 12 : #[derive(Clone, Copy, Debug, Default, Eq, PartialEq, Deserialize, Serialize)]
180 : pub enum ComputeMode {
181 : /// A read-write node
182 : #[default]
183 : Primary,
184 : /// A read-only node, pinned at a particular LSN
185 : Static(Lsn),
186 : /// A read-only node that follows the tip of the branch in hot standby mode
187 : ///
188 : /// Future versions may want to distinguish between replicas with hot standby
189 : /// feedback and other kinds of replication configurations.
190 : Replica,
191 : }
192 :
193 156 : #[derive(Clone, Debug, Default, Deserialize, Serialize)]
194 : pub struct Cluster {
195 : pub cluster_id: Option<String>,
196 : pub name: Option<String>,
197 : pub state: Option<String>,
198 : pub roles: Vec<Role>,
199 : pub databases: Vec<Database>,
200 :
201 : /// Desired contents of 'postgresql.conf' file. (The 'compute_ctl'
202 : /// tool may add additional settings to the final file.)
203 : pub postgresql_conf: Option<String>,
204 :
205 : /// Additional settings that will be appended to the 'postgresql.conf' file.
206 : pub settings: GenericOptions,
207 : }
208 :
209 : /// Single cluster state changing operation that could not be represented as
210 : /// a static `Cluster` structure. For example:
211 : /// - DROP DATABASE
212 : /// - DROP ROLE
213 : /// - ALTER ROLE name RENAME TO new_name
214 : /// - ALTER DATABASE name RENAME TO new_name
215 288 : #[derive(Clone, Debug, Deserialize, Serialize)]
216 : pub struct DeltaOp {
217 : pub action: String,
218 : pub name: PgIdent,
219 : pub new_name: Option<PgIdent>,
220 : }
221 :
222 : /// Rust representation of Postgres role info with only those fields
223 : /// that matter for us.
224 432 : #[derive(Clone, Debug, Deserialize, Serialize)]
225 : pub struct Role {
226 : pub name: PgIdent,
227 : pub encrypted_password: Option<String>,
228 : pub options: GenericOptions,
229 : }
230 :
231 : /// Rust representation of Postgres database info with only those fields
232 : /// that matter for us.
233 204 : #[derive(Clone, Debug, Deserialize, Serialize)]
234 : pub struct Database {
235 : pub name: PgIdent,
236 : pub owner: PgIdent,
237 : pub options: GenericOptions,
238 : // These are derived flags, not present in the spec file.
239 : // They are never set by the control plane.
240 : #[serde(skip_deserializing, default)]
241 : pub restrict_conn: bool,
242 : #[serde(skip_deserializing, default)]
243 : pub invalid: bool,
244 : }
245 :
246 : /// Common type representing both SQL statement params with or without value,
247 : /// like `LOGIN` or `OWNER username` in the `CREATE/ALTER ROLE`, and config
248 : /// options like `wal_level = logical`.
249 2184 : #[derive(Clone, Debug, Deserialize, Serialize)]
250 : pub struct GenericOption {
251 : pub name: String,
252 : pub value: Option<String>,
253 : pub vartype: String,
254 : }
255 :
256 : /// Optional collection of `GenericOption`'s. Type alias allows us to
257 : /// declare a `trait` on it.
258 : pub type GenericOptions = Option<Vec<GenericOption>>;
259 :
260 : #[cfg(test)]
261 : mod tests {
262 : use super::*;
263 : use std::fs::File;
264 :
265 2 : #[test]
266 2 : fn parse_spec_file() {
267 2 : let file = File::open("tests/cluster_spec.json").unwrap();
268 2 : let spec: ComputeSpec = serde_json::from_reader(file).unwrap();
269 2 :
270 2 : // Features list defaults to empty vector.
271 2 : assert!(spec.features.is_empty());
272 2 : }
273 :
274 2 : #[test]
275 2 : fn parse_unknown_fields() {
276 2 : // Forward compatibility test
277 2 : let file = File::open("tests/cluster_spec.json").unwrap();
278 2 : let mut json: serde_json::Value = serde_json::from_reader(file).unwrap();
279 2 : let ob = json.as_object_mut().unwrap();
280 2 : ob.insert("unknown_field_123123123".into(), "hello".into());
281 2 : let _spec: ComputeSpec = serde_json::from_value(json).unwrap();
282 2 : }
283 :
284 2 : #[test]
285 2 : fn parse_unknown_features() {
286 2 : // Test that unknown feature flags do not cause any errors.
287 2 : let file = File::open("tests/cluster_spec.json").unwrap();
288 2 : let mut json: serde_json::Value = serde_json::from_reader(file).unwrap();
289 2 : let ob = json.as_object_mut().unwrap();
290 2 :
291 2 : // Add unknown feature flags.
292 2 : let features = vec!["foo_bar_feature", "baz_feature"];
293 2 : ob.insert("features".into(), features.into());
294 2 :
295 2 : let spec: ComputeSpec = serde_json::from_value(json).unwrap();
296 2 :
297 2 : assert!(spec.features.len() == 2);
298 2 : assert!(spec.features.contains(&ComputeFeature::UnknownFeature));
299 2 : assert_eq!(spec.features, vec![ComputeFeature::UnknownFeature; 2]);
300 2 : }
301 :
302 2 : #[test]
303 2 : fn parse_known_features() {
304 2 : // Test that we can properly parse known feature flags.
305 2 : let file = File::open("tests/cluster_spec.json").unwrap();
306 2 : let mut json: serde_json::Value = serde_json::from_reader(file).unwrap();
307 2 : let ob = json.as_object_mut().unwrap();
308 2 :
309 2 : // Add known feature flags.
310 2 : let features = vec!["activity_monitor_experimental"];
311 2 : ob.insert("features".into(), features.into());
312 2 :
313 2 : let spec: ComputeSpec = serde_json::from_value(json).unwrap();
314 2 :
315 2 : assert_eq!(
316 2 : spec.features,
317 2 : vec![ComputeFeature::ActivityMonitorExperimental]
318 2 : );
319 2 : }
320 : }
|
