Documentation ¶
Index ¶
- Variables
- func GVK() schema.GroupVersionKind
- func GVR() schema.GroupVersionResource
- func Group() string
- func Kind() string
- func Resource() string
- func Version() string
- type Handler
- func (h *Handler) Apply(obj interface{}) (*corev1.ConfigMap, error)
- func (h *Handler) ApplyFromBytes(data []byte) (cm *corev1.ConfigMap, err error)
- func (h *Handler) ApplyFromFile(filename string) (cm *corev1.ConfigMap, err error)
- func (h *Handler) ApplyFromMap(u map[string]interface{}) (*corev1.ConfigMap, error)
- func (h *Handler) ApplyFromObject(obj runtime.Object) (*corev1.ConfigMap, error)
- func (h *Handler) ApplyFromUnstructured(u *unstructured.Unstructured) (*corev1.ConfigMap, error)
- func (h *Handler) Clientset() *kubernetes.Clientset
- func (h *Handler) ConfigMapInformer() informerscore.ConfigMapInformer
- func (h *Handler) Create(obj interface{}) (*corev1.ConfigMap, error)
- func (h *Handler) CreateFromBytes(data []byte) (*corev1.ConfigMap, error)
- func (h *Handler) CreateFromFile(filename string) (*corev1.ConfigMap, error)
- func (h *Handler) CreateFromMap(u map[string]interface{}) (*corev1.ConfigMap, error)
- func (h *Handler) CreateFromObject(obj runtime.Object) (*corev1.ConfigMap, error)
- func (h *Handler) CreateFromUnstructured(u *unstructured.Unstructured) (*corev1.ConfigMap, error)
- func (in *Handler) DeepCopy() *Handler
- func (h *Handler) Delete(obj interface{}) error
- func (h *Handler) DeleteByName(name string) error
- func (h *Handler) DeleteFromBytes(data []byte) error
- func (h *Handler) DeleteFromFile(filename string) error
- func (h *Handler) DeleteFromMap(u map[string]interface{}) error
- func (h *Handler) DeleteFromObject(obj runtime.Object) error
- func (h *Handler) DeleteFromUnstructured(u *unstructured.Unstructured) error
- func (h *Handler) DiscoveryClient() *discovery.DiscoveryClient
- func (h *Handler) DynamicClient() dynamic.Interface
- func (h *Handler) Get(obj interface{}) (*corev1.ConfigMap, error)
- func (h *Handler) GetAge(object interface{}) (time.Duration, error)
- func (h *Handler) GetByName(name string) (*corev1.ConfigMap, error)
- func (h *Handler) GetData(object interface{}) (map[string]string, error)
- func (h *Handler) GetFromBytes(data []byte) (*corev1.ConfigMap, error)
- func (h *Handler) GetFromFile(filename string) (*corev1.ConfigMap, error)
- func (h *Handler) GetFromMap(u map[string]interface{}) (*corev1.ConfigMap, error)
- func (h *Handler) GetFromObject(obj runtime.Object) (*corev1.ConfigMap, error)
- func (h *Handler) GetFromUnstructured(u *unstructured.Unstructured) (*corev1.ConfigMap, error)
- func (h *Handler) Informer() cache.SharedIndexInformer
- func (h *Handler) InformerFactory() informers.SharedInformerFactory
- func (h *Handler) List() ([]*corev1.ConfigMap, error)
- func (h *Handler) ListAll() ([]*corev1.ConfigMap, error)
- func (h *Handler) ListByField(field string) ([]*corev1.ConfigMap, error)
- func (h *Handler) ListByLabel(labels string) ([]*corev1.ConfigMap, error)
- func (h *Handler) ListByNamespace(namespace string) ([]*corev1.ConfigMap, error)
- func (h *Handler) Lister() listerscore.ConfigMapLister
- func (h *Handler) NumData(object interface{}) (int, error)
- func (h *Handler) RESTClient() *rest.RESTClient
- func (h *Handler) RESTConfig() *rest.Config
- func (h *Handler) RunInformer(stopCh <-chan struct{}, addFunc func(obj interface{}), ...)
- func (h *Handler) SetForceDelete(force bool)
- func (h *Handler) SetInformerFactoryNamespace(namespace string)
- func (h *Handler) SetInformerFactoryResyncPeriod(resyncPeriod time.Duration)
- func (h *Handler) SetInformerFactoryTweakListOptions(tweakListOptions internalinterfaces.TweakListOptionsFunc)
- func (h *Handler) SetLimit(limit int64)
- func (h *Handler) SetTimeout(timeout int64)
- func (h *Handler) StartInformer(stopCh <-chan struct{}, addFunc func(obj interface{}), ...)
- func (h *Handler) Update(obj interface{}) (*corev1.ConfigMap, error)
- func (h *Handler) UpdateFromBytes(data []byte) (*corev1.ConfigMap, error)
- func (h *Handler) UpdateFromFile(filename string) (*corev1.ConfigMap, error)
- func (h *Handler) UpdateFromMap(u map[string]interface{}) (*corev1.ConfigMap, error)
- func (h *Handler) UpdateFromObject(obj runtime.Object) (*corev1.ConfigMap, error)
- func (h *Handler) UpdateFromUnstructured(u *unstructured.Unstructured) (*corev1.ConfigMap, error)
- func (h *Handler) Watch(name string, addFunc, modifyFunc, deleteFunc func(x interface{}), ...) (err error)
- func (h *Handler) WatchByLabel(labels string, addFunc, modifyFunc, deleteFunc func(x interface{}), ...) (err error)
- func (h *Handler) WatchByName(name string, addFunc, modifyFunc, deleteFunc func(x interface{}), ...) (err error)
- func (h *Handler) WithDryRun() *Handler
- func (h *Handler) WithNamespace(namespace string) *Handler
Constants ¶
This section is empty.
Variables ¶
var ( ErrInvalidToolsType = errors.New("type must be string, *corev1.ConfigMap, corev1.ConfigMap or runtime.Object") ErrInvalidCreateType = errors.New("type must be string, []byte, *corev1.ConfigMap, corev1.ConfigMap, runtime.Object, *unstructured.Unstructured, unstructured.Unstructured or map[string]interface{}") ErrInvalidUpdateType = ErrInvalidCreateType ErrInvalidApplyType = ErrInvalidCreateType ErrInvalidDeleteType = ErrInvalidCreateType ErrInvalidGetType = ErrInvalidCreateType )
Functions ¶
func GVK ¶ added in v0.6.1
func GVK() schema.GroupVersionKind
GVK returns the name of Group, Version, Kind of configmap resource.
func GVR ¶ added in v0.5.0
func GVR() schema.GroupVersionResource
GVR returns the name of Group, Version, Resource of configmap resource.
func Group ¶ added in v0.5.0
func Group() string
Group returns the Group name of configmap resource.
Types ¶
type Handler ¶
type Handler struct { Options *types.HandlerOptions // contains filtered or unexported fields }
func New ¶
New returns a configmap handler from kubeconfig or in-cluster config. The kubeconfig precedence is: * kubeconfig variable passed. * KUBECONFIG environment variable pointing at a file. * $HOME/.kube/config if exists. * In-cluster config if running in cluster.
func NewOrDie ¶ added in v0.3.0
NewOrDie simply call New() to get a configmap handler. panic if there is any error occurs.
func (*Handler) Apply ¶
Apply applies configmap from type string, []byte, *corev1.ConfigMap, corev1.ConfigMap, runtime.Object, *unstructured.Unstructured, unstructured.Unstructured or map[string]interface{}.
func (*Handler) ApplyFromBytes ¶
ApplyFromBytes pply configmap from bytes.
func (*Handler) ApplyFromFile ¶
ApplyFromFile applies configmap from yaml file.
func (*Handler) ApplyFromMap ¶ added in v0.5.0
ApplyFromMap applies configmap from map[string]interface{}.
func (*Handler) ApplyFromObject ¶ added in v0.3.0
ApplyFromObject applies configmap from runtime.Object.
func (*Handler) ApplyFromUnstructured ¶ added in v0.3.0
func (h *Handler) ApplyFromUnstructured(u *unstructured.Unstructured) (*corev1.ConfigMap, error)
ApplyFromUnstructured applies configmap from *unstructured.Unstructured.
func (*Handler) Clientset ¶ added in v0.2.0
func (h *Handler) Clientset() *kubernetes.Clientset
Clientset returns underlying clientset.
func (*Handler) ConfigMapInformer ¶ added in v0.5.0
func (h *Handler) ConfigMapInformer() informerscore.ConfigMapInformer
ConfigMapInformer returns underlying ConfigMapInformer which provides access to a shared informer and lister for configmap.
func (*Handler) Create ¶
Create creates configmap from type string, []byte, *corev1.ConfigMap, corev1.ConfigMap, runtime.Object, *unstructured.Unstructured, unstructured.Unstructured or map[string]interface{}.
func (*Handler) CreateFromBytes ¶
CreateFromBytes creates configmap from bytes.
func (*Handler) CreateFromFile ¶
CreateFromFile creates configmap from yaml file.
func (*Handler) CreateFromMap ¶ added in v0.5.0
CreateFromMap creates configmap from map[string]interface{}.
func (*Handler) CreateFromObject ¶ added in v0.3.0
CreateFromObject creates configmap from runtime.Object.
func (*Handler) CreateFromUnstructured ¶ added in v0.3.0
func (h *Handler) CreateFromUnstructured(u *unstructured.Unstructured) (*corev1.ConfigMap, error)
CreateFromUnstructured creates configmap from *unstructured.Unstructured.
func (*Handler) Delete ¶
Delete deletes configmap from type string, []byte, *corev1.ConfigMap, corev1.ConfigMap, runtime.Object, *unstructured.Unstructured, unstructured.Unstructured or map[string]interface{}.
If passed parameter type is string, it will simply call DeleteByName instead of DeleteFromFile. You should always explicitly call DeleteFromFile to delete a configmap from file path.
func (*Handler) DeleteByName ¶
DeleteByName deletes configmap by name.
func (*Handler) DeleteFromBytes ¶
DeleteFromBytes deletes configmap from bytes.
func (*Handler) DeleteFromFile ¶
DeleteFromFile deletes configmap from yaml file.
func (*Handler) DeleteFromMap ¶ added in v0.5.0
DeleteFromMap deletes configmap from map[string]interface{}.
func (*Handler) DeleteFromObject ¶ added in v0.3.0
DeleteFromObject deletes configmap from runtime.Object.
func (*Handler) DeleteFromUnstructured ¶ added in v0.3.0
func (h *Handler) DeleteFromUnstructured(u *unstructured.Unstructured) error
DeleteFromUnstructured deletes configmap from *unstructured.Unstructured.
func (*Handler) DiscoveryClient ¶ added in v0.2.0
func (h *Handler) DiscoveryClient() *discovery.DiscoveryClient
DiscoveryClient returns underlying discovery client.
func (*Handler) DynamicClient ¶ added in v0.2.0
DynamicClient returns underlying dynamic client.
func (*Handler) Get ¶
Get gets configmap from type string, []byte, *corev1.ConfigMap, corev1.ConfigMap, runtime.Object, *unstructured.Unstructured, unstructured.Unstructured or map[string]interface{}.
If passed parameter type is string, it will simply call GetByName instead of GetFromFile. You should always explicitly call GetFromFile to get a configmap from file path.
func (*Handler) GetFromBytes ¶
GetFromBytes gets configmap from bytes.
func (*Handler) GetFromFile ¶
GetFromFile gets configmap from yaml file.
func (*Handler) GetFromMap ¶ added in v0.5.0
GetFromMap gets configmap from map[string]interface{}.
func (*Handler) GetFromObject ¶ added in v0.3.0
GetFromObject gets configmap from runtime.Object.
func (*Handler) GetFromUnstructured ¶ added in v0.3.0
func (h *Handler) GetFromUnstructured(u *unstructured.Unstructured) (*corev1.ConfigMap, error)
GetFromUnstructured gets configmap from *unstructured.Unstructured.
func (*Handler) Informer ¶ added in v0.5.0
func (h *Handler) Informer() cache.SharedIndexInformer
Informer returns underlying SharedIndexInformer which provides add and Indexers ability based on SharedInformer.
func (*Handler) InformerFactory ¶ added in v0.5.0
func (h *Handler) InformerFactory() informers.SharedInformerFactory
InformerFactory returns underlying SharedInformerFactory which provides shared informer for resources in all known API group version.
func (*Handler) ListByField ¶ added in v0.7.0
ListByField list configmaps by field, work like `kubectl get xxx --field-selector=xxx`.
func (*Handler) ListByLabel ¶
ListByLabel list configmaps by labels. Multiple labels separated by comma(",") eg: "name=myapp,role=devops", and there is an "And" relationship between multiple labels.
func (*Handler) ListByNamespace ¶
ListByNamespace list all configmaps in the specified namespace.
func (*Handler) Lister ¶ added in v0.5.0
func (h *Handler) Lister() listerscore.ConfigMapLister
Lister returns underlying ConfigMapLister which helps list configmaps.
func (*Handler) RESTClient ¶ added in v0.2.0
func (h *Handler) RESTClient() *rest.RESTClient
RESTClient returns underlying rest client.
func (*Handler) RESTConfig ¶ added in v0.3.0
RESTConfig returns underlying rest config.
func (*Handler) RunInformer ¶
func (h *Handler) RunInformer( stopCh <-chan struct{}, addFunc func(obj interface{}), updateFunc func(oldObj, newObj interface{}), deleteFunc func(obj interface{}))
RunInformer start and run the shared informer, returning after it stops. The informer will be stopped when stopCh is closed.
AddFunc, updateFunc, and deleteFunc are used to handle add, update, and delete event of k8s configmap resource, respectively.
func (*Handler) SetForceDelete ¶
func (*Handler) SetInformerFactoryNamespace ¶ added in v0.10.4
SetInformerFactoryNamespace limit the scope of informer list-and-watch k8s resource. informer list-and-watch all namespace k8s resource by default.
func (*Handler) SetInformerFactoryResyncPeriod ¶ added in v0.10.4
SetInformerFactoryResyncPeriod will set informer resync period.
func (*Handler) SetInformerFactoryTweakListOptions ¶ added in v0.10.4
func (h *Handler) SetInformerFactoryTweakListOptions(tweakListOptions internalinterfaces.TweakListOptionsFunc)
SetInformerFactoryTweakListOptions sets a custom filter on all listers of the configured SharedInformerFactory.
func (*Handler) SetTimeout ¶
func (*Handler) StartInformer ¶ added in v0.10.1
func (h *Handler) StartInformer( stopCh <-chan struct{}, addFunc func(obj interface{}), updateFunc func(oldObj, newObj interface{}), deleteFunc func(obj interface{}))
StartInformer simply call RunInformer.
func (*Handler) Update ¶
Update updates configmap from type string, []byte, *corev1.ConfigMap, corev1.ConfigMap, runtime.Object, *unstructured.Unstructured, unstructured.Unstructured or map[string]interface{}.
func (*Handler) UpdateFromBytes ¶
UpdateFromBytes updates configmap from bytes.
func (*Handler) UpdateFromFile ¶
UpdateFromFile updates configmap from yaml file.
func (*Handler) UpdateFromMap ¶ added in v0.5.0
UpdateFromMap updates configmap from map[string]interface{}.
func (*Handler) UpdateFromObject ¶ added in v0.3.0
UpdateFromObject updates configmap from runtime.Object.
func (*Handler) UpdateFromUnstructured ¶ added in v0.3.0
func (h *Handler) UpdateFromUnstructured(u *unstructured.Unstructured) (*corev1.ConfigMap, error)
UpdateFromUnstructured updates configmap from *unstructured.Unstructured.
func (*Handler) Watch ¶
func (h *Handler) Watch(name string, addFunc, modifyFunc, deleteFunc func(x interface{}), x interface{}) (err error)
WatchByName watch configmap by name, alias to "WatchByName".
func (*Handler) WatchByLabel ¶
func (h *Handler) WatchByLabel(labels string, addFunc, modifyFunc, deleteFunc func(x interface{}), x interface{}) (err error)
WatchByLabel watch configmap by labels.
func (*Handler) WatchByName ¶
func (h *Handler) WatchByName(name string, addFunc, modifyFunc, deleteFunc func(x interface{}), x interface{}) (err error)
WatchByName watch configmap by name.
func (*Handler) WithDryRun ¶
WithDryRun deep copies a new handler and prints the create/update/apply/delete operations, without sending it to apiserver.
func (*Handler) WithNamespace ¶
WithNamespace deep copies a new handler, but set the handler.namespace to the provided namespace.