1. Using Visual Builder Studio
  2. Common Tasks
  3. Build Your Applications
  4. Run Jobs in a Pipeline
  5. Create and Manage Pipelines

Create and Manage Pipelines

From the Pipelines tab, you can create, run, and manage pipelines.

Note:

If you're creating a new pipeline or renaming an existing one and see a message that the pipeline name you entered matches a pattern that is restricted, you don't have access to any pipeline name matching the glob pattern that restricts the pipeline. Enter a name that doesn't match the name restricted by the glob pattern or contact the pipeline owner and request to be added as an authorized user (or member of an authorized group).

See Protect Your Pipeline: Restrict Who Can Start It Manually or Edit Its Configuration.

Note:

If you're trying to access a renamed or deleted pipeline by using a link from the activities feed (or from a bookmarked link), you will be unable to do so because that pipeline no longer exists. A page with a message indicating that there was an error loading the Pipelines page is displayed, along with some text that says that the pipeline could not be found because it may have been deleted or renamed. Click the Take me back to Pipelines button and the Builds page's Pipelines tab will be displayed.

To access the Pipelines tab:

  1. In the left navigator, click Builds Builds.
  2. Click the Pipelines tab.
    Action How to

    Create a pipeline

    		 In the Pipelines tab:

    1. Click + Create Pipeline.

      The Create Pipeline dialog is displayed.

    2. In Name and Description, enter a unique name and a description, respectively.

    3. (Optional) Select the appropriate check boxes:

      • Auto start when pipeline jobs are built externally: Select this check box to trigger a pipeline build when any job in the pipeline is triggered externally (that is, started from outside the pipeline).

        In the pipeline, builds of jobs downstream from the started job will be run in the order shown in the diagram. Builds of jobs upstream from the externally-started job in the pipeline won't be run.

      • Auto start only when trigger jobs are built: If you selected the Auto start option in the previous step, you can select this check box to limit the jobs that can automatically start the pipeline to trigger jobs only. This effectively excludes all jobs that aren't trigger jobs.

        If both options are selected, when a non-trigger pipeline job is started manually, it won't be shown in the Pipeline Instances page. It will be shown on the Jobs Overview page instead, because the Trigger only option was selected.

      • Disallow pipeline jobs to build externally when the pipeline is building: Select this check box to disable manual or automatic builds of the jobs that are part of the pipeline when the pipeline is running.

    4. Click Create.

    5. In the Pipeline Configuration page, design the pipeline, and click Save.

    Rename a pipeline or update its description In the Pipelines tab:
    1. Choose Configure Pipeline from the Actions Actions menu menu in the Pipelines tab (or click the Configure button from a pipeline's details page).
    2. Select Settings if it isn't already selected.
    3. In Name, update the pipeline name.
    4. Click Save.
    Create a pipeline using YAML In VB Studio, you can use a YAML file (a file with .yml extension) to store a job or pipeline configuration in any of the project's Git repositories. See Configure Jobs and Pipelines with YAML.
    Configure a pipeline

    The pipeline configuration page opens immediately after you create a pipeline. You can also configure an existing pipeline by choosing Configure Pipeline from the Actions Actions menu menu in the Pipelines tab or clicking the Configure button from a pipeline's details page.

    Note:

    If you are configuring an edit restricted pipeline:
    • The Pipelines page's Configure Pipeline and Delete Pipeline options in the Actions Actions menu menu are disabled.
    • The Pipeline Details page doesn't display the Configure or Delete buttons.
    • The Delete option in the Run History page's Actions Actions menu menu is disabled.
    • The Delete button is not displayed on the Pipeline Run Instance page.
    • The lock icon Lock iconwill be displayed in the Private column in the list of pipelines on the Pipelines page.
    • The Pipeline Protection page's pipelines list (accessed from the tab under the Project Administration : Builds tile) uses the same icon to identify protected pipelines. See Protect Your Pipeline: Restrict Who Can Start It Manually or Edit Its Configuration.
    Run a pipeline

    Choose Run Pipeline from the Actions Actions menu menu in the Pipelines tab or click the Run button from a pipeline's details page.

    Note:

    There can be a maximum of five (5) instances of the same pipeline running simultaneously. If there is an attempt to exceed this limit, VB Studio will display a message that an additional instance of the pipeline failed to start because the maximum number of instances were already running.
    Delete a pipeline Choose Delete Pipeline from the Actions Actions menu menu in the Pipelines tab or click the Delete button from a pipeline's details page.