package
1.33.0-alpha.2
Repository: https://github.com/kubernetes/kubernetes.git
Documentation: pkg.go.dev
# Packages
Package install installs the batch API group, making it available as an option to all of the API encoding/decoding machinery.
# Constants
AllowConcurrent allows CronJobs to run concurrently.
Controller UID is used for selectors and labels for jobs.
Failed means to wait until a previously created Pod is fully terminated (has phaseFailed or Succeeded) before creating a replacement Pod.
ForbidConcurrent forbids concurrent runs, skipping next run if previous hasn't finished yet.
GroupName is the group name use in this package.
IndexedCompletion is a Job completion mode.
JobComplete means the job has completed its execution.
JobControllerName reserved value for the managedBy field for the built-in Job controller.
JobFailed means the job has failed its execution.
FailureTarget means the job is about to fail its execution.
Annotation indicating the number of failures for the index corresponding to the pod, which are counted towards the backoff limit.
Annotation indicating the number of failures for the index corresponding to the pod, which don't count towards the backoff limit, according to the pod failure policy.
JobName is a user friendly way to refer to jobs and is set in the labels for jobs.
JobSuccessCriteriaMet means the Job has reached a success state and will be marked as Completed.
JobSuspended means the job has been suspended.
JobTrackingFinalizer is a finalizer for Job's pods.
LegacyJobName and LegacyControllerUid are legacy labels that were set using unprefixed labels.
NonIndexedCompletion is a Job completion mode.
This is an action which might be taken on a pod failure - the pod failure is handled in the default way - the counter towards .backoffLimit, represented by the job's .status.failed field, is incremented.
This is an action which might be taken on a pod failure - mark the Job's index as failed to avoid restarts within this index.
This is an action which might be taken on a pod failure - mark the pod's job as Failed and terminate all running pods.
This is an action which might be taken on a pod failure - the counter towards .backoffLimit, represented by the job's .status.failed field, is not incremented and a replacement pod is created.
ReplaceConcurrent cancels currently running job and replaces it with a new one.
TerminatingOrFailed means that we recreate pods when they are terminating (has a metadata.deletionTimestamp) or failed.
# Variables
AddToScheme applies all the stored functions to the scheme.
SchemeBuilder points to a list of functions added to Scheme.
SchemeGroupVersion is group version used to register these objects.
# Structs
CronJob represents the configuration of a single cron job.
CronJobList is a collection of cron jobs.
CronJobSpec describes how the job execution will look like and when it will actually run.
CronJobStatus represents the current state of a cron job.
Job represents the configuration of a single job.
JobCondition describes current state of a job.
JobList is a collection of jobs.
JobSpec describes how the job execution will look like.
JobStatus represents the current state of a Job.
JobTemplateSpec describes the data a Job should have when created from a template.
PodFailurePolicy describes how failed pods influence the backoffLimit.
PodFailurePolicyOnExitCodesRequirement describes the requirement for handling a failed pod based on its container exit codes.
PodFailurePolicyOnPodConditionsPattern describes a pattern for matching an actual pod condition type.
PodFailurePolicyRule describes how a pod failure is handled when the requirements are met.
SuccessPolicy describes when a Job can be declared as succeeded based on the success of some indexes.
SuccessPolicyRule describes rule for declaring a Job as succeeded.
UncountedTerminatedPods holds UIDs of Pods that have terminated but haven't been accounted in Job status counters.
# Type aliases
CompletionMode specifies how Pod completions of a Job are tracked.
ConcurrencyPolicy describes how the job will be handled.
JobConditionType is a valid value for JobCondition.Type.
PodFailurePolicyAction specifies how a Pod failure is handled.
+enum.
PodReplacementPolicy specifies the policy for creating pod replacements.