Eventline is now open source and available on GitHub !

If you are still using the old Eventline platform, contact us to migrate to the new service, and head to the new documentation website for more information.

Commands

Introduction

While triggers are about automatic execution, commands are designed for manual execution. They offer a mechanism to instantiate one or more pipelines whenever you need it, using the web interface or the evcli command line tool.

Data schema

Command data contain the following fields:

parameters (array)
The set of parameters used by the command.
pipelines (array)
A list of pipelines to instantiate when the command is executed.

Example

type: "command"
version: 1
name: "create-pg-snapshot"
description: "create a snapshot of the main postgresql database"
data:
  parameters:
    - name: "name"
      type: "string"
    - name: "ttl"
      type: "integer"
      default: 30
      description: "the number of days to keep the snapshot around"
    - name: "notify-devops"
      type: "boolean"
      description: "whether to send an email to the devops team or not"
  pipelines:
    - "create-pg-snapshot"

Parameters

Parameters are used to pass values to the pipelines instantiated by the command. Each parameter is an object containing the following fields:

name (string)
The name of the parameter. It must be unique in each command.
type (string)
The data type of the parameter.
values (string array)
A list of valid values for the parameter. Can only be used for parameters of type string.
default (any)
The value used for the parameter if it is not provided during command execution. The parameter is mandatory if it does not have a default value.
description (string)
A description of the parameter (optional).
environment (string)
If defined, set an environment variable to the value of this parameter in all pipelines instantiated from this command (optional).

Parameter names follow the same conventions as resource names.

Info
Parameter descriptions are used on the website and in the evcli command line tool to display information about a command. Using them will make your commands easier to use.

Data types

The following data types are currently supported:

number
A 64 bit signed integer or 64 bit floating point number.
integer
A 64 bit signed integer.
string
An UTF-8 encoded character string.
boolean
Either true or false.

In general, values must always be representable by valid JSON values.