arno/clair
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

contrib: Improve analyze-local-images docs and launch command.

Browse Source 
Fixes #32
This commit is contained in:
Quentin Machu 2015-11-24 16:37:11 -05:00
parent 9391417b2d
commit 867279a5c9
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
contrib/analyze-local-images/README.md
View File

@ -12,7 +12,7 @@ You need to install this tool:
You also need a working Clair instance, the bare minimal setup is to run Clair in a Docker instance without much configuration:
docker run -it -p 6060:6060 -p 6061:6061 quay.io/coreos/clair --db-path=/db/bolt
docker run -it -v /tmp:/tmp -p 6060:6060 -p 6061:6061 quay.io/coreos/clair --db-path=/db/bolt
You will need to let it do its initial vulnerability update, which may take some time.
@ -30,6 +30,6 @@ Or, If you run Clair remotely (ie. boot2docker),
analyze-local-image -endpoint "http://<CLAIR-IP-ADDRESS>:6060" -my-address "<MY-IP-ADDRESS>" <Docker Image ID>
```
Clair needs access to the image files. If you run Clair locally, it will directly find them in the filesystem. If you run Clair remotely, this tool will run a small HTTP server to let Clair downloading them. It listens on the port 9279 and allows a single host: Clair's IP address, extracted from the `-endpoint` parameter. The `my-address` parameters defines the IP address of the HTTP server that Clair will use to download the images. With boot2docker, these parameters would be `-endpoint "http://192.168.99.100:6060" -my-address "192.168.99.1"`.
Clair needs access to the image files. If you run Clair locally, this tool will store the files in the system's temporary folder and Clair will find them there. It means if Clair is running in Docker, the host's temporary folder must be mounted in the Clair's container. If you run Clair remotely, this tool will run a small HTTP server to let Clair downloading them. It listens on the port 9279 and allows a single host: Clair's IP address, extracted from the `-endpoint` parameter. The `my-address` parameters defines the IP address of the HTTP server that Clair will use to download the images. With boot2docker, these parameters would be `-endpoint "http://192.168.99.100:6060" -my-address "192.168.99.1"`.
As it runs an HTTP server and not an HTTP**S** one, be sure to **not** expose sensitive data and container images.