engenho-controllers 0.1.3

engenho-controllers — the engenho K8s controller suite. Hosts the Controller trait + canonical implementations: ReplicaSetController (R9), DeploymentController (R9.5), ServiceController (R9.6), GC (R9.7). Each is a thin reconcile loop on engenho-store. Same shape as engenho-scheduler — the second-site for the controller pattern.
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

//! # engenho-controllers
//!
//! The K8s controller suite for engenho. Hosts:
//!
//!   * [`Controller`] trait — the second-site extraction of the
//!     reconcile-loop shape (first site: `engenho-scheduler`'s
//!     `Scheduler`). Future controllers all implement this.
//!   * [`replicaset::ReplicaSetController`] — first concrete
//!     impl. Watches ReplicaSets, creates/deletes Pods so the
//!     observed replica count matches `spec.replicas`.
//!   * [`runtime::ControllerRuntime`] — runs N controllers on a
//!     shared tokio scheduler with per-controller intervals.
//!
//! ## Why this is its own crate (not part of engenho-scheduler)
//!
//! The scheduler is one controller. The controllers crate is the
//! HOME for all the others. Per the prime directive, the SHARED
//! trait + runtime live here; engenho-scheduler keeps its
//! `Scheduler` impl and will optionally implement [`Controller`]
//! at R9.5 (cheap mechanical edit).
//!
//! ## Owner references
//!
//! K8s controllers track ownership via `metadata.ownerReferences`.
//! [`owner::set_owner_reference`] is the typed helper. Garbage
//! collection of orphaned children is R9.7.

#![warn(clippy::pedantic)]
#![allow(clippy::module_name_repetitions)]

pub mod controller;
pub mod deployment;
pub mod endpoints;
pub mod error;
pub mod gc;
pub mod owner;
pub mod replicaset;
pub mod runtime;
pub mod selector;
pub mod service_router;
pub mod watch_driver;

pub use controller::{Controller, ReconcileReport};
pub use deployment::DeploymentController;
pub use endpoints::EndpointsController;
pub use error::ControllerError;
pub use gc::GcController;
pub use owner::{controlling_owner, is_owned_by, set_owner_reference, OwnerReference};
pub use replicaset::ReplicaSetController;
pub use runtime::{ControllerRuntime, RuntimeConfig};
pub use selector::{matches_labels, selector_match_labels, service_selector};
pub use service_router::{
    FakeRouter, FakeRouterEvent, PortMap, RouterError, ServiceRoute, ServiceRouter,
    ServiceRoutingController,
};
pub use watch_driver::{KindFilter, WatchDriver, WatchDriverConfig};