Documentation ¶
Index ¶
- Variables
- type Handler
- func (h *Handler) Apply(obj interface{}) (*rbacv1.RoleBinding, error)
- func (h *Handler) ApplyFromBytes(data []byte) (rb *rbacv1.RoleBinding, err error)
- func (h *Handler) ApplyFromFile(filename string) (rb *rbacv1.RoleBinding, err error)
- func (h *Handler) ApplyFromMap(u map[string]interface{}) (*rbacv1.RoleBinding, error)
- func (h *Handler) ApplyFromObject(obj interface{}) (*rbacv1.RoleBinding, error)
- func (h *Handler) ApplyFromUnstructured(u *unstructured.Unstructured) (*rbacv1.RoleBinding, error)
- func (h *Handler) Clientset() *kubernetes.Clientset
- func (h *Handler) Create(obj interface{}) (*rbacv1.RoleBinding, error)
- func (h *Handler) CreateFromBytes(data []byte) (*rbacv1.RoleBinding, error)
- func (h *Handler) CreateFromFile(filename string) (*rbacv1.RoleBinding, error)
- func (h *Handler) CreateFromMap(u map[string]interface{}) (*rbacv1.RoleBinding, error)
- func (h *Handler) CreateFromObject(obj interface{}) (*rbacv1.RoleBinding, error)
- func (h *Handler) CreateFromUnstructured(u *unstructured.Unstructured) (*rbacv1.RoleBinding, 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{}) (*rbacv1.RoleBinding, error)
- func (h *Handler) GetAge(object interface{}) (time.Duration, error)
- func (h *Handler) GetByName(name string) (*rbacv1.RoleBinding, error)
- func (h *Handler) GetFromBytes(data []byte) (*rbacv1.RoleBinding, error)
- func (h *Handler) GetFromFile(filename string) (*rbacv1.RoleBinding, error)
- func (h *Handler) GetFromMap(u map[string]interface{}) (*rbacv1.RoleBinding, error)
- func (h *Handler) GetFromObject(obj interface{}) (*rbacv1.RoleBinding, error)
- func (h *Handler) GetFromUnstructured(u *unstructured.Unstructured) (*rbacv1.RoleBinding, error)
- func (h *Handler) GetRole(object interface{}) (*Role, error)
- func (h *Handler) GetSubjects(object interface{}) ([]Subject, error)
- func (h *Handler) Informer() cache.SharedIndexInformer
- func (h *Handler) InformerFactory() informers.SharedInformerFactory
- func (h *Handler) List() ([]*rbacv1.RoleBinding, error)
- func (h *Handler) ListAll() ([]*rbacv1.RoleBinding, error)
- func (h *Handler) ListByField(field string) ([]*rbacv1.RoleBinding, error)
- func (h *Handler) ListByLabel(labels string) ([]*rbacv1.RoleBinding, error)
- func (h *Handler) ListByNamespace(namespace string) ([]*rbacv1.RoleBinding, error)
- func (h *Handler) Lister() listersrbac.RoleBindingLister
- func (h *Handler) Patch(original *rbacv1.RoleBinding, patch interface{}, ...) (*rbacv1.RoleBinding, error)
- func (h *Handler) RESTClient() *rest.RESTClient
- func (h *Handler) RESTConfig() *rest.Config
- func (h *Handler) ResetNamespace(namespace string)
- func (h *Handler) RoleBindingInformer() informersrbac.RoleBindingInformer
- 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{}) (*rbacv1.RoleBinding, error)
- func (h *Handler) UpdateFromBytes(data []byte) (*rbacv1.RoleBinding, error)
- func (h *Handler) UpdateFromFile(filename string) (*rbacv1.RoleBinding, error)
- func (h *Handler) UpdateFromMap(u map[string]interface{}) (*rbacv1.RoleBinding, error)
- func (h *Handler) UpdateFromObject(obj interface{}) (*rbacv1.RoleBinding, error)
- func (h *Handler) UpdateFromUnstructured(u *unstructured.Unstructured) (*rbacv1.RoleBinding, 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 Role
- type Subject
Constants ¶
This section is empty.
Variables ¶
var ( ErrInvalidToolsType = errors.New("type must be string, *rbacv1.RoleBinding, rbacv1.RoleBinding, metav1.Object or runtime.Object") ErrInvalidCreateType = errors.New("type must be string, []byte, *rbacv1.RoleBinding, rbacv1.RoleBinding, 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, *rbacv1.RoleBinding, rbacv1.RoleBinding, metav1.Object, runtime.Object, *unstructured.Unstructured, unstructured.Unstructured or map[string]interface{}") )
var GVK = schema.GroupVersionKind{ Group: rbacv1.SchemeGroupVersion.Group, Version: rbacv1.SchemeGroupVersion.Version, Kind: types.KindRoleBinding, }
GVK contains the Group, Version, Kind name of rolebinding.
var GVR = schema.GroupVersionResource{ Group: rbacv1.SchemeGroupVersion.Group, Version: rbacv1.SchemeGroupVersion.Version, Resource: types.ResourceRoleBinding, }
GVR contains the Group, Version and Resource name of rolebinding.
var Group = GVK.Group
Group is the rolebinding Group name.
var Kind = GVK.Kind
Kind is the rolebinding Kind name.
var Resource = GVR.Resource
Resource is the rolebinding Resource name.
var Version = GVK.Version
Version is the rolebinding 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 rolebinding handler. panic if there is any error occurs.
func (*Handler) Apply ¶
func (h *Handler) Apply(obj interface{}) (*rbacv1.RoleBinding, error)
Apply applies rolebinding from type string, []byte, *rbacv1.RoleBinding, rbacv1.RoleBinding, metav1.Object, runtime.Object, *unstructured.Unstructured, unstructured.Unstructured or map[string]interface{}.
func (*Handler) ApplyFromBytes ¶
func (h *Handler) ApplyFromBytes(data []byte) (rb *rbacv1.RoleBinding, err error)
ApplyFromBytes pply rolebinding from bytes data.
func (*Handler) ApplyFromFile ¶
func (h *Handler) ApplyFromFile(filename string) (rb *rbacv1.RoleBinding, err error)
ApplyFromFile applies rolebinding from yaml or json file.
func (*Handler) ApplyFromMap ¶ added in v0.5.0
func (h *Handler) ApplyFromMap(u map[string]interface{}) (*rbacv1.RoleBinding, error)
ApplyFromMap applies rolebinding from map[string]interface{}.
func (*Handler) ApplyFromObject ¶ added in v0.3.0
func (h *Handler) ApplyFromObject(obj interface{}) (*rbacv1.RoleBinding, error)
ApplyFromObject applies rolebinding from metav1.Object or runtime.Object.
func (*Handler) ApplyFromUnstructured ¶ added in v0.3.0
func (h *Handler) ApplyFromUnstructured(u *unstructured.Unstructured) (*rbacv1.RoleBinding, error)
ApplyFromUnstructured applies rolebinding from *unstructured.Unstructured.
func (*Handler) Clientset ¶ added in v0.2.0
func (h *Handler) Clientset() *kubernetes.Clientset
Clientset returns underlying clientset.
func (*Handler) Create ¶
func (h *Handler) Create(obj interface{}) (*rbacv1.RoleBinding, error)
Create creates rolebinding from type string, []byte, *rbacv1.RoleBinding, rbacv1.RoleBinding, metav1.Object, runtime.Object, *unstructured.Unstructured, unstructured.Unstructured or map[string]interface{}.
func (*Handler) CreateFromBytes ¶
func (h *Handler) CreateFromBytes(data []byte) (*rbacv1.RoleBinding, error)
CreateFromBytes creates rolebinding from bytes data.
func (*Handler) CreateFromFile ¶
func (h *Handler) CreateFromFile(filename string) (*rbacv1.RoleBinding, error)
CreateFromFile creates rolebinding from yaml or json file.
func (*Handler) CreateFromMap ¶ added in v0.5.0
func (h *Handler) CreateFromMap(u map[string]interface{}) (*rbacv1.RoleBinding, error)
CreateFromMap creates rolebinding from map[string]interface{}.
func (*Handler) CreateFromObject ¶ added in v0.3.0
func (h *Handler) CreateFromObject(obj interface{}) (*rbacv1.RoleBinding, error)
CreateFromObject creates rolebinding from metav1.Object or runtime.Object.
func (*Handler) CreateFromUnstructured ¶ added in v0.3.0
func (h *Handler) CreateFromUnstructured(u *unstructured.Unstructured) (*rbacv1.RoleBinding, error)
CreateFromUnstructured creates rolebinding from *unstructured.Unstructured.
func (*Handler) Delete ¶
Delete deletes rolebinding from type string, []byte, *rbacv1.RoleBinding, rbacv1.RoleBinding, 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 rolebinding from file path.
func (*Handler) DeleteByName ¶
DeleteByName deletes rolebinding by name.
func (*Handler) DeleteFromBytes ¶
DeleteFromBytes deletes rolebinding from bytes data.
func (*Handler) DeleteFromFile ¶
DeleteFromFile deletes rolebinding from yaml or json file.
func (*Handler) DeleteFromMap ¶ added in v0.5.0
DeleteFromMap deletes rolebinding from map[string]interface{}.
func (*Handler) DeleteFromObject ¶ added in v0.3.0
DeleteFromObject deletes rolebinding from metav1.Object or runtime.Object.
func (*Handler) DeleteFromUnstructured ¶ added in v0.3.0
func (h *Handler) DeleteFromUnstructured(u *unstructured.Unstructured) error
DeleteFromUnstructured deletes rolebinding 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 ¶
func (h *Handler) Get(obj interface{}) (*rbacv1.RoleBinding, error)
Get gets rolebinding from type string, []byte, *rbacv1.RoleBinding, rbacv1.RoleBinding, 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 rolebinding from file path.
func (*Handler) GetByName ¶
func (h *Handler) GetByName(name string) (*rbacv1.RoleBinding, error)
GetByName gets rolebinding by name.
func (*Handler) GetFromBytes ¶
func (h *Handler) GetFromBytes(data []byte) (*rbacv1.RoleBinding, error)
GetFromBytes gets rolebinding from bytes data.
func (*Handler) GetFromFile ¶
func (h *Handler) GetFromFile(filename string) (*rbacv1.RoleBinding, error)
GetFromFile gets rolebinding from yaml or json file.
func (*Handler) GetFromMap ¶ added in v0.5.0
func (h *Handler) GetFromMap(u map[string]interface{}) (*rbacv1.RoleBinding, error)
GetFromMap gets rolebinding from map[string]interface{}.
func (*Handler) GetFromObject ¶ added in v0.3.0
func (h *Handler) GetFromObject(obj interface{}) (*rbacv1.RoleBinding, error)
GetFromObject gets rolebinding from metav1.Object or runtime.Object.
func (*Handler) GetFromUnstructured ¶ added in v0.3.0
func (h *Handler) GetFromUnstructured(u *unstructured.Unstructured) (*rbacv1.RoleBinding, error)
GetFromUnstructured gets rolebinding from *unstructured.Unstructured.
func (*Handler) GetRole ¶ added in v0.2.0
GetRole get the role/clusterrole binding by this rolebinding.
func (*Handler) GetSubjects ¶ added in v0.2.0
GetSubjects get the subjects to which the role/clusterrole applies. All supported subject kinds are: User, Group, ServiceAccount.
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) List ¶
func (h *Handler) List() ([]*rbacv1.RoleBinding, error)
List list all rolebindings in the k8s cluster, it simply call `ListAll`.
func (*Handler) ListAll ¶
func (h *Handler) ListAll() ([]*rbacv1.RoleBinding, error)
ListAll list all rolebindings in the k8s cluster.
func (*Handler) ListByField ¶ added in v0.7.0
func (h *Handler) ListByField(field string) ([]*rbacv1.RoleBinding, error)
ListByField list rolebindings by field, work like `kubectl get xxx --field-selector=xxx`.
func (*Handler) ListByLabel ¶
func (h *Handler) ListByLabel(labels string) ([]*rbacv1.RoleBinding, error)
ListByLabel list rolebindings by labels. Multiple labels separated by comma(",") eg: "name=myapp,role=devops", and there is an "And" relationship between multiple labels.
func (*Handler) ListByNamespace ¶
func (h *Handler) ListByNamespace(namespace string) ([]*rbacv1.RoleBinding, error)
ListByNamespace list all rolebindings in the specified namespace.
func (*Handler) Lister ¶ added in v0.5.0
func (h *Handler) Lister() listersrbac.RoleBindingLister
Lister returns underlying RoleBindingLister which helps list rolebindings.
func (*Handler) Patch ¶ added in v0.11.1
func (h *Handler) Patch(original *rbacv1.RoleBinding, patch interface{}, patchOptions ...types.PatchType) (*rbacv1.RoleBinding, error)
Patch use the default patch type(Strategic Merge Patch) to patch rolebinding. 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) RoleBindingInformer ¶ added in v0.5.0
func (h *Handler) RoleBindingInformer() informersrbac.RoleBindingInformer
RoleBindingInformer returns underlying RoleBindingInformer which provides access to a shared informer and lister for rolebinding.
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 rolebinding 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 ¶
func (h *Handler) Update(obj interface{}) (*rbacv1.RoleBinding, error)
Update updates rolebinding from type string, []byte, *rbacv1.RoleBinding, rbacv1.RoleBinding, metav1.Object, runtime.Object, *unstructured.Unstructured, unstructured.Unstructured or map[string]interface{}.
func (*Handler) UpdateFromBytes ¶
func (h *Handler) UpdateFromBytes(data []byte) (*rbacv1.RoleBinding, error)
UpdateFromBytes updates rolebinding from bytes data.
func (*Handler) UpdateFromFile ¶
func (h *Handler) UpdateFromFile(filename string) (*rbacv1.RoleBinding, error)
UpdateFromFile updates rolebinding from yaml or json file.
func (*Handler) UpdateFromMap ¶ added in v0.5.0
func (h *Handler) UpdateFromMap(u map[string]interface{}) (*rbacv1.RoleBinding, error)
UpdateFromMap updates rolebinding from map[string]interface{}.
func (*Handler) UpdateFromObject ¶ added in v0.3.0
func (h *Handler) UpdateFromObject(obj interface{}) (*rbacv1.RoleBinding, error)
UpdateFromObject updates rolebinding from metav1.Object or runtime.Object.
func (*Handler) UpdateFromUnstructured ¶ added in v0.3.0
func (h *Handler) UpdateFromUnstructured(u *unstructured.Unstructured) (*rbacv1.RoleBinding, error)
UpdateFromUnstructured updates rolebinding from *unstructured.Unstructured.
func (*Handler) Watch ¶
Watch watch all rolebinding 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 RoleBinding 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 RoleBinding 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 rolebinding 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 rolebinding 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.