operator-framework 0.6.2

Tools and helpers used to create Kubernetes operators
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

/*
 * Copyright (c) 2020 Jens Reimann and others.
 *
 * See the NOTICE file(s) distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0
 *
 * SPDX-License-Identifier: EPL-2.0
 */
use anyhow::Result;

use kube::{
    api::{ObjectMeta, PostParams},
    Api, Error, Resource,
};
use serde::{de::DeserializeOwned, Serialize};
use std::fmt::Debug;

pub enum Outcome<T> {
    Created(T),
    Updated(T),
    Unchanged(T),
}

impl<T> Outcome<T> {
    pub fn resource(self) -> T {
        match self {
            Self::Created(r) => r,
            Self::Updated(r) => r,
            Self::Unchanged(r) => r,
        }
    }
}

/// Create or update a Kubernetes resource.
pub async fn create_or_update_by<T, S1, S2, C, F, E, Eq>(
    api: &Api<T>,
    namespace: Option<S1>,
    name: S2,
    creator: C,
    eq: Eq,
    mutator: F,
) -> Result<Outcome<T>, E>
where
    T: Resource + Clone + Debug + DeserializeOwned + Serialize,
    S1: ToString,
    S2: AsRef<str>,
    C: FnOnce(ObjectMeta) -> T,
    F: FnOnce(T) -> Result<T, E>,
    Eq: FnOnce(&T, &T) -> bool,
    E: From<Error>,
{
    match api.get(name.as_ref()).await {
        Err(Error::Api(ae)) if ae.code == 404 => {
            log::debug!("CreateOrUpdate - Err(Api(404))");
            let object: T = creator(ObjectMeta {
                namespace: namespace.map(|s| s.to_string()),
                name: Some(name.as_ref().to_string()),
                ..Default::default()
            });
            let object = mutator(object)?;
            api.create(&PostParams::default(), &object).await?;
            Ok(Outcome::Created(object))
        }
        Err(e) => {
            log::info!("Error - {}", e);
            Err(e)?
        }
        Ok(object) => {
            log::debug!("CreateOrUpdate - Ok(...)");
            let new_object = mutator(object.clone())?;

            // only update when necessary
            if !eq(&object, &new_object) {
                log::debug!("CreateOrUpdate - Changed -> replacing");
                api.replace(name.as_ref(), &PostParams::default(), &new_object)
                    .await?;
                Ok(Outcome::Updated(new_object))
            } else {
                Ok(Outcome::Unchanged(new_object))
            }
        }
    }
}

/// Create or update a Kubernetes resource.
pub async fn create_or_update<T, S1, S2, F, E>(
    api: &Api<T>,
    namespace: Option<S1>,
    name: S2,
    mutator: F,
) -> Result<Outcome<T>, E>
where
    T: Resource + Clone + Debug + DeserializeOwned + Serialize + PartialEq + Default,
    S1: ToString,
    S2: AsRef<str>,
    F: FnOnce(T) -> Result<T, E>,
    E: From<Error>,
{
    create_or_update_by(
        api,
        namespace,
        name,
        |meta| {
            let mut object: T = Default::default();
            *object.meta_mut() = meta;
            object
        },
        |this, that| this == that,
        mutator,
    )
    .await
}