Documentation

Index

Constants

View Source
const (
	LEVEL_0 = iota
	LEVEL_1
	LEVEL_2
	LEVEL_3
)

    Each level has 2 spaces for PrefixWriter

    Variables

    View Source
    var DefaultObjectDescriber printers.ObjectDescriber

      DefaultObjectDescriber can describe the default Kubernetes objects.

      Functions

      func AddHandlers

      func AddHandlers(h *printers.HumanReadablePrinter)

        AddHandlers adds print handlers for default Kubernetes types dealing with internal versions.

        func AppendAllLabels

        func AppendAllLabels(showLabels bool, itemLabels map[string]string) string

          Append all labels to a single column. We need this even when show-labels flag* is false, since this adds newline delimiter to the end of each row.

          func AppendLabelTabs

          func AppendLabelTabs(columnLabels []string) string

            Append a set of tabs for each label column. We need this in the case where we have extra lines so that the tabwriter will still line things up.

            func AppendLabels

            func AppendLabels(itemLabels map[string]string, columnLabels []string) string

            func DescribableResources

            func DescribableResources() []string

              DescribableResources lists all resource types we can describe.

              func DescribeEvents

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

              func DescribeLimitRanges

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

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

                func DescribePodTemplate

                func DescribePodTemplate(template *api.PodTemplateSpec, out io.Writer)

                func DescribeProbe

                func DescribeProbe(probe *api.Probe) string

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

                  func DescribeResourceQuotas

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

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

                    func DescriberFor

                    func DescriberFor(kind schema.GroupKind, c clientset.Interface) (printers.Describer, bool)

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

                      func GenericDescriberFor

                      func GenericDescriberFor(mapping *meta.RESTMapping, dynamic *dynamic.Client, events coreclient.EventsGetter) printers.Describer

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

                        func SortedQoSResourceNames

                        func SortedQoSResourceNames(list qos.QOSList) []api.ResourceName

                          SortedQoSResourceNames returns the sorted resource names of a QoS list.

                          func SortedResourceNames

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

                            SortedResourceNames returns the sorted resource names of a resource list.

                            Types

                            type CertificateSigningRequestDescriber

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

                            func (*CertificateSigningRequestDescriber) Describe

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

                            type ClusterDescriber

                            type ClusterDescriber struct {
                            	fedclientset.Interface
                            }

                            func (*ClusterDescriber) Describe

                            func (d *ClusterDescriber) Describe(namespace, name string, describerSettings printers.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 printers.DescriberSettings) (string, error)

                              type CronJobDescriber

                              type CronJobDescriber struct {
                              	clientset.Interface
                              }

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

                                func (*CronJobDescriber) Describe

                                func (d *CronJobDescriber) Describe(namespace, name string, describerSettings printers.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 printers.DescriberSettings) (string, error)

                                  type DeploymentDescriber

                                  type DeploymentDescriber struct {
                                  	clientset.Interface
                                  	// contains filtered or unexported fields
                                  }

                                    DeploymentDescriber generates information about a deployment.

                                    func (*DeploymentDescriber) Describe

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

                                    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 printers.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 EndpointsDescriber

                                          type EndpointsDescriber struct {
                                          	clientset.Interface
                                          }

                                            EndpointsDescriber generates information about an Endpoint.

                                            func (*EndpointsDescriber) Describe

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

                                            type EnvVarResolverFunc

                                            type EnvVarResolverFunc func(e api.EnvVar) string

                                            func EnvValueRetriever

                                            func EnvValueRetriever(pod *api.Pod) EnvVarResolverFunc

                                              EnvValueFrom is exported for use by describers in other packages

                                              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 printers.DescriberSettings) (string, error)

                                                type IngressDescriber

                                                type IngressDescriber struct {
                                                	clientset.Interface
                                                }

                                                func (*IngressDescriber) Describe

                                                func (i *IngressDescriber) Describe(namespace, name string, describerSettings printers.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 printers.DescriberSettings) (string, error)

                                                  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 printers.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 printers.DescriberSettings) (string, error)

                                                      type NetworkPolicyDescriber

                                                      type NetworkPolicyDescriber struct {
                                                      	clientset.Interface
                                                      }

                                                        NetworkPolicyDescriber generates information about a NetworkPolicy

                                                        func (*NetworkPolicyDescriber) Describe

                                                        func (d *NetworkPolicyDescriber) Describe(namespace, name string, describerSettings printers.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 printers.DescriberSettings) (string, error)

                                                          type PersistentVolumeClaimDescriber

                                                          type PersistentVolumeClaimDescriber struct {
                                                          	clientset.Interface
                                                          }

                                                          func (*PersistentVolumeClaimDescriber) Describe

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

                                                          type PersistentVolumeDescriber

                                                          type PersistentVolumeDescriber struct {
                                                          	clientset.Interface
                                                          }

                                                          func (*PersistentVolumeDescriber) Describe

                                                          func (d *PersistentVolumeDescriber) Describe(namespace, name string, describerSettings printers.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 printers.DescriberSettings) (string, error)

                                                            type PodDisruptionBudgetDescriber

                                                            type PodDisruptionBudgetDescriber struct {
                                                            	clientset.Interface
                                                            }

                                                            func (*PodDisruptionBudgetDescriber) Describe

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

                                                            type PrefixWriter

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

                                                            func (*PrefixWriter) Write

                                                            func (pw *PrefixWriter) Write(level int, format string, a ...interface{})

                                                            func (*PrefixWriter) WriteLine

                                                            func (pw *PrefixWriter) WriteLine(a ...interface{})

                                                            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 printers.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 printers.DescriberSettings) (string, error)

                                                                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 printers.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 printers.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 printers.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 printers.DescriberSettings) (string, error)

                                                                        type SortableResourceNames

                                                                        type SortableResourceNames []api.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 []api.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 SortableVolumeMounts

                                                                        type SortableVolumeMounts []api.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 printers.DescriberSettings) (string, error)

                                                                        type StorageClassDescriber

                                                                        type StorageClassDescriber struct {
                                                                        	clientset.Interface
                                                                        }

                                                                        func (*StorageClassDescriber) Describe

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