clientcmd

package
v1.5.0-alpha.1 Latest Latest
Warning

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

 Go to latest Published: Dec 29, 2016 License: Apache-2.0 Imports: 61 Imported by: 0

Documentation

Index

Constants

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

Variables

This section is empty.

Functions

func AnonymousClientConfig added in v1.0.7 

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 added in v0.3.2 

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

func DefaultGenerators added in v1.1.3 

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

func EnvVars added in v0.6.1 

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

func FindAllCanonicalResources added in v1.3.0 

func FindAllCanonicalResources(d discovery.DiscoveryInterface, m meta.RESTMapper) ([]unversioned.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 GetPrettyErrorFor added in v1.3.0 

func GetPrettyErrorFor(err error) error

GetPrettyErrorFor prettifys the message of the provided error

func GetPrettyErrorForServer added in v1.3.0 

func GetPrettyErrorForServer(err error, serverName string) error

GetPrettyErrorForServer prettifys the message of the provided error

func GetPrettyMessageFor added in v0.4.2 

func GetPrettyMessageFor(err error) string

GetPrettyMessageFor prettifys the message of the provided error

func GetPrettyMessageForServer added in v1.3.0 

func GetPrettyMessageForServer(err error, serverName string) string

GetPrettyMessageForServer prettifys the message of the provided error

func IsCertificateAuthorityUnknown added in v0.4.2 

func IsCertificateAuthorityUnknown(err error) bool

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

func IsCertificateHostnameError added in v1.3.1 

func IsCertificateHostnameError(err error) bool

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

func IsCertificateInvalid added in v1.3.1 

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 added in v0.4.4 

func IsConfigurationInvalid(err error) bool

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

func IsConfigurationMissing added in v1.3.0 

func IsConfigurationMissing(err error) bool

func IsForbidden added in v0.4.2 

func IsForbidden(err error) bool

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

func IsNoServerFound added in v0.4.2 

func IsNoServerFound(err error) bool

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

func IsTLSOversizedRecord added in v1.3.0 

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 ResourceMapper added in v1.3.0 

func ResourceMapper(f *Factory) *resource.Mapper

Types

type CachedDiscoveryClient added in v1.1.4 

type CachedDiscoveryClient struct {
	discovery.DiscoveryInterface
	// contains filtered or unexported fields
}

CachedDiscoveryClient implements the functions that discovery server-supported API groups, versions and resources.

func NewCachedDiscoveryClient added in v1.1.4 

func NewCachedDiscoveryClient(delegate discovery.DiscoveryInterface, cacheDirectory string, ttl time.Duration) *CachedDiscoveryClient

NewCachedDiscoveryClient creates a new DiscoveryClient. cacheDirectory is the directory where discovery docs are held. It must be unique per host:port combination to work well.

func (*CachedDiscoveryClient) ServerGroups added in v1.1.4 

func (d *CachedDiscoveryClient) ServerGroups() (*unversioned.APIGroupList, error)

func (*CachedDiscoveryClient) ServerResources added in v1.1.4 

func (d *CachedDiscoveryClient) ServerResources() (map[string]*unversioned.APIResourceList, error)

ServerResources returns the supported resources for all groups and versions.

func (*CachedDiscoveryClient) ServerResourcesForGroupVersion added in v1.1.4 

func (d *CachedDiscoveryClient) ServerResourcesForGroupVersion(groupVersion string) (*unversioned.APIResourceList, error)

ServerResourcesForGroupVersion returns the supported resources for a group and version.

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 added in v1.1.4 

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, kclient.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 added in v0.3.2 

type Factory struct {
	*cmdutil.Factory
	OpenShiftClientConfig kclientcmd.ClientConfig

	ImageResolutionOptions FlagBinder

	PrintResourceInfos func(*cobra.Command, []*resource.Info, io.Writer) error
	// contains filtered or unexported fields
}

Factory provides common options for OpenShift commands

func New added in v0.3.2 

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 added in v0.3.2 

func NewFactory(clientConfig kclientcmd.ClientConfig) *Factory

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

func (*Factory) ApproximatePodTemplateForObject added in v1.1.4 

func (w *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) Clients added in v0.3.2 

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

Clients returns an OpenShift and Kubernetes client.

func (*Factory) ExtractFileContents added in v1.3.0 

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) OriginSwaggerSchema added in v1.1.3 

func (f *Factory) OriginSwaggerSchema(client *restclient.RESTClient, version unversioned.GroupVersion) (*swagger.ApiDeclaration, error)

OriginSwaggerSchema returns a swagger API doc for an Origin schema under the /oapi prefix.

func (*Factory) PodForResource added in v1.3.0 

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

func (*Factory) UpdateObjectEnvironment added in v1.1.4 

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

UpdateObjectEnvironment update the environment variables in object specification.

type FlagBinder added in v1.4.0 

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.

type ShortcutExpander added in v0.3.2 

type ShortcutExpander struct {
	RESTMapper meta.RESTMapper

	All []string
}

ShortcutExpander is a RESTMapper that can be used for OpenShift resources. It expands the resource first, then invokes the wrapped

func NewShortcutExpander added in v1.1.4 

func NewShortcutExpander(discoveryClient discovery.DiscoveryInterface, delegate meta.RESTMapper) ShortcutExpander

func (ShortcutExpander) AliasesForResource added in v0.4.4 

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

AliasesForResource returns whether a resource has an alias or not

func (ShortcutExpander) KindFor added in v1.1.2 

func (e ShortcutExpander) KindFor(resource unversioned.GroupVersionResource) (unversioned.GroupVersionKind, error)

func (ShortcutExpander) KindsFor added in v1.1.3 

func (e ShortcutExpander) KindsFor(resource unversioned.GroupVersionResource) ([]unversioned.GroupVersionKind, error)

func (ShortcutExpander) RESTMapping added in v1.1.3 

func (e ShortcutExpander) RESTMapping(gk unversioned.GroupKind, versions ...string) (*meta.RESTMapping, error)

func (ShortcutExpander) RESTMappings added in v1.3.0 

func (e ShortcutExpander) RESTMappings(gk unversioned.GroupKind) ([]*meta.RESTMapping, error)

func (ShortcutExpander) ResourceFor added in v1.1.3 

func (e ShortcutExpander) ResourceFor(resource unversioned.GroupVersionResource) (unversioned.GroupVersionResource, error)

func (ShortcutExpander) ResourceSingularizer added in v1.1.3 

func (e ShortcutExpander) ResourceSingularizer(resource string) (string, error)

func (ShortcutExpander) ResourcesFor added in v1.1.3 

func (e ShortcutExpander) ResourcesFor(resource unversioned.GroupVersionResource) ([]unversioned.GroupVersionResource, error)

Source Files

View all Source files

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.