Skip to main content

Reconcile pipeline template changes

APIs detect changes in Harness pipeline templates that require reconciliation. This topic explains how to view referenced entity changes detected in your pipeline templates and reconcile them.

For example, let's say you have a pipeline template with an environment in a CD stage. You must reconcile the change if you update the environment via the Environment tab and not via the Pipeline Studio in the UI.

How Harness detects changes​

Harness APIs detect pipeline template changes that require reconciliation. Harness warns you in the UI when a pipeline references a template with updated entities you must reconcile.

Harness calls the Validate template inputs API GET https://app.harness.io/pipeline/api/refresh-template/validate-template-inputs when you select the Reconcile option in the Pipeline Studio. For more information, go to Validate template inputs in the API documentation.

When you save pipeline changes, the Validate pipeline API POST https://app.harness.io/pipeline/api/pipelines/{pipelineIdentifier}/validate starts an asynchronous pipeline validation. The same flow is also executed when you view a pipeline (by making a GET call from the Pipelines list page). The YAML is fetched from the cache, so the results may not be the latest.

Harness fetches the response of the validation event from the Get Pipeline validation event data API GET https://app.harness.io/pipeline/api/pipelines/validate/{uuid}. This API includes the information to determine whether reconciliation is required.

How Harness gets the latest pipeline YAML​

Harness calls the refreshed YAML API POST https://app.harness.io/template/api/refresh-template/refreshed-yaml when you select the Reconcile option in the Pipeline Studio. This API gets the latest pipeline YAML. Harness shows the differences between the original and the refreshed YAML in the UI on the Template Error Inspection page.

Resolve conflicts in the pipeline YAML​

Harness warns you when a pipeline references a template that needs to be reconciled when you change it.

To resolve conflicts in the pipeline YAML, do the following:

  1. In the Pipeline Studio, select Reconcile. The Template Error Inspection page opens.

    You can view the Git YAML differences for the pipeline and see which lines have been modified. The differences are calculated based on the data, not exact string matches. Therefore, a different quote symbol, such as, " versus ' for the same value might not be recognized as a difference. This is not an issue or error.

  2. Update the YAML with the required changes.

  3. Select Save. Harness reconciles the change, making it the default state.

    Harness calls the update pipeline API PUT https://app.harness.io/pipeline/api/pipelines/{pipelineIdentifier}, and saves the updated YAML.