Doc: add doc for ccnp

* Add sphinx based html documentation * revise github pylint workflow to exclude docs/ folder from inspection Signed-off-by: Ruoyu Ying <ruoyu.ying@intel.com>
intel · Aug 31, 2023 · 8d2d083 · 8d2d083
1 parent a1b2dcd
commit 8d2d083
Show file tree

Hide file tree

Showing 95 changed files with 8,428 additions and 1 deletion.
diff --git a/.github/workflows/pr-pylint.yaml b/.github/workflows/pr-pylint.yaml
@@ -31,7 +31,7 @@ jobs:
         run: |
           set -ex
           export PYTHONPATH=$PWD/ccnp:$PYTHONPATH
-          python_files=$(find . -path ./sdk/python3/tests -prune -o -name "*.py" -print)
+          python_files=$(find . \( -path ./sdk/python3/tests -o -path ./docs \) -prune -o -name "*.py" -print)
           if [[ -n "$python_files" ]]; then
             echo "$python_files" | xargs -n 1 python3 -m pylint --rcfile=.github/pylintrc
           else

diff --git a/docs/.buildinfo b/docs/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: fc7a2c9964d336543b9179413d12d010
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/.doctrees/ccnp.doctree b/docs/.doctrees/ccnp.doctree
diff --git a/docs/.doctrees/ccnp.eventlog.doctree b/docs/.doctrees/ccnp.eventlog.doctree
diff --git a/docs/.doctrees/ccnp.measurement.doctree b/docs/.doctrees/ccnp.measurement.doctree
diff --git a/docs/.doctrees/ccnp.quote.doctree b/docs/.doctrees/ccnp.quote.doctree
diff --git a/docs/.doctrees/environment.pickle b/docs/.doctrees/environment.pickle
diff --git a/docs/.doctrees/eventlog/eventlog.doctree b/docs/.doctrees/eventlog/eventlog.doctree
diff --git a/docs/.doctrees/eventlog/modules.doctree b/docs/.doctrees/eventlog/modules.doctree
diff --git a/docs/.doctrees/index.doctree b/docs/.doctrees/index.doctree
diff --git a/docs/.doctrees/measurement/measurement.doctree b/docs/.doctrees/measurement/measurement.doctree
diff --git a/docs/.doctrees/measurement/modules.doctree b/docs/.doctrees/measurement/modules.doctree
diff --git a/docs/.doctrees/modules.doctree b/docs/.doctrees/modules.doctree
diff --git a/docs/.doctrees/quote/modules.doctree b/docs/.doctrees/quote/modules.doctree
diff --git a/docs/.doctrees/quote/quote.doctree b/docs/.doctrees/quote/quote.doctree
diff --git a/docs/.doctrees/readme.doctree b/docs/.doctrees/readme.doctree
diff --git a/docs/.doctrees/source/ccnp.doctree b/docs/.doctrees/source/ccnp.doctree
diff --git a/docs/.doctrees/source/ccnp.eventlog.doctree b/docs/.doctrees/source/ccnp.eventlog.doctree
diff --git a/docs/.doctrees/source/ccnp.measurement.doctree b/docs/.doctrees/source/ccnp.measurement.doctree
diff --git a/docs/.doctrees/source/ccnp.quote.doctree b/docs/.doctrees/source/ccnp.quote.doctree
diff --git a/docs/.doctrees/source/modules.doctree b/docs/.doctrees/source/modules.doctree
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/Makefile b/docs/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/_rst/ccnp.eventlog.html b/docs/_rst/ccnp.eventlog.html
diff --git a/docs/_rst/ccnp.html b/docs/_rst/ccnp.html
diff --git a/docs/_rst/ccnp.measurement.html b/docs/_rst/ccnp.measurement.html
diff --git a/docs/_rst/ccnp.quote.html b/docs/_rst/ccnp.quote.html
diff --git a/docs/_rst/modules.html b/docs/_rst/modules.html
diff --git a/docs/_rst/readme.html b/docs/_rst/readme.html
@@ -0,0 +1,126 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" >
+<head>
+  <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
+
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>Confidential Cloud Native Primitives (CCNP) &mdash; Confidential Cloud-Native Primitives  documentation</title>
+      <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+      <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+  <!--[if lt IE 9]>
+    <script src="../_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+
+        <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=b3ba4146"></script>
+        <script src="../_static/doctools.js?v=888ff710"></script>
+        <script src="../_static/sphinx_highlight.js?v=4825356b"></script>
+    <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" href="modules.html" />
+    <link rel="prev" title="Welcome to Confidential Cloud-Native Primitives (CCNP)’s documentation!" href="../index.html" /> 
+</head>
+
+<body class="wy-body-for-nav"> 
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+
+
+
+          <a href="../index.html" class="icon icon-home">
+            Confidential Cloud-Native Primitives
+          </a>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
+<ul class="current">
+<li class="toctree-l1 current"><a class="current reference internal" href="#">CCNP Introduction</a></li>
+<li class="toctree-l1"><a class="reference internal" href="modules.html">CCNP Modules</a></li>
+</ul>
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="../index.html">Confidential Cloud-Native Primitives</a>
+      </nav>
+
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="Page navigation">
+  <ul class="wy-breadcrumbs">
+      <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
+      <li class="breadcrumb-item active">Confidential Cloud Native Primitives (CCNP)</li>
+      <li class="wy-breadcrumbs-aside">
+            <a href="../_sources/_rst/readme.rst.txt" rel="nofollow"> View page source</a>
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <section id="confidential-cloud-native-primitives-ccnp">
+<span id="readme"></span><h1>Confidential Cloud Native Primitives (CCNP)<a class="headerlink" href="#confidential-cloud-native-primitives-ccnp" title="Permalink to this heading">¶</a></h1>
+<a class="reference external image-reference" href="https://github.com/intel/confidential-cloud-native-primitives/actions/workflows/pr-license-python.yaml/badge.svg"><img alt="CI Check License" src="https://github.com/intel/confidential-cloud-native-primitives/actions/workflows/pr-license-python.yaml/badge.svg" /></a>
+<a class="reference external image-reference" href="https://github.com/intel/confidential-cloud-native-primitives/actions/workflows/pr-doclint.yaml/badge.svg"><img alt="CI Check Spelling" src="https://github.com/intel/confidential-cloud-native-primitives/actions/workflows/pr-doclint.yaml/badge.svg" /></a>
+<a class="reference external image-reference" href="https://github.com/intel/confidential-cloud-native-primitives/actions/workflows/pr-pylint.yaml/badge.svg"><img alt="CI Check Python" src="https://github.com/intel/confidential-cloud-native-primitives/actions/workflows/pr-pylint.yaml/badge.svg" /></a>
+<a class="reference external image-reference" href="https://github.com/intel/confidential-cloud-native-primitives/actions/workflows/pr-shell-check.yaml/badge.svg"><img alt="CI Check Shell" src="https://github.com/intel/confidential-cloud-native-primitives/actions/workflows/pr-shell-check.yaml/badge.svg" /></a>
+<a class="reference external image-reference" href="https://github.com/intel/confidential-cloud-native-primitives/actions/workflows/pr-check-rust.yaml/badge.svg"><img alt="CI Check Rust" src="https://github.com/intel/confidential-cloud-native-primitives/actions/workflows/pr-check-rust.yaml/badge.svg" /></a>
+<a class="reference external image-reference" href="https://github.com/intel/confidential-cloud-native-primitives/actions/workflows/pr-golanglint.yaml/badge.svg"><img alt="CI Check Golang" src="https://github.com/intel/confidential-cloud-native-primitives/actions/workflows/pr-golanglint.yaml/badge.svg" /></a>
+<a class="reference external image-reference" href="https://github.com/intel/confidential-cloud-native-primitives/actions/workflows/pr-container-check.yaml/badge.svg"><img alt="CI Check Container" src="https://github.com/intel/confidential-cloud-native-primitives/actions/workflows/pr-container-check.yaml/badge.svg" /></a>
+<p>VM(Virtual Machine) based confidential computing like Intel TDX provides isolated encryption runtime environment based on
+hardware Trusted Execution Environment (TEE) technologies. To land cloud native computing into confidential environment,
+there are lots of different PaaS frameworks such as confidential cluster, confidential container, which brings challenges
+for enabling and TEE measurement.
+This project uses cloud native design pattern to implement confidential computing primitives like event log, measurement,
+quote and attestation. It also provides new features design to address new challenges like how to auto scale trustworthy,
+how to reduce TCB size, etc.</p>
+<p><em>NOTE: For Intel TDX, it bases on Linux TDX Software Stack at `tdx-tools &lt;https://github.com/intel/tdx-tools&gt;`_, the corresponding white
+paper is at `Whitepaper: Linux</em> Stacks for Intel® Trust Domain Extension 1.0 &lt;<a class="reference external" href="https://www.intel.com/content/www/us/en/content-details/779108/whitepaper-linux-stacks-for-intel-trust-domain-extension-1-0.html">https://www.intel.com/content/www/us/en/content-details/779108/whitepaper-linux-stacks-for-intel-trust-domain-extension-1-0.html</a>&gt;`_.*</p>
+<a class="reference external image-reference" href="../ccnp_arch.png"><img alt="" src="../ccnp_arch.png" /></a>
+<p><strong>Note</strong>: This is pre-release/prototype software and, as such, it may be substantially modified as updated versions are made available. Also, the authors make no assurance that it will ever develop or make generally available a production-ready version.</p>
+</section>
+
+
+           </div>
+          </div>
+          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
+        <a href="../index.html" class="btn btn-neutral float-left" title="Welcome to Confidential Cloud-Native Primitives (CCNP)’s documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="modules.html" class="btn btn-neutral float-right" title="ccnp" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+    </div>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2023, Intel.</p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>
diff --git a/docs/_rst_file/.buildinfo b/docs/_rst_file/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 18a851dde4b52825dc2f433ebca1a834
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_rst_file/.doctrees/_rst/ccnp.doctree b/docs/_rst_file/.doctrees/_rst/ccnp.doctree
diff --git a/docs/_rst_file/.doctrees/_rst/ccnp.eventlog.doctree b/docs/_rst_file/.doctrees/_rst/ccnp.eventlog.doctree
diff --git a/docs/_rst_file/.doctrees/_rst/ccnp.measurement.doctree b/docs/_rst_file/.doctrees/_rst/ccnp.measurement.doctree
diff --git a/docs/_rst_file/.doctrees/_rst/ccnp.quote.doctree b/docs/_rst_file/.doctrees/_rst/ccnp.quote.doctree
diff --git a/docs/_rst_file/.doctrees/_rst/index.doctree b/docs/_rst_file/.doctrees/_rst/index.doctree
diff --git a/docs/_rst_file/.doctrees/_rst/modules.doctree b/docs/_rst_file/.doctrees/_rst/modules.doctree
diff --git a/docs/_rst_file/.doctrees/_rst/readme.doctree b/docs/_rst_file/.doctrees/_rst/readme.doctree
diff --git a/docs/_rst_file/.doctrees/environment.pickle b/docs/_rst_file/.doctrees/environment.pickle
diff --git a/docs/_rst_file/.doctrees/index.doctree b/docs/_rst_file/.doctrees/index.doctree
diff --git a/docs/_rst_file/ccnp.eventlog.rst b/docs/_rst_file/ccnp.eventlog.rst
@@ -0,0 +1,21 @@
+ccnp.eventlog package
+=====================
+
+Submodules
+----------
+
+ccnp.eventlog.eventlog\_sdk module
+----------------------------------
+
+.. automodule:: ccnp.eventlog.eventlog_sdk
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ccnp.eventlog
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_rst_file/ccnp.measurement.rst b/docs/_rst_file/ccnp.measurement.rst
@@ -0,0 +1,21 @@
+ccnp.measurement package
+========================
+
+Submodules
+----------
+
+ccnp.measurement.measurement\_sdk module
+----------------------------------------
+
+.. automodule:: ccnp.measurement.measurement_sdk
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ccnp.measurement
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_rst_file/ccnp.quote.rst b/docs/_rst_file/ccnp.quote.rst
@@ -0,0 +1,21 @@
+ccnp.quote package
+==================
+
+Submodules
+----------
+
+ccnp.quote.quote\_sdk module
+----------------------------
+
+.. automodule:: ccnp.quote.quote_sdk
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ccnp.quote
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_rst_file/ccnp.rst b/docs/_rst_file/ccnp.rst
@@ -0,0 +1,20 @@
+ccnp package
+============
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   ccnp.eventlog
+   ccnp.measurement
+   ccnp.quote
+
+Module contents
+---------------
+
+.. automodule:: ccnp
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_rst_file/conf.py b/docs/_rst_file/conf.py
@@ -0,0 +1,36 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'CCNP'
+copyright = '2023, Intel'
+author = 'Ken Lu, Ruoyu Ying, Hairong Chen, Xiaocheng Dong, Lei Zhou'
+
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../sdk/python3/ccnp/eventlog'))
+sys.path.insert(0, os.path.abspath('../sdk/python3/ccnp/measurement'))
+sys.path.insert(0, os.path.abspath('../sdk/python3/ccnp/quote'))
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.napoleon', 'sphinx_markdown_builder',
+        'sphinx_mdinclude']
+
+napoleon_google_docstring = True
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+import sphinx_rtd_theme
+
+html_theme = "sphinx_rtd_theme"
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
diff --git a/docs/_rst_file/modules.rst b/docs/_rst_file/modules.rst
@@ -0,0 +1,9 @@
+ccnp
+====
+
+.. toctree::
+   :maxdepth: 4
+
+   CCNP Quote packages <ccnp.quote>
+   CCNP Measurement packages <ccnp.measurement>
+   CCNP Event log packages <ccnp.eventlog>
diff --git a/docs/_rst_file/readme.rst b/docs/_rst_file/readme.rst
@@ -0,0 +1,3 @@
+.. _readme:
+
+.. mdinclude:: ../../README.md
diff --git a/docs/_sources/_rst/ccnp.eventlog.rst.txt b/docs/_sources/_rst/ccnp.eventlog.rst.txt
@@ -0,0 +1,21 @@
+ccnp.eventlog package
+=====================
+
+Submodules
+----------
+
+ccnp.eventlog.eventlog\_sdk module
+----------------------------------
+
+.. automodule:: ccnp.eventlog.eventlog_sdk
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ccnp.eventlog
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/_rst/ccnp.measurement.rst.txt b/docs/_sources/_rst/ccnp.measurement.rst.txt
@@ -0,0 +1,21 @@
+ccnp.measurement package
+========================
+
+Submodules
+----------
+
+ccnp.measurement.measurement\_sdk module
+----------------------------------------
+
+.. automodule:: ccnp.measurement.measurement_sdk
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ccnp.measurement
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/_rst/ccnp.quote.rst.txt b/docs/_sources/_rst/ccnp.quote.rst.txt
@@ -0,0 +1,21 @@
+ccnp.quote package
+==================
+
+Submodules
+----------
+
+ccnp.quote.quote\_sdk module
+----------------------------
+
+.. automodule:: ccnp.quote.quote_sdk
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ccnp.quote
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/_rst/ccnp.rst.txt b/docs/_sources/_rst/ccnp.rst.txt
@@ -0,0 +1,20 @@
+ccnp package
+============
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   ccnp.eventlog
+   ccnp.measurement
+   ccnp.quote
+
+Module contents
+---------------
+
+.. automodule:: ccnp
+   :members:
+   :undoc-members:
+   :show-inheritance: