Skip to content

Commit

Permalink
Changes to structure as discussed in today's contributor meeting.
Browse files Browse the repository at this point in the history
Signed-off-by: Benny Fuhry <benny.fuhry@intel.com>
  • Loading branch information
BFuhry committed May 9, 2023
1 parent 49094b5 commit 9ba1e10
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 25 deletions.
6 changes: 6 additions & 0 deletions Documentation/curated-installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@
Ready-made confidential protected images
========================================

.. note::
This is not an official part of Gramine.
The offering mentioned here wasn't thoroughly reviewed by the Gramine
maintainers.
Use at your own risk!

Confidential Compute images with Gramine are ready-made solutions for popular
open-source projects, such as PyTorch and Redis.
Customize your environment through interactive scripts.
Expand Down
54 changes: 29 additions & 25 deletions Documentation/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,27 +20,21 @@ This page mimics the table of contents in the left column.
Gramine deployment options
--------------------------

There are three deployment options for Gramine -- each option has a dedicated
section in the menu and an introduction is provided below.

Ready-made protected applications
=================================

Confidential compute images are ready-made solutions for popular open source
projects such as `PyTorch <https://github.com/gramineproject/contrib/tree/master/Intel-Confidential-Compute-for-X/workloads/pytorch>`_
and `Redis <https://github.com/gramineproject/contrib/tree/master/Intel-Confidential-Compute-for-X/workloads/redis>`_.
These images enable you to customize your environment through interactive
scripts. The result is an image that includes your specific machine-learning
application, common dependencies, and a manifest file.

.. note:: These confidential compute images only run on machines that support
Intel SGX.

See the :doc:`curated-installation` article for more information.
There are two deployment options for Gramine: protect your container and protect
your application.
Each option has a dedicated section in the menu and an introduction is provided
below.

Protect your container
======================

In this section, we describe how you can protect your Docker container using
Gramine Shielded Containers and how you can use ready-made solutions for popular
open source projects.

Gramine Shielded Containers
~~~~~~~~~~~~~~~~~~~~~~~~~~~

Docker images are used to run applications in the cloud.
The Gramine Shielded Container tool transforms a Docker image into a graminized
image that includes the Gramine Library OS and Intel SGX related information.
Expand All @@ -53,6 +47,23 @@ It enables you to run an application on a Docker image and keep it protected.
- `Download the Gramine Shielded Container tool <https://github.com/gramineproject/gsc>`_ -
Protect the Docker image containing the application you want to protect.

Ready-made protected applications
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Confidential compute images are ready-made solutions for popular open source
projects such as `PyTorch <https://github.com/gramineproject/contrib/tree/master/Intel-Confidential-Compute-for-X/workloads/pytorch>`_
and `Redis <https://github.com/gramineproject/contrib/tree/master/Intel-Confidential-Compute-for-X/workloads/redis>`_.
These images enable you to customize your environment through interactive
scripts.
The result is an image that includes your specific machine-learning
application, common dependencies, and a manifest file.

.. note:: These confidential compute images only run on machines that support
Intel SGX.

See the :doc:`curated-installation` article for more information.


Protect your application
========================

Expand Down Expand Up @@ -146,20 +157,13 @@ Indices and tables
- :ref:`genindex`
- :ref:`search`

.. toctree::
:hidden:
:caption: Ready-made protected applications
:maxdepth: 1

curated-installation


.. toctree::
:hidden:
:caption: Protect your container
:maxdepth: 1

gsc-installation
curated-installation


.. toctree::
Expand Down

0 comments on commit 9ba1e10

Please sign in to comment.