describe

package
v0.24.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 25, 2022 License: Apache-2.0 Imports: 64 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	LEVEL_0 = iota
	LEVEL_1
	LEVEL_2
	LEVEL_3
	LEVEL_4
)

Each level has 2 spaces for PrefixWriter

View Source 
const (
	// LoadBalancerWidth is the width how we describe load balancer
	LoadBalancerWidth = 16

	// LabelNodeRolePrefix is a label prefix for node roles
	// It's copied over to here until it's merged in core: https://github.com/kubernetes/kubernetes/pull/39112
	LabelNodeRolePrefix = "node-role.kubernetes.io/"

	// NodeLabelRole specifies the role of a node
	NodeLabelRole = "kubernetes.io/role"
)

Variables

This section is empty.

Functions

func CombineResourceGroup 

func CombineResourceGroup(resource, group []string) string

func DescribeEvents 

func DescribeEvents(el *corev1.EventList, w PrefixWriter)

func DescribeLimitRanges 

func DescribeLimitRanges(limitRanges *corev1.LimitRangeList, w PrefixWriter)

DescribeLimitRanges merges a set of limit range items into a single tabular description

func DescribePodTemplate 

func DescribePodTemplate(template *corev1.PodTemplateSpec, w PrefixWriter)

func DescribeProbe 

func DescribeProbe(probe *corev1.Probe) string

DescribeProbe is exported for consumers in other API groups that have probes

func DescribeResourceQuotas 

func DescribeResourceQuotas(quotas *corev1.ResourceQuotaList, w PrefixWriter)

DescribeResourceQuotas merges a set of quota items into a single tabular description of all quotas

func SortedResourceNames 

func SortedResourceNames(list corev1.ResourceList) []corev1.ResourceName

SortedResourceNames returns the sorted resource names of a resource list.

Types

type CSINodeDescriber 

type CSINodeDescriber struct {
	clientset.Interface
}

func (*CSINodeDescriber) Describe 

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

type CertificateSigningRequestDescriber 

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

func (*CertificateSigningRequestDescriber) Describe 

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 (*ClusterRoleBindingDescriber) Describe 

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 (*ClusterRoleDescriber) Describe 

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 (*ConfigMapDescriber) Describe 

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 (*CronJobDescriber) Describe 

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 (*DaemonSetDescriber) Describe 

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 (*DeploymentDescriber) Describe 

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 (*Describers) Add 

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

Add adds one or more describer functions to the Describer. The passed function must match the signature: 

func(...) (string, error)

Any number of arguments may be provided.

func (*Describers) DescribeObject 

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

DescribeObject implements ObjectDescriber and will attempt to print the provided object to a string, if at least one describer function has been registered with the exact types passed, or if any describer can print the exact object in its first argument (the remainder will be provided empty values). If no function registered with Add can satisfy the passed objects, an ErrNoDescriber will be returned TODO: reorder and partial match extra.

type EndpointSliceDescriber 

type EndpointSliceDescriber struct {
	clientset.Interface
}

EndpointSliceDescriber generates information about an EndpointSlice.

func (*EndpointSliceDescriber) Describe 

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 (*EndpointsDescriber) Describe 

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

type EnvVarResolverFunc 

type EnvVarResolverFunc func(e corev1.EnvVar) string

func EnvValueRetriever 

func EnvValueRetriever(pod *corev1.Pod) EnvVarResolverFunc

EnvValueFrom is exported for use by describers in other packages

type ErrNoDescriber 

type ErrNoDescriber struct {
	Types []string
}

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

func (ErrNoDescriber) Error 

func (e ErrNoDescriber) Error() string

Error implements the error interface.

type HorizontalPodAutoscalerDescriber 

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

HorizontalPodAutoscalerDescriber generates information about a horizontal pod autoscaler.

func (*HorizontalPodAutoscalerDescriber) Describe 

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

type IngressClassDescriber 

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

func (*IngressClassDescriber) Describe 

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

type IngressDescriber 

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

func (*IngressDescriber) Describe 

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 (*JobDescriber) Describe 

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 (*LimitRangeDescriber) Describe 

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 (*NamespaceDescriber) Describe 

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 (*NetworkPolicyDescriber) Describe 

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 (*NodeDescriber) Describe 

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

DefaultObjectDescriber can describe the default Kubernetes objects.

type PersistentVolumeClaimDescriber 

type PersistentVolumeClaimDescriber struct {
	clientset.Interface
}

func (*PersistentVolumeClaimDescriber) Describe 

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

type PersistentVolumeDescriber 

type PersistentVolumeDescriber struct {
	clientset.Interface
}

func (*PersistentVolumeDescriber) Describe 

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 (*PodDescriber) Describe 

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

type PodDisruptionBudgetDescriber 

type PodDisruptionBudgetDescriber struct {
	clientset.Interface
}

func (*PodDisruptionBudgetDescriber) Describe 

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 (*PodSecurityPolicyDescriber) Describe 

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 

func NewNestedPrefixWriter(out PrefixWriter, indent int) PrefixWriter

NewPrefixWriter creates a new PrefixWriter.

func NewPrefixWriter 

func NewPrefixWriter(out io.Writer) PrefixWriter

NewPrefixWriter creates a new PrefixWriter.

type PriorityClassDescriber 

type PriorityClassDescriber struct {
	clientset.Interface
}

PriorityClassDescriber generates information about a PriorityClass.

func (*PriorityClassDescriber) Describe 

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 (*ReplicaSetDescriber) Describe 

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 (*ReplicationControllerDescriber) Describe 

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 

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

Describer returns a Describer for displaying the specified RESTMapping type or an error.

func DescriberFor 

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

DescriberFor returns the default describe functions for each of the standard Kubernetes types.

func GenericDescriberFor 

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

GenericDescriberFor returns a generic describer for the specified mapping that uses only information available from runtime.Unstructured

type ResourceQuotaDescriber 

type ResourceQuotaDescriber struct {
	clientset.Interface
}

ResourceQuotaDescriber generates information about a resource quota

func (*ResourceQuotaDescriber) Describe 

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 (*RoleBindingDescriber) Describe 

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 (*RoleDescriber) Describe 

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 (*SecretDescriber) Describe 

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 (*ServiceAccountDescriber) Describe 

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 (*ServiceDescriber) Describe 

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

type SortableResourceNames 

type SortableResourceNames []corev1.ResourceName

func (SortableResourceNames) Len 

func (list SortableResourceNames) Len() int

func (SortableResourceNames) Less 

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

func (SortableResourceNames) Swap 

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

type SortableResourceQuotas 

type SortableResourceQuotas []corev1.ResourceQuota

func (SortableResourceQuotas) Len 

func (list SortableResourceQuotas) Len() int

func (SortableResourceQuotas) Less 

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

func (SortableResourceQuotas) Swap 

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

type SortableVolumeDevices 

type SortableVolumeDevices []corev1.VolumeDevice

func (SortableVolumeDevices) Len 

func (list SortableVolumeDevices) Len() int

func (SortableVolumeDevices) Less 

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

func (SortableVolumeDevices) Swap 

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

type SortableVolumeMounts 

type SortableVolumeMounts []corev1.VolumeMount

func (SortableVolumeMounts) Len 

func (list SortableVolumeMounts) Len() int

func (SortableVolumeMounts) Less 

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

func (SortableVolumeMounts) Swap 

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

type StatefulSetDescriber 

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

func (*StatefulSetDescriber) Describe 

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

type StorageClassDescriber 

type StorageClassDescriber struct {
	clientset.Interface
}

func (*StorageClassDescriber) Describe 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.