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.

Resources

Introduction

Resources are a generic term for components you will use to create pipelines.

Each resource is part of a project and is represented as a YAML document: when deploying a project, all its resources are send to the server. New resources are created, existing resources are updated, and resources which disappeared are deleted.

Definition files

All resources share the same top-level structure. The following fields are defined:

type (string)
A valid resource type: trigger, command, pipeline or task.
version (integer)
The version associated with the resource type (currently 1).
name (string)
The name of the resource.
description (string)
A short description of the resource (optional).
data (object)
Data specific to the resource type. Refer to the next documentation pages for information about data fields for each resource type.

Example

type: "pipeline"
version: 1
name: "website-deployment"
description: "deploy website static pages to S3"
data:
  tasks:
    - name: "generate"
      task: "generate-static-pages"
    - task: "deploy"
      dependencies:
        - "generate"

Versioning

The version field refers to the data schema used by each resource. In our previous example, we are using the version 1 of the pipeline data schema. In the future, we may introduce new versions with different data schemas; when that happens, previous versions will continue to work as expected.

Naming

Each resource is identified by its name. Resource names must be valid API names.

Names are unique by project and by type. This means that you can have both a task and a command named send-email in the same project, but you cannot have two pipelines named `image-analysis'.