Managing Your Pipelines

Use these tutorials to create, modify, and run your pipelines.

Creating Pipelines

Before you begin:

A pipeline requires at least two jobs. To create another job, see Creating Jobs.

  1. Click the The "Projects" module icon is a folder. Projects module from the primary navigation menu.
    Your project library opens and lists the projects you’ve created.

  2. Click a project.
    The project opens on its job library.

    Navigate to your project

  3. Click The "Pipelines" page icon is represented by several connected jobs. Pipelines from the secondary navigation menu to open the project’s pipeline library.

  4. Click New pipeline to create a new pipeline.
    A page to create your pipeline opens.

  5. Enter a name and a description to your pipeline.

  6. Construct your pipeline by adding at least two jobs.

    1. Select Add job and chose a first job from the list.
      A card containing basic information, such as name, technology and job category, appears in the graph.

    2. Select Add job again and chose a second job from the list.
      Another card containing basic information, such as name, technology and job category, appears in the graph.

    3. Linked the two pipelines.

      pipeline create
  7. Configure the settings. You can add a scheduled run, email alerts and a release note.

  8. Click either:

    • Save pipeline to save your changes.

    • Save & run to save your changes and automatically run your pipeline.

      Click the cross to exit the creation mode without saving your pipeline. A pop-in window appears with a progress bar: you can click the cross to exit faster or click Continue pipeline to cancel your cancellation.
To delete a pipeline, click delete Delete at the end of the corresponding pipeline row from the The "Pipelines" page icon is represented by several connected jobs. Pipelines page. A confirmation message appears, click Delete again to confirm the deletion. Be careful, because there is no progress bar to cancel the deletion once it is confirmed.

Running and Stopping Pipelines

You can run or stop your pipelines manually, even when the pipelines are is scheduled to run.

  1. Click the The "Projects" module icon is a folder. Projects module from the primary navigation menu.
    Your project library opens and lists the projects you’ve created.

  2. Click a project.
    The project opens on its job library.

    Navigate to your project

  3. Click The "Pipelines" page icon is represented by several connected jobs. Pipelines from the secondary navigation menu to open the project’s pipeline library.

  4. You can either:

    • Click Run or Stop in front of the desired pipeline from the library.

    • Open the pipeline details and start or stop the run from there.

      1. Click the desired pipeline to open its details.
        By default, the The "Overview" page icon is a square divided into several other squares. Overview page opens.

      2. Click either Run or Stop depending of the current status of your pipeline.

        You can also access this command at the bottom of the secondary navigation menu from the The "Instances" page icon is three overlapping squares. Instances and The "Versions" page icon is a folder with an arrow pointing up. Versions page.

    The pipeline status changes depending on the outcome.

Modifying Pipelines Settings

After its creation, you can always modify your pipeline settings. You can access the settings from the The "Overview" page icon is a square divided into several other squares. Overview page of the pipeline.

  1. Click the The "Projects" module icon is a folder. Projects module from the primary navigation menu.
    Your project library opens and lists the projects you’ve created.

  2. Click a project.
    The project opens on its job library.

    Navigate to your project

  3. From the list, click a pipeline to access its details.
    The pipeline The "Overview" page icon is a square divided into several other squares. Overview page opens.

  4. Pipeline settings are accessible from the The "Overview" page icon is a square divided into several other squares. Overview page. Click the desired element to edit it:

    Pipeline settings from the "Overview" page.
    • 1 - Name

    • 2 - Description

    • 3 - Scheduled Run

    • 4 - Email Alerts

    Names are mandatory, with a maximum of 255 characters, and unique within a project.

    Descriptions are optional and have no restrictions, but it’s a good practice to keep them short and informative.

    There are two runtime types:

    • The manual run, which requires you to click Run to start the pipeline.

    • The scheduled run, which launches the pipeline according to the schedule you choose.

      Scheduled pipelines can also be started manually.

      The Scheduled run type has three schedule modes: Simple, Shortcut, and Expert.

      • In Simple mode, you can easily specify variables through the user interface. There are many possibilities.

        Screenshot of the settings for the scheduled run type in simple mode

      • In Shortcut mode, you can choose the recurrence of your run on an hourly, daily, weekly, monthly, or annual basis. All other settings are automatic.

        Screenshot of the settings for the scheduled run type in shortcut mode

      • In Expert mode, you can specify variables using the Cron format. The Cron time string consists of five values separated by spaces: [minute] [hour] [day of the month] [month] [day of the week]. They are based on the following information:

        Table 1. Cron format
        Descriptor Acceptable values

        Minute

        0 to 59, or *

        Hour

        0 to 23, or *

        Day of the month

        1 to 31, or *

        Month

        1 to 12, or *

        Day of the week

        0 to 7 (0 and 7 both represent Sunday), or *

        The Cron time string must contain entries for each character attribute. If you want to set a value using only minutes, you must have asterisk characters for the other four attributes that you’re not configuring.

        Screenshot of the settings for the scheduled run type in expert mode

        Once you have finished scheduling your run, you will see the summary of your choice written below and the time of the next run.

    Alerts are optional and can be set to receive an email when the status of your pipeline changes. They can be sent to multiple email addresses to notify you of the following status changes:

    • queued requested Requested: the pipeline’s run has been requested and is being executed.

    • queued requested Queued: the pipeline is waiting for the necessary resources to be executed.

    • spinner Running: the pipeline is up and running.

    • success Succeeded: the pipeline has been successfully executed.

    • stop Stopping: the pipeline is stopping.

    • stop Stopped: the pipeline has stopped running.

    • failed Failed: the pipeline has crashed.

    • unknown Unknown: the pipeline no longer runs because an error has occurred.

  5. Saving is automatic. You can just press Enter to validate the pipeline name change, click anywhere nearby to confirm the description change, and close de side panel to validate the scheduled run and email alert changes.

Upgrading Pipelines

You can upgrade your pipelines to always get the most out of them. It allows you to modify the name and description, the settings, add and delete jobs and conditions. By upgrading your pipeline, you create a new version of it.

  1. Click the The "Projects" module icon is a folder. Projects module from the primary navigation menu.
    Your project library opens and lists the projects you’ve created.

  2. Click a project.
    The project opens on its job library.

    Navigate to your project

  3. From the list, click a job to access its details.
    The job The "Overview" page icon is a square divided into several other squares. Overview page opens.

    On this page you can see information about the last update, such as when it took place, by whom, how long it took to run, and the version currently in use.
  4. From the The "Instances" page icon is three overlapping squares. Instances or The "Versions" page icon is a folder with an arrow pointing up. Versions page, click Upgrade pipeline button.
    The page for editing your pipeline opens.

  5. You can:

    • Design your pipeline → Move jobs and conditions anywhere on the design grid.

    • Add or remove jobs →

      • Click Add job and select a job from the list to add a job to the pipeline.

      • Click the job card and select delete Remove to remove the job from the pipeline.

    • Add or remove links →

      • Click the connectors of a job or condition and connect then to create links between them.

      • Click the small grey cross in the middle of a link to remove the link between two jobs.

    • Add or remove conditions →

      • Click Add condition to add a condition to the pipeline.

      • Click the condition and select delete Remove to remove the condition from the pipeline.

    • Modify settings → Change the pipeline name, description, scheduled run, email alerts, and release note.

      Changes related to metadata such as name, description, scheduled run, email alerts, and release note do not trigger the creation of a new pipeline version.

Your pipeline has been upgrade and you should see that a new version of it has been created, along with a new instance.