clientcmd

Documentation

Index

• func AsVersionedObject(infos []*resource.Info, forceList bool, version schema.GroupVersion, ...) (runtime.Object, error)
• func AsVersionedObjects(infos []*resource.Info, version schema.GroupVersion, encoder runtime.Encoder) ([]runtime.Object, error)
• func ConvertExteralPodSpecToInternal(inFn func(*corev1.PodSpec) error) func(*kapi.PodSpec) error
• func ConvertInteralPodSpecToExternal(inFn func(*kapi.PodSpec) error) func(*corev1.PodSpec) error
• func DefaultGenerators(cmdName string) map[string]kubectl.Generator
• func FindAllCanonicalResources(d discovery.DiscoveryInterface, m meta.RESTMapper) ([]schema.GroupResource, error)
• func NewBuilderFactory(clientAccessFactory kcmdutil.ClientAccessFactory, ...) kcmdutil.BuilderFactory
• func NewClientAccessFactory(optionalClientConfig kclientcmd.ClientConfig) kcmdutil.ClientAccessFactory
• func NewObjectMappingFactory(clientAccessFactory kcmdutil.ClientAccessFactory) kcmdutil.ObjectMappingFactory
• func ParseDockerImageReferenceToStringFunc(spec string) (string, error)
• func ResourceMapper(f kcmdutil.Factory) *resource.Mapper
• type Config
  • func (cfg *Config) Clients() (kclientset.Interface, error)
  • func (cfg *Config) KubeConfig() *restclient.Config
  • func (cfg *Config) OpenShiftConfig() *restclient.Config
• type Factory
  • func New(flags *pflag.FlagSet) *Factory
  • func NewFactory(optionalClientConfig kclientcmd.ClientConfig) *Factory
  • func (f *Factory) ApproximatePodTemplateForObject(object runtime.Object) (*api.PodTemplateSpec, error)
  • func (f *Factory) ExtractFileContents(obj runtime.Object) (map[string][]byte, bool, error)
  • func (f *Factory) PodForResource(resource string, timeout time.Duration) (string, error)
  • func (f *Factory) PrintResourceInfos(cmd *cobra.Command, isLocal bool, infos []*resource.Info, out io.Writer) error
  • func (f *Factory) UpdateObjectEnvironment(obj runtime.Object, fn func(*[]api.EnvVar) error) (bool, error)
• type FlagBinder

Functions

func AsVersionedObject

func AsVersionedObject(infos []*resource.Info, forceList bool, version schema.GroupVersion, encoder runtime.Encoder) (runtime.Object, error)

AsVersionedObject converts a list of infos into a single object - either a List containing the objects as children, or if only a single Object is present, as that object. The provided version will be preferred as the conversion target, but the Object's mapping version will be used if that version is not present.

func AsVersionedObjects

func AsVersionedObjects(infos []*resource.Info, version schema.GroupVersion, encoder runtime.Encoder) ([]runtime.Object, error)

AsVersionedObjects converts a list of infos into versioned objects. The provided version will be preferred as the conversion target, but the Object's mapping version will be used if that version is not present.

func ConvertExteralPodSpecToInternal

func ConvertExteralPodSpecToInternal(inFn func(*corev1.PodSpec) error) func(*kapi.PodSpec) error

func ConvertInteralPodSpecToExternal

func ConvertInteralPodSpecToExternal(inFn func(*kapi.PodSpec) error) func(*corev1.PodSpec) error

func DefaultGenerators

func DefaultGenerators(cmdName string) map[string]kubectl.Generator

func FindAllCanonicalResources

func FindAllCanonicalResources(d discovery.DiscoveryInterface, m meta.RESTMapper) ([]schema.GroupResource, error)

FindAllCanonicalResources returns all resource names that map directly to their kind (Kind -> Resource -> Kind) and are not subresources. This is the closest mapping possible from the client side to resources that can be listed and updated. Note that this may return some virtual resources (like imagestreamtags) that can be otherwise represented. TODO: add a field to APIResources for "virtual" (or that points to the canonical resource). TODO: fallback to the scheme when discovery is not possible.

func NewBuilderFactory

func NewBuilderFactory(clientAccessFactory kcmdutil.ClientAccessFactory, objectMappingFactory kcmdutil.ObjectMappingFactory) kcmdutil.BuilderFactory

func NewClientAccessFactory

func NewClientAccessFactory(optionalClientConfig kclientcmd.ClientConfig) kcmdutil.ClientAccessFactory

func NewObjectMappingFactory

func NewObjectMappingFactory(clientAccessFactory kcmdutil.ClientAccessFactory) kcmdutil.ObjectMappingFactory

func ParseDockerImageReferenceToStringFunc

func ParseDockerImageReferenceToStringFunc(spec string) (string, error)

func ResourceMapper

func ResourceMapper(f kcmdutil.Factory) *resource.Mapper

Types

type Config

type Config struct {
	// MasterAddr is the address the master can be reached on (host, host:port, or URL).
	MasterAddr flagtypes.Addr
	// KubernetesAddr is the address of the Kubernetes server (host, host:port, or URL).
	// If omitted defaults to the master.
	KubernetesAddr flagtypes.Addr
	// CommonConfig is the shared base config for both the OpenShift config and Kubernetes config
	CommonConfig restclient.Config
	// Namespace is the namespace to act in
	Namespace string

	// If set, allow kubeconfig file loading
	FromFile bool
	// If true, no environment is loaded (for testing, primarily)
	SkipEnv bool
	// contains filtered or unexported fields
}

Config contains all the necessary bits for client configuration

func (*Config) Clients

func (cfg *Config) Clients() (kclientset.Interface, error)

Clients returns an OpenShift and a Kubernetes client from a given configuration

func (*Config) KubeConfig

func (cfg *Config) KubeConfig() *restclient.Config

KubeConfig returns the Kubernetes configuration

func (*Config) OpenShiftConfig

func (cfg *Config) OpenShiftConfig() *restclient.Config

OpenShiftConfig returns the OpenShift configuration

type Factory

type Factory struct {
	kcmdutil.ClientAccessFactory
	kcmdutil.ObjectMappingFactory
	kcmdutil.BuilderFactory
}

Factory provides common options for OpenShift commands

func New

func New(flags *pflag.FlagSet) *Factory

New creates a default Factory for commands that should share identical server connection behavior. Most commands should use this method to get a factory.

func NewFactory

func NewFactory(optionalClientConfig kclientcmd.ClientConfig) *Factory

NewFactory creates an object that holds common methods across all OpenShift commands

func (*Factory) ApproximatePodTemplateForObject

func (f *Factory) ApproximatePodTemplateForObject(object runtime.Object) (*api.PodTemplateSpec, error)

ApproximatePodTemplateForObject returns a pod template object for the provided source. It may return both an error and a object. It attempt to return the best possible template available at the current time.

func (*Factory) ExtractFileContents

func (f *Factory) ExtractFileContents(obj runtime.Object) (map[string][]byte, bool, error)

ExtractFileContents returns a map of keys to contents, false if the object cannot support such an operation, or an error.

func (*Factory) PodForResource

func (f *Factory) PodForResource(resource string, timeout time.Duration) (string, error)

func (*Factory) PrintResourceInfos

func (f *Factory) PrintResourceInfos(cmd *cobra.Command, isLocal bool, infos []*resource.Info, out io.Writer) error

PrintResourceInfos receives a list of resource infos and prints versioned objects if a generic output format was specified otherwise, it iterates through info objects, printing each resource with a unique printer for its mapping

func (*Factory) UpdateObjectEnvironment

func (f *Factory) UpdateObjectEnvironment(obj runtime.Object, fn func(*[]api.EnvVar) error) (bool, error)

UpdateObjectEnvironment update the environment variables in object specification.

type FlagBinder

type FlagBinder interface {
	// Bound returns true if the flag is already bound to a command.
	Bound() bool
	// Bind allows to bind an extra flag to a command
	Bind(*pflag.FlagSet)
}

FlagBinder represents an interface that allows to bind extra flags into commands.