Merge pull request #65 from kube-HPC/update_volumes_info

updated volume section for sidecar

Author: Adir111

site/learn/API.md

@@ -8,7 +8,7 @@ sublinks: Restful, Cli
 next: /learn/algorithms/
 ---
 
-HKube support two types of APIs, Restful and Cli
+HKube supports two types of APIs, Restful and Cli.
 
 ### Restful API
 
@@ -18,28 +18,18 @@ Also check the [Swagger-UI](http://petstore.swagger.io/?url=https://raw.githubus
 
 ### Cli
 
-`hkubectl` is a command-line tool that help you to work with hkube more easily.
-
-
-#### Download
-
-```console
-export latestVersion="$(curl -s https://api.github.com/repos/kube-HPC/hkubectl/releases/latest | grep -oP '"tag_name": "\K(.*)(?=")')"
-curl -Lo hkubectl https://github.com/kube-HPC/hkubectl/releases/download/${latestVersion}/hkubectl-linux \
-&& chmod +x hkubectl \
-&& sudo mv hkubectl /usr/local/bin/
-```
-
-#### Config
-
-`hkubectl` config set endpoint <KUBERNETES-MASTER-IP>  
-`hkubectl` config set rejectUnauthorized false
+`hkubectl` is a command-line tool that help you to work with hkube more easily.  
+For download, please follow the instructions [here](../installCLI/#setup).
 
 #### Syntax
 
 ```
 hkubectl [type] [command] [name]
 ```
+To get commands and options, run:
+```
+hkubectl --help
+```
 
 
 In the next sections you will learn in details about the pipeline definitions.

site/learn/Sidecars.md

@@ -35,12 +35,6 @@ Below is an example of a complete sidecar configuration:
           }
         }
       },
-      "volumes": [
-        {
-          "name": "shared-volume",
-          "emptyDir": {}
-        }
-      ],
       "volumeMounts": [
         {
           "name": "shared-volume",
@@ -91,23 +85,31 @@ Below is an example of a sidecar container configuration, with resources:
 > **Note:** Resources are not mandatory and will default to a preset value if not provided. You can change the default values by modifying `config.resources`.
 
 ## Volumes Usage
-Sidecars can mount volumes for shared storage. In HKube, `volumes` are defined in the volumes section and mounted using `volumeMounts`.
+Sidecars can mount volumes for shared storage. In HKube, `volumes` are defined in the volumes section at the algorithm level, and mounted using `volumeMounts` in the sidecar or algorithm (for algorunner) level.
 
 **Example:**
 ```json
 {
+  "name": "algo-car-with-volume-mount",
+  "algorithmImage": "docker.io/hkubedevtest/print-every-10-sec:v4o4c4xne",
+  "volumes": [
+    {
+      "name": "shared-volume",
+      "emptyDir": {}
+    }
+  ],
+  "volumeMounts": [
+    {
+      "name": "shared-volume",
+      "mountPath": "/shared-dir"
+    }
+  ],
   "sideCars": [
     {
       "container": {
         "name": "mycar",
         "image": "httpd"
       },
-      "volumes": [
-        {
-          "name": "shared-volume",
-          "emptyDir": {}
-        }
-      ],
       "volumeMounts": [
         {
           "name": "shared-volume",