Skip to content

Commit

Permalink
Merge pull request #118 from grycap/devel
Browse files Browse the repository at this point in the history
Minor changes in docs
  • Loading branch information
srisco authored Jul 28, 2021
2 parents 0cbc948 + 2956451 commit 234ca1e
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 36 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

OSCAR is an open-source platform to support the Functions as a Service (FaaS) computing model for file-processing applications. It can be automatically deployed on multi-Clouds in order to create highly-parallel event-driven file-processing serverless applications that execute on customized runtime environments provided by Docker containers than run on an elastic Kubernetes cluster.

[**Deploy**](https://grycap.github.io/oscar/deploy-im-dashboard/)   |
[**Deploy**](https://grycap.github.io/oscar/deploy-im-dashboard.html)   |
  [**Documentation**](https://grycap.github.io/oscar/)  

## Overview
Expand Down
67 changes: 34 additions & 33 deletions docs/deploy-im-dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,75 +10,76 @@ These are the steps:

1. Access the [IM Dashboard](https://appsgrycap.i3m.upv.es:31443/im-dashboard/login)

![login](images/im-dashboard/im-dashboard-00.png)
![login](images/im-dashboard/im-dashboard-00.png)

You will need to authenticate via [EGI Check-In](https://www.egi.eu/services/check-in/), which supports mutiple Identity Providers (IdP).
You will need to authenticate via [EGI Check-In](https://www.egi.eu/services/check-in/), which supports mutiple Identity Providers (IdP).

2. Configure the Cloud Credentials
Once logged in, you need to define the access credentials to the Cloud on which the OSCAR cluster will be deployed. These should be temporary credentials under the [principle of least privilege (PoLP)](https://searchsecurity.techtarget.com/definition/principle-of-least-privilege-POLP).

![credentials](images/im-dashboard/im-dashboard-00-2.png)
Once logged in, you need to define the access credentials to the Cloud on which the OSCAR cluster will be deployed. These should be temporary credentials under the [principle of least privilege (PoLP)](https://searchsecurity.techtarget.com/definition/principle-of-least-privilege-POLP).

![credentials](images/im-dashboard/im-dashboard-00-3.png)
![credentials](images/im-dashboard/im-dashboard-00-2.png)

![credentials](images/im-dashboard/im-dashboard-00-4.png)
![credentials](images/im-dashboard/im-dashboard-00-3.png)

In our case we indicate an identifier for the set of credentials, [the Access Key ID and the Secret Access Key](https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html) for an [IAM](https://aws.amazon.com/iam/) user that has privileges to deploy Virtual Machines in [Amazon EC2](https://aws.amazon.com/ec2).
![credentials](images/im-dashboard/im-dashboard-00-4.png)

In our case we indicate an identifier for the set of credentials, [the Access Key ID and the Secret Access Key](https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html) for an [IAM](https://aws.amazon.com/iam/) user that has privileges to deploy Virtual Machines in [Amazon EC2](https://aws.amazon.com/ec2).

3. Select the OSCAR template

![template](images/im-dashboard/im-dashboard-01.png)
![template](images/im-dashboard/im-dashboard-01.png)

4. Customize and deploy the OSCAR cluster

In this panel you can specify the number of Working Nodes (WNs) of the cluster together with the computational requirements for each node. We leave the default values.
![template-hw](images/im-dashboard/im-dashboard-02.png)
In this panel you can specify the number of Working Nodes (WNs) of the cluster together with the computational requirements for each node. We leave the default values.
![template-hw](images/im-dashboard/im-dashboard-02.png)

In this panel, specify the passwords to be employed to access the Kubernetes Web UI (Dashboard), to access the OSCAR web UI and to access the MinIO dashboard. These tokens can also be used for programmatic access to the respective services.
![template-param](images/im-dashboard/im-dashboard-03.png)
In this panel, specify the passwords to be employed to access the Kubernetes Web UI (Dashboard), to access the OSCAR web UI and to access the MinIO dashboard. These tokens can also be used for programmatic access to the respective services.
![template-param](images/im-dashboard/im-dashboard-03.png)

Now, choose the Cloud provider. The ID specified when creating the Cloud credentials will be shown.
You will also need to specify the [Amazon Machine Image (AMI) identifier](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIs.html). We chose an AMI based on Ubuntu 20.04 provided by Canonical whose identifier for the us-east-1 region is: ami-09e67e426f25ce0d7
Now, choose the Cloud provider. The ID specified when creating the Cloud credentials will be shown.
You will also need to specify the [Amazon Machine Image (AMI) identifier](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIs.html). We chose an AMI based on Ubuntu 20.04 provided by Canonical whose identifier for the us-east-1 region is: ami-09e67e426f25ce0d7

NOTE: You should obtain the AMI identifier for the latest version of the OS. This way, security patches will be already installed. You can obtain this AMI identifier from the AWS Marketplace or the Amazon EC2 service.
NOTE: You should obtain the AMI identifier for the latest version of the OS. This way, security patches will be already installed. You can obtain this AMI identifier from the AWS Marketplace or the Amazon EC2 service.


![template-param](images/im-dashboard/im-dashboard-04.png)
![template-param](images/im-dashboard/im-dashboard-04.png)

Give the infrastructure a name and press "Submit".
Give the infrastructure a name and press "Submit".

5. Check the status of the deployment OSCAR cluster

You will see that the OSCAR cluster is being deployed and the infrastructure reaches the status "running". The process will not finish until it reaches the state "configured".
You will see that the OSCAR cluster is being deployed and the infrastructure reaches the status "running". The process will not finish until it reaches the state "configured".

![status-general](images/im-dashboard/im-dashboard-05.png)
![status-general](images/im-dashboard/im-dashboard-05.png)

If you are interested in understanding what is happening under the hood you can see the logs:
If you are interested in understanding what is happening under the hood you can see the logs:

![status-log](images/im-dashboard/im-dashboard-06.png)
![status-log](images/im-dashboard/im-dashboard-06.png)

6. Accessing the OSCAR cluster

Once reached the "configured" state, see the "Outputs" to obtain the different endpoints:
Once reached the "configured" state, see the "Outputs" to obtain the different endpoints:

![outputs](images/im-dashboard/im-dashboard-07.png)
![outputs](images/im-dashboard/im-dashboard-07.png)

The OSCAR UI can be accessed with the username ``oscar`` and the password you specified at deployment time.
The OSCAR UI can be accessed with the username ``oscar`` and the password you specified at deployment time.

![access-oscar](images/im-dashboard/im-dashboard-08.png)
![access-oscar](images/im-dashboard/im-dashboard-08.png)

The MinIO UI can be accessed with the username ``minio`` and the password you specified at deployment time.
The MinIO UI can be accessed with the username ``minio`` and the password you specified at deployment time.

![access-minio](images/im-dashboard/im-dashboard-09.png)
![access-minio](images/im-dashboard/im-dashboard-09.png)

The Kubernetes Dashboard can be accessed with the token you specified at deployment time.
![access-kubernetes](images/im-dashboard/im-dashboard-10.png)
The Kubernetes Dashboard can be accessed with the token you specified at deployment time.
![access-kubernetes](images/im-dashboard/im-dashboard-10.png)

You can obtain statistics about the Kubernetes cluster:
![access-kubernetes-2](images/im-dashboard/im-dashboard-11.png)
You can obtain statistics about the Kubernetes cluster:
![access-kubernetes-2](images/im-dashboard/im-dashboard-11.png)


7. Terminating the OSCAR cluster

You can terminate the OSCAR cluster from the IM Dashboard:
![terminate](images/im-dashboard/im-dashboard-12.png)
You can terminate the OSCAR cluster from the IM Dashboard:
![terminate](images/im-dashboard/im-dashboard-12.png)
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ functions:
memory: 1Gi
cpu: '1.0'
image: grycap/oscar-theano-plants
script: plants.sh
script: script.sh
input:
- storage_provider: minio
path: plants/in
output:
- storage_provider: minio
path: plants/out
path: plants/out

0 comments on commit 234ca1e

Please sign in to comment.