Spinnaker Pipeline SpEL Expressions

From NovaOrdis Knowledge Base
Revision as of 04:33, 31 May 2023 by Ovidiu (talk | contribs) (→‎Variable)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

External

Internal

Overview

The Spinnaker pipeline expression language is based on Spring Expression Language (SpEL).

The pipeline expressions are resolved by default in Kubernetes manifests specified as text.

Accessing Pipeline Element State

A Tag set by a Trigger

The tag set by a trigger can be accessed with the following expression:

- image: "something/something-else:${trigger['tag']}"

The example above did not work last time I tried it to use it in an artifact specification, but this did:

"helm.com/something/something-else-${execution.trigger.parameters.tag}.tgz"

For an example where this works see: Pipeline parameters.

The Judgment Value set by a Manual Judgment Stage

The value selected by a specific Manual Judgment option can be accessed by subsequent stages with the following expression:

${execution.stages.?[name == '<stage-name>' ][0].context.judgmentInput}

The expression can be used in the "Conditional on Expression" clause of subsequent stages as follows:

${execution.stages.?[name == '<stage-name>' ][0].context.judgmentInput == '<option-value>'}

where stage-name should be replaced with the actual name of the Manual Judgment stage and <option-value> with the actual option value using the same capitalization.

An alternative to get the selected option value is to use the ${#judgment() function. Did not manage to make it work, more experimentation is necessary. For more details see:

https://spinnaker.io/docs/reference/pipeline/expressions/#judgmentstring
${#judgment("<stage-name>")}

The Kind and Name of a Manifest Deployed by a Deployment Stage

${execution.stages.?[name == 'Deploy in Prod'][0].artifacts.reference}

Access an Output Produced by a Run Job (Manifest)

The output name is "replicas":

${ execution.stages.?[ name == 'Script Job' ][0].outputs.replicas }

Displaying Pipeline State at Runtime

TODO

Conditional Expressions

https://spinnaker.io/docs/reference/pipeline/expressions/#comparisons
 ${ execution.stages.?[ name == 'Rollback Decision' ][0].context.judgmentInput == 'Rollback' }

Variable

Pipeline Variables