Create a remote stage template
Currently, this feature is behind the feature flag
NG_TEMPLATE_GITX. Contact Harness Support to enable the feature. Harness enables you to add templates to create re-usable logic and Harness entities (like steps, stages, and pipelines) in your pipelines. You can link these templates in your pipelines or share them with your teams for improved efficiency.
Templates enhance developer productivity, reduce onboarding time, and enforce standardization across the teams that use Harness.
You can create a Template and save it either in Harness or in a Git repository using the Inline or Remote option respectively.
This topic walks you through the steps to create a Remote Stage Template.
You will learn how to:
- Create a Remote Stage Template
- Define Template parameters.
Before you begin
- Review Harness key concepts
- See Templates overview
- See CI quickstarts
To create a Remote Stage Template make sure you have Create/Edit and Access permissions for Templates.
Remote stage template overview
A Stage Template is a Harness CD, CI, or Approval Stage Template that can be used in any Pipeline in any Project. Harness lets you create Stage Templates that you can use when creating a new Pipeline or adding a stage to your existing one.
All your templates can be seen in Templates based on their scope. We will also call this Template Library in this topic.
A Remote Stage Template is one which you save in your Git repositories.
For information on inline stage template, go to create a stage template
Use template in a pipeline
Harness resolves the repositories when your pipeline starts up. After that, the same resource is used during the execution of the pipeline. Whenever you use the templates in your pipelines, once the templates are fully expanded, the final pipeline runs as if it were defined entirely in the source repo.
You can have one of the following scenarios when using a template in your pipeline:
- Remote stage template and the pipeline exist in the same Git repo.
- Remote stage template and the pipeline exist in different Git repos.
- Pipeline exists in Harness and the stage template exists in Git repo.
Let us see how you can use template in each of these situations.
Remote stage template and the pipeline exist in the same Git repo
In order to use the Template in your Pipeline if your remote stage template and pipeline are both present in the same Git repository, make sure your pipeline and template are both present in the same branch.
Remote stage template and the pipeline exist in different Git repos
In order to use the template in your pipeline if your remote stage template and Pipeline are present in different Git repositories, make sure your template is present in the default branch of the specific repo.
Pipeline exists in Harness and the stage template exists in Git repo
In order to use the template in your inline pipeline, make sure your Template is present in the default branch of your Git repository.
Create a remote stage template
You can create a stage template from your account, org or project. This topic explains the steps to create a stage template from the project scope.
In your Harness account, go to your project.
In Project SETUP select Templates.
Select New Template and then select Stage. The Create New Stage Template settings appear.
In Name, enter a name for the template.
In Version Label, enter a version for the template.
In Git Connector, select or create a Git connector to the repo for your project. For steps, go to code repo connectors.info
Connector must use the Enable API access option and token. The Connector must use the Enable API access option and Username and Token authentication. Harness requires the token for API access. Generate the token in your account on the Git provider and add it to Harness as a Secret. Next, use the token in the credentials for the Git Connector.
For GitHub, the token must have the following scopes:
In Repository, select your repository. If your repository isn't listed, enter its name since only a select few repositories are filled here.Create the repository in Git before entering it in Select Repository. Harness does not create the repository for you.
In Git Branch, select your branch. If your branch isn't listed, enter its name since only a select few branches are filled here.Create the branch in your repository before entering it in Git Branch. Harness does not create the branch for you.
Harness auto-populates the YAML Path. You can change this path and the file name.
Your stage template is created and the select stage type settings appear.
Add the stage parameters
- Select Deploy in the Select Stage Type settings.
The Deploy stage type is a CD Stage that enables you to deploy any service to your target environment.
The About your Stage settings appear.
Select the type of deployment this Stage must perform.
A stage can deploy Services, and other workloads. The default selection is Service.
Select Set Up Stage. The Template Studio page appears.
In Select Service, select an existing service or add a new one. Select Continue.
In Specify Environment, select an existing environment or add a new one.
In Specify Infrastructure, select an existing infrastructure or add a new one. Select Continue.
In Execution Strategies, select Rolling and select Use Strategy.
In Execution, you can see the Rollout Deployment step is added automatically.
Select Save. The Save Template to Git settings appear.
In Select Branch to Commit, You can select one of the following:
- Commit to an existing branch: you can start a pull request if you like.
- Commit to a new branch: enter the new branch name. You can start a pull request if you like.
Select Save. Your remote stage template is saved to the repo branch.
Click the YAML file to see the YAML for the Stage Template.
Edit the YAML. For example, change the name of the Template.
Commit your changes to Git.
Return to Harness and refresh the page.
A Template Updated message appears.