Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates Clair docs #783

Merged
merged 2 commits into from
Sep 12, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions clair/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,14 @@ The contents within this guide provide an overview of Clair for {productname}, r
The content in this guide explains the key purposes and concepts of Clair on {productname}. It also contains information about Clair releases and the location of official Clair containers.

include::modules/clair-vulnerability-scanner-overview.adoc[leveloffset=+1]
include::modules/about-clair.adoc[leveloffset=+2]
include::modules/clair-vulnerability-scanner-hosts.adoc[leveloffset=+2]
include::modules/clair-concepts.adoc[leveloffset=+1]
// include::modules/internal-api.adoc[leveloffset=+2]
include::modules/clair-authentication.adoc[leveloffset=+2]
//include::modules/testing-clair.adoc[leveloffset=+1]
include::modules/clair-updaters.adoc[leveloffset=+2]
include::modules/clair-updater-urls.adoc[leveloffset=+3]
include::modules/about-clair.adoc[leveloffset=+1]
include::modules/clair-cve.adoc[leveloffset=+2]
include::modules/fips-overview.adoc[leveloffset=+2]

Expand Down Expand Up @@ -66,7 +66,7 @@ include::modules/clair-export-bundle-standalone.adoc[leveloffset=+3]
include::modules/clair-openshift-airgap-database-standalone.adoc[leveloffset=+3]
include::modules/clair-openshift-airgap-import-bundle-standalone.adoc[leveloffset=+3]

include::modules/clair-crda-configuration.adoc[leveloffset=+2]
//include::modules/clair-crda-configuration.adoc[leveloffset=+2]
include::modules/mapping-repositories-to-cpe-information.adoc[leveloffset=+2]


Expand Down
2 changes: 1 addition & 1 deletion deploy_quay_on_openshift_op_tng/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ include::modules/clair-export-bundle-standalone.adoc[leveloffset=+5]
include::modules/clair-openshift-airgap-database-standalone.adoc[leveloffset=+5]
include::modules/clair-openshift-airgap-import-bundle-standalone.adoc[leveloffset=+5]

include::modules/clair-crda-configuration.adoc[leveloffset=+3]
//include::modules/clair-crda-configuration.adoc[leveloffset=+3]
include::modules/mapping-repositories-to-cpe-information.adoc[leveloffset=+3]

////
Expand Down
30 changes: 26 additions & 4 deletions modules/about-clair.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,24 @@ New versions of Clair are regularly released. The source code needed to build Cl

Release artifacts also include the `clairctl` command line interface tool, which obtains updater data from the internet by using an open host.

[discrete]
[id="clair-releases-471"]
=== Clair 4.7.1

Clair 4.7.1 was released as part of {productname} 3.9.1. The following changes have been made:

* With this release, you can view unpatched vulnerabilities from {rhel} sources. If you want to view unpatched vulnerabilities, you can the set `ignore_unpatched` parameter to `false`. For example:
+
[source,terminal]
----
updaters:
config:
rhel:
ignore_unpatched: false
----
+
To disable this feature, you can set `ignore_unpatched` to `true`.

[discrete]
[id="clair-releases-47"]
=== Clair 4.7
Expand All @@ -24,17 +42,21 @@ Clair 4.7 was released as part of {productname} 3.9, and includes support for th
* Native support for indexing Golang modules and RubeGems in container images.
* Change to link:OSV.dev[OSV.dev] as the vulnerability database source for any programming language package managers.
** This includes popular sources like GitHub Security Advisories or PyPA.
** This allow offline capability.
** This allows offline capability.
* Use of pyup.io for Python and CRDA for Java is suspended.
* Clair now supports Java, Golang, Python, and Ruby dependencies.

[id="clair-supported-languages"]
== Clair supported languages
== Clair supported dependencies

Clair supports the following languages:
Clair supports identifying and managing the following dependencies:

* Java
* Golang
* Python
* Java (CRDA must be enabled)
* Ruby

This means that it can analyze and report on the third-party libraries and packages that a project in these languages relies on to work correctly.

[id="clair-containers"]
== Clair containers
Expand Down
4 changes: 2 additions & 2 deletions modules/clair-vulnerability-scanner-hosts.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@
Clair uses the following vulnerability databases to report for issues in your images:

* Ubuntu Oval database
* Debian Oval database
* * Debian Security Tracker
* {rhel} Oval database
* SUSE Oval database
* Oracle Oval database
* Alpine SecDB database
* VMWare Photon OS database
* Amazon Web Services (AWS) UpdateInfo
* Pyup.io (Python) database
* link:https://osv.dev/[Open Source Vulnerability (OSV) Database]

For information about how Clair does security mapping with the different databases, see
link:https://quay.github.io/claircore/concepts/severity_mapping.html[ClairCore Severity Mapping].
13 changes: 12 additions & 1 deletion modules/config-fields-clair-updaters.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
The following updaters configuration fields are available for Clair.

[cols="3a,1a,2a",options="header"]

|===
| Field | Type | Description
| **updaters** | Object | Provides configuration for the matcher's update manager.
Expand All @@ -28,4 +27,16 @@ config:
ignore_distributions:
- cosmic
----

| **..ignore_unpatched** | Boolean | Whether to enable reporting of unpatched vulnerabilities.

**Default:** `false`

[source,terminal]
----
updaters:
config:
rhel:
ignore_unpatched: false
----
|===
4 changes: 2 additions & 2 deletions modules/rn_3_90.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Issued 2023-09-05

{productname} release 3.9.1 is now available. The bug fixes that are included in the update are listed in the link:https://access.redhat.com/errata/RHBA-2023:4974[RHBA-2023:4974] advisory.
{productname} release 3.9.1 is now available with Clair 4.7.1. The bug fixes that are included in the update are listed in the link:https://access.redhat.com/errata/RHBA-2023:4974[RHBA-2023:4974] advisory.

[id="bug-fixes-391"]
== Bug fixes
Expand Down Expand Up @@ -46,7 +46,7 @@ Clair 4.7 was released as part of {productname} 3.9, and includes support for th
* Native support for indexing Golang modules and RubeGems in container images.
* Change to link:OSV.dev[OSV.dev] as the vulnerability database source for any programming language package managers.
** This includes popular sources like GitHub Security Advisories or PyPA.
** This allow offline capability.
** This allows offline capability.
* Use of pyup.io for Python and CRDA for Java is suspended.
* Clair now supports Java, Golang, Python, and Ruby dependencies.

Expand Down
2 changes: 1 addition & 1 deletion red_hat_quay_operator_features/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ include::modules/clair-standalone-config-location.adoc[leveloffset=+5]
include::modules/clair-export-bundle-standalone.adoc[leveloffset=+5]
include::modules/clair-openshift-airgap-database-standalone.adoc[leveloffset=+5]
include::modules/clair-openshift-airgap-import-bundle-standalone.adoc[leveloffset=+5]
include::modules/clair-crda-configuration.adoc[leveloffset=+3]
//include::modules/clair-crda-configuration.adoc[leveloffset=+3]
include::modules/mapping-repositories-to-cpe-information.adoc[leveloffset=+3]

//infrastructure
Expand Down