Skip to content

Commit e40fd16

Browse files
cedricbonhommecedricbonhomme
committed
Merge branch 'main' of github.com:vulnerability-lookup/vulnerability-lookup.org
2 parents 850c096 + 57da0d4 commit e40fd16

17 files changed

+170
-142
lines changed

‎static/documentation/_sources/prerequisites.rst

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,24 @@ For the Web server you can use Gunicorn, uWSGI, Apache or Nginx.
2626
Hardware
2727
--------
2828

29+
For the core of the Vulnerability-Lookup service, we recommend the following baseline specifications for a public-facing deployment (running Kvrocks and PostgreSQL):
30+
31+
- 16 CPU cores
32+
- 64 GB RAM
33+
- 2 TB NVMe storage
34+
35+
The new VLAI capabilities are straightforward to set up, as we intentionally avoided adding complexity to the core Vulnerability-Lookup software or its dependencies. Instead, we developed a separate component called `ML-Gateway <https://github.com/vulnerability-lookup/ML-Gateway>`_, which is queried by the core service.
36+
37+
The requirements for ML-Gateway are currently minimal. For VLAI Severity, no GPU or specialized hardware is needed, as it uses `a lightweight NLP model <https://huggingface.co/CIRCL/vulnerability-severity-classification-roberta-base>`_ that is loaded at runtime. ML-Gateway requires:
38+
39+
- 4 GB of memory
40+
- 200 GB of disk space
41+
- At least 4 vCPU cores
42+
43+
These requirements may increase depending on the VLAI features added in the future.
2944

3045
Network
3146
-------
3247

33-
The deployment on the different servers requires an Internet connection since
34-
the updates are retrieved from the GitHub repository.
48+
Deployment on the different servers requires an Internet connection, as updates are retrieved from the GitHub repository. The feeders also need Internet access to various locations, including Git repositories, HTTP endpoints, and specific APIs.
49+

‎static/documentation/_static/pygments.css

Lines changed: 121 additions & 121 deletions
Large diffs are not rendered by default.

‎static/documentation/api-v1.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-brands-400.woff2" />
2929
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-regular-400.woff2" />
3030

31-
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=8f2a1f02" />
31+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
3232
<link rel="stylesheet" type="text/css" href="_static/styles/sphinx-book-theme.css?v=eba8b062" />
3333
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=ee704053" />
3434

‎static/documentation/architecture.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-brands-400.woff2" />
2929
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-regular-400.woff2" />
3030

31-
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=8f2a1f02" />
31+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
3232
<link rel="stylesheet" type="text/css" href="_static/styles/sphinx-book-theme.css?v=eba8b062" />
3333
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=ee704053" />
3434

‎static/documentation/command-line-interface.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-brands-400.woff2" />
2929
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-regular-400.woff2" />
3030

31-
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=8f2a1f02" />
31+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
3232
<link rel="stylesheet" type="text/css" href="_static/styles/sphinx-book-theme.css?v=eba8b062" />
3333
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=ee704053" />
3434

‎static/documentation/feeds.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-brands-400.woff2" />
2929
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-regular-400.woff2" />
3030

31-
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=8f2a1f02" />
31+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
3232
<link rel="stylesheet" type="text/css" href="_static/styles/sphinx-book-theme.css?v=eba8b062" />
3333
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=ee704053" />
3434

‎static/documentation/genindex.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-brands-400.woff2" />
2828
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-regular-400.woff2" />
2929

30-
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=8f2a1f02" />
30+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
3131
<link rel="stylesheet" type="text/css" href="_static/styles/sphinx-book-theme.css?v=eba8b062" />
3232
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=ee704053" />
3333

‎static/documentation/http-routingtable.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-brands-400.woff2" />
2828
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-regular-400.woff2" />
2929

30-
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=8f2a1f02" />
30+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
3131
<link rel="stylesheet" type="text/css" href="_static/styles/sphinx-book-theme.css?v=eba8b062" />
3232
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=ee704053" />
3333

‎static/documentation/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-brands-400.woff2" />
2929
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-regular-400.woff2" />
3030

31-
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=8f2a1f02" />
31+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
3232
<link rel="stylesheet" type="text/css" href="_static/styles/sphinx-book-theme.css?v=eba8b062" />
3333
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=ee704053" />
3434

‎static/documentation/installation.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-brands-400.woff2" />
2929
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-regular-400.woff2" />
3030

31-
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=8f2a1f02" />
31+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
3232
<link rel="stylesheet" type="text/css" href="_static/styles/sphinx-book-theme.css?v=eba8b062" />
3333
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=ee704053" />
3434

@@ -650,7 +650,7 @@ <h2>Launching the website with systemd<a class="headerlink" href="#launching-the
650650
<span class="na">User</span><span class="o">=</span><span class="s">&lt;system user used to install Vulnerability-Lookup&gt;</span>
651651
<span class="na">Group</span><span class="o">=</span><span class="s">&lt;group of the user used to install Vulnerability-Lookup&gt;</span>
652652
<span class="na">WorkingDirectory</span><span class="o">=</span><span class="s">&lt;path to the directory where you cloned the repository&gt;</span>
653-
<span class="na">Environment=PATH</span><span class="o">=</span><span class="s">&quot;&lt;path-of-the-virtualenv&gt;/bin/:/usr/bin&quot;</span>
653+
<span class="na">Environment</span><span class="o">=</span><span class="s">PATH=&quot;&lt;path-of-the-virtualenv&gt;/bin/:/usr/bin&quot;</span>
654654
<span class="na">ExecStart</span><span class="o">=</span><span class="s">/bin/bash -c &quot;run_backend --start</span><span class="w"> </span><span class="c1">; start_website&quot;</span>
655655
<span class="na">ExecStop</span><span class="o">=</span><span class="s">/bin/bash -c &quot;run_backend --stop&quot;</span>
656656

‎static/documentation/prerequisites.html

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-brands-400.woff2" />
2929
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-regular-400.woff2" />
3030

31-
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=8f2a1f02" />
31+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
3232
<link rel="stylesheet" type="text/css" href="_static/styles/sphinx-book-theme.css?v=eba8b062" />
3333
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=ee704053" />
3434

@@ -432,11 +432,24 @@ <h2>Software<a class="headerlink" href="#software" title="Link to this heading">
432432
</section>
433433
<section id="hardware">
434434
<h2>Hardware<a class="headerlink" href="#hardware" title="Link to this heading">#</a></h2>
435+
<p>For the core of the Vulnerability-Lookup service, we recommend the following baseline specifications for a public-facing deployment (running Kvrocks and PostgreSQL):</p>
436+
<ul class="simple">
437+
<li><p>16 CPU cores</p></li>
438+
<li><p>64 GB RAM</p></li>
439+
<li><p>2 TB NVMe storage</p></li>
440+
</ul>
441+
<p>The new VLAI capabilities are straightforward to set up, as we intentionally avoided adding complexity to the core Vulnerability-Lookup software or its dependencies. Instead, we developed a separate component called <a class="reference external" href="https://github.com/vulnerability-lookup/ML-Gateway">ML-Gateway</a>, which is queried by the core service.</p>
442+
<p>The requirements for ML-Gateway are currently minimal. For VLAI Severity, no GPU or specialized hardware is needed, as it uses <a class="reference external" href="https://huggingface.co/CIRCL/vulnerability-severity-classification-roberta-base">a lightweight NLP model</a> that is loaded at runtime. ML-Gateway requires:</p>
443+
<ul class="simple">
444+
<li><p>4 GB of memory</p></li>
445+
<li><p>200 GB of disk space</p></li>
446+
<li><p>At least 4 vCPU cores</p></li>
447+
</ul>
448+
<p>These requirements may increase depending on the VLAI features added in the future.</p>
435449
</section>
436450
<section id="network">
437451
<h2>Network<a class="headerlink" href="#network" title="Link to this heading">#</a></h2>
438-
<p>The deployment on the different servers requires an Internet connection since
439-
the updates are retrieved from the GitHub repository.</p>
452+
<p>Deployment on the different servers requires an Internet connection, as updates are retrieved from the GitHub repository. The feeders also need Internet access to various locations, including Git repositories, HTTP endpoints, and specific APIs.</p>
440453
</section>
441454
</section>
442455

‎static/documentation/search.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-brands-400.woff2" />
2727
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-regular-400.woff2" />
2828

29-
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=8f2a1f02" />
29+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
3030
<link rel="stylesheet" type="text/css" href="_static/styles/sphinx-book-theme.css?v=eba8b062" />
3131
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=ee704053" />
3232

‎static/documentation/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎static/documentation/sightings.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-brands-400.woff2" />
2929
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-regular-400.woff2" />
3030

31-
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=8f2a1f02" />
31+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
3232
<link rel="stylesheet" type="text/css" href="_static/styles/sphinx-book-theme.css?v=eba8b062" />
3333
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=ee704053" />
3434

@@ -523,7 +523,7 @@ <h3>Tools<a class="headerlink" href="#tools" title="Link to this heading">#</a><
523523
<section id="pyvulnerabilitylookup-usage-example">
524524
<h4>PyVulnerabilityLookup usage example<a class="headerlink" href="#pyvulnerabilitylookup-usage-example" title="Link to this heading">#</a></h4>
525525
<p>Initalize a PyVulnerabilityLookup object:</p>
526-
<div class="highlight-Python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span><span class="w"> </span><span class="nn">pyvulnerabilitylookup</span><span class="w"> </span><span class="kn">import</span> <span class="n">PyVulnerabilityLookup</span>
526+
<div class="highlight-Python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">pyvulnerabilitylookup</span> <span class="kn">import</span> <span class="n">PyVulnerabilityLookup</span>
527527
<span class="n">vuln_lookup</span> <span class="o">=</span> <span class="n">PyVulnerabilityLookup</span><span class="p">(</span><span class="s2">&quot;https://vulnerability.circl.lu/&quot;</span><span class="p">,</span> <span class="n">token</span><span class="o">=</span><span class="s2">&quot;&lt;YOUR-API-TOKEN&gt;&quot;</span><span class="p">)</span>
528528
</pre></div>
529529
</div>

‎static/documentation/streaming.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-brands-400.woff2" />
2929
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-regular-400.woff2" />
3030

31-
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=8f2a1f02" />
31+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
3232
<link rel="stylesheet" type="text/css" href="_static/styles/sphinx-book-theme.css?v=eba8b062" />
3333
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=ee704053" />
3434

‎static/documentation/update.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-brands-400.woff2" />
2929
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-regular-400.woff2" />
3030

31-
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=8f2a1f02" />
31+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
3232
<link rel="stylesheet" type="text/css" href="_static/styles/sphinx-book-theme.css?v=eba8b062" />
3333
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=ee704053" />
3434

‎static/documentation/webservice.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-brands-400.woff2" />
2929
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-regular-400.woff2" />
3030

31-
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=8f2a1f02" />
31+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
3232
<link rel="stylesheet" type="text/css" href="_static/styles/sphinx-book-theme.css?v=eba8b062" />
3333
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=ee704053" />
3434

0 commit comments

Comments
 (0)