Documentation ¶
Index ¶
- Variables
- type Handler
- func (h *Handler) Apply(obj interface{}) (*corev1.Service, error)
- func (h *Handler) ApplyFromBytes(data []byte) (svc *corev1.Service, err error)
- func (h *Handler) ApplyFromFile(filename string) (svc *corev1.Service, err error)
- func (h *Handler) ApplyFromMap(u map[string]interface{}) (*corev1.Service, error)
- func (h *Handler) ApplyFromObject(obj interface{}) (*corev1.Service, error)
- func (h *Handler) ApplyFromUnstructured(u *unstructured.Unstructured) (*corev1.Service, error)
- func (h *Handler) Clientset() *kubernetes.Clientset
- func (h *Handler) Create(obj interface{}) (*corev1.Service, error)
- func (h *Handler) CreateFromBytes(data []byte) (*corev1.Service, error)
- func (h *Handler) CreateFromFile(filename string) (*corev1.Service, error)
- func (h *Handler) CreateFromMap(u map[string]interface{}) (*corev1.Service, error)
- func (h *Handler) CreateFromObject(obj interface{}) (*corev1.Service, error)
- func (h *Handler) CreateFromUnstructured(u *unstructured.Unstructured) (*corev1.Service, 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 interface{}) 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.Service, error)
- func (h *Handler) GetAge(object interface{}) (time.Duration, error)
- func (h *Handler) GetByName(name string) (*corev1.Service, error)
- func (h *Handler) GetClusterIP(object interface{}) (string, error)
- func (h *Handler) GetExternalIPs(object interface{}) ([]string, error)
- func (h *Handler) GetFromBytes(data []byte) (*corev1.Service, error)
- func (h *Handler) GetFromFile(filename string) (*corev1.Service, error)
- func (h *Handler) GetFromMap(u map[string]interface{}) (*corev1.Service, error)
- func (h *Handler) GetFromObject(obj interface{}) (*corev1.Service, error)
- func (h *Handler) GetFromUnstructured(u *unstructured.Unstructured) (*corev1.Service, error)
- func (h *Handler) GetPorts(object interface{}) ([]ServicePort, error)
- func (h *Handler) GetType(object interface{}) (string, error)
- func (h *Handler) Informer() cache.SharedIndexInformer
- func (h *Handler) InformerFactory() informers.SharedInformerFactory
- func (h *Handler) List() ([]*corev1.Service, error)
- func (h *Handler) ListAll() ([]*corev1.Service, error)
- func (h *Handler) ListByField(field string) ([]*corev1.Service, error)
- func (h *Handler) ListByLabel(labels string) ([]*corev1.Service, error)
- func (h *Handler) ListByNamespace(namespace string) ([]*corev1.Service, error)
- func (h *Handler) Lister() listerscore.ServiceLister
- func (h *Handler) Patch(original *corev1.Service, patch interface{}, patchOptions ...types.PatchType) (*corev1.Service, error)
- func (h *Handler) RESTClient() *rest.RESTClient
- func (h *Handler) RESTConfig() *rest.Config
- func (h *Handler) ResetNamespace(namespace string)
- func (h *Handler) RunInformer(stopCh <-chan struct{}, addFunc func(obj interface{}), ...)
- func (h *Handler) ServiceInformer() informerscore.ServiceInformer
- 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.Service, error)
- func (h *Handler) UpdateFromBytes(data []byte) (*corev1.Service, error)
- func (h *Handler) UpdateFromFile(filename string) (*corev1.Service, error)
- func (h *Handler) UpdateFromMap(u map[string]interface{}) (*corev1.Service, error)
- func (h *Handler) UpdateFromObject(obj interface{}) (*corev1.Service, error)
- func (h *Handler) UpdateFromUnstructured(u *unstructured.Unstructured) (*corev1.Service, error)
- func (h *Handler) Watch(addFunc, modifyFunc, deleteFunc func(obj interface{})) error
- func (h *Handler) WatchByField(field string, addFunc, modifyFunc, deleteFunc func(obj interface{})) error
- func (h *Handler) WatchByLabel(labels string, addFunc, modifyFunc, deleteFunc func(obj interface{})) error
- func (h *Handler) WatchByName(name string, addFunc, modifyFunc, deleteFunc func(obj interface{})) error
- func (h *Handler) WatchByNamespace(namespace string, addFunc, modifyFunc, deleteFunc func(obj interface{})) error
- func (h *Handler) WithDryRun() *Handler
- func (h *Handler) WithNamespace(namespace string) *Handler
- type ServicePort
Constants ¶
This section is empty.
Variables ¶
var ( ErrInvalidToolsType = errors.New("type must be string, *corev1.Service, corev1.Service, metav1.Object or runtime.Object") ErrInvalidCreateType = errors.New("type must be string, []byte, *corev1.Service, corev1.Service, metav1.object, runtime.Object, *unstructured.Unstructured, unstructured.Unstructured or map[string]interface{}") ErrInvalidUpdateType = ErrInvalidCreateType ErrInvalidApplyType = ErrInvalidCreateType ErrInvalidDeleteType = ErrInvalidCreateType ErrInvalidGetType = ErrInvalidCreateType ErrInvalidPatchType = errors.New("patch data type must be string, []byte, *corev1.Service, corev1.Service, metav1.Object, runtime.Object, *unstructured.Unstructured, unstructured.Unstructured or map[string]interface{}") )
var GVK = schema.GroupVersionKind{ Group: corev1.SchemeGroupVersion.Group, Version: corev1.SchemeGroupVersion.Version, Kind: types.KindService, }
GVK contains the Group, Version, Kind name of service.
var GVR = schema.GroupVersionResource{ Group: corev1.SchemeGroupVersion.Group, Version: corev1.SchemeGroupVersion.Version, Resource: types.ResourceService, }
GVR contains the Group, Version and Resource name of service.
var Group = GVK.Group
Group is the service Group name.
var Kind = GVK.Kind
Kind is the service Kind name.
var Resource = GVR.Resource
Resource is the service Resource name.
var Version = GVK.Version
Version is the service Version name.
Functions ¶
This section is empty.
Types ¶
type Handler ¶
type Handler struct { Options *types.HandlerOptions // contains filtered or unexported fields }
func New ¶
New returns a Handler 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 service handler. panic if there is any error occurs.
func (*Handler) Apply ¶
Apply applies service from type string, []byte, *corev1.Service, corev1.Service, metav1.Object, runtime.Object, *unstructured.Unstructured, unstructured.Unstructured or map[string]interface{}.
func (*Handler) ApplyFromBytes ¶
ApplyFromBytes pply service from bytes data.
func (*Handler) ApplyFromFile ¶
ApplyFromFile applies service from yaml or json file.
func (*Handler) ApplyFromMap ¶ added in v0.5.0
ApplyFromMap applies service from map[string]interface{}.
func (*Handler) ApplyFromObject ¶ added in v0.3.0
ApplyFromObject applies service from metav1.Object or runtime.Object.
func (*Handler) ApplyFromUnstructured ¶ added in v0.3.0
func (h *Handler) ApplyFromUnstructured(u *unstructured.Unstructured) (*corev1.Service, error)
ApplyFromUnstructured applies service from *unstructured.Unstructured.
func (*Handler) Clientset ¶ added in v0.2.0
func (h *Handler) Clientset() *kubernetes.Clientset
Clientset returns underlying clientset.
func (*Handler) Create ¶
Create creates service from type string, []byte, *corev1.Service, corev1.Service, metav1.Object, runtime.Object, *unstructured.Unstructured, unstructured.Unstructured or map[string]interface{}.
func (*Handler) CreateFromBytes ¶
CreateFromBytes creates service from bytes data.
func (*Handler) CreateFromFile ¶
CreateFromFile creates service from yaml or json file.
func (*Handler) CreateFromMap ¶ added in v0.5.0
CreateFromMap creates service from map[string]interface{}.
func (*Handler) CreateFromObject ¶ added in v0.3.0
CreateFromObject creates service from metav1.Object or runtime.Object.
func (*Handler) CreateFromUnstructured ¶ added in v0.3.0
func (h *Handler) CreateFromUnstructured(u *unstructured.Unstructured) (*corev1.Service, error)
CreateFromUnstructured creates service from *unstructured.Unstructured.
func (*Handler) Delete ¶
Delete deletes service from type string, []byte, *corev1.Service, corev1.Service, metav1.Object, 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 service from file path.
func (*Handler) DeleteByName ¶
DeleteByName deletes service by name.
func (*Handler) DeleteFromBytes ¶
DeleteFromBytes deletes service from bytes data.
func (*Handler) DeleteFromFile ¶
DeleteFromFile deletes service from yaml or json file.
func (*Handler) DeleteFromMap ¶ added in v0.5.0
DeleteFromMap deletes service from map[string]interface{}.
func (*Handler) DeleteFromObject ¶ added in v0.3.0
DeleteFromObject deletes service from metav1.Object or runtime.Object.
func (*Handler) DeleteFromUnstructured ¶ added in v0.3.0
func (h *Handler) DeleteFromUnstructured(u *unstructured.Unstructured) error
DeleteFromUnstructured deletes service 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 service from type string, []byte, *corev1.Service, corev1.Service, metav1.Object, 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 service from file path.
func (*Handler) GetClusterIP ¶ added in v0.2.0
GetClusterIP returns the cluster ip of the service.
func (*Handler) GetExternalIPs ¶ added in v0.2.0
GetExternalIPs returns the external ip list of the service.
func (*Handler) GetFromBytes ¶
GetFromBytes gets service from bytes data.
func (*Handler) GetFromFile ¶
GetFromFile gets service from yaml or json file.
func (*Handler) GetFromMap ¶ added in v0.5.0
GetFromMap gets service from map[string]interface{}.
func (*Handler) GetFromObject ¶ added in v0.3.0
GetFromObject gets service from metav1.Object or runtime.Object.
func (*Handler) GetFromUnstructured ¶ added in v0.3.0
func (h *Handler) GetFromUnstructured(u *unstructured.Unstructured) (*corev1.Service, error)
GetFromUnstructured gets service from *unstructured.Unstructured.
func (*Handler) GetPorts ¶ added in v0.2.0
func (h *Handler) GetPorts(object interface{}) ([]ServicePort, error)
GetPorts get the port list of the service.
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 services by field, work like `kubectl get xxx --field-selector=xxx`.
func (*Handler) ListByLabel ¶
ListByLabel list services 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 services in the specified namespace.
func (*Handler) Lister ¶ added in v0.5.0
func (h *Handler) Lister() listerscore.ServiceLister
Lister returns underlying ServiceLister which helps list services.
func (*Handler) Patch ¶ added in v0.11.1
func (h *Handler) Patch(original *corev1.Service, patch interface{}, patchOptions ...types.PatchType) (*corev1.Service, error)
Patch use the default patch type(Strategic Merge Patch) to patch service. Supported patch types are: "StrategicMergePatchType", "MergePatchType", "JSONPatchType".
For further more Strategic Merge patch, see:
https://kubernetes.io/docs/tasks/manage-kubernetes-objects/update-api-object-kubectl-patch/#before-you-begin
For a comparison of JSON patch and JSON merge patch, see:
https://erosb.github.io/post/json-patch-vs-merge-patch/
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) ResetNamespace ¶ added in v0.11.4
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 service resource, respectively.
func (*Handler) ServiceInformer ¶ added in v0.5.0
func (h *Handler) ServiceInformer() informerscore.ServiceInformer
ServiceInformer returns underlying ServiceInformer which provides access to a shared informer and lister for service.
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 service from type string, []byte, *corev1.Service, corev1.Service, metav1.Object, runtime.Object, *unstructured.Unstructured, unstructured.Unstructured or map[string]interface{}.
func (*Handler) UpdateFromBytes ¶
UpdateFromBytes updates service from bytes data.
func (*Handler) UpdateFromFile ¶
UpdateFromFile updates service from yaml or json file.
func (*Handler) UpdateFromMap ¶ added in v0.5.0
UpdateFromMap updates service from map[string]interface{}.
func (*Handler) UpdateFromObject ¶ added in v0.3.0
UpdateFromObject updates service from metav1.Object or runtime.Object.
func (*Handler) UpdateFromUnstructured ¶ added in v0.3.0
func (h *Handler) UpdateFromUnstructured(u *unstructured.Unstructured) (*corev1.Service, error)
UpdateFromUnstructured updates service from *unstructured.Unstructured.
func (*Handler) Watch ¶
Watch watch all service resources.
Object as the parameter of addFunc, modifyFunc, deleteFunc:
- If Event.Type is Added or Modified: the new state of the object.
- If Event.Type is Deleted: the state of the object immediately before deletion.
- If Event.Type is Bookmark: the object (instance of a type being watched) where only ResourceVersion field is set. On successful restart of watch from a bookmark resourceVersion, client is guaranteed to not get repeat event nor miss any events.
- If Event.Type is Error: *api.Status is recommended; other types may make sense depending on context.
func (*Handler) WatchByField ¶ added in v0.11.1
func (h *Handler) WatchByField(field string, addFunc, modifyFunc, deleteFunc func(obj interface{})) error
WatchByField watch a single or multiple Service resources selected by the field.
Object as the parameter of addFunc, modifyFunc, deleteFunc:
- If Event.Type is Added or Modified: the new state of the object.
- If Event.Type is Deleted: the state of the object immediately before deletion.
- If Event.Type is Bookmark: the object (instance of a type being watched) where only ResourceVersion field is set. On successful restart of watch from a bookmark resourceVersion, client is guaranteed to not get repeat event nor miss any events.
- If Event.Type is Error: *api.Status is recommended; other types may make sense depending on context.
func (*Handler) WatchByLabel ¶
func (h *Handler) WatchByLabel(labels string, addFunc, modifyFunc, deleteFunc func(obj interface{})) error
WatchByLabel watch a single or multiple Service resources selected by the label. Multiple labels are separated by ",", label key and value conjunctaed by "=".
Object as the parameter of addFunc, modifyFunc, deleteFunc:
- If Event.Type is Added or Modified: the new state of the object.
- If Event.Type is Deleted: the state of the object immediately before deletion.
- If Event.Type is Bookmark: the object (instance of a type being watched) where only ResourceVersion field is set. On successful restart of watch from a bookmark resourceVersion, client is guaranteed to not get repeat event nor miss any events.
- If Event.Type is Error: *api.Status is recommended; other types may make sense depending on context.
func (*Handler) WatchByName ¶
func (h *Handler) WatchByName(name string, addFunc, modifyFunc, deleteFunc func(obj interface{})) error
WatchByName watch a single service reseource.
Object as the parameter of addFunc, modifyFunc, deleteFunc:
- If Event.Type is Added or Modified: the new state of the object.
- If Event.Type is Deleted: the state of the object immediately before deletion.
- If Event.Type is Bookmark: the object (instance of a type being watched) where only ResourceVersion field is set. On successful restart of watch from a bookmark resourceVersion, client is guaranteed to not get repeat event nor miss any events.
- If Event.Type is Error: *api.Status is recommended; other types may make sense depending on context.
func (*Handler) WatchByNamespace ¶ added in v0.11.1
func (h *Handler) WatchByNamespace(namespace string, addFunc, modifyFunc, deleteFunc func(obj interface{})) error
WatchByNamespace watch all service resources in the specified namespace.
Object as the parameter of addFunc, modifyFunc, deleteFunc:
- If Event.Type is Added or Modified: the new state of the object.
- If Event.Type is Deleted: the state of the object immediately before deletion.
- If Event.Type is Bookmark: the object (instance of a type being watched) where only ResourceVersion field is set. On successful restart of watch from a bookmark resourceVersion, client is guaranteed to not get repeat event nor miss any events.
- If Event.Type is Error: *api.Status is recommended; other types may make sense depending on context.
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.