Upgrade kube to 0.98 and migrate event Recorder (#116)

* test out new event recorder interface for kube-rs/kube#1655 Signed-off-by: clux <[email protected]> * cache recorder in Context to use the cache correctly Signed-off-by: clux <[email protected]> * event by ref Signed-off-by: clux <[email protected]> * use official now that it's released Signed-off-by: clux <[email protected]> * merge conflicts Signed-off-by: clux <[email protected]> * fix test compile Signed-off-by: clux <[email protected]> * gen Signed-off-by: clux <[email protected]> --------- Signed-off-by: clux <[email protected]>
kube-rs · Dec 23, 2024 · ac0b94a · ac0b94a
1 parent 1f178f3
commit ac0b94a
Show file tree

Hide file tree

Showing 5 changed files with 76 additions and 41 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -29,7 +29,7 @@ telemetry = ["opentelemetry-otlp"]
 actix-web = "4.4.0"
 futures = "0.3.31"
 tokio = { version = "1.41.1", features = ["macros", "rt-multi-thread"] }
-k8s-openapi = { version = "0.23.0", features = ["latest"] }
+k8s-openapi = { version = "0.24.0", features = ["latest"] }
 schemars = { version = "0.8.12", features = ["chrono"] }
 serde = { version = "1.0.216", features = ["derive"] }
 serde_json = "1.0.133"
@@ -53,7 +53,7 @@ tower-test = "0.4.0"
 
 [dependencies.kube]
 features = ["runtime", "client", "derive" ]
-version = "0.97.0"
+version = "0.98.0"
 
 # testing new releases - ignore
 #git = "https://github.com/kube-rs/kube.git"

diff --git a/src/controller.rs b/src/controller.rs
@@ -24,6 +24,8 @@ pub static DOCUMENT_FINALIZER: &str = "documents.kube.rs";
 /// Generate the Kubernetes wrapper struct `Document` from our Spec and Status struct
 ///
 /// This provides a hook for generating the CRD yaml (in crdgen.rs)
+/// NB: CustomResource generates a pub struct Document here
+/// To query for documents.kube.rs with kube, use Api<Document>.
 #[derive(CustomResource, Deserialize, Serialize, Clone, Debug, JsonSchema)]
 #[cfg_attr(test, derive(Default))]
 #[kube(kind = "Document", group = "kube.rs", version = "v1", namespaced)]
@@ -50,6 +52,8 @@ impl Document {
 pub struct Context {
     /// Kubernetes client
     pub client: Client,
+    /// Event recorder
+    pub recorder: Recorder,
     /// Diagnostics read by the web server
     pub diagnostics: Arc<RwLock<Diagnostics>>,
     /// Prometheus metrics
@@ -88,22 +92,25 @@ impl Document {
     // Reconcile (for non-finalizer related changes)
     async fn reconcile(&self, ctx: Arc<Context>) -> Result<Action> {
         let client = ctx.client.clone();
-        let recorder = ctx.diagnostics.read().await.recorder(client.clone(), self);
+        let oref = self.object_ref(&());
         let ns = self.namespace().unwrap();
         let name = self.name_any();
         let docs: Api<Document> = Api::namespaced(client, &ns);
 
         let should_hide = self.spec.hide;
         if !self.was_hidden() && should_hide {
             // send an event once per hide
-            recorder
-                .publish(Event {
-                    type_: EventType::Normal,
-                    reason: "HideRequested".into(),
-                    note: Some(format!("Hiding `{name}`")),
-                    action: "Hiding".into(),
-                    secondary: None,
-                })
+            ctx.recorder
+                .publish(
+                    &Event {
+                        type_: EventType::Normal,
+                        reason: "HideRequested".into(),
+                        note: Some(format!("Hiding `{name}`")),
+                        action: "Hiding".into(),
+                        secondary: None,
+                    },
+                    &oref,
+                )
                 .await
                 .map_err(Error::KubeError)?;
         }
@@ -130,16 +137,19 @@ impl Document {
 
     // Finalizer cleanup (the object was deleted, ensure nothing is orphaned)
     async fn cleanup(&self, ctx: Arc<Context>) -> Result<Action> {
-        let recorder = ctx.diagnostics.read().await.recorder(ctx.client.clone(), self);
+        let oref = self.object_ref(&());
         // Document doesn't have any real cleanup, so we just publish an event
-        recorder
-            .publish(Event {
-                type_: EventType::Normal,
-                reason: "DeleteRequested".into(),
-                note: Some(format!("Delete `{}`", self.name_any())),
-                action: "Deleting".into(),
-                secondary: None,
-            })
+        ctx.recorder
+            .publish(
+                &Event {
+                    type_: EventType::Normal,
+                    reason: "DeleteRequested".into(),
+                    note: Some(format!("Delete `{}`", self.name_any())),
+                    action: "Deleting".into(),
+                    secondary: None,
+                },
+                &oref,
+            )
             .await
             .map_err(Error::KubeError)?;
         Ok(Action::await_change())
@@ -163,8 +173,8 @@ impl Default for Diagnostics {
     }
 }
 impl Diagnostics {
-    fn recorder(&self, client: Client, doc: &Document) -> Recorder {
-        Recorder::new(client, self.reporter.clone(), doc.object_ref(&()))
+    fn recorder(&self, client: Client) -> Recorder {
+        Recorder::new(client, self.reporter.clone())
     }
 }
 
@@ -193,9 +203,10 @@ impl State {
     }
 
     // Create a Controller Context that can update State
-    pub fn to_context(&self, client: Client) -> Arc<Context> {
+    pub async fn to_context(&self, client: Client) -> Arc<Context> {
         Arc::new(Context {
-            client,
+            client: client.clone(),
+            recorder: self.diagnostics.read().await.recorder(client),
             metrics: self.metrics.clone(),
             diagnostics: self.diagnostics.clone(),
         })
@@ -213,7 +224,7 @@ pub async fn run(state: State) {
     }
     Controller::new(docs, Config::default().any_semantic())
         .shutdown_on_signal()
-        .run(reconcile, error_policy, state.to_context(client))
+        .run(reconcile, error_policy, state.to_context(client).await)
         .filter_map(|x| async move { std::result::Result::ok(x) })
         .for_each(|_| futures::future::ready(()))
         .await;
@@ -293,7 +304,7 @@ mod test {
     #[ignore = "uses k8s current-context"]
     async fn integration_reconcile_should_set_status_and_send_event() {
         let client = kube::Client::try_default().await.unwrap();
-        let ctx = super::State::default().to_context(client.clone());
+        let ctx = super::State::default().to_context(client.clone()).await;
 
         // create a test doc
         let doc = Document::test().finalized().needs_hide();

diff --git a/src/fixtures.rs b/src/fixtures.rs
@@ -2,7 +2,7 @@
 use crate::{Context, Document, DocumentSpec, DocumentStatus, Result, DOCUMENT_FINALIZER};
 use assert_json_diff::assert_json_include;
 use http::{Request, Response};
-use kube::{client::Body, Client, Resource, ResourceExt};
+use kube::{client::Body, runtime::events::Recorder, Client, Resource, ResourceExt};
 use std::sync::Arc;
 
 impl Document {
@@ -210,10 +210,12 @@ impl Context {
     pub fn test() -> (Arc<Self>, ApiServerVerifier) {
         let (mock_service, handle) = tower_test::mock::pair::<Request<Body>, Response<Body>>();
         let mock_client = Client::new(mock_service, "default");
+        let mock_recorder = Recorder::new(mock_client.clone(), "doc-ctrl-test".into());
         let ctx = Self {
             client: mock_client,
             metrics: Arc::default(),
             diagnostics: Arc::default(),
+            recorder: mock_recorder,
         };
         (Arc::new(ctx), ApiServerVerifier(handle))
     }

diff --git a/yaml/crd.yaml b/yaml/crd.yaml
@@ -23,7 +23,7 @@ spec:
             description: |-
               Generate the Kubernetes wrapper struct `Document` from our Spec and Status struct
 
-              This provides a hook for generating the CRD yaml (in crdgen.rs)
+              This provides a hook for generating the CRD yaml (in crdgen.rs) NB: CustomResource generates a pub struct Document here To query for documents.kube.rs with kube, use Api<Document>.
             properties:
               content:
                 type: string