|
| 1 | +After a pipeline is defined, you can execute it. The pipeline may need some inputs for it to run. Ensure you configure them correctly before triggering the run. |
| 2 | + |
| 3 | +# Add Pipeline Variables and Secrets |
| 4 | + |
| 5 | +The pipelines are defined at the organization level. Thus the variables defined for them are injected at the same level. Learn more on how to define a input variable in your pipeline at [Variables and Secrets - Choreo Pipelines Specification](abc). Follow these steps to define inputs and their values for a given pipeline. |
| 6 | + |
| 7 | +1. Click on **Pipeline Variables & Secrets** at upper right corner of the pipeline page. |
| 8 | +2. A panel will appear on the right side. To add a variable, under **Variables** section, add a new one by providing the Name and Value. The variable name must exactly match the name expected by the pipeline. |
| 9 | +3. If you have a secret to be added as a pipeline input, under **Secrets** section, add a new one by providing the Name and Value. The secret name must exactly match the name expected by the pipeline. |
| 10 | + |
| 11 | +!!! info "Note" |
| 12 | + Once a secret is added, it is securely uploaded to the environment’s configured vault and injected into the pods running the workflow. You will not be able to view the secret value again after it is added. |
| 13 | + |
| 14 | +## Manage existing Pipeline Variables and Secrets |
| 15 | + |
| 16 | +To update or remove a secret, click the three vertical dots in the upper-right corner of the variable box in the Choreo UI. From the menu, choose the appropriate action. |
| 17 | + |
| 18 | +# Run pipeline |
| 19 | + |
| 20 | +Once the pipeline inputs are configured, click **Start New Run** to trigger a workflow run. The run will use the latest version of the pipeline definition along with the configured inputs. |
| 21 | + |
| 22 | +Under the Runs table, a new row will appear displaying a unique **Run ID** for the triggered run. The following details are shown for each pipeline run: |
| 23 | + |
| 24 | +1. **Version** – The version of the pipeline definition. This version is automatically incremented each time the pipeline definition is updated. It helps determine whether the run was triggered after a definition update. |
| 25 | +2. **Status** – The current status of the run: |
| 26 | + - **Successful**: All steps in the pipeline completed successfully. |
| 27 | + - **Failed**: One or more steps in the pipeline failed. |
| 28 | + - **Stopped**: The pipeline was manually stopped. |
| 29 | +3. **Start Time** – The timestamp when the pipeline run was triggered. |
| 30 | +4. **Duration** – The total time taken to execute the pipeline. If the pipeline runs for more than a predefined threshold (e.g., xx minutes), it will be automatically force-stopped by Choreo. |
| 31 | + |
| 32 | + |
| 33 | +# View pipeline logs |
| 34 | + |
| 35 | +Click **View Logs** for a selected pipeline run in the Runs table. This opens a panel on the right, displaying logs for each step of the pipeline. You can close or maximize the log panel using the icons in the upper-right corner of the panel. |
| 36 | + |
| 37 | +!!! info "Note" |
| 38 | + Choreo keeps pipeline logs maximum for 30 days. |
| 39 | + |
| 40 | +# Stop a pipeline run |
| 41 | + |
| 42 | +One a pipeline run is triggered, Click on **View Logs** and then in the log panel that opens to the right, click on **Stop Run**. |
0 commit comments