kube.rs 16.7 KB
Newer Older
1
2
3
// SPDX-FileCopyrightText: Copyright (c) 2024-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
// SPDX-License-Identifier: Apache-2.0

4
mod crd;
5
6
7
mod daemon;
mod utils;

8
pub use crd::{DynamoWorkerMetadata, DynamoWorkerMetadataSpec};
9
10
pub use utils::hash_pod_name;

11
use crd::{apply_cr, build_cr};
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
use daemon::DiscoveryDaemon;
use utils::PodInfo;

use crate::CancellationToken;
use crate::discovery::{
    Discovery, DiscoveryEvent, DiscoveryInstance, DiscoveryMetadata, DiscoveryQuery, DiscoverySpec,
    DiscoveryStream, MetadataSnapshot,
};
use anyhow::Result;
use async_trait::async_trait;
use kube::Client as KubeClient;
use std::collections::HashSet;
use std::sync::Arc;
use tokio::sync::RwLock;

/// Kubernetes-based discovery client
#[derive(Clone)]
pub struct KubeDiscoveryClient {
    instance_id: u64,
    metadata: Arc<RwLock<DiscoveryMetadata>>,
    metadata_watch: tokio::sync::watch::Receiver<Arc<MetadataSnapshot>>,
33
34
    kube_client: KubeClient,
    pod_info: PodInfo,
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
}

impl KubeDiscoveryClient {
    /// Create a new Kubernetes discovery client
    ///
    /// # Arguments
    /// * `metadata` - Shared metadata store (also used by system server)
    /// * `cancel_token` - Cancellation token for shutdown
    pub async fn new(
        metadata: Arc<RwLock<DiscoveryMetadata>>,
        cancel_token: CancellationToken,
    ) -> Result<Self> {
        let pod_info = PodInfo::from_env()?;
        let instance_id = hash_pod_name(&pod_info.pod_name);

        tracing::info!(
51
            "Initializing KubeDiscoveryClient: pod_name={}, instance_id={:x}, namespace={}, pod_uid={}",
52
53
            pod_info.pod_name,
            instance_id,
54
55
            pod_info.pod_namespace,
            pod_info.pod_uid
56
57
58
59
60
61
62
63
64
65
        );

        let kube_client = KubeClient::try_default()
            .await
            .map_err(|e| anyhow::anyhow!("Failed to create Kubernetes client: {}", e))?;

        // Create watch channel with initial empty snapshot
        let (watch_tx, watch_rx) = tokio::sync::watch::channel(Arc::new(MetadataSnapshot::empty()));

        // Create and spawn daemon
66
        let daemon = DiscoveryDaemon::new(kube_client.clone(), pod_info.clone(), cancel_token)?;
67
68
69
70
71
72
73
74
75
76
77
78
79

        tokio::spawn(async move {
            if let Err(e) = daemon.run(watch_tx).await {
                tracing::error!("Discovery daemon failed: {}", e);
            }
        });

        tracing::info!("Discovery daemon started");

        Ok(Self {
            instance_id,
            metadata,
            metadata_watch: watch_rx,
80
81
            kube_client,
            pod_info,
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
        })
    }
}

#[async_trait]
impl Discovery for KubeDiscoveryClient {
    fn instance_id(&self) -> u64 {
        self.instance_id
    }

    async fn register(&self, spec: DiscoverySpec) -> Result<DiscoveryInstance> {
        let instance_id = self.instance_id();
        let instance = spec.with_instance_id(instance_id);

        tracing::debug!(
            "Registering instance: {:?} with instance_id={:x}",
            instance,
            instance_id
        );

102
103
        // Write to local metadata and persist to CR
        // IMPORTANT: Hold the write lock across the CR write to prevent race conditions
104
        let mut metadata = self.metadata.write().await;
105
106
107
108

        // Clone state for rollback in case CR persistence fails
        let original_state = metadata.clone();

109
110
111
        match &instance {
            DiscoveryInstance::Endpoint(inst) => {
                tracing::info!(
112
                    "Registering endpoint: namespace={}, component={}, endpoint={}, instance_id={:x}",
113
114
115
116
117
118
119
120
121
122
123
124
125
126
                    inst.namespace,
                    inst.component,
                    inst.endpoint,
                    instance_id
                );
                metadata.register_endpoint(instance.clone())?;
            }
            DiscoveryInstance::Model {
                namespace,
                component,
                endpoint,
                ..
            } => {
                tracing::info!(
127
                    "Registering model card: namespace={}, component={}, endpoint={}, instance_id={:x}",
128
129
130
131
132
133
134
135
136
                    namespace,
                    component,
                    endpoint,
                    instance_id
                );
                metadata.register_model_card(instance.clone())?;
            }
        }

137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
        // Build and apply the CR with the updated metadata
        // This persists the metadata to Kubernetes for other pods to discover
        let cr = build_cr(&self.pod_info.pod_name, &self.pod_info.pod_uid, &metadata)?;

        if let Err(e) = apply_cr(&self.kube_client, &self.pod_info.pod_namespace, &cr).await {
            // Rollback local state on CR persistence failure
            tracing::warn!(
                "Failed to persist metadata to CR, rolling back local state: {}",
                e
            );
            *metadata = original_state;
            return Err(e);
        }

        tracing::debug!("Persisted metadata to DynamoWorkerMetadata CR");

153
154
155
        Ok(instance)
    }

156
    async fn unregister(&self, instance: DiscoveryInstance) -> Result<()> {
157
158
159
160
        let instance_id = self.instance_id();

        // Write to local metadata and persist to CR
        // IMPORTANT: Hold the write lock across the CR write to prevent race conditions
161
        let mut metadata = self.metadata.write().await;
162
163
164
165

        // Clone state for rollback in case CR persistence fails
        let original_state = metadata.clone();

166
        match &instance {
167
168
169
170
171
172
173
174
            DiscoveryInstance::Endpoint(inst) => {
                tracing::info!(
                    "Unregistering endpoint: namespace={}, component={}, endpoint={}, instance_id={:x}",
                    inst.namespace,
                    inst.component,
                    inst.endpoint,
                    instance_id
                );
175
176
                metadata.unregister_endpoint(&instance)?;
            }
177
178
179
180
181
182
183
184
185
186
187
188
189
            DiscoveryInstance::Model {
                namespace,
                component,
                endpoint,
                ..
            } => {
                tracing::info!(
                    "Unregistering model card: namespace={}, component={}, endpoint={}, instance_id={:x}",
                    namespace,
                    component,
                    endpoint,
                    instance_id
                );
190
191
192
193
                metadata.unregister_model_card(&instance)?;
            }
        }

194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
        // Build and apply the CR with the updated metadata
        // This persists the removal to Kubernetes for other pods to see
        let cr = build_cr(&self.pod_info.pod_name, &self.pod_info.pod_uid, &metadata)?;

        if let Err(e) = apply_cr(&self.kube_client, &self.pod_info.pod_namespace, &cr).await {
            // Rollback local state on CR persistence failure
            tracing::warn!(
                "Failed to persist metadata removal to CR, rolling back local state: {}",
                e
            );
            *metadata = original_state;
            return Err(e);
        }

        tracing::debug!("Persisted metadata removal to DynamoWorkerMetadata CR");

210
211
212
        Ok(())
    }

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
    async fn list(&self, query: DiscoveryQuery) -> Result<Vec<DiscoveryInstance>> {
        tracing::debug!("KubeDiscoveryClient::list called with query={:?}", query);

        // Get current snapshot (may be empty if daemon hasn't fetched yet)
        let snapshot = self.metadata_watch.borrow().clone();

        tracing::debug!(
            "List using snapshot seq={} with {} instances",
            snapshot.sequence,
            snapshot.instances.len()
        );

        // Filter snapshot by query
        let instances = snapshot.filter(&query);

        tracing::info!(
            "KubeDiscoveryClient::list returning {} instances for query={:?}",
            instances.len(),
            query
        );

        Ok(instances)
    }

    async fn list_and_watch(
        &self,
        query: DiscoveryQuery,
        cancel_token: Option<CancellationToken>,
    ) -> Result<DiscoveryStream> {
        use tokio::sync::mpsc;

        tracing::info!(
            "KubeDiscoveryClient::list_and_watch started for query={:?}",
            query
        );

        // Clone the watch receiver
        let mut watch_rx = self.metadata_watch.clone();

        // Create output stream
        let (event_tx, event_rx) = mpsc::unbounded_channel();

        // Generate unique stream identifier for tracing
        let stream_id = uuid::Uuid::new_v4();

        // Spawn task to process snapshots
        tokio::spawn(async move {
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
            // Initialize known_instances from current snapshot state
            // This is critical: watch_rx.changed() only fires on FUTURE changes,
            // so we must capture the current state first to detect removals correctly
            let initial_snapshot = watch_rx.borrow_and_update().clone();

            let mut known_instances: HashSet<u64> = initial_snapshot
                .instances
                .iter()
                .filter_map(|(&instance_id, metadata)| {
                    let filtered = metadata.filter(&query);
                    if !filtered.is_empty() {
                        Some(instance_id)
                    } else {
                        None
                    }
                })
                .collect();
277
278
279

            tracing::debug!(
                stream_id = %stream_id,
280
                initial_instances = known_instances.len(),
281
282
283
284
                "Watch started for query={:?}",
                query
            );

285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
            // Emit initial Added events for all existing instances (the "list" part of list_and_watch)
            for &instance_id in &known_instances {
                if let Some(metadata) = initial_snapshot.instances.get(&instance_id) {
                    let instances = metadata.filter(&query);
                    for instance in instances {
                        tracing::info!(
                            stream_id = %stream_id,
                            instance_id = format!("{:x}", instance.instance_id()),
                            "Emitting initial Added event"
                        );
                        if event_tx.send(Ok(DiscoveryEvent::Added(instance))).is_err() {
                            tracing::debug!(
                                stream_id = %stream_id,
                                "Watch receiver dropped during initial sync"
                            );
                            return;
                        }
                    }
                }
            }

306
            loop {
307
308
309
310
311
312
                tracing::trace!(
                    stream_id = %stream_id,
                    known_count = known_instances.len(),
                    "Watch loop waiting for changes"
                );

313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
                // Wait for next snapshot or cancellation
                let watch_result = if let Some(ref token) = cancel_token {
                    tokio::select! {
                        result = watch_rx.changed() => result,
                        _ = token.cancelled() => {
                            tracing::info!(
                                stream_id = %stream_id,
                                "Watch cancelled via cancel token"
                            );
                            break;
                        }
                    }
                } else {
                    watch_rx.changed().await
                };

                match watch_result {
                    Ok(()) => {
                        // Get latest snapshot
                        let snapshot = watch_rx.borrow_and_update().clone();

334
335
336
337
338
339
340
341
                        tracing::debug!(
                            stream_id = %stream_id,
                            seq = snapshot.sequence,
                            snapshot_instances = snapshot.instances.len(),
                            known_instances = known_instances.len(),
                            "Watch received snapshot update"
                        );

342
343
344
345
346
347
348
349
350
351
352
353
354
355
                        // Filter snapshot by query
                        let current_instances: HashSet<u64> = snapshot
                            .instances
                            .iter()
                            .filter_map(|(&instance_id, metadata)| {
                                let filtered = metadata.filter(&query);
                                if !filtered.is_empty() {
                                    Some(instance_id)
                                } else {
                                    None
                                }
                            })
                            .collect();

356
357
358
359
360
361
362
                        tracing::trace!(
                            stream_id = %stream_id,
                            current_ids = ?current_instances.iter().map(|id| format!("{:x}", id)).collect::<Vec<_>>(),
                            known_ids = ?known_instances.iter().map(|id| format!("{:x}", id)).collect::<Vec<_>>(),
                            "Comparing instance sets"
                        );

363
364
365
366
367
368
369
370
371
372
373
                        // Compute diff
                        let added: Vec<u64> = current_instances
                            .difference(&known_instances)
                            .copied()
                            .collect();

                        let removed: Vec<u64> = known_instances
                            .difference(&current_instances)
                            .copied()
                            .collect();

374
375
376
377
378
379
380
381
382
383
                        // Log diff results (even if empty, for debugging)
                        if added.is_empty() && removed.is_empty() {
                            tracing::debug!(
                                stream_id = %stream_id,
                                seq = snapshot.sequence,
                                current_count = current_instances.len(),
                                known_count = known_instances.len(),
                                "Watch snapshot received but no diff detected"
                            );
                        } else {
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
                            tracing::debug!(
                                stream_id = %stream_id,
                                seq = snapshot.sequence,
                                added = added.len(),
                                removed = removed.len(),
                                total = current_instances.len(),
                                "Watch detected changes"
                            );
                        }

                        // Emit Added events
                        for instance_id in added {
                            if let Some(metadata) = snapshot.instances.get(&instance_id) {
                                let instances = metadata.filter(&query);
                                for instance in instances {
                                    tracing::info!(
                                        stream_id = %stream_id,
                                        instance_id = format!("{:x}", instance.instance_id()),
                                        "Emitting Added event"
                                    );
                                    if event_tx.send(Ok(DiscoveryEvent::Added(instance))).is_err() {
                                        tracing::debug!(
                                            stream_id = %stream_id,
                                            "Watch receiver dropped"
                                        );
                                        return;
                                    }
                                }
                            }
                        }

                        // Emit Removed events
                        for instance_id in removed {
                            tracing::info!(
                                stream_id = %stream_id,
                                instance_id = format!("{:x}", instance_id),
                                "Emitting Removed event"
                            );
                            if event_tx
                                .send(Ok(DiscoveryEvent::Removed(instance_id)))
                                .is_err()
                            {
                                tracing::debug!(stream_id = %stream_id, "Watch receiver dropped");
                                return;
                            }
                        }

                        // Update known set
                        known_instances = current_instances;
                    }
                    Err(_) => {
                        tracing::info!(
                            stream_id = %stream_id,
                            "Watch channel closed (daemon stopped)"
                        );
                        break;
                    }
                }
            }
        });

        // Convert receiver to stream
        let stream = tokio_stream::wrappers::UnboundedReceiverStream::new(event_rx);
        Ok(Box::pin(stream))
    }
}