clientcmd

Documentation

Index

• Constants
• func AnonymousClientConfig(config *restclient.Config) restclient.Config
• func BindClientConfigSecurityFlags(config *restclient.Config, flags *pflag.FlagSet)
• func DefaultClientConfig(flags *pflag.FlagSet) kclientcmd.ClientConfig
• func DefaultGenerators(cmdName string) map[string]kubectl.Generator
• func EnvVars(host string, caData []byte, insecure bool, bearerTokenFile string) []api.EnvVar
• func FindAllCanonicalResources(d discovery.DiscoveryInterface, m meta.RESTMapper) ([]schema.GroupResource, error)
• func Gate(ocClient *client.Client, minServerVersion, maxServerVersion string) error
• func GetPrettyErrorFor(err error) error
• func GetPrettyErrorForServer(err error, serverName string) error
• func GetPrettyMessageFor(err error) string
• func GetPrettyMessageForServer(err error, serverName string) string
• func IsCertificateAuthorityUnknown(err error) bool
• func IsCertificateHostnameError(err error) bool
• func IsCertificateInvalid(err error) bool
• func IsConfigurationInvalid(err error) bool
• func IsConfigurationMissing(err error) bool
• func IsForbidden(err error) bool
• func IsNoServerFound(err error) bool
• func IsTLSOversizedRecord(err error) bool
• func NewObjectMappingFactory(clientAccessFactory ClientAccessFactory) kcmdutil.ObjectMappingFactory
• func ResourceMapper(f kcmdutil.Factory) *resource.Mapper
• type ClientAccessFactory
  • func NewClientAccessFactory(optionalClientConfig kclientcmd.ClientConfig) ClientAccessFactory
• type Config
  • func NewConfig() *Config
  • func (cfg *Config) Bind(flags *pflag.FlagSet)
  • func (cfg *Config) BindToFile() *Config
  • func (cfg *Config) Clients() (osclient.Interface, 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

Constants

const ConfigSyntax = " --master=<addr>"

Functions

func AnonymousClientConfig

func AnonymousClientConfig(config *restclient.Config) restclient.Config

AnonymousClientConfig returns a copy of the given config with all user credentials (cert/key, bearer token, and username/password) removed

func BindClientConfigSecurityFlags

func BindClientConfigSecurityFlags(config *restclient.Config, flags *pflag.FlagSet)

BindClientConfigSecurityFlags adds flags for the supplied client config

func DefaultClientConfig

func DefaultClientConfig(flags *pflag.FlagSet) kclientcmd.ClientConfig

func DefaultGenerators

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

func EnvVars

func EnvVars(host string, caData []byte, insecure bool, bearerTokenFile string) []api.EnvVar

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 Gate

func Gate(ocClient *client.Client, minServerVersion, maxServerVersion string) error

Gate returns an error if the server is below minServerVersion or above/equal maxServerVersion. To test only for min or only max version, set the other string to the empty value.

func GetPrettyErrorFor

func GetPrettyErrorFor(err error) error

GetPrettyErrorFor prettifys the message of the provided error

func GetPrettyErrorForServer

func GetPrettyErrorForServer(err error, serverName string) error

GetPrettyErrorForServer prettifys the message of the provided error

func GetPrettyMessageFor

func GetPrettyMessageFor(err error) string

GetPrettyMessageFor prettifys the message of the provided error

func GetPrettyMessageForServer

func GetPrettyMessageForServer(err error, serverName string) string

GetPrettyMessageForServer prettifys the message of the provided error

func IsCertificateAuthorityUnknown

func IsCertificateAuthorityUnknown(err error) bool

IsCertificateAuthorityUnknown checks whether the provided error is a 'certificate authority unknown' error or not

func IsCertificateHostnameError

func IsCertificateHostnameError(err error) bool

IsCertificateHostnameError checks whether the set of authorized names doesn't match the requested name

func IsCertificateInvalid

func IsCertificateInvalid(err error) bool

IsCertificateInvalid checks whether the certificate is invalid for reasons like expired, CA not authorized to sign, there are too many cert intermediates, or the cert usage is not valid for the wanted purpose.

func IsConfigurationInvalid

func IsConfigurationInvalid(err error) bool

IsConfigurationInvalid checks whether the provided error is a 'invalid configuration' error or not

func IsConfigurationMissing

func IsConfigurationMissing(err error) bool

func IsForbidden

func IsForbidden(err error) bool

IsForbidden checks whether the provided error is a 'forbidden' error or not

func IsNoServerFound

func IsNoServerFound(err error) bool

IsNoServerFound checks whether the provided error is a 'no server found' error or not

func IsTLSOversizedRecord

func IsTLSOversizedRecord(err error) bool

IsTLSOversizedRecord checks whether the provided error is a url.Error with "tls: oversized record received", which usually means TLS not supported.

func NewObjectMappingFactory

func NewObjectMappingFactory(clientAccessFactory ClientAccessFactory) kcmdutil.ObjectMappingFactory

func ResourceMapper

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

Types

type ClientAccessFactory

type ClientAccessFactory interface {
	kcmdutil.ClientAccessFactory

	Clients() (*client.Client, kclientset.Interface, error)
	OpenShiftClientConfig() kclientcmd.ClientConfig
	ImageResolutionOptions() FlagBinder
}

func NewClientAccessFactory

func NewClientAccessFactory(optionalClientConfig kclientcmd.ClientConfig) ClientAccessFactory

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 NewConfig

func NewConfig() *Config

NewConfig returns a new configuration

func (*Config) Bind

func (cfg *Config) Bind(flags *pflag.FlagSet)

Bind binds configuration values to the passed flagset

func (*Config) BindToFile

func (cfg *Config) BindToFile() *Config

BindToFile is used when this config will not be bound to flags, but should load the config file from disk if available.

func (*Config) Clients

func (cfg *Config) Clients() (osclient.Interface, 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 {
	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.