KubectlTopPodSettings Class

Summary

Display Resource (CPU/Memory/Storage) usage of pods. The 'top pod' command allows you to see the resource consumption of pods. Due to the metrics pipeline delay, they may be unavailable for a few minutes since pod creation.
Assembly
Cake.Kubectl.dll
Namespace
Cake.Kubectl
Base Types
graph BT Type-->Base0["AutoToolSettings"] click Base0 "/api/Cake.Kubectl/AutoToolSettings" Base0-->Base1["ToolSettings"] Type["KubectlTopPodSettings"] class Type type-node

Syntax

public sealed class KubectlTopPodSettings : AutoToolSettings

Examples

# Show metrics for all pods in the default namespace kubectl top pod # Show metrics for all pods in the given namespace kubectl top pod --namespace=NAMESPACE # Show metrics for a given pod and its containers kubectl top pod POD_NAME --containers # Show metrics for the pods defined by label name=myLabel kubectl top pod -l name=myLabel

Attributes

Type Description
CompilerGeneratedAttribute

Constructors

Properties

Name Value Summary
AllNamespaces Nullable<bool>
-A, --all-namespaces If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace.
Containers Nullable<bool>
--containers If present, print usage of containers within a pod.
HeapsterNamespace string
--heapster-namespace Namespace Heapster service is located in
HeapsterPort string
--heapster-port Port name in service to use
HeapsterScheme string
--heapster-scheme Scheme (http or https) to connect to Heapster as
HeapsterService string
--heapster-service Name of Heapster service
NoHeaders Nullable<bool>
--no-headers If present, print output without headers.
Selector string
-l, --selector Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2)

Extension Methods

Name Value Summary
Dump<KubectlTopPodSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<KubectlTopPodSettings>(KubectlTopPodSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<KubectlTopPodSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<KubectlTopPodSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<KubectlTopPodSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<KubectlTopPodSettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin