role

package
v0.9.1 Latest Latest
Warning

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

 Go to latest Published: Aug 18, 2022 License: Apache-2.0 Imports: 30 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	ERR_TYPE_TOOLS       = fmt.Errorf("type must be string *rbacv1.Role, or rbacv1.Role")
	ErrInvalidCreateType = fmt.Errorf("type must be string, []byte, *rbacv1.Role, rbacv1.Role, runtime.Object, *unstructured.Unstructured, unstructured.Unstructured or map[string]interface{}")
	ErrInvalidUpdateType = ErrInvalidCreateType
	ErrInvalidApplyType  = ErrInvalidCreateType
	ErrInvalidDeleteType = ErrInvalidCreateType
	ErrInvalidGetType    = ErrInvalidCreateType
)
View Source 
var ERR_TYPE = fmt.Errorf("type must be *rbacv1.Role, rbacv1.Role or string")

Functions

func GVK added in v0.6.1 

func GVK() schema.GroupVersionKind

GVK returns the name of Group, Version, Kind of role resource.

func GVR added in v0.5.0 

func GVR() schema.GroupVersionResource

GVR returns the name of Group, Version, Resource of role resource.

func Group added in v0.5.0 

func Group() string

Group returns the Group name of role resource.

func Kind added in v0.6.1 

func Kind() string

Kind returns the Kind name of role resource.

func Resource added in v0.5.0 

func Resource() string

Resource returns the Resource name of role resource.

func Version added in v0.5.0 

func Version() string

Version returns the Version name of role resource.

Types

type Handler 

type Handler struct {
	Options *types.HandlerOptions
	// contains filtered or unexported fields
}

func New 

func New(ctx context.Context, kubeconfig, namespace string) (handler *Handler, err error)

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 

func NewOrDie(ctx context.Context, kubeconfig, namespace string) *Handler

NewOrDie simply call New() to get a role handler. panic if there is any error occurs.

func (*Handler) Apply 

func (h *Handler) Apply(obj interface{}) (*rbacv1.Role, error)

Apply applies role from type string, []byte, *rbacv1.Role, rbacv1.Role, runtime.Object, *unstructured.Unstructured, unstructured.Unstructured or map[string]interface{}.

func (*Handler) ApplyFromBytes 

func (h *Handler) ApplyFromBytes(data []byte) (role *rbacv1.Role, err error)

ApplyFromBytes pply role from bytes.

func (*Handler) ApplyFromFile 

func (h *Handler) ApplyFromFile(filename string) (role *rbacv1.Role, err error)

ApplyFromFile applies role from yaml file.

func (*Handler) ApplyFromMap added in v0.5.0 

func (h *Handler) ApplyFromMap(u map[string]interface{}) (*rbacv1.Role, error)

ApplyFromMap applies role from map[string]interface{}.

func (*Handler) ApplyFromObject added in v0.3.0 

func (h *Handler) ApplyFromObject(obj runtime.Object) (*rbacv1.Role, error)

ApplyFromObject applies role from runtime.Object.

func (*Handler) ApplyFromUnstructured added in v0.3.0 

func (h *Handler) ApplyFromUnstructured(u *unstructured.Unstructured) (*rbacv1.Role, error)

ApplyFromUnstructured applies role 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.Role, error)

Create creates role from type string, []byte, *rbacv1.Role, rbacv1.Role, runtime.Object, *unstructured.Unstructured, unstructured.Unstructured or map[string]interface{}.

func (*Handler) CreateFromBytes 

func (h *Handler) CreateFromBytes(data []byte) (*rbacv1.Role, error)

CreateFromBytes creates role from bytes.

func (*Handler) CreateFromFile 

func (h *Handler) CreateFromFile(filename string) (*rbacv1.Role, error)

CreateFromFile creates role from yaml file.

func (*Handler) CreateFromMap added in v0.5.0 

func (h *Handler) CreateFromMap(u map[string]interface{}) (*rbacv1.Role, error)

CreateFromMap creates role from map[string]interface{}.

func (*Handler) CreateFromObject added in v0.3.0 

func (h *Handler) CreateFromObject(obj runtime.Object) (*rbacv1.Role, error)

CreateFromObject creates role from runtime.Object.

func (*Handler) CreateFromUnstructured added in v0.3.0 

func (h *Handler) CreateFromUnstructured(u *unstructured.Unstructured) (*rbacv1.Role, error)

CreateFromUnstructured creates role from *unstructured.Unstructured.

func (*Handler) DeepCopy 

func (in *Handler) DeepCopy() *Handler

func (*Handler) Delete 

func (h *Handler) Delete(obj interface{}) error

Delete deletes role from type string, []byte, *rbacv1.Role, rbacv1.Role, 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 role from file path.

func (*Handler) DeleteByName 

func (h *Handler) DeleteByName(name string) error

DeleteByName deletes role by name.

func (*Handler) DeleteFromBytes 

func (h *Handler) DeleteFromBytes(data []byte) error

DeleteFromBytes deletes role from bytes.

func (*Handler) DeleteFromFile 

func (h *Handler) DeleteFromFile(filename string) error

DeleteFromFile deletes role from yaml file.

func (*Handler) DeleteFromMap added in v0.5.0 

func (h *Handler) DeleteFromMap(u map[string]interface{}) error

DeleteFromMap deletes role from map[string]interface{}.

func (*Handler) DeleteFromObject added in v0.3.0 

func (h *Handler) DeleteFromObject(obj runtime.Object) error

DeleteFromObject deletes role from runtime.Object.

func (*Handler) DeleteFromUnstructured added in v0.3.0 

func (h *Handler) DeleteFromUnstructured(u *unstructured.Unstructured) error

DeleteFromUnstructured deletes role 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 

func (h *Handler) DynamicClient() dynamic.Interface

DynamicClient returns underlying dynamic client.

func (*Handler) Get 

func (h *Handler) Get(obj interface{}) (*rbacv1.Role, error)

Get gets role from type string, []byte, *rbacv1.Role, rbacv1.Role, 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 role from file path.

func (*Handler) GetAge added in v0.2.0 

func (h *Handler) GetAge(object interface{}) (time.Duration, error)

GetAge returns role age.

func (*Handler) GetByName 

func (h *Handler) GetByName(name string) (*rbacv1.Role, error)

GetByName gets role by name.

func (*Handler) GetFromBytes 

func (h *Handler) GetFromBytes(data []byte) (*rbacv1.Role, error)

GetFromBytes gets role from bytes.

func (*Handler) GetFromFile 

func (h *Handler) GetFromFile(filename string) (*rbacv1.Role, error)

GetFromFile gets role from yaml file.

func (*Handler) GetFromMap added in v0.5.0 

func (h *Handler) GetFromMap(u map[string]interface{}) (*rbacv1.Role, error)

GetFromMap gets role from map[string]interface{}.

func (*Handler) GetFromObject added in v0.3.0 

func (h *Handler) GetFromObject(obj runtime.Object) (*rbacv1.Role, error)

GetFromObject gets role from runtime.Object.

func (*Handler) GetFromUnstructured added in v0.3.0 

func (h *Handler) GetFromUnstructured(u *unstructured.Unstructured) (*rbacv1.Role, error)

GetFromUnstructured gets role 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) List 

func (h *Handler) List() ([]*rbacv1.Role, error)

List list all roles in the k8s cluster, it simply call `ListAll`.

func (*Handler) ListAll 

func (h *Handler) ListAll() ([]*rbacv1.Role, error)

ListAll list all roles in the k8s cluster.

func (*Handler) ListByField added in v0.7.0 

func (h *Handler) ListByField(field string) ([]*rbacv1.Role, error)

ListByField list roles by field, work like `kubectl get xxx --field-selector=xxx`.

func (*Handler) ListByLabel 

func (h *Handler) ListByLabel(labels string) ([]*rbacv1.Role, error)

ListByLabel list roles 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.Role, error)

ListByNamespace list all roles in the specified namespace.

func (*Handler) Lister added in v0.5.0 

func (h *Handler) Lister() listersrbac.RoleLister

Lister returns underlying RoleLister which helps list roles.

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 

func (h *Handler) RESTConfig() *rest.Config

RESTConfig returns underlying rest config.

func (*Handler) RoleInformer added in v0.5.0 

func (h *Handler) RoleInformer() informersrbac.RoleInformer

RoleInformer returns underlying RoleInformer which provides access to a shared informer and lister for role.

func (*Handler) RunInformer 

func (h *Handler) RunInformer(
	addFunc func(obj interface{}),
	updateFunc func(oldObj, newObj interface{}),
	deleteFunc func(obj interface{}),
	stopCh chan struct{})

RunInformer

func (*Handler) SetForceDelete 

func (h *Handler) SetForceDelete(force bool)

func (*Handler) SetInformerResyncPeriod added in v0.5.0 

func (h *Handler) SetInformerResyncPeriod(resyncPeriod time.Duration)

SetInformerResyncPeriod will set informer resync period.

func (*Handler) SetLimit 

func (h *Handler) SetLimit(limit int64)

func (*Handler) SetTimeout 

func (h *Handler) SetTimeout(timeout int64)

func (*Handler) Update 

func (h *Handler) Update(obj interface{}) (*rbacv1.Role, error)

Update updates role from type string, []byte, *rbacv1.Role, rbacv1.Role, runtime.Object, *unstructured.Unstructured, unstructured.Unstructured or map[string]interface{}.

func (*Handler) UpdateFromBytes 

func (h *Handler) UpdateFromBytes(data []byte) (*rbacv1.Role, error)

UpdateFromBytes updates role from bytes.

func (*Handler) UpdateFromFile 

func (h *Handler) UpdateFromFile(filename string) (*rbacv1.Role, error)

UpdateFromFile updates role from yaml file.

func (*Handler) UpdateFromMap added in v0.5.0 

func (h *Handler) UpdateFromMap(u map[string]interface{}) (*rbacv1.Role, error)

UpdateFromMap updates role from map[string]interface{}.

func (*Handler) UpdateFromObject added in v0.3.0 

func (h *Handler) UpdateFromObject(obj runtime.Object) (*rbacv1.Role, error)

UpdateFromObject updates role from runtime.Object.

func (*Handler) UpdateFromUnstructured added in v0.3.0 

func (h *Handler) UpdateFromUnstructured(u *unstructured.Unstructured) (*rbacv1.Role, error)

UpdateFromUnstructured updates role from *unstructured.Unstructured.

func (*Handler) Watch 

func (h *Handler) Watch(name string,
	addFunc, modifyFunc, deleteFunc func(x interface{}), x interface{}) (err error)

Watch watch roles 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 roles by labels.

func (*Handler) WatchByName 

func (h *Handler) WatchByName(name string,
	addFunc, modifyFunc, deleteFunc func(x interface{}), x interface{}) (err error)

WatchByName watch roles by name.

func (*Handler) WithDryRun 

func (h *Handler) WithDryRun() *Handler

WithDryRun deep copies a new handler and prints the create/update/apply/delete operations, without sending it to apiserver.

func (*Handler) WithNamespace 

func (h *Handler) WithNamespace(namespace string) *Handler

WithNamespace deep copies a new handler, but set the handler.namespace to the provided namespace.

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.