From 9ba1e107e9ecd1d046f6ef27ea7e703984e30e00 Mon Sep 17 00:00:00 2001 From: Benny Fuhry Date: Tue, 9 May 2023 19:32:40 +0200 Subject: [PATCH] Changes to structure as discussed in today's contributor meeting. Signed-off-by: Benny Fuhry --- Documentation/curated-installation.rst | 6 +++ Documentation/index.rst | 54 ++++++++++++++------------ 2 files changed, 35 insertions(+), 25 deletions(-) diff --git a/Documentation/curated-installation.rst b/Documentation/curated-installation.rst index c0267a5d74..2c5184fe8c 100644 --- a/Documentation/curated-installation.rst +++ b/Documentation/curated-installation.rst @@ -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. diff --git a/Documentation/index.rst b/Documentation/index.rst index 6ba2a8497f..acd8abfb90 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -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 `_ -and `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. @@ -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 `_ - 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 `_ +and `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 ======================== @@ -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::