Skip to content

Commit 4815cb0

Browse files
committed
clair
1 parent c0f08c3 commit 4815cb0

File tree

2 files changed

+48
-0
lines changed

2 files changed

+48
-0
lines changed

incubator/clair/README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Codefresh Clair Plugin
2+
3+
Clair is an open source Docker Image securitu scanning server. For more information see here: https://github.com/coreos/clair/
4+
5+
There's an open source CLI tool for clair, called 'klar' that you can use to integrate secrurity scan into your pipeline. More info on klar: https://github.com/optiopay/klar
6+
7+
## Usage
8+
9+
Set environment variables described below, and run the command with the given image to scan:
10+
11+
```yaml
12+
scan:
13+
image: 'codefresh/klar:master'
14+
commands:
15+
- /klar codefresh/helm:2.8.1
16+
```
17+
18+
(in this example we are scanning the helm image tagged 2.8.1 under codefresh organization in Docker Hub)
19+
20+
## Environment Variables
21+
22+
The minimal setup is described below. Please see Klar documentation for additional configuration.
23+
24+
Name|Required|Description
25+
---|---|---
26+
CLAIR_ADDR|Yes|The address of the clair server
27+
DOCKER_USER|No|Docker registry account name
28+
DOCKER_PASSWORD|No|Docker registry account password
29+

incubator/clair/plugin.yaml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
image: codefresh/klar:master
2+
version: 1.0.0
3+
description: Scan an image with Clair
4+
keywords:
5+
- clair
6+
home: https://github.com/codefresh-io/pugins/tree/master/incubator/clair
7+
sources:
8+
- https://github.com/optiopay/klar
9+
envs:
10+
- name: CLAIR_ADDR
11+
type: required
12+
description: The address of the clair server
13+
- name: DOCKER_USER
14+
type: required
15+
description: Docker registry account name.
16+
- name: DOCKER_PASSWORD
17+
description: Docker registry account password.
18+
context:
19+
- kind: Clair

0 commit comments

Comments
 (0)