Merge pull request #213 from grycap/dev-calarcon

Dev calarcon

docs/api.yaml

@@ -360,7 +360,7 @@ components:
         cpu:
           type: string
         enable_gpu:
-          type: bool
+          type: boolean
           default: false
         total_memory:
           type: string
@@ -568,7 +568,7 @@ components:
         namespace:
           type: string
         gpu_avaliable:
-          type: bool
+          type: boolean
         serverless_backend:
           type: string
         yunikorn_enable:
@@ -607,4 +607,4 @@ servers:
   - url: 'https://localhost'
     description: 'Local testing'
   - url: 'https://inference.cloud.ai4eosc.eu'
-    description: 'AI4EOSC's OSCAR cluster'
+    description: 'AI4EOSC OSCAR cluster'

docs/fdl.md

@@ -75,6 +75,7 @@ storage_providers:
 | `image` </br> *string*                                            | Docker image for the service                                                                                                                                                                                                                                 |
 | `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)                                   |
 | `image_pull_secrets` </br> *string array*                         | Array of Kubernetes secrets. Only needed to use private images located on private registries.                                                                                                                                                                |
 | `memory` </br> *string*                                           | Memory limit for the service following the [kubernetes format](https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/#meaning-of-memory). Optional (default: 256Mi)                                                           |
 | `cpu` </br> *string*                                              | CPU limit for the service following the [kubernetes format](https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/#meaning-of-cpu). Optional (default: 0.2)                                                                   |

docs/index.md

@@ -70,5 +70,5 @@ on any major public and on-premises Cloud provider, including the EGI Federated
 
 An OSCAR cluster can be accessed via its
 [REST API](https://grycap.github.io/oscar/api/), the
-[web-based [UI](https://github.com/grycap/oscar/tree/master/ui) and the command-line interface provided by
+[web-based [UI](https://github.com/grycap/oscar-ui) and the command-line interface provided by
 [oscar-cli](https://github.com/grycap/oscar-cli).

docs/oscar-cli.md

@@ -48,26 +48,33 @@ oscar-cli service run plant-classification -i <image-path> -c <cluster-identifie
 
 ## Available commands
 
-- [apply](#apply)
-- [cluster](#cluster)
-  - [add](#add)
-  - [default](#default)
-  - [info](#info)
-  - [list](#list)
-  - [remove](#remove)
-- [service](#service)
-  - [get](#get)
-  - [list](#list-1)
-  - [remove](#remove-1)
-  - [run](#run)
-  - [logs list](#logs-list)
-  - [logs get](#logs-get)
-  - [logs remove](#logs-remove)
-  - [get-file](#get-file)
-  - [put-file](#put-file)
-  - [list-files](#list-files)
-- [version](#version)
-- [help](#help)
+- [OSCAR-CLI](#oscar-cli)
+  - [Download](#download)
+    - [Releases](#releases)
+    - [Install from source](#install-from-source)
+  - [Available commands](#available-commands)
+    - [apply](#apply)
+    - [cluster](#cluster)
+      - [Subcommands](#subcommands)
+        - [add](#add)
+        - [default](#default)
+        - [info](#info)
+        - [list](#list)
+        - [remove](#remove)
+    - [service](#service)
+      - [Subcommands of services](#subcommands-of-services)
+        - [get](#get)
+        - [list services](#list-services)
+        - [remove services](#remove-services)
+        - [run](#run)
+        - [logs list](#logs-list)
+        - [logs get](#logs-get)
+        - [logs remove](#logs-remove)
+        - [get-file](#get-file)
+        - [put-file](#put-file)
+        - [list-files](#list-files)
+    - [version](#version)
+    - [help](#help)
 
 ### apply
 
@@ -339,6 +346,15 @@ Global Flags:
   -c, --cluster string   set the cluster
       --config string    set the location of the config file (YAML or JSON)
 ```
+> **Note**
+> The following subcommands will not work with MinIO if you use a local deployment due to DNS resolutions, so if you want to use a command line put/get/list files from your buckets, you can use the [MinIO client](https://min.io/docs/minio/linux/reference/minio-mc.html) command line. <br>
+> Once you have the client installed you can define the cluster with the `mc alias` command like it follows:
+> ```
+> mc alias set myminio https://localhost:30000 minioadminuser minioadminpassword
+> ```
+> So, instead of the next subcommands, you would use:
+> - [`mc cp`](https://min.io/docs/minio/linux/reference/minio-mc/mc-cp.html) to put/get files fron a bucket. <br>
+> - [`mc ls`](https://min.io/docs/minio/linux/reference/minio-mc/mc-ls.html) to list files from a bucket.
 
 ##### get-file