kaniop 0.14.1

Kubernetes operator for Kanidm identity management system
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
use kaniop_backup::crd::KanidmBackupRepository;
use kaniop_k8s_util::client::new_client_with_metrics;
use kaniop_operator::controller::{
    SUBSCRIBE_BUFFER_SIZE, State as KaniopState, check_api_queryable, create_subscriber,
    set_cluster_domain, set_idm_reconcile_interval,
};
use kaniop_operator::kanidm::crd::Kanidm;
use kaniop_operator::leader_election::{LeaseLock, LeaseLockParams, acquire_lease_with_retry};
use kaniop_operator::telemetry;

use axum::extract::State;
use axum::http::StatusCode;
use axum::response::{IntoResponse, Json};
use axum::routing::{Router, get};
use clap::{Parser, crate_authors, crate_description, crate_version};
use k8s_openapi::api::core::v1::Namespace;
use kube::Config;
use tokio::net::TcpListener;
use tokio::signal::unix::{SignalKind, signal};
use tokio::time::Duration;
use tokio_util::sync::CancellationToken;
use tracing::debug;

use rustls::crypto::aws_lc_rs::default_provider;

async fn metrics(State(state): State<KaniopState>) -> impl IntoResponse {
    match state.metrics() {
        Ok(metrics) => (
            StatusCode::OK,
            [(
                "content-type",
                "application/openmetrics-text; version=1.0.0; charset=utf-8",
            )],
            metrics,
        )
            .into_response(),
        Err(e) => {
            tracing::error!("Failed to get metrics: {:?}", e);
            StatusCode::INTERNAL_SERVER_ERROR.into_response()
        }
    }
}

async fn healthz() -> impl IntoResponse {
    Json("healthy")
}

#[derive(Parser, Debug)]
#[command(
    name="kaniop",
    about = crate_description!(),
    version = crate_version!(),
    author = crate_authors!("\n"),
)]
struct Args {
    /// Listen address (use "::" for IPv6, "0.0.0.0" for IPv4)
    #[arg(long, default_value = "0.0.0.0", env)]
    listen_address: String,

    /// Listen on given port
    #[arg(short, long, default_value_t = 8080, env)]
    port: u16,

    /// Set logging filter directive for `tracing_subscriber::filter::EnvFilter`. Example: "info,kube=debug,kaniop=debug"
    #[arg(long, default_value = "info", env)]
    log_filter: String,

    /// Set log format
    #[arg(long, value_enum, default_value_t = telemetry::LogFormat::Text, env)]
    log_format: telemetry::LogFormat,

    /// URL for the OpenTelemetry tracing endpoint.
    ///
    /// This optional argument specifies the URL to which traces will be sent using
    /// OpenTelemetry. If not provided, tracing will be disabled.
    #[arg(short, long, env = "OPENTELEMETRY_ENDPOINT_URL")]
    tracing_url: Option<String>,

    /// Sampling ratio for tracing.
    ///
    /// Specifies the ratio of traces to sample. A value of `1.0` will sample all traces,
    /// while a lower value will sample fewer traces. The default is `0.1`, meaning 10%
    /// of traces are sampled.
    #[arg(short, long, default_value_t = 0.1, env)]
    sample_ratio: f64,

    /// Reconciliation interval in seconds for IDM resources (groups, OAuth2 clients,
    /// person accounts, service accounts). This does not affect the Kanidm cluster
    /// reconciliation interval which remains at 24 hours.
    #[arg(long, default_value_t = 60, env)]
    idm_reconcile_interval_seconds: u64,

    /// Kubernetes cluster domain used for DNS resolution. Used to construct FQDNs
    /// for replication hostnames when no custom template is provided.
    #[arg(long, default_value = "cluster.local", env)]
    cluster_domain: String,

    /// Enable leader election for HA deployments.
    #[arg(long, default_value_t = false, env)]
    leader_election: bool,

    /// Lease name for leader election.
    #[arg(long, default_value = "kaniop-leader", env)]
    leader_election_lease_name: String,

    /// Lease namespace for leader election. Defaults to POD_NAMESPACE env var.
    #[arg(long, env)]
    leader_election_lease_namespace: Option<String>,

    /// Lease TTL in seconds for leader election.
    #[arg(long, default_value_t = 15, env)]
    leader_election_lease_ttl_seconds: u64,
}

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    default_provider().install_default().unwrap();

    let args: Args = Args::parse();

    set_idm_reconcile_interval(tokio::time::Duration::from_secs(
        args.idm_reconcile_interval_seconds,
    ));
    set_cluster_domain(args.cluster_domain);

    telemetry::init(
        &args.log_filter,
        args.log_format,
        args.tracing_url.as_deref(),
        args.sample_ratio,
    )
    .await?;
    debug!("Telemetry initialized");

    let exporter = kaniop_operator::prometheus_exporter::PrometheusExporter::new();
    debug!("Prometheus exporter created");
    let reader = opentelemetry_sdk::metrics::PeriodicReader::builder(exporter.clone())
        .with_interval(Duration::from_secs(5))
        .build();
    let provider = opentelemetry_sdk::metrics::SdkMeterProvider::builder()
        .with_reader(reader)
        .build();
    debug!("Metrics provider initialized");

    kaniop_operator::prometheus_exporter::set_global_exporter(exporter);
    debug!("Global Prometheus exporter set");

    opentelemetry::global::set_meter_provider(provider.clone());
    let meter = opentelemetry::global::meter("kaniop");
    debug!("Global meter 'kaniop' created");

    let config = Config::infer().await?;
    let client = new_client_with_metrics(config, &meter).await?;
    let controllers = [
        kaniop_operator::kanidm::controller::CONTROLLER_ID,
        kaniop_operator::kanidm::restore::CONTROLLER_ID,
        kaniop_backup::controller::REPOSITORY_CONTROLLER_ID,
        kaniop_backup::controller::SCHEDULE_CONTROLLER_ID,
        kaniop_backup::controller::BACKUP_CONTROLLER_ID,
        kaniop_backup::controller::DISCOVERY_CONTROLLER_ID,
        kaniop_group::controller::CONTROLLER_ID,
        kaniop_oauth2::controller::CONTROLLER_ID,
        kaniop_person::controller::CONTROLLER_ID,
        kaniop_service_account::controller::CONTROLLER_ID,
    ];

    let namespace = check_api_queryable::<Namespace>(client.clone()).await;
    let namespace_r = create_subscriber::<Namespace>(SUBSCRIBE_BUFFER_SIZE);
    let kanidm = check_api_queryable::<Kanidm>(client.clone()).await;
    let kanidm_r = create_subscriber::<Kanidm>(SUBSCRIBE_BUFFER_SIZE);
    let repository = check_api_queryable::<KanidmBackupRepository>(client.clone()).await;
    let repository_r = create_subscriber::<KanidmBackupRepository>(SUBSCRIBE_BUFFER_SIZE);

    let controller_metrics = kaniop_operator::metrics::Metrics::new(&meter, &controllers);

    let state = KaniopState::new(
        controller_metrics,
        namespace_r.store.clone(),
        kanidm_r.store.clone(),
        Some(client.clone()),
    );

    let cancellation_token = CancellationToken::new();
    let shutdown_token = cancellation_token.clone();

    if args.leader_election {
        let lease_namespace = args
            .leader_election_lease_namespace
            .or_else(|| std::env::var("POD_NAMESPACE").ok())
            .ok_or_else(|| {
                anyhow::anyhow!("POD_NAMESPACE must be set when leader election is enabled")
            })?;

        let holder_id = std::env::var("POD_NAME").unwrap_or_else(|_| {
            hostname::get()
                .map(|h| h.to_string_lossy().to_string())
                .unwrap_or_else(|_| "unknown".to_string())
        });

        let lease_lock = LeaseLock::new(
            client.clone(),
            &lease_namespace,
            LeaseLockParams {
                holder_id: holder_id.clone(),
                lease_name: args.leader_election_lease_name.clone(),
                lease_ttl: Duration::from_secs(args.leader_election_lease_ttl_seconds),
            },
        );

        tracing::info!(
            lease_name = %args.leader_election_lease_name,
            lease_namespace = %lease_namespace,
            holder_id = %holder_id,
            "waiting to acquire leader lease"
        );

        acquire_lease_with_retry(&lease_lock, Duration::from_secs(2), None).await?;

        tracing::info!("acquired leader lease; starting controllers");

        let lease_lock_clone = lease_lock.clone();
        let renew_token = cancellation_token.clone();
        let lease_ttl = Duration::from_secs(args.leader_election_lease_ttl_seconds);
        let renew_interval = lease_ttl / 3;

        let renew_handle = tokio::spawn(async move {
            loop {
                if renew_token.is_cancelled() {
                    break;
                }
                tokio::time::sleep(renew_interval).await;
                if renew_token.is_cancelled() {
                    break;
                }
                match lease_lock_clone.try_acquire_or_renew().await {
                    Ok(result) if result.acquired_lease => {
                        debug!("successfully renewed leader lease");
                    }
                    Ok(_) => {
                        tracing::warn!("lost leader lease; triggering shutdown");
                        renew_token.cancel();
                        break;
                    }
                    Err(e) => {
                        tracing::warn!("lease renewal failed: {e:#}");
                    }
                }
            }
        });

        let kanidm_c = kaniop_operator::kanidm::controller::run(
            state.clone(),
            client.clone(),
            namespace,
            namespace_r,
            kanidm,
            kanidm_r,
        );

        let restore_c = kaniop_operator::kanidm::restore::run(client.clone());
        let backup_repo_c = kaniop_backup::controller::repository::run(
            state.clone(),
            client.clone(),
            repository.clone(),
            repository_r,
        );
        let backup_schedule_c =
            kaniop_backup::controller::schedule::run(state.clone(), client.clone());
        let backup_c = kaniop_backup::controller::backup::run(state.clone(), client.clone());
        let discovery_loop =
            kaniop_backup::controller::discovery::run(state.clone(), client.clone(), None);
        let group_c = kaniop_group::controller::run(state.clone(), client.clone());
        let oauth2_c = kaniop_oauth2::controller::run(state.clone(), client.clone());
        let person_c = kaniop_person::controller::run(state.clone(), client.clone());
        let service_account_c = kaniop_service_account::controller::run(state.clone(), client);

        let app = Router::new()
            .route("/metrics", get(metrics))
            .route("/healthz", get(healthz))
            .with_state(state.clone());

        let addr = if args.listen_address.contains(':') {
            format!("[{}]:{}", args.listen_address, args.port)
        } else {
            format!("{}:{}", args.listen_address, args.port)
        };
        tracing::info!("Starting HTTP server on {}", addr);
        let listener = TcpListener::bind(&addr).await?;
        let server = axum::serve(listener, app)
            .with_graceful_shutdown(shutdown_signal_with_token(shutdown_token));

        let controllers_handle = tokio::spawn(async move {
            tokio::join!(
                kanidm_c,
                restore_c,
                backup_repo_c,
                backup_schedule_c,
                backup_c,
                discovery_loop,
                group_c,
                oauth2_c,
                person_c,
                service_account_c
            );
        });

        tokio::select! {
            result = server => {
                tracing::info!("HTTP server stopped");
                cancellation_token.cancel();
                result?;
            }
            _ = cancellation_token.cancelled() => {
                tracing::info!("Shutdown signal received (lost lease or external signal)");
            }
        }

        controllers_handle.abort();
        lease_lock.step_down().await.ok();
        renew_handle.abort();
    } else {
        let kanidm_c = kaniop_operator::kanidm::controller::run(
            state.clone(),
            client.clone(),
            namespace,
            namespace_r,
            kanidm,
            kanidm_r,
        );

        let restore_c = kaniop_operator::kanidm::restore::run(client.clone());
        let backup_repo_c = kaniop_backup::controller::repository::run(
            state.clone(),
            client.clone(),
            repository,
            repository_r,
        );
        let backup_schedule_c =
            kaniop_backup::controller::schedule::run(state.clone(), client.clone());
        let backup_c = kaniop_backup::controller::backup::run(state.clone(), client.clone());
        let discovery_loop =
            kaniop_backup::controller::discovery::run(state.clone(), client.clone(), None);
        let group_c = kaniop_group::controller::run(state.clone(), client.clone());
        let oauth2_c = kaniop_oauth2::controller::run(state.clone(), client.clone());
        let person_c = kaniop_person::controller::run(state.clone(), client.clone());
        let service_account_c = kaniop_service_account::controller::run(state.clone(), client);

        let app = Router::new()
            .route("/metrics", get(metrics))
            .route("/healthz", get(healthz))
            .with_state(state.clone());

        let addr = if args.listen_address.contains(':') {
            format!("[{}]:{}", args.listen_address, args.port)
        } else {
            format!("{}:{}", args.listen_address, args.port)
        };
        tracing::info!("Starting HTTP server on {}", addr);
        let listener = TcpListener::bind(&addr).await?;
        let server = axum::serve(listener, app).with_graceful_shutdown(shutdown_signal());

        tokio::join!(
            kanidm_c,
            restore_c,
            backup_repo_c,
            backup_schedule_c,
            backup_c,
            discovery_loop,
            group_c,
            oauth2_c,
            person_c,
            service_account_c,
            server
        )
        .10?;
    }
    Ok(())
}

async fn shutdown_signal() {
    let mut sigterm =
        signal(SignalKind::terminate()).expect("failed to install SIGTERM signal handler");

    tokio::select! {
        _ = tokio::signal::ctrl_c() => {},
        _ = sigterm.recv() => {},
    }
}

async fn shutdown_signal_with_token(token: CancellationToken) {
    let mut sigterm =
        signal(SignalKind::terminate()).expect("failed to install SIGTERM signal handler");

    tokio::select! {
        _ = tokio::signal::ctrl_c() => {
            token.cancel();
        },
        _ = sigterm.recv() => {
            token.cancel();
        },
        _ = token.cancelled() => {},
    }
}