K8sSummary: ClusterSummary
  • 07 Nov 2024
  • 7 Minutes to read
  • Contributors
  • Dark
    Light

K8sSummary: ClusterSummary

  • Dark
    Light

Article summary

This model describes summary information about a Kubernetes Cluster

Example:

{
    "metadata": {
        "id": "f99e055f-b35d-208b-63b1-f4222b80151a",
        "name": "realtheory-cluster-01",
        "timestamp": "2024-07-15T14:07:22.7005109Z"
    },
    "version": "v1.27.13",
    "url": "https://10.222.0.1:443/api/v1",
    "nodePools": [
       {
         "name": "nodepool-0",
         "instanceType": "Standard_B4ms",
         "architecture": "amd64",
         "os": "linux",
         "size": 2
       }
    ],
    "properties": {
        "cloud.provider": "Azure",
        "cloud.region": "westus2",
        "cloud.zone": "0",
        "name": "MC_realtheory-cluster-01_westus2"
    },
    "manifest": {
        "nodeCount": 10,
        "nodeReadyCount": 10,
        "namespaceCount": 14,
        "namespaceActiveCount": 14,
        "serviceCount": 98,
        "deploymentCount": 97,
        "replicaSetCount": 212,
        "daemonSetCount": 9,
        "statefulSetCount": 0,
        "jobCount": 0,
        "cronJobCount": 0,
        "podCount": 335,
        "podReadyCount": 324,
        "containerCount": 382,
        "containerReadyCount": 371
    },
    "metrics": {
        "cpuUsage": 6330,
        "cpuRequest": 34680,
        "cpuLimit": 36000,
        "cpuPercentage": 18.252596,
        "memoryUsage": 73900856,
        "memoryRequest": 112350688,
        "memoryLimit": 145192416,
        "memoryPercentage": 65.77695,
        "rxUsage": 37922268623,
        "rxErrors": 0,
        "txUsage": 13694367204,
        "txErrors": 0
    },
    "cost": {
        "totalCost": {
            "lastHour": 1.81215,
            "lastHourCoverage": "1h/1h",
            "lastDay": 40.89905,
            "lastDayCoverage": "24h/24h",
            "lastWeek": 255.66683,
            "lastWeekCoverage": "7d/7d",
            "lastMonth": 255.66683,
            "lastMonthCoverage": "7d/31d",
            "lastYear": 255.66683,
            "lastYearCoverage": "7d/365d"
        },
        "idleCost": {
            "lastHour": 1.34627,
            "lastHourCoverage": "1h/1h",
            "lastDay": 29.19303,
            "lastDayCoverage": "24h/24h",
            "lastWeek": 182.5253,
            "lastWeekCoverage": "7d/7d",
            "lastMonth": 182.5253,
            "lastMonthCoverage": "7d/31d",
            "lastYear": 182.5253,
            "lastYearCoverage": "7d/365d"
        },
        "cpuUtilization": 15.72,
        "memoryUtilization": 65.7,
        "utilization": 40.71,
        "effectiveUtilization": 67.85,
        "efficiency": 21.72
    },
    "resources": {
        "allocatables": {
            "cpu": "34680m",
            "ephemeral-storage": "1197030553670",
            "hugepages-1Gi": "0",
            "hugepages-2Mi": "0",
            "memory": "112350688Ki",
            "pods": "1100"
        },
        "capacities": {
            "cpu": "36",
            "ephemeral-storage": "1298861280Ki",
            "hugepages-1Gi": "0",
            "hugepages-2Mi": "0",
            "memory": "145192416Ki",
            "pods": "1100"
        }
    },
    "synopsis": {
        "healthScore": 100,
        "performanceScore": 60,
        "governanceScore": 80,
        "costScore": 100,
        "aggregateScores": {
            "health": 50,
            "performance": 50,
            "governance": 50,
            "cost": 30
        },
        "alertCount": 5,
        "aggregateAlerts": {
            "critical": 240,
            "high": 839,
            "normal": 760,
            "total": 1839
        },
        "recommendationCount": 4,
        "aggregateRecommendations": {
            "high": 10,
            "medium": 14,
            "low": 436,
            "total": 460
        }
    }
}

where:

  • metadata
    • id: Represents the ID of the Cluster.
    • name: Represents the external name of the Cluster.
    • timestamp: Represents the timestamp of the record.
  • version: Indicates the version of the cluster
  • url: Indicates the URL of cluster.
  • nodePools:
    • name: Represents the name of a node pool.
    • instanceType: Represents the instance type associated with the node pool.
    • architecture: Represents the processor architecture associated with the node pool.
    • os: Represents the operating system associated with the node pool.
    • size: Indicates the number of nodes within the node pool.
  • properties
    • cloud.provider: Represents the name of the cloud provider where the cluster is hosted.
    • cloud.region: Represents the name of the cloud region where the cluster is hosted.
    • cloud.zone: Represents the name or designation of the zone where the cluster is hosted.
    • name: Represent the cloud provider's internal name of the cluster.
  • manifest
    • nodeCount: Indicates the total number of Kubernetes Nodes in the cluster.
    • nodeReadyCount: Indicates the number of Kubernetes Nodes that are currently ready in the cluster.
    • namespaceCount: Indicates the total number of Kubernetes Namespaces in the cluster.
    • namespaceActiveCount: Indicates the number of active Kubernetes Namespaces in the cluster.
    • serviceCount: Indicates the total number of Kubernetes Services present in the cluster.
    • deploymentCount: Indicates the number of Kubernetes Deployments deployed in the cluster.
    • replicaSetCount: Indicates the number of Kubernetes ReplicaSets deployed in the cluster.
    • daemonSetCount: Indicates the number of Kubernetes DaemonSets deployed within the cluster.
    • statefulSetCount: Indicates the number of Kubernetes StatefulSets deployed within the cluster.
    • jobCount: Indicates the number of Kubernetes Jobs deployed within the cluster.
    • cronJobCount: Indicates the number of Kubernetes CronJobs deployed within the cluster.
    • podCount: Indicates the number of Kubernetes Pods deployed within the cluster.
    • podReadyCount: Indicates the number of Kubernetes Pods currently ready in the cluster
    • containerCount: Indicates the number of containers deployed within the cluster.
    • containerReadyCount: Indicates the number of Containers currently ready in the cluster.
  • metrics
    • cpuUsage: Indicates the current CPU usage of the Cluster in millicores (m).
    • cpuRequest: Represents the amount of allocatable CPU within the Cluster in millicores (m).
    • cpuLimit: Represents the total CPU capacity of the Cluster in millicores (m).
    • cpuPercentage: Indicates the current CPU usage percentage of the Cluster.
    • memoryUsage: Indicates the current memory usage of the Cluster in kibibytes (KiB).
    • memoryRequest: Represents the amount of allocatable memory within the Cluster in kibibytes (KiB).
    • memoryLimit: Represents the total memory capacity of the Cluster in kibibytes (KiB).
    • memoryPercentage: Indicates the current memory usage percentage of the cluster.
    • rxUsage: Indicates the cumulative count of data received by the Cluster in kibibytes (KiB).
    • rxErrors: Indicates the cumulative count of received errors encountered by the Cluster in kibibytes (KiB).
    • txUsage: Indicates the cumulative count of data transmitted by the Cluster in kibibytes (KiB).
    • txErrors: Indicates the cumulative count of transmit errors encountered by the Cluster in kibibytes (KiB).
  • cost
    • totalCost
      • lastHour: Indicates the total cost of the Cluster over the last hour in USD.
      • lastHourCoverage: Indicates the cost coverage over the last hour.
      • lastDay: Indicates the total cost of the Cluster over the last 24 hours in USD.
      • lastDayCoverage: Indicates the cost coverage over the last 24 hours.
      • lastWeek: Indicates the total cost of the Cluster over the last 7 days in USD.
      • lastWeekCoverage: Indicates the cost coverage over the last 7 days.
      • lastMonth: Indicates the total cost of the Cluster over the last 31 days in USD.
      • lastMonthCoverage: Indicates the cost coverage over the last 31 days.
      • lastYear: Indicates the total cost of the Cluster over the last 365 days in USD.
      • lastYearCoverge: Indicates the cost coverage over the last 365 days.
    • idleCost
      • lastHour: Indicates the non-utilized cost of the Cluster over the last hour in USD.
      • lastHourCoverage: Indicates the non-utilized cost coverage over the last hour.
      • lastDay: Indicates the non-utilized cost of the Cluster over the last 24 hours in USD.
      • lastDayCoverage: Indicates the non-utilized cost coverage over the last 24 hours.
      • lastWeek: Indicates the non-utilized cost of the Cluster over the last 7 days in USD.
      • lastWeekCoverage: Indicates the non-utilized cost coverage over the last 7 days.
      • lastMonth: Indicates the non-utilized cost of the Cluster over the last 31 days in USD.
      • lastMonthCoverage: Indicates the non-utilized cost coverage over the last 31 days.
      • lastYear: Indicates the non-utilized cost of the Cluster over the last 365 days in USD.
      • lastYearCoverge: Indicates the non-utilized cost coverage over the last 365 days.
    • cpuUtilization: Indicates the Cluster's current CPU utilization.
    • memoryUtilization: Indicates the Cluster's current memory utilization.
    • utilization: Indicates the Cluster's overall utilization.
    • effectiveUtilization: Indicates the Cluster's effective utilization, which is scaled version of overall utilization. Note: This field is deprecated.
    • efficency: Indicates the Cluster's overall resources efficiency, which is cost weighted version of utilization that reflects that CPU, GPU and memory all cost different amounts.
  • synopsis
    • healthScore: Denotes the Cluster's individual health score, rated on a scale from 0 to 100, with 0 being the worst and 100 being the best.
    • performanceScore: Denotes the Cluster's individual performance score, rated on a scale from 0 to 100, with 0 being the worst and 100 being the best.
    • costScore: Denotes the Cluster's individual cost score, rated on a scale from 0 to 100, with 0 being the worst and 100 being the best.
    • governanceScore: Denotes the Cluster's individual governance score, rated on a scale from 0 to 100, with 0 being the worst and 100 being the best.
    • aggregatedScores
      • healthScore: Denotes the Cluster's overall health score, an aggregate of the scores of all objects within the cluster, rated on a scale from 0 to 100, where 0 is the worst and 100 is the best.
      • performanceScore: Denotes the Cluster's overall performance score, an aggregate of the scores of all objects within the cluster, rated on a scale from 0 to 100, where 0 is the worst and 100 is the best.
      • costScore: Denotes the Cluster's overall cost score, an aggregate of the scores of all objects within the cluster, rated on a scale from 0 to 100, where 0 is the worst and 100 is the best.
      • governanceScore: Denotes the Cluster's overall governance score, an aggregate of the scores of all objects within the cluster, rated on a scale from 0 to 100, where 0 is the worst and 100 is the best.
    • alertCount: Shows the total number of Alerts linked to the Cluster.
    • aggregatedAlerts
      • critical: Shows the total number of critical Alerts associated with the Cluster and all objects within it.
      • high: Shows the total number of high Alerts associated with the Cluster and all objects within it.
      • normal: Shows the total number of normal Alerts associated with the Cluster and all objects within it.
      • total: Shows the overall number of Alerts, including critical, high, and normal, associated with the Cluster and all objects within it.
    • recommendationCount: Shows the total number of Recommendations linked to the Cluster.
    • aggregatedRecommendations
      • high: Shows the total number of high Recommendations associated with the Cluster and all objects within it.
      • medium: Shows the total number of medium Recommendations associated with the Cluster and all objects within it.
      • low: Shows the total number of low Recommendations associated with the Cluster and all objects within it.
      • total: Shows the overall number of Recommendations, including nigh, medium, and low, associated with the Cluster and all objects within it.
  • resources
    • allocatables
      • cpu: Represents the amount of allocatable CPU within the Cluster in millicores (m).
      • memory: Represents the amount of allocatable memory within the Cluster in kibibytes (KiB).
      • ephemeral-storage: Represents the amount of allocatable ephemeral storage within the Cluster in kibibytes (KiB).
      • pods: Represents the number of allocatable pods within the Cluster.
    • capacity
      • cpu: Represents the total CPU capacity of the Cluster in millicores (m)
      • memory: Represents the total memory capacity of the Cluster in kibibytes (KiB).
      • ephemeral-storage: Represents the total capacity of ephemeral storage of the Clusters in kibibytes (KiB)
      • pods: Represents the maximum numbers of pods that can run within the Cluster.

Was this article helpful?