Compare commits
1 Commits
feat/postg
...
c7cbd9eeac
| Author | SHA1 | Date | |
|---|---|---|---|
| c7cbd9eeac |
15
Cargo.lock
generated
15
Cargo.lock
generated
@@ -1835,21 +1835,6 @@ dependencies = [
|
|||||||
"url",
|
"url",
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "example-operatorhub-catalogsource"
|
|
||||||
version = "0.1.0"
|
|
||||||
dependencies = [
|
|
||||||
"cidr",
|
|
||||||
"env_logger",
|
|
||||||
"harmony",
|
|
||||||
"harmony_cli",
|
|
||||||
"harmony_macros",
|
|
||||||
"harmony_types",
|
|
||||||
"log",
|
|
||||||
"tokio",
|
|
||||||
"url",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "example-opnsense"
|
name = "example-opnsense"
|
||||||
version = "0.1.0"
|
version = "0.1.0"
|
||||||
|
|||||||
@@ -1,114 +0,0 @@
|
|||||||
# Architecture Decision Record: Higher-Order Topologies
|
|
||||||
|
|
||||||
**Initial Author:** Jean-Gabriel Gill-Couture
|
|
||||||
**Initial Date:** 2025-12-08
|
|
||||||
**Last Updated Date:** 2025-12-08
|
|
||||||
|
|
||||||
## Status
|
|
||||||
|
|
||||||
Implemented
|
|
||||||
|
|
||||||
## Context
|
|
||||||
|
|
||||||
Harmony models infrastructure as **Topologies** (deployment targets like `K8sAnywhereTopology`, `LinuxHostTopology`) implementing **Capabilities** (tech traits like `PostgreSQL`, `Docker`).
|
|
||||||
|
|
||||||
**Higher-Order Topologies** (e.g., `FailoverTopology<T>`) compose/orchestrate capabilities *across* multiple underlying topologies (e.g., primary+replica `T`).
|
|
||||||
|
|
||||||
Naive design requires manual `impl Capability for HigherOrderTopology<T>` *per T per capability*, causing:
|
|
||||||
- **Impl explosion**: N topologies × M capabilities = N×M boilerplate.
|
|
||||||
- **ISP violation**: Topologies forced to impl unrelated capabilities.
|
|
||||||
- **Maintenance hell**: New topology needs impls for *all* orchestrated capabilities; new capability needs impls for *all* topologies/higher-order.
|
|
||||||
- **Barrier to extension**: Users can't easily add topologies without todos/panics.
|
|
||||||
|
|
||||||
This makes scaling Harmony impractical as ecosystem grows.
|
|
||||||
|
|
||||||
## Decision
|
|
||||||
|
|
||||||
Use **blanket trait impls** on higher-order topologies to *automatically* derive orchestration:
|
|
||||||
|
|
||||||
````rust
|
|
||||||
/// Higher-Order Topology: Orchestrates capabilities across sub-topologies.
|
|
||||||
pub struct FailoverTopology<T> {
|
|
||||||
/// Primary sub-topology.
|
|
||||||
primary: T,
|
|
||||||
/// Replica sub-topology.
|
|
||||||
replica: T,
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Automatically provides PostgreSQL failover for *any* `T: PostgreSQL`.
|
|
||||||
/// Delegates to primary for queries; orchestrates deploy across both.
|
|
||||||
#[async_trait]
|
|
||||||
impl<T: PostgreSQL> PostgreSQL for FailoverTopology<T> {
|
|
||||||
async fn deploy(&self, config: &PostgreSQLConfig) -> Result<String, String> {
|
|
||||||
// Deploy primary; extract certs/endpoint;
|
|
||||||
// deploy replica with pg_basebackup + TLS passthrough.
|
|
||||||
// (Full impl logged/elaborated.)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Delegate queries to primary.
|
|
||||||
async fn get_replication_certs(&self, cluster_name: &str) -> Result<ReplicationCerts, String> {
|
|
||||||
self.primary.get_replication_certs(cluster_name).await
|
|
||||||
}
|
|
||||||
// ...
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Similarly for other capabilities.
|
|
||||||
#[async_trait]
|
|
||||||
impl<T: Docker> Docker for FailoverTopology<T> {
|
|
||||||
// Failover Docker orchestration.
|
|
||||||
}
|
|
||||||
````
|
|
||||||
|
|
||||||
**Key properties:**
|
|
||||||
- **Auto-derivation**: `Failover<K8sAnywhere>` gets `PostgreSQL` iff `K8sAnywhere: PostgreSQL`.
|
|
||||||
- **No boilerplate**: One blanket impl per capability *per higher-order type*.
|
|
||||||
|
|
||||||
## Rationale
|
|
||||||
|
|
||||||
- **Composition via generics**: Rust trait solver auto-selects impls; zero runtime cost.
|
|
||||||
- **Compile-time safety**: Missing `T: Capability` → compile error (no panics).
|
|
||||||
- **Scalable**: O(capabilities) impls per higher-order; new `T` auto-works.
|
|
||||||
- **ISP-respecting**: Capabilities only surface if sub-topology provides.
|
|
||||||
- **Centralized logic**: Orchestration (e.g., cert propagation) in one place.
|
|
||||||
|
|
||||||
**Example usage:**
|
|
||||||
````rust
|
|
||||||
// ✅ Works: K8sAnywhere: PostgreSQL → Failover provides failover PG
|
|
||||||
let pg_failover: FailoverTopology<K8sAnywhereTopology> = ...;
|
|
||||||
pg_failover.deploy_pg(config).await;
|
|
||||||
|
|
||||||
// ✅ Works: LinuxHost: Docker → Failover provides failover Docker
|
|
||||||
let docker_failover: FailoverTopology<LinuxHostTopology> = ...;
|
|
||||||
docker_failover.deploy_docker(...).await;
|
|
||||||
|
|
||||||
// ❌ Compile fail: K8sAnywhere !: Docker
|
|
||||||
let invalid: FailoverTopology<K8sAnywhereTopology>;
|
|
||||||
invalid.deploy_docker(...); // `T: Docker` bound unsatisfied
|
|
||||||
````
|
|
||||||
|
|
||||||
## Consequences
|
|
||||||
|
|
||||||
**Pros:**
|
|
||||||
- **Extensible**: New topology `AWSTopology: PostgreSQL` → instant `Failover<AWSTopology>: PostgreSQL`.
|
|
||||||
- **Lean**: No useless impls (e.g., no `K8sAnywhere: Docker`).
|
|
||||||
- **Observable**: Logs trace every step.
|
|
||||||
|
|
||||||
**Cons:**
|
|
||||||
- **Monomorphization**: Generics generate code per T (mitigated: few Ts).
|
|
||||||
- **Delegation opacity**: Relies on rustdoc/logs for internals.
|
|
||||||
|
|
||||||
## Alternatives considered
|
|
||||||
|
|
||||||
| Approach | Pros | Cons |
|
|
||||||
|----------|------|------|
|
|
||||||
| **Manual per-T impls**<br>`impl PG for Failover<K8s> {..}`<br>`impl PG for Failover<Linux> {..}` | Explicit control | N×M explosion; violates ISP; hard to extend. |
|
|
||||||
| **Dynamic trait objects**<br>`Box<dyn AnyCapability>` | Runtime flex | Perf hit; type erasure; error-prone dispatch. |
|
|
||||||
| **Mega-topology trait**<br>All-in-one `OrchestratedTopology` | Simple wiring | Monolithic; poor composition. |
|
|
||||||
| **Registry dispatch**<br>Runtime capability lookup | Decoupled | Complex; no compile safety; perf/debug overhead. |
|
|
||||||
|
|
||||||
**Selected**: Blanket impls leverage Rust generics for safe, zero-cost composition.
|
|
||||||
|
|
||||||
## Additional Notes
|
|
||||||
|
|
||||||
- Applies to `MultisiteTopology<T>`, `ShardedTopology<T>`, etc.
|
|
||||||
- `FailoverTopology` in `failover.rs` is first implementation.
|
|
||||||
@@ -1,153 +0,0 @@
|
|||||||
//! Example of Higher-Order Topologies in Harmony.
|
|
||||||
//! Demonstrates how `FailoverTopology<T>` automatically provides failover for *any* capability
|
|
||||||
//! supported by a sub-topology `T` via blanket trait impls.
|
|
||||||
//!
|
|
||||||
//! Key insight: No manual impls per T or capability -- scales effortlessly.
|
|
||||||
//! Users can:
|
|
||||||
//! - Write new `Topology` (impl capabilities on a struct).
|
|
||||||
//! - Compose with `FailoverTopology` (gets capabilities if T has them).
|
|
||||||
//! - Compile fails if capability missing (safety).
|
|
||||||
|
|
||||||
use async_trait::async_trait;
|
|
||||||
use tokio;
|
|
||||||
|
|
||||||
/// Capability trait: Deploy and manage PostgreSQL.
|
|
||||||
#[async_trait]
|
|
||||||
pub trait PostgreSQL {
|
|
||||||
async fn deploy(&self, config: &PostgreSQLConfig) -> Result<String, String>;
|
|
||||||
async fn get_replication_certs(&self, cluster_name: &str) -> Result<ReplicationCerts, String>;
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Capability trait: Deploy Docker.
|
|
||||||
#[async_trait]
|
|
||||||
pub trait Docker {
|
|
||||||
async fn deploy_docker(&self) -> Result<String, String>;
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Configuration for PostgreSQL deployments.
|
|
||||||
#[derive(Clone)]
|
|
||||||
pub struct PostgreSQLConfig;
|
|
||||||
|
|
||||||
/// Replication certificates.
|
|
||||||
#[derive(Clone)]
|
|
||||||
pub struct ReplicationCerts;
|
|
||||||
|
|
||||||
/// Concrete topology: Kubernetes Anywhere (supports PostgreSQL).
|
|
||||||
#[derive(Clone)]
|
|
||||||
pub struct K8sAnywhereTopology;
|
|
||||||
|
|
||||||
#[async_trait]
|
|
||||||
impl PostgreSQL for K8sAnywhereTopology {
|
|
||||||
async fn deploy(&self, _config: &PostgreSQLConfig) -> Result<String, String> {
|
|
||||||
// Real impl: Use k8s helm chart, operator, etc.
|
|
||||||
Ok("K8sAnywhere PostgreSQL deployed".to_string())
|
|
||||||
}
|
|
||||||
|
|
||||||
async fn get_replication_certs(&self, _cluster_name: &str) -> Result<ReplicationCerts, String> {
|
|
||||||
Ok(ReplicationCerts)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Concrete topology: Linux Host (supports Docker).
|
|
||||||
#[derive(Clone)]
|
|
||||||
pub struct LinuxHostTopology;
|
|
||||||
|
|
||||||
#[async_trait]
|
|
||||||
impl Docker for LinuxHostTopology {
|
|
||||||
async fn deploy_docker(&self) -> Result<String, String> {
|
|
||||||
// Real impl: Install/configure Docker on host.
|
|
||||||
Ok("LinuxHost Docker deployed".to_string())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Higher-Order Topology: Composes multiple sub-topologies (primary + replica).
|
|
||||||
/// Automatically derives *all* capabilities of `T` with failover orchestration.
|
|
||||||
///
|
|
||||||
/// - If `T: PostgreSQL`, then `FailoverTopology<T>: PostgreSQL` (blanket impl).
|
|
||||||
/// - Same for `Docker`, etc. No boilerplate!
|
|
||||||
/// - Compile-time safe: Missing `T: Capability` → error.
|
|
||||||
#[derive(Clone)]
|
|
||||||
pub struct FailoverTopology<T> {
|
|
||||||
/// Primary sub-topology.
|
|
||||||
pub primary: T,
|
|
||||||
/// Replica sub-topology.
|
|
||||||
pub replica: T,
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Blanket impl: Failover PostgreSQL if T provides PostgreSQL.
|
|
||||||
/// Delegates reads to primary; deploys to both.
|
|
||||||
#[async_trait]
|
|
||||||
impl<T: PostgreSQL + Send + Sync + Clone> PostgreSQL for FailoverTopology<T> {
|
|
||||||
async fn deploy(&self, config: &PostgreSQLConfig) -> Result<String, String> {
|
|
||||||
// Orchestrate: Deploy primary first, then replica (e.g., via pg_basebackup).
|
|
||||||
let primary_result = self.primary.deploy(config).await?;
|
|
||||||
let replica_result = self.replica.deploy(config).await?;
|
|
||||||
Ok(format!("Failover PG deployed: {} | {}", primary_result, replica_result))
|
|
||||||
}
|
|
||||||
|
|
||||||
async fn get_replication_certs(&self, cluster_name: &str) -> Result<ReplicationCerts, String> {
|
|
||||||
// Delegate to primary (replica follows).
|
|
||||||
self.primary.get_replication_certs(cluster_name).await
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Blanket impl: Failover Docker if T provides Docker.
|
|
||||||
#[async_trait]
|
|
||||||
impl<T: Docker + Send + Sync + Clone> Docker for FailoverTopology<T> {
|
|
||||||
async fn deploy_docker(&self) -> Result<String, String> {
|
|
||||||
// Orchestrate across primary + replica.
|
|
||||||
let primary_result = self.primary.deploy_docker().await?;
|
|
||||||
let replica_result = self.replica.deploy_docker().await?;
|
|
||||||
Ok(format!("Failover Docker deployed: {} | {}", primary_result, replica_result))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[tokio::main]
|
|
||||||
async fn main() {
|
|
||||||
let config = PostgreSQLConfig;
|
|
||||||
|
|
||||||
println!("=== ✅ PostgreSQL Failover (K8sAnywhere supports PG) ===");
|
|
||||||
let pg_failover = FailoverTopology {
|
|
||||||
primary: K8sAnywhereTopology,
|
|
||||||
replica: K8sAnywhereTopology,
|
|
||||||
};
|
|
||||||
let result = pg_failover.deploy(&config).await.unwrap();
|
|
||||||
println!("Result: {}", result);
|
|
||||||
|
|
||||||
println!("\n=== ✅ Docker Failover (LinuxHost supports Docker) ===");
|
|
||||||
let docker_failover = FailoverTopology {
|
|
||||||
primary: LinuxHostTopology,
|
|
||||||
replica: LinuxHostTopology,
|
|
||||||
};
|
|
||||||
let result = docker_failover.deploy_docker().await.unwrap();
|
|
||||||
println!("Result: {}", result);
|
|
||||||
|
|
||||||
println!("\n=== ❌ Would fail to compile (K8sAnywhere !: Docker) ===");
|
|
||||||
// let invalid = FailoverTopology {
|
|
||||||
// primary: K8sAnywhereTopology,
|
|
||||||
// replica: K8sAnywhereTopology,
|
|
||||||
// };
|
|
||||||
// invalid.deploy_docker().await.unwrap(); // Error: `K8sAnywhereTopology: Docker` not satisfied!
|
|
||||||
// Very clear error message :
|
|
||||||
// error[E0599]: the method `deploy_docker` exists for struct `FailoverTopology<K8sAnywhereTopology>`, but its trait bounds were not satisfied
|
|
||||||
// --> src/main.rs:90:9
|
|
||||||
// |
|
|
||||||
// 4 | pub struct FailoverTopology<T> {
|
|
||||||
// | ------------------------------ method `deploy_docker` not found for this struct because it doesn't satisfy `FailoverTopology<K8sAnywhereTopology>: Docker`
|
|
||||||
// ...
|
|
||||||
// 37 | struct K8sAnywhereTopology;
|
|
||||||
// | -------------------------- doesn't satisfy `K8sAnywhereTopology: Docker`
|
|
||||||
// ...
|
|
||||||
// 90 | invalid.deploy_docker(); // `T: Docker` bound unsatisfied
|
|
||||||
// | ^^^^^^^^^^^^^ method cannot be called on `FailoverTopology<K8sAnywhereTopology>` due to unsatisfied trait bounds
|
|
||||||
// |
|
|
||||||
// note: trait bound `K8sAnywhereTopology: Docker` was not satisfied
|
|
||||||
// --> src/main.rs:61:9
|
|
||||||
// |
|
|
||||||
// 61 | impl<T: Docker + Send + Sync> Docker for FailoverTopology<T> {
|
|
||||||
// | ^^^^^^ ------ -------------------
|
|
||||||
// | |
|
|
||||||
// | unsatisfied trait bound introduced here
|
|
||||||
// note: the trait `Docker` must be implemented
|
|
||||||
}
|
|
||||||
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
[package]
|
|
||||||
name = "example-operatorhub-catalogsource"
|
|
||||||
edition = "2024"
|
|
||||||
version.workspace = true
|
|
||||||
readme.workspace = true
|
|
||||||
license.workspace = true
|
|
||||||
publish = false
|
|
||||||
|
|
||||||
[dependencies]
|
|
||||||
harmony = { path = "../../harmony" }
|
|
||||||
harmony_cli = { path = "../../harmony_cli" }
|
|
||||||
harmony_types = { path = "../../harmony_types" }
|
|
||||||
cidr = { workspace = true }
|
|
||||||
tokio = { workspace = true }
|
|
||||||
harmony_macros = { path = "../../harmony_macros" }
|
|
||||||
log = { workspace = true }
|
|
||||||
env_logger = { workspace = true }
|
|
||||||
url = { workspace = true }
|
|
||||||
@@ -1,22 +0,0 @@
|
|||||||
use std::str::FromStr;
|
|
||||||
|
|
||||||
use harmony::{
|
|
||||||
inventory::Inventory,
|
|
||||||
modules::{k8s::apps::OperatorHubCatalogSourceScore, postgresql::CloudNativePgOperatorScore},
|
|
||||||
topology::K8sAnywhereTopology,
|
|
||||||
};
|
|
||||||
|
|
||||||
#[tokio::main]
|
|
||||||
async fn main() {
|
|
||||||
let operatorhub_catalog = OperatorHubCatalogSourceScore::default();
|
|
||||||
let cnpg_operator = CloudNativePgOperatorScore::default();
|
|
||||||
|
|
||||||
harmony_cli::run(
|
|
||||||
Inventory::autoload(),
|
|
||||||
K8sAnywhereTopology::from_env(),
|
|
||||||
vec![Box::new(operatorhub_catalog), Box::new(cnpg_operator)],
|
|
||||||
None,
|
|
||||||
)
|
|
||||||
.await
|
|
||||||
.unwrap();
|
|
||||||
}
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
[package]
|
|
||||||
name = "example-postgresql"
|
|
||||||
edition = "2024"
|
|
||||||
version.workspace = true
|
|
||||||
readme.workspace = true
|
|
||||||
license.workspace = true
|
|
||||||
publish = false
|
|
||||||
|
|
||||||
[dependencies]
|
|
||||||
harmony = { path = "../../harmony" }
|
|
||||||
harmony_cli = { path = "../../harmony_cli" }
|
|
||||||
harmony_types = { path = "../../harmony_types" }
|
|
||||||
cidr = { workspace = true }
|
|
||||||
tokio = { workspace = true }
|
|
||||||
harmony_macros = { path = "../../harmony_macros" }
|
|
||||||
log = { workspace = true }
|
|
||||||
env_logger = { workspace = true }
|
|
||||||
url = { workspace = true }
|
|
||||||
@@ -1,22 +0,0 @@
|
|||||||
use harmony::{
|
|
||||||
inventory::Inventory, modules::postgresql::PostgreSQLScore, topology::K8sAnywhereTopology,
|
|
||||||
};
|
|
||||||
|
|
||||||
#[tokio::main]
|
|
||||||
async fn main() {
|
|
||||||
let postgresql = PostgreSQLScore {
|
|
||||||
name: "harmony-postgres-example".to_string(), // Override default name
|
|
||||||
namespace: "harmony-postgres-example".to_string(),
|
|
||||||
..Default::default() // Use harmony defaults, they are based on CNPG's default values :
|
|
||||||
// "default" namespace, 1 instance, 1Gi storage
|
|
||||||
};
|
|
||||||
|
|
||||||
harmony_cli::run(
|
|
||||||
Inventory::autoload(),
|
|
||||||
K8sAnywhereTopology::from_env(),
|
|
||||||
vec![Box::new(postgresql)],
|
|
||||||
None,
|
|
||||||
)
|
|
||||||
.await
|
|
||||||
.unwrap();
|
|
||||||
}
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
[package]
|
|
||||||
name = "example-public-postgres"
|
|
||||||
edition = "2024"
|
|
||||||
version.workspace = true
|
|
||||||
readme.workspace = true
|
|
||||||
license.workspace = true
|
|
||||||
publish = false
|
|
||||||
|
|
||||||
[dependencies]
|
|
||||||
harmony = { path = "../../harmony" }
|
|
||||||
harmony_cli = { path = "../../harmony_cli" }
|
|
||||||
harmony_types = { path = "../../harmony_types" }
|
|
||||||
cidr = { workspace = true }
|
|
||||||
tokio = { workspace = true }
|
|
||||||
harmony_macros = { path = "../../harmony_macros" }
|
|
||||||
log = { workspace = true }
|
|
||||||
env_logger = { workspace = true }
|
|
||||||
url = { workspace = true }
|
|
||||||
@@ -1,34 +0,0 @@
|
|||||||
use harmony::{
|
|
||||||
inventory::Inventory,
|
|
||||||
modules::{network::TlsPassthroughScore, postgresql::PostgreSQLScore},
|
|
||||||
topology::{K8sAnywhereTopology, TlsRoute},
|
|
||||||
};
|
|
||||||
|
|
||||||
#[tokio::main]
|
|
||||||
async fn main() {
|
|
||||||
let namespace = "harmony-postgres-example".to_string();
|
|
||||||
let postgresql = PostgreSQLScore {
|
|
||||||
name: "harmony-postgres-example".to_string(), // Override default name
|
|
||||||
namespace: namespace.clone(),
|
|
||||||
..Default::default() // Use harmony defaults, they are based on CNPG's default values :
|
|
||||||
// "default" namespace, 1 instance, 1Gi storage
|
|
||||||
};
|
|
||||||
|
|
||||||
let tls_passthrough = TlsPassthroughScore {
|
|
||||||
route: TlsRoute {
|
|
||||||
hostname: "postgres.example.com".to_string(), // CNPG creates a -rw service for read-write endpoint
|
|
||||||
backend: format!("{}-rw", postgresql.name), // Public hostname for TLS SNI
|
|
||||||
namespace: namespace.clone(),
|
|
||||||
target_port: 5432, // PostgreSQL default port
|
|
||||||
},
|
|
||||||
};
|
|
||||||
|
|
||||||
harmony_cli::run(
|
|
||||||
Inventory::autoload(),
|
|
||||||
K8sAnywhereTopology::from_env(),
|
|
||||||
vec![Box::new(postgresql), Box::new(tls_passthrough)],
|
|
||||||
None,
|
|
||||||
)
|
|
||||||
.await
|
|
||||||
.unwrap();
|
|
||||||
}
|
|
||||||
@@ -152,12 +152,6 @@ pub struct InterpretError {
|
|||||||
msg: String,
|
msg: String,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl From<InterpretError> for String {
|
|
||||||
fn from(e: InterpretError) -> String {
|
|
||||||
format!("InterpretError : {}", e.msg)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl std::fmt::Display for InterpretError {
|
impl std::fmt::Display for InterpretError {
|
||||||
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
||||||
f.write_str(&self.msg)
|
f.write_str(&self.msg)
|
||||||
|
|||||||
@@ -1,19 +0,0 @@
|
|||||||
use async_trait::async_trait;
|
|
||||||
|
|
||||||
use crate::topology::{PreparationError, PreparationOutcome, Topology};
|
|
||||||
|
|
||||||
pub struct FailoverTopology<T> {
|
|
||||||
pub primary: T,
|
|
||||||
pub replica: T,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[async_trait]
|
|
||||||
impl<T: Send + Sync> Topology for FailoverTopology<T> {
|
|
||||||
fn name(&self) -> &str {
|
|
||||||
"FailoverTopology"
|
|
||||||
}
|
|
||||||
|
|
||||||
async fn ensure_ready(&self) -> Result<PreparationOutcome, PreparationError> {
|
|
||||||
todo!()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -451,20 +451,7 @@ impl K8sClient {
|
|||||||
{
|
{
|
||||||
let mut result = Vec::new();
|
let mut result = Vec::new();
|
||||||
for r in resource.iter() {
|
for r in resource.iter() {
|
||||||
let apply_result = self.apply(r, ns).await;
|
result.push(self.apply(r, ns).await?);
|
||||||
if apply_result.is_err() {
|
|
||||||
// NOTE : We should be careful about this one, it may leak sensitive information in
|
|
||||||
// logs
|
|
||||||
// Maybe just reducing it to debug would be enough as we already know debug logs
|
|
||||||
// are unsafe.
|
|
||||||
// But keeping it at warn makes it much easier to understand what is going on. So be it for now.
|
|
||||||
warn!(
|
|
||||||
"Failed to apply k8s resource : {}",
|
|
||||||
serde_json::to_string_pretty(r).map_err(|e| Error::SerdeError(e))?
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
result.push(apply_result?);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
Ok(result)
|
Ok(result)
|
||||||
|
|||||||
@@ -2,7 +2,6 @@ use std::{collections::BTreeMap, process::Command, sync::Arc, time::Duration};
|
|||||||
|
|
||||||
use async_trait::async_trait;
|
use async_trait::async_trait;
|
||||||
use base64::{Engine, engine::general_purpose};
|
use base64::{Engine, engine::general_purpose};
|
||||||
use harmony_types::rfc1123::Rfc1123Name;
|
|
||||||
use k8s_openapi::api::{
|
use k8s_openapi::api::{
|
||||||
core::v1::Secret,
|
core::v1::Secret,
|
||||||
rbac::v1::{ClusterRoleBinding, RoleRef, Subject},
|
rbac::v1::{ClusterRoleBinding, RoleRef, Subject},
|
||||||
@@ -35,15 +34,13 @@ use crate::{
|
|||||||
service_monitor::ServiceMonitor,
|
service_monitor::ServiceMonitor,
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
network::TlsPassthroughScore,
|
|
||||||
okd::route::OKDTlsPassthroughScore,
|
|
||||||
prometheus::{
|
prometheus::{
|
||||||
k8s_prometheus_alerting_score::K8sPrometheusCRDAlertingScore,
|
k8s_prometheus_alerting_score::K8sPrometheusCRDAlertingScore,
|
||||||
prometheus::PrometheusMonitoring, rhob_alerting_score::RHOBAlertingScore,
|
prometheus::PrometheusMonitoring, rhob_alerting_score::RHOBAlertingScore,
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
score::Score,
|
score::Score,
|
||||||
topology::{TlsRoute, TlsRouter, ingress::Ingress},
|
topology::ingress::Ingress,
|
||||||
};
|
};
|
||||||
|
|
||||||
use super::{
|
use super::{
|
||||||
@@ -105,31 +102,6 @@ impl K8sclient for K8sAnywhereTopology {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
#[async_trait]
|
|
||||||
impl TlsRouter for K8sAnywhereTopology {
|
|
||||||
async fn install_route(&self, route: TlsRoute) -> Result<(), String> {
|
|
||||||
let distro = self
|
|
||||||
.get_k8s_distribution()
|
|
||||||
.await
|
|
||||||
.map_err(|e| format!("Could not get k8s distribution {e}"))?;
|
|
||||||
|
|
||||||
match distro {
|
|
||||||
KubernetesDistribution::OpenshiftFamily => {
|
|
||||||
OKDTlsPassthroughScore {
|
|
||||||
name: Rfc1123Name::try_from(route.backend_info_string().as_str())?,
|
|
||||||
route,
|
|
||||||
}
|
|
||||||
.interpret(&Inventory::empty(), self)
|
|
||||||
.await?;
|
|
||||||
Ok(())
|
|
||||||
}
|
|
||||||
KubernetesDistribution::K3sFamily | KubernetesDistribution::Default => Err(format!(
|
|
||||||
"Distribution not supported yet for Tlsrouter {distro:?}"
|
|
||||||
)),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[async_trait]
|
#[async_trait]
|
||||||
impl Grafana for K8sAnywhereTopology {
|
impl Grafana for K8sAnywhereTopology {
|
||||||
async fn ensure_grafana_operator(
|
async fn ensure_grafana_operator(
|
||||||
@@ -371,7 +343,6 @@ impl K8sAnywhereTopology {
|
|||||||
pub async fn get_k8s_distribution(&self) -> Result<&KubernetesDistribution, PreparationError> {
|
pub async fn get_k8s_distribution(&self) -> Result<&KubernetesDistribution, PreparationError> {
|
||||||
self.k8s_distribution
|
self.k8s_distribution
|
||||||
.get_or_try_init(async || {
|
.get_or_try_init(async || {
|
||||||
debug!("Trying to detect k8s distribution");
|
|
||||||
let client = self.k8s_client().await.unwrap();
|
let client = self.k8s_client().await.unwrap();
|
||||||
|
|
||||||
let discovery = client.discovery().await.map_err(|e| {
|
let discovery = client.discovery().await.map_err(|e| {
|
||||||
@@ -387,17 +358,14 @@ impl K8sAnywhereTopology {
|
|||||||
.groups()
|
.groups()
|
||||||
.any(|g| g.name() == "project.openshift.io")
|
.any(|g| g.name() == "project.openshift.io")
|
||||||
{
|
{
|
||||||
info!("Found KubernetesDistribution OpenshiftFamily");
|
|
||||||
return Ok(KubernetesDistribution::OpenshiftFamily);
|
return Ok(KubernetesDistribution::OpenshiftFamily);
|
||||||
}
|
}
|
||||||
|
|
||||||
// K3d / K3s
|
// K3d / K3s
|
||||||
if version.git_version.contains("k3s") {
|
if version.git_version.contains("k3s") {
|
||||||
info!("Found KubernetesDistribution K3sFamily");
|
|
||||||
return Ok(KubernetesDistribution::K3sFamily);
|
return Ok(KubernetesDistribution::K3sFamily);
|
||||||
}
|
}
|
||||||
|
|
||||||
info!("Could not identify KubernetesDistribution, using Default");
|
|
||||||
return Ok(KubernetesDistribution::Default);
|
return Ok(KubernetesDistribution::Default);
|
||||||
})
|
})
|
||||||
.await
|
.await
|
||||||
|
|||||||
@@ -1,7 +1,5 @@
|
|||||||
mod failover;
|
|
||||||
mod ha_cluster;
|
mod ha_cluster;
|
||||||
pub mod ingress;
|
pub mod ingress;
|
||||||
pub use failover::*;
|
|
||||||
use harmony_types::net::IpAddress;
|
use harmony_types::net::IpAddress;
|
||||||
mod host_binding;
|
mod host_binding;
|
||||||
mod http;
|
mod http;
|
||||||
@@ -15,7 +13,7 @@ pub use k8s_anywhere::*;
|
|||||||
pub use localhost::*;
|
pub use localhost::*;
|
||||||
pub mod k8s;
|
pub mod k8s;
|
||||||
mod load_balancer;
|
mod load_balancer;
|
||||||
pub mod router;
|
mod router;
|
||||||
mod tftp;
|
mod tftp;
|
||||||
use async_trait::async_trait;
|
use async_trait::async_trait;
|
||||||
pub use ha_cluster::*;
|
pub use ha_cluster::*;
|
||||||
|
|||||||
@@ -1,20 +1,11 @@
|
|||||||
use async_trait::async_trait;
|
|
||||||
use cidr::Ipv4Cidr;
|
use cidr::Ipv4Cidr;
|
||||||
use derive_new::new;
|
use derive_new::new;
|
||||||
use serde::Serialize;
|
|
||||||
|
|
||||||
use super::{IpAddress, LogicalHost};
|
use super::{IpAddress, LogicalHost};
|
||||||
|
|
||||||
/// Basic network router abstraction (L3 IP routing/gateway).
|
|
||||||
/// Distinguished from TlsRouter (L4 TLS passthrough).
|
|
||||||
pub trait Router: Send + Sync {
|
pub trait Router: Send + Sync {
|
||||||
/// Gateway IP address for this subnet/router.
|
|
||||||
fn get_gateway(&self) -> IpAddress;
|
fn get_gateway(&self) -> IpAddress;
|
||||||
|
|
||||||
/// CIDR block managed by this router.
|
|
||||||
fn get_cidr(&self) -> Ipv4Cidr;
|
fn get_cidr(&self) -> Ipv4Cidr;
|
||||||
|
|
||||||
/// Logical host associated with this router.
|
|
||||||
fn get_host(&self) -> LogicalHost;
|
fn get_host(&self) -> LogicalHost;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -47,67 +38,3 @@ impl Router for UnmanagedRouter {
|
|||||||
todo!()
|
todo!()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Desired state config for a TLS passthrough route.
|
|
||||||
/// Forwards external TLS (port 443) → backend service:target_port (no termination at router).
|
|
||||||
/// Inspired by CNPG multisite: exposes `-rw`/`-ro` services publicly via OKD Route/HAProxy/K8s
|
|
||||||
/// Gateway etc.
|
|
||||||
///
|
|
||||||
/// # Example
|
|
||||||
/// ```
|
|
||||||
/// use harmony::topology::router::TlsRoute;
|
|
||||||
/// let postgres_rw = TlsRoute {
|
|
||||||
/// hostname: "postgres-cluster-example.public.domain.io".to_string(),
|
|
||||||
/// backend: "postgres-cluster-example-rw".to_string(), // k8s Service or HAProxy upstream
|
|
||||||
/// target_port: 5432,
|
|
||||||
/// };
|
|
||||||
/// ```
|
|
||||||
#[derive(Clone, Debug, Serialize)]
|
|
||||||
pub struct TlsRoute {
|
|
||||||
/// Public hostname clients connect to (TLS SNI, port 443 implicit).
|
|
||||||
/// Router matches this for passthrough forwarding.
|
|
||||||
pub hostname: String,
|
|
||||||
|
|
||||||
/// Backend/host identifier (k8s Service, HAProxy upstream, IP/FQDN, etc.).
|
|
||||||
pub backend: String,
|
|
||||||
|
|
||||||
/// Backend TCP port (Postgres: 5432).
|
|
||||||
pub target_port: u16,
|
|
||||||
|
|
||||||
/// The environment in which it lives.
|
|
||||||
/// TODO clarify how we handle this in higher level abstractions. The namespace name is a
|
|
||||||
/// direct mapping to k8s but that could be misleading for other implementations.
|
|
||||||
pub namespace: String,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl TlsRoute {
|
|
||||||
pub fn to_string_short(&self) -> String {
|
|
||||||
format!("{}-{}:{}", self.hostname, self.backend, self.target_port)
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn backend_info_string(&self) -> String {
|
|
||||||
format!("{}:{}", self.backend, self.target_port)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Installs and queries TLS passthrough routes (L4 TCP/SNI forwarding, no TLS termination).
|
|
||||||
/// Agnostic to impl: OKD Route, AWS NLB+HAProxy, k3s Envoy Gateway, Apache ProxyPass.
|
|
||||||
/// Used by PostgreSQL capability to expose CNPG clusters multisite (site1 → site2 replication).
|
|
||||||
///
|
|
||||||
/// # Usage
|
|
||||||
/// ```ignore
|
|
||||||
/// use harmony::topology::router::TlsRoute;
|
|
||||||
/// // After CNPG deploy, expose RW endpoint
|
|
||||||
/// async fn route() {
|
|
||||||
/// let topology = okd_topology();
|
|
||||||
/// let route = TlsRoute { /* ... */ };
|
|
||||||
/// topology.install_route(route).await; // OKD Route, HAProxy reload, etc.
|
|
||||||
/// }
|
|
||||||
/// ```
|
|
||||||
#[async_trait]
|
|
||||||
pub trait TlsRouter: Send + Sync {
|
|
||||||
/// Provisions the route (idempotent where possible).
|
|
||||||
/// Example: OKD Route{ host, to: backend:target_port, tls: {passthrough} };
|
|
||||||
/// HAProxy frontend→backend \"postgres-upstream\".
|
|
||||||
async fn install_route(&self, config: TlsRoute) -> Result<(), String>;
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -17,12 +17,6 @@ use crate::{
|
|||||||
topology::{HostNetworkConfig, NetworkError, NetworkManager, k8s::K8sClient},
|
topology::{HostNetworkConfig, NetworkError, NetworkManager, k8s::K8sClient},
|
||||||
};
|
};
|
||||||
|
|
||||||
/// TODO document properly the non-intuitive behavior or "roll forward only" of nmstate in general
|
|
||||||
/// It is documented in nmstate official doc, but worth mentionning here :
|
|
||||||
///
|
|
||||||
/// - You create a bond, nmstate will apply it
|
|
||||||
/// - You delete de bond from nmstate, it will NOT delete it
|
|
||||||
/// - To delete it you have to update it with configuration set to null
|
|
||||||
pub struct OpenShiftNmStateNetworkManager {
|
pub struct OpenShiftNmStateNetworkManager {
|
||||||
k8s_client: Arc<K8sClient>,
|
k8s_client: Arc<K8sClient>,
|
||||||
}
|
}
|
||||||
@@ -37,7 +31,6 @@ impl std::fmt::Debug for OpenShiftNmStateNetworkManager {
|
|||||||
impl NetworkManager for OpenShiftNmStateNetworkManager {
|
impl NetworkManager for OpenShiftNmStateNetworkManager {
|
||||||
async fn ensure_network_manager_installed(&self) -> Result<(), NetworkError> {
|
async fn ensure_network_manager_installed(&self) -> Result<(), NetworkError> {
|
||||||
debug!("Installing NMState controller...");
|
debug!("Installing NMState controller...");
|
||||||
// TODO use operatorhub maybe?
|
|
||||||
self.k8s_client.apply_url(url::Url::parse("https://github.com/nmstate/kubernetes-nmstate/releases/download/v0.84.0/nmstate.io_nmstates.yaml
|
self.k8s_client.apply_url(url::Url::parse("https://github.com/nmstate/kubernetes-nmstate/releases/download/v0.84.0/nmstate.io_nmstates.yaml
|
||||||
").unwrap(), Some("nmstate"))
|
").unwrap(), Some("nmstate"))
|
||||||
.await?;
|
.await?;
|
||||||
|
|||||||
@@ -1,157 +0,0 @@
|
|||||||
use std::collections::BTreeMap;
|
|
||||||
|
|
||||||
use k8s_openapi::{
|
|
||||||
api::core::v1::{Affinity, Toleration},
|
|
||||||
apimachinery::pkg::apis::meta::v1::ObjectMeta,
|
|
||||||
};
|
|
||||||
use kube::CustomResource;
|
|
||||||
use schemars::JsonSchema;
|
|
||||||
use serde::{Deserialize, Serialize};
|
|
||||||
use serde_json::Value;
|
|
||||||
|
|
||||||
#[derive(CustomResource, Deserialize, Serialize, Clone, Debug)]
|
|
||||||
#[kube(
|
|
||||||
group = "operators.coreos.com",
|
|
||||||
version = "v1alpha1",
|
|
||||||
kind = "CatalogSource",
|
|
||||||
plural = "catalogsources",
|
|
||||||
namespaced = true,
|
|
||||||
schema = "disabled"
|
|
||||||
)]
|
|
||||||
#[serde(rename_all = "camelCase")]
|
|
||||||
pub struct CatalogSourceSpec {
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub address: Option<String>,
|
|
||||||
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub config_map: Option<String>,
|
|
||||||
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub description: Option<String>,
|
|
||||||
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub display_name: Option<String>,
|
|
||||||
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub grpc_pod_config: Option<GrpcPodConfig>,
|
|
||||||
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub icon: Option<Icon>,
|
|
||||||
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub image: Option<String>,
|
|
||||||
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub priority: Option<i64>,
|
|
||||||
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub publisher: Option<String>,
|
|
||||||
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub run_as_root: Option<bool>,
|
|
||||||
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub secrets: Option<Vec<String>>,
|
|
||||||
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub source_type: Option<String>,
|
|
||||||
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub update_strategy: Option<UpdateStrategy>,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Deserialize, Serialize, Clone, Debug)]
|
|
||||||
#[serde(rename_all = "camelCase")]
|
|
||||||
pub struct GrpcPodConfig {
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub affinity: Option<Affinity>,
|
|
||||||
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub extract_content: Option<ExtractContent>,
|
|
||||||
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub memory_target: Option<Value>,
|
|
||||||
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub node_selector: Option<BTreeMap<String, String>>,
|
|
||||||
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub priority_class_name: Option<String>,
|
|
||||||
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub security_context_config: Option<String>,
|
|
||||||
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub tolerations: Option<Vec<Toleration>>,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Deserialize, Serialize, Clone, Debug, JsonSchema)]
|
|
||||||
#[serde(rename_all = "camelCase")]
|
|
||||||
pub struct ExtractContent {
|
|
||||||
pub cache_dir: String,
|
|
||||||
pub catalog_dir: String,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Deserialize, Serialize, Clone, Debug, JsonSchema)]
|
|
||||||
#[serde(rename_all = "camelCase")]
|
|
||||||
pub struct Icon {
|
|
||||||
pub base64data: String,
|
|
||||||
pub mediatype: String,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Deserialize, Serialize, Clone, Debug, JsonSchema)]
|
|
||||||
#[serde(rename_all = "camelCase")]
|
|
||||||
pub struct UpdateStrategy {
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub registry_poll: Option<RegistryPoll>,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Deserialize, Serialize, Clone, Debug, JsonSchema)]
|
|
||||||
#[serde(rename_all = "camelCase")]
|
|
||||||
pub struct RegistryPoll {
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub interval: Option<String>,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Default for CatalogSource {
|
|
||||||
fn default() -> Self {
|
|
||||||
Self {
|
|
||||||
metadata: ObjectMeta::default(),
|
|
||||||
spec: CatalogSourceSpec {
|
|
||||||
address: None,
|
|
||||||
config_map: None,
|
|
||||||
description: None,
|
|
||||||
display_name: None,
|
|
||||||
grpc_pod_config: None,
|
|
||||||
icon: None,
|
|
||||||
image: None,
|
|
||||||
priority: None,
|
|
||||||
publisher: None,
|
|
||||||
run_as_root: None,
|
|
||||||
secrets: None,
|
|
||||||
source_type: None,
|
|
||||||
update_strategy: None,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Default for CatalogSourceSpec {
|
|
||||||
fn default() -> Self {
|
|
||||||
Self {
|
|
||||||
address: None,
|
|
||||||
config_map: None,
|
|
||||||
description: None,
|
|
||||||
display_name: None,
|
|
||||||
grpc_pod_config: None,
|
|
||||||
icon: None,
|
|
||||||
image: None,
|
|
||||||
priority: None,
|
|
||||||
publisher: None,
|
|
||||||
run_as_root: None,
|
|
||||||
secrets: None,
|
|
||||||
source_type: None,
|
|
||||||
update_strategy: None,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,4 +0,0 @@
|
|||||||
mod catalogsources_operators_coreos_com;
|
|
||||||
pub use catalogsources_operators_coreos_com::*;
|
|
||||||
mod subscriptions_operators_coreos_com;
|
|
||||||
pub use subscriptions_operators_coreos_com::*;
|
|
||||||
@@ -1,68 +0,0 @@
|
|||||||
use k8s_openapi::apimachinery::pkg::apis::meta::v1::ObjectMeta;
|
|
||||||
use kube::CustomResource;
|
|
||||||
use serde::{Deserialize, Serialize};
|
|
||||||
|
|
||||||
#[derive(CustomResource, Deserialize, Serialize, Clone, Debug)]
|
|
||||||
#[kube(
|
|
||||||
group = "operators.coreos.com",
|
|
||||||
version = "v1alpha1",
|
|
||||||
kind = "Subscription",
|
|
||||||
plural = "subscriptions",
|
|
||||||
namespaced = true,
|
|
||||||
schema = "disabled"
|
|
||||||
)]
|
|
||||||
#[serde(rename_all = "camelCase")]
|
|
||||||
pub struct SubscriptionSpec {
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub channel: Option<String>,
|
|
||||||
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub config: Option<SubscriptionConfig>,
|
|
||||||
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub install_plan_approval: Option<String>,
|
|
||||||
|
|
||||||
pub name: String,
|
|
||||||
|
|
||||||
pub source: String,
|
|
||||||
|
|
||||||
pub source_namespace: String,
|
|
||||||
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub starting_csv: Option<String>,
|
|
||||||
}
|
|
||||||
#[derive(Deserialize, Serialize, Clone, Debug)]
|
|
||||||
#[serde(rename_all = "camelCase")]
|
|
||||||
pub struct SubscriptionConfig {
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub env: Option<Vec<k8s_openapi::api::core::v1::EnvVar>>,
|
|
||||||
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub node_selector: Option<std::collections::BTreeMap<String, String>>,
|
|
||||||
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub tolerations: Option<Vec<k8s_openapi::api::core::v1::Toleration>>,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Default for Subscription {
|
|
||||||
fn default() -> Self {
|
|
||||||
Subscription {
|
|
||||||
metadata: ObjectMeta::default(),
|
|
||||||
spec: SubscriptionSpec::default(),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Default for SubscriptionSpec {
|
|
||||||
fn default() -> SubscriptionSpec {
|
|
||||||
SubscriptionSpec {
|
|
||||||
name: String::new(),
|
|
||||||
source: String::new(),
|
|
||||||
source_namespace: String::new(),
|
|
||||||
channel: None,
|
|
||||||
config: None,
|
|
||||||
install_plan_approval: None,
|
|
||||||
starting_csv: None,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
mod operatorhub;
|
|
||||||
pub use operatorhub::*;
|
|
||||||
pub mod crd;
|
|
||||||
@@ -1,107 +0,0 @@
|
|||||||
// Write operatorhub catalog score
|
|
||||||
// for now this will only support on OKD with the default catalog and operatorhub setup and does not verify OLM state or anything else. Very opinionated and bare-bones to start
|
|
||||||
|
|
||||||
use k8s_openapi::apimachinery::pkg::apis::meta::v1::ObjectMeta;
|
|
||||||
use serde::Serialize;
|
|
||||||
|
|
||||||
use crate::interpret::Interpret;
|
|
||||||
use crate::modules::k8s::apps::crd::{
|
|
||||||
CatalogSource, CatalogSourceSpec, RegistryPoll, UpdateStrategy,
|
|
||||||
};
|
|
||||||
use crate::modules::k8s::resource::K8sResourceScore;
|
|
||||||
use crate::score::Score;
|
|
||||||
use crate::topology::{K8sclient, Topology};
|
|
||||||
|
|
||||||
/// Installs the CatalogSource in a cluster which already has the required services and CRDs installed.
|
|
||||||
///
|
|
||||||
/// ```rust
|
|
||||||
/// use harmony::modules::k8s::apps::OperatorHubCatalogSourceScore;
|
|
||||||
///
|
|
||||||
/// let score = OperatorHubCatalogSourceScore::default();
|
|
||||||
/// ```
|
|
||||||
///
|
|
||||||
/// Required services:
|
|
||||||
/// - catalog-operator
|
|
||||||
/// - olm-operator
|
|
||||||
///
|
|
||||||
/// They are installed by default with OKD/Openshift
|
|
||||||
///
|
|
||||||
/// **Warning** : this initial implementation does not manage the dependencies. They must already
|
|
||||||
/// exist in the cluster.
|
|
||||||
#[derive(Debug, Clone, Serialize)]
|
|
||||||
pub struct OperatorHubCatalogSourceScore {
|
|
||||||
pub name: String,
|
|
||||||
pub namespace: String,
|
|
||||||
pub image: String,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl OperatorHubCatalogSourceScore {
|
|
||||||
pub fn new(name: &str, namespace: &str, image: &str) -> Self {
|
|
||||||
Self {
|
|
||||||
name: name.to_string(),
|
|
||||||
namespace: namespace.to_string(),
|
|
||||||
image: image.to_string(),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Default for OperatorHubCatalogSourceScore {
|
|
||||||
/// This default implementation will create this k8s resource :
|
|
||||||
///
|
|
||||||
/// ```yaml
|
|
||||||
/// apiVersion: operators.coreos.com/v1alpha1
|
|
||||||
/// kind: CatalogSource
|
|
||||||
/// metadata:
|
|
||||||
/// name: operatorhubio-catalog
|
|
||||||
/// namespace: openshift-marketplace
|
|
||||||
/// spec:
|
|
||||||
/// sourceType: grpc
|
|
||||||
/// image: quay.io/operatorhubio/catalog:latest
|
|
||||||
/// displayName: Operatorhub Operators
|
|
||||||
/// publisher: OperatorHub.io
|
|
||||||
/// updateStrategy:
|
|
||||||
/// registryPoll:
|
|
||||||
/// interval: 60m
|
|
||||||
/// ```
|
|
||||||
fn default() -> Self {
|
|
||||||
OperatorHubCatalogSourceScore {
|
|
||||||
name: "operatorhubio-catalog".to_string(),
|
|
||||||
namespace: "openshift-marketplace".to_string(),
|
|
||||||
image: "quay.io/operatorhubio/catalog:latest".to_string(),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<T: Topology + K8sclient> Score<T> for OperatorHubCatalogSourceScore {
|
|
||||||
fn create_interpret(&self) -> Box<dyn Interpret<T>> {
|
|
||||||
let metadata = ObjectMeta {
|
|
||||||
name: Some(self.name.clone()),
|
|
||||||
namespace: Some(self.namespace.clone()),
|
|
||||||
..ObjectMeta::default()
|
|
||||||
};
|
|
||||||
|
|
||||||
let spec = CatalogSourceSpec {
|
|
||||||
source_type: Some("grpc".to_string()),
|
|
||||||
image: Some(self.image.clone()),
|
|
||||||
display_name: Some("Operatorhub Operators".to_string()),
|
|
||||||
publisher: Some("OperatorHub.io".to_string()),
|
|
||||||
update_strategy: Some(UpdateStrategy {
|
|
||||||
registry_poll: Some(RegistryPoll {
|
|
||||||
interval: Some("60m".to_string()),
|
|
||||||
}),
|
|
||||||
}),
|
|
||||||
..CatalogSourceSpec::default()
|
|
||||||
};
|
|
||||||
|
|
||||||
let catalog_source = CatalogSource {
|
|
||||||
metadata,
|
|
||||||
spec: spec,
|
|
||||||
};
|
|
||||||
|
|
||||||
K8sResourceScore::single(catalog_source, Some(self.namespace.clone())).create_interpret()
|
|
||||||
}
|
|
||||||
|
|
||||||
fn name(&self) -> String {
|
|
||||||
format!("OperatorHubCatalogSourceScore({})", self.name)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,4 +1,3 @@
|
|||||||
pub mod apps;
|
|
||||||
pub mod deployment;
|
pub mod deployment;
|
||||||
pub mod ingress;
|
pub mod ingress;
|
||||||
pub mod namespace;
|
pub mod namespace;
|
||||||
|
|||||||
@@ -79,33 +79,7 @@ where
|
|||||||
_inventory: &Inventory,
|
_inventory: &Inventory,
|
||||||
topology: &T,
|
topology: &T,
|
||||||
) -> Result<Outcome, InterpretError> {
|
) -> Result<Outcome, InterpretError> {
|
||||||
// TODO improve this log
|
info!("Applying {} resources", self.score.resource.len());
|
||||||
let resource_names: Vec<String> = self
|
|
||||||
.score
|
|
||||||
.resource
|
|
||||||
.iter()
|
|
||||||
.map(|r| {
|
|
||||||
format!(
|
|
||||||
"{}{}",
|
|
||||||
r.meta()
|
|
||||||
.name
|
|
||||||
.as_ref()
|
|
||||||
.map(|n| format!("{n}"))
|
|
||||||
.unwrap_or_default(),
|
|
||||||
r.meta()
|
|
||||||
.namespace
|
|
||||||
.as_ref()
|
|
||||||
.map(|ns| format!("@{}", ns))
|
|
||||||
.unwrap_or_default()
|
|
||||||
)
|
|
||||||
})
|
|
||||||
.collect();
|
|
||||||
|
|
||||||
info!(
|
|
||||||
"Applying {} resources : {}",
|
|
||||||
resource_names.len(),
|
|
||||||
resource_names.join(", ")
|
|
||||||
);
|
|
||||||
topology
|
topology
|
||||||
.k8s_client()
|
.k8s_client()
|
||||||
.await
|
.await
|
||||||
|
|||||||
@@ -11,10 +11,8 @@ pub mod k8s;
|
|||||||
pub mod lamp;
|
pub mod lamp;
|
||||||
pub mod load_balancer;
|
pub mod load_balancer;
|
||||||
pub mod monitoring;
|
pub mod monitoring;
|
||||||
pub mod network;
|
|
||||||
pub mod okd;
|
pub mod okd;
|
||||||
pub mod opnsense;
|
pub mod opnsense;
|
||||||
pub mod postgresql;
|
|
||||||
pub mod prometheus;
|
pub mod prometheus;
|
||||||
pub mod storage;
|
pub mod storage;
|
||||||
pub mod tenant;
|
pub mod tenant;
|
||||||
|
|||||||
@@ -1,2 +0,0 @@
|
|||||||
mod tls_router;
|
|
||||||
pub use tls_router::*;
|
|
||||||
@@ -1,91 +0,0 @@
|
|||||||
use async_trait::async_trait;
|
|
||||||
use harmony_types::id::Id;
|
|
||||||
use serde::Serialize;
|
|
||||||
|
|
||||||
use crate::data::Version;
|
|
||||||
use crate::domain::topology::router::{TlsRoute, TlsRouter};
|
|
||||||
use crate::interpret::{Interpret, InterpretError, InterpretName, InterpretStatus, Outcome};
|
|
||||||
use crate::inventory::Inventory;
|
|
||||||
use crate::score::Score;
|
|
||||||
use crate::topology::{K8sclient, Topology};
|
|
||||||
|
|
||||||
/// Score for provisioning a TLS passthrough route.
|
|
||||||
/// Exposes backend services via TLS passthrough (L4 TCP/SNI forwarding).
|
|
||||||
/// Agnostic to underlying router impl (OKD Route, HAProxy, Envoy, etc.).
|
|
||||||
///
|
|
||||||
/// TlsPassthroughScore relies on the TlsRouter Capability for its entire functionnality,
|
|
||||||
/// the implementation depends entirely on how the Topology implements it.
|
|
||||||
///
|
|
||||||
/// # Usage
|
|
||||||
/// ```
|
|
||||||
/// use harmony::modules::network::TlsPassthroughScore;
|
|
||||||
/// use harmony::topology::router::TlsRoute;
|
|
||||||
/// let score = TlsPassthroughScore {
|
|
||||||
/// route: TlsRoute {
|
|
||||||
/// backend: "postgres-cluster-rw".to_string(),
|
|
||||||
/// hostname: "postgres-rw.example.com".to_string(),
|
|
||||||
/// target_port: 5432,
|
|
||||||
/// },
|
|
||||||
/// };
|
|
||||||
/// ```
|
|
||||||
///
|
|
||||||
/// # Hint
|
|
||||||
///
|
|
||||||
/// **This TlsPassthroughScore should be used whenever possible.** It is effectively
|
|
||||||
/// an abstraction over the concept of tls passthrough, and it will allow much more flexible
|
|
||||||
/// usage over multiple types of Topology than using a lower level module such as
|
|
||||||
/// OKDTlsPassthroughScore.
|
|
||||||
///
|
|
||||||
/// On the other hand, some implementation specific options might not be available or practical
|
|
||||||
/// to use through this high level TlsPassthroughScore.
|
|
||||||
#[derive(Debug, Clone, Serialize)]
|
|
||||||
pub struct TlsPassthroughScore {
|
|
||||||
pub route: TlsRoute,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<T: Topology + K8sclient + TlsRouter + Send + Sync> Score<T> for TlsPassthroughScore {
|
|
||||||
fn create_interpret(&self) -> Box<dyn Interpret<T>> {
|
|
||||||
Box::new(TlsPassthroughInterpret {
|
|
||||||
tls_route: self.route.clone(),
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
fn name(&self) -> String {
|
|
||||||
format!(
|
|
||||||
"TlsRouterScore({}:{} → {})",
|
|
||||||
self.route.backend, self.route.target_port, self.route.hostname
|
|
||||||
)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Custom interpret: provisions the TLS passthrough route on the topology.
|
|
||||||
#[derive(Debug, Clone)]
|
|
||||||
struct TlsPassthroughInterpret {
|
|
||||||
tls_route: TlsRoute,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[async_trait]
|
|
||||||
impl<T: Topology + K8sclient + TlsRouter + Send + Sync> Interpret<T> for TlsPassthroughInterpret {
|
|
||||||
fn get_name(&self) -> InterpretName {
|
|
||||||
InterpretName::Custom("TlsRouterInterpret")
|
|
||||||
}
|
|
||||||
fn get_version(&self) -> Version {
|
|
||||||
todo!()
|
|
||||||
}
|
|
||||||
fn get_status(&self) -> InterpretStatus {
|
|
||||||
todo!()
|
|
||||||
}
|
|
||||||
fn get_children(&self) -> Vec<Id> {
|
|
||||||
todo!()
|
|
||||||
}
|
|
||||||
async fn execute(&self, _inventory: &Inventory, topo: &T) -> Result<Outcome, InterpretError> {
|
|
||||||
topo.install_route(self.tls_route.clone())
|
|
||||||
.await
|
|
||||||
.map_err(|e| InterpretError::new(e.to_string()))?;
|
|
||||||
|
|
||||||
Ok(Outcome::success(format!(
|
|
||||||
"TLS route installed: {} → {}:{}",
|
|
||||||
self.tls_route.hostname, self.tls_route.backend, self.tls_route.target_port
|
|
||||||
)))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,2 +1 @@
|
|||||||
pub mod nmstate;
|
pub mod nmstate;
|
||||||
pub mod route;
|
|
||||||
|
|||||||
@@ -1,287 +0,0 @@
|
|||||||
use k8s_openapi::apimachinery::pkg::apis::meta::v1::{ListMeta, ObjectMeta, Time};
|
|
||||||
use k8s_openapi::apimachinery::pkg::util::intstr::IntOrString;
|
|
||||||
use k8s_openapi::{NamespaceResourceScope, Resource};
|
|
||||||
use serde::{Deserialize, Serialize};
|
|
||||||
|
|
||||||
#[derive(Deserialize, Serialize, Clone, Debug)]
|
|
||||||
#[serde(rename_all = "camelCase")]
|
|
||||||
pub struct LocalObjectReference {
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub name: Option<String>,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Deserialize, Serialize, Clone, Debug)]
|
|
||||||
#[serde(rename_all = "camelCase")]
|
|
||||||
pub struct Route {
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub api_version: Option<String>,
|
|
||||||
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub kind: Option<String>,
|
|
||||||
pub metadata: ObjectMeta,
|
|
||||||
|
|
||||||
pub spec: RouteSpec,
|
|
||||||
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub status: Option<RouteStatus>,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Resource for Route {
|
|
||||||
const API_VERSION: &'static str = "route.openshift.io/v1";
|
|
||||||
const GROUP: &'static str = "route.openshift.io";
|
|
||||||
const VERSION: &'static str = "v1";
|
|
||||||
const KIND: &'static str = "Route";
|
|
||||||
const URL_PATH_SEGMENT: &'static str = "routes";
|
|
||||||
type Scope = NamespaceResourceScope;
|
|
||||||
}
|
|
||||||
|
|
||||||
impl k8s_openapi::Metadata for Route {
|
|
||||||
type Ty = ObjectMeta;
|
|
||||||
|
|
||||||
fn metadata(&self) -> &Self::Ty {
|
|
||||||
&self.metadata
|
|
||||||
}
|
|
||||||
|
|
||||||
fn metadata_mut(&mut self) -> &mut Self::Ty {
|
|
||||||
&mut self.metadata
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Default for Route {
|
|
||||||
fn default() -> Self {
|
|
||||||
Route {
|
|
||||||
api_version: Some("route.openshift.io/v1".to_string()),
|
|
||||||
kind: Some("Route".to_string()),
|
|
||||||
metadata: ObjectMeta::default(),
|
|
||||||
spec: RouteSpec::default(),
|
|
||||||
status: None,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Deserialize, Serialize, Clone, Debug)]
|
|
||||||
#[serde(rename_all = "camelCase")]
|
|
||||||
pub struct RouteList {
|
|
||||||
pub metadata: ListMeta,
|
|
||||||
pub items: Vec<Route>,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Default for RouteList {
|
|
||||||
fn default() -> Self {
|
|
||||||
Self {
|
|
||||||
metadata: ListMeta::default(),
|
|
||||||
items: Vec::new(),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Resource for RouteList {
|
|
||||||
const API_VERSION: &'static str = "route.openshift.io/v1";
|
|
||||||
const GROUP: &'static str = "route.openshift.io";
|
|
||||||
const VERSION: &'static str = "v1";
|
|
||||||
const KIND: &'static str = "RouteList";
|
|
||||||
const URL_PATH_SEGMENT: &'static str = "routes";
|
|
||||||
type Scope = NamespaceResourceScope;
|
|
||||||
}
|
|
||||||
|
|
||||||
impl k8s_openapi::Metadata for RouteList {
|
|
||||||
type Ty = ListMeta;
|
|
||||||
|
|
||||||
fn metadata(&self) -> &Self::Ty {
|
|
||||||
&self.metadata
|
|
||||||
}
|
|
||||||
|
|
||||||
fn metadata_mut(&mut self) -> &mut Self::Ty {
|
|
||||||
&mut self.metadata
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Deserialize, Serialize, Clone, Debug)]
|
|
||||||
#[serde(rename_all = "camelCase")]
|
|
||||||
pub struct RouteSpec {
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub alternate_backends: Option<Vec<RouteTargetReference>>,
|
|
||||||
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub host: Option<String>,
|
|
||||||
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub http_headers: Option<RouteHTTPHeaders>,
|
|
||||||
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub path: Option<String>,
|
|
||||||
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub port: Option<RoutePort>,
|
|
||||||
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub subdomain: Option<String>,
|
|
||||||
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub tls: Option<TLSConfig>,
|
|
||||||
|
|
||||||
pub to: RouteTargetReference,
|
|
||||||
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub wildcard_policy: Option<String>,
|
|
||||||
}
|
|
||||||
impl Default for RouteSpec {
|
|
||||||
fn default() -> RouteSpec {
|
|
||||||
RouteSpec {
|
|
||||||
alternate_backends: None,
|
|
||||||
host: None,
|
|
||||||
http_headers: None,
|
|
||||||
path: None,
|
|
||||||
port: None,
|
|
||||||
subdomain: None,
|
|
||||||
tls: None,
|
|
||||||
to: RouteTargetReference::default(),
|
|
||||||
wildcard_policy: None,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Deserialize, Serialize, Clone, Debug)]
|
|
||||||
#[serde(rename_all = "camelCase")]
|
|
||||||
pub struct RouteTargetReference {
|
|
||||||
pub kind: String,
|
|
||||||
pub name: String,
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub weight: Option<i32>,
|
|
||||||
}
|
|
||||||
impl Default for RouteTargetReference {
|
|
||||||
fn default() -> RouteTargetReference {
|
|
||||||
RouteTargetReference {
|
|
||||||
kind: String::default(),
|
|
||||||
name: String::default(),
|
|
||||||
weight: None,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Deserialize, Serialize, Clone, Debug)]
|
|
||||||
#[serde(rename_all = "camelCase")]
|
|
||||||
pub struct RoutePort {
|
|
||||||
pub target_port: u16,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Deserialize, Serialize, Clone, Debug)]
|
|
||||||
#[serde(rename_all = "camelCase")]
|
|
||||||
pub struct TLSConfig {
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub ca_certificate: Option<String>,
|
|
||||||
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub certificate: Option<String>,
|
|
||||||
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub destination_ca_certificate: Option<String>,
|
|
||||||
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub external_certificate: Option<LocalObjectReference>,
|
|
||||||
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub insecure_edge_termination_policy: Option<String>,
|
|
||||||
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub key: Option<String>,
|
|
||||||
|
|
||||||
pub termination: String,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Default for TLSConfig {
|
|
||||||
fn default() -> Self {
|
|
||||||
Self {
|
|
||||||
ca_certificate: None,
|
|
||||||
certificate: None,
|
|
||||||
destination_ca_certificate: None,
|
|
||||||
external_certificate: None,
|
|
||||||
insecure_edge_termination_policy: None,
|
|
||||||
key: None,
|
|
||||||
termination: "edge".to_string(),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Deserialize, Serialize, Clone, Debug)]
|
|
||||||
#[serde(rename_all = "camelCase")]
|
|
||||||
pub struct RouteStatus {
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub ingress: Option<Vec<RouteIngress>>,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Deserialize, Serialize, Clone, Debug)]
|
|
||||||
#[serde(rename_all = "camelCase")]
|
|
||||||
pub struct RouteIngress {
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub host: Option<String>,
|
|
||||||
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub router_canonical_hostname: Option<String>,
|
|
||||||
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub router_name: Option<String>,
|
|
||||||
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub wildcard_policy: Option<String>,
|
|
||||||
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub conditions: Option<Vec<RouteIngressCondition>>,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Deserialize, Serialize, Clone, Debug)]
|
|
||||||
#[serde(rename_all = "camelCase")]
|
|
||||||
pub struct RouteIngressCondition {
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub last_transition_time: Option<Time>,
|
|
||||||
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub message: Option<String>,
|
|
||||||
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub reason: Option<String>,
|
|
||||||
|
|
||||||
pub status: String,
|
|
||||||
#[serde(rename = "type")]
|
|
||||||
pub condition_type: String,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Deserialize, Serialize, Clone, Debug)]
|
|
||||||
#[serde(rename_all = "camelCase")]
|
|
||||||
pub struct RouteHTTPHeader {
|
|
||||||
pub name: String,
|
|
||||||
pub action: RouteHTTPHeaderActionUnion,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Deserialize, Serialize, Clone, Debug)]
|
|
||||||
#[serde(rename_all = "camelCase")]
|
|
||||||
pub struct RouteHTTPHeaderActionUnion {
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub set: Option<RouteSetHTTPHeader>,
|
|
||||||
|
|
||||||
#[serde(rename = "type")]
|
|
||||||
pub action_type: String,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Deserialize, Serialize, Clone, Debug)]
|
|
||||||
#[serde(rename_all = "camelCase")]
|
|
||||||
pub struct RouteSetHTTPHeader {
|
|
||||||
pub value: String,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Deserialize, Serialize, Clone, Debug, Default)]
|
|
||||||
#[serde(rename_all = "camelCase")]
|
|
||||||
pub struct RouteHTTPHeaderActions {
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub request: Option<Vec<RouteHTTPHeader>>,
|
|
||||||
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub response: Option<Vec<RouteHTTPHeader>>,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Deserialize, Serialize, Clone, Debug)]
|
|
||||||
#[serde(rename_all = "camelCase")]
|
|
||||||
pub struct RouteHTTPHeaders {
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub actions: Option<RouteHTTPHeaderActions>,
|
|
||||||
}
|
|
||||||
@@ -12,7 +12,6 @@ pub mod dns;
|
|||||||
pub mod installation;
|
pub mod installation;
|
||||||
pub mod ipxe;
|
pub mod ipxe;
|
||||||
pub mod load_balancer;
|
pub mod load_balancer;
|
||||||
pub mod route;
|
|
||||||
pub mod templates;
|
pub mod templates;
|
||||||
pub mod upgrade;
|
pub mod upgrade;
|
||||||
pub use bootstrap_01_prepare::*;
|
pub use bootstrap_01_prepare::*;
|
||||||
|
|||||||
@@ -1,101 +0,0 @@
|
|||||||
// TODO
|
|
||||||
// Write OKDRouteScore : This is the real one which will apply the k8s resource and expose all
|
|
||||||
// relevant option to Harmony's various use cases
|
|
||||||
//
|
|
||||||
// Write OKDTlsPassthroughScore : This one will use an OKDRouteScore under the hood and simply fill
|
|
||||||
// in all settings to make this route a TlsPassthrough
|
|
||||||
//
|
|
||||||
// These scores are meant to be used by an OKD based topology to provide Capabilities like
|
|
||||||
// TlsRouter
|
|
||||||
//
|
|
||||||
// The first use case to serve here is the postgresql multisite setup, so exposing only the
|
|
||||||
// settings relevant to this use case is enough at first, following YAGNI.
|
|
||||||
//
|
|
||||||
// These scores are not intended to be used directly by a user, unless the user knows that he will
|
|
||||||
// always be dealing only with okd/openshift compatible topologies and is ready to manage the
|
|
||||||
// additional maintenance burden that comes with a lower level functionnality.
|
|
||||||
|
|
||||||
use harmony_types::rfc1123::Rfc1123Name;
|
|
||||||
use kube::api::ObjectMeta;
|
|
||||||
use serde::Serialize;
|
|
||||||
|
|
||||||
use crate::modules::k8s::resource::K8sResourceScore;
|
|
||||||
use crate::modules::okd::crd::route::{
|
|
||||||
Route, RoutePort, RouteSpec, RouteTargetReference, TLSConfig,
|
|
||||||
};
|
|
||||||
use crate::score::Score;
|
|
||||||
use crate::topology::{K8sclient, TlsRoute, Topology};
|
|
||||||
|
|
||||||
#[derive(Debug, Clone, Serialize)]
|
|
||||||
pub struct OKDRouteScore {
|
|
||||||
pub name: String,
|
|
||||||
pub namespace: String,
|
|
||||||
pub spec: RouteSpec,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl OKDRouteScore {
|
|
||||||
pub fn new(name: &str, namespace: &str, spec: RouteSpec) -> Self {
|
|
||||||
Self {
|
|
||||||
name: name.to_string(),
|
|
||||||
namespace: namespace.to_string(),
|
|
||||||
spec,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<T: Topology + K8sclient> Score<T> for OKDRouteScore {
|
|
||||||
fn create_interpret(&self) -> Box<dyn crate::interpret::Interpret<T>> {
|
|
||||||
let route = Route {
|
|
||||||
metadata: ObjectMeta {
|
|
||||||
name: Some(self.name.clone()),
|
|
||||||
namespace: Some(self.namespace.clone()),
|
|
||||||
..ObjectMeta::default()
|
|
||||||
},
|
|
||||||
spec: self.spec.clone(),
|
|
||||||
..Default::default()
|
|
||||||
};
|
|
||||||
K8sResourceScore::single(route, Some(self.namespace.clone())).create_interpret()
|
|
||||||
}
|
|
||||||
|
|
||||||
fn name(&self) -> String {
|
|
||||||
format!("OKDRouteScore({})", self.name)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Debug, Clone, Serialize)]
|
|
||||||
pub struct OKDTlsPassthroughScore {
|
|
||||||
pub route: TlsRoute,
|
|
||||||
pub name: Rfc1123Name,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<T: Topology + K8sclient> Score<T> for OKDTlsPassthroughScore {
|
|
||||||
fn create_interpret(&self) -> Box<dyn crate::interpret::Interpret<T>> {
|
|
||||||
let passthrough_spec = RouteSpec {
|
|
||||||
host: Some(self.route.hostname.clone()),
|
|
||||||
wildcard_policy: Some("None".to_string()),
|
|
||||||
to: RouteTargetReference {
|
|
||||||
kind: "Service".to_string(),
|
|
||||||
name: self.route.backend.clone(),
|
|
||||||
weight: Some(100),
|
|
||||||
},
|
|
||||||
port: Some(RoutePort {
|
|
||||||
target_port: self.route.target_port,
|
|
||||||
}),
|
|
||||||
tls: Some(TLSConfig {
|
|
||||||
termination: "passthrough".to_string(),
|
|
||||||
insecure_edge_termination_policy: Some("None".to_string()),
|
|
||||||
..Default::default()
|
|
||||||
}),
|
|
||||||
..Default::default()
|
|
||||||
};
|
|
||||||
let route_score = OKDRouteScore::new(&self.name.to_string(), &self.route.namespace, passthrough_spec);
|
|
||||||
route_score.create_interpret()
|
|
||||||
}
|
|
||||||
|
|
||||||
fn name(&self) -> String {
|
|
||||||
format!(
|
|
||||||
"OKDTlsPassthroughScore({}:{}/{} → {})",
|
|
||||||
self.route.backend, self.route.target_port, self.route.namespace, self.route.hostname
|
|
||||||
)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,85 +0,0 @@
|
|||||||
use async_trait::async_trait;
|
|
||||||
use harmony_types::storage::StorageSize;
|
|
||||||
use serde::Serialize;
|
|
||||||
use std::collections::HashMap;
|
|
||||||
|
|
||||||
#[async_trait]
|
|
||||||
pub trait PostgreSQL: Send + Sync {
|
|
||||||
async fn deploy(&self, config: &PostgreSQLConfig) -> Result<String, String>;
|
|
||||||
|
|
||||||
/// Extracts PostgreSQL-specific replication certs (PEM format) from a deployed primary cluster.
|
|
||||||
/// Abstracts away storage/retrieval details (e.g., secrets, files).
|
|
||||||
async fn get_replication_certs(&self, cluster_name: &str) -> Result<ReplicationCerts, String>;
|
|
||||||
|
|
||||||
/// Gets the internal/private endpoint (e.g., k8s service FQDN:5432) for the cluster.
|
|
||||||
async fn get_endpoint(&self, cluster_name: &str) -> Result<PostgreSQLEndpoint, String>;
|
|
||||||
|
|
||||||
/// Gets the public/externally routable endpoint if configured (e.g., OKD Route:443 for TLS passthrough).
|
|
||||||
/// Returns None if no public endpoint (internal-only cluster).
|
|
||||||
/// UNSTABLE: This is opinionated for initial multisite use cases. Networking abstraction is complex
|
|
||||||
/// (cf. k8s Ingress -> Gateway API evolution); may move to higher-order Networking/PostgreSQLNetworking trait.
|
|
||||||
async fn get_public_endpoint(
|
|
||||||
&self,
|
|
||||||
cluster_name: &str,
|
|
||||||
) -> Result<Option<PostgreSQLEndpoint>, String>;
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Clone, Debug, Serialize)]
|
|
||||||
pub struct PostgreSQLConfig {
|
|
||||||
pub cluster_name: String,
|
|
||||||
pub instances: u32,
|
|
||||||
pub storage_size: StorageSize,
|
|
||||||
pub role: PostgreSQLClusterRole,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Clone, Debug, Serialize)]
|
|
||||||
pub enum PostgreSQLClusterRole {
|
|
||||||
Primary,
|
|
||||||
Replica(ReplicaConfig),
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Clone, Debug, Serialize)]
|
|
||||||
pub struct ReplicaConfig {
|
|
||||||
/// Name of the primary cluster this replica will sync from
|
|
||||||
pub primary_cluster_name: String,
|
|
||||||
/// Certs extracted from primary via Topology::get_replication_certs()
|
|
||||||
pub replication_certs: ReplicationCerts,
|
|
||||||
/// Bootstrap method (e.g., pg_basebackup from primary)
|
|
||||||
pub bootstrap: BootstrapConfig,
|
|
||||||
/// External cluster connection details for CNPG spec.externalClusters
|
|
||||||
pub external_cluster: ExternalClusterConfig,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Clone, Debug, Serialize)]
|
|
||||||
pub struct BootstrapConfig {
|
|
||||||
pub strategy: BootstrapStrategy,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Clone, Debug, Serialize)]
|
|
||||||
pub enum BootstrapStrategy {
|
|
||||||
PgBasebackup,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Clone, Debug, Serialize)]
|
|
||||||
pub struct ExternalClusterConfig {
|
|
||||||
/// Name used in CNPG externalClusters list
|
|
||||||
pub name: String,
|
|
||||||
/// Connection params (host/port set by multisite logic, sslmode='verify-ca', etc.)
|
|
||||||
pub connection_parameters: HashMap<String, String>,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Clone, Debug, Serialize)]
|
|
||||||
pub struct ReplicationCerts {
|
|
||||||
/// PEM-encoded CA cert from primary
|
|
||||||
pub ca_cert_pem: String,
|
|
||||||
/// PEM-encoded streaming_replica client cert (tls.crt)
|
|
||||||
pub streaming_replica_cert_pem: String,
|
|
||||||
/// PEM-encoded streaming_replica client key (tls.key)
|
|
||||||
pub streaming_replica_key_pem: String,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Clone, Debug)]
|
|
||||||
pub struct PostgreSQLEndpoint {
|
|
||||||
pub host: String,
|
|
||||||
pub port: u16,
|
|
||||||
}
|
|
||||||
@@ -1,58 +0,0 @@
|
|||||||
use kube::{CustomResource, api::ObjectMeta};
|
|
||||||
use serde::{Deserialize, Serialize};
|
|
||||||
|
|
||||||
#[derive(CustomResource, Deserialize, Serialize, Clone, Debug)]
|
|
||||||
#[kube(
|
|
||||||
group = "postgresql.cnpg.io",
|
|
||||||
version = "v1",
|
|
||||||
kind = "Cluster",
|
|
||||||
plural = "clusters",
|
|
||||||
namespaced = true,
|
|
||||||
schema = "disabled"
|
|
||||||
)]
|
|
||||||
#[serde(rename_all = "camelCase")]
|
|
||||||
pub struct ClusterSpec {
|
|
||||||
pub instances: i32,
|
|
||||||
pub image_name: Option<String>,
|
|
||||||
pub storage: Storage,
|
|
||||||
pub bootstrap: Bootstrap,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Default for Cluster {
|
|
||||||
fn default() -> Self {
|
|
||||||
Cluster {
|
|
||||||
metadata: ObjectMeta::default(),
|
|
||||||
spec: ClusterSpec::default(),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Default for ClusterSpec {
|
|
||||||
fn default() -> Self {
|
|
||||||
Self {
|
|
||||||
instances: 1,
|
|
||||||
image_name: None,
|
|
||||||
storage: Storage::default(),
|
|
||||||
bootstrap: Bootstrap::default(),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Deserialize, Serialize, Clone, Debug, Default)]
|
|
||||||
#[serde(rename_all = "camelCase")]
|
|
||||||
pub struct Storage {
|
|
||||||
pub size: String,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Deserialize, Serialize, Clone, Debug, Default)]
|
|
||||||
#[serde(rename_all = "camelCase")]
|
|
||||||
pub struct Bootstrap {
|
|
||||||
pub initdb: Initdb,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Deserialize, Serialize, Clone, Debug, Default)]
|
|
||||||
#[serde(rename_all = "camelCase")]
|
|
||||||
pub struct Initdb {
|
|
||||||
pub database: String,
|
|
||||||
pub owner: String,
|
|
||||||
}
|
|
||||||
@@ -1,2 +0,0 @@
|
|||||||
mod crd;
|
|
||||||
pub use crd::*;
|
|
||||||
@@ -1,125 +0,0 @@
|
|||||||
use async_trait::async_trait;
|
|
||||||
use log::debug;
|
|
||||||
use log::info;
|
|
||||||
use std::collections::HashMap;
|
|
||||||
|
|
||||||
use crate::{
|
|
||||||
modules::postgresql::capability::{
|
|
||||||
BootstrapConfig, BootstrapStrategy, ExternalClusterConfig, PostgreSQL,
|
|
||||||
PostgreSQLClusterRole, PostgreSQLConfig, PostgreSQLEndpoint, ReplicaConfig,
|
|
||||||
ReplicationCerts,
|
|
||||||
},
|
|
||||||
topology::FailoverTopology,
|
|
||||||
};
|
|
||||||
|
|
||||||
#[async_trait]
|
|
||||||
impl<T: PostgreSQL> PostgreSQL for FailoverTopology<T> {
|
|
||||||
async fn deploy(&self, config: &PostgreSQLConfig) -> Result<String, String> {
|
|
||||||
info!(
|
|
||||||
"Starting deployment of failover topology '{}'",
|
|
||||||
config.cluster_name
|
|
||||||
);
|
|
||||||
|
|
||||||
let primary_config = PostgreSQLConfig {
|
|
||||||
cluster_name: config.cluster_name.clone(),
|
|
||||||
instances: config.instances,
|
|
||||||
storage_size: config.storage_size.clone(),
|
|
||||||
role: PostgreSQLClusterRole::Primary,
|
|
||||||
};
|
|
||||||
|
|
||||||
info!(
|
|
||||||
"Deploying primary cluster '{{}}' ({} instances, {:?} storage)",
|
|
||||||
primary_config.cluster_name, primary_config.storage_size
|
|
||||||
);
|
|
||||||
|
|
||||||
let primary_cluster_name = self.primary.deploy(&primary_config).await?;
|
|
||||||
|
|
||||||
info!("Primary cluster '{primary_cluster_name}' deployed successfully");
|
|
||||||
|
|
||||||
info!("Retrieving replication certificates for primary '{primary_cluster_name}'");
|
|
||||||
|
|
||||||
let certs = self
|
|
||||||
.primary
|
|
||||||
.get_replication_certs(&primary_cluster_name)
|
|
||||||
.await?;
|
|
||||||
|
|
||||||
info!("Replication certificates retrieved successfully");
|
|
||||||
|
|
||||||
info!("Retrieving public endpoint for primary '{primary_cluster_name}");
|
|
||||||
|
|
||||||
let endpoint = self
|
|
||||||
.primary
|
|
||||||
.get_public_endpoint(&primary_cluster_name)
|
|
||||||
.await?
|
|
||||||
.ok_or_else(|| "No public endpoint configured on primary cluster".to_string())?;
|
|
||||||
|
|
||||||
info!(
|
|
||||||
"Public endpoint '{}:{}' retrieved for primary",
|
|
||||||
endpoint.host, endpoint.port
|
|
||||||
);
|
|
||||||
|
|
||||||
info!("Configuring replica connection parameters and bootstrap");
|
|
||||||
|
|
||||||
let mut connection_parameters = HashMap::new();
|
|
||||||
connection_parameters.insert("host".to_string(), endpoint.host);
|
|
||||||
connection_parameters.insert("port".to_string(), endpoint.port.to_string());
|
|
||||||
connection_parameters.insert("dbname".to_string(), "postgres".to_string());
|
|
||||||
connection_parameters.insert("user".to_string(), "streaming_replica".to_string());
|
|
||||||
connection_parameters.insert("sslmode".to_string(), "verify-ca".to_string());
|
|
||||||
connection_parameters.insert("sslnegotiation".to_string(), "direct".to_string());
|
|
||||||
|
|
||||||
debug!("Replica connection parameters: {:?}", connection_parameters);
|
|
||||||
|
|
||||||
let external_cluster = ExternalClusterConfig {
|
|
||||||
name: primary_cluster_name.clone(),
|
|
||||||
connection_parameters,
|
|
||||||
};
|
|
||||||
|
|
||||||
let bootstrap_config = BootstrapConfig {
|
|
||||||
strategy: BootstrapStrategy::PgBasebackup,
|
|
||||||
};
|
|
||||||
|
|
||||||
let replica_cluster_config = ReplicaConfig {
|
|
||||||
primary_cluster_name: primary_cluster_name.clone(),
|
|
||||||
replication_certs: certs,
|
|
||||||
bootstrap: bootstrap_config,
|
|
||||||
external_cluster,
|
|
||||||
};
|
|
||||||
|
|
||||||
let replica_config = PostgreSQLConfig {
|
|
||||||
cluster_name: format!("{}-replica", primary_cluster_name),
|
|
||||||
instances: config.instances,
|
|
||||||
storage_size: config.storage_size.clone(),
|
|
||||||
role: PostgreSQLClusterRole::Replica(replica_cluster_config),
|
|
||||||
};
|
|
||||||
|
|
||||||
info!(
|
|
||||||
"Deploying replica cluster '{}' ({} instances, {:?} storage) on replica topology",
|
|
||||||
replica_config.cluster_name, replica_config.instances, replica_config.storage_size
|
|
||||||
);
|
|
||||||
|
|
||||||
self.replica.deploy(&replica_config).await?;
|
|
||||||
|
|
||||||
info!(
|
|
||||||
"Replica cluster '{}' deployed successfully; failover topology '{}' ready",
|
|
||||||
replica_config.cluster_name, config.cluster_name
|
|
||||||
);
|
|
||||||
|
|
||||||
Ok(primary_cluster_name)
|
|
||||||
}
|
|
||||||
|
|
||||||
async fn get_replication_certs(&self, cluster_name: &str) -> Result<ReplicationCerts, String> {
|
|
||||||
self.primary.get_replication_certs(cluster_name).await
|
|
||||||
}
|
|
||||||
|
|
||||||
async fn get_endpoint(&self, cluster_name: &str) -> Result<PostgreSQLEndpoint, String> {
|
|
||||||
self.primary.get_endpoint(cluster_name).await
|
|
||||||
}
|
|
||||||
|
|
||||||
async fn get_public_endpoint(
|
|
||||||
&self,
|
|
||||||
cluster_name: &str,
|
|
||||||
) -> Result<Option<PostgreSQLEndpoint>, String> {
|
|
||||||
self.primary.get_public_endpoint(cluster_name).await
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
pub mod capability;
|
|
||||||
mod score;
|
|
||||||
pub use score::*;
|
|
||||||
mod score_public;
|
|
||||||
pub use score_public::*;
|
|
||||||
|
|
||||||
pub mod failover;
|
|
||||||
mod operator;
|
|
||||||
pub use operator::*;
|
|
||||||
|
|
||||||
pub mod cnpg;
|
|
||||||
@@ -1,102 +0,0 @@
|
|||||||
use k8s_openapi::apimachinery::pkg::apis::meta::v1::ObjectMeta;
|
|
||||||
use serde::Serialize;
|
|
||||||
|
|
||||||
use crate::interpret::Interpret;
|
|
||||||
use crate::modules::k8s::apps::crd::{Subscription, SubscriptionSpec};
|
|
||||||
use crate::modules::k8s::resource::K8sResourceScore;
|
|
||||||
use crate::score::Score;
|
|
||||||
use crate::topology::{K8sclient, Topology};
|
|
||||||
|
|
||||||
/// Install the CloudNativePg (CNPG) Operator via an OperatorHub `Subscription`.
|
|
||||||
///
|
|
||||||
/// This Score creates a a `Subscription` Custom Resource in the specified namespace.
|
|
||||||
///
|
|
||||||
/// The default implementation pulls the `cloudnative-pg` operator from the
|
|
||||||
/// `operatorhubio-catalog` source.
|
|
||||||
///
|
|
||||||
/// # Goals
|
|
||||||
/// - Deploy the CNPG Operator to manage PostgreSQL clusters in OpenShift/OKD environments.
|
|
||||||
///
|
|
||||||
/// # Usage
|
|
||||||
/// ```
|
|
||||||
/// use harmony::modules::postgresql::CloudNativePgOperatorScore;
|
|
||||||
/// let score = CloudNativePgOperatorScore::default();
|
|
||||||
/// ```
|
|
||||||
///
|
|
||||||
/// Or, you can take control of most relevant fiedls this way :
|
|
||||||
///
|
|
||||||
/// ```
|
|
||||||
/// use harmony::modules::postgresql::CloudNativePgOperatorScore;
|
|
||||||
///
|
|
||||||
/// let score = CloudNativePgOperatorScore {
|
|
||||||
/// namespace: "custom-cnpg-namespace".to_string(),
|
|
||||||
/// channel: "unstable-i-want-bleedingedge-v498437".to_string(),
|
|
||||||
/// install_plan_approval: "Manual".to_string(),
|
|
||||||
/// source: "operatorhubio-catalog-but-different".to_string(),
|
|
||||||
/// source_namespace: "i-customize-everything-marketplace".to_string(),
|
|
||||||
/// };
|
|
||||||
/// ```
|
|
||||||
///
|
|
||||||
/// # Limitations
|
|
||||||
/// - **OperatorHub dependency**: Requires OperatorHub catalog sources (e.g., `operatorhubio-catalog` in `openshift-marketplace`).
|
|
||||||
/// - **OKD/OpenShift assumption**: Catalog/source names and namespaces are hardcoded for OKD-like setups; adjust for upstream OpenShift.
|
|
||||||
/// - **Hardcoded values in Default implementation**: Operator name (`cloudnative-pg`), channel (`stable-v1`), automatic install plan approval.
|
|
||||||
/// - **No config options**: Does not support custom `SubscriptionConfig` (env vars, node selectors, tolerations).
|
|
||||||
/// - **Single namespace**: Targets one namespace per score instance.
|
|
||||||
#[derive(Debug, Clone, Serialize)]
|
|
||||||
pub struct CloudNativePgOperatorScore {
|
|
||||||
pub namespace: String,
|
|
||||||
pub channel: String,
|
|
||||||
pub install_plan_approval: String,
|
|
||||||
pub source: String,
|
|
||||||
pub source_namespace: String,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Default for CloudNativePgOperatorScore {
|
|
||||||
fn default() -> Self {
|
|
||||||
Self {
|
|
||||||
namespace: "openshift-operators".to_string(),
|
|
||||||
channel: "stable-v1".to_string(),
|
|
||||||
install_plan_approval: "Automatic".to_string(),
|
|
||||||
source: "operatorhubio-catalog".to_string(),
|
|
||||||
source_namespace: "openshift-marketplace".to_string(),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl CloudNativePgOperatorScore {
|
|
||||||
pub fn new(namespace: &str) -> Self {
|
|
||||||
Self {
|
|
||||||
namespace: namespace.to_string(),
|
|
||||||
..Default::default()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<T: Topology + K8sclient> Score<T> for CloudNativePgOperatorScore {
|
|
||||||
fn create_interpret(&self) -> Box<dyn Interpret<T>> {
|
|
||||||
let metadata = ObjectMeta {
|
|
||||||
name: Some("cloudnative-pg".to_string()),
|
|
||||||
namespace: Some(self.namespace.clone()),
|
|
||||||
..ObjectMeta::default()
|
|
||||||
};
|
|
||||||
|
|
||||||
let spec = SubscriptionSpec {
|
|
||||||
channel: Some(self.channel.clone()),
|
|
||||||
config: None,
|
|
||||||
install_plan_approval: Some(self.install_plan_approval.clone()),
|
|
||||||
name: "cloudnative-pg".to_string(),
|
|
||||||
source: self.source.clone(),
|
|
||||||
source_namespace: self.source_namespace.clone(),
|
|
||||||
starting_csv: None,
|
|
||||||
};
|
|
||||||
|
|
||||||
let subscription = Subscription { metadata, spec };
|
|
||||||
|
|
||||||
K8sResourceScore::single(subscription, Some(self.namespace.clone())).create_interpret()
|
|
||||||
}
|
|
||||||
|
|
||||||
fn name(&self) -> String {
|
|
||||||
format!("CloudNativePgOperatorScore({})", self.namespace)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,93 +0,0 @@
|
|||||||
use serde::Serialize;
|
|
||||||
|
|
||||||
use crate::interpret::Interpret;
|
|
||||||
use crate::modules::k8s::resource::K8sResourceScore;
|
|
||||||
use crate::modules::postgresql::cnpg::{Bootstrap, Cluster, ClusterSpec, Initdb, Storage};
|
|
||||||
use crate::score::Score;
|
|
||||||
use crate::topology::{K8sclient, Topology};
|
|
||||||
use k8s_openapi::apimachinery::pkg::apis::meta::v1::ObjectMeta;
|
|
||||||
|
|
||||||
/// Deploys an opinionated, highly available PostgreSQL cluster managed by CNPG.
|
|
||||||
///
|
|
||||||
/// # Goals
|
|
||||||
/// - Production-ready Postgres HA (3 instances), persistent storage, app DB.
|
|
||||||
///
|
|
||||||
/// # Usage
|
|
||||||
/// ```
|
|
||||||
/// use harmony::modules::postgresql::PostgreSQLScore;
|
|
||||||
/// let score = PostgreSQLScore::new("my-app-ns");
|
|
||||||
/// ```
|
|
||||||
///
|
|
||||||
/// # Limitations (Happy Path)
|
|
||||||
/// - Requires CNPG operator installed (use CloudNativePgOperatorScore).
|
|
||||||
/// - No backups, monitoring, extensions configured.
|
|
||||||
///
|
|
||||||
/// TODO : refactor this to declare a clean dependency on cnpg operator. Then cnpg operator will
|
|
||||||
/// self-deploy either using operatorhub or helm chart depending on k8s flavor. This is cnpg
|
|
||||||
/// specific behavior
|
|
||||||
#[derive(Debug, Clone, Serialize)]
|
|
||||||
pub struct PostgreSQLScore {
|
|
||||||
pub name: String,
|
|
||||||
/// **Note :** on OpenShfit based clusters, the namespace `default` has security
|
|
||||||
/// settings incompatible with the default CNPG behavior.
|
|
||||||
pub namespace: String,
|
|
||||||
pub instances: i32,
|
|
||||||
pub storage_size: String,
|
|
||||||
pub image_name: Option<String>,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Default for PostgreSQLScore {
|
|
||||||
fn default() -> Self {
|
|
||||||
Self {
|
|
||||||
name: "harmony-pg".to_string(),
|
|
||||||
// We are using the namespace harmony by default since some clusters (openshift family)
|
|
||||||
// have incompatible configuration of the default namespace with cnpg
|
|
||||||
namespace: "harmony".to_string(),
|
|
||||||
instances: 1,
|
|
||||||
storage_size: "1Gi".to_string(),
|
|
||||||
image_name: None, // This lets cnpg use its default image
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl PostgreSQLScore {
|
|
||||||
pub fn new(namespace: &str) -> Self {
|
|
||||||
Self {
|
|
||||||
namespace: namespace.to_string(),
|
|
||||||
..Default::default()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<T: Topology + K8sclient> Score<T> for PostgreSQLScore {
|
|
||||||
fn create_interpret(&self) -> Box<dyn Interpret<T>> {
|
|
||||||
let metadata = ObjectMeta {
|
|
||||||
name: Some(self.name.clone()),
|
|
||||||
namespace: Some(self.namespace.clone()),
|
|
||||||
..ObjectMeta::default()
|
|
||||||
};
|
|
||||||
|
|
||||||
let spec = ClusterSpec {
|
|
||||||
instances: self.instances,
|
|
||||||
image_name: self.image_name.clone(),
|
|
||||||
storage: Storage {
|
|
||||||
size: self.storage_size.clone(),
|
|
||||||
},
|
|
||||||
bootstrap: Bootstrap {
|
|
||||||
initdb: Initdb {
|
|
||||||
database: "app".to_string(),
|
|
||||||
owner: "app".to_string(),
|
|
||||||
},
|
|
||||||
},
|
|
||||||
..ClusterSpec::default()
|
|
||||||
};
|
|
||||||
|
|
||||||
let cluster = Cluster { metadata, spec };
|
|
||||||
|
|
||||||
K8sResourceScore::single(cluster, Some(self.namespace.clone())).create_interpret()
|
|
||||||
}
|
|
||||||
|
|
||||||
fn name(&self) -> String {
|
|
||||||
format!("PostgreSQLScore({})", self.namespace)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,100 +0,0 @@
|
|||||||
use async_trait::async_trait;
|
|
||||||
use harmony_types::id::Id;
|
|
||||||
use serde::Serialize;
|
|
||||||
|
|
||||||
use crate::data::Version;
|
|
||||||
use crate::domain::topology::router::{TlsRoute, TlsRouter};
|
|
||||||
use crate::interpret::{Interpret, InterpretError, InterpretName, InterpretStatus, Outcome};
|
|
||||||
use crate::inventory::Inventory;
|
|
||||||
use crate::modules::postgresql::PostgreSQLScore;
|
|
||||||
use crate::score::Score;
|
|
||||||
use crate::topology::{K8sclient, Topology};
|
|
||||||
|
|
||||||
/// Deploys a public PostgreSQL cluster: CNPG + TLS passthrough route for RW endpoint.
|
|
||||||
/// For failover/multisite: exposes single-instance or small HA Postgres publicly.
|
|
||||||
///
|
|
||||||
/// Sequence: PostgreSQLScore → TlsRouter::install_route (RW backend).
|
|
||||||
///
|
|
||||||
/// # Usage
|
|
||||||
/// ```
|
|
||||||
/// use harmony::modules::postgresql::PublicPostgreSQLScore;
|
|
||||||
/// let score = PublicPostgreSQLScore::new("harmony", "pg-rw.example.com");
|
|
||||||
/// ```
|
|
||||||
#[derive(Debug, Clone, Serialize)]
|
|
||||||
pub struct PublicPostgreSQLScore {
|
|
||||||
/// Inner non-public Postgres cluster config.
|
|
||||||
pub postgres_score: PostgreSQLScore,
|
|
||||||
/// Public hostname for RW TLS passthrough (port 443 → cluster-rw:5432).
|
|
||||||
pub hostname: String,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl PublicPostgreSQLScore {
|
|
||||||
pub fn new(namespace: &str, hostname: &str) -> Self {
|
|
||||||
Self {
|
|
||||||
postgres_score: PostgreSQLScore::new(namespace),
|
|
||||||
hostname: hostname.to_string(),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Custom interpret: deploy Postgres then install public TLS route.
|
|
||||||
#[derive(Debug, Clone)]
|
|
||||||
struct PublicPostgreSQLInterpret {
|
|
||||||
postgres_score: PostgreSQLScore,
|
|
||||||
tls_route: TlsRoute,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[async_trait]
|
|
||||||
impl<T: Topology + K8sclient + TlsRouter + Send + Sync> Interpret<T> for PublicPostgreSQLInterpret {
|
|
||||||
fn get_name(&self) -> InterpretName {
|
|
||||||
InterpretName::Custom("PublicPostgreSQLInterpret")
|
|
||||||
}
|
|
||||||
fn get_version(&self) -> Version {
|
|
||||||
todo!()
|
|
||||||
}
|
|
||||||
fn get_status(&self) -> InterpretStatus {
|
|
||||||
todo!()
|
|
||||||
}
|
|
||||||
fn get_children(&self) -> Vec<Id> {
|
|
||||||
todo!()
|
|
||||||
}
|
|
||||||
async fn execute(&self, inventory: &Inventory, topo: &T) -> Result<Outcome, InterpretError> {
|
|
||||||
// Deploy CNPG cluster first (creates -rw service)
|
|
||||||
self.postgres_score.interpret(inventory, topo).await?;
|
|
||||||
|
|
||||||
// Expose RW publicly via TLS passthrough
|
|
||||||
topo.install_route(self.tls_route.clone())
|
|
||||||
.await
|
|
||||||
.map_err(|e| InterpretError::new(e))?;
|
|
||||||
|
|
||||||
Ok(Outcome::success(format!(
|
|
||||||
"Public CNPG cluster '{}' deployed with TLS passthrough route '{}'",
|
|
||||||
self.postgres_score.name.clone(),
|
|
||||||
self.tls_route.hostname
|
|
||||||
)))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<T: Topology + K8sclient + TlsRouter + Send + Sync> Score<T> for PublicPostgreSQLScore {
|
|
||||||
fn create_interpret(&self) -> Box<dyn Interpret<T>> {
|
|
||||||
let rw_backend = format!("{}-rw", self.postgres_score.name);
|
|
||||||
let tls_route = TlsRoute {
|
|
||||||
namespace: self.postgres_score.namespace.clone(),
|
|
||||||
hostname: self.hostname.clone(),
|
|
||||||
backend: rw_backend,
|
|
||||||
target_port: 5432,
|
|
||||||
};
|
|
||||||
|
|
||||||
Box::new(PublicPostgreSQLInterpret {
|
|
||||||
postgres_score: self.postgres_score.clone(),
|
|
||||||
tls_route,
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
fn name(&self) -> String {
|
|
||||||
format!(
|
|
||||||
"PublicPostgreSQLScore({}:{})",
|
|
||||||
self.postgres_score.namespace, self.hostname
|
|
||||||
)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,5 +1,3 @@
|
|||||||
pub mod id;
|
pub mod id;
|
||||||
pub mod net;
|
pub mod net;
|
||||||
pub mod storage;
|
|
||||||
pub mod switch;
|
pub mod switch;
|
||||||
pub mod rfc1123;
|
|
||||||
|
|||||||
@@ -1,232 +0,0 @@
|
|||||||
/// A String that can be used as a subdomain.
|
|
||||||
///
|
|
||||||
/// This means the name must:
|
|
||||||
///
|
|
||||||
/// - contain no more than 253 characters
|
|
||||||
/// - contain only lowercase alphanumeric characters, '-' or '.'
|
|
||||||
/// - start with an alphanumeric character
|
|
||||||
/// - end with an alphanumeric character
|
|
||||||
///
|
|
||||||
/// https://datatracker.ietf.org/doc/html/rfc1123
|
|
||||||
///
|
|
||||||
/// This is relevant in harmony since most k8s resource names are required to be usable as dns
|
|
||||||
/// subdomains.
|
|
||||||
///
|
|
||||||
/// See https://kubernetes.io/docs/concepts/overview/working-with-objects/names/
|
|
||||||
#[derive(Debug, Clone)]
|
|
||||||
pub struct Rfc1123Name {
|
|
||||||
content: String,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl TryFrom<&str> for Rfc1123Name {
|
|
||||||
fn try_from(s: &str) -> Result<Self, String> {
|
|
||||||
let mut content = s.to_lowercase();
|
|
||||||
|
|
||||||
// Remove invalid characters
|
|
||||||
content.retain(|c| c.is_ascii_alphanumeric() || c == '-' || c == '.');
|
|
||||||
|
|
||||||
// Enforce max length
|
|
||||||
if content.len() > 253 {
|
|
||||||
content.truncate(253);
|
|
||||||
}
|
|
||||||
|
|
||||||
// Trim leading/trailing dots
|
|
||||||
content = content.trim_matches('.').to_string();
|
|
||||||
|
|
||||||
// Deduplicate consecutive dots
|
|
||||||
loop {
|
|
||||||
let new_content = content.replace("..", ".");
|
|
||||||
if new_content == content {
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
content = new_content;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Trim leading/trailing non-alphanumeric
|
|
||||||
content = content.trim_matches(|c: char| !c.is_ascii_alphanumeric()).to_string();
|
|
||||||
|
|
||||||
if content.is_empty() {
|
|
||||||
return Err(format!("Input '{}' resulted in empty string", s));
|
|
||||||
}
|
|
||||||
|
|
||||||
Ok(Self { content })
|
|
||||||
}
|
|
||||||
|
|
||||||
type Error = String;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/// Converts an `Rfc1123Name` into a `String`.
|
|
||||||
///
|
|
||||||
/// This allows using `Rfc1123Name` in contexts where a `String` is expected.
|
|
||||||
impl From<Rfc1123Name> for String {
|
|
||||||
fn from(name: Rfc1123Name) -> Self {
|
|
||||||
name.content
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Serializes the `Rfc1123Name` as a string.
|
|
||||||
///
|
|
||||||
/// This directly serializes the inner `String` content without additional wrapping.
|
|
||||||
impl serde::Serialize for Rfc1123Name {
|
|
||||||
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
|
|
||||||
where
|
|
||||||
S: serde::Serializer,
|
|
||||||
{
|
|
||||||
serializer.serialize_str(&self.content)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Deserializes an `Rfc1123Name` from a string.
|
|
||||||
///
|
|
||||||
/// This directly deserializes into the inner `String` content without additional wrapping.
|
|
||||||
impl<'de> serde::Deserialize<'de> for Rfc1123Name {
|
|
||||||
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
|
|
||||||
where
|
|
||||||
D: serde::Deserializer<'de>,
|
|
||||||
{
|
|
||||||
let content = String::deserialize(deserializer)?;
|
|
||||||
Ok(Self { content })
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Displays the `Rfc1123Name` as a string.
|
|
||||||
///
|
|
||||||
/// This directly displays the inner `String` content without additional wrapping.
|
|
||||||
impl std::fmt::Display for Rfc1123Name {
|
|
||||||
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
|
||||||
write!(f, "{}", self.content)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
#[cfg(test)]
|
|
||||||
mod tests {
|
|
||||||
use super::Rfc1123Name;
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_try_from_empty() {
|
|
||||||
let name = Rfc1123Name::try_from("");
|
|
||||||
assert!(name.is_err());
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_try_from_valid() {
|
|
||||||
let name = Rfc1123Name::try_from("hello-world").unwrap();
|
|
||||||
assert_eq!(name.content, "hello-world");
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_try_from_uppercase() {
|
|
||||||
let name = Rfc1123Name::try_from("Hello-World").unwrap();
|
|
||||||
assert_eq!(name.content, "hello-world");
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_try_from_invalid_chars() {
|
|
||||||
let name = Rfc1123Name::try_from("hel@lo#w!or%ld123").unwrap();
|
|
||||||
assert_eq!(name.content, "helloworld123");
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_try_from_leading_dot() {
|
|
||||||
let name = Rfc1123Name::try_from(".hello").unwrap();
|
|
||||||
assert_eq!(name.content, "hello");
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_try_from_trailing_dot() {
|
|
||||||
let name = Rfc1123Name::try_from("hello.").unwrap();
|
|
||||||
assert_eq!(name.content, "hello");
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_try_from_leading_hyphen() {
|
|
||||||
let name = Rfc1123Name::try_from("-hello").unwrap();
|
|
||||||
assert_eq!(name.content, "hello");
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_try_from_complicated_string() {
|
|
||||||
let name = Rfc1123Name::try_from("--h--e,}{}12!$#)\np_aulbS\r\t.!@o--._--").unwrap();
|
|
||||||
assert_eq!(name.content, "h--e12paulbs.o");
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_try_from_trailing_hyphen() {
|
|
||||||
let name = Rfc1123Name::try_from("hello-").unwrap();
|
|
||||||
assert_eq!(name.content, "hello");
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_try_from_single_hyphen() {
|
|
||||||
let name = Rfc1123Name::try_from("-");
|
|
||||||
assert!(name.is_err());
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_from_str() {
|
|
||||||
let name: Rfc1123Name = "test-name".try_into().unwrap();
|
|
||||||
assert_eq!(name.content, "test-name");
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_into_string() {
|
|
||||||
let name = Rfc1123Name::try_from("test").unwrap();
|
|
||||||
let s: String = name.into();
|
|
||||||
assert_eq!(s, "test");
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_compliance() {
|
|
||||||
let inputs = vec![
|
|
||||||
"valid",
|
|
||||||
"in-VALID",
|
|
||||||
".dots",
|
|
||||||
"-hyphen",
|
|
||||||
"hyphen-",
|
|
||||||
"!!1@",
|
|
||||||
"aaaaaaaaaa",
|
|
||||||
"--abc--",
|
|
||||||
"a.b-c",
|
|
||||||
];
|
|
||||||
|
|
||||||
for input in inputs {
|
|
||||||
let name = Rfc1123Name::try_from(input).unwrap();
|
|
||||||
let s = &name.content;
|
|
||||||
// Check only allowed characters
|
|
||||||
for c in s.chars() {
|
|
||||||
assert!(c.is_ascii_alphanumeric() || c == '-' || c == '.');
|
|
||||||
}
|
|
||||||
// Check starts and ends with alphanumeric
|
|
||||||
if !s.is_empty() {
|
|
||||||
assert!(s.chars().next().unwrap().is_ascii_alphanumeric());
|
|
||||||
assert!(s.chars().last().unwrap().is_ascii_alphanumeric());
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_enforces_max_length() {
|
|
||||||
let long_input = "a".repeat(300);
|
|
||||||
let name = Rfc1123Name::try_from(long_input.as_str()).unwrap();
|
|
||||||
assert_eq!(name.content.len(), 253);
|
|
||||||
assert_eq!(name.content, "a".repeat(253));
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_truncate_trim_end() {
|
|
||||||
let input = "a".repeat(252) + "-";
|
|
||||||
let name = Rfc1123Name::try_from(input.as_str()).unwrap();
|
|
||||||
assert_eq!(name.content.len(), 252);
|
|
||||||
assert_eq!(name.content, "a".repeat(252));
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_dedup_dots() {
|
|
||||||
let input = "a..b...c";
|
|
||||||
let name = Rfc1123Name::try_from(input).unwrap();
|
|
||||||
assert_eq!(name.content, "a.b.c");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
@@ -1,6 +0,0 @@
|
|||||||
use serde::{Deserialize, Serialize};
|
|
||||||
|
|
||||||
#[derive(Copy, Clone, PartialEq, Eq, Hash, Serialize, Deserialize, PartialOrd, Ord, Debug)]
|
|
||||||
pub struct StorageSize {
|
|
||||||
size_bytes: u64,
|
|
||||||
}
|
|
||||||
Reference in New Issue
Block a user