Stages and Steps

Stages and steps are the collections of actions that make up pipelines on the Cycle platform.

Steps Action List

The following is a full list of supported pipeline steps.

  • Sleep - an amount of time for the pipeline to wait in seconds before moving to the next step.
  • Webhook Post - post the results of a previous step to the supplied endpoint.
  • Container Create - create a container resource.
  • Container Restart - restart a container resource.
  • Container Start - start a container resource.
  • Container Stop - stop a container resource.
  • Container Delete - delete a container resource.
  • Image Source Create - create an image source that can be used to create and import images.
  • Image Create - create the shell of an image that will be populated with data when the image is imported.
  • Image Import - import the resources that will make up the image from the connected image source.
  • Images Prune - prune all or a list of images by source.
  • Environment Create - create an environment resource.
  • Environment Start - start an environment resource.
  • Environment Start - start an environment resource.
  • Environment Stop - stop an environment resource.
  • Environment Delete - delete an environment resource.
  • Stack Build Create - build the shell of a stack that will be used to generate the stack build.
  • Stack Build Generate - generate a full build of the stack.

Each of these steps can be added to a stage one or more times through the editor. All steps can be referenced by an optional identifier and the results of that step can be reused in other steps.

Be sure to check the official Cycle Blog for guides and tutorials on how these steps can be used together to form powerful pipeline automations coming soon!

Adding Stages and Steps

Adding a stage from the editor is as easy as clicking the Add New Stage button and entering a name into the stage identifer form field.

Adding a step to a stage is a similar process but after clicking into the Add New Step button, you'll be presented with a modal.

Select an action type from the dropdown, and you'll be able to quickly configure your desired setting for that action.

As you can see the enable reference checkbox is clicked here. This allows the step to be referenced by other steps in the same pipeline - even if they are in different stages.

To save changes to the steps and stages you must press the Save Pipeline button at the bottom of the page. Failure to do this will result in a loss of your applied changes.

Managing Stages And Steps

Stages can be skipped and deleted. To skip a stage, slide the skip toggle to the right hand side. To delete a stage, click on the gear icon in the top right of the stage you have selected and click Set Stage To Be Deleted. A stage that is marked for deletion will not be immediately deleted, in order for the deletion to take place you will need to save the pipeline.

Steps can also be skipped and deleted. Each step will have two check boxes available, the first is a box that will set the step to be skipped and the second to be deleted. These changes will also not take effect until the pipeline is saved.

Settings for both stages and steps come with visual queues showing what the current setting represents (pictured below), so you can be sure which setting is currently configured for your stages and steps.

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