Skip to main content

Create a step template

The Harness Template Library enables you to standardize and create step templates that can be re-used across pipelines and teams that use Harness.

This topic walks you through the steps to create a Run step template.

Objectives

You'll learn how to: 

  • Create a Run step template.
  • Define template parameters.
  • Use the run step template in a pipeline.

Before you begin

Step 1: Create a template

First, we'll create a project-level template in the Builds module. You can do this in any project.

To create a project-level template, do the following:

  1. In Harness, navigate to the Builds module.

  2. In Projects, select the desired project.

  3. Select Templates under Project Setup.

  4. Select New Template.

  5. Select Step to create a step template.

    The Create New Step Template settings appear.

  6. In Name, enter a name for the template, for example Quickstart.

  7. In Version Label, enter a name for the version of the template, for example V1.

  8. Select Save. The Step Library panel opens.

Step 2: Add step parameters

To add step parameters, do the following:

  1. Follow the steps above to create a template.

  2. In Step Library, select Run under Build.

    The Step Parameters settings appear.

  3. Select Container Registry, and then select Runtime input, which lets you add values when you start a pipeline execution.

  4. In Image, select Runtime input. You can use any Docker image from any Docker registry, including private registries.

  5. In Command, select Runtime input.

  6. Select Save. The new template appears under the Templates list.

    Use Runtime Inputs instead of variable expressions: when you want to template settings in a Stage or step template, use Runtime inputs instead of variable expressions. When Harness tries to resolve variable expressions to specific stage-level settings using fully-qualified names, it can cause issues at runtime. Every pipeline where the stage or step template is inserted must utilize the exact same names for fully-qualified name references to operate. With runtime inputs, you can supply values for a setting at deployment runtime.

Step 3: Add the run step template to a pipeline

To add the run step template to a pipeline, do the following:

  1. Follow the steps above to create a template.

  2. Go to your pipeline, and then select Add Step.

    The Step Library panel opens.

  3. In Step Library, select Run under Build. The Configure Run Step settings appear.

  4. Select Use Template. The next page lists all the project-level templates.

  5. Select the template that you created.

  6. Select the Activity Log to track all template events. It shows you details like who created the template and template version changes.

  7. In Details, from the Version Label list, select Always use the stable version. This ensures that any changes that you make to this version are propagated automatically to the pipelines using this template.

  8. Select Use Template.

  9. In Container Registry, select Runtime input.

  10. In Image, select Runtime input.

  11. In Command, select Runtime input.

  12. Select Apply Changes.

  13. Click Save.