UNCLASSIFIED

README.md 1.16 KB
Newer Older
sean.melissari's avatar
sean.melissari committed
1
# Clair
sean.melissari's avatar
sean.melissari committed
2

sean.melissari's avatar
sean.melissari committed
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
![Clair Logo](https://cloud.githubusercontent.com/assets/343539/21630811/c5081e5c-d202-11e6-92eb-919d5999c77a.png)

Clair is an open source project for the static analysis of vulnerabilities in application containers (currently including appc and docker).

1. In regular intervals, Clair ingests vulnerability metadata from a configured set of sources and stores it in the database.
2. Clients use the Clair API to index their container images; this creates a list of _features_ present in the image and stores them in the database.
3. Clients use the Clair API to query the database for vulnerabilities of a particular image; correlating vulnerabilities and features is done for each request, avoiding the need to rescan images.
4. When updates to vulnerability metadata occur, a notification can be sent to alert systems that a change has occurred.

Our goal is to enable a more transparent view of the security of container-based infrastructure.
Thus, the project was named `Clair` after the French term which translates to *clear*, *bright*, *transparent*.

## Documentation

To learn more about Clair [go to the complete documentation](https://coreos.com/clair/docs/latest/).