This content is part of a third party extension that is not supported by the Cake project. For more information about this extension see Cake.Kubectl.

Summary

Dump cluster information out suitable for debugging and diagnosing cluster problems. By default, dumps everything to stdout. You can optionally specify a directory with --output-directory. If you specify a directory, Kubernetes will build a set of files in that directory. By default, only dumps things in the current namespace and 'kube-system' namespace, but you can switch to a different namespace with the --namespaces flag, or specify --all-namespaces to dump all namespaces. The command also dumps the logs of all of the pods in the cluster; these logs are dumped into different directories based on namespace and pod name.

Assembly

Cake.Kubectl.dll

Namespace

Cake.Kubectl

Base Types

ToolSettings
AutoToolSettings

graph BT Type-->Base0["AutoToolSettings"] click Base0 "/api/Cake.Kubectl/AutoToolSettings" Base0-->Base1["ToolSettings"] Type["KubectlClusterInfoDumpSettings"] class Type type-node

Syntax

public sealed class KubectlClusterInfoDumpSettings : AutoToolSettings

Examples

# Dump current cluster state to stdout kubectl cluster-info dump # Dump current cluster state to /path/to/cluster-state kubectl cluster-info dump --output-directory=/path/to/cluster-state # Dump all namespaces to stdout kubectl cluster-info dump --all-namespaces # Dump a set of namespaces to /path/to/cluster-state kubectl cluster-info dump --namespaces default,kube-system --output-directory=/path/to/cluster-state

Attributes

Type	Description
NullableContextAttribute
NullableAttribute
CompilerGeneratedAttribute

Constructors

Name	Summary
KubectlClusterInfoDumpSettings()

Properties

Name	Value	Summary
AllNamespaces	Nullable<bool>	-A, --all-namespaces If true, dump all namespaces. If true, --namespaces is ignored.
AllowMissingTemplateKeys	Nullable<bool>	--allow-missing-template-keys If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.
Namespaces	string	--namespaces A comma separated list of namespaces to dump.
Output	string	-o, --output Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).
OutputDirectory	string	--output-directory Where to output the files. If empty or '-' uses stdout, otherwise creates a directory hierarchy in that directory
PodRunningTimeout	string	--pod-running-timeout The length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running
ShowManagedFields	Nullable<bool>	--show-managed-fields If true, keep the managedFields when printing objects in JSON or YAML format.
Template	string	--template Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].

Extension Methods

Name	Value	Summary
Dump<KubectlClusterInfoDumpSettings>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<KubectlClusterInfoDumpSettings>(KubectlClusterInfoDumpSettings[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<KubectlClusterInfoDumpSettings>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<KubectlClusterInfoDumpSettings>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
ThrowIfNull<KubectlClusterInfoDumpSettings>(string, string)	T	Throws a `System.ArgumentNullException` with a specific message if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ThrowIfNull<KubectlClusterInfoDumpSettings>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin