boatramp 0.2.6

boatramp — self-hosted, streaming-first static site publishing (server + CLI in one binary)
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

//! The operator's CustomResourceDefinitions, **single-sourced as Rust types** —
//! `boatramp operator crds` emits their YAML from exactly these definitions, so the
//! shipped CRDs can never drift from what the controller reconciles.
//!
//! Three kinds under `boatramp.dev/v1alpha1`:
//! - [`BoatRampCluster`] — a Raft cluster (StatefulSet) or a stateless frontend
//!   (Deployment); the operator owns its workloads and (in cluster mode) its Raft
//!   **membership** (the reason the operator is mandatory — see `PLAN-kubernetes`).
//! - [`Site`] — a declarative tenant site, reconciled via the control-plane API.
//! - [`Function`] — a declarative function (the k8s surface of `PLAN-faas`).
//!
//! Spec fields are intentionally minimal at K1 (skeleton); the reconcilers that
//! consume them land in K2–K5.

use kube::CustomResource;
use schemars::JsonSchema;
use serde::{Deserialize, Serialize};

/// Deploy shape for a [`BoatRampCluster`].
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
#[serde(rename_all = "lowercase")]
pub enum ClusterMode {
    /// A Raft cluster: a `StatefulSet` + per-node `PersistentVolumeClaim`, with the
    /// operator managing consensus **membership** (join → learner → voter on
    /// scale-up; demote + remove before pod delete on scale-down).
    #[default]
    Cluster,
    /// A stateless frontend over a shared/replicated KV: a `Deployment` + `HPA`.
    Stateless,
}

/// A boatramp cluster managed by the operator.
#[derive(CustomResource, Clone, Debug, Serialize, Deserialize, JsonSchema)]
#[kube(
    group = "boatramp.dev",
    version = "v1alpha1",
    kind = "BoatRampCluster",
    plural = "boatrampclusters",
    shortname = "brc",
    namespaced,
    status = "BoatRampClusterStatus",
    printcolumn = r#"{"name":"Mode","type":"string","jsonPath":".spec.mode"}"#,
    printcolumn = r#"{"name":"Desired","type":"integer","jsonPath":".spec.replicas"}"#,
    printcolumn = r#"{"name":"Phase","type":"string","jsonPath":".status.phase"}"#,
    printcolumn = r#"{"name":"Quorum","type":"boolean","jsonPath":".status.quorum"}"#
)]
#[serde(rename_all = "camelCase")]
pub struct BoatRampClusterSpec {
    /// Raft cluster (default) or stateless frontend.
    #[serde(default)]
    pub mode: ClusterMode,
    /// Desired node count.
    #[serde(default = "default_replicas")]
    pub replicas: u32,
    /// Container image; empty ⇒ the operator's own image (one artifact, one version).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub image: Option<String>,
    /// Per-node persistent-volume size (e.g. `10Gi`), cluster mode only.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub storage: Option<String>,
    /// Security posture profile (`multi-tenant` / `single-tenant` / `dev` / custom);
    /// the operator enforces this floor and a tenant CRD can never relax it.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub posture: Option<String>,
    /// Name of a `Secret` (same namespace) holding an admin control-plane token
    /// under key `token`. The operator uses it to drive Raft membership
    /// (`GET /api/cluster/members`, promote, remove) + mint join tickets. Absent ⇒
    /// the operator plans + reports membership but does not execute it.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub admin_token_secret: Option<String>,
    /// The cluster **root public key** (`es256:`/`ed25519:` hex) — the anchor a
    /// joining pod verifies the seed + members against. Required for the executor
    /// to build join tickets; absent ⇒ it promotes/removes but does not admit.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub root_pubkey: Option<String>,
    /// Name of a `Secret` (same namespace) that wires **auth into the pods**: key
    /// `root-private-key` (the cluster root **private** key — the founder signs
    /// join tokens / attestations / member assertions with it) and an optional
    /// `bootstrap-secret` (single-use, to mint the first admin token). Absent ⇒
    /// the pods run without control-plane auth (dev only).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub auth_secret: Option<String>,
}

/// Observed state of a [`BoatRampCluster`] — surfaced in `kubectl get brc`.
#[derive(Clone, Debug, Default, Serialize, Deserialize, JsonSchema)]
#[serde(rename_all = "camelCase")]
pub struct BoatRampClusterStatus {
    /// A short lifecycle phase (`Pending` / `Reconciling` / `Ready` / `Degraded`).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub phase: Option<String>,
    /// Per-node Raft membership, as the operator observes it.
    #[serde(default)]
    pub members: Vec<MemberStatus>,
    /// Whether the Raft cluster currently holds quorum.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub quorum: Option<bool>,
    /// The `.metadata.generation` this status reflects (staleness guard).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub observed_generation: Option<i64>,
}

/// One node's observed Raft membership.
#[derive(Clone, Debug, Serialize, Deserialize, JsonSchema)]
pub struct MemberStatus {
    /// The node (pod) name.
    pub node: String,
    /// Its Raft role: `learner`, `voter`, or `leader`.
    pub role: String,
    /// Whether its `/readyz` reports ready.
    pub ready: bool,
}

/// A declarative tenant site, reconciled via the control-plane API.
#[derive(CustomResource, Clone, Debug, Serialize, Deserialize, JsonSchema)]
#[kube(
    group = "boatramp.dev",
    version = "v1alpha1",
    kind = "Site",
    plural = "sites",
    namespaced,
    status = "SiteStatus",
    printcolumn = r#"{"name":"Cluster","type":"string","jsonPath":".spec.cluster"}"#,
    printcolumn = r#"{"name":"Project","type":"string","jsonPath":".spec.project"}"#,
    printcolumn = r#"{"name":"Ready","type":"string","jsonPath":".status.phase"}"#
)]
pub struct SiteSpec {
    /// The [`BoatRampCluster`] serving this site; empty ⇒ the sole cluster in the
    /// namespace.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub cluster: Option<String>,
    /// The owning **project** (tenant boundary); empty ⇒ the reserved `default`
    /// project (byte-identical to the legacy per-site routing). Reconciled to the
    /// project-scoped control-plane API.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub project: Option<String>,
    /// Hostnames routed to this site.
    #[serde(default)]
    pub domains: Vec<String>,
}

/// Observed state of a [`Site`].
#[derive(Clone, Debug, Default, Serialize, Deserialize, JsonSchema)]
#[serde(rename_all = "camelCase")]
pub struct SiteStatus {
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub phase: Option<String>,
}

/// A declarative function (the Kubernetes surface of `PLAN-faas` FA-1..FA-3).
#[derive(CustomResource, Clone, Debug, Serialize, Deserialize, JsonSchema)]
#[kube(
    group = "boatramp.dev",
    version = "v1alpha1",
    kind = "Function",
    plural = "functions",
    shortname = "fn",
    namespaced,
    status = "FunctionStatus",
    printcolumn = r#"{"name":"Cluster","type":"string","jsonPath":".spec.cluster"}"#,
    printcolumn = r#"{"name":"Project","type":"string","jsonPath":".spec.project"}"#,
    printcolumn = r#"{"name":"Ready","type":"string","jsonPath":".status.phase"}"#
)]
pub struct FunctionSpec {
    /// The [`BoatRampCluster`] hosting this function; empty ⇒ the sole cluster.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub cluster: Option<String>,
    /// The owning **project** (tenant boundary); empty ⇒ the reserved `default`
    /// project. Reconciled to the project-scoped functions API once the operator's
    /// apply path lands.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub project: Option<String>,
    /// The wasm component: a blob content-address or an OCI reference.
    pub component: String,
    /// An optional route this function answers (`/api/...` or a host path).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub route: Option<String>,
}

/// Observed state of a [`Function`].
#[derive(Clone, Debug, Default, Serialize, Deserialize, JsonSchema)]
#[serde(rename_all = "camelCase")]
pub struct FunctionStatus {
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub phase: Option<String>,
}

/// The default node count for a new cluster (a minimal Raft quorum).
fn default_replicas() -> u32 {
    3
}