syncable-cli 0.37.1

A Rust-based CLI that analyzes code repositories and generates Infrastructure as Code configurations
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

//! K8S-OPT-006: Memory request exceeds threshold for workload type.

use super::{OptimizationRule, RuleContext, codes};
use crate::analyzer::k8s_optimize::config::K8sOptimizeConfig;
use crate::analyzer::k8s_optimize::parser::parse_memory_to_bytes;
use crate::analyzer::k8s_optimize::types::{
    OptimizationIssue, ResourceRecommendation, ResourceSpec, RuleCode, Severity, WorkloadType,
};

/// Rule: Memory request exceeds threshold.
pub struct HighMemoryRequestRule;

impl OptimizationRule for HighMemoryRequestRule {
    fn code(&self) -> &'static str {
        codes::HIGH_MEMORY_REQUEST
    }

    fn description(&self) -> &'static str {
        "Memory request exceeds threshold for workload type"
    }

    fn default_severity(&self) -> Severity {
        Severity::High
    }

    fn check(
        &self,
        ctx: &RuleContext,
        config: &K8sOptimizeConfig,
    ) -> Option<ResourceRecommendation> {
        // Exclude database/ML workloads from this check (they legitimately need more memory)
        if matches!(
            ctx.workload_type,
            WorkloadType::Database | WorkloadType::MachineLearning
        ) {
            return None;
        }

        let memory_request = ctx.current.memory_request.as_ref()?;
        let bytes = parse_memory_to_bytes(memory_request)?;
        let mi = bytes / (1024 * 1024);

        // Check if exceeds threshold
        if mi <= config.max_memory_request_mi as u64 {
            return None;
        }

        let defaults = ctx.workload_type.default_resources();
        let recommended = ResourceSpec {
            cpu_request: None,
            cpu_limit: None,
            memory_request: Some(defaults.memory_request.to_string()),
            memory_limit: Some(defaults.memory_limit.to_string()),
        };

        Some(ResourceRecommendation {
            resource_kind: ctx.resource_kind.clone(),
            resource_name: ctx.resource_name.clone(),
            namespace: ctx.namespace.clone(),
            container: ctx.container_name.clone(),
            file_path: ctx.file_path.clone(),
            line: ctx.line,
            issue: OptimizationIssue::OverProvisioned,
            severity: self.default_severity(),
            message: format!(
                "Memory request ({}) exceeds {}Mi threshold for {} workload. This is likely over-provisioned.",
                memory_request, config.max_memory_request_mi, ctx.workload_type
            ),
            workload_type: ctx.workload_type,
            current: ctx.current.clone(),
            actual_usage: None,
            recommended: recommended.clone(),
            savings: None,
            fix_yaml: recommended.to_yaml(),
            rule_code: RuleCode::new(self.code()),
        })
    }
}