GuidesChangelogDiscussions
Log In

Ketch Job Definition

In addition to using the Ketch CLI or external providers to manage jobs, you can also leverage a simplified Ketch definition that you can store in a YAML file.

Here is an application definition file example:

name:
type:
framework: 
description:
containers: 
    - name: 
  - image: 
  - command:

Specification

Component

Type

Description

name

string

The name of the job.

Required: Yes

framework

string

The name of the framework/namespace where Ketch should deploy the job.

Required: Yes

description

string

Description of the job you are deploying.

Required: No

containers

Array of key value

The job specification Ketch needs to create and run it.

Required: Yes

name

string

The job process name.

Required: Yes

image

string

The image to deploy as part of this job.

Required: Yes

command

array of string

The commands to execute when deploying the job.

Required: Yes

Job definition example

name: pi-job
type: Job
framework: myframework
description: "Pi job"
containers:
  - name: pi
    image: perl
    command:
      - "perl"
      - "-Mbignum=bpi"
      - "-wle"
      - "print bpi(2000)"

Deploying Job

Use the command below in combination with your job definition file to have Ketch deploy your job:

ketch job deploy job.yaml