clientcmd

Documentation

Index

• Constants
• func AnonymousClientConfig(config kclient.Config) kclient.Config
• func BindClientConfigSecurityFlags(config *kclient.Config, flags *pflag.FlagSet)
• func DefaultClientConfig(flags *pflag.FlagSet) clientcmd.ClientConfig
• func EnvVars(host string, caData []byte, insecure bool, bearerTokenFile string) []api.EnvVar
• func GetPrettyMessageFor(err error) string
• func IsCertificateAuthorityUnknown(err error) bool
• func IsConfigurationInvalid(err error) bool
• func IsForbidden(err error) bool
• func IsNoServerFound(err error) bool
• type Config
  • func NewConfig() *Config
  • func (cfg *Config) Bind(flags *pflag.FlagSet)
  • func (cfg *Config) Clients() (osclient.Interface, kclient.Interface, error)
  • func (cfg *Config) KubeConfig() *kclient.Config
  • func (cfg *Config) OpenShiftConfig() *kclient.Config
• type Factory
  • func New(flags *pflag.FlagSet) *Factory
  • func NewFactory(clientConfig kclientcmd.ClientConfig) *Factory
  • func (f *Factory) Clients() (*client.Client, *kclient.Client, error)
  • func (f *Factory) UpdatePodSpecForObject(obj runtime.Object, fn func(*api.PodSpec) error) (bool, error)
• type ShortcutExpander
  • func (e ShortcutExpander) AliasesForResource(resource string) ([]string, bool)
  • func (e ShortcutExpander) ResourceIsValid(resource string) bool
  • func (e ShortcutExpander) VersionAndKindForResource(resource string) (defaultVersion, kind string, err error)

Constants

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

Functions

func AnonymousClientConfig

func AnonymousClientConfig(config kclient.Config) kclient.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 *kclient.Config, flags *pflag.FlagSet)

BindClientConfigSecurityFlags adds flags for the supplied client config

func DefaultClientConfig

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

func EnvVars

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

func GetPrettyMessageFor

func GetPrettyMessageFor(err error) string

GetPrettyMessageFor 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 IsConfigurationInvalid

func IsConfigurationInvalid(err error) bool

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

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

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 kclient.Config
	// Namespace is the namespace to act in
	Namespace string

	// If set, allow kubeconfig file loading
	FromFile 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) Clients

func (cfg *Config) Clients() (osclient.Interface, kclient.Interface, error)

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

func (*Config) KubeConfig

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

KubeConfig returns the Kubernetes configuration

func (*Config) OpenShiftConfig

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

OpenShiftConfig returns the OpenShift configuration

type Factory

type Factory struct {
	*cmdutil.Factory
	OpenShiftClientConfig kclientcmd.ClientConfig
	// contains filtered or unexported fields
}

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(clientConfig kclientcmd.ClientConfig) *Factory

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

func (*Factory) Clients

func (f *Factory) Clients() (*client.Client, *kclient.Client, error)

Clients returns an OpenShift and Kubernetes client.

func (*Factory) UpdatePodSpecForObject

func (f *Factory) UpdatePodSpecForObject(obj runtime.Object, fn func(*api.PodSpec) error) (bool, error)

UpdatePodSpecForObject update the pod specification for the provided object TODO: move to upstream

type ShortcutExpander

type ShortcutExpander struct {
	meta.RESTMapper
}

ShortcutExpander is a RESTMapper that can be used for OpenShift resources.

func (ShortcutExpander) AliasesForResource

func (e ShortcutExpander) AliasesForResource(resource string) ([]string, bool)

AliasesForResource returns whether a resource has an alias or not

func (ShortcutExpander) ResourceIsValid

func (e ShortcutExpander) ResourceIsValid(resource string) bool

ResourceIsValid takes a string (kind) and checks if it's a valid resource. It expands the resource first, then invokes the wrapped mapper.

func (ShortcutExpander) VersionAndKindForResource

func (e ShortcutExpander) VersionAndKindForResource(resource string) (defaultVersion, kind string, err error)

VersionAndKindForResource implements meta.RESTMapper. It expands the resource first, then invokes the wrapped mapper.