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
use ;
use ;
use json;
use info;
use crateResult;
use crate;
use crate;
// ---------------------------------------------------------------------------
// Private core helper
// ---------------------------------------------------------------------------
/// Shared GC loop. Operates on a pre-built listing `Api<T>` and a
/// per-resource `Api<T>` factory so it works for both cluster and namespaced
/// resources without duplicating the loop body.
///
/// `is_desired` returns `true` for any resource that should be kept.
async
// ---------------------------------------------------------------------------
// Internal helpers
// ---------------------------------------------------------------------------
/// Force-clear all finalizers on a resource to unblock stuck terminations.
/// Errors are intentionally swallowed — the resource may already be gone.
async
// ---------------------------------------------------------------------------
// Generic public API
// ---------------------------------------------------------------------------
/// Garbage collect orphaned Kubernetes resources.
///
/// Lists all resources of type `T` matching `label_selector` and deletes any
/// for which `is_desired` returns `false`. Resources already in termination
/// are unblocked by clearing their finalizers.
///
/// This generic form accepts any scope and a predicate so it can express both
/// the cluster case (`name not in set`) and the namespaced case
/// (`(namespace, name) not in set`) uniformly. Prefer
/// [`gc_cluster_resources`] or [`gc_namespaced_resources`] when the scope and
/// desired-set type are known at compile time.
///
/// # Examples
///
/// ```no_run
/// use std::collections::HashSet;
/// use koprs::error::KubeGenericError;
/// use kube::Client;
/// use kube::ResourceExt;
/// use koprs::gc::gc_resources;
/// use koprs::scope::Namespaced;
/// use koprs::traits::NamespacedResource;
///
/// # async fn example<MyCR: NamespacedResource>(client: Client) -> Result<(), KubeGenericError> {
/// let desired: HashSet<(String, String)> = HashSet::from([
/// ("default".to_string(), "my-resource".to_string()),
/// ]);
/// gc_resources::<MyCR, _>(
/// client,
/// Namespaced("default"),
/// "app=my-operator",
/// |r| {
/// let ns = r.namespace().unwrap_or_default();
/// desired.contains(&(ns, r.name_any()))
/// },
/// ).await?;
/// # Ok(())
/// # }
/// ```
pub async
// ---------------------------------------------------------------------------
// Convenience wrappers — cluster-scoped
// ---------------------------------------------------------------------------
/// Garbage collect orphaned **cluster-scoped** resources.
///
/// Delegates to the shared GC loop with `Api::all` and a name-based predicate.
/// Any resource whose name is not in `desired_names` is deleted. Resources
/// already in termination are unblocked by clearing their finalizers.
///
/// The resource type `T` must implement [`ClusterResource`], which the
/// compiler enforces — passing a namespace-scoped type is a compile error.
///
/// Prefer this over [`gc_resources`] when the scope and desired-set type are
/// known at compile time.
///
/// # Examples
///
/// ```no_run
/// use std::collections::HashSet;
/// use koprs::error::KubeGenericError;
/// use kube::Client;
/// use kube::Resource;
/// use k8s_openapi::api::core::v1::PersistentVolume;
///
/// # async fn example(client: Client) -> Result<(), KubeGenericError> {
/// let desired = HashSet::from(["pv-a".to_string(), "pv-b".to_string()]);
/// koprs::gc::gc_cluster_resources::<PersistentVolume>(
/// client,
/// "app=my-operator",
/// |pv| desired.contains(pv.meta().name.as_deref().unwrap_or("")),
/// ).await?;
/// # Ok(())
/// # }
/// ```
pub async
// ---------------------------------------------------------------------------
// Convenience wrappers — namespaced
// ---------------------------------------------------------------------------
/// Garbage collect orphaned **namespace-scoped** resources across all namespaces.
///
/// Delegates to the shared GC loop with `Api::namespaced` per resource and a
/// `(namespace, name)` predicate. Any resource whose pair is not in
/// `desired_resources` is deleted. Resources already in termination are
/// unblocked by clearing their finalizers.
///
/// The resource type `T` must implement [`NamespacedResource`], which the
/// compiler enforces — passing a cluster-scoped type is a compile error.
///
/// Prefer this over [`gc_resources`] when the scope and desired-set type are
/// known at compile time.
///
/// # Examples
///
/// ```no_run
/// use std::collections::HashSet;
/// use koprs::error::KubeGenericError;
/// use kube::Client;
/// use kube::Resource;
/// use k8s_openapi::api::core::v1::PersistentVolumeClaim;
///
/// # async fn example(client: Client) -> Result<(), KubeGenericError> {
/// let desired = HashSet::from([
/// ("default".to_string(), "pvc-a".to_string()),
/// ]);
/// koprs::gc::gc_namespaced_resources::<PersistentVolumeClaim>(
/// client,
/// "default",
/// "app=my-operator",
/// |pvc| {
/// let meta = pvc.meta();
/// let ns = meta.namespace.as_deref().unwrap_or("");
/// let name = meta.name.as_deref().unwrap_or("");
/// desired.contains(&(ns.to_string(), name.to_string()))
/// },
/// ).await?;
/// # Ok(())
/// # }
/// ```
pub async