kaniop-operator 0.22.1

Core library for the Kanidm Kubernetes operator
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
use super::super::controller::context::Context;
use crate::kanidm::crd::{DomainAppearanceImageStatus, Kanidm, KanidmStatus};
use crate::metrics::{
    KANIDM_OP_DELETE, KANIDM_OP_IMAGE, KANIDM_OP_SET_DISPLAY_NAME, KANIDM_OUTCOME_CHANGED,
    KANIDM_OUTCOME_ERROR, KANIDM_OUTCOME_UNCHANGED, KANIDM_RESOURCE_DOMAIN,
};
use kaniop_k8s_util::error::{Error, Result};
use kaniop_k8s_util::image::{ImageOperation, publish_image_error_event, update_image_if_needed};

use std::sync::Arc;

use kanidm_client::{ClientError, KanidmClient, StatusCode};
use kanidm_proto::internal::OperationError;
use kube::ResourceExt;
use kube::api::{Api, Patch, PatchParams};
use tracing::{debug, trace};

async fn delete_domain_image(kanidm_client: &KanidmClient, ctx: &Context) -> Result<()> {
    let start = tokio::time::Instant::now();
    let result = kanidm_client.idm_domain_delete_image().await;
    match result {
        Ok(()) => {
            ctx.kaniop_ctx.metrics.record_kanidm_sdk_outcome(
                KANIDM_RESOURCE_DOMAIN,
                KANIDM_OP_DELETE,
                KANIDM_OUTCOME_CHANGED,
                start.elapsed(),
            );
            Ok(())
        }
        Err(ClientError::Http(
            StatusCode::NOT_FOUND,
            Some(OperationError::NoMatchingEntries),
            _,
        )) => {
            debug!("domain image already absent, skipping delete");
            ctx.kaniop_ctx.metrics.record_kanidm_sdk_outcome(
                KANIDM_RESOURCE_DOMAIN,
                KANIDM_OP_DELETE,
                KANIDM_OUTCOME_UNCHANGED,
                start.elapsed(),
            );
            Ok(())
        }
        Err(e) => {
            ctx.kaniop_ctx.metrics.record_kanidm_sdk_outcome(
                KANIDM_RESOURCE_DOMAIN,
                KANIDM_OP_DELETE,
                KANIDM_OUTCOME_ERROR,
                start.elapsed(),
            );
            Err(Error::KanidmClientError(
                "failed to delete domain image".to_string(),
                Box::new(e),
            ))
        }
    }
}

async fn clear_domain_appearance_image_status(
    kanidm_api: &Api<Kanidm>,
    name: &str,
    namespace: &str,
) -> Result<()> {
    let status_patch = serde_json::json!({
        "status": {
            "domainAppearanceImage": null
        }
    });
    kanidm_api
        .patch_status(name, &PatchParams::default(), &Patch::Merge(&status_patch))
        .await
        .map_err(|e| {
            Error::KubeError(
                format!("failed to clear domain appearance image status for {namespace}/{name}"),
                Box::new(e),
            )
        })?;
    Ok(())
}

/// Remove the domain image from Kanidm if the operator set one, as recorded in the status.
///
/// Skipping the delete when no image was set avoids an admin API call on every reconciliation.
/// The status is cleared only after a successful delete, so a failed delete is retried.
async fn remove_domain_image(
    kanidm: &Kanidm,
    kanidm_client: &KanidmClient,
    status: &KanidmStatus,
    ctx: &Context,
) -> Result<()> {
    if status.domain_appearance_image.is_none() {
        trace!("no domain image set by the operator, skipping delete");
        return Ok(());
    }

    debug!("removing domain image from Kanidm");
    delete_domain_image(kanidm_client, ctx).await?;

    let namespace = kanidm.namespace().unwrap();
    let name = kanidm.name_any();
    let kanidm_api = Api::<Kanidm>::namespaced(ctx.kaniop_ctx.client.clone(), &namespace);
    clear_domain_appearance_image_status(&kanidm_api, &name, &namespace).await
}

pub async fn reconcile_domain_appearance(
    kanidm: &Kanidm,
    kanidm_client: Arc<KanidmClient>,
    status: &KanidmStatus,
    ctx: Arc<Context>,
) -> Result<()> {
    let namespace = kanidm.namespace().unwrap();
    let name = kanidm.name_any();
    let kanidm_api = Api::<Kanidm>::namespaced(ctx.kaniop_ctx.client.clone(), &namespace);

    let current_kanidm = kanidm_api.get(&name).await.map_err(|e| {
        Error::KubeError(
            format!("failed to get current Kanidm {namespace}/{name}"),
            Box::new(e),
        )
    })?;

    let domain_appearance = current_kanidm.spec.domain_appearance.as_ref();
    let image_spec = domain_appearance.and_then(|da| da.image.as_ref());

    if let Some(domain_appearance) = domain_appearance {
        reconcile_domain_display_name(
            kanidm,
            kanidm_client.clone(),
            domain_appearance.display_name.as_deref(),
            &ctx,
        )
        .await?;

        reconcile_domain_image_with_spec(kanidm, kanidm_client, status, ctx.clone(), image_spec)
            .await?;
    } else {
        remove_domain_image(kanidm, &kanidm_client, status, &ctx).await?;
    }

    Ok(())
}

async fn reconcile_domain_display_name(
    kanidm: &Kanidm,
    kanidm_client: Arc<KanidmClient>,
    display_name: Option<&str>,
    ctx: &Context,
) -> Result<()> {
    if let Some(name) = display_name {
        debug!("setting domain display name to '{}'", name);
        let start = tokio::time::Instant::now();
        let result = kanidm_client.idm_domain_set_display_name(name).await;
        match result {
            Ok(()) => {
                ctx.kaniop_ctx.metrics.record_kanidm_sdk_outcome(
                    KANIDM_RESOURCE_DOMAIN,
                    KANIDM_OP_SET_DISPLAY_NAME,
                    KANIDM_OUTCOME_CHANGED,
                    start.elapsed(),
                );
            }
            Err(ClientError::Http(
                StatusCode::NOT_FOUND,
                Some(OperationError::NoMatchingEntries),
                _,
            )) => {
                debug!("domain display name target is absent, skipping update");
                ctx.kaniop_ctx.metrics.record_kanidm_sdk_outcome(
                    KANIDM_RESOURCE_DOMAIN,
                    KANIDM_OP_SET_DISPLAY_NAME,
                    KANIDM_OUTCOME_UNCHANGED,
                    start.elapsed(),
                );
            }
            Err(e) => {
                ctx.kaniop_ctx.metrics.record_kanidm_sdk_outcome(
                    KANIDM_RESOURCE_DOMAIN,
                    KANIDM_OP_SET_DISPLAY_NAME,
                    KANIDM_OUTCOME_ERROR,
                    start.elapsed(),
                );
                return Err(Error::KanidmClientError(
                    format!(
                        "failed to set domain display name for {namespace}/{name}",
                        namespace = kanidm.namespace().unwrap(),
                        name = kanidm.name_any()
                    ),
                    Box::new(e),
                ));
            }
        }
    }
    Ok(())
}

async fn reconcile_domain_image_with_spec(
    kanidm: &Kanidm,
    kanidm_client: Arc<KanidmClient>,
    status: &KanidmStatus,
    ctx: Arc<Context>,
    image_spec: Option<&crate::kanidm::crd::DomainAppearanceImageSpec>,
) -> Result<()> {
    match image_spec {
        None => {
            remove_domain_image(kanidm, &kanidm_client, status, &ctx).await?;
        }
        Some(image_spec) => {
            let url = &image_spec.url;
            let namespace = kanidm.namespace().unwrap();
            let name = kanidm.name_any();
            debug!("checking domain image from {}", url);

            let kanidm_client_clone = kanidm_client.clone();
            let namespace_for_error = namespace.clone();
            let name_for_error = name.clone();
            let metrics = ctx.kaniop_ctx.metrics.clone();

            let update_result = update_image_if_needed(
                url,
                status.domain_appearance_image.as_ref(),
                |image_value| {
                    let metrics = metrics.clone();
                    async move {
                        let start = tokio::time::Instant::now();
                        let result = kanidm_client_clone
                            .idm_domain_update_image(image_value)
                            .await;
                        match &result {
                            Ok(_) => {
                                metrics.record_kanidm_sdk_outcome(
                                    KANIDM_RESOURCE_DOMAIN,
                                    KANIDM_OP_IMAGE,
                                    KANIDM_OUTCOME_CHANGED,
                                    start.elapsed(),
                                );
                            }
                            Err(_) => {
                                metrics.record_kanidm_sdk_outcome(
                                    KANIDM_RESOURCE_DOMAIN,
                                    KANIDM_OP_IMAGE,
                                    KANIDM_OUTCOME_ERROR,
                                    start.elapsed(),
                                );
                            }
                        }
                        result.map_err(|e| {
                            Error::KanidmClientError(
                                format!(
                                    "failed to update domain image for {namespace_for_error}/{name_for_error}",
                                ),
                                Box::new(e),
                            )
                        })
                    }
                },
            )
            .await;

            match update_result {
                Ok(Some(updated)) => {
                    let new_image_status = DomainAppearanceImageStatus {
                        url: updated.image_status.url,
                        etag: updated.image_status.etag,
                        last_modified: updated.image_status.last_modified,
                        content_length: updated.image_status.content_length,
                        content_hash: Some(updated.image_status.content_hash),
                    };

                    let namespace = kanidm.namespace().unwrap();
                    let name = kanidm.name_any();
                    let kanidm_api =
                        Api::<Kanidm>::namespaced(ctx.kaniop_ctx.client.clone(), &namespace);
                    let status_patch = serde_json::json!({
                        "status": {
                            "domainAppearanceImage": new_image_status
                        }
                    });
                    kanidm_api
                        .patch_status(&name, &PatchParams::default(), &Patch::Merge(&status_patch))
                        .await
                        .map_err(|e| {
                            Error::KubeError(
                                format!("failed to patch Kanidm/status {namespace}/{name}"),
                                Box::new(e),
                            )
                        })?;
                }
                Ok(None) => {}
                Err(e) => {
                    let operation = if matches!(e, Error::HttpError(_, _)) {
                        ImageOperation::Fetch
                    } else {
                        ImageOperation::Download
                    };
                    return Err(publish_image_error_event(
                        e,
                        operation,
                        &name,
                        &namespace,
                        &name,
                        &ctx.kaniop_ctx.recorder,
                        kanidm,
                    )
                    .await);
                }
            }
        }
    };

    Ok(())
}

#[cfg(test)]
mod test {
    use super::reconcile_domain_appearance;

    use crate::kanidm::crd::{DomainAppearanceImageStatus, Kanidm, KanidmStatus};
    use crate::kanidm::reconcile::test::get_test_context;
    use kaniop_k8s_util::error::Result;

    use std::sync::Arc;
    use std::time::Duration;

    use futures::FutureExt;
    use http::{Method, Response};
    use kanidm_client::{KanidmClient, KanidmClientBuilder};
    use kube::client::Body;

    /// Client for a Kanidm refusing connections, so any Kanidm API call fails.
    fn unreachable_kanidm_client() -> Arc<KanidmClient> {
        let listener = std::net::TcpListener::bind("127.0.0.1:0").unwrap();
        let address = listener.local_addr().unwrap();
        drop(listener);
        Arc::new(
            KanidmClientBuilder::new()
                .no_proxy()
                .address(format!("http://{address}"))
                .build()
                .unwrap(),
        )
    }

    /// Reconcile the domain appearance of a Kanidm without image in its spec. The mocked
    /// Kubernetes API answers only the initial read of the Kanidm; returns the reconcile result
    /// and whether any further Kubernetes API request (e.g. a status patch) was made.
    async fn reconcile_without_image_spec(status: KanidmStatus) -> (Result<()>, bool) {
        let (ctx, verifier) = get_test_context();
        let mut api_server = verifier.0;
        let kanidm = Kanidm::test();
        let kanidm_response = serde_json::to_vec(&kanidm).unwrap();

        let api_server = async move {
            let (request, send) = api_server
                .next_request()
                .await
                .expect("current Kanidm is read");
            assert_eq!(request.method(), Method::GET);
            send.send_response(
                Response::builder()
                    .body(Body::from(kanidm_response))
                    .unwrap(),
            );
            api_server
        };
        let (result, mut api_server) = tokio::time::timeout(Duration::from_secs(5), async {
            tokio::join!(
                reconcile_domain_appearance(&kanidm, unreachable_kanidm_client(), &status, ctx),
                api_server
            )
        })
        .await
        .expect("domain appearance reconcile does not wait on further Kubernetes API requests");
        let more_requests = api_server.next_request().now_or_never().is_some();
        (result, more_requests)
    }

    #[tokio::test]
    async fn domain_image_is_not_deleted_when_none_was_set() {
        let (result, more_requests) = reconcile_without_image_spec(KanidmStatus::default()).await;

        result.expect("no Kanidm API call is made");
        assert!(!more_requests);
    }

    #[tokio::test]
    async fn domain_image_status_is_kept_when_delete_fails() {
        let status = KanidmStatus {
            domain_appearance_image: Some(DomainAppearanceImageStatus {
                url: "https://example.com/logo.svg".to_string(),
                ..Default::default()
            }),
            ..Default::default()
        };

        let (result, more_requests) = reconcile_without_image_spec(status).await;

        assert!(result.is_err(), "a previously set image is deleted");
        assert!(
            !more_requests,
            "image status must be kept so the delete is retried"
        );
    }
}