cf-nodes-registry 0.1.3

Nodes registry module
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109

use uuid::Uuid;

/// Node response DTO
#[modkit_macros::api_dto(request, response)]
pub struct NodeDto {
    pub id: Uuid,
    pub hostname: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub ip_address: Option<String>,
    pub created_at: chrono::DateTime<chrono::Utc>,
    pub updated_at: chrono::DateTime<chrono::Utc>,
    /// System information (included when details=true)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub sysinfo: Option<NodeSysInfoDto>,
    /// System capabilities (included when details=true)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub syscap: Option<NodeSysCapDto>,
}

/// System information response DTO
#[modkit_macros::api_dto(request, response)]
pub struct NodeSysInfoDto {
    pub node_id: uuid::Uuid,
    pub os: OsInfoDto,
    pub cpu: CpuInfoDto,
    pub memory: MemoryInfoDto,
    pub host: HostInfoDto,
    pub gpus: Vec<GpuInfoDto>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub battery: Option<BatteryInfoDto>,
    pub collected_at: chrono::DateTime<chrono::Utc>,
}

#[modkit_macros::api_dto(request, response)]
pub struct OsInfoDto {
    pub name: String,
    pub version: String,
    pub arch: String,
}

#[modkit_macros::api_dto(request, response)]
pub struct CpuInfoDto {
    pub model: String,
    pub num_cpus: u32,
    pub cores: u32,
    pub frequency_mhz: f64,
}

#[modkit_macros::api_dto(request, response)]
pub struct MemoryInfoDto {
    pub total_bytes: u64,
    pub available_bytes: u64,
    pub used_bytes: u64,
    pub used_percent: u32,
}

#[modkit_macros::api_dto(request, response)]
pub struct HostInfoDto {
    pub hostname: String,
    pub uptime_seconds: u64,
    /// All detected IP addresses. The first one is the primary IP (used for default route).
    pub ip_addresses: Vec<String>,
}

#[modkit_macros::api_dto(request, response)]
pub struct GpuInfoDto {
    pub model: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub cores: Option<u32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub total_memory_mb: Option<f64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub used_memory_mb: Option<f64>,
}

#[modkit_macros::api_dto(request, response)]
pub struct BatteryInfoDto {
    pub on_battery: bool,
    pub percentage: u32,
}

/// System capabilities response DTO
#[modkit_macros::api_dto(request, response)]
pub struct NodeSysCapDto {
    pub node_id: uuid::Uuid,
    pub capabilities: Vec<SysCapDto>,
    pub collected_at: chrono::DateTime<chrono::Utc>,
}

#[modkit_macros::api_dto(request, response)]
pub struct SysCapDto {
    pub key: String,
    pub category: String,
    pub name: String,
    pub display_name: String,
    pub present: bool,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub version: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub amount: Option<f64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub amount_dimension: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub details: Option<String>,
    /// Cache TTL in seconds
    pub cache_ttl_secs: u64,
    /// When this capability was last fetched (Unix timestamp in seconds)
    pub fetched_at_secs: i64,
}