Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated documentation #224

Merged
merged 2 commits into from
Jan 19, 2024
Merged

Updated documentation #224

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
afa6497
Updated documentation
catttam Jan 19, 2024
ffa27b2
Minor fix
catttam Jan 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/fdl.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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) |
Expand Down
17 changes: 17 additions & 0 deletions docs/sgx-integration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
```
2 changes: 1 addition & 1 deletion docs/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
7 changes: 5 additions & 2 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down