Merge pull request #224 from grycap/change-doc

Updated documentation
grycap · Jan 19, 2024 · 7f229ea · 7f229ea
2 parents 5ff2e6d + ffa27b2
commit 7f229ea
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 4 deletions.
diff --git a/docs/fdl.md b/docs/fdl.md
@@ -72,7 +72,8 @@ storage_providers:
 |------------------------------| --------------------------------------------|
 | `name` </br> *string*                                             | The name of the service                                                                                                                                                                                                                                      |
 | `cluster_id` </br> *string*                                       | Identifier for the current cluster, used to specify the cluster's StorageProvider in job delegations. OSCAR-CLI sets it using the ClusterID from the FDL. Optional. (default: "")                                                                            |
-| `image` </br> *string*                                            | Docker image for the service                                                                                                                                                                                                                                 |
+| `image` </br> *string*                                            | Docker image for the service                                                                                                    |
+| `vo` </br> *string*                                               | Virtual Organization (VO) in which the user creating the service is enrolled. Optional (default: "")                                                             |
 | `alpine` </br> *boolean*                                          | Alpine parameter to set if image is based on Alpine. If `true` a custom release of faas-supervisor will be used. Optional (default: false)                                                                                                                   |
 | `script` </br> *string*                                           | Local path to the user script to be executed in the service container                                                                                                                                                                                        |
 | `file_stage_in` </br> *bool*                                      | Parameter to skip the download of the input files by the FaaS Supervisor (default: false)                                   |

diff --git a/docs/sgx-integration.md b/docs/sgx-integration.md
@@ -0,0 +1,17 @@
+# Integration with SCONE
+
+SCONE is a tool that allows confidential computing on the cloud thus protecting the data, code and application secrets on a Kubernetes cluster (More info about SCONE and Kubernetes [here](https://sconedocs.github.io/k8s_concepts/)). 
+
+To use SCONE on a Kubernetes cluster Intel SGX has to be enabled on the machines, and for these, the SGX Kubernetes plugin needs to be present on the cluster. Once the plugin is installed you only need to specify the parameter `enable_sgx` on the FDL of the services that are going to use a secured container image like in the following example.
+
+``` yaml
+functions:
+  oscar:
+  - oscar-cluster:
+      name: sgx-service
+      memory: 1Gi
+      cpu: '0.6'
+      image: your_image
+      enable_sgx: true
+      script: script.sh
+```
diff --git a/docs/usage.md b/docs/usage.md
@@ -17,7 +17,7 @@ You can follow one of the
 [examples](https://github.com/grycap/oscar/tree/master/examples)
 in order to test the OSCAR framework for specific applications. We recommend
 you to start with the
-[plant classification example](https://github.com/grycap/oscar/tree/master/examples/imagemagick)
+[plant classification example](https://github.com/grycap/oscar/tree/master/examples/plant-classification-sync)
 detailed below.
 
 If you prefer to use the command-line interface rather than the web-based UI,

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -13,10 +13,13 @@ nav:
 - Functions Definition Language (FDL): fdl.md
 - FDL Composer: fdl-composer.md
 - oscar-cli.md
-- Integration with EGI: egi-integration.md
-- OIDC Authorization: oidc-auth.md
 - OpenAPI Specification: api.md
 - MinIO bucket replication: minio-bucket-replication.md
+nav:
+- Third party integrations:
+  - Integration with EGI: egi-integration.md
+  - OIDC Authorization: oidc-auth.md
+  - Integration with SCONE: sgx-integration.md
 - Frequently Asked Questions (FAQ): faq.md
 - license.md
 - about.md