cronjob

Documentation

Index

• Variables
• type Handler
  • func New(ctx context.Context, kubeconfig, namespace string) (handler *Handler, err error)
  • func NewOrDie(ctx context.Context, kubeconfig, namespace string) *Handler
  • func (h *Handler) Apply(obj interface{}) (*batchv1.CronJob, error)
  • func (h *Handler) ApplyFromBytes(data []byte) (cm *batchv1.CronJob, err error)
  • func (h *Handler) ApplyFromFile(filename string) (cm *batchv1.CronJob, err error)
  • func (h *Handler) ApplyFromObject(obj runtime.Object) (*batchv1.CronJob, error)
  • func (h *Handler) ApplyFromUnstructured(u map[string]interface{}) (*batchv1.CronJob, error)
  • func (h *Handler) Clientset() *kubernetes.Clientset
  • func (h *Handler) Create(obj interface{}) (*batchv1.CronJob, error)
  • func (h *Handler) CreateFromBytes(data []byte) (*batchv1.CronJob, error)
  • func (h *Handler) CreateFromFile(filename string) (*batchv1.CronJob, error)
  • func (h *Handler) CreateFromObject(obj runtime.Object) (*batchv1.CronJob, error)
  • func (h *Handler) CreateFromUnstructured(u map[string]interface{}) (*batchv1.CronJob, 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) DeleteFromObject(obj runtime.Object) error
  • func (h *Handler) DeleteFromUnstructured(u map[string]interface{}) error
  • func (h *Handler) DiscoveryClient() *discovery.DiscoveryClient
  • func (h *Handler) DurationOfCompleted(object interface{}) (time.Duration, error)
  • func (h *Handler) DurationOfLastScheduled(object interface{}) (time.Duration, error)
  • func (h *Handler) DynamicClient() dynamic.Interface
  • func (h *Handler) Get(obj interface{}) (*batchv1.CronJob, error)
  • func (h *Handler) GetAge(object interface{}) (time.Duration, error)
  • func (h *Handler) GetByName(name string) (*batchv1.CronJob, error)
  • func (h *Handler) GetContainers(object interface{}) ([]string, error)
  • func (h *Handler) GetFromBytes(data []byte) (*batchv1.CronJob, error)
  • func (h *Handler) GetFromFile(filename string) (*batchv1.CronJob, error)
  • func (h *Handler) GetFromObject(obj runtime.Object) (*batchv1.CronJob, error)
  • func (h *Handler) GetFromUnstructured(u map[string]interface{}) (*batchv1.CronJob, error)
  • func (h *Handler) GetImages(object interface{}) ([]string, error)
  • func (h *Handler) GetJobs(object interface{}) ([]batchv1.Job, error)
  • func (h *Handler) GetSchedule(object interface{}) (string, error)
  • func (h *Handler) IsSuspend(object interface{}) (bool, error)
  • func (h *Handler) List(labels string) (*batchv1.CronJobList, error)
  • func (h *Handler) ListAll(namespace string) (*batchv1.CronJobList, error)
  • func (h *Handler) ListByLabel(labels string) (*batchv1.CronJobList, error)
  • func (h *Handler) ListByNamespace(namespace string) (*batchv1.CronJobList, error)
  • func (h *Handler) Namespace() string
  • func (h *Handler) NumActive(object interface{}) (int, error)
  • func (h *Handler) RESTClient() *rest.RESTClient
  • func (h *Handler) RESTConfig() *rest.Config
  • func (h *Handler) RunInformer(addFunc func(obj interface{}), updateFunc func(oldObj, newObj interface{}), ...)
  • func (h *Handler) SetForceDelete(force bool)
  • func (h *Handler) SetLimit(limit int64)
  • func (h *Handler) SetPropagationPolicy(policy string)
  • func (h *Handler) SetTimeout(timeout int64)
  • func (h *Handler) Update(obj interface{}) (*batchv1.CronJob, error)
  • func (h *Handler) UpdateFromBytes(data []byte) (*batchv1.CronJob, error)
  • func (h *Handler) UpdateFromFile(filename string) (*batchv1.CronJob, error)
  • func (h *Handler) UpdateFromObject(obj runtime.Object) (*batchv1.CronJob, error)
  • func (h *Handler) UpdateFromUnstructured(u map[string]interface{}) (*batchv1.CronJob, error)
  • func (h *Handler) Watch(name string, addFunc, modifyFunc, deleteFunc func(x interface{}), ...) (err error)
  • func (h *Handler) WatchByLabel(labelSelector 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

Variables

var (
	ERR_TYPE_TOOLS  = fmt.Errorf("type must be string *batchv1.CronJob, or batchv1.CronJob")
	ERR_TYPE_CREATE = fmt.Errorf("type must be string, []byte, *batchv1.CronJob, batchv1.CronJob, runtime.Object or map[string]interface{}")
	ERR_TYPE_UPDATE = ERR_TYPE_CREATE
	ERR_TYPE_APPLY  = ERR_TYPE_CREATE
	ERR_TYPE_DELETE = ERR_TYPE_CREATE
	ERR_TYPE_GET    = ERR_TYPE_CREATE
)

var ERR_TYPE = fmt.Errorf("type must be *batchv1.CronJob, batchv1.CronJob or string")

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 cronjob handler from kubeconfig or in-cluster config.

func NewOrDie

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

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

func (*Handler) Apply

func (h *Handler) Apply(obj interface{}) (*batchv1.CronJob, error)

Apply applies cronjob from type string, []byte, *batchv1.CronJob, batchv1.CronJob, runtime.Object or map[string]interface{}.

func (*Handler) ApplyFromBytes

func (h *Handler) ApplyFromBytes(data []byte) (cm *batchv1.CronJob, err error)

ApplyFromBytes pply cronjob from bytes.

func (*Handler) ApplyFromFile

func (h *Handler) ApplyFromFile(filename string) (cm *batchv1.CronJob, err error)

ApplyFromFile applies cronjob from yaml file.

func (*Handler) ApplyFromObject

func (h *Handler) ApplyFromObject(obj runtime.Object) (*batchv1.CronJob, error)

ApplyFromObject applies cronjob from runtime.Object.

func (*Handler) ApplyFromUnstructured

func (h *Handler) ApplyFromUnstructured(u map[string]interface{}) (*batchv1.CronJob, error)

ApplyFromUnstructured applies cronjob from map[string]interface{}.

func (*Handler) Clientset

func (h *Handler) Clientset() *kubernetes.Clientset

Clientset returns underlying clientset.

func (*Handler) Create

func (h *Handler) Create(obj interface{}) (*batchv1.CronJob, error)

Create creates cronjob from type string, []byte, *batchv1.CronJob, batchv1.CronJob, runtime.Object or map[string]interface{}.

func (*Handler) CreateFromBytes

func (h *Handler) CreateFromBytes(data []byte) (*batchv1.CronJob, error)

CreateFromBytes creates cronjob from bytes.

func (*Handler) CreateFromFile

func (h *Handler) CreateFromFile(filename string) (*batchv1.CronJob, error)

CreateFromFile creates cronjob from yaml file.

func (*Handler) CreateFromObject

func (h *Handler) CreateFromObject(obj runtime.Object) (*batchv1.CronJob, error)

CreateFromObject creates cronjob from runtime.Object.

func (*Handler) CreateFromUnstructured

func (h *Handler) CreateFromUnstructured(u map[string]interface{}) (*batchv1.CronJob, error)

CreateFromUnstructured creates cronjob from map[string]interface{}.

func (*Handler) DeepCopy

func (in *Handler) DeepCopy() *Handler

func (*Handler) Delete

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

If passed parameter type is string, it will simply call DeleteByName instead of DeleteFromFile. You should always explicitly call DeleteFromFile to delete a cronjob from file path.

func (*Handler) DeleteByName

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

DeleteByName deletes cronjob by name.

func (*Handler) DeleteFromBytes

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

DeleteFromBytes deletes cronjob from bytes.

func (*Handler) DeleteFromFile

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

DeleteFromFile deletes cronjob from yaml file.

func (*Handler) DeleteFromObject

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

DeleteFromObject deletes cronjob from runtime.Object.

func (*Handler) DeleteFromUnstructured

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

DeleteFromUnstructured deletes cronjob from map[string]interface{}.

func (*Handler) DiscoveryClient

func (h *Handler) DiscoveryClient() *discovery.DiscoveryClient

DiscoveryClient returns underlying discovery client.

func (*Handler) DurationOfCompleted

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

DurationOfCompleted returns the duration from last time the job successful completed.

func (*Handler) DurationOfLastScheduled

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

DurationOfLastScheduled returns the duration from last time the job successfully scheduled.

func (*Handler) DynamicClient

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

DynamicClient returns underlying dynamic client.

func (*Handler) Get

func (h *Handler) Get(obj interface{}) (*batchv1.CronJob, error)

If passed parameter type is string, it will simply call GetByName instead of GetFromFile. You should always explicitly call GetFromFile to get a cronjob from file path.

func (*Handler) GetAge

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

GetAge returns cronjob age.

func (*Handler) GetByName

func (h *Handler) GetByName(name string) (*batchv1.CronJob, error)

GetByName gets cronjob by name.

func (*Handler) GetContainers

func (h *Handler) GetContainers(object interface{}) ([]string, error)

GetContainers get all container of this cronjob.

func (*Handler) GetFromBytes

func (h *Handler) GetFromBytes(data []byte) (*batchv1.CronJob, error)

GetFromBytes gets cronjob from bytes.

func (*Handler) GetFromFile

func (h *Handler) GetFromFile(filename string) (*batchv1.CronJob, error)

GetFromFile gets cronjob from yaml file.

func (*Handler) GetFromObject

func (h *Handler) GetFromObject(obj runtime.Object) (*batchv1.CronJob, error)

GetFromObject gets cronjob from runtime.Object.

func (*Handler) GetFromUnstructured

func (h *Handler) GetFromUnstructured(u map[string]interface{}) (*batchv1.CronJob, error)

GetFromUnstructured gets cronjob from map[string]interface{}.

func (*Handler) GetImages

func (h *Handler) GetImages(object interface{}) ([]string, error)

GetImages get all container images of this cronjob.

func (*Handler) GetJobs

func (h *Handler) GetJobs(object interface{}) ([]batchv1.Job, error)

GetJobs get all jobs created by the cronjob.

func (*Handler) GetSchedule

func (h *Handler) GetSchedule(object interface{}) (string, error)

GetSchedule returns the schedule in Cron format.

func (*Handler) IsSuspend

func (h *Handler) IsSuspend(object interface{}) (bool, error)

IsSuspend check whether the controller will suspend subsequent executions.

func (*Handler) List

func (h *Handler) List(labels string) (*batchv1.CronJobList, error)

List list cronjobs by labels, alias to ListByLabel.

func (*Handler) ListAll

func (h *Handler) ListAll(namespace string) (*batchv1.CronJobList, error)

ListAll list all cronjobs in the k8s cluster.

func (*Handler) ListByLabel

func (h *Handler) ListByLabel(labels string) (*batchv1.CronJobList, error)

ListByLabel list cronjobs by labels.

func (*Handler) ListByNamespace

func (h *Handler) ListByNamespace(namespace string) (*batchv1.CronJobList, error)

ListByNamespace list cronjobs by namespace.

func (*Handler) Namespace

func (h *Handler) Namespace() string

func (*Handler) NumActive

func (h *Handler) NumActive(object interface{}) (int, error)

NumActive returns the number of running job created by cronjob.

func (*Handler) RESTClient

func (h *Handler) RESTClient() *rest.RESTClient

RESTClient returns underlying rest client.

func (*Handler) RESTConfig

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

RESTConfig returns underlying rest config.

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) SetLimit

func (h *Handler) SetLimit(limit int64)

func (*Handler) SetPropagationPolicy

func (h *Handler) SetPropagationPolicy(policy string)

Whether and how garbage collection will be performed. support value are "Background", "Orphan", "Foreground", default value is "Background"

func (*Handler) SetTimeout

func (h *Handler) SetTimeout(timeout int64)

func (*Handler) Update

func (h *Handler) Update(obj interface{}) (*batchv1.CronJob, error)

Update updates cronjob from type string, []byte, *batchv1.CronJob, batchv1.CronJob, runtime.Object or map[string]interface{}.

func (*Handler) UpdateFromBytes

func (h *Handler) UpdateFromBytes(data []byte) (*batchv1.CronJob, error)

UpdateFromBytes updates cronjob from bytes.

func (*Handler) UpdateFromFile

func (h *Handler) UpdateFromFile(filename string) (*batchv1.CronJob, error)

UpdateFromFile updates cronjob from yaml file.

func (*Handler) UpdateFromObject

func (h *Handler) UpdateFromObject(obj runtime.Object) (*batchv1.CronJob, error)

UpdateFromObject updates cronjob from runtime.Object.

func (*Handler) UpdateFromUnstructured

func (h *Handler) UpdateFromUnstructured(u map[string]interface{}) (*batchv1.CronJob, error)

UpdateFromUnstructured updates cronjob from map[string]interface{}.

func (*Handler) Watch

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

Watch watch cronjobs by name, alias to "WatchByName".

func (*Handler) WatchByLabel

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

WatchByLabel watch cronjobs by label.

func (*Handler) WatchByName

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

WatchByName watch cronjobs by name.

func (*Handler) WithDryRun

func (h *Handler) WithDryRun() *Handler

func (*Handler) WithNamespace

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