Ona Automations

Configuration for Ona Automations

Type object
File match **/.ona/automations.json **/.ona/automations.yaml **/.ona/automations.yml **/.ona/automation.yaml
Schema URL https://catalog.lintel.tools/schemas/schemastore/ona-automations/latest.json
Source https://app.ona.com/jsonschema/v1/automations_file.jsonschema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

WARN: Do not remove any field here, as it will break reading automation yaml files. We error if there are any unknown fields in the yaml (to ensure the yaml is correct), but would break if we removed any fields. This includes marking a field as "reserved" in the proto file, this will also break reading the yaml.

Properties

services Record<string, object>
tasks Record<string, object>

Definitions

gitpod.v1.AutomationsFile.Service object
commands object
3 nested properties
ready string

ready is an optional command that is run repeatedly until it exits with a zero exit code. If set, the service will first go into a Starting phase, and then into a Running phase once the ready command exits with a zero exit code.

Default: ""
start string

start is the command to start and run the service. If start exits, the service will transition to the following phase:

  • Stopped: if the exit code is 0
  • Failed: if the exit code is not 0 If the stop command is not set, the start command will receive a SIGTERM signal when the service is requested to stop. If it does not exit within 2 minutes, it will receive a SIGKILL signal.
Default: ""
minLength=1
stop string

stop is an optional command that runs when the service is requested to stop. If set, instead of sending a SIGTERM signal to the start command, the stop command will be run. Once the stop command exits, the start command will receive a SIGKILL signal. If the stop command exits with a non-zero exit code, the service will transition to the Failed phase. If the stop command does not exit within 2 minutes, a SIGKILL signal will be sent to both the start and stop commands.

Default: ""
description string
Default: ""
name string
Default: ""
minLength=1
role string
Default: ""
Values: "" "default" "editor" "ai-agent"
runsOn object
2 nested properties
docker object
2 nested properties
environment string[]
image string
Default: ""
minLength=1
machine object

Machine runs the service/task directly on the VM/machine level.

triggeredBy string[]
gitpod.v1.AutomationsFile.Task object
command string
Default: ""
minLength=1
dependsOn string[]
description string
Default: ""
name string
Default: ""
minLength=1
runsOn object
2 nested properties
docker object
2 nested properties
environment string[]
image string
Default: ""
minLength=1
machine object

Machine runs the service/task directly on the VM/machine level.

triggeredBy string[]
gitpod.v1.RunsOn object
docker object
2 nested properties
environment string[]
image string
Default: ""
minLength=1
machine object

Machine runs the service/task directly on the VM/machine level.

gitpod.v1.RunsOn.Docker object
environment string[]
image string
Default: ""
minLength=1
gitpod.v1.RunsOn.Machine object

Machine runs the service/task directly on the VM/machine level.

gitpod.v1.ServiceSpec.Commands object
ready string

ready is an optional command that is run repeatedly until it exits with a zero exit code. If set, the service will first go into a Starting phase, and then into a Running phase once the ready command exits with a zero exit code.

Default: ""
start string

start is the command to start and run the service. If start exits, the service will transition to the following phase:

  • Stopped: if the exit code is 0
  • Failed: if the exit code is not 0 If the stop command is not set, the start command will receive a SIGTERM signal when the service is requested to stop. If it does not exit within 2 minutes, it will receive a SIGKILL signal.
Default: ""
minLength=1
stop string

stop is an optional command that runs when the service is requested to stop. If set, instead of sending a SIGTERM signal to the start command, the stop command will be run. Once the stop command exits, the start command will receive a SIGKILL signal. If the stop command exits with a non-zero exit code, the service will transition to the Failed phase. If the stop command does not exit within 2 minutes, a SIGKILL signal will be sent to both the start and stop commands.

Default: ""