Pipelines Overview

From simple tasks like importing an image, to complex sequences that affect entire clusters, Deployment Pipelines make it easy to automate nearly any task within Cycle.

Parts of a Pipeline

Each pipeline consists of stages and steps. Each stage should have one or more steps. A stage can be used as a way to group steps together or to orgainze steps between stages. A step represent a single action.

  • Pipeline - A sequence of tasks on the platform that can be arranged and executed repeatedly.
  • Stage - A group of steps identified with a name. Stages can be individually skipped and deleted.
  • Step - A single action that can be added to a stage. Steps can be individually skipped and deleted. Steps can also be given a reference and subsequent steps (even those in other stages) can use the resources produced by the step using a reference identifier.

Managing Pipelines

To create a new pipeline, simply click the Pipelines tab in the main navigation and then the Create Pipeline button. On the next page, you'll be asked to name your pipeline and then click the Create Pipeline button on that page. Once you've created a pipeline you'll be taken to the pipeline dashboard, pictured below.

From the pipelines dashbaord you can use the Editor to add stages and steps.

  • For more information on adding stages and steps head to the stages and steps page.

Triggering A Pipeline

To start a full run of a pipeline, click the trigger pipeline button located on the pipeline dashboard in the top right of the screen.

If you'd like to remotely trigger a pipeline you can create a trigger key by selecting Trigger Keys from the horizontal nav and then Create Trigger Key.

The create form will ask for a name and a list of IP's (optional) that are approved for this call. Leaving IP's blank just means you can use the trigger key secret from any ip.

The pipeline can be triggered remotely by sending an http POST request to https://api.cycle.io/v1/pipelines/yourpipelineid/trigger - with that request you'll need to send the secret as JSON with the key as secret and the value as your trigger key secret key.

Example http request to trigger pipeline

$ curl https://api.cycle.io/v1/pipelines/5b9c2a77b6393d0001eb45fd/trigger \
    -H "Content-Type: application/json" \
    -d '{"secret": "secret_yaaaCgEabUXnZYcccTaQWTnWYE333DQw1111ZQ2UAUHEEEio6BNqc8888888"}' \
    -X POST

Need Help?

If you've got questions about the platform or need some help getting started, our team is more than happy to assist. Whether you're new to containers or just new to Cycle, reach out to us via livechat by clicking the blue circle in the bottom right corner. Join our Slack channel, and get help from the dev team or other members of the community, and check out our Roadmap to see what's planned for the future!

Copyright © 2021, Cycle - A Petrichor Company
v2021.02.16.01-angel-lake