CronJob

Default version: batch/v1beta1

• Official Documentation

• PHP K8s Pod Kind

• PHP K8s Job Kind

Example

use RenokiCo\PhpK8s\K8s;

$container = K8s::container()
    ->setName('pi')
    ->setImage('perl')
    ->setCommand(['perl',  '-Mbignum=bpi', '-wle', 'print bpi(2000)']);

$pod = K8s::pod()
    ->setName('pi')
    ->setLabels(['job-name' => 'pi']) // needs job-name: pi so that ->getPods() can work
    ->setContainers([$container])
    ->restartOnFailure();

$job = K8s::job()
    ->setName('pi')
    ->setSelectors(['matchLabels' => ['tier' => 'backend']])
    ->setTemplate($pod);

$cronjob = $this->cluster
    ->cronjob()
    ->setName('pi')
    ->setLabels(['tier' => 'backend'])
    ->setAnnotations(['perl/annotation' => 'yes'])
    ->setJobTemplate($job)
    ->setSchedule(CronExpression::factory('@hourly'))
    ->create();

Job Template Retrieval

CronJobs rely on jobs, so you can get the pod template as K8sJob class:

$template = $cronjob->getJobTemplate();

$jobName = $template->getName();

To retrieve the pod template as an array, pass false to the retrieval method:

$pod = $cronjob->getJobTemplate(false);

$jobName = $template['name'];

CronJob Status

The Status API is available to be accessed for fresh instances:

$cronjob->getStatus();

$lastSchedule = $cronjob->getLastSchedule(); // Carbon\Carbon instance with the last schedule time.

if ($lastSchedule->before(now())) {
    echo 'This job already ran...';
}

Active Jobs

You can access the active jobs for any cronjob. The active jobs return an \Illuminate\Support\Collection instance, on which you can chain various methods as described here: https://laravel.com/docs/master/collections

while (! $job = $cronjob->getActiveJobs()->first()) {
    $cronjob->refresh();
    sleep(1);
}

// You can get the scheduled Job's pods.
$job->getPods();

The $job variable is a K8sJob instance class that is already synced with the existing job. Check Job documentation for the K8sJob instance.