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.

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

Documentation revamp #242

Merged
merged 19 commits into from
Jun 4, 2024
Merged
Changes from 1 commit
Commits
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
Prev Previous commit
Minor docs changes
  • Loading branch information
catttam committed Jun 4, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
commit d56c4291d6ffc7676ab4d150f041740ffec5c08d
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -11,7 +11,7 @@ run on AWS Lambda and AWS Batch.


## Concepts
- **OSCAR Cluster**: A Kubernetes cluster (either fixed size or elastic) configured with the OSCAR services and components. The cluster must have at least one Front-End (FE) node, which executes the OSCAR control plane and, optionally, several Working Nodes (WNs), which execute the OSCAR services and replicated services from the control plane for enhanced fault-tolerance.
- **OSCAR Cluster**: A Kubernetes cluster (either fixed size or elastic) configured with the OSCAR services and components. The cluster must have at least one front-end node, which executes the OSCAR control plane and one or several working nodes.
- **OSCAR Service**: The execution unit in the OSCAR framework, typically defined in [FDL](fdl.md), by a:
- Docker image, providing the customized runtime environment for an application.
- Execution requirements.
4 changes: 0 additions & 4 deletions docs/invoking-async.md
Original file line number Diff line number Diff line change
@@ -9,8 +9,4 @@ processed.

![oscar-async.png](images/oscar-async.png)

In addition, the service can be executed asynchronously sending an
HTTP POST request to paths `/run/<SERVICE_NAME>` and `/job/<SERVICE_NAME>`
respectively.


15 changes: 1 addition & 14 deletions docs/invoking-sync.md
Original file line number Diff line number Diff line change
@@ -99,18 +99,5 @@ interface.

Although the use of the Knative Serverless Backend for synchronous invocations provides elasticity similar to the one provided by their counterparts in public clouds, such as AWS Lambda, synchronous invocations are not still the best option for run long-running resource-demanding applications, like deep learning inference or video processing.

The synchronous invocation of long-running resource-demanding applications may lead to timeouts on Knative pods. Therefore, we consider asynchronous invocations (which generate Kubernetes jobs) as the optimal approach to handle event-driven file processing.


## Asynchronous invocations

For file processing, OSCAR automatically manages the creation
and [notification system](https://docs.min.io/minio/baremetal/monitoring/bucket-notifications/bucket-notifications.html#minio-bucket-notifications)
of MinIO buckets in order to allow the event-driven invocation of services
using asynchronous requests, generating a Kubernetes job for every file to be
processed.

In addition, the service can be executed asynchronously sending an
HTTP POST request to paths `/run/<SERVICE_NAME>` and `/job/<SERVICE_NAME>`
respectively.
The synchronous invocation of long-running resource-demanding applications may lead to timeouts on Knative pods. Therefore, we consider asynchronous invocations (which generate Kubernetes jobs) as the optimal approach to handle event-driven file processing.

15 changes: 7 additions & 8 deletions docs/oscar-cli.md
Original file line number Diff line number Diff line change
@@ -29,26 +29,25 @@ go install github.com/grycap/oscar-cli@latest

### OIDC (OpenID Connect)

Once the service is created, follow these steps to use `oscar-cli` to interact with an OSCAR cluster using the OpenID Connect.
If your cluster has OIDC avaliable, follow these steps to use `oscar-cli` to interact with it using the OpenID Connect.

- Install [oidc-agent](https://indigo-dc.gitbook.io/oidc-agent/intro)
- Register the [EGI client](https://indigo-dc.gitbook.io/oidc-agent/user/oidc-gen/provider/egi)
- Add a cluster in `oscar-cli` with oidc credentians
- Add a cluster in `oscar-cli` with oidc credentians (More info about the usage of the `cluster add` command [here](#add))

``` bash
oscar-cli cluster add IDENTIFIER ENDPOINT --oidc-account-name SHORTNAME
```

- Run the service

``` bash
oscar-cli service run plant-classification -i <image-path> -c <cluster-identifier>
```


## Available commands


- [OSCAR CLI](#oscar-cli)
- [Download](#download)
- [Releases](#releases)
- [Install from source](#install-from-source)
- [OIDC (OpenID Connect)](#oidc-openid-connect)
- [Available commands](#available-commands)
- [apply](#apply)
- [cluster](#cluster)
Loading