diff --git a/cmd/clairctl/README.md b/cmd/clairctl/README.md index f1215aa6..cd0be85c 100644 --- a/cmd/clairctl/README.md +++ b/cmd/clairctl/README.md @@ -1,42 +1,21 @@ -# hyperclair +# clairctl -[](https://travis-ci.org/wemanity-belgium/hyperclair) [](https://gitter.im/wemanity-belgium/hyperclair?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) +> Tracking container vulnerabilities with Clair Control -> Tracking container vulnerabilities, that's should be *Hyperclair* - -Tracking vulnerabilities in your container images, it's easy with CoreOS Clair. -Integrate it inside your CI/CD pipeline is easier with Hyperclair. - -Hyperclair is a lightweight command-line tool doing the bridge between Registries as Docker Hub, Docker Registry or Quay.io, and the CoreOS vulnerability tracker, Clair. -It's easily integrated in your CI/CD pipeline and Hyperclair will play as reverse proxy for authentication. - - -> The Registry is a stateless, highly scalable server side application that stores and lets you distribute Docker images. The Registry is open-source, under the permissive Apache license. -> ->*From https://docs.docker.com/registry/* - -> Clair is a container vulnerability analysis service. It provides a list of vulnerabilities that threaten a container, and can notify users when new vulnerabilities that affect existing containers become known. -> ->*From https://github.com/coreos/clair* - -hyperclair is tool to make the link between the Docker Registry and the CoreOS Clair tool. - - +Clairctl is a lightweight command-line tool doing the bridge between Registries as Docker Hub, Docker Registry or Quay.io, and the CoreOS vulnerability tracker, Clair. +Clairctl will play as reverse proxy for authentication. # Usage [](https://asciinema.org/a/41461) -# Notification -2. On-Demand: the CLI tool is used to pull image from Registry then push it to Clair - # Reporting -**hyperclair** get vulnerabilities report from Clair and generate HTML report +**clairctl** get vulnerabilities report from Clair and generate HTML report -hyperclair can be used for Docker Hub and self-hosted Registry +clairctl can be used for Docker Hub and self-hosted Registry # Command @@ -44,23 +23,23 @@ hyperclair can be used for Docker Hub and self-hosted Registry Analyse your docker image with Clair, directly from your registry. Usage: - hyperclair [command] + clairctl [command] Available Commands: analyse Analyse Docker image - health Get Health of Hyperclair and underlying services + health Get Health of clairctl and underlying services login Log in to a Docker registry logout Log out from a Docker registry pull Pull Docker image information push Push Docker image to Clair report Generate Docker Image vulnerabilities report - version Get Versions of Hyperclair and underlying services + version Get Versions of clairctl and underlying services Flags: --config string config file (default is ./.hyperclair.yml) --log-level string log level [Panic,Fatal,Error,Warn,Info,Debug] -Use "hyperclair [command] --help" for more information about a command. +Use "clairctl [command] --help" for more information about a command. ``` # Optional Configuration diff --git a/cmd/clairctl/clair/report_test.go b/cmd/clairctl/clair/report_test.go index 31ea0845..bcbc0059 100644 --- a/cmd/clairctl/clair/report_test.go +++ b/cmd/clairctl/clair/report_test.go @@ -2,11 +2,11 @@ package clair import ( "encoding/json" + "fmt" "io/ioutil" "log" "os" "testing" - "fmt" ) func TestReportAsHtml(t *testing.T) { @@ -21,10 +21,10 @@ func TestReportAsHtml(t *testing.T) { if err != nil { log.Fatal(err) } - - fmt.Println(os.TempDir()+"/hyperclair-html-report.html") - - err = ioutil.WriteFile(os.TempDir()+"/hyperclair-html-report.html", []byte(html), 0700) + + fmt.Println(os.TempDir() + "/clairctl-html-report.html") + + err = ioutil.WriteFile(os.TempDir()+"/clairctl-html-report.html", []byte(html), 0700) if err != nil { log.Fatal(err) } diff --git a/cmd/clairctl/clair/templates/analysis-template.1.html b/cmd/clairctl/clair/templates/analysis-template.1.html index 2821a090..bb2723c7 100644 --- a/cmd/clairctl/clair/templates/analysis-template.1.html +++ b/cmd/clairctl/clair/templates/analysis-template.1.html @@ -6,7 +6,7 @@ -
Total : 4215
-- Critical : 923 - -
-- Medium : 661 - -
-- Low : 371 - -
- Negligible : 1197 --
- -