client

Documentation

Index

• func IsResourceTypeNotFound(err error) bool
• func IsSubResource(resource *metav1.APIResource) bool
• type APIGroupMap
• type APIResourceMap
• type ErrorResourceTypeNotFound
  • func NewTypeNotFoundError(message string) ErrorResourceTypeNotFound
  • func (e ErrorResourceTypeNotFound) Error() string
• type KubeClient
  • func NewKubeClient(cfg *rest.Config, cluster string) (*KubeClient, error)
  • func (c *KubeClient) ClientForGVK(gvk schema.GroupVersionKind) (dynamic.NamespaceableResourceInterface, error)
  • func (c *KubeClient) ConfigForResource(name, preferredVersion string) (rest.Config, error)
  • func (c *KubeClient) DynamicClientForGroupKind(gk metav1.GroupKind) (dynamic.NamespaceableResourceInterface, error)
  • func (c *KubeClient) DynamicClientForResource(resource, version string) (dynamic.NamespaceableResourceInterface, error)
  • func (c *KubeClient) GetApiResourceByGroupKind(gk metav1.GroupKind) (*metav1.APIResource, error)
  • func (c *KubeClient) GetApiResourceByKind(kind string) (*metav1.APIResource, error)
  • func (c *KubeClient) GetApiResourceByKindInsensitive(kind string) (*metav1.APIResource, error)
  • func (c *KubeClient) GetApiResourceByName(name, preferredVersion string) (*metav1.APIResource, error)
  • func (c *KubeClient) GetApiResourceList() ([]*metav1.APIResourceList, error)
  • func (c *KubeClient) GetGroupVersionByName(name, preferredVersion string) (schema.GroupVersion, error)
  • func (c *KubeClient) GetGroupVersionList() (*metav1.APIGroupList, error)
  • func (c *KubeClient) GetResourceTypeByGroupKind(gk metav1.GroupKind) (string, error)
  • func (c *KubeClient) GetResourceTypeByKind(kind string) (string, error)
  • func (c *KubeClient) GetVersionByGroup(group string) (string, error)
  • func (c *KubeClient) IsClusterScopeResource(kind string) bool
  • func (c *KubeClient) IsNamespaceScoped(resource string) (bool, error)

Functions

func IsResourceTypeNotFound

func IsResourceTypeNotFound(err error) bool

func IsSubResource

func IsSubResource(resource *metav1.APIResource) bool

Types

type APIGroupMap

type APIGroupMap struct {
	// index by cluster
	M map[string]*metav1.APIGroupList
	sync.RWMutex
}

type APIResourceMap

type APIResourceMap struct {
	// index by cluster
	M map[string][]*metav1.APIResourceList
	sync.RWMutex
}

type ErrorResourceTypeNotFound

type ErrorResourceTypeNotFound struct {
	// contains filtered or unexported fields
}

func NewTypeNotFoundError

func NewTypeNotFoundError(message string) ErrorResourceTypeNotFound

func (ErrorResourceTypeNotFound) Error

func (e ErrorResourceTypeNotFound) Error() string

type KubeClient

type KubeClient struct {
	// contains filtered or unexported fields
}

func NewKubeClient

func NewKubeClient(cfg *rest.Config, cluster string) (*KubeClient, error)

func (*KubeClient) ClientForGVK

func (c *KubeClient) ClientForGVK(gvk schema.GroupVersionKind) (dynamic.NamespaceableResourceInterface, error)

func (*KubeClient) ConfigForResource

func (c *KubeClient) ConfigForResource(name, preferredVersion string) (rest.Config, error)

ConfigForResource generates the REST config of k8s client for the resource type and version

func (*KubeClient) DynamicClientForGroupKind

func (c *KubeClient) DynamicClientForGroupKind(gk metav1.GroupKind) (dynamic.NamespaceableResourceInterface, error)

DynamicClientForResource get dynamic client for resource

func (*KubeClient) DynamicClientForResource

func (c *KubeClient) DynamicClientForResource(resource, version string) (dynamic.NamespaceableResourceInterface, error)

DynamicClientForResource get dynamic client for resource

func (*KubeClient) GetApiResourceByGroupKind

func (c *KubeClient) GetApiResourceByGroupKind(gk metav1.GroupKind) (*metav1.APIResource, error)

GetApiResourceByGroupKind get api resource by GroupKind

func (*KubeClient) GetApiResourceByKind

func (c *KubeClient) GetApiResourceByKind(kind string) (*metav1.APIResource, error)

GetApiResourceByKind get api resource by kind

func (*KubeClient) GetApiResourceByKindInsensitive

func (c *KubeClient) GetApiResourceByKindInsensitive(kind string) (*metav1.APIResource, error)

GetApiResourceByKindInsensitive get api resource by kind, but ignore case when compare

func (*KubeClient) GetApiResourceByName

func (c *KubeClient) GetApiResourceByName(name, preferredVersion string) (*metav1.APIResource, error)

GetApiResourceByName gets APIResource by the resource type name and the preferred api version. If the preferredVersion not exist, the first available version will be returned.

func (*KubeClient) GetApiResourceList

func (c *KubeClient) GetApiResourceList() ([]*metav1.APIResourceList, error)

GetResourceList gets api resource list of the cluster.

func (*KubeClient) GetGroupVersionByName

func (c *KubeClient) GetGroupVersionByName(name, preferredVersion string) (schema.GroupVersion, error)

GetGroupVersionByName gets the group version of a resource by it's type name and the preferred api version.

func (*KubeClient) GetGroupVersionList

func (c *KubeClient) GetGroupVersionList() (*metav1.APIGroupList, error)

func (*KubeClient) GetResourceTypeByGroupKind

func (c *KubeClient) GetResourceTypeByGroupKind(gk metav1.GroupKind) (string, error)

GetResourceTypeByGroupKind gets the name of resource type by the resource Groupkind. eg: Deployment -> deployments

func (*KubeClient) GetResourceTypeByKind

func (c *KubeClient) GetResourceTypeByKind(kind string) (string, error)

GetResourceByKind gets the name of resource type by the resource kind. eg: Deployment -> deployments

func (*KubeClient) GetVersionByGroup

func (c *KubeClient) GetVersionByGroup(group string) (string, error)

GetVersionByGroup gets the preferred version of a group.

func (*KubeClient) IsClusterScopeResource

func (c *KubeClient) IsClusterScopeResource(kind string) bool

func (*KubeClient) IsNamespaceScoped

func (c *KubeClient) IsNamespaceScoped(resource string) (bool, error)