Using Pipeline Templates on Spinnaker

Enable Pipeline Templates

Mon, 01 Jan 0001 00:00:00 +0000

hal config features edit --pipeline-templates true
hal deploy apply

Create a Pipeline Template

Mon, 01 Jan 0001 00:00:00 +0000

When you create a pipeline template, you start with the underlying JSON of a pipeline that already resembles the template you want. You turn this JSON into template JSON.

1. Get a pipeline’s JSON

Use spin CLI to get the JSON of an existing pipeline that is close to what your template will be. Alternatively, you can create a new pipeline in the model of your intended template.

Install the spin CLI , if you haven’t already done so.

Inherit from a Template or Override It

Mon, 01 Jan 0001 00:00:00 +0000

In a pipeline that instantiates a template, besides providing values for template variables you can…

Inherit features from the template
Override (add to) inherited features.

Inherit from the template

By default, the pipeline instance inherits the stages, expected artifacts, triggers, parameters, and notifications from the template. It’s possible to opt out of inheriting triggers, parameters, and notifications by including the corresponding string in the exclude element.

For example, the template might have a trigger defined in the triggers element, but you can opt out of inheriting it by including triggers inside the exclude element.

Create a Pipeline from a Template

Mon, 01 Jan 0001 00:00:00 +0000

Given a pipeline template that defines variables to be resolved per pipeline, you can create pipelines that reference that template and that provide values for all of those variables.

Instantiate a pipeline

Get the pipeline template.

spin pipeline-template list

This returns a list of all pipeline templates available in the Spinnaker deployment.
From the list, determine which of the listed templates is the one you want, and get it using the following command:

Visualize a Hydrated Pipeline

Mon, 01 Jan 0001 00:00:00 +0000

You can use spin CLI to visualize a pipeline created from a pipeline template without actually instantiating one.

When you do this, you are creating JSON output that looks like regular pipeline JSON (plus the template reference and hydrated variables), but you’re not creating the actual pipeline in Spinnaker.

Using `spin pt plan`

spin pipeline-templates plan --file <path to pipeline config>

{
  "application": "my-spinnaker-app"
  "stages": [...] # Evaluated pipeline config based on template config values.
}

…where <path to pipeline config> points to the file you created when you instantiated a pipeline based on the template.

Using Pipeline Templates on Spinnaker

Enable Pipeline Templates

Create a Pipeline Template

1. Get a pipeline’s JSON

Inherit from a Template or Override It

Inherit from the template

Create a Pipeline from a Template

Instantiate a pipeline

Visualize a Hydrated Pipeline

Using spin pt plan

Using `spin pt plan`