Skip to content
This repository has been archived by the owner on Apr 15, 2024. It is now read-only.

Commit

Permalink
doc: update html doc index page
Browse files Browse the repository at this point in the history 
Signed-off-by: Ruoyu Ying <[email protected]>
  • Loading branch information
@Ruoyu-y
Ruoyu-y committed Jan 10, 2024
1 parent 68deeec commit 264510f
Show file tree
Hide file tree
Showing 24 changed files with 720 additions and 36 deletions.
Binary file added docs/_images/cc-full-measurement-tdreport.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/cc-full-meaurement-chain.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/ccnp-architecture-high-level.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/ccnp-landing-confidential-cluster.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/ccnp_arch.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/_rst/ccnp.eventlog.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="modules.html#ccnp-services">CCNP Services</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules.html#deployment-guide">Deployment Guide</a></li>
</ul>
</li>
</ul>
Expand Down
1 change: 1 addition & 0 deletions docs/_rst/ccnp.measurement.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="modules.html#ccnp-services">CCNP Services</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules.html#deployment-guide">Deployment Guide</a></li>
</ul>
</li>
</ul>
Expand Down
1 change: 1 addition & 0 deletions docs/_rst/ccnp.quote.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="modules.html#ccnp-services">CCNP Services</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules.html#deployment-guide">Deployment Guide</a></li>
</ul>
</li>
</ul>
Expand Down
263 changes: 263 additions & 0 deletions docs/_rst/deployment.readme.html
View file

Large diffs are not rendered by default.

20 changes: 20 additions & 0 deletions docs/_rst/modules.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,10 @@
<li class="toctree-l3"><a class="reference internal" href="service.eventlog.html">CCNP Event Log Service</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#deployment-guide">Deployment Guide</a><ul>
<li class="toctree-l3"><a class="reference internal" href="deployment.readme.html">CCNP Deployment Guide</a></li>
</ul>
</li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -315,6 +319,7 @@ <h2>CCNP Services<a class="headerlink" href="#ccnp-services" title="Permalink to
<li class="toctree-l1"><a class="reference internal" href="service.quote.html">CCNP Quote Service</a><ul>
<li class="toctree-l2"><a class="reference internal" href="service.quote.html#introduction">Introduction</a></li>
<li class="toctree-l2"><a class="reference internal" href="service.quote.html#installation">Installation</a><ul>
<li class="toctree-l3"><a class="reference internal" href="service.quote.html#prerequisite">Prerequisite</a></li>
<li class="toctree-l3"><a class="reference internal" href="service.quote.html#build-docker-image">Build docker image</a></li>
<li class="toctree-l3"><a class="reference internal" href="service.quote.html#deploy-as-daemonset-in-kubernetes">Deploy as DaemonSet in Kubernetes</a></li>
</ul>
Expand Down Expand Up @@ -351,6 +356,21 @@ <h2>CCNP Services<a class="headerlink" href="#ccnp-services" title="Permalink to
</ul>
</div>
</section>
<section id="deployment-guide">
<h2>Deployment Guide<a class="headerlink" href="#deployment-guide" title="Permalink to this heading"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="deployment.readme.html">CCNP Deployment Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="deployment.readme.html#create-td">Create TD</a></li>
<li class="toctree-l2"><a class="reference internal" href="deployment.readme.html#prepare-a-k8s-cluster-with-td-as-worker-nodes">Prepare a K8S cluster with TD as worker nodes</a></li>
<li class="toctree-l2"><a class="reference internal" href="deployment.readme.html#deploy-ccnp">Deploy CCNP</a></li>
<li class="toctree-l2"><a class="reference internal" href="deployment.readme.html#install-ccnp-sdk">Install CCNP SDK</a></li>
<li class="toctree-l2"><a class="reference internal" href="deployment.readme.html#ccnp-example">CCNP example</a></li>
</ul>
</li>
</ul>
</div>
</section>
</section>


Expand Down
230 changes: 216 additions & 14 deletions docs/_rst/readme.html
View file

Large diffs are not rendered by default.

10 changes: 6 additions & 4 deletions docs/_rst/sdk.readme.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="modules.html#ccnp-services">CCNP Services</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules.html#deployment-guide">Deployment Guide</a></li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -101,7 +102,7 @@
<p>CCNP, as the overall framework for attestation, measurement and event log fetching, provides user with both customer-facing SDK and overall framework. By leveraging this SDK, user can easily retrieve different kinds of measurements or evidence such as event logs. Working along with different verification services (such as Amber) and configurable policies, user can validate the trustworthiness of the platform and make further decision.</p>
<p><a class="reference external" href="https://github.com/intel/confidential-cloud-native-primitives/tree/main/sdk/python3">Source code</a>
| <a class="reference external" href="https://pypi.org/project/ccnp/">Package (PyPI)</a>
| <a class="reference external" href="https://github.com/intel/confidential-cloud-native-primitives/tree/main/api">API reference documentation</a></p>
| <a class="reference external" href="https://intel.github.io/confidential-cloud-native-primitives/_rst/sdk.readme.html">API reference documentation</a></p>
<section id="getting-started">
<h2>Getting started<a class="headerlink" href="#getting-started" title="Permalink to this heading"></a></h2>
<section id="prerequisites">
Expand Down Expand Up @@ -156,10 +157,11 @@ <h4>Example usage of quote SDK<a class="headerlink" href="#example-usage-of-quot
<ul class="simple">
<li><p>Fetch quote with a <code class="docutils literal notranslate"><span class="pre">nonce</span></code></p></li>
</ul>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">secrets</span>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">base64</span>
<span class="kn">import</span> <span class="nn">secrets</span>
<span class="kn">from</span> <span class="nn">ccnp</span> <span class="kn">import</span> <span class="n">Quote</span>

<span class="n">nonce</span> <span class="o">=</span> <span class="n">secrets</span><span class="o">.</span><span class="n">token_urlsafe</span><span class="p">()</span>
<span class="n">nonce</span> <span class="o">=</span> <span class="n">base64</span><span class="o">.</span><span class="n">b64encode</span><span class="p">(</span><span class="n">secrets</span><span class="o">.</span><span class="n">token_urlsafe</span><span class="p">()</span><span class="o">.</span><span class="n">encode</span><span class="p">())</span>
<span class="n">quote</span> <span class="o">=</span> <span class="n">Quote</span><span class="o">.</span><span class="n">get_quote</span><span class="p">(</span><span class="n">nonce</span><span class="o">=</span><span class="n">nonce</span><span class="p">)</span>

<span class="nb">print</span><span class="p">(</span><span class="n">quote</span><span class="o">.</span><span class="n">quote_type</span><span class="p">)</span>
Expand All @@ -173,7 +175,7 @@ <h4>Example usage of quote SDK<a class="headerlink" href="#example-usage-of-quot
<span class="kn">import</span> <span class="nn">secrets</span>
<span class="kn">from</span> <span class="nn">ccnp</span> <span class="kn">import</span> <span class="n">Quote</span>

<span class="n">nonce</span> <span class="o">=</span> <span class="n">secrets</span><span class="o">.</span><span class="n">token_urlsafe</span><span class="p">()</span>
<span class="n">nonce</span> <span class="o">=</span> <span class="n">base64</span><span class="o">.</span><span class="n">b64encode</span><span class="p">(</span><span class="n">secrets</span><span class="o">.</span><span class="n">token_urlsafe</span><span class="p">()</span><span class="o">.</span><span class="n">encode</span><span class="p">())</span>
<span class="n">user_data</span> <span class="o">=</span> <span class="n">base64</span><span class="o">.</span><span class="n">b64encode</span><span class="p">(</span><span class="sa">b</span><span class="s1">&#39;This data should be measured.&#39;</span><span class="p">)</span>
<span class="n">quote</span> <span class="o">=</span> <span class="n">Quote</span><span class="o">.</span><span class="n">get_quote</span><span class="p">(</span><span class="n">nonce</span><span class="o">=</span><span class="n">nonce</span><span class="p">,</span> <span class="n">user_data</span><span class="o">=</span><span class="n">user_data</span><span class="p">)</span>

Expand Down
9 changes: 6 additions & 3 deletions docs/_rst/service.eventlog.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="CCNP Deployment Guide" href="deployment.readme.html" />
<link rel="prev" title="Service: CCNP Measurement Server" href="service.measurement.html" />
</head>

Expand Down Expand Up @@ -54,6 +55,7 @@
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="modules.html#deployment-guide">Deployment Guide</a></li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -132,15 +134,15 @@ <h3>Prerequisite<a class="headerlink" href="#prerequisite" title="Permalink to t
</section>
<section id="build-docker-image">
<h3>Build docker image<a class="headerlink" href="#build-docker-image" title="Permalink to this heading"></a></h3>
<p>The dockerfile for the service can be found under <code class="docutils literal notranslate"><span class="pre">container/eventlog-server</span></code> directory. Use the following command to build the image:</p>
<p>The dockerfile for the service can be found under <code class="docutils literal notranslate"><span class="pre">container/ccnp-eventlog-server</span></code> directory. Use the following command to build the image:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">../..</span>
<span class="n">docker</span> <span class="n">build</span> <span class="o">-</span><span class="n">t</span> <span class="n">ccnp_eventlog_server</span><span class="p">:</span><span class="mf">0.1</span> <span class="o">-</span><span class="n">f</span> <span class="n">container</span><span class="o">/</span><span class="n">eventlog</span><span class="o">-</span><span class="n">server</span><span class="o">/</span><span class="n">Dockerfile</span> <span class="o">.</span>
<span class="n">docker</span> <span class="n">build</span> <span class="o">-</span><span class="n">t</span> <span class="n">ccnp</span><span class="o">-</span><span class="n">eventlog</span><span class="o">-</span><span class="n">server</span><span class="p">:</span><span class="o">&lt;</span><span class="n">your</span> <span class="n">image</span> <span class="n">tag</span><span class="o">&gt;</span> <span class="o">-</span><span class="n">f</span> <span class="n">container</span><span class="o">/</span><span class="n">ccnp</span><span class="o">-</span><span class="n">eventlog</span><span class="o">-</span><span class="n">server</span><span class="o">/</span><span class="n">Dockerfile</span> <span class="o">.</span>
</pre></div>
</div>
<blockquote>
<div><p>Note: if you are using containerd as the default runtime for kubernetes. Please remember to use the following commands to import the image into containerd first:</p>
</div></blockquote>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">docker</span> <span class="n">save</span> <span class="o">-</span><span class="n">o</span> <span class="n">ccnp</span><span class="o">-</span><span class="n">eventlog</span><span class="o">-</span><span class="n">server</span><span class="o">.</span><span class="n">tar</span> <span class="n">ccnp_eventlog_server</span><span class="p">:</span><span class="mf">0.1</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">docker</span> <span class="n">save</span> <span class="o">-</span><span class="n">o</span> <span class="n">ccnp</span><span class="o">-</span><span class="n">eventlog</span><span class="o">-</span><span class="n">server</span><span class="o">.</span><span class="n">tar</span> <span class="n">ccnp</span><span class="o">-</span><span class="n">eventlog</span><span class="o">-</span><span class="n">server</span><span class="p">:</span><span class="o">&lt;</span><span class="n">your</span> <span class="n">image</span> <span class="n">tag</span><span class="o">&gt;</span>
<span class="n">ctr</span> <span class="o">-</span><span class="n">n</span><span class="o">=</span><span class="n">k8s</span><span class="o">.</span><span class="n">io</span> <span class="n">image</span> <span class="kn">import</span> <span class="nn">ccnp</span><span class="o">-</span><span class="n">eventlog</span><span class="o">-</span><span class="n">server</span><span class="o">.</span><span class="n">tar</span>
</pre></div>
</div>
Expand Down Expand Up @@ -207,6 +209,7 @@ <h2>Testing<a class="headerlink" href="#testing" title="Permalink to this headin
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="service.measurement.html" class="btn btn-neutral float-left" title="Service: CCNP Measurement Server" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="deployment.readme.html" class="btn btn-neutral float-right" title="CCNP Deployment Guide" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

<hr/>
Expand Down
7 changes: 4 additions & 3 deletions docs/_rst/service.measurement.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@
<li class="toctree-l3"><a class="reference internal" href="service.eventlog.html">CCNP Event Log Service</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="modules.html#deployment-guide">Deployment Guide</a></li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -136,15 +137,15 @@ <h3>Prerequisite<a class="headerlink" href="#prerequisite" title="Permalink to t
</section>
<section id="build-docker-image">
<h3>Build docker image<a class="headerlink" href="#build-docker-image" title="Permalink to this heading"></a></h3>
<p>The dockerfile for the service can be found under <code class="docutils literal notranslate"><span class="pre">container/measurement-server</span></code> directory. Use the following command to build the image:</p>
<p>The dockerfile for the service can be found under <code class="docutils literal notranslate"><span class="pre">container/ccnp-measurement-server</span></code> directory. Use the following command to build the image:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">../..</span>
<span class="n">docker</span> <span class="n">build</span> <span class="o">-</span><span class="n">t</span> <span class="n">ccnp_measurement_server</span><span class="p">:</span><span class="mf">0.1</span> <span class="o">-</span><span class="n">f</span> <span class="n">container</span><span class="o">/</span><span class="n">measurement</span><span class="o">-</span><span class="n">server</span><span class="o">/</span><span class="n">Dockerfile</span> <span class="o">.</span>
<span class="n">docker</span> <span class="n">build</span> <span class="o">-</span><span class="n">t</span> <span class="n">ccnp</span><span class="o">-</span><span class="n">measurement</span><span class="o">-</span><span class="n">server</span><span class="p">:</span><span class="o">&lt;</span><span class="n">your</span> <span class="n">image</span> <span class="n">tag</span><span class="o">&gt;</span> <span class="o">-</span><span class="n">f</span> <span class="n">container</span><span class="o">/</span><span class="n">ccnp</span><span class="o">-</span><span class="n">measurement</span><span class="o">-</span><span class="n">server</span><span class="o">/</span><span class="n">Dockerfile</span> <span class="o">.</span>
</pre></div>
</div>
<blockquote>
<div><p>Note: if you are using containerd as the default runtime for kubernetes. Please remember to use the following commands to import the image into containerd first:</p>
</div></blockquote>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">docker</span> <span class="n">save</span> <span class="o">-</span><span class="n">o</span> <span class="n">ccnp</span><span class="o">-</span><span class="n">measurement</span><span class="o">-</span><span class="n">server</span><span class="o">.</span><span class="n">tar</span> <span class="n">ccnp_measurement_server</span><span class="p">:</span><span class="mf">0.1</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">docker</span> <span class="n">save</span> <span class="o">-</span><span class="n">o</span> <span class="n">ccnp</span><span class="o">-</span><span class="n">measurement</span><span class="o">-</span><span class="n">server</span><span class="o">.</span><span class="n">tar</span> <span class="n">ccnp</span><span class="o">-</span><span class="n">measurement</span><span class="o">-</span><span class="n">server</span><span class="p">:</span><span class="o">&lt;</span><span class="n">your</span> <span class="n">image</span> <span class="n">tag</span><span class="o">&gt;</span>
<span class="n">ctr</span> <span class="o">-</span><span class="n">n</span><span class="o">=</span><span class="n">k8s</span><span class="o">.</span><span class="n">io</span> <span class="n">image</span> <span class="kn">import</span> <span class="nn">ccnp</span><span class="o">-</span><span class="n">measurement</span><span class="o">-</span><span class="n">server</span><span class="o">.</span><span class="n">tar</span>
</pre></div>
</div>
Expand Down
Loading

0 comments on commit 264510f

Please sign in to comment.