External pipeline

2 minute read

CloudBees Release Orchestration SaaS Agent allows you to create a pipeline with a defined pipeline. When you add a External Pipeline step, you can now define your External Pipeline configuration.

External pipeline configuration

Drag and drop yourExternal Pipeline and configure the following External Pipeline options on the right pane:

  • Tool Name*: Select your CI

  • Environment Name*: Select your Environment

  • Pipeline Name*: All the jobs configured in the tool gets appended in the drop down. Select the job you want, based on that job external pipeline will created For example Unified_UI_Multi_Deploy, the external pipeline is created with two stages namely _"checkout" , "Build & Copy" _

Based on Pipeline Name the external pipeline stages varies

Job Parameters: Enter the parameters the job expects.

  • Branch_Name: The CloudBees Release Orchestration SaaS Agent displays all the branches Select the branch name on which the latest code changes are stored.

  • Namespace: Enter the namespace.

  • Build: Enter the build to run.

  • Env_Name: Enter the name of your environment such as Stage, Production, and Test.

Modify parameters during execution

Enable Modify Parameters during Execution in the right pane allows you to to modify the parameter of the tool during the pipeline execution.

Schedule

  • Enable the check box for a custom script to run at a specific time when a commit happens. You can schedule in the following ways:

    • Force Start: Enable the force start if you need to run the pipeline before Schedule time.

    • Every: Enable the checkbox and select the time (in minutes or hours) to run a custom script.

    • Time: Enter a specific time. When a commit happens, the custom script step waits until the defined time and runs at the specified time.

    • Time Zone: Enter the time zone. The custom script runs at the defined time and in the specified time zone.

    • Recurrence: Enable the check box and define a weekly recurring interval for a custom script to run on a specific day of the week, when a commit happens.

Notification

  • Enable the check box to notify the user upon the completion of a custom script.

    • Success: Enable the check box to notify the user when a custom script is successful.

    • Failure: Enable the check box to notify the user when a custom script has failed.

    • Notify Committer: Enable the check box to notify the user who made the code change and committed. The platform automatically identifies the user who has committed the code change and notifies the committer.

    • Mode: Select the mode of notification

      • Email ID: Select the mail ID of any specific user from the drop down to send the notification.

      • Slack: When you want to get notification on the Slack tool, you can select Slack → Slack endpoint and Slack Channel.

      • Send Event to Observability Tool: You can also choose to send notifications on the Observability tool by selecting the Send event to Observability tool→ Tool name*.

If you try to skip a field and move, the application displays a red line promoting you to fill in the details to move forward