describe

type CSINodeDescriber ¶

type CSINodeDescriber struct {
	clientset.Interface
}

func (c *CSINodeDescriber) Describe(namespace, name string, describerSettings DescriberSettings) (string, error)

type CertificateSigningRequestDescriber ¶

type CertificateSigningRequestDescriber struct {
	// contains filtered or unexported fields
}

func (p *CertificateSigningRequestDescriber) Describe(namespace, name string, describerSettings DescriberSettings) (string, error)

type ClusterRoleBindingDescriber ¶

type ClusterRoleBindingDescriber struct {
	clientset.Interface
}

ClusterRoleBindingDescriber generates information about a node.

func (d *ClusterRoleBindingDescriber) Describe(namespace, name string, describerSettings DescriberSettings) (string, error)

type ClusterRoleDescriber ¶

type ClusterRoleDescriber struct {
	clientset.Interface
}

ClusterRoleDescriber generates information about a node.

func (d *ClusterRoleDescriber) Describe(namespace, name string, describerSettings DescriberSettings) (string, error)

type ConfigMapDescriber ¶

type ConfigMapDescriber struct {
	clientset.Interface
}

ConfigMapDescriber generates information about a ConfigMap

func (d *ConfigMapDescriber) Describe(namespace, name string, describerSettings DescriberSettings) (string, error)

type CronJobDescriber ¶

type CronJobDescriber struct {
	// contains filtered or unexported fields
}

CronJobDescriber generates information about a cron job and the jobs it has created.

func (d *CronJobDescriber) Describe(namespace, name string, describerSettings DescriberSettings) (string, error)

type DaemonSetDescriber ¶

type DaemonSetDescriber struct {
	clientset.Interface
}

DaemonSetDescriber generates information about a daemon set and the pods it has created.

func (d *DaemonSetDescriber) Describe(namespace, name string, describerSettings DescriberSettings) (string, error)

type DeploymentDescriber ¶

type DeploymentDescriber struct {
	// contains filtered or unexported fields
}

DeploymentDescriber generates information about a deployment.

func (dd *DeploymentDescriber) Describe(namespace, name string, describerSettings DescriberSettings) (string, error)

type DescriberFunc ¶

type DescriberFunc func(restClientGetter genericclioptions.RESTClientGetter, mapping *meta.RESTMapping) (ResourceDescriber, error)

DescriberFunc gives a way to display the specified RESTMapping type

var (

	// DescriberFn gives a way to easily override the function for unit testing if needed
	DescriberFn DescriberFunc = Describer
)

type DescriberSettings ¶

type DescriberSettings struct {
	ShowEvents bool
	ChunkSize  int64
}

DescriberSettings holds display configuration for each object describer to control what is printed.

type Describers ¶

type Describers struct {
	// contains filtered or unexported fields
}

Describers implements ObjectDescriber against functions registered via Add. Those functions can be strongly typed. Types are exactly matched (no conversion or assignable checks).

func (d *Describers) Add(fns ...interface{}) error

func(...) (string, error)

func (d *Describers) DescribeObject(exact interface{}, extra ...interface{}) (string, error)

type EndpointSliceDescriber ¶

type EndpointSliceDescriber struct {
	clientset.Interface
}

EndpointSliceDescriber generates information about an EndpointSlice.

func (d *EndpointSliceDescriber) Describe(namespace, name string, describerSettings DescriberSettings) (string, error)

type EndpointsDescriber ¶

type EndpointsDescriber struct {
	clientset.Interface
}

EndpointsDescriber generates information about an Endpoint.

func (d *EndpointsDescriber) Describe(namespace, name string, describerSettings DescriberSettings) (string, error)

type EnvVarResolverFunc ¶

type EnvVarResolverFunc func(e corev1.EnvVar) string

func EnvValueRetriever(pod *corev1.Pod) EnvVarResolverFunc

type ErrNoDescriber ¶

type ErrNoDescriber struct {
	Types []string
}

ErrNoDescriber is a structured error indicating the provided object or objects cannot be described.

func (e ErrNoDescriber) Error() string

type HorizontalPodAutoscalerDescriber ¶

type HorizontalPodAutoscalerDescriber struct {
	// contains filtered or unexported fields
}

HorizontalPodAutoscalerDescriber generates information about a horizontal pod autoscaler.

func (d *HorizontalPodAutoscalerDescriber) Describe(namespace, name string, describerSettings DescriberSettings) (string, error)

type IngressClassDescriber ¶

type IngressClassDescriber struct {
	// contains filtered or unexported fields
}

func (i *IngressClassDescriber) Describe(namespace, name string, describerSettings DescriberSettings) (string, error)

type IngressDescriber ¶

type IngressDescriber struct {
	// contains filtered or unexported fields
}

func (i *IngressDescriber) Describe(namespace, name string, describerSettings DescriberSettings) (string, error)

type JobDescriber ¶

type JobDescriber struct {
	clientset.Interface
}

JobDescriber generates information about a job and the pods it has created.

func (d *JobDescriber) Describe(namespace, name string, describerSettings DescriberSettings) (string, error)

type LeaseDescriber ¶

type LeaseDescriber struct {
	// contains filtered or unexported fields
}

type LimitRangeDescriber ¶

type LimitRangeDescriber struct {
	clientset.Interface
}

LimitRangeDescriber generates information about a limit range

func (d *LimitRangeDescriber) Describe(namespace, name string, describerSettings DescriberSettings) (string, error)

type NamespaceDescriber ¶

type NamespaceDescriber struct {
	clientset.Interface
}

NamespaceDescriber generates information about a namespace

func (d *NamespaceDescriber) Describe(namespace, name string, describerSettings DescriberSettings) (string, error)

type NetworkPolicyDescriber ¶

type NetworkPolicyDescriber struct {
	clientset.Interface
}

NetworkPolicyDescriber generates information about a networkingv1.NetworkPolicy

func (d *NetworkPolicyDescriber) Describe(namespace, name string, describerSettings DescriberSettings) (string, error)

type NodeDescriber ¶

type NodeDescriber struct {
	clientset.Interface
}

NodeDescriber generates information about a node.

func (d *NodeDescriber) Describe(namespace, name string, describerSettings DescriberSettings) (string, error)

type ObjectDescriber ¶

type ObjectDescriber interface {
	DescribeObject(object interface{}, extra ...interface{}) (output string, err error)
}

ObjectDescriber is an interface for displaying arbitrary objects with extra information. Use when an object is in hand (on disk, or already retrieved). Implementers may ignore the additional information passed on extra, or use it by default. ObjectDescribers may return ErrNoDescriber if no suitable describer is found.

var DefaultObjectDescriber ObjectDescriber

type PersistentVolumeClaimDescriber ¶

type PersistentVolumeClaimDescriber struct {
	clientset.Interface
}

func (d *PersistentVolumeClaimDescriber) Describe(namespace, name string, describerSettings DescriberSettings) (string, error)

type PersistentVolumeDescriber ¶

type PersistentVolumeDescriber struct {
	clientset.Interface
}

func (d *PersistentVolumeDescriber) Describe(namespace, name string, describerSettings DescriberSettings) (string, error)

type PodDescriber ¶

type PodDescriber struct {
	clientset.Interface
}

PodDescriber generates information about a pod and the replication controllers that create it.

func (d *PodDescriber) Describe(namespace, name string, describerSettings DescriberSettings) (string, error)

type PodDisruptionBudgetDescriber ¶

type PodDisruptionBudgetDescriber struct {
	clientset.Interface
}

func (p *PodDisruptionBudgetDescriber) Describe(namespace, name string, describerSettings DescriberSettings) (string, error)

type PodSecurityPolicyDescriber ¶

type PodSecurityPolicyDescriber struct {
	clientset.Interface
}

PodSecurityPolicyDescriber generates information about a PodSecuritypolicyv1beta1.

func (d *PodSecurityPolicyDescriber) Describe(namespace, name string, describerSettings DescriberSettings) (string, error)

type PrefixWriter ¶

type PrefixWriter interface {
	// Write writes text with the specified indentation level.
	Write(level int, format string, a ...interface{})
	// WriteLine writes an entire line with no indentation level.
	WriteLine(a ...interface{})
	// Flush forces indentation to be reset.
	Flush()
}

PrefixWriter can write text at various indentation levels.

func NewNestedPrefixWriter(out PrefixWriter, indent int) PrefixWriter

func NewPrefixWriter(out io.Writer) PrefixWriter

type PriorityClassDescriber ¶

type PriorityClassDescriber struct {
	clientset.Interface
}

PriorityClassDescriber generates information about a PriorityClass.

func (s *PriorityClassDescriber) Describe(namespace, name string, describerSettings DescriberSettings) (string, error)

type ReplicaSetDescriber ¶

type ReplicaSetDescriber struct {
	clientset.Interface
}

ReplicaSetDescriber generates information about a ReplicaSet and the pods it has created.

func (d *ReplicaSetDescriber) Describe(namespace, name string, describerSettings DescriberSettings) (string, error)

type ReplicationControllerDescriber ¶

type ReplicationControllerDescriber struct {
	clientset.Interface
}

ReplicationControllerDescriber generates information about a replication controller and the pods it has created.

func (d *ReplicationControllerDescriber) Describe(namespace, name string, describerSettings DescriberSettings) (string, error)

type ResourceDescriber ¶

type ResourceDescriber interface {
	Describe(namespace, name string, describerSettings DescriberSettings) (output string, err error)
}

ResourceDescriber generates output for the named resource or an error if the output could not be generated. Implementers typically abstract the retrieval of the named object from a remote server.

func Describer(restClientGetter genericclioptions.RESTClientGetter, mapping *meta.RESTMapping) (ResourceDescriber, error)

func DescriberFor(kind schema.GroupKind, clientConfig *rest.Config) (ResourceDescriber, bool)

func GenericDescriberFor(mapping *meta.RESTMapping, clientConfig *rest.Config) (ResourceDescriber, bool)

type ResourceQuotaDescriber ¶

type ResourceQuotaDescriber struct {
	clientset.Interface
}

ResourceQuotaDescriber generates information about a resource quota

func (d *ResourceQuotaDescriber) Describe(namespace, name string, describerSettings DescriberSettings) (string, error)

type RoleBindingDescriber ¶

type RoleBindingDescriber struct {
	clientset.Interface
}

RoleBindingDescriber generates information about a node.

func (d *RoleBindingDescriber) Describe(namespace, name string, describerSettings DescriberSettings) (string, error)

type RoleDescriber ¶

type RoleDescriber struct {
	clientset.Interface
}

RoleDescriber generates information about a node.

func (d *RoleDescriber) Describe(namespace, name string, describerSettings DescriberSettings) (string, error)

type SecretDescriber ¶

type SecretDescriber struct {
	clientset.Interface
}

SecretDescriber generates information about a secret

func (d *SecretDescriber) Describe(namespace, name string, describerSettings DescriberSettings) (string, error)

type ServiceAccountDescriber ¶

type ServiceAccountDescriber struct {
	clientset.Interface
}

ServiceAccountDescriber generates information about a service.

func (d *ServiceAccountDescriber) Describe(namespace, name string, describerSettings DescriberSettings) (string, error)

type ServiceDescriber ¶

type ServiceDescriber struct {
	clientset.Interface
}

ServiceDescriber generates information about a service.

func (d *ServiceDescriber) Describe(namespace, name string, describerSettings DescriberSettings) (string, error)

type SortableResourceNames ¶

type SortableResourceNames []corev1.ResourceName

func (list SortableResourceNames) Len() int

func (list SortableResourceNames) Less(i, j int) bool

func (list SortableResourceNames) Swap(i, j int)

type SortableResourceQuotas ¶

type SortableResourceQuotas []corev1.ResourceQuota

func (list SortableResourceQuotas) Len() int

func (list SortableResourceQuotas) Less(i, j int) bool

func (list SortableResourceQuotas) Swap(i, j int)

type SortableVolumeDevices ¶

type SortableVolumeDevices []corev1.VolumeDevice

func (list SortableVolumeDevices) Len() int

func (list SortableVolumeDevices) Less(i, j int) bool

func (list SortableVolumeDevices) Swap(i, j int)

type SortableVolumeMounts ¶

type SortableVolumeMounts []corev1.VolumeMount

func (list SortableVolumeMounts) Len() int

func (list SortableVolumeMounts) Less(i, j int) bool

func (list SortableVolumeMounts) Swap(i, j int)

type StatefulSetDescriber ¶

type StatefulSetDescriber struct {
	// contains filtered or unexported fields
}

func (p *StatefulSetDescriber) Describe(namespace, name string, describerSettings DescriberSettings) (string, error)

type StorageClassDescriber ¶

type StorageClassDescriber struct {
	clientset.Interface
}

func (s *StorageClassDescriber) Describe(namespace, name string, describerSettings DescriberSettings) (string, error)