spinnaker.execution.stages.before.manualJudgment
A policy targeting this object runs before executing each task in a manualJudgment stage.
Example Payload
Click to expand
{
"input": {
"pipeline": {
"application": "hostname",
"authentication": {
"allowedAccounts": [
"spinnaker",
"staging",
"staging-ecs"
],
"user": "myUserName"
},
"buildTime": 1620762127532,
"canceled": false,
"canceledBy": null,
"cancellationReason": null,
"description": null,
"endTime": null,
"id": "01F5EF6V1CTYQBD3HBNZXG0CTJ",
"initialConfig": {},
"keepWaitingPipelines": false,
"limitConcurrent": true,
"name": "scale deployments",
"notifications": [],
"origin": "api",
"partition": null,
"paused": null,
"pipelineConfigId": "7db1e350-dedb-4dc1-9976-e71f97b5f132",
"source": null,
"spelEvaluator": "v4",
"stages": [],
"startTime": 1620762127602,
"startTimeExpiry": null,
"status": "RUNNING",
"systemNotifications": [],
"templateVariables": null,
"trigger": {
"artifacts": [
{
"artifactAccount": "myUserName",
"customKind": false,
"location": null,
"metadata": {
"id": "4aa85178-0618-46c4-b530-6883d393656d"
},
"name": "manifests/deploy-spinnaker.yaml",
"provenance": null,
"reference": "Https://api.github.com/repos/myUserName/hostname/contents/manifests/deploy-spinnaker.yaml",
"type": "github/file",
"uuid": null,
"version": "master"
},
{
"artifactAccount": "myUserName",
"customKind": false,
"location": null,
"metadata": {
"id": "e79162ab-69cb-4ff7-acf4-a8f2875ef8ef"
},
"name": "manifests/service-spinnaker.yaml",
"provenance": null,
"reference": "Https://api.github.com/repos/myUserName/hostname/contents/manifests/service-spinnaker.yaml",
"type": "github/file",
"uuid": null,
"version": null
}
],
"correlationId": null,
"isDryRun": false,
"isRebake": false,
"isStrategy": false,
"notifications": [],
"other": {
"artifacts": [
{
"artifactAccount": "myUserName",
"customKind": false,
"metadata": {
"id": "4aa85178-0618-46c4-b530-6883d393656d"
},
"name": "manifests/deploy-spinnaker.yaml",
"reference": "Https://api.github.com/repos/myUserName/hostname/contents/manifests/deploy-spinnaker.yaml",
"type": "github/file",
"version": "master"
},
{
"artifactAccount": "myUserName",
"customKind": false,
"metadata": {
"id": "e79162ab-69cb-4ff7-acf4-a8f2875ef8ef"
},
"name": "manifests/service-spinnaker.yaml",
"reference": "Https://api.github.com/repos/myUserName/hostname/contents/manifests/service-spinnaker.yaml",
"type": "github/file"
}
],
"dryRun": false,
"enabled": false,
"eventId": "ce0c7aa0-7c0e-463e-9074-84a1270a0e78",
"executionId": "01F5EF6V1CTYQBD3HBNZXG0CTJ",
"expectedArtifacts": [
{
"boundArtifact": {
"artifactAccount": "myUserName",
"customKind": false,
"metadata": {
"id": "4aa85178-0618-46c4-b530-6883d393656d"
},
"name": "manifests/deploy-spinnaker.yaml",
"reference": "Https://api.github.com/repos/myUserName/hostname/contents/manifests/deploy-spinnaker.yaml",
"type": "github/file",
"version": "master"
},
"defaultArtifact": {
"artifactAccount": "myUserName",
"customKind": false,
"metadata": {
"id": "4aa85178-0618-46c4-b530-6883d393656d"
},
"name": "manifests/deploy-spinnaker.yaml",
"reference": "Https://api.github.com/repos/myUserName/hostname/contents/manifests/deploy-spinnaker.yaml",
"type": "github/file",
"version": "master"
},
"id": "0cf98032-1b0f-48db-9314-09c69293b3a6",
"matchArtifact": {
"artifactAccount": "myUserName",
"customKind": true,
"metadata": {
"id": "3f72ed8e-cb95-454f-9119-2323682121ff"
},
"name": "manifests/deploy-spinnaker.yaml",
"type": "github/file"
},
"useDefaultArtifact": true,
"usePriorArtifact": false
},
{
"boundArtifact": {
"artifactAccount": "myUserName",
"customKind": false,
"metadata": {
"id": "e79162ab-69cb-4ff7-acf4-a8f2875ef8ef"
},
"name": "manifests/service-spinnaker.yaml",
"reference": "Https://api.github.com/repos/myUserName/hostname/contents/manifests/service-spinnaker.yaml",
"type": "github/file"
},
"defaultArtifact": {
"artifactAccount": "myUserName",
"customKind": false,
"metadata": {
"id": "e79162ab-69cb-4ff7-acf4-a8f2875ef8ef"
},
"name": "manifests/service-spinnaker.yaml",
"reference": "Https://api.github.com/repos/myUserName/hostname/contents/manifests/service-spinnaker.yaml",
"type": "github/file"
},
"id": "425d20a8-2942-4902-8d2b-277769a1492c",
"matchArtifact": {
"artifactAccount": "myUserName",
"customKind": true,
"metadata": {
"id": "d7ac7eca-0131-4d54-ab8f-880ff0041e4f"
},
"name": "manifests/service-spinnaker",
"type": "github/file"
},
"useDefaultArtifact": true,
"usePriorArtifact": false
}
],
"notifications": [],
"parameters": {
"namespace": "staging",
"replicas": "2"
},
"preferred": false,
"rebake": false,
"resolvedExpectedArtifacts": [
{
"boundArtifact": {
"artifactAccount": "myUserName",
"customKind": false,
"metadata": {
"id": "4aa85178-0618-46c4-b530-6883d393656d"
},
"name": "manifests/deploy-spinnaker.yaml",
"reference": "Https://api.github.com/repos/myUserName/hostname/contents/manifests/deploy-spinnaker.yaml",
"type": "github/file",
"version": "master"
},
"defaultArtifact": {
"artifactAccount": "myUserName",
"customKind": false,
"metadata": {
"id": "4aa85178-0618-46c4-b530-6883d393656d"
},
"name": "manifests/deploy-spinnaker.yaml",
"reference": "Https://api.github.com/repos/myUserName/hostname/contents/manifests/deploy-spinnaker.yaml",
"type": "github/file",
"version": "master"
},
"id": "0cf98032-1b0f-48db-9314-09c69293b3a6",
"matchArtifact": {
"artifactAccount": "myUserName",
"customKind": true,
"metadata": {
"id": "3f72ed8e-cb95-454f-9119-2323682121ff"
},
"name": "manifests/deploy-spinnaker.yaml",
"type": "github/file"
},
"useDefaultArtifact": true,
"usePriorArtifact": false
},
{
"boundArtifact": {
"artifactAccount": "myUserName",
"customKind": false,
"metadata": {
"id": "e79162ab-69cb-4ff7-acf4-a8f2875ef8ef"
},
"name": "manifests/service-spinnaker.yaml",
"reference": "Https://api.github.com/repos/myUserName/hostname/contents/manifests/service-spinnaker.yaml",
"type": "github/file"
},
"defaultArtifact": {
"artifactAccount": "myUserName",
"customKind": false,
"metadata": {
"id": "e79162ab-69cb-4ff7-acf4-a8f2875ef8ef"
},
"name": "manifests/service-spinnaker.yaml",
"reference": "Https://api.github.com/repos/myUserName/hostname/contents/manifests/service-spinnaker.yaml",
"type": "github/file"
},
"id": "425d20a8-2942-4902-8d2b-277769a1492c",
"matchArtifact": {
"artifactAccount": "myUserName",
"customKind": true,
"metadata": {
"id": "d7ac7eca-0131-4d54-ab8f-880ff0041e4f"
},
"name": "manifests/service-spinnaker",
"type": "github/file"
},
"useDefaultArtifact": true,
"usePriorArtifact": false
}
],
"strategy": false,
"type": "manual",
"user": "myUserName"
},
"parameters": {
"namespace": "staging",
"replicas": "2"
},
"resolvedExpectedArtifacts": [
{
"boundArtifact": {
"artifactAccount": "myUserName",
"customKind": false,
"location": null,
"metadata": {
"id": "4aa85178-0618-46c4-b530-6883d393656d"
},
"name": "manifests/deploy-spinnaker.yaml",
"provenance": null,
"reference": "Https://api.github.com/repos/myUserName/hostname/contents/manifests/deploy-spinnaker.yaml",
"type": "github/file",
"uuid": null,
"version": "master"
},
"defaultArtifact": {
"artifactAccount": "myUserName",
"customKind": false,
"location": null,
"metadata": {
"id": "4aa85178-0618-46c4-b530-6883d393656d"
},
"name": "manifests/deploy-spinnaker.yaml",
"provenance": null,
"reference": "Https://api.github.com/repos/myUserName/hostname/contents/manifests/deploy-spinnaker.yaml",
"type": "github/file",
"uuid": null,
"version": "master"
},
"id": "0cf98032-1b0f-48db-9314-09c69293b3a6",
"matchArtifact": {
"artifactAccount": "myUserName",
"customKind": true,
"location": null,
"metadata": {
"id": "3f72ed8e-cb95-454f-9119-2323682121ff"
},
"name": "manifests/deploy-spinnaker.yaml",
"provenance": null,
"reference": null,
"type": "github/file",
"uuid": null,
"version": null
},
"useDefaultArtifact": true,
"usePriorArtifact": false
},
{
"boundArtifact": {
"artifactAccount": "myUserName",
"customKind": false,
"location": null,
"metadata": {
"id": "e79162ab-69cb-4ff7-acf4-a8f2875ef8ef"
},
"name": "manifests/service-spinnaker.yaml",
"provenance": null,
"reference": "Https://api.github.com/repos/myUserName/hostname/contents/manifests/service-spinnaker.yaml",
"type": "github/file",
"uuid": null,
"version": null
},
"defaultArtifact": {
"artifactAccount": "myUserName",
"customKind": false,
"location": null,
"metadata": {
"id": "e79162ab-69cb-4ff7-acf4-a8f2875ef8ef"
},
"name": "manifests/service-spinnaker.yaml",
"provenance": null,
"reference": "Https://api.github.com/repos/myUserName/hostname/contents/manifests/service-spinnaker.yaml",
"type": "github/file",
"uuid": null,
"version": null
},
"id": "425d20a8-2942-4902-8d2b-277769a1492c",
"matchArtifact": {
"artifactAccount": "myUserName",
"customKind": true,
"location": null,
"metadata": {
"id": "d7ac7eca-0131-4d54-ab8f-880ff0041e4f"
},
"name": "manifests/service-spinnaker",
"provenance": null,
"reference": null,
"type": "github/file",
"uuid": null,
"version": null
},
"useDefaultArtifact": true,
"usePriorArtifact": false
}
],
"type": "manual",
"user": "myUserName"
},
"type": "PIPELINE"
},
"stage": {
"context": {
"completeOtherBranchesThenFail": false,
"continuePipeline": true,
"failPipeline": false,
"instructions": "is the new service working?",
"judgmentInputs": [],
"judgmentStatus": "continue",
"lastModifiedBy": "myUserName",
"notifications": [],
"stageTimeoutMs": 60000
},
"endTime": null,
"id": "01F5EF6V5C94PAJ0JPEDAGV18W",
"lastModified": {
"allowedAccounts": [
"spinnaker",
"staging",
"staging-ecs"
],
"lastModifiedTime": 1620762143342,
"user": "myUserName"
},
"name": "Manual Judgment",
"outputs": {},
"parentStageId": null,
"refId": "4",
"requisiteStageRefIds": [
"2",
"3"
],
"scheduledTime": null,
"startTime": 1620762136521,
"startTimeExpiry": null,
"status": "RUNNING",
"syntheticStageOwner": null,
"tasks": [
{
"endTime": null,
"id": "1",
"implementingClass": "com.netflix.spinnaker.orca.echo.pipeline.ManualJudgmentStage.WaitForManualJudgmentTask",
"loopEnd": false,
"loopStart": false,
"name": "waitForJudgment",
"stageEnd": true,
"stageStart": true,
"startTime": 1620762136595,
"status": "RUNNING"
}
],
"type": "manualJudgment"
},
"user": {
"isAdmin": false,
"roles": [],
"username": "myUserName"
}
}
}
Example Policy
This example policy prevents execution of any manual judgement stage that can be approved by multiple roles, or for which the approving role is not on a whitelist of approving roles.
package spinnaker.execution.stages.before.manualJudgment
approving_roles=["infosec","qa"]
deny["Manual Judgement stages must restrict approval to exactly 1 role."]{
count(input.stage.context.selectedStageRoles)!=1
}
deny["Manual Judgement stages may only approved by the following roles: qa, infosec."]{
count(input.stage.context.selectedStageRoles)==1
not isApprovedRole(input.stage.context.selectedStageRoles[0])
}
isApprovedRole(role){
approving_roles[_]==role
}
Keys
Parameters related to the stage against which the policy is executing can be found in the input.stage.context object.
input.pipeline
| Key | Type | Description |
|---|---|---|
input.pipeline.application | string | The name of the Spinnaker application to which this pipeline belongs. |
input.pipeline.authentication.allowedAccounts[] | string | The list of accounts to which the user this stage runs as has access. |
input.pipeline.authentication.user | string | The Spinnaker user initiating the change. |
input.pipeline.buildTime | number | |
input.pipeline.canceled | boolean | |
input.pipeline.canceledBy | ||
input.pipeline.cancellationReason | ||
input.pipeline.description | string | Description of the pipeline defined in the UI. |
input.pipeline.endTime | ||
input.pipeline.id | string | The unique ID of the pipeline. |
input.pipeline.keepWaitingPipelines | boolean | If false and concurrent pipeline execution is disabled, then the pipelines in the waiting queue gets canceled when the next execution starts. |
input.pipeline.limitConcurrent | boolean | True if only 1 concurrent execution of this pipeline is allowed. |
input.pipeline.name | string | The name of this pipeline. |
input.pipeline.origin | string | |
input.pipeline.partition | ||
input.pipeline.paused | ||
input.pipeline.pipelineConfigId | string | |
input.pipeline.source | ||
input.pipeline.spelEvaluator | string | Which version of spring expression language is being used to evaluate SpEL. |
input.pipeline.stages[] | [array] | An array of the stages in the pipeline. Typically if you are writing a policy that examines multiple pipeline stages, it is better to write that policy against either the opa.pipelines package, or the spinnaker.execution.pipelines.before package. |
input.pipeline.startTime | number | Timestamp from when the pipeline was started. |
input.pipeline.startTimeExpiry | date | Unix epoch date at which the pipeline expires. |
input.pipeline.status | string | |
input.pipeline.templateVariables |
input.pipeline.trigger
See input.pipeline.trigger for more information.
input.stage
See input.stage for more information.
input.stage.context
| Key | Type | Description |
|---|---|---|
input.stage.context.completeOtherBranchesThenFail | boolean | |
input.stage.context.continuePipeline | boolean | |
input.stage.context.failPipeline | boolean | |
input.stage.context.instructions | string | Instructions are shown to the user when making a manual judgment. |
input.stage.context.judgmentStatus | string | |
input.stage.context.lastModifiedBy | string | Once completed, this is the ID of the user that approved the judgement. |
input.stage.context.selectedStageRoles[] | string | The list of roles that are permitted to approve the manual judgement. |
input.stage.context.stageTimeoutMs | number | Allows forcing the stage to fail if its not approved within a certain time. |
input.user
This object provides information about the user performing the action. This can be used to restrict actions by role. See input.user for more information.
Feedback
Was this page helpful?
Thank you for letting us know!
Sorry to hear that. Please tell us how we can improve.
Last modified August 18, 2023: (02b163b7)