controller 0.59.0

Tembo Operator for Postgres
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
use crate::traefik::ingress_route_tcp_crd::{
    IngressRouteTCP, IngressRouteTCPRoutes, IngressRouteTCPRoutesMiddlewares,
    IngressRouteTCPRoutesServices, IngressRouteTCPSpec, IngressRouteTCPTls,
};
use k8s_openapi::apimachinery::pkg::{
    apis::meta::v1::{ObjectMeta, OwnerReference},
    util::intstr::IntOrString,
};
use kube::{
    api::{DeleteParams, Patch, PatchParams},
    Api, Resource, ResourceExt,
};
use regex::Regex;
use std::sync::Arc;

use crate::ingress_route_crd::IngressRoute;
use crate::{
    apis::coredb_types::CoreDB,
    errors::OperatorError,
    traefik::middleware_tcp_crd::{MiddlewareTCP, MiddlewareTCPIpAllowList, MiddlewareTCPSpec},
    Context,
};
use tracing::{debug, error, info};

pub const VALID_IPV4_CIDR_BLOCK: &str = "^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(/(3[0-2]|2[0-9]|1[0-9]|[0-9]))?$";

fn postgres_ingress_route_tcp(
    name: String,
    namespace: String,
    owner_reference: OwnerReference,
    matcher: String,
    service_name: String,
    middleware_names: Vec<String>,
    port: IntOrString,
) -> IngressRouteTCP {
    let mut middlewares = vec![];
    for middleware_name in middleware_names {
        middlewares.push(IngressRouteTCPRoutesMiddlewares {
            name: middleware_name.clone(),
            // Warning: 'namespace' field does not mean kubernetes namespace,
            // it means Traefik 'provider' namespace.
            // The IngressRouteTCP will by default look in the same Kubernetes namespace,
            // so this should be set to None.
            // https://doc.traefik.io/traefik/providers/overview/#provider-namespace
            namespace: None,
        });
    }
    let middlewares = Some(middlewares);

    IngressRouteTCP {
        metadata: ObjectMeta {
            name: Some(name),
            namespace: Some(namespace),
            owner_references: Some(vec![owner_reference]),
            ..ObjectMeta::default()
        },
        spec: IngressRouteTCPSpec {
            entry_points: Some(vec!["postgresql".to_string()]),
            routes: vec![IngressRouteTCPRoutes {
                r#match: matcher,
                services: Some(vec![IngressRouteTCPRoutesServices {
                    name: service_name,
                    port,
                    ..IngressRouteTCPRoutesServices::default()
                }]),
                middlewares,
                priority: None,
                syntax: None,
            }],
            tls: Some(IngressRouteTCPTls {
                passthrough: Some(true),
                ..IngressRouteTCPTls::default()
            }),
        },
    }
}

// For end-user provided, extra domain names,
// we allow for update and deletion of domain names.
pub async fn reconcile_extra_postgres_ing_route_tcp(
    cdb: &CoreDB,
    ctx: Arc<Context>,
    namespace: &str,
    service_name_read_write: &str,
    port: IntOrString,
    middleware_names: Vec<String>,
) -> Result<(), OperatorError> {
    let mut extra_domain_names = cdb.spec.extra_domains_rw.clone().unwrap_or_default();
    // Ensure always same order
    extra_domain_names.sort();
    let matchers = extra_domain_names
        .iter()
        .map(|domain_name| format!("HostSNI(`{}`)", domain_name))
        .collect::<Vec<String>>();
    let matcher_actual = matchers.join(" || ");
    let ingress_route_tcp_name = format!("extra-{}-rw", cdb.name_any());
    let owner_reference = cdb.controller_owner_ref(&()).unwrap();

    let ingress_route_tcp_to_apply = postgres_ingress_route_tcp(
        ingress_route_tcp_name.clone(),
        namespace.to_string(),
        owner_reference,
        matcher_actual,
        service_name_read_write.to_string(),
        middleware_names,
        port,
    );
    let ingress_route_tcp_api: Api<IngressRouteTCP> =
        Api::namespaced(ctx.client.clone(), namespace);
    if !extra_domain_names.is_empty() {
        apply_ingress_route_tcp(
            ingress_route_tcp_api,
            namespace,
            &ingress_route_tcp_name,
            &ingress_route_tcp_to_apply,
        )
        .await
    } else {
        delete_ingress_route_tcp(ingress_route_tcp_api, namespace, &ingress_route_tcp_name).await
    }
}

// For end-user provided, extra domain names,
// we allow for update and deletion of domain names.
pub async fn reconcile_ip_allowlist_middleware(
    cdb: &CoreDB,
    ctx: Arc<Context>,
) -> Result<String, OperatorError> {
    let ip_allow_list_middleware = generate_ip_allow_list_middleware_tcp(cdb);
    let middleware_name = ip_allow_list_middleware
        .metadata
        .name
        .clone()
        .expect("middleware is always named");
    let namespace = &ip_allow_list_middleware
        .metadata
        .namespace
        .clone()
        .expect("namespace is always set");

    let middleware_api: Api<MiddlewareTCP> = Api::namespaced(ctx.client.clone(), namespace);

    let patch = Patch::Apply(&ip_allow_list_middleware);
    let patch_parameters = PatchParams::apply("cntrlr").force();
    match middleware_api
        .patch(&middleware_name.clone(), &patch_parameters, &patch)
        .await
    {
        Ok(_) => {
            debug!(
                "Updated MiddlewareTCP {}.{}",
                middleware_name.clone(),
                &namespace
            );
        }
        Err(e) => {
            // serialize then log json of middlewaretcp
            let serialized = serde_json::to_string(&ip_allow_list_middleware).unwrap_or_default();
            error!(
                "Failed to update MiddlewareTCP {}.{}: {} \n {}",
                middleware_name, namespace, e, serialized
            );
            return Err(OperatorError::IngressRouteTcpError);
        }
    }

    Ok(middleware_name)
}

async fn apply_ingress_route_tcp(
    ingress_route_tcp_api: Api<IngressRouteTCP>,
    namespace: &str,
    ingress_route_tcp_name: &String,
    ingress_route_tcp_to_apply: &IngressRouteTCP,
) -> Result<(), OperatorError> {
    let patch: Patch<&&IngressRouteTCP> = Patch::Apply(&ingress_route_tcp_to_apply);
    let patch_parameters = PatchParams::apply("cntrlr").force();
    match ingress_route_tcp_api
        .patch(&ingress_route_tcp_name.clone(), &patch_parameters, &patch)
        .await
    {
        Ok(_) => {
            info!(
                "Updated postgres IngressRouteTCP {}.{}",
                ingress_route_tcp_name.clone(),
                namespace
            );
        }
        Err(e) => {
            error!(
                "Failed to update postgres IngressRouteTCP {}.{}: {}",
                ingress_route_tcp_name, namespace, e
            );
            return Err(OperatorError::IngressRouteTcpError);
        }
    }
    Ok(())
}

pub async fn delete_ingress_route(
    ingress_route_api: Api<IngressRoute>,
    namespace: &str,
    ingress_route_name: &String,
) -> Result<(), OperatorError> {
    // Check if the resource exists
    if ingress_route_api
        .get(&ingress_route_name.clone())
        .await
        .is_ok()
    {
        // If it exists, proceed with the deletion
        let delete_parameters = DeleteParams::default();
        match ingress_route_api
            .delete(&ingress_route_name.clone(), &delete_parameters)
            .await
        {
            Ok(_) => {
                info!(
                    "Deleted IngressRoute {}.{}",
                    ingress_route_name.clone(),
                    namespace
                );
            }
            Err(e) => {
                error!(
                    "Failed to delete IngressRoute {}.{}: {}",
                    ingress_route_name, namespace, e
                );
                return Err(OperatorError::IngressRouteError);
            }
        }
    } else {
        debug!(
            "IngressRoute {}.{} was not found. Assuming it's already deleted.",
            ingress_route_name, namespace
        );
    }
    Ok(())
}

pub async fn delete_ingress_route_tcp(
    ingress_route_tcp_api: Api<IngressRouteTCP>,
    namespace: &str,
    ingress_route_tcp_name: &String,
) -> Result<(), OperatorError> {
    // Check if the resource exists
    if ingress_route_tcp_api
        .get(&ingress_route_tcp_name.clone())
        .await
        .is_ok()
    {
        // If it exists, proceed with the deletion
        let delete_parameters = DeleteParams::default();
        match ingress_route_tcp_api
            .delete(&ingress_route_tcp_name.clone(), &delete_parameters)
            .await
        {
            Ok(_) => {
                info!(
                    "Deleted IngressRouteTCP {}.{}",
                    ingress_route_tcp_name.clone(),
                    namespace
                );
            }
            Err(e) => {
                error!(
                    "Failed to delete IngressRouteTCP {}.{}: {}",
                    ingress_route_tcp_name, namespace, e
                );
                return Err(OperatorError::IngressRouteTcpError);
            }
        }
    } else {
        debug!(
            "IngressRouteTCP {}.{} was not found. Assuming it's already deleted.",
            ingress_route_tcp_name, namespace
        );
    }
    Ok(())
}

#[allow(clippy::too_many_arguments)]
pub async fn reconcile_postgres_ing_route_tcp(
    cdb: &CoreDB,
    ctx: Arc<Context>,
    subdomain: &str,
    basedomain: &str,
    namespace: &str,
    ingress_name_prefix: &str,
    service_name: &str,
    port: IntOrString,
    middleware_names: Vec<String>,
    delete: bool,
) -> Result<(), OperatorError> {
    let client = ctx.client.clone();
    // Initialize kube api for ingress route tcp
    let ingress_route_tcp_api: Api<IngressRouteTCP> = Api::namespaced(client, namespace);
    let owner_reference = cdb.controller_owner_ref(&()).unwrap();
    let ingress_route_tcp_name = format!("{}0", ingress_name_prefix);
    let newest_matcher = format!("HostSNI(`{subdomain}.{basedomain}`)");
    if delete {
        delete_ingress_route_tcp(
            ingress_route_tcp_api.clone(),
            namespace,
            &ingress_route_tcp_name,
        )
        .await?;
        return Ok(());
    }

    let ingress_route_tcp_to_apply = postgres_ingress_route_tcp(
        ingress_route_tcp_name.clone(),
        namespace.to_string(),
        owner_reference.clone(),
        newest_matcher.clone(),
        service_name.to_string(),
        middleware_names.clone(),
        port.clone(),
    );

    // Apply this ingress route tcp
    apply_ingress_route_tcp(
        ingress_route_tcp_api.clone(),
        namespace,
        &ingress_route_tcp_name,
        &ingress_route_tcp_to_apply,
    )
    .await?;

    Ok(())
}

fn generate_ip_allow_list_middleware_tcp(cdb: &CoreDB) -> MiddlewareTCP {
    let source_range = cdb.spec.ip_allow_list.clone().unwrap_or_default();

    let mut valid_ips = valid_cidrs(&source_range);

    for ip in &source_range {
        if !valid_ips.contains(ip) {
            error!(
                "Invalid IP address or CIDR block '{}' on DB {}, skipping",
                ip,
                cdb.name_any()
            );
        }
    }

    if valid_ips.is_empty() {
        // If IP allow list is not specified, allow all IPs
        debug!(
            "No valid IP addresses or CIDR blocks specified for DB {}, allowing all IPs",
            cdb.name_any()
        );
        valid_ips.push("0.0.0.0/0".to_string());
    }

    let owner_references = cdb.controller_owner_ref(&()).map(|oref| vec![oref]);

    MiddlewareTCP {
        metadata: ObjectMeta {
            name: Some(cdb.name_any()),
            namespace: cdb.namespace(),
            owner_references,
            ..Default::default()
        },
        spec: MiddlewareTCPSpec {
            ip_allow_list: Some(MiddlewareTCPIpAllowList {
                source_range: Some(valid_ips),
            }),
            ..Default::default()
        },
    }
}

pub fn valid_cidrs(source_range: &[String]) -> Vec<String> {
    // Validate each IP address or CIDR block against the regex
    let cidr_regex =
        Regex::new(VALID_IPV4_CIDR_BLOCK).expect("Failed to compile regex for IPv4 CIDR block");
    let mut valid_ips = Vec::new();
    for ip in source_range.iter() {
        if !cidr_regex.is_match(ip) {
        } else {
            valid_ips.push(ip.clone());
        }
    }
    valid_ips.sort();
    valid_ips
}

#[cfg(test)]
mod tests {
    use crate::{
        apis::coredb_types::{CoreDB, CoreDBSpec},
        ingress::generate_ip_allow_list_middleware_tcp,
    };
    use k8s_openapi::apimachinery::pkg::apis::meta::v1::ObjectMeta;

    #[test]
    fn test_no_ip_allow_list() {
        let cdb = CoreDB {
            metadata: ObjectMeta::default(),
            spec: CoreDBSpec {
                ip_allow_list: None,
                ..CoreDBSpec::default()
            },
            status: None,
        };
        let result = generate_ip_allow_list_middleware_tcp(&cdb);
        let source_range = result
            .spec
            .ip_allow_list
            .clone()
            .unwrap()
            .source_range
            .unwrap();
        assert_eq!(source_range.len(), 1);
        assert!(
            source_range.contains(&"0.0.0.0/0".to_string()),
            "{:?}",
            source_range
        );
    }

    #[test]
    fn test_invalid_ips() {
        let cdb = CoreDB {
            metadata: ObjectMeta::default(),
            spec: CoreDBSpec {
                ip_allow_list: Some(vec!["10.0.0.256".to_string(), "192.168.1.0/33".to_string()]),
                ..CoreDBSpec::default()
            },
            status: None,
        };
        let result = generate_ip_allow_list_middleware_tcp(&cdb);
        let source_range = result
            .spec
            .ip_allow_list
            .clone()
            .unwrap()
            .source_range
            .unwrap();
        assert_eq!(source_range.len(), 1);
        assert!(
            source_range.contains(&"0.0.0.0/0".to_string()),
            "{:?}",
            source_range
        );
    }

    #[test]
    fn test_mixed_ips() {
        let cdb = CoreDB {
            metadata: ObjectMeta::default(),
            spec: CoreDBSpec {
                ip_allow_list: Some(vec![
                    "10.0.0.1".to_string(),
                    "192.168.1.0/24".to_string(),
                    "10.0.0.255".to_string(),
                ]),
                ..CoreDBSpec::default()
            },
            status: None,
        };
        let result = generate_ip_allow_list_middleware_tcp(&cdb);
        // Add assertions to ensure that the middleware contains the correct IPs and not the invalid one
        let source_range = result
            .spec
            .ip_allow_list
            .clone()
            .unwrap()
            .source_range
            .unwrap();
        assert_eq!(source_range.len(), 3);
        assert!(
            source_range.contains(&"10.0.0.1".to_string()),
            "{:?}",
            source_range
        );
        assert!(
            source_range.contains(&"192.168.1.0/24".to_string()),
            "{:?}",
            source_range
        );
        assert!(
            source_range.contains(&"10.0.0.255".to_string()),
            "{:?}",
            source_range
        );
    }
}