spinnaker.execution.stages.before.undoRolloutManifest

A policy targeting this object runs before executing each task in a undoRolloutManifest stage.

See Deploy Applications to Kubernetes for more information on this stage.

Example Payload

Click to expand

{
  "input": {
    "pipeline": {
      "application": "hostname",
      "authentication": {
        "allowedAccounts": [
          "spinnaker",
          "staging",
          "staging-ecs"
        ],
        "user": "myUserName"
      },
      "buildTime": 1620752523096,
      "canceled": false,
      "canceledBy": null,
      "cancellationReason": null,
      "description": "Undo rollout of manifest",
      "endTime": null,
      "id": "01F5E61QTRW9H5TPZSAK4D2WCV",
      "initialConfig": {},
      "keepWaitingPipelines": false,
      "limitConcurrent": false,
      "name": null,
      "notifications": [],
      "origin": "unknown",
      "partition": null,
      "paused": null,
      "pipelineConfigId": null,
      "source": null,
      "spelEvaluator": null,
      "stages": [
        "01F5E61QTRMYD2PV6Z5YHXXE4D"
      ],
      "startTime": 1620752523145,
      "startTimeExpiry": null,
      "status": "RUNNING",
      "systemNotifications": [],
      "templateVariables": null,
      "trigger": {
        "artifacts": [],
        "correlationId": null,
        "isDryRun": false,
        "isRebake": false,
        "isStrategy": false,
        "notifications": [],
        "other": {
          "artifacts": [],
          "dryRun": false,
          "expectedArtifacts": [],
          "notifications": [],
          "parameters": {},
          "rebake": false,
          "resolvedExpectedArtifacts": [],
          "strategy": false,
          "type": "manual",
          "user": "myUserName"
        },
        "parameters": {},
        "resolvedExpectedArtifacts": [],
        "type": "manual",
        "user": "myUserName"
      },
      "type": "ORCHESTRATION"
    },
    "stage": {
      "context": {
        "account": "spinnaker",
        "cloudProvider": "kubernetes",
        "deploy.server.groups": {},
        "failedManifests": [],
        "kato.last.task.id": {
          "id": "7891099a-c0da-4e1b-b14a-89592343293b"
        },
        "kato.result.expected": false,
        "kato.task.firstNotFoundRetry": -1,
        "kato.task.lastStatus": "SUCCEEDED",
        "kato.task.notFoundRetryCount": 0,
        "kato.task.terminalRetryCount": 0,
        "kato.tasks": [
          {
            "history": [
              {
                "phase": "ORCHESTRATION",
                "status": "Initializing Orchestration Task"
              },
              {
                "phase": "ORCHESTRATION",
                "status": "Processing op: KubernetesUndoRolloutManifestOperation"
              },
              {
                "phase": "UNDO_ROLLOUT_KUBERNETES_MANIFEST",
                "status": "Starting undo rollout operation..."
              },
              {
                "phase": "UNDO_ROLLOUT_KUBERNETES_MANIFEST",
                "status": "Looking up resource properties..."
              },
              {
                "phase": "UNDO_ROLLOUT_KUBERNETES_MANIFEST",
                "status": "Calling undo rollout operation..."
              },
              {
                "phase": "ORCHESTRATION",
                "status": "Orchestration completed."
              }
            ],
            "id": "7891099a-c0da-4e1b-b14a-89592343293b",
            "resultObjects": [],
            "status": {
              "completed": true,
              "failed": false,
              "retryable": false
            }
          }
        ],
        "location": "staging",
        "manifest.account.name": "spinnaker",
        "manifest.location": "staging",
        "manifest.name": "deployment hostname",
        "manifestName": "deployment hostname",
        "messages": [
          "'deployment hostname' in 'staging' for account spinnaker: waiting for manifest to stabilize"
        ],
        "outputs.manifestNamesByNamespace": {
          "staging": [
            "deployment hostname"
          ]
        },
        "reason": "someReason",
        "revision": "3",
        "stableManifests": [],
        "user": "myUserName"
      },
      "endTime": null,
      "id": "01F5E61QTRMYD2PV6Z5YHXXE4D",
      "lastModified": null,
      "name": "undoRolloutManifest",
      "outputs": {},
      "parentStageId": null,
      "refId": "0",
      "requisiteStageRefIds": [],
      "scheduledTime": null,
      "startTime": 1620752523160,
      "startTimeExpiry": null,
      "status": "RUNNING",
      "syntheticStageOwner": null,
      "tasks": [
        {
          "endTime": 1620752523449,
          "id": "1",
          "implementingClass": "com.netflix.spinnaker.orca.clouddriver.tasks.manifest.UndoRolloutManifestTask",
          "loopEnd": false,
          "loopStart": false,
          "name": "undoRolloutManifest",
          "stageEnd": false,
          "stageStart": true,
          "startTime": 1620752523216,
          "status": "SUCCEEDED"
        },
        {
          "endTime": 1620752528687,
          "id": "2",
          "implementingClass": "com.netflix.spinnaker.orca.clouddriver.tasks.MonitorKatoTask",
          "loopEnd": false,
          "loopStart": false,
          "name": "monitorUndoRollout",
          "stageEnd": false,
          "stageStart": false,
          "startTime": 1620752523464,
          "status": "SUCCEEDED"
        },
        {
          "endTime": null,
          "id": "3",
          "implementingClass": "com.netflix.spinnaker.orca.clouddriver.tasks.manifest.WaitForManifestStableTask",
          "loopEnd": false,
          "loopStart": false,
          "name": "waitForManifestToStabilize",
          "stageEnd": true,
          "stageStart": false,
          "startTime": 1620752528755,
          "status": "RUNNING"
        }
      ],
      "type": "undoRolloutManifest"
    },
    "user": {
      "isAdmin": false,
      "roles": [],
      "username": "myUserName"
    }
  }
}

Example Policy

Requires a reason to be provided for any rollback.

package spinnaker.http.authz
default message=""
allow = message==""

message = "A reason must be provided when rolling back a deploy."{
      createsTaskOfType("undoRolloutManifest")
      count(input.body.job[_].reason)==0
}
createsTaskOfType(tasktype){
    input.method="POST"
    input.path=["tasks"]
    input.body.job[_].type=tasktype
}

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.canceledBy`
`input.pipeline.canceled`	`boolean`
`input.pipeline.cancellationReason`
`input.pipeline.description`	`string`	Description of the pipeline defined in the UI.
`input.pipeline.endTime`	`number`
`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.startTimeExpiry`	`date`	Unix epoch date at which the pipeline expires.
`input.pipeline.startTime`	`number`	Timestamp from when the pipeline was started.
`input.pipeline.status`	`string`
`input.pipeline.templateVariables`
`input.pipeline.type`	`string`

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.account`	`string`	The account containing the manifest.
`input.stage.context.cloudProvider`	`string`	The name of the cloud provider that executes the stage.
`input.stage.context.kato.last.task.id.id`	`string`
`input.stage.context.kato.result.expected`	`boolean`
`input.stage.context.kato.task.firstNotFoundRetry`	`number`
`input.stage.context.kato.task.lastStatus`	`string`
`input.stage.context.kato.task.notFoundRetryCount`	`number`
`input.stage.context.kato.task.terminalRetryCount`	`number`
`input.stage.context.kato.tasks[].history[].phase`	`string`
`input.stage.context.kato.tasks[].history[].status`	`string`
`input.stage.context.kato.tasks[].id`	`string`
`input.stage.context.kato.tasks[].status.completed`	`boolean`
`input.stage.context.kato.tasks[].status.failed`	`boolean`
`input.stage.context.kato.tasks[].status.retryable`	`boolean`
`input.stage.context.location`	`string`
`input.stage.context.manifest.account.name`	`string`	The account containing the manifest.
`input.stage.context.manifest.location`	`string`	The namespace containing the manifest.
`input.stage.context.manifest.name`	`string`	The kind and name of the manifest.
`input.stage.context.manifestName`	`string`	The kind and name of the manifest.
`input.stage.context.messages[]`	`string`
`input.stage.context.mode`	`string`
`input.stage.context.numRevisionsBack`	`number`	The number of revisions to roll back.
`input.stage.context.outputs.manifestNamesByNamespace.<namespace>[]`	`string`	A list of output manifests in the specified namespace.
`input.stage.context.reason`	`string`	The reason for the rollback.
`input.stage.context.revision`	`string`	The revision to rollback to.
`input.stage.context.user`	`string`

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)