Skip to content
This repository has been archived by the owner on Jul 10, 2021. It is now read-only.

Commit

Permalink
feat(md): veto docs
Browse files Browse the repository at this point in the history
  • Loading branch information
emjburns committed Apr 29, 2020
1 parent 3d50c12 commit 5e398ca
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 3 deletions.
2 changes: 2 additions & 0 deletions _data/navigation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -462,6 +462,8 @@ guides:
url: /guides/user/managed-delivery/artifacts/
- title: Pinning an Environment
url: /guides/user/managed-delivery/pinning/
- title: Vetoing an Artifact
url: /guides/user/managed-delivery/vetoing/
- title: Resource Status
url: /guides/user/managed-delivery/resource-status/
- title: API
Expand Down
4 changes: 1 addition & 3 deletions guides/user/managed-delivery/pinning/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Until the pin is removed, that environment won't change to a new version of the

### Pinning via the API

To create a pin via the API you'll need the application name, the name of the environment you want to pin, the reference for your artifact (defined in your delivery config, defaulted to the artifact name), the type of the artifact, and the version you'd like to pin to.
To create a pin via the API you'll need the application name, the name of the environment you want to pin, the reference for your artifact (defined in your delivery config, defaulted to the artifact name), and the version you'd like to pin to.
The request needs to have a body that contains [this information](https://github.com/spinnaker/gate/blob/master/gate-core/src/main/groovy/com/netflix/spinnaker/gate/model/manageddelivery/EnvironmentArtifactPin.java).
Here's an example:

Expand All @@ -25,7 +25,6 @@ with body:
{
"targetEnvironment": "test",
"reference" : "my-artifact",
"type" : "docker",
"version" : "master-h10.62bbbd6"
}
```
Expand All @@ -50,7 +49,6 @@ with body:
{
"targetEnvironment": "test",
"reference" : "my-artifact",
"type" : "docker",
"version" : "master-h10.62bbbd6"
}
```
Expand Down
29 changes: 29 additions & 0 deletions guides/user/managed-delivery/vetoing/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
layout: single
title: "Vetoing a Version"
sidebar:
nav: guides
---

{% include toc %}

You can veto a version in an environment to ensure that that version never gets deploy to the environment.
If you veto an artifact in the first in a series of environments (linked together by `depends-on` constraints) the vetoed artifact will never be promoted into the later environments.

### Vetoing via the API

To veto via the API you'll need the application name, the name of the environment, the reference for your artifact (defined in your delivery config, defaulted to the artifact name), and the version you'd like to veto.
The request needs to have a body that contains [this information](https://github.com/spinnaker/gate/blob/master/gate-core/src/main/groovy/com/netflix/spinnaker/gate/model/manageddelivery/EnvironmentArtifactVeto.java).
Here's an example:

`POST /managed/application/{application}/veto`

with body:
```json

{
"targetEnvironment": "test",
"reference" : "my-artifact",
"version" : "master-h10.62bbbd6"
}
```

0 comments on commit 5e398ca

Please sign in to comment.