util

package
v1.11.9-beta.0 Latest Latest
Warning

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

 Go to latest Published: Feb 28, 2019 License: Apache-2.0 Imports: 48 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// TODO(sig-cli): Enforce consistent naming for generators here.
	// See discussion in https://github.com/kubernetes/kubernetes/issues/46237
	// before you add any more.
	RunV1GeneratorName                      = "run/v1"
	RunPodV1GeneratorName                   = "run-pod/v1"
	ServiceV1GeneratorName                  = "service/v1"
	ServiceV2GeneratorName                  = "service/v2"
	ServiceNodePortGeneratorV1Name          = "service-nodeport/v1"
	ServiceClusterIPGeneratorV1Name         = "service-clusterip/v1"
	ServiceLoadBalancerGeneratorV1Name      = "service-loadbalancer/v1"
	ServiceExternalNameGeneratorV1Name      = "service-externalname/v1"
	ServiceAccountV1GeneratorName           = "serviceaccount/v1"
	HorizontalPodAutoscalerV1GeneratorName  = "horizontalpodautoscaler/v1"
	DeploymentV1Beta1GeneratorName          = "deployment/v1beta1"
	DeploymentAppsV1Beta1GeneratorName      = "deployment/apps.v1beta1"
	DeploymentBasicV1Beta1GeneratorName     = "deployment-basic/v1beta1"
	DeploymentBasicAppsV1Beta1GeneratorName = "deployment-basic/apps.v1beta1"
	DeploymentBasicAppsV1GeneratorName      = "deployment-basic/apps.v1"
	JobV1GeneratorName                      = "job/v1"
	CronJobV2Alpha1GeneratorName            = "cronjob/v2alpha1"
	CronJobV1Beta1GeneratorName             = "cronjob/v1beta1"
	NamespaceV1GeneratorName                = "namespace/v1"
	ResourceQuotaV1GeneratorName            = "resourcequotas/v1"
	SecretV1GeneratorName                   = "secret/v1"
	SecretForDockerRegistryV1GeneratorName  = "secret-for-docker-registry/v1"
	SecretForTLSV1GeneratorName             = "secret-for-tls/v1"
	ConfigMapV1GeneratorName                = "configmap/v1"
	ClusterRoleBindingV1GeneratorName       = "clusterrolebinding.rbac.authorization.k8s.io/v1alpha1"
	RoleBindingV1GeneratorName              = "rolebinding.rbac.authorization.k8s.io/v1alpha1"
	PodDisruptionBudgetV1GeneratorName      = "poddisruptionbudget/v1beta1"
	PodDisruptionBudgetV2GeneratorName      = "poddisruptionbudget/v1beta1/v2"
	PriorityClassV1Alpha1GeneratorName      = "priorityclass/v1alpha1"
)
View Source 
const (
	ApplyAnnotationsFlag     = "save-config"
	DefaultErrorExitCode     = 1
	IncludeUninitializedFlag = "include-uninitialized"
)

Variables

View Source 
var ErrExit = fmt.Errorf("exit")

ErrExit may be passed to CheckError to instruct it to output nothing but exit with status code 1.

Functions

func AddApplyAnnotationFlags added in v1.2.0 

func AddApplyAnnotationFlags(cmd *cobra.Command)

func AddApplyAnnotationVarFlags added in v1.7.0 

func AddApplyAnnotationVarFlags(cmd *cobra.Command, applyAnnotation *bool)

func AddDryRunFlag added in v1.3.0 

func AddDryRunFlag(cmd *cobra.Command)

AddDryRunFlag adds dry-run flag to a command. Usually used by mutations.

func AddFilenameOptionFlags added in v1.5.1 

func AddFilenameOptionFlags(cmd *cobra.Command, options *resource.FilenameOptions, usage string)

func AddGeneratorFlags added in v1.2.0 

func AddGeneratorFlags(cmd *cobra.Command, defaultGenerator string)

AddGeneratorFlags adds flags common to resource generation commands TODO: need to take a pass at other generator commands to use this set of flags

func AddIncludeUninitializedFlag added in v1.8.0 

func AddIncludeUninitializedFlag(cmd *cobra.Command)

func AddJsonFilenameFlag added in v1.11.1 

func AddJsonFilenameFlag(flags *pflag.FlagSet, value *[]string, usage string)

func AddPodRunningTimeoutFlag added in v1.7.0 

func AddPodRunningTimeoutFlag(cmd *cobra.Command, defaultTimeout time.Duration)

func AddSourceToErr added in v0.20.0 

func AddSourceToErr(verb string, source string, err error) error

AddSourceToErr adds handleResourcePrefix and source string to error message. verb is the string like "creating", "deleting" etc. source is the filename or URL to the template file(*.json or *.yaml), or stdin to use to handle the resource.

func AddValidateFlags added in v1.1.1 

func AddValidateFlags(cmd *cobra.Command)

func AddValidateOptionFlags added in v1.7.0 

func AddValidateOptionFlags(cmd *cobra.Command, options *ValidateOptions)

func AsDefaultVersionedOrOriginal added in v1.11.1 

func AsDefaultVersionedOrOriginal(obj runtime.Object, mapping *meta.RESTMapping) runtime.Object

AsDefaultVersionedOrOriginal returns the object as a Go object in the external form if possible (matching the group version kind of the mapping if provided, a best guess based on serialization if not provided, or obj if it cannot be converted. TODO update call sites to specify the scheme they want on their builder.

func BehaviorOnFatal added in v1.1.1 

func BehaviorOnFatal(f func(string, int))

BehaviorOnFatal allows you to override the default behavior when a fatal error occurs, which is to call os.Exit(code). You can pass 'panic' as a function here if you prefer the panic() over os.Exit(1).

func CheckErr added in v0.13.0 

func CheckErr(err error)

CheckErr prints a user friendly error to STDERR and exits with a non-zero exit code. Unrecognized errors will be printed with an "error: " prefix.

This method is generic to the command in use and may be used by non-Kubectl commands.

func DefaultBehaviorOnFatal added in v1.2.0 

func DefaultBehaviorOnFatal()

DefaultBehaviorOnFatal allows you to undo any previous override. Useful in tests.

func DefaultSubCommandRun added in v1.5.1 

func DefaultSubCommandRun(out io.Writer) func(c *cobra.Command, args []string)

DefaultSubCommandRun prints a command's help string to the specified output if no arguments (sub-commands) are provided, or a usage error otherwise.

func DumpReaderToFile added in v1.1.1 

func DumpReaderToFile(reader io.Reader, filename string) error

DumpReaderToFile writes all data from the given io.Reader to the specified file (usually for temporary use).

func FallbackGeneratorNameIfNecessary added in v1.9.1 

func FallbackGeneratorNameIfNecessary(
	generatorName string,
	discoveryClient discovery.DiscoveryInterface,
	cmdErr io.Writer,
) (string, error)

FallbackGeneratorNameIfNecessary returns the name of the old generator if server does not support new generator. Otherwise, the generator string is returned unchanged.

If the generator name is changed, print a warning message to let the user know.

func GetDryRunFlag added in v1.3.0 

func GetDryRunFlag(cmd *cobra.Command) bool

func GetFlagBool 

func GetFlagBool(cmd *cobra.Command, flag string) bool

func GetFlagDuration 

func GetFlagDuration(cmd *cobra.Command, flag string) time.Duration

func GetFlagInt 

func GetFlagInt(cmd *cobra.Command, flag string) int

Assumes the flag has a default value.

func GetFlagInt32 added in v1.9.1 

func GetFlagInt32(cmd *cobra.Command, flag string) int32

Assumes the flag has a default value.

func GetFlagInt64 added in v1.1.1 

func GetFlagInt64(cmd *cobra.Command, flag string) int64

Assumes the flag has a default value.

func GetFlagString 

func GetFlagString(cmd *cobra.Command, flag string) string

func GetFlagStringArray added in v1.5.1 

func GetFlagStringArray(cmd *cobra.Command, flag string) []string

GetFlagStringArray can be used to accept multiple argument with flag repetition (e.g. -f arg1 -f arg2 ...)

func GetFlagStringSlice added in v1.1.1 

func GetFlagStringSlice(cmd *cobra.Command, flag string) []string

GetFlagStringSlice can be used to accept multiple argument with flag repetition (e.g. -f arg1,arg2 -f arg3 ...)

func GetPodRunningTimeoutFlag added in v1.7.0 

func GetPodRunningTimeoutFlag(cmd *cobra.Command) (time.Duration, error)

func GetResourcesAndPairs added in v1.3.0 

func GetResourcesAndPairs(args []string, pairType string) (resources []string, pairArgs []string, err error)

GetResourcesAndPairs retrieves resources and "KEY=VALUE or KEY-" pair args from given args

func HasResource added in v1.9.1 

func HasResource(client discovery.DiscoveryInterface, resource schema.GroupVersionResource) (bool, error)

func InternalVersionDecoder added in v1.10.0 

func InternalVersionDecoder() runtime.Decoder

this method exists to help us find the points still relying on internal types.

func InternalVersionJSONEncoder added in v1.10.0 

func InternalVersionJSONEncoder() runtime.Encoder

func IsFilenameSliceEmpty added in v1.8.0 

func IsFilenameSliceEmpty(filenames []string) bool

func IsSiblingCommandExists added in v1.5.1 

func IsSiblingCommandExists(cmd *cobra.Command, targetCmdName string) bool

IsSiblingCommandExists receives a pointer to a cobra command and a target string. Returns true if the target string is found in the list of sibling commands.

func ManualStrip added in v1.7.0 

func ManualStrip(file []byte) []byte

ManualStrip is used for dropping comments from a YAML file

func Merge 

func Merge(codec runtime.Codec, dst runtime.Object, fragment string) (runtime.Object, error)

Merge requires JSON serialization TODO: merge assumes JSON serialization, and does not properly abstract API retrieval

func MultilineError added in v0.15.0 

func MultilineError(prefix string, err error) string

MultilineError returns a string representing an error that splits sub errors into their own lines. The returned string will end with a newline.

func MultipleErrors added in v0.18.2 

func MultipleErrors(prefix string, errs []error) string

MultipleErrors returns a newline delimited string containing the prefix and referenced errors in standard form.

func ParsePairs added in v1.3.0 

func ParsePairs(pairArgs []string, pairType string, supportRemove bool) (newPairs map[string]string, removePairs []string, err error)

ParsePairs retrieves new and remove pairs (if supportRemove is true) from "KEY=VALUE or KEY-" pair args

func PrintErrorWithCauses added in v1.5.1 

func PrintErrorWithCauses(err error, errOut io.Writer) bool

PrintErrorWithCauses prints an error's kind, name, and each of the error's causes in a new line. The returned string will end with a newline. Returns true if a case exists to handle the error type, or false otherwise.

func RequireNoArguments added in v1.5.1 

func RequireNoArguments(c *cobra.Command, args []string)

RequireNoArguments exits with a usage error if extra arguments are provided.

func ShouldIncludeUninitialized added in v1.8.0 

func ShouldIncludeUninitialized(cmd *cobra.Command, includeUninitialized bool) bool

ShouldIncludeUninitialized identifies whether to include uninitialized objects. includeUninitialized is the default value. Assume we can parse `all` and `selector` from cmd.

func StandardErrorMessage added in v0.18.2 

func StandardErrorMessage(err error) (string, bool)

StandardErrorMessage translates common errors into a human readable message, or returns false if the error is not one of the recognized types. It may also log extended information to glog.

This method is generic to the command in use and may be used by non-Kubectl commands.

func StripComments added in v1.7.0 

func StripComments(file []byte) []byte

StripComments will transform a YAML file into JSON, thus dropping any comments in it. Note that if the given file has a syntax error, the transformation will fail and we will manually drop all comments from the file.

func SuggestApiResources added in v1.11.1 

func SuggestApiResources(parent string) string

SuggestApiResources returns a suggestion to use the "api-resources" command to retrieve a supported list of resources

func UsageErrorf added in v1.8.0 

func UsageErrorf(cmd *cobra.Command, format string, args ...interface{}) error

func Warning added in v1.11.1 

func Warning(cmdErr io.Writer, newGeneratorName, oldGeneratorName string)

Types

type DescriberFunc added in v1.11.1 

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

DescriberFunc gives a way to display the specified RESTMapping type 

var DescriberFn DescriberFunc = describer

DescriberFn gives a way to easily override the function for unit testing if needed

type Factory added in v0.15.0 

type Factory interface {
	genericclioptions.RESTClientGetter

	// ClientSet gives you back an internal, generated clientset
	ClientSet() (internalclientset.Interface, error)

	// DynamicClient returns a dynamic client ready for use
	DynamicClient() (dynamic.Interface, error)

	// KubernetesClientSet gives you back an external clientset
	KubernetesClientSet() (*kubernetes.Clientset, error)

	// Returns a RESTClient for accessing Kubernetes resources or an error.
	RESTClient() (*restclient.RESTClient, error)

	// NewBuilder returns an object that assists in loading objects from both disk and the server
	// and which implements the common patterns for CLI interactions with generic resources.
	NewBuilder() *resource.Builder

	// Returns a RESTClient for working with the specified RESTMapping or an error. This is intended
	// for working with arbitrary resources and is not guaranteed to point to a Kubernetes APIServer.
	ClientForMapping(mapping *meta.RESTMapping) (resource.RESTClient, error)
	// Returns a RESTClient for working with Unstructured objects.
	UnstructuredClientForMapping(mapping *meta.RESTMapping) (resource.RESTClient, error)

	// Returns a schema that can validate objects stored on disk.
	Validator(validate bool) (validation.Schema, error)
	// OpenAPISchema returns the schema openapi schema definition
	OpenAPISchema() (openapi.Resources, error)
}

Factory provides abstractions that allow the Kubectl command to be extended across multiple types of resources and different API sets. The rings are here for a reason. In order for composers to be able to provide alternative factory implementations they need to provide low level pieces of *certain* functions so that when the factory calls back into itself it uses the custom version of the function. Rather than try to enumerate everything that someone would want to override we split the factory into rings, where each ring can depend on methods in an earlier ring, but cannot depend upon peer methods in its own ring. TODO: make the functions interfaces TODO: pass the various interfaces on the factory directly into the command constructors (so the commands are decoupled from the factory).

func NewFactory added in v0.15.0 

func NewFactory(clientGetter genericclioptions.RESTClientGetter) Factory

type GeneratorFunc added in v1.11.1 

type GeneratorFunc func(cmdName string) map[string]kubectl.Generator

GeneratorFunc returns the generators for the provided command 

var GeneratorFn GeneratorFunc = defaultGenerators

GeneratorFn gives a way to easily override the function for unit testing if needed

type MatchVersionFlags added in v1.11.1 

type MatchVersionFlags struct {
	Delegate genericclioptions.RESTClientGetter

	RequireMatchedServerVersion bool
	// contains filtered or unexported fields
}

MatchVersionFlags is for setting the "match server version" function.

func NewMatchVersionFlags added in v1.11.1 

func NewMatchVersionFlags(delegate genericclioptions.RESTClientGetter) *MatchVersionFlags

func (*MatchVersionFlags) AddFlags added in v1.11.1 

func (f *MatchVersionFlags) AddFlags(flags *pflag.FlagSet)

func (*MatchVersionFlags) ToDiscoveryClient added in v1.11.1 

func (f *MatchVersionFlags) ToDiscoveryClient() (discovery.CachedDiscoveryInterface, error)

func (*MatchVersionFlags) ToRESTConfig added in v1.11.1 

func (f *MatchVersionFlags) ToRESTConfig() (*rest.Config, error)

ToRESTConfig implements RESTClientGetter. Returns a REST client configuration based on a provided path to a .kubeconfig file, loading rules, and config flag overrides. Expects the AddFlags method to have been called.

func (*MatchVersionFlags) ToRESTMapper added in v1.11.1 

func (f *MatchVersionFlags) ToRESTMapper() (meta.RESTMapper, error)

RESTMapper returns a mapper.

func (*MatchVersionFlags) ToRawKubeConfigLoader added in v1.11.1 

func (f *MatchVersionFlags) ToRawKubeConfigLoader() clientcmd.ClientConfig

type ScaleClientFunc added in v1.11.1 

type ScaleClientFunc func(genericclioptions.RESTClientGetter) (scale.ScalesGetter, error)

ScaleClientFunc provides a ScalesGetter 

var ScaleClientFn ScaleClientFunc = scaleClient

ScaleClientFn gives a way to easily override the function for unit testing if needed.

type ValidateOptions added in v1.7.0 

type ValidateOptions struct {
	EnableValidation bool
}

Source Files

View all Source files

Directories

Path Synopsis
crlf
Package openapi is a collection of libraries for fetching the openapi spec from a Kubernetes server and then indexing the type definitions.
 Package openapi is a collection of libraries for fetching the openapi spec from a Kubernetes server and then indexing the type definitions.
testing
validation

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.