Add HPC WaaS first description

Author: loicalbertin

.gitignore

@@ -1 +1,2 @@
 build
+.vscode

doc/source/Sections/03_HPCWaaS_Methodology.rst

@@ -2,7 +2,14 @@
 HPCWaaS Methodology
 ======================
 
-The eFlows4HPC proposes the HPC Workflow as a Service (HPCWaaS) methodology which tries to apply the usage model of the Functions as a Service in Cloud environments to the workflows for HPC systems. In this model to main roles are identified. From one side, the function developer which is in charge of developing and registering the fuction in the FaaS platform, which transparently deploys de function in the cloud infrastructure. On the other side, the final user executes the deployed function using a REST API. In the case of running workflows in HPC systems, we can find a similar roles. First, we can find the workflow developer, which is charge of developing and deploying the workflow in the computing infrastructure, and the users' comunities which are usually scientist which just want to execute the workflow and collect their results to avance in their scientific goals.
+The eFlows4HPC proposes the HPC Workflow as a Service (HPCWaaS) methodology which tries to apply the usage model of the Functions
+as a Service in Cloud environments to the workflows for HPC systems. In this model tow main roles are identified.
+From one side, the function developer which is in charge of developing and registering the function in the FaaS platform,
+which transparently deploys de function in the cloud infrastructure. On the other side, the final user executes the deployed
+function using a REST API. In the case of running workflows in HPC systems, we can find a similar roles. First, we can find
+the workflow developer, which is charge of developing and deploying the workflow in the computing infrastructure, and the
+users' communities which are usually scientist which just want to execute the workflow and collect their results to advance
+in their scientific goals.
 
 .. _fig_hpcwaas:
 .. figure:: 03_HPCWaaS_Methodology/Figures/HPCWaaS.png
@@ -13,8 +20,10 @@ The eFlows4HPC proposes the HPC Workflow as a Service (HPCWaaS) methodology whic
     .center{HPC Workfow as a Service overview}
 
 
-:numref:`fig_hpcwaas` shows how these two roles interacts with the proposed HPCWaaS methodology. Worklfow developers implement and describe the workflow in a way that allow the eFlows4HPC Gateway services to automatically deploy and orchestrate the workflow execution. This is done interacting with the Developement Interface offered by the Alien4Cloud tool to describe workflows as a TOSCA application.
-Once the workflow is deployed users' communities can invoke this workflow using the Execution API.
+:numref:`fig_hpcwaas` shows how these two roles interacts with the proposed HPCWaaS methodology. Workflow developers implement
+and describe the workflow in a way that allow the eFlows4HPC Gateway services to automatically deploy and orchestrate the workflow
+execution. This is done interacting with the Development Interface offered by the Alien4Cloud tool to describe workflows as a
+TOSCA application. Once the workflow is deployed users' communities can invoke this workflow using the Execution API.
 
 Next sections provide more details about these interfaces. A simple workflow example about can be found `here <04_Usage_Example.rst>`_.
 

doc/source/Sections/03_HPCWaaS_Methodology/01_Development_Interface.rst

@@ -1,5 +1,98 @@
 Development Interface
 =====================
 
+Setup
+-----
 
-TODO: (Loïc) How to use Alien4Cloud developing and Deploying TOSCA Workflow
+Alien4Cloud & Yorc
+##################
+
+Please refer to the documentation of the Alien4Cloud & Yorc project for more information.
+
+A instance of Alien4Cloud and Yorc is available on Juelich cloud, ask to the project to have an access
+
+Importing required components into Alien4Cloud
+##############################################
+
+Some TOSCA components and topologies templates need to be imported into Alien4Cloud.
+If you are using the instance on Juelich cloud, this is already done and you can move to the next paragraph.
+
+You should first move to the ``Catalog`` tab and then the ``Manage archives`` tab, finally click on ``Git import`` to add components.
+
+.. figure:: Figures/catalog.png
+    :figwidth: 50 %
+    :alt: Alien4Cloud catalog
+    :align: center
+
+    Click on ``Git import`` to add components
+
+You should have at least the three repositories defined as shown in :numref:`fig_alien4cloud_git_catalog`:
+
+.. _fig_alien4cloud_git_catalog:
+.. figure:: Figures/git-catalog.png
+    :figwidth: 50 %
+    :alt: Alien4Cloud git catalog
+    :align: center
+
+    Click on ``Git location`` to define imports from a git repository
+
+
+Click on ``Git location`` to define imports from a git repository as shown in :numref:`fig_alien4cloud_git_import_setup`
+
+.. _fig_alien4cloud_git_import_setup:
+.. figure:: Figures/git-import-setup.png
+    :figwidth: 50 %
+    :alt: Alien4Cloud setup a catalog git repository
+    :align: center
+
+    Alien4Cloud setup a catalog git repository
+
+Once done you can click on ``Import all``.
+
+Creating an application based on the minimal workflow example
+-------------------------------------------------------------
+
+Move to the ``Applications`` tab and click on ``New application``.
+
+.. figure:: Figures/applications.png
+    :figwidth: 50 %
+    :alt: Alien4Cloud applications list
+    :align: center
+
+    Manage applications in Alien4Cloud
+
+Then create a new application based on the minimal workflow template as shown in :numref:`fig_alien4cloud_app_create`
+
+.. _fig_alien4cloud_app_create:
+.. figure:: Figures/new-application.png
+    :figwidth: 50 %
+    :alt: Alien4Cloud create a new application
+    :align: center
+
+    Alien4Cloud create a template based application
+
+Edit the topology to fit your needs:
+
+.. figure:: Figures/topology.png
+    :figwidth: 50 %
+    :alt: Alien4Cloud minimal workflow topology
+    :align: center
+
+    Alien4Cloud minimal workflow topology
+
+Then click on ``Deploy`` to deploy the application.
+
+.. figure:: Figures/deploy.png
+    :figwidth: 50 %
+    :alt: Alien4Cloud deploy an application
+    :align: center
+
+    Alien4Cloud deploy an application
+
+Make your workflow available to end-users using the WaaS API
+------------------------------------------------------------
+
+In order for the WaaS API to know which workflow to allow users to use, you should add a specific tag to your Alien4Cloud application.
+Move to your application main panel and under the ``Tags`` section add a tag named ``hpcwaas-workflows``.
+The tag value should be a coma-separated list of workflow names that could be called through the HPC WaaS API.
+In the minimal workflow example, this tag value should be ``exec_job``.

doc/source/Sections/03_HPCWaaS_Methodology/02_Execution_API.rst

@@ -1,3 +1,28 @@
 Execution API
 =============
-TODO: (Loïc) Execution API
+
+The execution API is still under active development and is subject to changes.
+Please refer to the repository documentation_ for a detailed description of the current status of the different
+endpoints of this API.
+
+A CLI is planned to interact with the API, but as this is not available yet, the API can be called using a tool like ``curl``.
+
+There is a running instance on Juelich cloud, ask to the team for access to the API.
+
+Basic usage
+-----------
+
+First you need to setup your SSH credentials using the `Create an SSH Key Pair for a given user endpoint <https://github.com/eflows4hpc/hpcwaas-api/blob/main/docs/rest-api.md#create-an-ssh-key-pair-for-a-given-user>`.
+By calling this endpoint the API will create a new SSH key pair and store it into a vault you will receive in return of this call
+the public key. You will never get or even see the private key.
+Add this public key as an authorized key for your HPC user account in order to let transfer data to your user account and run
+PyCOMPS jobs for you in an automated way.
+
+Then you can use the `list available workflows endpoint <https://github.com/eflows4hpc/hpcwaas-api/blob/main/docs/rest-api.md#list-available-workflows>`
+to get the list of endpoints you can access.
+
+You can then `trigger a workflow execution <https://github.com/eflows4hpc/hpcwaas-api/blob/main/docs/rest-api.md#trigger-a-workflow-execution>`.
+
+And finally `monitor the workflow execution <https://github.com/eflows4hpc/hpcwaas-api/blob/main/docs/rest-api.md#monitor-a-workflow-execution>`.
+
+.. _documentation: https://github.com/eflows4hpc/hpcwaas-api/blob/main/docs/rest-api.md