Runway Job Manifest Schema

Type: object

A job manifest for Runway platform

 No Additional Properties
Example:

apiVersion: runway/v1
kind: RunwayJob
metadata:
  owner_email_handle: my-username
  department: my-dept
  department_group: my-dept-group
  product_category: my-product-category
spec:
  region: us-central1
  command:
  - /cron
  args:
  - --arg1
  - --arg2
  resources:
    limits:
      cpu: 500m
      memory: 128Mi

root apiVersion
Type: string Default: "runway/v1"

The API version of the manifest schema

root kind
Type: enum (of string)

The kind of resource manifest

Must be one of:

  • "RunwayJob"

root metadata
Type: object
No Additional Properties

root metadata owner_email_handle
Type: string

The email handle of the person or group that owns this job. See https://handbook.gitlab.com/handbook/infrastructure-standards/labels-tags/#owner-email-handle-glowneremail_handle for more information

root metadata department
Type: string

The department of the person or group that owns this job. See https://handbook.gitlab.com/handbook/infrastructure-standards/labels-tags/#gitlab-department-gl_dept for more information

root metadata department_group
Type: string

The department group of the person or group that owns this job. See https://handbook.gitlab.com/handbook/infrastructure-standards/labels-tags/#gitlab-department-group-gldeptgroup for more information

root metadata product_category
Type: string

The product category that owns this job. See https://handbook.gitlab.com/handbook/infrastructure-standards/labels-tags/#gitlab-product-category-glproductcategory for more information

root spec
Type: object

The specification of the job

 No Additional Properties

root spec region
Type: string Default: "us-east1"

The region to run this job in

root spec command
Type: array

The command that the container is to start up with. Default is to use the ENTRYPOINT defined in the image

 No Additional Items

root spec args
Type: array

Argument you are sending to the container command. If you use multiple arguments, specify each one as a separate item. Default is to use the CMD defined in the image

 No Additional Items

root spec resources
Type: object

The container resource management of the service

 No Additional Properties

root spec resources limits
Type: object

The limits to prevent the container from using more than the configured resources. When exceeded, running containers are terminated

 No Additional Properties

root spec resources limits cpu
Type: string Default: "1000m"

The limit of CPU resources, measured in cpu units

root spec resources limits memory
Type: string Default: "512Mi"

The limit of memory resources, measured in bytes

root spec resources limits scratch_space
Type: string Default: "256Mi"

The amount of memory consumable by the in-memory volume mounted at /scratch, in bytes. Must be less than "memory".

root spec timeout
Type: number Default: 600

Max allowed time (in seconds) per attempt that the task may be active for before the system will actively try to mark it failed and kill associated containers

root spec max_retries
Type: number Default: 3

Number of retries allowed per task before marking this task as failed.

root spec schedule
Type: object

Schedule configuration for the job

 No Additional Properties

root spec schedule paused
Type: boolean Default: false

Controls if the schedule is paused

root spec schedule cron
Type: string

Schedule for this job in cron format

root spec vpc_access
Type: object

VPC connectivity

 No Additional Properties

root spec vpc_access enabled
Type: boolean Default: false

Enable VPC access for connecting to internal services like Memorystore

root spec vpc_access egress
Type: enum (of string) Default: "PRIVATE_RANGES_ONLY"

Type of egress traffic that should be routed via the VPC

Must be one of:

  • "PRIVATE_RANGES_ONLY"
  • "ALL_TRAFFIC"

root spec cloud_providers
Type: object

Cloud provider specific configurations

root spec cloud_providers gcp
Type: object

Google Cloud Platform specific configurations

root spec cloud_providers gcp cloudsql_instances
Type: array of object

List of connection configuration for CloudSQL instances

Must contain a maximum of 3 items

No Additional Items

Each item of this array must be:

root spec cloud_providers gcp cloudsql_instances cloudsql_instances items
Type: object

root spec cloud_providers gcp cloudsql_instances cloudsql_instances items psc_enabled
Type: boolean Default: false

Connect to CloudSQL instance using a Private Service Connect endpoint

root spec cloud_providers gcp cloudsql_instances cloudsql_instances items instance_connection_name
Type: string

Instance connection name of the CloudSQL instance