Skip to content
This repository has been archived by the owner on Sep 21, 2023. It is now read-only.

Add QSS webhook notification section w/ anchor #61

Open
wants to merge 4 commits into
base: gh-pages
Choose a base branch
from
Open

Add QSS webhook notification section w/ anchor #61

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
50f6dea
Add Clair webhook notification section w/ anchor
Sep 29, 2016
246883b
Fixed swagger link in the API
Sep 29, 2016
7a36a21
Replace json and subheading.
Sep 29, 2016
7a5e18f
Add periods to notification descriptions & notes.
Sep 29, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions guides/notifications.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,25 @@ A Dockerfile build has failed
}
```

#### <i class="fa fa-lg fa-times-circle-o event-icon"></i>Vulnerability Found
<a name="#vulnerability_found"></a>

Clair has discovered a new vulnerability
Copy link
Contributor

@josephschorr josephschorr Sep 29, 2016 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, this should be "Quay Security Scanner has discovered a new vulnerability or an existing vulnerability was updated to a higher severity"


<a name="#webhook_vulnerability_found"></a>

Note: Clair webhook notifications report the UUID of the affected build. Use the <a href=http://docs.quay.io/api/swagger>API</a> to analyze notifications for the build.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Clair -> Quay


```json
{
"Notification": {
"Name": "6e4ad270-4957-4242-b5ad-dad851379573"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The JSON for the QSS notification has this format:

{
  "tags": ["latest", "prod"],
  "image": "the-image-id",
  "vulnerability": {
    "id": "CVE-1234-ID", 
    "description": "Heartbleed 2: Coronary Boogaloo",
    "link": "http://link/to/vuln/info",
    "priority": "Critical",
    "has_fix": true
  }
}

}
}
```



### Notification Actions

#### <img class="method-icon" src="https://quay.io/static/img/favicon.ico" style="width: 22px; height: 22px;">Quay.io Notification
Expand Down