resources

Documentation

Index

• type CreateOption
• type DeleteOption
  • func WithDeletePropagation(prop string) DeleteOption
  • func WithGracePeriod(gpt time.Duration) DeleteOption
• type ListOption
  • func WithFieldSelector(sel string) ListOption
  • func WithLabelSelector(sel string) ListOption
  • func WithTimeout(to time.Duration) ListOption
• type PatchOption
• type Resources
  • func New(cfg *rest.Config) (*Resources, error)
  • func (r *Resources) Annotate(obj k8s.Object, annotation map[string]string)
  • func (r *Resources) Create(ctx context.Context, obj k8s.Object, opts ...CreateOption) error
  • func (r *Resources) Delete(ctx context.Context, obj k8s.Object, opts ...DeleteOption) error
  • func (r *Resources) ExecInPod(ctx context.Context, namespaceName, podName, containerName string, ...) error
  • func (r *Resources) Get(ctx context.Context, name, namespace string, obj k8s.Object) error
  • func (r *Resources) GetConfig() *rest.Config
  • func (r *Resources) GetControllerRuntimeClient() cr.Client
  • func (r *Resources) GetScheme() *runtime.Scheme
  • func (r *Resources) Label(obj k8s.Object, label map[string]string)
  • func (r *Resources) List(ctx context.Context, objs k8s.ObjectList, opts ...ListOption) error
  • func (r *Resources) Patch(ctx context.Context, obj k8s.Object, patch k8s.Patch, opts ...PatchOption) error
  • func (r *Resources) PatchStatus(ctx context.Context, objs k8s.Object, patch k8s.Patch, opts ...PatchOption) error
  • func (r *Resources) PatchSubresource(ctx context.Context, obj k8s.Object, subresource string, patch k8s.Patch, ...) error
  • func (r *Resources) Update(ctx context.Context, obj k8s.Object, opts ...UpdateOption) error
  • func (r *Resources) UpdateStatus(ctx context.Context, obj k8s.Object, opts ...UpdateOption) error
  • func (r *Resources) UpdateSubresource(ctx context.Context, obj k8s.Object, subresource string, opts ...UpdateOption) error
  • func (r *Resources) Watch(object k8s.ObjectList, opts ...ListOption) *watcher.EventHandlerFuncs
  • func (r *Resources) WithNamespace(ns string) *Resources
• type UpdateOption

Types

type CreateOption

type CreateOption func(*metav1.CreateOptions)

type DeleteOption

type DeleteOption func(*metav1.DeleteOptions)

func WithDeletePropagation

func WithDeletePropagation(prop string) DeleteOption

func WithGracePeriod

func WithGracePeriod(gpt time.Duration) DeleteOption

type ListOption

type ListOption func(*metav1.ListOptions)

func WithFieldSelector

func WithFieldSelector(sel string) ListOption

func WithLabelSelector

func WithLabelSelector(sel string) ListOption

func WithTimeout

func WithTimeout(to time.Duration) ListOption

type PatchOption

type PatchOption func(*metav1.PatchOptions)

PatchOption is used to provide additional arguments to the Patch call.

type Resources

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

func New

func New(cfg *rest.Config) (*Resources, error)

New instantiates the controller runtime client object. User can get panic for belopw scenarios. 1. if user does not provide k8s config 2. if controller runtime client instantiation fails.

func (*Resources) Annotate

func (r *Resources) Annotate(obj k8s.Object, annotation map[string]string)

Annotate attach annotations to an existing resource objec

func (*Resources) Create

func (r *Resources) Create(ctx context.Context, obj k8s.Object, opts ...CreateOption) error

func (*Resources) Delete

func (r *Resources) Delete(ctx context.Context, obj k8s.Object, opts ...DeleteOption) error

func (*Resources) ExecInPod

func (r *Resources) ExecInPod(ctx context.Context, namespaceName, podName, containerName string, command []string, stdout, stderr *bytes.Buffer) error

func (*Resources) Get

func (r *Resources) Get(ctx context.Context, name, namespace string, obj k8s.Object) error

func (*Resources) GetConfig

func (r *Resources) GetConfig() *rest.Config

GetConfig hepls to get config type *rest.Config

func (*Resources) GetControllerRuntimeClient

func (r *Resources) GetControllerRuntimeClient() cr.Client

GetControllerRuntimeClient return the controller-runtime client instance

func (*Resources) GetScheme

func (r *Resources) GetScheme() *runtime.Scheme

func (*Resources) Label

func (r *Resources) Label(obj k8s.Object, label map[string]string)

Label apply labels to an existing resources.

func (*Resources) List

func (r *Resources) List(ctx context.Context, objs k8s.ObjectList, opts ...ListOption) error

func (*Resources) Patch

func (r *Resources) Patch(ctx context.Context, obj k8s.Object, patch k8s.Patch, opts ...PatchOption) error

Patch patches portion of object `obj` with data from object `patch`

func (*Resources) PatchStatus

func (r *Resources) PatchStatus(ctx context.Context, objs k8s.Object, patch k8s.Patch, opts ...PatchOption) error

PatchStatus patches portion of object `obj` with data from object `patch`

func (*Resources) PatchSubresource

func (r *Resources) PatchSubresource(ctx context.Context, obj k8s.Object, subresource string, patch k8s.Patch, opts ...PatchOption) error

PatchSubresource patches portion of object `obj` with data from object `patch`

func (*Resources) Update

func (r *Resources) Update(ctx context.Context, obj k8s.Object, opts ...UpdateOption) error

func (*Resources) UpdateStatus

func (r *Resources) UpdateStatus(ctx context.Context, obj k8s.Object, opts ...UpdateOption) error

UpdateStatus updates the status of the object

func (*Resources) UpdateSubresource

func (r *Resources) UpdateSubresource(ctx context.Context, obj k8s.Object, subresource string, opts ...UpdateOption) error

UpdateSubresource updates the subresource of the object

func (*Resources) Watch

func (r *Resources) Watch(object k8s.ObjectList, opts ...ListOption) *watcher.EventHandlerFuncs

func (*Resources) WithNamespace

func (r *Resources) WithNamespace(ns string) *Resources

type UpdateOption

type UpdateOption func(*metav1.UpdateOptions)