Skip to content

Commit

Permalink
docs: add guide to update vulnerability data
Browse files Browse the repository at this point in the history
  • Loading branch information
lucasmoura committed Oct 25, 2024
1 parent 996c1cf commit 0972c14
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/howtoguides.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ Vulnerability commands

Display USNs that affectt the system... <howtoguides/how_to_display_usns_that_affect_the_system>
Provide manifest file to commands... <howtoguides/how_to_use_manifest_file_for_pro_vulnerability>
Update vulnerability data... <howtoguides/how_to_update_vulnerability_data>

Use the Pro Client
==================
Expand Down
43 changes: 43 additions & 0 deletions docs/howtoguides/how_to_update_vulnerability_data.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
How to update vulnerability data on the machine?
************************************************

When running the ``pro vulnerability list`` you might see an alert like this:

.. code-block:: text
The vulnerabilities data used in the system is outdated by NUM days/hours
To update the data please run with --update:
pro vulnerability list --update
This same behavior can happen when running ``pro vulnerability show``. This indicates
that our data source for the vulnerability commands is outdated in the machine.

To update it, you can follow the instructions mentioned in the warning or you
can run the following command as well:

.. code-block:: bash
pro vulnerability update
The main purpose of this command is to just allow you to update that datasource.
When we detect a new version of this datasource, you should see an output like this:

.. code-block:: text
Checking for the availability of newer vulnerability data.
Please wait a moment while we verify if a new version is ready for download.
Found a newer version of the data.
Fetching and processing the new data…
✔ Vulnerability data in the system is now up-to-date
And if you there is no new version of the datasource:

.. code-block:: text
Checking for the availability of newer vulnerability data.
Please wait a moment while we verify if a new version is ready for download.
✔ Vulnerability data in the system is already up-to-date

0 comments on commit 0972c14

Please sign in to comment.