About Pipelines

The The "Pipelines" page icon is represented by several connected jobs. Pipelines page lets you access the pipeline library of a project.

What is a pipeline?

A pipeline is an end-to-end process that includes multiple jobs that are connected and executed within projects. A pipeline can include advanced orchestration logic, such as conditions or parallel job execution.

Pipelines are listed with few basic information, such as the name (a), status (b), and last instance executed (c).

From the pipeline library, you can also run a pipeline (d), delete it, move it to another project, or duplicate its Current Badge for the "Current" status version (e).

A clock Clock icon to view information about the next job run. icon (f) is displayed for scheduled pipelines: hover over the icon to view information about the next pipeline run.
Focused image of listed pipelines.

Click a pipeline to access its:

Overview Page

The The "Overview" page icon is a square divided into several other squares. Overview page gives general information on your pipeline.

By default, the page opens when you click a pipeline in the project’s pipeline library.

Screenshot of the "Overview" page of a pipeline.

The first part of the page (1) gives general information on the pipeline, such as the name, alias, description, and other pipeline settings. It also allows you to delete the pipeline, move it to another project, or duplicate its Current Badge for the "Current" status version (a).

The second part of the page (2) gives information on the last pipeline instance, such as the status, start and end dates, duration, and whether variables were editable at runtime.

You can also see the progress of a running pipeline in real-time. Click a job to open a context menu and view:

Screenshot of a selected job from a pipeline instance to access this job overview and logs

  • The overview page of the selected job by clicking overview See overview.

  • The log page of the selected job instance by clicking logs See logs.

  • A summary table of the variables used and modified (5) by clicking settings env vars a See variables, if the setting for modifying variables at pipeline execution was enabled.

When a pipeline is running, you can select a job to view its overview by clicking overview See overview in the job’s context menu. When a job is finished, click it to open a context menu and view its logs, and a summary table of the variables used and modified (4), if the setting has been enabled at runtime.

Use the buttons to adjust the view to your needs. You can display the pipeline in full screen (b), zoom in and out (c), reframe it (d), and realign (e) the graph.

The third part of the page (3) gives information on the pipeline consumption through various graphs. You can use these graphs to check your pipeline consumption during its execution.

monitoring graph consumption pipeline
  • Hover over the legend to see on which node the pipeline has been executed.

  • Select a range on the graph to zoom in on the selection. Click close Reset range to display all details again.

The fourth part of the page (4) gives information on the variables used and modified. It is only available if the setting to modify variables at pipeline runtime was enabled.

Instances Page

The The "Instances" page icon is three overlapping squares. Instances page gives information on your pipeline instances and allows you to keep track of all executed instances.

What is an instance?

An instance is a single run of a job or pipeline in a project. Execution information and job logs of all instances are saved on your platform.

Each time you run a pipeline, you create a new instance of it. All instances are saved and remain accessible. They are listed on the right side of the page (1). You can see their information by selecting them in the list. You can also delete instances from this list.

By default, the page opens on the last executed instance of the selected pipeline.

Screenshot of the "Instances" page of a pipeline.

The first part of the page (2) gives general information on the pipeline instance, such as the instance number (specified by #001 in the title), execution status, the pipeline version used, and whether variables were editable at runtime.

The second part of the page (3) allows you to see the progress of the orchestration for the running pipeline in real-time. Click a job to open a context menu and view:

Screenshot of a selected job from a pipeline instance to access this job overview and logs

  • The overview page of the selected job by clicking overview See overview.

  • The log page of the selected job instance by clicking logs See logs.

  • A summary table of the variables used and modified (5) by clicking settings env vars a See variables, if the setting for modifying variables at pipeline execution was enabled.

Use the buttons to adjust the view to your needs. You can display the pipeline in full screen (a), zoom in and out (b), reframe it (c), and realign (d) the graph.

The third part of the page (3) gives information on the pipeline consumption through various graphs. You can use these graphs to check your pipeline consumption during its execution.

monitoring graph consumption pipeline
  • Hover over the legend to see on which node the pipeline has been executed.

  • Select a range on the graph to zoom in on the selection. Click close Reset range to display all details again.

The fourth part of the page (4) gives information on the variables used and modified. It is only available if the setting to modify variables at pipeline runtime was enabled.

You can edit your pipeline by clicking The "Upgrade pipeline" icon is an arrow pointing up. Upgrade pipeline (6). Upgrading your pipeline creates a new version of it.

Versions Page

The The "Versions" page icon is a folder with an arrow pointing up. Versions page gives information on the version of your pipeline. It also keeps track of all previous versions.

What is a version?

A version is a single iteration of a job, pipeline, or app. Each new upgrade is stored as a version, so you can roll back to previous iterations and keep track of the changes that have been made.

Each time you upgrade a pipeline (1), you create a new version of it. This version is automatically defined as the Current Badge for the "Current" status version.

All versions are saved and remain accessible. They are listed on the right side of the page (2), and you can see the information of a version by selecting it in the list. You can also delete versions from this list.

You can switch back and forth between versions by selecting a version from the list and clicking Rollback to this version (3). The selected version then becomes the new Current Badge for the "Current" status version.

You can define a version as major to highlight the most stable pipeline version. Select a version from the list and click Set as major version (4). The version appears with the Major version label and sparks in front of its line. Click Unset as a major version to remove the label from a version.

By default, the page opens on the version of the pipeline in use, tagged with the Current Badge for the "Current" status badge.

Screenshot of the "Versions" page of a pipeline.

The first part of the page (5) gives general information on the version, such as the version number, release note, creation date and creator.

The second part of the page (6) displays the pipeline version orchestration.

Use the buttons to adjust the view to your needs. You can display the pipeline in full screen (a), zoom in and out (b), reframe it (c), and realign (d) the graph.

Environment Variables Page

The The "Environment variables" module icon is a rectangle with the "VAR" written in it. Environment Variables page gives you access to the environment variables of the pipeline.

What is an environment variable?

An environment variable is a dynamic value that can be referenced in jobs. It limits the need to modify the job execution code each time the value of the variable changes.

pipeline environment variables

Environment variables are listed with some basic information, such as the name, description, and application level, which is indicated by the Pipeline badge envvar pipeline label.

At the pipeline level, the Icon for environment variables Environment Variables page gives you access to the environment variables defined for the selected pipeline but also to the project and global environment variables. However, you can only create and edit environment variables for the pipeline.

  • You can create up to 200 environment variables per pipeline. When you reach this limit, the create button becomes unavailable, preventing you from creating new environment variables.

  • Click the environment variable to view its information. A panel opens. You can edit its information from this panel.

  • Environment variable can be defined as passwords. Select the option is password if your value is a password and must be hidden.

  • You can override a global or project environment variable only for the pipeline currently displayed. Click a global or project environment variable from the pipeline environment variables library. Then, click Override in this pipeline. The overridden environment variable will still exist at its level and will still be applied, except in this pipeline. For more information, see Overriding Environment Variables.

Environment variables can be created at the platform, project, and pipeline level. This allows you to have values dedicated to a specific scope without impacting other projects or pipelines. Therefore, you will find two other Environment Variables pages.

  • At the platform level: At this level, the The "Environment variables" module icon is a rectangle with the "VAR" written in it. Environment Variables page allows you to access, create, and edit only the global environment variables, that is, environment variables defined for all projects on the platform. For more information, see the Environment Variables page of a platform.

  • Within a project: At this level, the The "Environment variables" module icon is a rectangle with the "VAR" written in it. Environment Variables page gives you access to the environment variables defined for the selected project but also to the global environment variables. However, you can only create and edit environment variables for the project. For more information, see the Environment Variables page of a project.