Documentation
¶
Index ¶
- Constants
- Variables
- func AddDefaultHandlers(h printers.PrintHandler)
- func AddHandlers(h printers.PrintHandler)
- func DescribeEvents(el *api.EventList, w PrefixWriter)
- func DescribeLimitRanges(limitRanges *api.LimitRangeList, w PrefixWriter)
- func DescribePodTemplate(template *api.PodTemplateSpec, w PrefixWriter)
- func DescribeProbe(probe *api.Probe) string
- func DescribeResourceQuotas(quotas *api.ResourceQuotaList, w PrefixWriter)
- func DescriberFor(kind schema.GroupKind, clientConfig *rest.Config) (printers.Describer, bool)
- func GenericDescriberFor(mapping *meta.RESTMapping, dynamic dynamic.Interface, ...) printers.Describer
- func SortedResourceNames(list api.ResourceList) []api.ResourceName
- type CertificateSigningRequestDescriber
- type ClusterRoleBindingDescriber
- type ClusterRoleDescriber
- type ConfigMapDescriber
- type CronJobDescriber
- type DaemonSetDescriber
- type DeploymentDescriber
- type Describers
- type EndpointsDescriber
- type EnvVarResolverFunc
- type HorizontalPodAutoscalerDescriber
- type IngressDescriber
- type JobDescriber
- type LimitRangeDescriber
- type NamespaceDescriber
- type NetworkPolicyDescriber
- type NodeDescriber
- type PersistentVolumeClaimDescriber
- type PersistentVolumeDescriber
- type PodDescriber
- type PodDisruptionBudgetDescriber
- type PodSecurityPolicyDescriber
- type PrefixWriter
- type PriorityClassDescriber
- type ReplicaSetDescriber
- type ReplicationControllerDescriber
- type ResourceQuotaDescriber
- type RoleBindingDescriber
- type RoleDescriber
- type SecretDescriber
- type ServiceAccountDescriber
- type ServiceDescriber
- type SortableResourceNames
- type SortableResourceQuotas
- type SortableVolumeDevices
- type SortableVolumeMounts
- type StatefulSetDescriber
- type StorageClassDescriber
Constants ¶
const ( LEVEL_0 = iota LEVEL_1 LEVEL_2 LEVEL_3 )
Each level has 2 spaces for PrefixWriter
Variables ¶
var DefaultObjectDescriber printers.ObjectDescriber
DefaultObjectDescriber can describe the default Kubernetes objects.
Functions ¶
func AddDefaultHandlers ¶ added in v1.8.0
func AddDefaultHandlers(h printers.PrintHandler)
AddDefaultHandlers adds handlers that can work with most Kubernetes objects.
func AddHandlers ¶
func AddHandlers(h printers.PrintHandler)
AddHandlers adds print handlers for default Kubernetes types dealing with internal versions. TODO: handle errors from Handler
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, w PrefixWriter)
func DescribeProbe ¶
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 ¶
DescriberFor returns the default describe functions for each of the standard Kubernetes types.
func GenericDescriberFor ¶
func GenericDescriberFor(mapping *meta.RESTMapping, dynamic dynamic.Interface, events coreclient.EventsGetter) printers.Describer
GenericDescriberFor returns a generic describer for the specified mapping that uses only information available from runtime.Unstructured
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 ClusterRoleBindingDescriber ¶ added in v1.7.0
ClusterRoleBindingDescriber generates information about a node.
func (*ClusterRoleBindingDescriber) Describe ¶ added in v1.7.0
func (d *ClusterRoleBindingDescriber) Describe(namespace, name string, describerSettings printers.DescriberSettings) (string, error)
type ClusterRoleDescriber ¶ added in v1.7.0
ClusterRoleDescriber generates information about a node.
func (*ClusterRoleDescriber) Describe ¶ added in v1.7.0
func (d *ClusterRoleDescriber) Describe(namespace, name string, describerSettings printers.DescriberSettings) (string, error)
type ConfigMapDescriber ¶
ConfigMapDescriber generates information about a ConfigMap
func (*ConfigMapDescriber) Describe ¶
func (d *ConfigMapDescriber) Describe(namespace, name string, describerSettings printers.DescriberSettings) (string, error)
type CronJobDescriber ¶
CronJobDescriber generates information about a cron job and the jobs it has created.
func (*CronJobDescriber) Describe ¶
func (d *CronJobDescriber) Describe(namespace, name string, describerSettings printers.DescriberSettings) (string, error)
type DaemonSetDescriber ¶
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 ¶
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 ¶
EndpointsDescriber generates information about an Endpoint.
func (*EndpointsDescriber) Describe ¶
func (d *EndpointsDescriber) Describe(namespace, name string, describerSettings printers.DescriberSettings) (string, error)
type EnvVarResolverFunc ¶
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 ¶
func (*IngressDescriber) Describe ¶
func (i *IngressDescriber) Describe(namespace, name string, describerSettings printers.DescriberSettings) (string, error)
type JobDescriber ¶
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 ¶
LimitRangeDescriber generates information about a limit range
func (*LimitRangeDescriber) Describe ¶
func (d *LimitRangeDescriber) Describe(namespace, name string, describerSettings printers.DescriberSettings) (string, error)
type NamespaceDescriber ¶
NamespaceDescriber generates information about a namespace
func (*NamespaceDescriber) Describe ¶
func (d *NamespaceDescriber) Describe(namespace, name string, describerSettings printers.DescriberSettings) (string, error)
type NetworkPolicyDescriber ¶
NetworkPolicyDescriber generates information about a networking.NetworkPolicy
func (*NetworkPolicyDescriber) Describe ¶
func (d *NetworkPolicyDescriber) Describe(namespace, name string, describerSettings printers.DescriberSettings) (string, error)
type NodeDescriber ¶
NodeDescriber generates information about a node.
func (*NodeDescriber) Describe ¶
func (d *NodeDescriber) Describe(namespace, name string, describerSettings printers.DescriberSettings) (string, error)
type PersistentVolumeClaimDescriber ¶
func (*PersistentVolumeClaimDescriber) Describe ¶
func (d *PersistentVolumeClaimDescriber) Describe(namespace, name string, describerSettings printers.DescriberSettings) (string, error)
type PersistentVolumeDescriber ¶
func (*PersistentVolumeDescriber) Describe ¶
func (d *PersistentVolumeDescriber) Describe(namespace, name string, describerSettings printers.DescriberSettings) (string, error)
type PodDescriber ¶
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 ¶
func (*PodDisruptionBudgetDescriber) Describe ¶
func (p *PodDisruptionBudgetDescriber) Describe(namespace, name string, describerSettings printers.DescriberSettings) (string, error)
type PodSecurityPolicyDescriber ¶ added in v1.8.0
PodSecurityPolicyDescriber generates information about a PodSecurityPolicy.
func (*PodSecurityPolicyDescriber) Describe ¶ added in v1.8.0
func (d *PodSecurityPolicyDescriber) Describe(namespace, name string, describerSettings printers.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 NewPrefixWriter ¶ added in v1.7.0
func NewPrefixWriter(out io.Writer) PrefixWriter
NewPrefixWriter creates a new PrefixWriter.
type PriorityClassDescriber ¶ added in v1.8.0
PriorityClassDescriber generates information about a PriorityClass.
func (*PriorityClassDescriber) Describe ¶ added in v1.8.0
func (s *PriorityClassDescriber) Describe(namespace, name string, describerSettings printers.DescriberSettings) (string, error)
type ReplicaSetDescriber ¶
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 ¶
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 ¶
ResourceQuotaDescriber generates information about a resource quota
func (*ResourceQuotaDescriber) Describe ¶
func (d *ResourceQuotaDescriber) Describe(namespace, name string, describerSettings printers.DescriberSettings) (string, error)
type RoleBindingDescriber ¶ added in v1.7.0
RoleBindingDescriber generates information about a node.
func (*RoleBindingDescriber) Describe ¶ added in v1.7.0
func (d *RoleBindingDescriber) Describe(namespace, name string, describerSettings printers.DescriberSettings) (string, error)
type RoleDescriber ¶ added in v1.7.0
RoleDescriber generates information about a node.
func (*RoleDescriber) Describe ¶ added in v1.7.0
func (d *RoleDescriber) Describe(namespace, name string, describerSettings printers.DescriberSettings) (string, error)
type SecretDescriber ¶
SecretDescriber generates information about a secret
func (*SecretDescriber) Describe ¶
func (d *SecretDescriber) Describe(namespace, name string, describerSettings printers.DescriberSettings) (string, error)
type ServiceAccountDescriber ¶
ServiceAccountDescriber generates information about a service.
func (*ServiceAccountDescriber) Describe ¶
func (d *ServiceAccountDescriber) Describe(namespace, name string, describerSettings printers.DescriberSettings) (string, error)
type ServiceDescriber ¶
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 SortableVolumeDevices ¶ added in v1.9.1
type SortableVolumeDevices []api.VolumeDevice
func (SortableVolumeDevices) Len ¶ added in v1.9.1
func (list SortableVolumeDevices) Len() int
func (SortableVolumeDevices) Less ¶ added in v1.9.1
func (list SortableVolumeDevices) Less(i, j int) bool
func (SortableVolumeDevices) Swap ¶ added in v1.9.1
func (list SortableVolumeDevices) 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 ¶
func (*StorageClassDescriber) Describe ¶
func (s *StorageClassDescriber) Describe(namespace, name string, describerSettings printers.DescriberSettings) (string, error)