Documentation
¶
Index ¶
- Constants
- Variables
- func DescribeEvents(el *corev1.EventList, w PrefixWriter)
- func DescribeLimitRanges(limitRanges *corev1.LimitRangeList, w PrefixWriter)
- func DescribePodTemplate(template *corev1.PodTemplateSpec, w PrefixWriter)
- func DescribeProbe(probe *corev1.Probe) string
- func DescribeResourceQuotas(quotas *corev1.ResourceQuotaList, w PrefixWriter)
- func Describer(restClientGetter genericclioptions.RESTClientGetter, mapping *meta.RESTMapping) (describe.Describer, error)
- func DescriberFor(kind schema.GroupKind, clientConfig *rest.Config) (describe.Describer, bool)
- func GenericDescriberFor(mapping *meta.RESTMapping, clientConfig *rest.Config) (describe.Describer, bool)
- func SortedResourceNames(list corev1.ResourceList) []corev1.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 describe.ObjectDescriber
DefaultObjectDescriber can describe the default Kubernetes objects.
var DescriberFn describe.DescriberFunc = Describer
DescriberFn gives a way to easily override the function for unit testing if needed
Functions ¶
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 Describer ¶
func Describer(restClientGetter genericclioptions.RESTClientGetter, mapping *meta.RESTMapping) (describe.Describer, error)
Describer returns a Describer for displaying the specified RESTMapping type or an error.
func DescriberFor ¶
func DescriberFor(kind schema.GroupKind, clientConfig *rest.Config) (describe.Describer, bool)
DescriberFor returns the default describe functions for each of the standard Kubernetes types.
func GenericDescriberFor ¶
func GenericDescriberFor(mapping *meta.RESTMapping, clientConfig *rest.Config) (describe.Describer, bool)
GenericDescriberFor returns a generic describer for the specified mapping that uses only information available from runtime.Unstructured
func SortedResourceNames ¶
func SortedResourceNames(list corev1.ResourceList) []corev1.ResourceName
SortedResourceNames returns the sorted resource names of a resource list.
Types ¶
type CertificateSigningRequestDescriber ¶
type CertificateSigningRequestDescriber struct {
// contains filtered or unexported fields
}
type ClusterRoleBindingDescriber ¶
type ClusterRoleBindingDescriber struct {
clientset.Interface
}
ClusterRoleBindingDescriber generates information about a node.
type ClusterRoleDescriber ¶
type ClusterRoleDescriber struct {
clientset.Interface
}
ClusterRoleDescriber generates information about a node.
type ConfigMapDescriber ¶
type ConfigMapDescriber struct {
clientset.Interface
}
ConfigMapDescriber generates information about a ConfigMap
type CronJobDescriber ¶
type CronJobDescriber struct {
// contains filtered or unexported fields
}
CronJobDescriber generates information about a cron job and the jobs it has created.
type DaemonSetDescriber ¶
type DaemonSetDescriber struct {
clientset.Interface
}
DaemonSetDescriber generates information about a daemon set and the pods it has created.
type DeploymentDescriber ¶
type DeploymentDescriber struct {
// contains filtered or unexported fields
}
DeploymentDescriber generates information about a deployment.
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 describe.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.
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 HorizontalPodAutoscalerDescriber ¶
type HorizontalPodAutoscalerDescriber struct {
// contains filtered or unexported fields
}
HorizontalPodAutoscalerDescriber generates information about a horizontal pod autoscaler.
type IngressDescriber ¶
type IngressDescriber struct {
clientset.Interface
}
type JobDescriber ¶
type JobDescriber struct {
clientset.Interface
}
JobDescriber generates information about a job and the pods it has created.
type LimitRangeDescriber ¶
type LimitRangeDescriber struct {
clientset.Interface
}
LimitRangeDescriber generates information about a limit range
type NamespaceDescriber ¶
type NamespaceDescriber struct {
clientset.Interface
}
NamespaceDescriber generates information about a namespace
type NetworkPolicyDescriber ¶
type NetworkPolicyDescriber struct {
clientset.Interface
}
NetworkPolicyDescriber generates information about a networkingv1.NetworkPolicy
type NodeDescriber ¶
type NodeDescriber struct {
clientset.Interface
}
NodeDescriber generates information about a node.
type PersistentVolumeClaimDescriber ¶
type PersistentVolumeClaimDescriber struct {
clientset.Interface
}
type PersistentVolumeDescriber ¶
type PersistentVolumeDescriber struct {
clientset.Interface
}
type PodDescriber ¶
type PodDescriber struct {
clientset.Interface
}
PodDescriber generates information about a pod and the replication controllers that create it.
type PodDisruptionBudgetDescriber ¶
type PodDisruptionBudgetDescriber struct {
clientset.Interface
}
type PodSecurityPolicyDescriber ¶
type PodSecurityPolicyDescriber struct {
clientset.Interface
}
PodSecurityPolicyDescriber generates information about a PodSecuritypolicyv1beta1.
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 ¶
func NewPrefixWriter(out io.Writer) PrefixWriter
NewPrefixWriter creates a new PrefixWriter.
type PriorityClassDescriber ¶
type PriorityClassDescriber struct {
clientset.Interface
}
PriorityClassDescriber generates information about a PriorityClass.
type ReplicaSetDescriber ¶
type ReplicaSetDescriber struct {
clientset.Interface
}
ReplicaSetDescriber generates information about a ReplicaSet and the pods it has created.
type ReplicationControllerDescriber ¶
type ReplicationControllerDescriber struct {
clientset.Interface
}
ReplicationControllerDescriber generates information about a replication controller and the pods it has created.
type ResourceQuotaDescriber ¶
type ResourceQuotaDescriber struct {
clientset.Interface
}
ResourceQuotaDescriber generates information about a resource quota
type RoleBindingDescriber ¶
type RoleBindingDescriber struct {
clientset.Interface
}
RoleBindingDescriber generates information about a node.
type RoleDescriber ¶
type RoleDescriber struct {
clientset.Interface
}
RoleDescriber generates information about a node.
type SecretDescriber ¶
type SecretDescriber struct {
clientset.Interface
}
SecretDescriber generates information about a secret
type ServiceAccountDescriber ¶
type ServiceAccountDescriber struct {
clientset.Interface
}
ServiceAccountDescriber generates information about a service.
type ServiceDescriber ¶
type ServiceDescriber struct {
clientset.Interface
}
ServiceDescriber generates information about a service.
type SortableResourceNames ¶
type SortableResourceNames []corev1.ResourceName
type SortableResourceQuotas ¶
type SortableResourceQuotas []corev1.ResourceQuota
type SortableVolumeDevices ¶
type SortableVolumeDevices []corev1.VolumeDevice
type SortableVolumeMounts ¶
type SortableVolumeMounts []corev1.VolumeMount
type StatefulSetDescriber ¶
type StatefulSetDescriber struct {
// contains filtered or unexported fields
}
type StorageClassDescriber ¶
type StorageClassDescriber struct {
clientset.Interface
}
Source Files