eksup 0.14.0

A CLI to aid in upgrading Amazon EKS clusters
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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227

use anyhow::{Context, Result};
use aws_sdk_eks::types::Cluster;
use serde::{Deserialize, Serialize};

use crate::{
  clients::{AwsClients, K8sClients},
  eks,
  finding::Findings,
  k8s, version,
};

/// Container of all findings collected
#[derive(Debug, Serialize, Deserialize)]
pub struct Results {
  pub cluster: eks::ClusterFindings,
  pub subnets: eks::SubnetFindings,
  pub data_plane: eks::DataPlaneFindings,
  pub addons: eks::AddonFindings,
  pub kubernetes: k8s::KubernetesFindings,
  #[serde(rename = "suppressed")]
  pub kubernetes_suppressed: k8s::KubernetesSuppressed,
  pub service_limits: eks::ServiceLimitFindings,
  pub insights: eks::InsightsFindings,
}

impl Results {
  /// Remove all findings where remediation is `Recommended`, keeping only `Required`
  pub fn filter_recommended(&mut self) {
    self
      .cluster
      .cluster_health
      .retain(|f| !f.finding.remediation.is_recommended());
    self
      .subnets
      .control_plane_ips
      .retain(|f| !f.finding.remediation.is_recommended());
    self.subnets.pod_ips.retain(|f| !f.finding.remediation.is_recommended());
    self.addons.health.retain(|f| !f.finding.remediation.is_recommended());
    self
      .addons
      .version_compatibility
      .retain(|f| !f.finding.remediation.is_recommended());
    self
      .data_plane
      .eks_managed_nodegroup_health
      .retain(|f| !f.finding.remediation.is_recommended());
    self
      .data_plane
      .eks_managed_nodegroup_update
      .retain(|f| !f.finding.remediation.is_recommended());
    self
      .data_plane
      .self_managed_nodegroup_update
      .retain(|f| !f.finding.remediation.is_recommended());
    self
      .data_plane
      .al2_ami_deprecation
      .retain(|f| !f.finding.remediation.is_recommended());
    self
      .data_plane
      .node_ips
      .retain(|f| !f.finding.remediation.is_recommended());
    self
      .kubernetes
      .version_skew
      .retain(|f| !f.finding.remediation.is_recommended());
    self
      .kubernetes
      .min_replicas
      .retain(|f| !f.finding.remediation.is_recommended());
    self
      .kubernetes
      .min_ready_seconds
      .retain(|f| !f.finding.remediation.is_recommended());
    self
      .kubernetes
      .pod_topology_distribution
      .retain(|f| !f.finding.remediation.is_recommended());
    self
      .kubernetes
      .readiness_probe
      .retain(|f| !f.finding.remediation.is_recommended());
    self
      .kubernetes
      .termination_grace_period
      .retain(|f| !f.finding.remediation.is_recommended());
    self
      .kubernetes
      .docker_socket
      .retain(|f| !f.finding.remediation.is_recommended());
    self
      .kubernetes
      .kube_proxy_version_skew
      .retain(|f| !f.finding.remediation.is_recommended());
    self
      .kubernetes
      .kube_proxy_ipvs_mode
      .retain(|f| !f.finding.remediation.is_recommended());
    self
      .kubernetes
      .ingress_nginx_retirement
      .retain(|f| !f.finding.remediation.is_recommended());
    self
      .kubernetes
      .pod_disruption_budgets
      .retain(|f| !f.finding.remediation.is_recommended());
    self
      .service_limits
      .ec2_limits
      .retain(|f| !f.finding.remediation.is_recommended());
    self
      .service_limits
      .ebs_gp2_limits
      .retain(|f| !f.finding.remediation.is_recommended());
    self
      .service_limits
      .ebs_gp3_limits
      .retain(|f| !f.finding.remediation.is_recommended());
    self
      .insights
      .upgrade_readiness
      .retain(|f| !f.finding.remediation.is_recommended());
    self
      .insights
      .misconfiguration
      .retain(|f| !f.finding.remediation.is_recommended());
  }

  /// Renders all findings as a formatted stdout table string
  pub fn to_stdout_table(&self, show_suppressed: bool) -> Result<String> {
    use std::fmt::Write;

    let mut output = String::new();

    output.push_str(&self.subnets.pod_ips.to_stdout_table()?);
    output.push_str(&self.subnets.control_plane_ips.to_stdout_table()?);
    output.push_str(&self.cluster.cluster_health.to_stdout_table()?);
    output.push_str(&self.data_plane.eks_managed_nodegroup_health.to_stdout_table()?);
    output.push_str(&self.addons.health.to_stdout_table()?);
    output.push_str(&self.addons.version_compatibility.to_stdout_table()?);
    output.push_str(&self.data_plane.eks_managed_nodegroup_update.to_stdout_table()?);
    output.push_str(&self.data_plane.self_managed_nodegroup_update.to_stdout_table()?);
    output.push_str(&self.data_plane.al2_ami_deprecation.to_stdout_table()?);
    output.push_str(&self.data_plane.node_ips.to_stdout_table()?);
    output.push_str(&self.kubernetes.version_skew.to_stdout_table()?);
    output.push_str(&self.kubernetes.min_replicas.to_stdout_table()?);
    output.push_str(&self.kubernetes.min_ready_seconds.to_stdout_table()?);
    output.push_str(&self.kubernetes.pod_topology_distribution.to_stdout_table()?);
    output.push_str(&self.kubernetes.readiness_probe.to_stdout_table()?);
    output.push_str(&self.kubernetes.termination_grace_period.to_stdout_table()?);
    output.push_str(&self.kubernetes.docker_socket.to_stdout_table()?);
    output.push_str(&self.kubernetes.kube_proxy_version_skew.to_stdout_table()?);
    output.push_str(&self.kubernetes.kube_proxy_ipvs_mode.to_stdout_table()?);
    output.push_str(&self.kubernetes.ingress_nginx_retirement.to_stdout_table()?);
    output.push_str(&self.kubernetes.pod_disruption_budgets.to_stdout_table()?);
    output.push_str(&self.service_limits.ec2_limits.to_stdout_table()?);
    output.push_str(&self.service_limits.ebs_gp2_limits.to_stdout_table()?);
    output.push_str(&self.service_limits.ebs_gp3_limits.to_stdout_table()?);
    output.push_str(&self.insights.upgrade_readiness.to_stdout_table()?);
    output.push_str(&self.insights.misconfiguration.to_stdout_table()?);

    let suppressed_total = self.kubernetes_suppressed.total();
    if suppressed_total > 0 {
      if show_suppressed {
        writeln!(output, "\nSuppressed by .eksup.yaml ({suppressed_total}):")?;
        output.push_str(&self.kubernetes_suppressed.min_replicas.to_stdout_table()?);
        output.push_str(&self.kubernetes_suppressed.min_ready_seconds.to_stdout_table()?);
        output.push_str(&self.kubernetes_suppressed.readiness_probe.to_stdout_table()?);
        output.push_str(&self.kubernetes_suppressed.pod_topology_distribution.to_stdout_table()?);
        output.push_str(&self.kubernetes_suppressed.termination_grace_period.to_stdout_table()?);
        output.push_str(&self.kubernetes_suppressed.docker_socket.to_stdout_table()?);
        output.push_str(&self.kubernetes_suppressed.ingress_nginx_retirement.to_stdout_table()?);
        output.push_str(&self.kubernetes_suppressed.pod_disruption_budgets.to_stdout_table()?);
      } else {
        writeln!(
          output,
          "\n{suppressed_total} findings suppressed by .eksup.yaml (use --show-suppressed to view)"
        )?;
      }
    }

    Ok(output)
  }
}

/// Analyze the cluster provided to collect all reported findings
pub async fn analyze(
  aws: &impl AwsClients,
  k8s: &impl K8sClients,
  cluster: &Cluster,
  target_minor: i32,
  config: &crate::config::Config,
) -> Result<Results> {
  let cluster_name = cluster.name().context("Cluster name missing from API response")?;
  let cluster_version = cluster.version().context("Cluster version missing from API response")?;
  let control_plane_minor = version::parse_minor(cluster_version)?;

  let cluster_findings = eks::get_cluster_findings(cluster)?;

  let (
    subnet_findings,
    addon_findings,
    dataplane_findings,
    kubernetes_result,
    service_limit_findings,
    insights_findings,
  ) = tokio::try_join!(
    eks::get_subnet_findings(aws, k8s, cluster),
    eks::get_addon_findings(aws, cluster_name, cluster_version, target_minor),
    eks::get_data_plane_findings(aws, cluster, target_minor),
    k8s::get_kubernetes_findings(k8s, control_plane_minor, target_minor, &config.checks),
    eks::get_service_limit_findings(aws),
    eks::get_insights_findings(aws, cluster_name),
  )?;
  let (kubernetes_findings, kubernetes_suppressed) = kubernetes_result;

  Ok(Results {
    cluster: cluster_findings,
    subnets: subnet_findings,
    addons: addon_findings,
    data_plane: dataplane_findings,
    kubernetes: kubernetes_findings,
    kubernetes_suppressed,
    service_limits: service_limit_findings,
    insights: insights_findings,
  })
}