Kubernetes Clusters Automation

Kubernetes Container Automation

#340840

Description

This resource is used to return container recommendations for Kubernetes cluster which have been selected for automation via the UI.

Resources

/kubernetes/clusters/<clusterName>/automation

Supported Operations

Table: Kubernetes Container Systems Supported Operations

HTTP Method

Input

Output

Description

GET /
kubernetes/clusters/<clusterName>/containers

Path Parameter:

ClusterName

Collection of:

Use this resource to retrieve details of container recommendation for a specific Kubernetes cluster.

Parameters

Path Parameters

Table: Kubernetes Clusters Path Parameters

Parameter Name

Type

Description

ClusterName

string

The unique cluster name obtained from the output of /kubernetes/clusters or from the Kubex UI Connections tab.

Response

If a property or value is not set or not available, it is not included in the response.

Table: Kubernetes Container Response Schema

Element

Type

Filter/Sort

Description

cluster

string

 

The cluster name as specified in the config.yaml files.

namespace

string

 

The name of the namespace associated with the selected container.

podOwnerName

string

 

This is the name of the controller or pod. You can have one or more containers per pod.

podOwnerKind

string

 

The controller type that monitors and maintains the state of your cluster. This can be one of DaemonSet, Deployment, ReplicaSet, ReplicationController, StatefulSet, etc.

container

string

 

This is the name of the container manifest.

entityId

string

 

A unique identifier, for the selected cluster assigned by Densify.

containerId

string

 

A unique identifier for the listed container.

avgContainerCount

integer

 

This is the number of containers specified by the selected manifest. The number is determined using an average number of containers, based on the metric, "In Service Instances".

currentCpuRequestmCores

integer

 

The current CPU request value for the listed container.

currentCpuLimitmCores

integer

 

The current CPU limit value for the listed container.

currentMemRequestBytes

integer

 

The current memory request value for the listed container.

currentMemLimitBytes

integer

 

The current memory limit value for the listed container.

recommendedCpuRequestmCores

integer

 

The recommended CPU request value for the listed container.

recommendedCpuLimitmCores

integer

 

The recommended CPU limit value for the listed container.

recommendedMemRequestBytes

integer

 

The recommended memory request value for the listed container.

recommendedMemLimitBytes

integer

 

The recommended memory limit value for the selected container.

estimatedSavingsPerContainer

integer

 

The estimated savings that can be achieved by using the recommended CPU and memory settings for this container.

analyzedOn

date

 

The date and time of the most recent analysis refresh, in the format: YYYY-MM-DDTHH:mm:ssZ

kubexAutomation

string

 

Indicates whether automation has been enabled for this cluster.

automationPolicy

string

 

The number of node groups discovered in this cluster.

hpaMetricName

string

 

Indicates the metric used to trigger autoscaling.

hpaMetricThreshold

string

 

Indicates the metric threshold value used to trigger autoscaling.

Table: Kubernetes Container Response Schema - Additional Details

Element

Type

Filter/Sort

Description

predictedUptime

string

 

The predicted uptime (%) for the container, is based on the percentage of hours CPU utilization data is present in the historical interval, as specified in the policy settings for the entity.

configLastChangedOn

date

 

A value in this column indicates the instance request/limit values have been changed recently. The date and time are in the format: YYYY-MM-DDTHH:mm:ssZ.

The workload for this instance, on which the recommendation is based, includes all historical data for this instance and is not included in the analysis.

nodeGroup

string

 

This is the name of the associated node group.

oomKills_last7days

string

 

The number of out of memory (oom) events that occurred in the last 7 days.

dateFirstAudited

date

 

The date and time on which this container was last audited, in the format: YYYY-MM-DDTHH:mm:ssZ. The value is from the workload history instead of the audit history, which may be truncated.

dateLastAudited

date

 

The date and time on which this container was first audited, in the format: YYYY-MM-DDTHH:mm:ssZ. The value is from the workload history instead of the audit history, which may be truncated.

Examples

Example: Listing Kubernetes Clusters with Containers Enabled for Automation

The following example shows you how to retrieve cluster details for containers that have been enabled for automation.