Creating/Editing a Pipeline Version

To create a new pipeline, navigate to the Search Pipelines screen using the Piplelines menu, and click on the Create button.  To edit an existing pipeline, click on the Pipeline Name column of the target pipeline in the search results, or select the row and click the Edit button.

The Definition tab provides the definition of the pipeline stages, and their steps and gates.  Changes to the pipeline, like a workflow, are versioned so that changes can be published to consumers, or previous versions can be reverted.

To add stages to the pipeline version, see Creating/Editing a Pipeline Stage. 

Once the stages are added to the pipeline version you can reorder by clicking the arrows  on the stage, or delete the stage by clicking the delete  button. In addition, for quicker configuration, you have the option to copy any number of gates/steps from one stage to another using copybutton. Using copy button will add the gates or steps selected to the end of target stage. To view/edit the stage, click on the maximize  button.

Click the  button to save your changes and continue with further updates, or the  button to save your changes and return to the previous page.  The  button reverts the changes and returns to the previous page.  

Click the  button to set the selected pipeline version as active, and be sure to save your changes.  Upon activation, the previously active version becomes inactive.  Once a version has been activated it is locked from future edits, and you must click the  button to create a new version in order to make further changes.  You can switch the editor to another version of the pipeline by selecting the pipeline version name in the Switch Version drop-down.

Team

A Team defines a set of roles which will participate during execution of the pipeline.  Roles assigned to the pipeline may then be used within the defined gates and steps (i.e. an approval step).  A role contains default members, which can be FlexDeploy Groups, FlexDeploy Users, or email addresses (used for notifications only).  A release which consumes the pipeline inherits the roles and default members from the pipeline, and can override those members.  For example, the Release Manager members can be different across releases.

In addition to members, a role defined within a pipeline also establishes default permissions.  When a release consumes the pipeline, it inherits the role's default permissions, but can override them for that particular role.  In other words, a role may have different permissions from release to release if necessary.

To create a new Role, click the  icon.  To edit an existing Role, click on the role name.  To delete a new Role, click the  icon. If a role is used in older versions of the pipeline, but not the active version it will be inactivated instead of deleted.

Add FlexDeploy Group or FlexDeploy User members to the role by shuttling them from the Available lists on the left to the Member lists on the right.

Click the  button to save the changes to the role (be sure to also save the pipeline, or changes will be lost), or  to revert any unsaved changes.

Properties

Pipeline Properties are used to decorate a release with some context.  Values for the properties are provided on each release, and may be used in various groovy scripts within the pipeline definition.  For example, only execute a particular step in the pipeline if the "Release Type" is "Security".

To create a new Pipeline Property, click the  icon.  To edit an existing Pipeline Property, click on the Property Code .

if ("BAD".equals(Value)) {ValidationMessage="Bad value!!"; return false;} else {return true;}

Click the  button to save the changes to the property (be sure to also save the pipeline, or changes will be lost), or  to revert any unsaved changes.

Snapshot Variables

Snapshot variables provide state for the life of a snapshot.  Such state affords the ability to store some data as part of a step or gate in one stage, and consume it or make decisions in a later stage.  One classic example is to store off a CMS ticket which was entered or created in one stage, and feed it into another stage which will use the same ticket.  The pipeline defines the metadata for any snapshot variables which are available, and values can be set or retrieved using Custom Gates or Custom Steps.

To create a Snapshot Variable, click on the  icon.  Enter the required information and click Save.

Project Groups

Project Groups provide categorization tags for release content.  As such, pipelines define the tags, and deploy segments of the content based on those tags.  Releases consuming the pipeline can then tag its content as belonging to those groups.

For example, suppose a pipeline defines project groups Database, Configuration, and Applications.  The steps within a pipeline stage can then deploy all Database, deploy all Configuration, and finally, deploy all Applications.  The release which consumes the pipeline, then defines which content is tagged with Database, Configuration, and Applications.

To add a new project group, click the  icon.  Enter the Group Name.

To edit a project group, modify the Group Name, or set the Active flag.

To delete a project group, click on the  icon for the project group you wish to remove.

Referenced By

Identifies the Releases which are referencing this pipeline.